webflow-api 3.1.4 → 3.2.0

package/.mock/definition/products.yml

@@ -73,11 +73,11 @@ service:
                         - id: Color
                           name: Color
                           enum:
-                            - id: id
+                            - id: royal-blue
                               name: Royal Blue
                               slug: royal-blue
                   skus:
-                    - id: 580e63fc8c9a982ac9b8b745
+                    - id: 66072fb71b89448912e2681c
                       cmsLocaleId: 653ad57de882f528b32e810e
                       lastPublished: '2023-03-17T18:47:35Z'
                       lastUpdated: '2023-03-17T18:47:35Z'
@@ -99,7 +99,7 @@ service:
                           - id: Color
                             name: Color
                             enum:
-                              - id: id
+                              - id: royal-blue
                                 name: Royal Blue
                                 slug: royal-blue
               pagination:
@@ -219,16 +219,16 @@ service:
                     - id: Color
                       name: Color
                       enum:
-                        - id: id
+                        - id: royal-blue
                           name: Royal Blue
                           slug: royal-blue
-                  categories:
-                    - categories
+                  category:
+                    - category
                   tax-category: standard-taxable
                   default-sku: default-sku
                   ec-product-type: ff42fee0113744f693a764e3431a9cc2
               skus:
-                - id: 580e63fc8c9a982ac9b8b745
+                - id: 66072fb71b89448912e2681c
                   cmsLocaleId: 653ad57de882f528b32e810e
                   lastPublished: '2023-03-17T18:47:35Z'
                   lastUpdated: '2023-03-17T18:47:35Z'
@@ -250,7 +250,7 @@ service:
                       - id: Color
                         name: Color
                         enum:
-                          - id: id
+                          - id: royal-blue
                             name: Royal Blue
                             slug: royal-blue
     get:
@@ -307,16 +307,16 @@ service:
                     - id: Color
                       name: Color
                       enum:
-                        - id: id
+                        - id: royal-blue
                           name: Royal Blue
                           slug: royal-blue
-                  categories:
-                    - categories
+                  category:
+                    - category
                   tax-category: standard-taxable
                   default-sku: default-sku
                   ec-product-type: ff42fee0113744f693a764e3431a9cc2
               skus:
-                - id: 580e63fc8c9a982ac9b8b745
+                - id: 66072fb71b89448912e2681c
                   cmsLocaleId: 653ad57de882f528b32e810e
                   lastPublished: '2023-03-17T18:47:35Z'
                   lastUpdated: '2023-03-17T18:47:35Z'
@@ -338,7 +338,7 @@ service:
                       - id: Color
                         name: Color
                         enum:
-                          - id: id
+                          - id: royal-blue
                             name: Royal Blue
                             slug: royal-blue
     update:
@@ -408,11 +408,11 @@ service:
                   - id: Color
                     name: Color
                     enum:
-                      - id: id
+                      - id: royal-blue
                         name: Royal Blue
                         slug: royal-blue
-                categories:
-                  - categories
+                category:
+                  - category
                 tax-category: standard-taxable
                 default-sku: default-sku
                 ec-product-type: ff42fee0113744f693a764e3431a9cc2
@@ -468,7 +468,12 @@ service:
             product_id: 580e63fc8c9a982ac9b8b745
           request:
             skus:
-              - fieldData:
+              - id: 66072fb71b89448912e2681c
+                cmsLocaleId: 653ad57de882f528b32e810e
+                lastPublished: '2023-03-17T18:47:35Z'
+                lastUpdated: '2023-03-17T18:47:35Z'
+                createdOn: '2023-03-17T18:47:35Z'
+                fieldData:
                   name: Colorful T-shirt - Default
                   slug: colorful-t-shirt-default
                   price:
@@ -478,7 +483,7 @@ service:
           response:
             body:
               skus:
-                - id: 580e63fc8c9a982ac9b8b745
+                - id: 66072fb71b89448912e2681c
                   cmsLocaleId: 653ad57de882f528b32e810e
                   lastPublished: '2023-03-17T18:47:35Z'
                   lastUpdated: '2023-03-17T18:47:35Z'
@@ -500,7 +505,7 @@ service:
                       - id: Color
                         name: Color
                         enum:
-                          - id: id
+                          - id: royal-blue
                             name: Royal Blue
                             slug: royal-blue
     update-sku:
@@ -556,6 +561,11 @@ service:
             sku_id: 5e8518516e147040726cc415
           request:
             sku:
