webflow-api 3.3.0-beta → 3.3.1

package/.mock/definition/scripts.yml

@@ -1,236 +0,0 @@
-imports:
-  root: __package__.yml
-service:
-  auth: false
-  base-path: ''
-  endpoints:
-    list:
-      path: /sites/{site_id}/registered_scripts
-      method: GET
-      auth:
-        - OAuth2:
-            - custom_code:read
-      docs: >
-        Get a list of scripts that have been registered to a site. A site can
-        have a maximum of 800 registered scripts.
-
-
-        <Note title="Script Registration">
-          To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information.
-        </Note>
-
-
-        Required scope | `custom_code:read`
-      source:
-        openapi: ../../../openapi/referenced-specs/v2.yml
-      path-parameters:
-        site_id:
-          type: string
-          docs: Unique identifier for a Site
-      display-name: Get Registered Scripts
-      response:
-        docs: Request was successful
-        type: root.RegisteredScriptList
-        status-code: 200
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.NotFoundError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            site_id: 580e63e98c9a982ac9b8b741
-          response:
-            body:
-              registeredScripts:
-                - id: alert
-                  canCopy: false
-                  displayName: Alert
-                  hostedLocation: https://cdn.webflow.io/.../alert-0.0.1.js
-                  integrityHash: integrityHash
-                  createdOn: '2022-10-26T00:28:54.191Z'
-                  lastUpdated: lastUpdated
-                  version: 0.0.1
-                - id: alert
-                  canCopy: false
-                  displayName: Alert
-                  hostedLocation: https://cdn.webflow.io/.../alert-0.0.2.js
-                  integrityHash: integrityHash
-                  createdOn: '2022-10-26T00:28:54.191Z'
-                  lastUpdated: lastUpdated
-                  version: 0.0.2
-                - id: cms_slider
-                  canCopy: true
-                  displayName: CMS Slider
-                  hostedLocation: https://cdn.jsdelivr.net/.../cms_slider.js
-                  integrityHash: >-
-                    sha384-J+YlJ8v0gpaRoKH7SbFbEmxOZlAxLiwNjfSsBhDooGa5roXlPPpXbEevck4J7YZ+
-                  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
-      auth:
-        - OAuth2:
-            - custom_code:write
-      docs: |
-        Register a hosted script to a site.
-
-        <Note title="Script Registration">
-          To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information.
-        </Note>
-
-        Required scope | `custom_code:write`
-      source:
-        openapi: ../../../openapi/referenced-specs/v2.yml
-      path-parameters:
-        site_id:
-          type: string
-          docs: Unique identifier for a Site
-      display-name: Register Script - Hosted
-      request:
-        name: CustomCodeHostedRequest
-        body:
-          properties:
-            hostedLocation:
-              type: string
-              docs: URI for an externally hosted script location
-            integrityHash:
-              type: string
-              docs: Sub-Resource Integrity Hash
-            canCopy:
-              type: optional<boolean>
-              docs: >-
-                Define whether the script can be copied on site duplication and
-                transfer
-              default: false
-            version:
-              type: string
-              docs: >-
-                A Semantic Version (SemVer) string, denoting the version of the
-                script
-            displayName:
-              type: string
-              docs: >-
-                User-facing name for the script. Must be between 1 and 50
-                alphanumeric characters
-        content-type: application/json
-      response:
-        docs: Request was successful
-        type: root.CustomCodeHostedResponse
-        status-code: 201
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.NotFoundError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            site_id: 580e63e98c9a982ac9b8b741
-          request:
-            hostedLocation: hostedLocation
-            integrityHash: integrityHash
-            version: version
-            displayName: displayName
-          response:
-            body:
-              id: cms_slider
-              canCopy: true
-              displayName: CMS Slider
-              hostedLocation: https://cdn.jsdelivr.net/.../cmsslider.js
-              integrityHash: >-
-                sha384-J+YlJ8v0gpaRoKH7SbFbEmxOZlAxLiwNjfSsBhDooGa5roXlPPpXbEevck4J7YZ+
-              createdOn: '2022-10-26T00:28:54.191Z'
-              lastUpdated: lastUpdated
-              version: 1.0.0
-    register-inline:
-      path: /sites/{site_id}/registered_scripts/inline
-      method: POST
-      auth:
-        - OAuth2:
-            - custom_code:write
-      docs: >
-        Register an inline script to a site. Inline scripts are limited to 2000
-        characters.
-
-
-        <Note title="Script Registration">
-          To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information.
-        </Note>
-
-
-        Required scope | `custom_code:write`
-      source:
-        openapi: ../../../openapi/referenced-specs/v2.yml
-      path-parameters:
-        site_id:
-          type: string
-          docs: Unique identifier for a Site
-      display-name: Register Script - Inline
-      request:
-        name: CustomCodeInlineRequest
-        body:
-          properties:
-            sourceCode:
-              type: string
-              docs: The code to be added to the site (to be hosted by Webflow).
-            integrityHash:
-              type: optional<string>
-              docs: >-
-                Sub-Resource Integrity Hash. Only required for externally hosted
-                scripts (passed via hostedLocation)
-            canCopy:
-              type: optional<boolean>
-              docs: >-
-                Define whether the script can be copied on site duplication and
-                transfer
-              default: false
-            version:
-              type: string
-              docs: >-
-                A Semantic Version (SemVer) string, denoting the version of the
-                script
-            displayName:
-              type: string
-              docs: >-
-                User-facing name for the script. Must be between 1 and 50
-                alphanumeric characters
-        content-type: application/json
-      response:
-        docs: Created
-        type: root.CustomCodeInlineResponse
-        status-code: 201
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.NotFoundError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - name: CustomCodeInlineResponse
-          path-parameters:
-            site_id: 580e63e98c9a982ac9b8b741
-          request:
-            sourceCode: alert('hello world');
-            version: 0.0.1
-            displayName: Alert
-          response:
-            body:
-              id: alert
-              canCopy: false
-              displayName: Alert
-              hostedLocation: >-
-                https://uploads-ssl.webflow.com/6258612d1ee792848f805dcf%2F64b6c769ff52ba6c3d904a91%2F660d6e15b3d1696f2d2b1447%2Falert-0.0.1.js
-              integrityHash: integrityHash
-              createdOn: '2022-10-26T00:28:54.191Z'
-              lastUpdated: lastUpdated
-              version: 0.0.1
-  source:
-    openapi: ../../../openapi/referenced-specs/v2.yml

