webflow-api 3.1.1 → 3.1.3

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

@@ -0,0 +1,325 @@
+types:
+  CommentsListCommentThreadsRequestSortBy:
+    enum:
+      - createdOn
+      - lastUpdated
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  CommentsListCommentThreadsRequestSortOrder:
+    enum:
+      - asc
+      - desc
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  CommentsGetCommentThreadRequestSortBy:
+    enum:
+      - createdOn
+      - lastUpdated
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  CommentsGetCommentThreadRequestSortOrder:
+    enum:
+      - asc
+      - desc
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  CommentsListCommentRepliesRequestSortBy:
+    enum:
+      - createdOn
+      - lastUpdated
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  CommentsListCommentRepliesRequestSortOrder:
+    enum:
+      - asc
+      - desc
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+imports:
+  root: ../__package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    list-comment-threads:
+      path: /sites/{site_id}/comments
+      method: GET
+      auth: true
+      docs: |
+        List all comment threads for a site.
+
+        <Note title="Timing of comment threads">
+          There may be a delay of up to 5 minutes before new comments appear in the system.
+        </Note>
+
+        Required scope | `comments:read`
+      source:
+        openapi: ../../../openapi/referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+      display-name: List Comment Threads
+      request:
+        name: CommentsListCommentThreadsRequest
+        query-parameters:
+          localeId:
+            type: optional<string>
+            docs: >-
+              Unique identifier for a specific locale. Applicable, when using
+              localization.
+          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)'
+          sortBy:
+            type: optional<CommentsListCommentThreadsRequestSortBy>
+            docs: >-
+              Sort results by the provided value. Only allowed when sortOrder is
+              provided.
+          sortOrder:
+            type: optional<CommentsListCommentThreadsRequestSortOrder>
+            docs: Sorts the results by asc or desc
+      response:
+        docs: Request was successful
+        type: root.CommentThreadList
+        status-code: 200
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          query-parameters:
+            localeId: 65427cf400e02b306eaa04a0
+          response:
+            body:
+              comments:
+                - id: 679d2ddb5196117ad04d1ffa
+                  siteId: 679826b3b20b045e176bc4b5
+                  pageId: 679826b3b20b045e176bc4bc
+                  localeId: 67993753d910db250db64b3e
+                  itemId: 580e64008c9a982ac9b8b754
+                  breakpoint: main
+                  url: >-
+                    https://webflow.com/design/site-slug-4ec832?workflow=comment&commentId=679d2ddb5196117ad04d1ff8&pageId=679826b3b20b045e176bc4bc
+                  content: 'Let''s go to the pub! [[6287ec36a841b25637c663df]] '
+                  isResolved: false
+                  author:
+                    userId: 6287ec36a841b25637c663df
+                    email: ford.prefect@heartofgold.spaceship
+                    name: Ford Prefect
+                  mentionedUsers:
+                    - userId: 6287ec36a841b25637c663df
+                      email: arthur.dent@heartofgold.spaceship
+                      name: Arthur Dent
+                  createdOn: '2025-01-31T20:08:59.759Z'
+                  lastUpdated: '2025-01-31T20:08:59.759Z'
+                - id: 679d2ddb5196117ad04d1ffc
+                  siteId: 679826b3b20b045e176bc4b5
+                  pageId: 679826b3b20b045e176bc4bc
+                  localeId: 67993753d910db250db64b3e
+                  itemId: 580e64008c9a982ac9b8b754
+                  breakpoint: main
+                  url: >-
+                    https://webflow.com/design/site-slug-4ec832?workflow=comment&commentId=679d2ddb5196117ad04d1ff8&pageId=679826b3b20b045e176bc4bc
+                  content: >-
+                    You have five minutes left to drink it
+                    [[6287ec36a841b25637c663df]] 
+                  isResolved: false
+                  author:
+                    userId: 6287ec36a841b25637c663df
+                    email: ford.prefect@heartofgold.spaceship
+                    name: Ford Prefect
+                  mentionedUsers:
+                    - userId: 6287ec36a841b25637c663df
+                      email: arthur.dent@heartofgold.spaceship
+                      name: Arthur Dent
+                  createdOn: '2025-01-31T20:08:59.759Z'
+                  lastUpdated: '2025-01-31T20:08:59.759Z'
+              pagination:
+                limit: 2
+                offset: 0
+                total: 2
+    get-comment-thread:
+      path: /sites/{site_id}/comments/{comment_thread_id}
+      method: GET
+      auth: true
+      docs: |
+        Get details of a specific comment thread.
+
+          <Note title="Timing of comment threads">
+            There may be a delay of up to 5 minutes before new comments appear in the system.
+          </Note>
+
+        Required scope | `comments:read`
+      source:
+        openapi: ../../../openapi/referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+        comment_thread_id:
+          type: string
+          docs: Unique identifier for a Comment Thread
+      display-name: Get Comment Thread
+      request:
+        name: CommentsGetCommentThreadRequest
+        query-parameters:
+          localeId:
+            type: optional<string>
+            docs: >-
+              Unique identifier for a specific locale. Applicable, when using
+              localization.
+          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)'
+          sortBy:
+            type: optional<CommentsGetCommentThreadRequestSortBy>
+            docs: >-
+              Sort results by the provided value. Only allowed when sortOrder is
+              provided.
+          sortOrder:
+            type: optional<CommentsGetCommentThreadRequestSortOrder>
+            docs: Sorts the results by asc or desc
+      response:
+        docs: Request was successful
+        type: root.CommentThread
+        status-code: 200
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+            comment_thread_id: 580e63e98c9a982ac9b8b741
+          query-parameters:
+            localeId: 65427cf400e02b306eaa04a0
+          response:
+            body:
+              id: 580e64008c9a982ac9b8b754
+              siteId: 580e64008c9a982ac9b8b754
+              pageId: 580e64008c9a982ac9b8b754
+              localeId: 580e64008c9a982ac9b8b754
+              itemId: 580e64008c9a982ac9b8b754
+              breakpoint: main
+              url: >-
+                https://webflow.com/design/site-slug-4ec832?workflow=comment&commentId=679d2ddb5196117ad04d1ff8&pageId=679826b3b20b045e176bc4bc
+              content: This is a comment reply
+              isResolved: true
+              author:
+                userId: userId
+                email: email
+                name: name
+              mentionedUsers:
+                - userId: 6287ec36a841b25637c663df
+                  email: arthur.dent@heartofgold.spaceship
+                  name: Arthur Dent
+              createdOn: '2023-03-17T18:47:35.560Z'
+              lastUpdated: '2023-03-17T18:47:35.560Z'
+    list-comment-replies:
+      path: /sites/{site_id}/comments/{comment_thread_id}/replies
+      method: GET
+      auth: true
+      docs: |
+        List all replies to a specific comment thread.
+
+        <Note title="Timing of comment threads">
+          There may be a delay of up to 5 minutes before new comments appear in the system.
+        </Note>
+
+        Required scope | `comments:read`
+      source:
+        openapi: ../../../openapi/referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+        comment_thread_id:
+          type: string
+          docs: Unique identifier for a Comment Thread
+      display-name: List Comment Replies
+      request:
+        name: CommentsListCommentRepliesRequest
+        query-parameters:
+          localeId:
+            type: optional<string>
+            docs: >-
+              Unique identifier for a specific locale. Applicable, when using
+              localization.
+          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)'
+          sortBy:
+            type: optional<CommentsListCommentRepliesRequestSortBy>
+            docs: >-
+              Sort results by the provided value. Only allowed when sortOrder is
+              provided.
+          sortOrder:
+            type: optional<CommentsListCommentRepliesRequestSortOrder>
+            docs: Sorts the results by asc or desc
+      response:
+        docs: Request was successful
+        type: root.CommentReplyList
+        status-code: 200
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+            comment_thread_id: 580e63e98c9a982ac9b8b741
+          query-parameters:
+            localeId: 65427cf400e02b306eaa04a0
+          response:
+            body:
+              comments:
+                - id: 679d2ddb5196117ad04d1ffa
+                  commentId: 679d2ddb5196117ad04d1ff8
+                  siteId: 679826b3b20b045e176bc4b5
+                  pageId: 679826b3b20b045e176bc4bc
+                  localeId: 67993753d910db250db64b3e
+                  breakpoint: main
+                  content: >-
+                    This comment mentions another user
+                    [[6287ec36a841b25637c663df]] 
+                  isResolved: false
+                  author:
+                    id: id
+                    email: email
+                    name: name
+                  mentionedUsers:
+                    - id: id
+                      email: arthur.dent@example.com
+                      name: Arthur Dent
+                  lastUpdated: '2025-01-31T20:08:59.759Z'
+                  createdOn: '2025-01-31T20:08:59.759Z'
+              pagination:
+                limit: 2
+                offset: 0
+                total: 1
+  source:
+    openapi: ../../../openapi/referenced-specs/v2.yml