+              id: 66072fb71b89448912e2681c
+              cmsLocaleId: 653ad57de882f528b32e810e
+              lastPublished: '2023-03-17T18:47:35Z'
+              lastUpdated: '2023-03-17T18:47:35Z'
+              createdOn: '2023-03-17T18:47:35Z'
               fieldData:
                 name: Colorful T-shirt - Default
                 slug: colorful-t-shirt-default
@@ -565,7 +575,7 @@ service:
                   currency: USD
           response:
             body:
-              id: 580e63fc8c9a982ac9b8b745
+              id: 66072fb71b89448912e2681c
               cmsLocaleId: 653ad57de882f528b32e810e
               lastPublished: '2023-03-17T18:47:35Z'
               lastUpdated: '2023-03-17T18:47:35Z'
@@ -598,7 +608,7 @@ service:
                   - id: Color
                     name: Color
                     enum:
-                      - id: id
+                      - id: royal-blue
                         name: Royal Blue
                         slug: royal-blue
   source:

package/.mock/definition/scripts.yml

@@ -65,6 +65,10 @@ service:
                   createdOn: '2022-10-26T00:28:54.191Z'
                   lastUpdated: lastUpdated
                   version: 1.0.0
+              pagination:
+                limit: 100
+                offset: 0
+                total: 3
     register-hosted:
       path: /sites/{site_id}/registered_scripts/hosted
       method: POST

package/.mock/definition/sites/comments.yml

@@ -106,7 +106,6 @@ service:
                   siteId: 679826b3b20b045e176bc4b5
                   pageId: 679826b3b20b045e176bc4bc
                   localeId: 67993753d910db250db64b3e
-                  itemId: 580e64008c9a982ac9b8b754
                   breakpoint: main
                   url: >-
                     https://webflow.com/design/site-slug-4ec832?workflow=comment&commentId=679d2ddb5196117ad04d1ff8&pageId=679826b3b20b045e176bc4bc
@@ -126,7 +125,6 @@ service:
                   siteId: 679826b3b20b045e176bc4b5
                   pageId: 679826b3b20b045e176bc4bc
                   localeId: 67993753d910db250db64b3e
-                  itemId: 580e64008c9a982ac9b8b754
                   breakpoint: main
                   url: >-
                     https://webflow.com/design/site-slug-4ec832?workflow=comment&commentId=679d2ddb5196117ad04d1ff8&pageId=679826b3b20b045e176bc4bc

package/.mock/definition/sites.yml

@@ -68,7 +68,7 @@ service:
                 - id: 589a331aa51e760df7ccb89d
                   url: test-api-domain.com
                   lastPublished: '2022-12-07T16:51:37Z'
-              dataCollectionEnabled: false
+              dataCollectionEnabled: true
               dataCollectionType: always
     list:
       path: /sites
@@ -426,11 +426,15 @@ service:
       method: POST
       auth: true
       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 +468,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 +499,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/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:
@@ -264,16 +385,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 +403,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
@@ -372,7 +486,7 @@ service:
           request:
             email: some.one@home.com
             accessGroups:
-              - webflowers
+              - accessGroups
           response:
             body:
               id: 6287ec36a841b25637c663df
@@ -394,3 +508,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/fern.config.json

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

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>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
         accessToken: core.Supplier<core.BearerToken>;
+        /** 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;
 }

package/Client.js

@@ -2,8 +2,43 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebflowClient = void 0;
+const core = __importStar(require("./core"));
+const headers_js_1 = require("./core/headers.js");
 const Client_1 = require("./api/resources/token/client/Client");
 const Client_2 = require("./api/resources/sites/client/Client");
 const Client_3 = require("./api/resources/collections/client/Client");
@@ -22,7 +57,14 @@ const Client_15 = require("./api/resources/ecommerce/client/Client");
 const Client_16 = require("./api/resources/workspaces/client/Client");
 class WebflowClient {
     constructor(_options) {
-        this._options = _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-Runtime": core.RUNTIME.type,
+                "X-Fern-Runtime-Version": core.RUNTIME.version,
+            }, _options === null || _options === void 0 ? void 0 : _options.headers) });
     }
     get token() {
         var _a;

package/api/errors/BadRequestError.d.ts

@@ -2,6 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as errors from "../../errors/index";
+import * as core from "../../core";
 export declare class BadRequestError extends errors.WebflowError {
-    constructor(body?: unknown);
+    constructor(body?: unknown, rawResponse?: core.RawResponse);
 }