webflow-api 3.1.0 → 3.1.2

package/.mock/definition/sites.yml

@@ -8,8 +8,13 @@ service:
       path: /workspaces/{workspace_id}/sites
       method: POST
       auth: true
-      docs: |
-        Create a site. This endpoint requires an Enterprise workspace.
+      docs: >
+        Create a site. 
+
+
+        <Warning title="Enterprise Only">This endpoint requires an Enterprise
+        workspace.</Warning>
+
 
         Required scope | `workspace:write`
       source:
@@ -36,6 +41,7 @@ service:
       response:
         docs: Request was successful
         type: root.Site
+        status-code: 201
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -56,34 +62,12 @@ service:
               createdOn: '2024-10-15T20:24:38Z'
               displayName: The Hitchiker‘s Guide
               shortName: hitchikers-guide
-              lastPublished: '2016-10-24T19:43:17Z'
               lastUpdated: '2024-10-15T20:24:38Z'
-              previewUrl: >-
-                https://d1otoma47x30pg.cloudfront.net/580e63e98c9a982ac9b8b741/201610241243.png
-              timeZone: America/Los_Angeles
               parentFolderId: 670ece123598db72d9648be1
               customDomains:
                 - id: 589a331aa51e760df7ccb89d
                   url: test-api-domain.com
                   lastPublished: '2022-12-07T16:51:37Z'
-              locales:
-                primary:
-                  id: 653fd9af6a07fc9cfd7a5e57
-                  cmsLocaleId: 653ad57de882f528b32e810e
-                  enabled: false
-                  displayName: English (United States)
-                  displayImageId: displayImageId
-                  redirect: true
-                  subdirectory: ''
-                  tag: en-US
-                secondary:
-                  - id: 653fd9af6a07fc9cfd7a5e57
-                    cmsLocaleId: 653ad57de882f528b32e810e
-                    enabled: false
-                    displayName: English (United States)
-                    redirect: true
-                    subdirectory: ''
-                    tag: en-US
               dataCollectionEnabled: false
               dataCollectionType: always
     list:
@@ -100,6 +84,7 @@ service:
       response:
         docs: Request was successful
         type: root.Sites
+        status-code: 200
       errors:
         - root.UnauthorizedError
         - root.NotFoundError
@@ -159,7 +144,6 @@ service:
                   previewUrl: >-
                     https://d1otoma47x30pg.cloudfront.net/42e63e98c9a982ac9b8b742/198110121200.png
                   timeZone: DeepSpace/Depression
-                  parentFolderId: 1as2d3f4g5h6j7k8l9z0x1c2v3b4n5m6
                   customDomains:
                     - id: 589a331aa51e760df7ccb89f
                       url: marvin.blog
@@ -193,7 +177,6 @@ service:
                   previewUrl: >-
                     https://d1otoma47x30pg.cloudfront.net/42e63e98c9a982ac9b8b743/198210121200.png
                   timeZone: Vogsphere/PoetryHall
-                  parentFolderId: 1as2d3f4g5h6j7k8l9z0x1c2v3b4n5m6
                   customDomains:
                     - id: 589a331aa51e760df7ccb8a0
                       url: vogonpoetry.galaxy
@@ -235,6 +218,7 @@ service:
       response:
         docs: Request was successful
         type: root.Site
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -288,8 +272,13 @@ service:
       path: /sites/{site_id}
       method: DELETE
       auth: true
-      docs: |
-        Delete a site. This endpoint requires an Enterprise workspace.
+      docs: >
+        Delete a site. 
+
+
+        <Warning title="Enterprise Only">This endpoint requires an Enterprise
+        workspace.</Warning>
+
 
         Required scope | `sites:write`
       source:
@@ -313,8 +302,13 @@ service:
       path: /sites/{site_id}
       method: PATCH
       auth: true
-      docs: |
-        Update a site. This endpoint requires an Enterprise workspace.
+      docs: >
+        Update a site. 
+
+
+        <Warning title="Enterprise Only">This endpoint requires an Enterprise
+        workspace.</Warning>
+
 
         Required scope | `sites:write`
       source:
@@ -338,6 +332,7 @@ service:
       response:
         docs: Request was successful
         type: root.Site
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -407,6 +402,7 @@ service:
       response:
         docs: Request was successful
         type: root.Domains
+        status-code: 200
       errors:
         - root.UnauthorizedError
         - root.ForbiddenError
@@ -460,6 +456,7 @@ service:
       response:
         docs: Request accepted
         type: SitesPublishResponse
+        status-code: 202
       errors:
         - root.BadRequestError
         - root.UnauthorizedError

package/.mock/definition/token.yml