package/.mock/definition/sites/activityLogs.yml

@@ -1,77 +0,0 @@
-imports:
-  root: ../__package__.yml
-service:
-  auth: false
-  base-path: ''
-  endpoints:
-    list:
-      path: /sites/{site_id}/activity_logs
-      method: GET
-      auth:
-        - OAuth2:
-            - site_activity:read
-      docs: >
-        Retrieve Activity Logs for a specific Site. 
-
-
-        <Warning title="Enterprise Only">This endpoint requires an Enterprise
-        workspace.</Warning>
-
-
-        Required scope: `site_activity:read`
-      source:
-        openapi: ../../../openapi/referenced-specs/v2.yml
-      path-parameters:
-        site_id:
-          type: string
-          docs: Unique identifier for a Site
-      display-name: Get Site Activity Logs
-      request:
-        name: ActivityLogsListRequest
-        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
-      response:
-        docs: A list of site activity logs
-        type: root.SiteActivityLogResponse
-        status-code: 200
-      errors:
-        - root.ForbiddenError
-        - root.NotFoundError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            site_id: 580e63e98c9a982ac9b8b741
-          query-parameters:
-            limit: 1.1
-            offset: 1.1
-          response:
-            body:
-              items:
-                - id: 654c16c7b229e56bcf26872d
-                  createdOn: '2023-11-08T23:16:23Z'
-                  lastUpdated: '2023-11-08T23:16:23Z'
-                  event: cms_collection
-                  resourceOperation: CREATED
-                  user:
-                    id: 6509cd56e90eec668b009712
-                    displayName: John Doe
-                  resourceId: 654c16c7b229e56bcf26870c
-                  resourceName: foo-bar
-                  newValue: newValue
-                  previousValue: previousValue
-                  payload:
-                    key: value
-              pagination:
-                limit: 25
-                offset: 0
-                total: 1
-  source:
-    openapi: ../../../openapi/referenced-specs/v2.yml

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

@@ -1,352 +0,0 @@
-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:
-        - OAuth2:
-            - comments:read
-      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.
-
-
-              [Lear more about
-              localization.](/data/v2.0.0/docs/working-with-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
-            offset: 1.1
-            limit: 1.1
-            sortBy: createdOn
-            sortOrder: asc
-          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:
-        - OAuth2:
-            - comments:read
-      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.
-
-
-              [Lear more about
-              localization.](/data/v2.0.0/docs/working-with-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
-            offset: 1.1
-            limit: 1.1
-            sortBy: createdOn
-            sortOrder: asc
-          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:
-        - OAuth2:
-            - comments:read
-      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.
-
-
-              [Lear more about
-              localization.](/data/v2.0.0/docs/working-with-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
-            offset: 1.1
-            limit: 1.1
-            sortBy: createdOn
-            sortOrder: asc
-          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