webflow-api 3.2.0 → 3.2.1

package/.mock/definition/sites/scripts.yml

@@ -7,7 +7,9 @@ service:
     get-custom-code:
       path: /sites/{site_id}/custom_code
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - custom_code:read
       docs: |
         Get all scripts applied to a site by the App. 
 
@@ -54,14 +56,22 @@ service:
     upsert-custom-code:
       path: /sites/{site_id}/custom_code
       method: PUT
-      auth: true
-      docs: |
-        Apply registered scripts to a site.
+      auth:
+        - OAuth2:
+            - custom_code:write
+      docs: >
+        Apply registered scripts to a site. If you have multiple scripts your
+        App needs to apply or maintain on a site, ensure they are always
+        included in the request body for this endpoint. To remove individual
+        scripts, simply call this endpoint without the script in the request
+        body.
+
 
         <Note title="Script Registration">
           To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information.
         </Note>
 
+
         Required scope | `custom_code:write`
       source:
         openapi: ../../../openapi/referenced-specs/v2.yml
@@ -114,10 +124,22 @@ service:
     delete-custom-code:
       path: /sites/{site_id}/custom_code
       method: DELETE
-      auth: true
+      auth:
+        - OAuth2:
+            - custom_code:write
       docs: >
-        Remove scripts from a site applied by the App. This endpoint will not
-        remove scripts from the site's registered scripts.
+        Remove all scripts from a site applied by the App. This endpoint will
+        not remove scripts from the site's registered scripts.
+
+
+        To remove individual scripts applied by the App, use the [Add/Update
+        Custom
+        Code](/data/reference/custom-code/custom-code-sites/upsert-custom-code)
+        endpoint.
+
+
+        <Note>Access to this endpoint requires a bearer token obtained from an
+        [OAuth Code Grant Flow](/data/reference/oauth-app).</Note>
 
 
         Required scope | `custom_code:write`
@@ -140,7 +162,9 @@ service:
     list-custom-code-blocks:
       path: /sites/{site_id}/custom_code/blocks
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - custom_code:read
       docs: >
         Get a list of scripts that have been applied to a site and/or individual
         pages. 
@@ -185,6 +209,9 @@ service:
       examples:
         - path-parameters:
             site_id: 580e63e98c9a982ac9b8b741
+          query-parameters:
+            offset: 1.1
+            limit: 1.1
           response:
             body:
               blocks:

package/.mock/definition/sites/wellKnown.yml

@@ -19,7 +19,9 @@ service:
     put:
       path: /sites/{site_id}/well_known
       method: PUT
-      auth: true
+      auth:
+        - OAuth2:
+            - site_config:write
       docs: >
         Upload a supported well-known file to a site.
 
@@ -70,12 +72,26 @@ service:
         - path-parameters:
             site_id: 580e63e98c9a982ac9b8b741
           request:
-            fileName: fileName
-            fileData: fileData
+            fileName: apple-app-site-association.txt
+            fileData: |
+              {
+                "applinks": {
+                  "apps": [],
+                  "details": [
+                {
+                  "appID": "ABCDE12345.com.example.app",
+                  "paths": [ "/*", "/some/path/*" ]
+                    }
+                  ]
+                }
+              }
+            contentType: application/json
     delete:
       path: /sites/{site_id}/well_known
       method: DELETE
-      auth: true
+      auth:
+        - OAuth2:
+            - site_config:write
       docs: >
         Delete existing well-known files from a site.
 

package/.mock/definition/sites.yml

@@ -7,7 +7,9 @@ service:
     create:
       path: /workspaces/{workspace_id}/sites
       method: POST
-      auth: true
+      auth:
+        - OAuth2:
+            - sites:write
       docs: >
         Create a site. 
 
@@ -73,7 +75,9 @@ service:
     list:
       path: /sites
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - sites:read
       docs: |
         List of all sites the provided access token is able to access.
 
@@ -203,7 +207,9 @@ service:
     get:
       path: /sites/{site_id}
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - sites:read
       docs: |
         Get details of a site.
 
@@ -226,7 +232,8 @@ service:
         - root.TooManyRequestsError
         - root.InternalServerError
       examples:
-        - path-parameters:
+        - name: SiteWithLocales
+          path-parameters:
             site_id: 580e63e98c9a982ac9b8b741
           response:
             body:
@@ -271,7 +278,9 @@ service:
     delete:
       path: /sites/{site_id}
       method: DELETE
-      auth: true
+      auth:
+        - OAuth2:
+            - sites:write
       docs: >
         Delete a site. 
 
@@ -301,7 +310,9 @@ service:
     update:
       path: /sites/{site_id}
       method: PATCH