@@ -18,6 +18,7 @@ service:
       response:
         docs: Request was successful
         type: root.AuthorizedUser
+        status-code: 200
       errors:
         - root.UnauthorizedError
         - root.ForbiddenError
@@ -44,6 +45,7 @@ service:
       response:
         docs: Request was successful
         type: root.Authorization
+        status-code: 200
       errors:
         - root.UnauthorizedError
       examples:

package/.mock/definition/users.yml

@@ -93,6 +93,7 @@ service:
       response:
         docs: Request was successful
         type: root.UserList
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -181,6 +182,7 @@ service:
       response:
         docs: Request was successful
         type: root.User
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -276,6 +278,7 @@ service:
       response:
         docs: Request was successful
         type: root.User
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -354,6 +357,7 @@ service:
       response:
         docs: Request was successful
         type: root.User
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError

package/.mock/definition/webhooks.yml

@@ -22,6 +22,7 @@ service:
       response:
         docs: Request was successful
         type: root.WebhookList
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -33,10 +34,6 @@ service:
             site_id: 580e63e98c9a982ac9b8b741
           response:
             body:
-              pagination:
-                limit: 100
-                offset: 0
-                total: 100
               webhooks:
                 - id: 57ca0a9e418c504a6e1acbb6
                   triggerType: form_submission
@@ -65,6 +62,10 @@ service:
                     name: Email Form
                   lastTriggered: '2023-02-08T23:59:28Z'
                   createdOn: '2016-07-19T01:43:40Z'
+              pagination:
+                limit: 100
+                offset: 0
+                total: 100
     create:
       path: /sites/{site_id}/webhooks
       method: POST
@@ -93,6 +94,7 @@ service:
       response:
         docs: Request was successful
         type: root.Webhook
+        status-code: 201
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -117,8 +119,6 @@ service:
               url: https://webhook.site/7f7f7f7f-7f7f-7f7f-7f7f-7f7f7f7f7f7f
               workspaceId: 4f4e46fd476ea8c507000001
               siteId: 562ac0395358780a1f5e6fbd
-              filter:
-                name: My Form
               lastTriggered: '2023-02-08T23:59:28Z'
               createdOn: '2022-11-08T23:59:28Z'
     get:
@@ -139,6 +139,7 @@ service:
       response:
         docs: Request was successful
         type: root.Webhook
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -155,8 +156,6 @@ service:
               url: https://webhook.site/7f7f7f7f-7f7f-7f7f-7f7f-7f7f7f7f7f7f
               workspaceId: 4f4e46fd476ea8c507000001
               siteId: 562ac0395358780a1f5e6fbd
-              filter:
-                name: My Form
               lastTriggered: '2023-02-08T23:59:28Z'
               createdOn: '2022-11-08T23:59:28Z'
     delete:

package/.mock/fern.config.json

@@ -1,4 +1,4 @@
 {
   "organization" : "webflow",
-  "version" : "0.46.19"
+  "version" : "0.56.16"
 }

package/api/resources/accessGroups/client/Client.js