package/.mock/definition/sites/robotsTxt.yml

@@ -8,9 +8,14 @@ service:
       path: /sites/{site_id}/robots_txt
       method: GET
       auth: true
-      docs: |
+      docs: >
         Retrieve the robots.txt configuration for various user agents.
 
+
+        <Warning title="Enterprise Only">This endpoint requires an Enterprise
+        workspace.</Warning>
+
+
         Required scope: `site_config:read`
       source:
         openapi: ../../../openapi/referenced-specs/v2.yml
@@ -46,9 +51,14 @@ service:
       path: /sites/{site_id}/robots_txt
       method: PUT
       auth: true
-      docs: |
+      docs: >
         Replace the `robots.txt` configuration for various user agents.
 
+
+        <Warning title="Enterprise Only">This endpoint requires an Enterprise
+        workspace.</Warning>
+
+
         Required scope | `site_config:write`
       source:
         openapi: ../../../openapi/referenced-specs/v2.yml
@@ -107,6 +117,10 @@ service:
         access unrestricted unless other directives apply.
 
 
+        <Warning title="Enterprise Only">This endpoint requires an Enterprise
+        workspace.</Warning>
+
+
         Required scope: `site_config:write`
       source:
         openapi: ../../../openapi/referenced-specs/v2.yml