-      auth: true
+      auth:
+        - OAuth2:
+            - sites:write
       docs: >
         Update a site. 
 
@@ -387,7 +398,9 @@ service:
     get-custom-domain:
       path: /sites/{site_id}/custom_domains
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - sites:read
       docs: |
         Get a list of all custom domains related to site.
 
@@ -424,7 +437,9 @@ service:
     publish:
       path: /sites/{site_id}/publish
       method: POST
-      auth: true
+      auth:
+        - OAuth2:
+            - sites:write
       docs: >
         Publishes a site to one or more more domains. 
 

package/.mock/definition/token.yml

@@ -7,7 +7,9 @@ service:
     authorized-by:
       path: /token/authorized_by
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - authorized_user:read
       docs: |
         Information about the Authorized User
 
@@ -32,7 +34,6 @@ service:
     introspect:
       path: /token/introspect
       method: GET
-      auth: true
       docs: >
         Information about the authorization token
 

package/.mock/definition/users.yml

@@ -180,7 +180,9 @@ service:
     list:
       path: /sites/{site_id}/users
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - users:read
       docs: |
         Get a list of users for a site
 
@@ -225,6 +227,10 @@ service:
       examples:
         - path-parameters:
             site_id: 580e63e98c9a982ac9b8b741
+          query-parameters:
+            offset: 1.1
+            limit: 1.1
+            sort: CreatedOn
           response:
             body:
               count: 5
@@ -285,7 +291,9 @@ service:
     get:
       path: /sites/{site_id}/users/{user_id}
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - users:read
       docs: |
         Get a User by ID
 
@@ -337,7 +345,9 @@ service:
     delete:
       path: /sites/{site_id}/users/{user_id}
       method: DELETE
-      auth: true
+      auth:
+        - OAuth2:
+            - users:write
       docs: |
         Delete a User by ID
 
@@ -366,7 +376,9 @@ service:
     update:
       path: /sites/{site_id}/users/{user_id}
       method: PATCH
-      auth: true
+      auth:
+        - OAuth2:
+            - users:write
       docs: |
         Update a User by ID 
 
@@ -435,7 +447,9 @@ service:
     invite:
       path: /sites/{site_id}/users/invite
       method: POST
-      auth: true
+      auth:
+        - OAuth2:
+            - users:write
       docs: >
         Create and invite a user with an email address. 
 

package/.mock/definition/webhooks.yml

@@ -7,7 +7,6 @@ service:
     list:
       path: /sites/{site_id}/webhooks
       method: GET
-      auth: true
       docs: |
         List all App-created Webhooks registered for a given site
 
@@ -69,7 +68,6 @@ service:
     create:
       path: /sites/{site_id}/webhooks
       method: POST
-      auth: true
       docs: >
         Create a new Webhook.
 
@@ -124,7 +122,6 @@ service:
     get:
       path: /webhooks/{webhook_id}
       method: GET
-      auth: true
       docs: |
         Get a specific Webhook instance
 
@@ -161,7 +158,6 @@ service:
     delete:
       path: /webhooks/{webhook_id}
       method: DELETE
-      auth: true
       docs: |
         Remove a Webhook
 

package/.mock/definition/workspaces/auditLogs.yml

@@ -23,7 +23,9 @@ service:
     get-workspace-audit_logs:
       path: /workspaces/{workspace_id_or_slug}/audit_logs
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - workspace_activity:read
       docs: >
         Get audit logs for a workspace.
 
@@ -79,8 +81,12 @@ service:
         - path-parameters:
             workspace_id_or_slug: hitchhikers-workspace
           query-parameters:
-            from: '2024-04-22T16:00:31Z'
-            to: '2024-04-22T16:00:31Z'
+            limit: 1.1
+            offset: 1.1
+            sortOrder: asc
+            eventType: user_access
+            from: '2025-06-22T16:00:31Z'
+            to: '2025-07-22T16:00:31Z'
           response:
             body:
               items:

package/.mock/fern.config.json

@@ -1,4 +1,4 @@
 {
   "organization" : "webflow",
-  "version" : "0.65.36"
+  "version" : "0.101.3"
 }

package/Client.d.ts