@@ -85,7 +85,7 @@ class AccessGroups {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}/accessgroups`),
                 method: "GET",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.0", "User-Agent": "webflow-api/3.1.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.2", "User-Agent": "webflow-api/3.1.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 requestType: "json",

package/api/resources/assets/client/Client.d.ts

@@ -27,7 +27,7 @@ export declare class Assets {
     protected readonly _options: Assets.Options;
     constructor(_options: Assets.Options);
     /**
-     * List assets for a given site
+     * List of assets uploaded to a site
      *
      * Required scope | `assets:read`
      *
@@ -45,15 +45,18 @@ export declare class Assets {
      */
     list(siteId: string, requestOptions?: Assets.RequestOptions): Promise<Webflow.Assets>;
     /**
-     * Create a new asset entry.
+     * The first step in uploading an asset to a site.
      *
      *
      * This endpoint generates a response with the following information: `uploadUrl` and `uploadDetails`.
-     * You can use these two properties to [upload the file to Amazon s3 by making a POST](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOST.html)
-     * request to the `uploadUrl` with the `uploadDetails` object as your header information in the request.
      *
      *
-     * Required scope | `assets:write`
+     * Use these properties in the header of a [POST request to Amazson s3](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOST.html) to complete the upload.
+     *
+     *
+     * To learn more about how to upload assets to Webflow, see our [assets guide](/data/docs/working-with-assets).
+     *
+     *  Required scope | `assets:write`
      *
      * @param {string} siteId - Unique identifier for a Site
      * @param {Webflow.AssetsCreateRequest} request
@@ -73,7 +76,7 @@ export declare class Assets {
      */
     create(siteId: string, request: Webflow.AssetsCreateRequest, requestOptions?: Assets.RequestOptions): Promise<Webflow.AssetUpload>;
     /**
-     * Get an Asset
+     * Get details about an asset
      *
      * Required scope | `assets:read`
      *
@@ -109,7 +112,7 @@ export declare class Assets {
      */
     delete(assetId: string, requestOptions?: Assets.RequestOptions): Promise<void>;
     /**
-     * Update an Asset
+     * Update details of an Asset.
      *
      * Required scope | `assets:write`
      *

package/api/resources/assets/client/Client.js

@@ -53,7 +53,7 @@ class Assets {
         this._options = _options;
     }
     /**
-     * List assets for a given site
+     * List of assets uploaded to a site
      *
      * Required scope | `assets:read`
      *
@@ -75,7 +75,7 @@ class Assets {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}/assets`),
                 method: "GET",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.0", "User-Agent": "webflow-api/3.1.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.2", "User-Agent": "webflow-api/3.1.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -150,15 +150,18 @@ class Assets {
         });
     }
     /**
-     * Create a new asset entry.
+     * The first step in uploading an asset to a site.
      *
      *
      * This endpoint generates a response with the following information: `uploadUrl` and `uploadDetails`.
-     * You can use these two properties to [upload the file to Amazon s3 by making a POST](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOST.html)
-     * request to the `uploadUrl` with the `uploadDetails` object as your header information in the request.
      *
      *
-     * Required scope | `assets:write`
+     * Use these properties in the header of a [POST request to Amazson s3](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOST.html) to complete the upload.
+     *
+     *
+     * To learn more about how to upload assets to Webflow, see our [assets guide](/data/docs/working-with-assets).
+     *
+     *  Required scope | `assets:write`
      *
      * @param {string} siteId - Unique identifier for a Site
      * @param {Webflow.AssetsCreateRequest} request
@@ -182,7 +185,7 @@ class Assets {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}/assets`),
                 method: "POST",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.0", "User-Agent": "webflow-api/3.1.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.2", "User-Agent": "webflow-api/3.1.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.AssetsCreateRequest.jsonOrThrow(request, {
@@ -262,7 +265,7 @@ class Assets {
         });
     }
     /**
-     * Get an Asset
+     * Get details about an asset
      *
      * Required scope | `assets:read`
      *
@@ -284,7 +287,7 @@ class Assets {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `assets/${encodeURIComponent(assetId)}`),
                 method: "GET",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.0", "User-Agent": "webflow-api/3.1.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.2", "User-Agent": "webflow-api/3.1.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -381,7 +384,7 @@ class Assets {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `assets/${encodeURIComponent(assetId)}`),
                 method: "DELETE",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.0", "User-Agent": "webflow-api/3.1.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.2", "User-Agent": "webflow-api/3.1.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -450,7 +453,7 @@ class Assets {
         });
     }
     /**
-     * Update an Asset
+     * Update details of an Asset.
      *
      * Required scope | `assets:write`
      *
@@ -473,7 +476,7 @@ class Assets {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `assets/${encodeURIComponent(assetId)}`),
                 method: "PATCH",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.0", "User-Agent": "webflow-api/3.1.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.2", "User-Agent": "webflow-api/3.1.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.AssetsUpdateRequest.jsonOrThrow(request, {
@@ -575,7 +578,7 @@ class Assets {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}/asset_folders`),
                 method: "GET",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.0", "User-Agent": "webflow-api/3.1.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.2", "User-Agent": "webflow-api/3.1.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -675,7 +678,7 @@ class Assets {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}/asset_folders`),
                 method: "POST",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.0", "User-Agent": "webflow-api/3.1.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.2", "User-Agent": "webflow-api/3.1.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.AssetsCreateFolderRequest.jsonOrThrow(request, {
@@ -777,7 +780,7 @@ class Assets {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `asset_folders/${encodeURIComponent(assetFolderId)}`),
                 method: "GET",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.0", "User-Agent": "webflow-api/3.1.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.2", "User-Agent": "webflow-api/3.1.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

package/api/resources/collections/client/Client.d.ts

@@ -58,6 +58,7 @@ export declare class Collections {
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
+     * @throws {@link Webflow.ConflictError}
      * @throws {@link Webflow.TooManyRequestsError}
      * @throws {@link Webflow.InternalServerError}
      *
@@ -65,7 +66,26 @@ export declare class Collections {
      *     await client.collections.create("580e63e98c9a982ac9b8b741", {
      *         displayName: "Blog Posts",
      *         singularName: "Blog Post",
-     *         slug: "posts"
+     *         slug: "posts",
+     *         fields: [{
+     *                 isRequired: true,
+     *                 type: "PlainText",
+     *                 displayName: "Title",
+     *                 helpText: "The title of the blog post"
+     *             }, {
+     *                 isRequired: true,
+     *                 type: "RichText",
+     *                 displayName: "Content",
+     *                 helpText: "The content of the blog post"
+     *             }, {
+     *                 isRequired: true,
+     *                 type: "Reference",
+     *                 displayName: "Author",
+     *                 helpText: "The author of the blog post",
+     *                 metadata: {
+     *                     collectionId: "23cc2d952d4e4631ffd4345d2743db4e"
+     *                 }
+     *             }]
      *     })
      */
     create(siteId: string, request: Webflow.CollectionsCreateRequest, requestOptions?: Collections.RequestOptions): Promise<Webflow.Collection>;

