Skip to content

Commit

Permalink
break: release 3.0.0 (#185)
Browse files Browse the repository at this point in the history
  • Loading branch information
@fern-api
fern-api[bot] authored Dec 4, 2024
1 parent 2f92f29 commit d7c27d9
Show file tree
Hide file tree
Showing 26 changed files with 234 additions and 395 deletions.
37 changes: 37 additions & 0 deletions MIGRATION.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Migration

When migrating to a new major version of this SDK, please consult the notes here for breaking changes, new features, and related fixes.

## v2.x.x -> v3.0.0

There are a few breaking changes with v3.0.0 of the Webflow JS SDK

### Breaking

#### CMS APIs

- CHANGED: Deleting a Collection is now achieved through `client.collections.delete()`, which was previously an API used to delete a Collection field.
- We've removed `client.collections.deleteCollection()`
- To delete a Collection field, use `client.collections.fields.delete()`
- CHANGED: Creating bulk CMS Items in multiple locales is now achieved through `client.collections.createItems()`
- We've removed `client.collections.createItemForMultipleLocales()`

#### Pages APIs

- CHANGED: The `locale` query parameter is now `localeId`

### New Features

#### CMS APIs

- We've added Bulk API support. See [docs](https://developers.webflow.com/data/reference/cms/collection-items/bulk-items/create-items) for more on usage.
- `createItems()`
- `updateItems()`
- `updateItemsLive()`
- `deleteItems()`
- `deleteItemsLive()`

### Fixes

- Some APIs that created resources (i.e. `collections.items.createItem()`) had types that required an `id`, which is not possible to provide. This is no longer required.
- `fieldData` type in CMS Items now allows arbitrary extra key/value pairs
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "webflow-api",
"version": "2.5.0",
"version": "3.0.0",
"private": false,
"repository": "https://github.com/webflow/js-webflow-api",
"main": "./index.js",
Expand Down
4 changes: 2 additions & 2 deletions src/api/resources/accessGroups/client/Client.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,8 @@ export class AccessGroups {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "webflow-api",
"X-Fern-SDK-Version": "2.5.0",
"User-Agent": "webflow-api/2.5.0",
"X-Fern-SDK-Version": "3.0.0",
"User-Agent": "webflow-api/3.0.0",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
...requestOptions?.headers,
Expand Down
32 changes: 16 additions & 16 deletions src/api/resources/assets/client/Client.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ export class Assets {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "webflow-api",
"X-Fern-SDK-Version": "2.5.0",
"User-Agent": "webflow-api/2.5.0",
"X-Fern-SDK-Version": "3.0.0",
"User-Agent": "webflow-api/3.0.0",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
...requestOptions?.headers,
Expand Down Expand Up @@ -187,8 +187,8 @@ export class Assets {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "webflow-api",
"X-Fern-SDK-Version": "2.5.0",
"User-Agent": "webflow-api/2.5.0",
"X-Fern-SDK-Version": "3.0.0",
"User-Agent": "webflow-api/3.0.0",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
...requestOptions?.headers,
Expand Down Expand Up @@ -309,8 +309,8 @@ export class Assets {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "webflow-api",
"X-Fern-SDK-Version": "2.5.0",
"User-Agent": "webflow-api/2.5.0",
"X-Fern-SDK-Version": "3.0.0",
"User-Agent": "webflow-api/3.0.0",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
...requestOptions?.headers,
Expand Down Expand Up @@ -426,8 +426,8 @@ export class Assets {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "webflow-api",
"X-Fern-SDK-Version": "2.5.0",
"User-Agent": "webflow-api/2.5.0",
"X-Fern-SDK-Version": "3.0.0",
"User-Agent": "webflow-api/3.0.0",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
...requestOptions?.headers,
Expand Down Expand Up @@ -542,8 +542,8 @@ export class Assets {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "webflow-api",
"X-Fern-SDK-Version": "2.5.0",
"User-Agent": "webflow-api/2.5.0",
"X-Fern-SDK-Version": "3.0.0",
"User-Agent": "webflow-api/3.0.0",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
...requestOptions?.headers,
Expand Down Expand Up @@ -664,8 +664,8 @@ export class Assets {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "webflow-api",
"X-Fern-SDK-Version": "2.5.0",
"User-Agent": "webflow-api/2.5.0",
"X-Fern-SDK-Version": "3.0.0",
"User-Agent": "webflow-api/3.0.0",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
...requestOptions?.headers,
Expand Down Expand Up @@ -790,8 +790,8 @@ export class Assets {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "webflow-api",
"X-Fern-SDK-Version": "2.5.0",
"User-Agent": "webflow-api/2.5.0",
"X-Fern-SDK-Version": "3.0.0",
"User-Agent": "webflow-api/3.0.0",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
...requestOptions?.headers,
Expand Down Expand Up @@ -917,8 +917,8 @@ export class Assets {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "webflow-api",
"X-Fern-SDK-Version": "2.5.0",
"User-Agent": "webflow-api/2.5.0",
"X-Fern-SDK-Version": "3.0.0",
"User-Agent": "webflow-api/3.0.0",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
...requestOptions?.headers,
Expand Down
16 changes: 8 additions & 8 deletions src/api/resources/collections/client/Client.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,8 @@ export class Collections {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "webflow-api",
"X-Fern-SDK-Version": "2.5.0",
"User-Agent": "webflow-api/2.5.0",
"X-Fern-SDK-Version": "3.0.0",
"User-Agent": "webflow-api/3.0.0",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
...requestOptions?.headers,
Expand Down Expand Up @@ -186,8 +186,8 @@ export class Collections {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "webflow-api",
"X-Fern-SDK-Version": "2.5.0",
"User-Agent": "webflow-api/2.5.0",
"X-Fern-SDK-Version": "3.0.0",
"User-Agent": "webflow-api/3.0.0",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
...requestOptions?.headers,
Expand Down Expand Up @@ -310,8 +310,8 @@ export class Collections {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "webflow-api",
"X-Fern-SDK-Version": "2.5.0",
"User-Agent": "webflow-api/2.5.0",
"X-Fern-SDK-Version": "3.0.0",
"User-Agent": "webflow-api/3.0.0",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
...requestOptions?.headers,
Expand Down Expand Up @@ -427,8 +427,8 @@ export class Collections {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "webflow-api",
"X-Fern-SDK-Version": "2.5.0",
"User-Agent": "webflow-api/2.5.0",
"X-Fern-SDK-Version": "3.0.0",
"User-Agent": "webflow-api/3.0.0",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
...requestOptions?.headers,
Expand Down
12 changes: 6 additions & 6 deletions src/api/resources/collections/resources/fields/client/Client.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,8 @@ export class Fields {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "webflow-api",
"X-Fern-SDK-Version": "2.5.0",
"User-Agent": "webflow-api/2.5.0",
"X-Fern-SDK-Version": "3.0.0",
"User-Agent": "webflow-api/3.0.0",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
...requestOptions?.headers,
Expand Down Expand Up @@ -200,8 +200,8 @@ export class Fields {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "webflow-api",
"X-Fern-SDK-Version": "2.5.0",
"User-Agent": "webflow-api/2.5.0",
"X-Fern-SDK-Version": "3.0.0",
"User-Agent": "webflow-api/3.0.0",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
...requestOptions?.headers,
Expand Down Expand Up @@ -324,8 +324,8 @@ export class Fields {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "webflow-api",
"X-Fern-SDK-Version": "2.5.0",
"User-Agent": "webflow-api/2.5.0",
"X-Fern-SDK-Version": "3.0.0",
"User-Agent": "webflow-api/3.0.0",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
...requestOptions?.headers,
Expand Down
64 changes: 32 additions & 32 deletions src/api/resources/collections/resources/items/client/Client.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,8 @@ export class Items {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "webflow-api",
"X-Fern-SDK-Version": "2.5.0",
"User-Agent": "webflow-api/2.5.0",
"X-Fern-SDK-Version": "3.0.0",
"User-Agent": "webflow-api/3.0.0",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
...requestOptions?.headers,
Expand Down Expand Up @@ -246,8 +246,8 @@ export class Items {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "webflow-api",
"X-Fern-SDK-Version": "2.5.0",
"User-Agent": "webflow-api/2.5.0",
"X-Fern-SDK-Version": "3.0.0",
"User-Agent": "webflow-api/3.0.0",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
...requestOptions?.headers,
Expand Down Expand Up @@ -377,8 +377,8 @@ export class Items {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "webflow-api",
"X-Fern-SDK-Version": "2.5.0",
"User-Agent": "webflow-api/2.5.0",
"X-Fern-SDK-Version": "3.0.0",
"User-Agent": "webflow-api/3.0.0",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
...requestOptions?.headers,
Expand Down Expand Up @@ -553,8 +553,8 @@ export class Items {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "webflow-api",
"X-Fern-SDK-Version": "2.5.0",
"User-Agent": "webflow-api/2.5.0",
"X-Fern-SDK-Version": "3.0.0",
"User-Agent": "webflow-api/3.0.0",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
...requestOptions?.headers,
Expand Down Expand Up @@ -712,8 +712,8 @@ export class Items {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "webflow-api",
"X-Fern-SDK-Version": "2.5.0",
"User-Agent": "webflow-api/2.5.0",
"X-Fern-SDK-Version": "3.0.0",
"User-Agent": "webflow-api/3.0.0",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
...requestOptions?.headers,
Expand Down Expand Up @@ -865,8 +865,8 @@ export class Items {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "webflow-api",
"X-Fern-SDK-Version": "2.5.0",
"User-Agent": "webflow-api/2.5.0",
"X-Fern-SDK-Version": "3.0.0",
"User-Agent": "webflow-api/3.0.0",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
...requestOptions?.headers,
Expand Down Expand Up @@ -996,8 +996,8 @@ export class Items {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "webflow-api",
"X-Fern-SDK-Version": "2.5.0",
"User-Agent": "webflow-api/2.5.0",
"X-Fern-SDK-Version": "3.0.0",
"User-Agent": "webflow-api/3.0.0",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
...requestOptions?.headers,
Expand Down Expand Up @@ -1172,8 +1172,8 @@ export class Items {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "webflow-api",
"X-Fern-SDK-Version": "2.5.0",
"User-Agent": "webflow-api/2.5.0",
"X-Fern-SDK-Version": "3.0.0",
"User-Agent": "webflow-api/3.0.0",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
...requestOptions?.headers,
Expand Down Expand Up @@ -1328,8 +1328,8 @@ export class Items {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "webflow-api",
"X-Fern-SDK-Version": "2.5.0",
"User-Agent": "webflow-api/2.5.0",
"X-Fern-SDK-Version": "3.0.0",
"User-Agent": "webflow-api/3.0.0",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
...requestOptions?.headers,
Expand Down Expand Up @@ -1465,8 +1465,8 @@ export class Items {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "webflow-api",
"X-Fern-SDK-Version": "2.5.0",
"User-Agent": "webflow-api/2.5.0",
"X-Fern-SDK-Version": "3.0.0",
"User-Agent": "webflow-api/3.0.0",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
...requestOptions?.headers,
Expand Down Expand Up @@ -1598,8 +1598,8 @@ export class Items {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "webflow-api",
"X-Fern-SDK-Version": "2.5.0",
"User-Agent": "webflow-api/2.5.0",
"X-Fern-SDK-Version": "3.0.0",
"User-Agent": "webflow-api/3.0.0",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
...requestOptions?.headers,
Expand Down Expand Up @@ -1731,8 +1731,8 @@ export class Items {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "webflow-api",
"X-Fern-SDK-Version": "2.5.0",
"User-Agent": "webflow-api/2.5.0",
"X-Fern-SDK-Version": "3.0.0",
"User-Agent": "webflow-api/3.0.0",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
...requestOptions?.headers,
Expand Down Expand Up @@ -1868,8 +1868,8 @@ export class Items {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "webflow-api",
"X-Fern-SDK-Version": "2.5.0",
"User-Agent": "webflow-api/2.5.0",
"X-Fern-SDK-Version": "3.0.0",
"User-Agent": "webflow-api/3.0.0",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
...requestOptions?.headers,
Expand Down Expand Up @@ -2003,8 +2003,8 @@ export class Items {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "webflow-api",
"X-Fern-SDK-Version": "2.5.0",
"User-Agent": "webflow-api/2.5.0",
"X-Fern-SDK-Version": "3.0.0",
"User-Agent": "webflow-api/3.0.0",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
...requestOptions?.headers,
Expand Down Expand Up @@ -2136,8 +2136,8 @@ export class Items {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "webflow-api",
"X-Fern-SDK-Version": "2.5.0",
"User-Agent": "webflow-api/2.5.0",
"X-Fern-SDK-Version": "3.0.0",
"User-Agent": "webflow-api/3.0.0",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
...requestOptions?.headers,
Expand Down Expand Up @@ -2268,8 +2268,8 @@ export class Items {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "webflow-api",
"X-Fern-SDK-Version": "2.5.0",
"User-Agent": "webflow-api/2.5.0",
"X-Fern-SDK-Version": "3.0.0",
"User-Agent": "webflow-api/3.0.0",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
...requestOptions?.headers,
Expand Down
Loading

0 comments on commit d7c27d9

Please sign in to comment.