webflow-api 2.4.0 → 2.5.0

package/.mock/definition/users.yml

@@ -0,0 +1,392 @@
+types:
+  UsersListRequestSort:
+    enum:
+      - value: CreatedOn
+        name: CreatedOnAscending
+        docs: Sorts users in ascending order based on their created date
+      - value: '-CreatedOn'
+        name: CreatedOnDescending
+        docs: Sorts users in descending order based on their created date
+      - value: Email
+        name: EmailAscending
+        docs: Sorts users in ascending order based on their email
+      - value: '-Email'
+        name: EmailDescending
+        docs: Sorts users in descending order based on their email
+      - value: Status
+        name: StatusAscending
+        docs: Sorts users in ascending order based on their status
+      - value: '-Status'
+        name: StatusDescending
+        docs: Sorts users in descending order based on their status
+      - value: LastLogin
+        name: LastLoginAscending
+        docs: Sorts users in ascending order based on their last login date
+      - value: '-LastLogin'
+        name: LastLoginDescending
+        docs: Sorts users in descending order based on their last login date
+      - value: UpdatedOn
+        name: UpdatedOnAscending
+        docs: Sorts users in ascending order based on their update date
+      - value: '-UpdatedOn'
+        name: UpdatedOnDescending
+        docs: Sorts users in descending order based on their update date
+    source:
+      openapi: ../../../referenced-specs/v2.yml
+  UsersUpdateRequestData:
+    properties:
+      name:
+        type: optional<string>
+        docs: |
+          The name of the user
+      accept-privacy:
+        type: optional<boolean>
+        docs: |
+          Boolean indicating if the user has accepted the privacy policy
+      accept-communications:
+        type: optional<boolean>
+        docs: |
+          Boolean indicating if the user has accepted to receive communications
+    source:
+      openapi: ../../../referenced-specs/v2.yml
+    inline: true
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    list:
+      path: /sites/{site_id}/users
+      method: GET
+      auth: true
+      docs: |
+        Get a list of users for a site
+
+        Required scope | `users:read`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+      display-name: List Users
+      request:
+        name: UsersListRequest
+        query-parameters:
+          offset:
+            type: optional<double>
+            docs: >-
+              Offset used for pagination if the results have more than limit
+              records
+          limit:
+            type: optional<double>
+            docs: 'Maximum number of records to be returned (max limit: 100)'
+          sort:
+            type: optional<UsersListRequestSort>
+            docs: |
+              Sort string to use when ordering users
+
+              Example(`CreatedOn`, `Email`, `Status`, `LastLogin`, `UpdatedOn`).
+
+              Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`)
+      response:
+        docs: Request was successful
+        type: root.UserList
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.ForbiddenError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          response:
+            body:
+              count: 5
+              limit: 5
+              offset: 0
+              total: 201
+              users:
+                - id: 6287ec36a841b25637c663df
+                  isEmailVerified: false
+                  lastUpdated: '2022-05-20T13:46:12Z'
+                  invitedOn: '2016-10-24T19:41:29Z'
+                  createdOn: '2022-05-20T13:46:12Z'
+                  lastLogin: '2016-10-24T19:41:29Z'
+                  status: unverified
+                  accessGroups:
+                    - slug: vogon-construction-crew
+                      type: admin
+                - id: 6287ec36a841b25637c663f0
+                  isEmailVerified: false
+                  lastUpdated: '2022-05-19T05:32:04Z'
+                  invitedOn: '2016-10-24T19:41:29Z'
+                  createdOn: '2022-05-19T05:32:04Z'
+                  lastLogin: '2016-10-24T19:41:29Z'
+                  status: unverified
+                  accessGroups:
+                    - slug: improbability-drive-test-subjects
+                      type: admin
+                - id: 6287ec36a841b25637c663d9
+                  isEmailVerified: true
+                  lastUpdated: '2022-05-17T03:34:06Z'
+                  invitedOn: '2016-10-24T19:41:29Z'
+                  createdOn: '2022-05-17T03:34:06Z'
+                  lastLogin: '2016-10-24T19:41:29Z'
+                  status: verified
+                  accessGroups:
+                    - slug: heart-of-gold-crew
+                      type: admin
+                - id: 6287ec37a841b25637c6641b
+                  isEmailVerified: false
+                  lastUpdated: '2022-05-15T03:46:09Z'
+                  invitedOn: '2016-10-24T19:41:29Z'
+                  createdOn: '2022-05-15T03:46:09Z'
+                  lastLogin: '2016-10-24T19:41:29Z'
+                  status: unverified
+                  accessGroups:
+                    - slug: hitchhikers-guide-research-team
+                      type: admin
+                - id: 6287ec37a841b25637c66449
+                  isEmailVerified: true
+                  lastUpdated: '2022-05-15T02:55:38Z'
+                  invitedOn: '2016-10-24T19:41:29Z'
+                  createdOn: '2022-05-15T02:55:38Z'
+                  lastLogin: '2016-10-24T19:41:29Z'
+                  status: verified
+                  accessGroups:
+                    - slug: milliways-reservationists
+                      type: admin
+    get:
+      path: /sites/{site_id}/users/{user_id}
+      method: GET
+      auth: true
+      docs: |
+        Get a User by ID
+
+        Required scope | `users:read`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+        user_id:
+          type: string
+          docs: Unique identifier for a User
+      display-name: Get User
+      response:
+        docs: Request was successful
+        type: root.User
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.ForbiddenError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+            user_id: 580e63e98c9a982ac9b8b741
+          response:
+            body:
+              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:
+                - slug: webflowers
+                  type: admin
+              data:
+                data:
+                  name: name
+                  email: email
+                  accept-privacy: true
+                  accept-communications: true
+                  additionalProperties: additionalProperties
+    delete:
+      path: /sites/{site_id}/users/{user_id}
+      method: DELETE
+      auth: true
+      docs: |
+        Delete a User by ID
+
+        Required scope | `users:write`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+        user_id:
+          type: string
+          docs: Unique identifier for a User
+      display-name: Delete User
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.ForbiddenError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+            user_id: 580e63e98c9a982ac9b8b741
+    update:
+      path: /sites/{site_id}/users/{user_id}
+      method: PATCH
+      auth: true
+      docs: |
+        Update a User by ID 
+
+          Required scope | `users:write`
+
+        <Note class="notice">The <code>email</code> and <code>password</code>
+        fields cannot be updated using this endpoint</Note>
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+        user_id:
+          type: string
+          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.
+        content-type: application/json
+      response:
+        docs: Request was successful
+        type: root.User
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.ForbiddenError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+            user_id: 580e63e98c9a982ac9b8b741
+          request:
+            data:
+              name: Some One
+              accept-privacy: false
+              accept-communications: false
+            accessGroups:
+              - webflowers
+              - platinum
+              - free-tier
+          response:
+            body:
+              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:
+                - slug: webflowers
+                  type: admin
+              data:
+                data:
+                  name: name
+                  email: email
+                  accept-privacy: true
+                  accept-communications: true
+                  additionalProperties: additionalProperties
+    invite:
+      path: /sites/{site_id}/users/invite
+      method: POST
+      auth: true
+      docs: >
+        Create and invite a user with an email address. 
+
+
+        The user will be sent and invite via email, which they will need to
+        accept in order to join paid any paid access group. 
+
+
+        Required scope | `users:write`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+      display-name: Create and Invite a User
+      request:
+        name: UsersInviteRequest
+        body:
+          properties:
+            email:
+              type: string
+              docs: Email address of user to send invite to
+              validation:
+                format: email
+            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.
+        content-type: application/json
+      response:
+        docs: Request was successful
+        type: root.User
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.ForbiddenError
+        - root.NotFoundError
+        - root.ConflictError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          request:
+            email: some.one@home.com
+            accessGroups:
+              - webflowers
+          response:
+            body:
+              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:
+                - slug: webflowers
+                  type: admin
+              data:
+                data:
+                  name: name
+                  email: email
+                  accept-privacy: true
+                  accept-communications: true
+                  additionalProperties: additionalProperties
+  source:
+    openapi: ../../../referenced-specs/v2.yml

package/.mock/definition/webhooks.yml

@@ -0,0 +1,189 @@
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    list:
+      path: /sites/{site_id}/webhooks
+      method: GET
+      auth: true
+      docs: |
+        List all App-created Webhooks registered for a given site
+
+        Required scope | `sites:read`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+      display-name: List Webhooks
+      response:
+        docs: Request was successful
+        type: root.WebhookList
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          response:
+            body:
+              pagination:
+                limit: 100
+                offset: 0
+                total: 100
+              webhooks:
+                - id: 57ca0a9e418c504a6e1acbb6
+                  triggerType: form_submission
+                  url: https://webhook.site/7f7f7f7f-7f7f-7f7f-7f7f-7f7f7f7f7f7f
+                  workspaceId: 4f4e46fd476ea8c507000001
+                  siteId: 562ac0395358780a1f5e6fbd
+                  filter:
+                    name: Email Form
+                  lastTriggered: '2023-02-08T23:59:28Z'
+                  createdOn: '2016-09-02T23:26:22Z'
+                - id: 578d85cce0c47cd2865f4cf2
+                  triggerType: form_submission
+                  url: https://webhook.site/7f7f7f7f-7f7f-7f7f-7f7f-7f7f7f7f7f7f
+                  workspaceId: 4f4e46fd476ea8c507000001
+                  siteId: 562ac0395358780a1f5e6fbd
+                  filter:
+                    name: Email Form
+                  lastTriggered: '2023-02-08T23:59:28Z'
+                  createdOn: '2016-07-19T01:43:40Z'
+                - id: 578d85cce0c47cd2865f4cf3
+                  triggerType: form_submission
+                  url: https://webhook.site/7f7f7f7f-7f7f-7f7f-7f7f-7f7f7f7f7f7f
+                  workspaceId: 4f4e46fd476ea8c507000001
+                  siteId: 562ac0395358780a1f5e6fbd
+                  filter:
+                    name: Email Form
+                  lastTriggered: '2023-02-08T23:59:28Z'
+                  createdOn: '2016-07-19T01:43:40Z'
+    create:
+      path: /sites/{site_id}/webhooks
+      method: POST
+      auth: true
+      docs: >
+        Create a new Webhook.
+
+
+        Limit of 75 registrations per `triggerType`, per site.
+
+        <blockquote class="callout callout_info" theme="📘">Access to this
+        endpoint requires a bearer token from a <a
+        href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data
+        Client App</a>.</blockquote>    
+
+        Required scope | `sites:write`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+      display-name: Create Webhook
+      request:
+        body: root.Webhook
+        content-type: application/json
+      response:
+        docs: Request was successful
+        type: root.Webhook
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          request:
+            id: 582266e0cd48de0f0e3c6d8b
+            triggerType: form_submission
+            url: https://webhook.site/7f7f7f7f-7f7f-7f7f-7f7f-7f7f7f7f7f7f
+            workspaceId: 4f4e46fd476ea8c507000001
+            siteId: 562ac0395358780a1f5e6fbd
+            lastTriggered: '2023-02-08T23:59:28Z'
+            createdOn: '2022-11-08T23:59:28Z'
+          response:
+            body:
+              id: 582266e0cd48de0f0e3c6d8b
+              triggerType: form_submission
+              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:
+      path: /webhooks/{webhook_id}
+      method: GET
+      auth: true
+      docs: |
+        Get a specific Webhook instance
+
+        Required scope: `sites:read`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        webhook_id:
+          type: string
+          docs: Unique identifier for a Webhook
+      display-name: Get Webhook
+      response:
+        docs: Request was successful
+        type: root.Webhook
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            webhook_id: 580e64008c9a982ac9b8b754
+          response:
+            body:
+              id: 582266e0cd48de0f0e3c6d8b
+              triggerType: form_submission
+              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:
+      path: /webhooks/{webhook_id}
+      method: DELETE
+      auth: true
+      docs: |
+        Remove a Webhook
+
+        Required scope: `sites:read`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        webhook_id:
+          type: string
+          docs: Unique identifier for a Webhook
+      display-name: Remove Webhook
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            webhook_id: 580e64008c9a982ac9b8b754
+  source:
+    openapi: ../../../referenced-specs/v2.yml
+  display-name: Webhooks

package/.mock/fern.config.json

@@ -0,0 +1,4 @@
+{
+  "organization" : "webflow",
+  "version" : "0.45.2"
+}

package/Client.d.ts

@@ -29,6 +29,8 @@ export declare namespace WebflowClient {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
     }
 }
 export declare class WebflowClient {

package/README.md

@@ -12,34 +12,6 @@ The SDK contains typings and request builders for the Webflow Data API.
 
 Explore the [API reference documentation](https://developers.webflow.com/reference/rest-introduction).
 
-## V2 Migration Guide
-
-> The SDK was rewritten in V2 and is now programatically generated from our OpenAPI spec. As part of this release there are some breaking changes.
-
-#### Client Instantiation
-The SDK exports `WebflowClient` instead of `Webflow`. The client now takes `accessToken` instead of `token`. 
-
-```ts
-const webflow = new WebflowClient({ accessToken: "..." }); 
-```
-
-#### Oauth 
-The `WebflowClient` exports static methods that you can use for OAuth. These were previously on `Webflow`. 
-
-`webflow.authorizeUrl` -> `WebflowClient.authorizeURL`
-
-`webflow.accessToken` -> `WebflowClient.getAccessToken`
-
-`webflow.revokeToken` -> `WebflowClient.revokeToken`
-
-#### HTTP Client
-The SDK no longer uses Axios and defaults to fetch. The SDK supports multiple runtimes and will handle
-using a fetch implementation if available or will default to `node-fetch`. 
-
-### Resources
-Previously the SDK only supported the most important resources, such as site and user. Now the SDK supports
-methods on a variety of different endpoints such as `collections`, `assets`, `forms`, `inventory`, `orders`, etc. 
-
 ## Installation
 
 Add this dependency to your project's package.json file:
@@ -65,7 +37,28 @@ import { WebflowClient } from "webflow-api";
 
 const webflow = new WebflowClient({ accessToken });
 
-const site = await webflow.sites.get("site-id");
+// Env. variables
+// in format of string, e.g.: "639656400769508adc12fe42"
+const site_id = process.env.SITE_ID;
+const custom_domain_id_1 = process.env.CUSTOM_DOMAIN_ID_1;
+const custom_domain_id_2 = process.env.CUSTOM_DOMAIN_ID_2;
+
+// Sites
+
+// List Sites
+const sites = await webflow.sites.list();
+
+// Get Site
+const site = await webflow.sites.get("site_id");
+
+// Get Custom Domains
+const customDomains = await webflow.sites.getCustomDomain(site_id);
+
+// Publish Site
+const site = await webflow.sites.publish(site_id, {
+  customDomains: [custom_domain_id_1, custom_domain_id_2],
+  publishToWebflowSubdomain: true,
+});
 ```
 
 ## OAuth
@@ -85,7 +78,7 @@ const authorizeUrl = WebflowClient.authorizeURL({
     state: "your_state",
     scope: "sites:read",
     clientId: "your_client_id",
-    redirctUri: "your_redirect_uri",
+    redirectUri: "your_redirect_uri",
 });
 
 console.log(authorizeUrl);

package/api/errors/InternalServerError.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 Webflow from "../index";
 export declare class InternalServerError extends errors.WebflowError {
-    constructor(body?: unknown);
+    constructor(body: Webflow.Error_);
 }

package/api/errors/NotFoundError.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 Webflow from "../index";
 export declare class NotFoundError extends errors.WebflowError {
-    constructor(body?: unknown);
+    constructor(body: Webflow.Error_);
 }

package/api/errors/TooManyRequestsError.d.ts

@@ -4,5 +4,5 @@
 import * as errors from "../../errors/index";
 import * as Webflow from "../index";
 export declare class TooManyRequestsError extends errors.WebflowError {
-    constructor(body: Webflow.TooManyRequestsErrorBody);
+    constructor(body: Webflow.Error_);
 }