package/api/resources/collections/client/Client.js

@@ -77,7 +77,7 @@ class Collections {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}/collections`),
                 method: "GET",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.0", "User-Agent": "webflow-api/3.1.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.2", "User-Agent": "webflow-api/3.1.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -163,6 +163,7 @@ class Collections {
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
+     * @throws {@link Webflow.ConflictError}
      * @throws {@link Webflow.TooManyRequestsError}
      * @throws {@link Webflow.InternalServerError}
      *
@@ -170,7 +171,26 @@ class Collections {
      *     await client.collections.create("580e63e98c9a982ac9b8b741", {
      *         displayName: "Blog Posts",
      *         singularName: "Blog Post",
-     *         slug: "posts"
+     *         slug: "posts",
+     *         fields: [{
+     *                 isRequired: true,
+     *                 type: "PlainText",
+     *                 displayName: "Title",
+     *                 helpText: "The title of the blog post"
+     *             }, {
+     *                 isRequired: true,
+     *                 type: "RichText",
+     *                 displayName: "Content",
+     *                 helpText: "The content of the blog post"
+     *             }, {
+     *                 isRequired: true,
+     *                 type: "Reference",
+     *                 displayName: "Author",
+     *                 helpText: "The author of the blog post",
+     *                 metadata: {
+     *                     collectionId: "23cc2d952d4e4631ffd4345d2743db4e"
+     *                 }
+     *             }]
      *     })
      */
     create(siteId, request, requestOptions) {
@@ -179,7 +199,7 @@ class Collections {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}/collections`),
                 method: "POST",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.0", "User-Agent": "webflow-api/3.1.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.2", "User-Agent": "webflow-api/3.1.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.CollectionsCreateRequest.jsonOrThrow(request, {
@@ -220,6 +240,8 @@ class Collections {
                             skipValidation: true,
                             breadcrumbsPrefix: ["response"],
                         }));
+                    case 409:
+                        throw new Webflow.ConflictError(_response.error.body);
                     case 429:
                         throw new Webflow.TooManyRequestsError(serializers.Error_.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
@@ -281,7 +303,7 @@ class Collections {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `collections/${encodeURIComponent(collectionId)}`),
                 method: "GET",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.0", "User-Agent": "webflow-api/3.1.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.2", "User-Agent": "webflow-api/3.1.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -378,7 +400,7 @@ class Collections {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `collections/${encodeURIComponent(collectionId)}`),
                 method: "DELETE",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.0", "User-Agent": "webflow-api/3.1.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.2", "User-Agent": "webflow-api/3.1.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

package/api/resources/collections/client/requests/CollectionsCreateRequest.d.ts

@@ -1,12 +1,32 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Webflow from "../../../../index";
 /**
  * @example
  *     {
  *         displayName: "Blog Posts",
  *         singularName: "Blog Post",
- *         slug: "posts"
+ *         slug: "posts",
+ *         fields: [{
+ *                 isRequired: true,
+ *                 type: "PlainText",
+ *                 displayName: "Title",
+ *                 helpText: "The title of the blog post"
+ *             }, {
+ *                 isRequired: true,
+ *                 type: "RichText",
+ *                 displayName: "Content",
+ *                 helpText: "The content of the blog post"
+ *             }, {
+ *                 isRequired: true,
+ *                 type: "Reference",
+ *                 displayName: "Author",
+ *                 helpText: "The author of the blog post",
+ *                 metadata: {
+ *                     collectionId: "23cc2d952d4e4631ffd4345d2743db4e"
+ *                 }
+ *             }]
  *     }
  */
 export interface CollectionsCreateRequest {
@@ -16,4 +36,6 @@ export interface CollectionsCreateRequest {
     singularName: string;
     /** Part of a URL that identifier */
     slug?: string;
+    /** An array of custom fields to add to the collection */
+    fields?: Webflow.FieldCreate[];
 }