@@ -24,7 +24,7 @@ export declare namespace WebflowClient {
         environment?: core.Supplier<environments.WebflowEnvironment | environments.WebflowEnvironmentUrls>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        accessToken: core.Supplier<core.BearerToken>;
+        accessToken?: core.Supplier<core.BearerToken | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
@@ -57,7 +57,7 @@ export declare class WebflowClient {
     protected _inventory: Inventory | undefined;
     protected _ecommerce: Ecommerce | undefined;
     protected _workspaces: Workspaces | undefined;
-    constructor(_options: WebflowClient.Options);
+    constructor(_options?: WebflowClient.Options);
     get token(): Token;
     get sites(): Sites;
     get collections(): Collections;

package/Client.js

@@ -56,12 +56,12 @@ const Client_14 = require("./api/resources/inventory/client/Client");
 const Client_15 = require("./api/resources/ecommerce/client/Client");
 const Client_16 = require("./api/resources/workspaces/client/Client");
 class WebflowClient {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "webflow-api",
-                "X-Fern-SDK-Version": "3.2.0",
-                "User-Agent": "webflow-api/3.2.0",
+                "X-Fern-SDK-Version": "3.2.1",
+                "User-Agent": "webflow-api/3.2.1",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

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

@@ -9,7 +9,7 @@ export declare namespace AccessGroups {
         environment?: core.Supplier<environments.WebflowEnvironment | environments.WebflowEnvironmentUrls>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        accessToken: core.Supplier<core.BearerToken>;
+        accessToken?: core.Supplier<core.BearerToken | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
@@ -26,7 +26,7 @@ export declare namespace AccessGroups {
 }
 export declare class AccessGroups {
     protected readonly _options: AccessGroups.Options;
-    constructor(_options: AccessGroups.Options);
+    constructor(_options?: AccessGroups.Options);
     /**
      * Get a list of access groups for a site
      *
@@ -44,9 +44,13 @@ export declare class AccessGroups {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await client.accessGroups.list("580e63e98c9a982ac9b8b741")
+     *     await client.accessGroups.list("580e63e98c9a982ac9b8b741", {
+     *         offset: 1.1,
+     *         limit: 1.1,
+     *         sort: "CreatedOn"
+     *     })
      */
     list(siteId: string, request?: Webflow.AccessGroupsListRequest, requestOptions?: AccessGroups.RequestOptions): core.HttpResponsePromise<Webflow.AccessGroupList>;
     private __list;
-    protected _getAuthorizationHeader(): Promise<string>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

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

@@ -57,7 +57,7 @@ const headers_js_1 = require("../../../../core/headers.js");
 const url_join_1 = __importDefault(require("url-join"));
 const errors = __importStar(require("../../../../errors/index"));
 class AccessGroups {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -77,7 +77,11 @@ class AccessGroups {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await client.accessGroups.list("580e63e98c9a982ac9b8b741")
+     *     await client.accessGroups.list("580e63e98c9a982ac9b8b741", {
+     *         offset: 1.1,
+     *         limit: 1.1,
+     *         sort: "CreatedOn"
+     *     })
      */
     list(siteId, request = {}, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__list(siteId, request, requestOptions));
@@ -187,7 +191,11 @@ class AccessGroups {
     }
     _getAuthorizationHeader() {
         return __awaiter(this, void 0, void 0, function* () {
-            return `Bearer ${yield core.Supplier.get(this._options.accessToken)}`;
+            const bearer = yield core.Supplier.get(this._options.accessToken);
+            if (bearer != null) {
+                return `Bearer ${bearer}`;
+            }
+            return undefined;
         });
     }
 }

package/api/resources/accessGroups/client/requests/AccessGroupsListRequest.d.ts

@@ -4,7 +4,11 @@
 import * as Webflow from "../../../../index";
 /**
  * @example
- *     {}
+ *     {
+ *         offset: 1.1,
+ *         limit: 1.1,
+ *         sort: "CreatedOn"
+ *     }
  */
 export interface AccessGroupsListRequest {
     /**

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

@@ -9,7 +9,7 @@ export declare namespace Assets {
         environment?: core.Supplier<environments.WebflowEnvironment | environments.WebflowEnvironmentUrls>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        accessToken: core.Supplier<core.BearerToken>;
+        accessToken?: core.Supplier<core.BearerToken | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
@@ -29,13 +29,14 @@ export declare namespace Assets {
  */
 export declare class Assets {
     protected readonly _options: Assets.Options;
-    constructor(_options: Assets.Options);
+    constructor(_options?: Assets.Options);
     /**
      * List of assets uploaded to a site
      *
      * Required scope | `assets:read`
      *
      * @param {string} siteId - Unique identifier for a Site
+     * @param {Webflow.AssetsListRequest} request
      * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Webflow.BadRequestError}
@@ -45,9 +46,12 @@ export declare class Assets {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await client.assets.list("580e63e98c9a982ac9b8b741")
+     *     await client.assets.list("580e63e98c9a982ac9b8b741", {
+     *         offset: 1.1,
+     *         limit: 1.1
+     *     })
      */
-    list(siteId: string, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<Webflow.Assets>;
+    list(siteId: string, request?: Webflow.AssetsListRequest, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<Webflow.Assets>;
     private __list;
     /**
      * The first step in uploading an asset to a site.
@@ -199,5 +203,5 @@ export declare class Assets {
      */
     getFolder(assetFolderId: string, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<Webflow.AssetFolder>;
     private __getFolder;
-    protected _getAuthorizationHeader(): Promise<string>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

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

@@ -60,7 +60,7 @@ const errors = __importStar(require("../../../../errors/index"));
  * Assets are files that are uploaded to your Webflow account.
  */
 class Assets {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -69,6 +69,7 @@ class Assets {
      * Required scope | `assets:read`
      *
      * @param {string} siteId - Unique identifier for a Site
+     * @param {Webflow.AssetsListRequest} request
      * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Webflow.BadRequestError}
@@ -78,19 +79,31 @@ class Assets {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await client.assets.list("580e63e98c9a982ac9b8b741")
+     *     await client.assets.list("580e63e98c9a982ac9b8b741", {
+     *         offset: 1.1,
+     *         limit: 1.1
+     *     })
      */
-    list(siteId, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__list(siteId, requestOptions));
+    list(siteId, request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__list(siteId, request, requestOptions));
     }
-    __list(siteId, requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
+    __list(siteId_1) {
+        return __awaiter(this, arguments, void 0, function* (siteId, request = {}, requestOptions) {
             var _a, _b, _c;
+            const { offset, limit } = request;
+            const _queryParams = {};
+            if (offset != null) {
+                _queryParams["offset"] = offset.toString();
+            }
+            if (limit != null) {
+                _queryParams["limit"] = limit.toString();
+            }
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.WebflowEnvironment.DataApi)
                     .base, `sites/${encodeURIComponent(siteId)}/assets`),
                 method: "GET",
                 headers: (0, headers_js_1.mergeHeaders)((_c = this._options) === null || _c === void 0 ? void 0 : _c.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                queryParameters: _queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -934,7 +947,11 @@ class Assets {
     }
     _getAuthorizationHeader() {
         return __awaiter(this, void 0, void 0, function* () {
-            return `Bearer ${yield core.Supplier.get(this._options.accessToken)}`;
+            const bearer = yield core.Supplier.get(this._options.accessToken);
+            if (bearer != null) {
+                return `Bearer ${bearer}`;
+            }
+            return undefined;
         });
     }
 }

package/api/resources/assets/client/requests/AssetsListRequest.d.ts

@@ -0,0 +1,20 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         offset: 1.1,
+ *         limit: 1.1
+ *     }
+ */
+export interface AssetsListRequest {
+    /**
+     * Offset used for pagination if the results have more than limit records
+     */
+    offset?: number;
+    /**
+     * Maximum number of records to be returned (max limit: 100)
+     */
+    limit?: number;
+}

package/api/resources/assets/client/requests/index.d.ts

@@ -1,3 +1,4 @@
+export { type AssetsListRequest } from "./AssetsListRequest";
 export { type AssetsCreateRequest } from "./AssetsCreateRequest";
 export { type AssetsUpdateRequest } from "./AssetsUpdateRequest";
 export { type AssetsCreateFolderRequest } from "./AssetsCreateFolderRequest";

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

@@ -11,7 +11,7 @@ export declare namespace Collections {
         environment?: core.Supplier<environments.WebflowEnvironment | environments.WebflowEnvironmentUrls>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        accessToken: core.Supplier<core.BearerToken>;
+        accessToken?: core.Supplier<core.BearerToken | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
@@ -33,7 +33,7 @@ export declare class Collections {
     protected readonly _options: Collections.Options;
     protected _fields: Fields | undefined;
     protected _items: Items | undefined;
-    constructor(_options: Collections.Options);
+    constructor(_options?: Collections.Options);
     get fields(): Fields;
     get items(): Items;
     /**
@@ -139,5 +139,5 @@ export declare class Collections {
      */
     delete(collectionId: string, requestOptions?: Collections.RequestOptions): core.HttpResponsePromise<void>;
     private __delete;
-    protected _getAuthorizationHeader(): Promise<string>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

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

@@ -62,7 +62,7 @@ const Client_2 = require("../resources/items/client/Client");
  * Collections are CMS collections of items.
  */
 class Collections {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     get fields() {
@@ -522,7 +522,11 @@ class Collections {
     }
     _getAuthorizationHeader() {
         return __awaiter(this, void 0, void 0, function* () {
-            return `Bearer ${yield core.Supplier.get(this._options.accessToken)}`;
+            const bearer = yield core.Supplier.get(this._options.accessToken);
+            if (bearer != null) {
+                return `Bearer ${bearer}`;
+            }
+            return undefined;
         });
     }
 }