webflow-api 3.1.4 → 3.2.1

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. 
 
@@ -68,12 +70,14 @@ service:
                 - id: 589a331aa51e760df7ccb89d
                   url: test-api-domain.com
                   lastPublished: '2022-12-07T16:51:37Z'
-              dataCollectionEnabled: false
+              dataCollectionEnabled: true
               dataCollectionType: always
     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,13 +437,19 @@ 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.
+        Publishes a site to one or more more domains. 
+
+
+        To publish to a specific custom domain, use the domain IDs from the [Get
+        Custom Domains](/data/reference/sites/get-custom-domain) endpoint.
 
 
-        <Note title="Endpoint-specific rate limit">This endpoint has a limit of
-        one successful publish queue per minute.</Note>
+        <Note title="Rate limit: 1 publish per minute">This endpoint has a
+        specific rate limit of one successful publish queue per minute.</Note>
 
 
         Required scope | `sites:write`
@@ -464,9 +483,14 @@ service:
         - root.NotFoundError
         - root.TooManyRequestsError
       examples:
-        - path-parameters:
+        - name: DomainIDs
+          path-parameters:
             site_id: 580e63e98c9a982ac9b8b741
-          request: {}
+          request:
+            customDomains:
+              - 660c6449dd97ebc7346ac629
+              - 660c6449dd97ebc7346ac62f
+            publishToWebflowSubdomain: false
           response:
             body:
               customDomains:
@@ -490,3 +514,21 @@ types:
         default: false
     source:
       openapi: ../../../openapi/referenced-specs/v2.yml
+webhooks:
+  site_publish:
+    audiences: []
+    method: POST
+    display-name: Site Publish
+    headers: {}
+    payload: root.SitePublish
+    examples:
+      - payload:
+          triggerType: site_publish
+          payload:
+            siteId: 62749158efef318abc8d5a0f
+            publishedOn: '2024-07-26T16:43:20Z'
+            domains:
+              - heartofgold.webflow.io
+            publishedBy:
+              displayName: Zaphod BeebleBrox
+    docs: Information about a site that was published

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

@@ -33,23 +33,144 @@ types:
         docs: Sorts users in descending order based on their update date
     source:
       openapi: ../../../openapi/referenced-specs/v2.yml
-  UsersUpdateRequestData:
+  UserAccountAddedPayloadPayloadData:
+    docs: The data about the user account that was added
     properties:
-      name:
+      accept-privacy-policy: optional<boolean>
+      accept-communications: optional<boolean>
+      email: optional<string>
+      name: optional<string>
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+    inline: true
+  UserAccountAddedPayloadPayload:
+    properties:
+      data:
+        type: optional<UserAccountAddedPayloadPayloadData>
+        docs: The data about the user account that was added
+      id:
         type: optional<string>
-        docs: |
-          The name of the user
-      accept-privacy:
+        docs: Unique identifier for the User
+      isEmailVerified:
         type: optional<boolean>
-        docs: |
-          Boolean indicating if the user has accepted the privacy policy
-      accept-communications:
+        docs: Shows whether the user has verified their email address
+      lastUpdated:
+        type: optional<datetime>
+        docs: The timestamp the user was updated
+      invitedOn:
+        type: optional<datetime>
+        docs: The timestamp the user was invited
+      createdOn:
+        type: optional<datetime>
+        docs: The timestamp the user was created
+      lastLogin:
+        type: optional<datetime>
+        docs: The timestamp the user was logged in
+      status: optional<root.UserStatus>
+      accessGroups:
+        type: optional<list<root.UserAccessGroupsItem>>
+        docs: Access groups the user belongs to
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+    inline: true
+  UserAccountAddedPayload:
+    properties:
+      triggerType: optional<literal<"user_account_added">>
+      payload: optional<UserAccountAddedPayloadPayload>
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  UserAccountUpdatedPayloadPayloadData:
+    docs: The data about the user account that was added
+    properties:
+      accept-privacy-policy: optional<boolean>
+      accept-communications: optional<boolean>
+      email: optional<string>
+      name: optional<string>
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+    inline: true
+  UserAccountUpdatedPayloadPayload:
+    properties:
+      data:
+        type: optional<UserAccountUpdatedPayloadPayloadData>
+        docs: The data about the user account that was added
+      id:
+        type: optional<string>
+        docs: Unique identifier for the User
+      isEmailVerified:
         type: optional<boolean>