@@ -152,9 +166,14 @@ service:
       path: /sites/{site_id}/robots_txt
       method: PATCH
       auth: true
-      docs: |
+      docs: >
         Update the `robots.txt` configuration for various user agents.
 
+
+        <Warning title="Enterprise Only">This endpoint requires an Enterprise
+        workspace.</Warning>
+
+
         Required scope | `site_config:write`
       source:
         openapi: ../../../openapi/referenced-specs/v2.yml

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

@@ -0,0 +1,114 @@
+types:
+  WellKnownFileContentType:
+    enum:
+      - value: application/json
+        name: ApplicationJson
+      - value: text/plain
+        name: TextPlain
+    docs: The content type of the file. Defaults to application/json
+    default: application/json
+    inline: true
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+imports:
+  root: ../__package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    put:
+      path: /sites/{site_id}/well_known
+      method: PUT
+      auth: true
+      docs: >
+        Upload a supported well-known file to a site.
+
+
+        The current restrictions on well-known files are as follows:
+          - Each file must be smaller than 100kb
+          - Less than 30 total files
+          - Have one of the following file extensions (or no extension): `.txt`, `.json`, `.noext` 
+          
+          <Note title=".noext">
+            `.noext` is a special file extension that removes other extensions. For example, `apple-app-site-association.noext.txt` will be uploaded as `apple-app-site-association`. Use this extension for tools that have trouble uploading extensionless files.
+          </Note>
+
+        <Warning title="Enterprise Only">This endpoint requires an Enterprise
+        workspace.</Warning>
+
+
+        Required scope: `site_config:write`
+      source:
+        openapi: ../../../openapi/referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+      display-name: Set a well-known file
+      request:
+        name: WellKnownFile
+        body:
+          properties:
+            fileName:
+              type: string
+              docs: The name of the file
+            fileData:
+              type: string
+              docs: The contents of the file
+            contentType:
+              type: optional<WellKnownFileContentType>
+              docs: The content type of the file. Defaults to application/json
+              default: application/json
+        content-type: application/json
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          request:
+            fileName: fileName
+            fileData: fileData
+    delete:
+      path: /sites/{site_id}/well_known
+      method: DELETE
+      auth: true
+      docs: >
+        Delete existing well-known files from a site.
+
+
+        <Warning title="Enterprise Only">This endpoint requires an Enterprise
+        workspace.</Warning>
+
+
+        Required scope: `site_config:write`
+      source:
+        openapi: ../../../openapi/referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+      display-name: Delete a well-known file
+      request:
+        name: WellKnownDeleteRequest
+        body:
+          properties:
+            fileNames:
+              type: optional<list<string>>
+              docs: A list of file names to delete
+        content-type: application/json
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          request: {}
+  source:
+    openapi: ../../../openapi/referenced-specs/v2.yml

