webflow-api 2.4.0 → 2.5.0

package/.mock/definition/scripts.yml

@@ -0,0 +1,257 @@
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    list:
+      path: /sites/{site_id}/registered_scripts
+      method: GET
+      auth: true
+      docs: >
+        List of scripts registered to a Site. 
+
+
+        In order to use the Custom Code APIs for Sites and Pages, Custom Code
+        Scripts must first be registered 
+
+        to a Site via the `registered_scripts` endpoints, and then applied to a
+        Site or Page using the appropriate
+
+        `custom_code` endpoints. 
+
+        Additionally, Scripts can be remotely hosted, or registered as inline
+        snippets.
+
+        <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 | `custom_code:read`
+      source:
+        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
+      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
+    register-hosted:
+      path: /sites/{site_id}/registered_scripts/hosted
+      method: POST
+      auth: true
+      docs: >
+        Add a script to a Site's Custom Code registry.
+
+
+        In order to use the Custom Code APIs for Sites and Pages, Custom Code
+        Scripts must first be registered 
+
+        to a Site via the `registered_scripts` endpoints, and then applied to a
+        Site or Page using the appropriate
+
+        `custom_code` endpoints. 
+
+        Additionally, Scripts can be remotely hosted, or registered as inline
+        snippets.  
+
+        <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 | `custom_code:write`
+      source:
+        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
+      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: true
+      docs: >
+        Add a script to a Site's Custom Code registry. Inline scripts can be
+        between 1 and 2000 characters.
+
+
+        In order to use the Custom Code APIs for Sites and Pages, Custom Code
+        Scripts must first be registered 
+
+        to a Site via the `registered_scripts` endpoints, and then applied to a
+        Site or Page using the appropriate
+
+        `custom_code` endpoints. 
+
+
+        <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 | `custom_code:write`
+      source:
+        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
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - 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: ../../../referenced-specs/v2.yml

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

@@ -0,0 +1,65 @@
+imports:
+  root: ../__package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    list:
+      path: /sites/{site_id}/activity_logs
+      method: GET
+      auth: true
+      docs: >-
+        Retrieve Activity Logs for a specific Site. Requires Site to be on an
+        Enterprise plan. </br></br>  Required scope | `site_activity:read`
+      source:
+        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
+      errors:
+        - root.ForbiddenError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          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: ../../../referenced-specs/v2.yml

package/.mock/definition/sites/scripts.yml

@@ -0,0 +1,228 @@
+imports:
+  root: ../__package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    get-custom-code:
+      path: /sites/{site_id}/custom_code
+      method: GET
+      auth: true
+      docs: >
+        Get all registered scripts that have been applied to a specific 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 | `custom_code:read`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+      display-name: Get Custom Code
+      response:
+        docs: Request was successful
+        type: root.ScriptApplyList
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          response:
+            body:
+              scripts:
+                - id: cms_slider
+                  location: header
+                  version: 1.0.0
+                  attributes:
+                    my-attribute: some-value
+                - id: alert
+                  location: header
+                  version: 0.0.1
+                  attributes:
+                    key: value
+              lastUpdated: '2022-10-26T00:28:54.191Z'
+              createdOn: '2022-10-26T00:28:54.191Z'
+    upsert-custom-code:
+      path: /sites/{site_id}/custom_code
+      method: PUT
+      auth: true
+      docs: >
+        Add a registered script to a Site. 
+
+
+        In order to use the Custom Code APIs for Sites and Pages, Custom Code
+        Scripts must first be registered 
+
+        to a Site via the `registered_scripts` endpoints, and then applied to a
+        Site or Page using the appropriate
+
+        `custom_code` endpoints. 
+
+        <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 | `custom_code:write`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+      display-name: Add/Update Custom Code
+      request:
+        body: root.ScriptApplyList
+        content-type: application/json
+      response:
+        docs: Request was successful
+        type: root.ScriptApplyList
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          request:
+            scripts:
+              - id: cms_slider
+                location: header
+                version: 1.0.0
+                attributes:
+                  my-attribute: some-value
+              - id: alert
+                location: header
+                version: 0.0.1
+          response:
+            body:
+              scripts:
+                - id: cms_slider
+                  location: header
+                  version: 1.0.0
+                  attributes:
+                    my-attribute: some-value
+                - id: alert
+                  location: header
+                  version: 0.0.1
+                  attributes:
+                    key: value
+              lastUpdated: lastUpdated
+              createdOn: createdOn
+    delete-custom-code:
+      path: /sites/{site_id}/custom_code
+      method: DELETE
+      auth: true
+      docs: >
+        Delete the custom code block that an app created for a 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 | `custom_code:write`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+      display-name: Delete Custom Code
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+    list-custom-code-blocks:
+      path: /sites/{site_id}/custom_code/blocks
+      method: GET
+      auth: true
+      docs: >
+        Get all instances of Custom Code applied to a Site or Pages. 
+
+        <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 | `custom_code:read`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+      display-name: List Custom Code Blocks
+      request:
+        name: ScriptsListCustomCodeBlocksRequest
+        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)'
+      response:
+        docs: Request was successful
+        type: root.ListCustomCodeBlocks
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          response:
+            body:
+              blocks:
+                - siteId: 6258612d1ee792848f805dcf
+                  pageId: pageId
+                  type: site
+                  scripts:
+                    - id: chartjs
+                      location: header
+                      version: 4.4.2
+                      attributes:
+                        key: value
+                  createdOn: '2024-04-03T16:49:15Z'
+                  lastUpdated: '2024-04-03T16:49:15Z'
+                - siteId: 6390c49674a71f84b51a08d8
+                  pageId: 6419db964a9c43f6a3af6348
+                  type: page
+                  scripts:
+                    - id: id
+                      location: header
+                      version: version
+                  createdOn: '2022-10-26T00:28:54Z'
+                  lastUpdated: '2022-10-26T00:28:54Z'
+              pagination:
+                limit: 10
+                offset: 0
+                total: 1
+  source:
+    openapi: ../../../referenced-specs/v2.yml