-        docs: |
-          Boolean indicating if the user has accepted to receive communications
+        docs: Shows whether the user has verified their email address
+      lastUpdated:
+        type: optional<datetime>
+        docs: The timestamp the user was updated
+      invitedOn:
+        type: optional<datetime>
+        docs: The timestamp the user was invited
+      createdOn:
+        type: optional<datetime>
+        docs: The timestamp the user was created
+      lastLogin:
+        type: optional<datetime>
+        docs: The timestamp the user was logged in
+      status: optional<root.UserStatus>
+      accessGroups:
+        type: optional<list<root.UserAccessGroupsItem>>
+        docs: Access groups the user belongs to
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+    inline: true
+  UserAccountUpdatedPayload:
+    properties:
+      triggerType: optional<literal<"user_account_updated">>
+      payload: optional<UserAccountUpdatedPayloadPayload>
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  UserAccountDeletedPayloadPayloadData:
+    docs: The data about the user account that was added
+    properties:
+      accept-privacy-policy: optional<boolean>
+      accept-communications: optional<boolean>
+      email: optional<string>
+      name: optional<string>
     source:
       openapi: ../../../openapi/referenced-specs/v2.yml
     inline: true
+  UserAccountDeletedPayloadPayload:
+    properties:
+      data:
+        type: optional<UserAccountDeletedPayloadPayloadData>
+        docs: The data about the user account that was added
+      id:
+        type: optional<string>
+        docs: Unique identifier for the User
+      isEmailVerified:
+        type: optional<boolean>
+        docs: Shows whether the user has verified their email address
+      lastUpdated:
+        type: optional<datetime>
+        docs: The timestamp the user was updated
+      invitedOn:
+        type: optional<datetime>
+        docs: The timestamp the user was invited
+      createdOn:
+        type: optional<datetime>
+        docs: The timestamp the user was created
+      lastLogin:
+        type: optional<datetime>
+        docs: The timestamp the user was logged in
+      status: optional<root.UserStatus>
+      accessGroups:
+        type: optional<list<root.UserAccessGroupsItem>>
+        docs: Access groups the user belongs to
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+    inline: true
+  UserAccountDeletedPayload:
+    properties:
+      triggerType: optional<literal<"user_account_deleted">>
+      payload: optional<UserAccountDeletedPayloadPayload>
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
 imports:
   root: __package__.yml
 service:
@@ -59,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
 
@@ -104,6 +227,10 @@ service:
       examples:
         - path-parameters:
             site_id: 580e63e98c9a982ac9b8b741
+          query-parameters:
+            offset: 1.1
+            limit: 1.1
+            sort: CreatedOn
           response:
             body:
               count: 5
@@ -164,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
 
@@ -216,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
 
@@ -245,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 
 
@@ -264,16 +397,7 @@ service:
           docs: Unique identifier for a User
       display-name: Update User
       request:
-        name: UsersUpdateRequest
-        body:
-          properties:
-            data: optional<UsersUpdateRequestData>
-            accessGroups:
-              type: optional<list<string>>
-              docs: >
-                An array of access group slugs. Access groups are assigned to
-                the user as type `admin` and the user remains in the group until
-                removed.
+        body: root.User
         content-type: application/json
       response:
         docs: Request was successful
@@ -291,14 +415,16 @@ service:
             site_id: 580e63e98c9a982ac9b8b741
             user_id: 580e63e98c9a982ac9b8b741
           request:
-            data:
-              name: Some One
-              accept-privacy: false
-              accept-communications: false
+            id: 6287ec36a841b25637c663df
+            isEmailVerified: true
+            lastUpdated: '2022-05-20T13:46:12Z'
+            invitedOn: '2022-05-20T13:46:12Z'
+            createdOn: '2022-05-20T13:46:12Z'
+            lastLogin: '2022-05-20T13:46:12Z'
+            status: verified
             accessGroups:
-              - webflowers
-              - platinum
-              - free-tier
+              - slug: webflowers
+                type: admin
           response:
             body:
               id: 6287ec36a841b25637c663df
@@ -321,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. 
 
@@ -372,7 +500,7 @@ service:
           request:
             email: some.one@home.com
             accessGroups:
-              - webflowers
+              - accessGroups
           response:
             body:
               id: 6287ec36a841b25637c663df
@@ -394,3 +522,73 @@ service:
                   additionalProperties: additionalProperties
   source:
     openapi: ../../../openapi/referenced-specs/v2.yml