package/.mock/definition/sites.yml

@@ -60,7 +60,7 @@ service:
               id: 670ecf86817e3cc7a510eb6a
               workspaceId: 625860a7a6c16d624927122f
               createdOn: '2024-10-15T20:24:38Z'
-              displayName: The Hitchiker‘s Guide
+              displayName: The Hitchiker's Guide
               shortName: hitchikers-guide
               lastUpdated: '2024-10-15T20:24:38Z'
               parentFolderId: 670ece123598db72d9648be1

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

@@ -0,0 +1,119 @@
+types:
+  AuditLogsGetWorkspaceAuditLogsRequestSortOrder:
+    enum:
+      - asc
+      - desc
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  AuditLogsGetWorkspaceAuditLogsRequestEventType:
+    enum:
+      - user_access
+      - custom_role
+      - workspace_membership
+      - site_membership
+      - workspace_invitation
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+imports:
+  root: ../__package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    get-workspace-audit_logs:
+      path: /workspaces/{workspace_id_or_slug}/audit_logs
+      method: GET
+      auth: true
+      docs: >
+        Get audit logs for a workspace.
+
+
+        <Warning title="Enterprise & workspace API token only">This endpoint
+        requires an Enterprise workspace and a workspace token with the
+        `workspace_activity:read` scope. Create a workspace token from your
+        workspace dashboard integrations page to use this endpoint.</Warning>
+
+
+        Required scope | `workspace_activity:read`
+      source:
+        openapi: ../../../openapi/referenced-specs/v2.yml
+      path-parameters:
+        workspace_id_or_slug:
+          type: string
+          docs: Unique identifier or slug for a Workspace
+      display-name: Get Workspace Audit Logs
+      request:
+        name: AuditLogsGetWorkspaceAuditLogsRequest
+        query-parameters:
+          limit:
+            type: optional<double>
+            docs: 'Maximum number of records to be returned (max limit: 100)'
+          offset:
+            type: optional<double>
+            docs: >-
+              Offset used for pagination if the results have more than limit
+              records
+          sortOrder:
+            type: optional<AuditLogsGetWorkspaceAuditLogsRequestSortOrder>
+            docs: Sorts the results by asc or desc
+          eventType:
+            type: optional<AuditLogsGetWorkspaceAuditLogsRequestEventType>
+            docs: The event type to filter by
+          from:
+            type: optional<datetime>
+            docs: The start date to filter by
+          to:
+            type: optional<datetime>
+            docs: The end date to filter by
+      response:
+        docs: A list of workspace audit logs
+        type: root.WorkspaceAuditLogResponse
+        status-code: 200
+      errors:
+        - root.UnauthorizedError
+        - root.ForbiddenError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            workspace_id_or_slug: hitchhikers-workspace
+          query-parameters:
+            from: '2024-04-22T16:00:31Z'
+            to: '2024-04-22T16:00:31Z'
+          response:
+            body:
+              items:
+                - eventSubType: login
+                  eventType: user_access
+                  timestamp: '2025-04-29T20:30:06Z'
+                  actor:
+                    id: 6661ccb359b561c69f29d554
+                    email: someone@email.com
+                  workspace:
+                    id: 6621ccb459b561c69f29d57c
+                    slug: hitchhikers-workspace
+                - eventSubType: user_added
+                  eventType: workspace_membership
+                  timestamp: '2025-04-30T20:30:06Z'
+                  actor:
+                    id: 60492e55bbddce079561cd7a
+                    email: someone@webflow.com
+                  workspace:
+                    id: 6621ccb459b561c69f29d57c
+                    slug: hitchhikers-workspace
+                - eventSubType: user_added
+                  eventType: site_membership
+                  timestamp: '2025-04-30T00:33:31Z'
+                  actor:
+                    id: 671fe00d185fc8c1ad409d37
+                    email: someone@webflow.com
+                  workspace:
+                    id: 6621ccb459b561c69f29d57c
+                    slug: hitchhikers-workspace
+              pagination:
+                limit: 10
+                offset: 0
+                total: 3
+  source:
+    openapi: ../../../openapi/referenced-specs/v2.yml