+webhooks:
+  user_account_added:
+    audiences: []
+    method: POST
+    display-name: New User Added
+    headers: {}
+    payload: UserAccountAddedPayload
+    examples:
+      - payload:
+          triggerType: user_account_added
+          payload:
+            id: 6287ec36a841b25637c663df
+            lastUpdated: '2022-05-20T13:46:12.093Z'
+            createdOn: '2022-05-20T13:46:12.093Z'
+            isEmailVerified: false
+            data:
+              accept-privacy: false
+              accept-communications: false
+              email: arthur.dent@heartofgold.ship
+              name: Arthur Dent
+            accessGroups:
+              - slug: webflowers
+                type: admin
+    docs: Information about a new user account
+  user_account_updated:
+    audiences: []
+    method: POST
+    display-name: Account Updated
+    headers: {}
+    payload: UserAccountUpdatedPayload
+    examples:
+      - payload:
+          triggerType: user_account_updated
+          payload:
+            id: 6287ec36a841b25637c663df
+            lastUpdated: '2022-05-20T13:46:12.093Z'
+            createdOn: '2022-05-20T13:46:12.093Z'
+            isEmailVerified: false
+            data:
+              accept-privacy: false
+              accept-communications: false
+              email: arthur.dent@heartofgold.ship
+              name: Arthur Dent
+            accessGroups:
+              - slug: webflowers
+                type: admin
+    docs: Information about an updated user account
+  user_account_deleted:
+    audiences: []
+    method: POST
+    display-name: Account Deleted
+    headers: {}
+    payload: UserAccountDeletedPayload
+    examples:
+      - payload:
+          triggerType: user_account_deleted
+          payload:
+            id: 6287ec36a841b25637c663df
+            lastUpdated: '2022-05-20T13:46:12.093Z'
+            createdOn: '2022-05-20T13:46:12.093Z'
+            isEmailVerified: false
+            data:
+              accept-privacy: false
+              accept-communications: false
+              email: arthur.dent@heartofgold.ship
+              name: Arthur Dent
+            accessGroups:
+              - slug: webflowers
+                type: admin
+    docs: Information about a deleted user account

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.56.34"
+  "version" : "0.101.3"
 }

package/Client.d.ts

@@ -22,7 +22,11 @@ import { Workspaces } from "./api/resources/workspaces/client/Client";
 export declare namespace WebflowClient {
     interface Options {
         environment?: core.Supplier<environments.WebflowEnvironment | environments.WebflowEnvironmentUrls>;
-        accessToken: core.Supplier<core.BearerToken>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        accessToken?: core.Supplier<core.BearerToken | undefined>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
     interface RequestOptions {
         /** The maximum time to wait for a response in seconds. */
@@ -32,42 +36,42 @@ export declare namespace WebflowClient {
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
         /** Additional headers to include in the request. */
-        headers?: Record<string, string>;
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
 }
 export declare class WebflowClient {
     protected readonly _options: WebflowClient.Options;
-    constructor(_options: WebflowClient.Options);
     protected _token: Token | undefined;
-    get token(): Token;
     protected _sites: Sites | undefined;
-    get sites(): Sites;
     protected _collections: Collections | undefined;
-    get collections(): Collections;
     protected _pages: Pages | undefined;
-    get pages(): Pages;
     protected _components: Components | undefined;
-    get components(): Components;
     protected _scripts: Scripts | undefined;
-    get scripts(): Scripts;
     protected _assets: Assets | undefined;
-    get assets(): Assets;
     protected _webhooks: Webhooks | undefined;
-    get webhooks(): Webhooks;
     protected _forms: Forms | undefined;
-    get forms(): Forms;
     protected _users: Users | undefined;
-    get users(): Users;
     protected _accessGroups: AccessGroups | undefined;
-    get accessGroups(): AccessGroups;
     protected _products: Products | undefined;
-    get products(): Products;
     protected _orders: Orders | undefined;
-    get orders(): Orders;
     protected _inventory: Inventory | undefined;
-    get inventory(): Inventory;
     protected _ecommerce: Ecommerce | undefined;
-    get ecommerce(): Ecommerce;
     protected _workspaces: Workspaces | undefined;
+    constructor(_options?: WebflowClient.Options);
+    get token(): Token;
+    get sites(): Sites;
+    get collections(): Collections;
+    get pages(): Pages;
+    get components(): Components;
+    get scripts(): Scripts;
+    get assets(): Assets;
+    get webhooks(): Webhooks;
+    get forms(): Forms;
+    get users(): Users;
+    get accessGroups(): AccessGroups;
+    get products(): Products;
+    get orders(): Orders;
+    get inventory(): Inventory;
+    get ecommerce(): Ecommerce;
     get workspaces(): Workspaces;
 }