package/.mock/fern.config.json

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

package/Client.d.ts

@@ -18,9 +18,10 @@ import { Products } from "./api/resources/products/client/Client";
 import { Orders } from "./api/resources/orders/client/Client";
 import { Inventory } from "./api/resources/inventory/client/Client";
 import { Ecommerce } from "./api/resources/ecommerce/client/Client";
+import { Workspaces } from "./api/resources/workspaces/client/Client";
 export declare namespace WebflowClient {
     interface Options {
-        environment?: core.Supplier<environments.WebflowEnvironment | string>;
+        environment?: core.Supplier<environments.WebflowEnvironment | environments.WebflowEnvironmentUrls>;
         accessToken: core.Supplier<core.BearerToken>;
     }
     interface RequestOptions {
@@ -67,4 +68,6 @@ export declare class WebflowClient {
     get inventory(): Inventory;
     protected _ecommerce: Ecommerce | undefined;
     get ecommerce(): Ecommerce;
+    protected _workspaces: Workspaces | undefined;
+    get workspaces(): Workspaces;
 }

package/Client.js

@@ -19,6 +19,7 @@ const Client_12 = require("./api/resources/products/client/Client");
 const Client_13 = require("./api/resources/orders/client/Client");
 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) {
         this._options = _options;
@@ -83,5 +84,9 @@ class WebflowClient {
         var _a;
         return ((_a = this._ecommerce) !== null && _a !== void 0 ? _a : (this._ecommerce = new Client_15.Ecommerce(this._options)));
     }
+    get workspaces() {
+        var _a;
+        return ((_a = this._workspaces) !== null && _a !== void 0 ? _a : (this._workspaces = new Client_16.Workspaces(this._options)));
+    }
 }
 exports.WebflowClient = WebflowClient;

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

@@ -6,7 +6,7 @@ import * as core from "../../../../core";
 import * as Webflow from "../../../index";
 export declare namespace AccessGroups {
     interface Options {
-        environment?: core.Supplier<environments.WebflowEnvironment | string>;
+        environment?: core.Supplier<environments.WebflowEnvironment | environments.WebflowEnvironmentUrls>;
         accessToken: core.Supplier<core.BearerToken>;
     }
     interface RequestOptions {