webflow-api 3.1.0 → 3.1.2

package/.mock/definition/products.yml

@@ -41,6 +41,7 @@ service:
       response:
         docs: Request was successful
         type: root.ProductAndSkUsList
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -138,6 +139,7 @@ service:
       response:
         docs: Request was successful
         type: root.ProductAndSkUs
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -214,6 +216,7 @@ service:
       response:
         docs: Request was successful
         type: root.ProductAndSkUs
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -303,6 +306,7 @@ service:
       response:
         docs: Request was successful
         type: root.Product
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -379,6 +383,7 @@ service:
       response:
         docs: Request was successful
         type: ProductsCreateSkuResponse
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -396,6 +401,8 @@ service:
               - {}
           response:
             body:
+              required:
+                key: value
               skus:
                 - id: 580e63fc8c9a982ac9b8b745
                   cmsLocaleId: 653ad57de882f528b32e810e
@@ -448,6 +455,7 @@ service:
       response:
         docs: Request was successful
         type: root.Sku
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -495,6 +503,7 @@ service:
 types:
   ProductsCreateSkuResponse:
     properties:
+      required: optional<unknown>
       skus: optional<list<root.Sku>>
     source:
       openapi: ../../../openapi/referenced-specs/v2.yml

package/.mock/definition/scripts.yml

@@ -9,23 +9,13 @@ service:
       method: GET
       auth: true
       docs: >
-        List of scripts registered to a Site. 
+        Get a list of scripts that have been registered to a site. A site can
+        have a maximum of 800 registered scripts.
 
 
-        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.
-
-
-        <Note>Access to this endpoint requires a bearer token from a [Data
-        Client App](/data/docs/getting-started-data-clients).</Note>    
+        <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`
@@ -39,6 +29,7 @@ service:
       response:
         docs: Request was successful
         type: root.RegisteredScriptList
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -55,7 +46,6 @@ service:
                   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
@@ -63,7 +53,6 @@ service:
                   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
@@ -80,25 +69,12 @@ service:
       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.  
-
-
-        <Note>Access to this endpoint requires a bearer token from a [Data
-        Client App](/data/docs/getting-started-data-clients).</Note>    
+      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:
@@ -138,6 +114,7 @@ service:
       response:
         docs: Request was successful
         type: root.CustomCodeHostedResponse
+        status-code: 201
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -168,21 +145,13 @@ service:
       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. 
+        Register an inline script to a site. Inline scripts are limited to 2000
+        characters.
 
 
-        <Note>Access to this endpoint requires a bearer token from a [Data
-        Client App](/data/docs/getting-started-data-clients).</Note>    
+        <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`
@@ -225,6 +194,7 @@ service:
       response:
         docs: Created
         type: root.CustomCodeInlineResponse
+        status-code: 201
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -245,7 +215,6 @@ service:
               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

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

@@ -8,9 +8,15 @@ service:
       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`
+      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:
@@ -32,6 +38,7 @@ service:
       response:
         docs: A list of site activity logs
         type: root.SiteActivityLogResponse
+        status-code: 200
       errors:
         - root.ForbiddenError
         - root.NotFoundError
@@ -53,10 +60,6 @@ service:
                     displayName: John Doe
                   resourceId: 654c16c7b229e56bcf26870c
                   resourceName: foo-bar
-                  newValue: newValue
-                  previousValue: previousValue
-                  payload:
-                    key: value
               pagination:
                 limit: 25
                 offset: 0

package/.mock/definition/sites/plans.yml

@@ -8,9 +8,14 @@ service:
       path: /sites/{site_id}/plan
       method: GET
       auth: true
-      docs: |
+      docs: >
         Get site plan details for the specified Site.
 
+
+        <Warning title="Enterprise Only">This endpoint requires an Enterprise
+        workspace.</Warning>
+
+
         Required scope | `sites:read`
       source:
         openapi: ../../../openapi/referenced-specs/v2.yml
@@ -22,6 +27,7 @@ service:
       response:
         docs: Request was successful
         type: root.SitePlan
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError

package/.mock/definition/sites/redirects.yml

@@ -16,6 +16,9 @@ service:
         control how traffic is rerouted on your site.
 
 
+        <Warning title="Enterprise Only">This endpoint requires an Enterprise
+        workspace.</Warning>
+
 
         Required scope: `sites:read`
       source:
@@ -28,6 +31,7 @@ service:
       response:
         docs: Request was successful
         type: root.Redirects
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -64,6 +68,10 @@ service:
         restructuring URLs, or handling outdated links.
 
 
+        <Warning title="Enterprise Only">This endpoint requires an Enterprise
+        workspace.</Warning>
+
+
         Required scope: `sites:write`
       source:
         openapi: ../../../openapi/referenced-specs/v2.yml
@@ -78,6 +86,7 @@ service:
       response:
         docs: Request was successful
         type: root.Redirect
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -103,10 +112,16 @@ service:
       docs: >
         Remove a URL redirection rule from a site.
 
+
         This is useful for cleaning up outdated or unnecessary redirects,
         ensuring that your site's routing behavior remains efficient and
         up-to-date.
 
+
+        <Warning title="Enterprise Only">This endpoint requires an Enterprise
+        workspace.</Warning>
+
+
         Required scope: `sites:write`
       source:
         openapi: ../../../openapi/referenced-specs/v2.yml
@@ -121,6 +136,7 @@ service:
       response:
         docs: Request was successful
         type: root.Redirects
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -148,8 +164,14 @@ service:
       path: /sites/{site_id}/redirects/{redirect_id}
       method: PATCH
       auth: true
-      docs: |
+      docs: >
         Update a URL redirection rule from a site.
+
+
+        <Warning title="Enterprise Only">This endpoint requires an Enterprise
+        workspace.</Warning>
+
+
         Required scope: `sites:write`
       source:
         openapi: ../../../openapi/referenced-specs/v2.yml
@@ -167,6 +189,7 @@ service:
       response:
         docs: Request was successful
         type: root.Redirect
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError

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

@@ -0,0 +1,202 @@
+imports:
+  root: ../__package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    get:
+      path: /sites/{site_id}/robots_txt
+      method: GET
+      auth: true
+      docs: |
+        Retrieve the robots.txt configuration for various user agents.
+
+        Required scope: `site_config:read`
+      source:
+        openapi: ../../../openapi/referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+      display-name: Get robots.txt
+      response:
+        docs: Request was successful
+        type: root.Robots
+        status-code: 200
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          response:
+            body:
+              rules:
+                - userAgent: googlebot
+                  allows:
+                    - /public
+                  disallows:
+                    - /vogon-poetry
+                    - /total-perspective-vortex
+              sitemap: https://heartofgold.ship/sitemap.xml
+    put:
+      path: /sites/{site_id}/robots_txt
+      method: PUT
+      auth: true
+      docs: |
+        Replace the `robots.txt` configuration for various user agents.
+
+        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: Replace robots.txt
+      request:
+        body: root.Robots
+        content-type: application/json
+      response:
+        docs: Request was successful
+        type: root.Robots
+        status-code: 200
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          request:
+            rules:
+              - userAgent: googlebot
+                allows:
+                  - /public
+                disallows:
+                  - /vogon-poetry
+                  - /total-perspective-vortex
+            sitemap: https://heartofgold.ship/sitemap.xml
+          response:
+            body:
+              rules:
+                - userAgent: googlebot
+                  allows:
+                    - /public
+                  disallows:
+                    - /vogon-poetry
+                    - /total-perspective-vortex
+              sitemap: https://heartofgold.ship/sitemap.xml
+    delete:
+      path: /sites/{site_id}/robots_txt
+      method: DELETE
+      auth: true
+      docs: >
+        Remove specific rules for a user-agent in your `robots.txt` file. To
+        delete all rules for a user-agent, provide an empty rule set. This will
+        remove the user-agent's entry entirely, leaving it subject to your
+        site's default crawling behavior.
+
+
+        **Note:** Deleting a user-agent with no rules will make the user-agent's
+        access unrestricted unless other directives apply.
+
+
+        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 robots.txt
+      request:
+        body: root.Robots
+        content-type: application/json
+      response:
+        docs: Request was successful
+        type: root.Robots
+        status-code: 200
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          request:
+            rules:
+              - userAgent: '*'
+                allows:
+                  - /public
+                disallows:
+                  - /bubbles
+          response:
+            body:
+              rules:
+                - userAgent: googlebot
+                  allows:
+                    - /public
+                  disallows:
+                    - /vogon-poetry
+                    - /total-perspective-vortex
+              sitemap: https://heartofgold.ship/sitemap.xml
+    patch:
+      path: /sites/{site_id}/robots_txt
+      method: PATCH
+      auth: true
+      docs: |
+        Update the `robots.txt` configuration for various user agents.
+
+        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: Update robots.txt
+      request:
+        body: root.Robots
+        content-type: application/json
+      response:
+        docs: Request was successful
+        type: root.Robots
+        status-code: 200
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          request:
+            rules:
+              - userAgent: googlebot
+                allows:
+                  - /public
+                disallows:
+                  - /vogon-poetry
+                  - /total-perspective-vortex
+            sitemap: https://heartofgold.ship/sitemap.xml
+          response:
+            body:
+              rules:
+                - userAgent: googlebot
+                  allows:
+                    - /public
+                  disallows:
+                    - /vogon-poetry
+                    - /total-perspective-vortex
+              sitemap: https://heartofgold.ship/sitemap.xml
+  source:
+    openapi: ../../../openapi/referenced-specs/v2.yml

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

@@ -8,13 +8,12 @@ service:
       path: /sites/{site_id}/custom_code
       method: GET
       auth: true
-      docs: >
-        Get all registered scripts that have been applied to a specific Site. 
-
-
-        <Note>Access to this endpoint requires a bearer token from a [Data
-        Client App](/data/docs/getting-started-data-clients).</Note>    
+      docs: |
+        Get all scripts applied to a site by the App. 
 
+        <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:
@@ -27,6 +26,7 @@ service:
       response:
         docs: Request was successful
         type: root.ScriptApplyList
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -55,22 +55,12 @@ service:
       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. 
-
-
-        <Note>Access to this endpoint requires a bearer token from a [Data
-        Client App](/data/docs/getting-started-data-clients).</Note>    
+      docs: |
+        Apply registered scripts 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:
@@ -86,6 +76,7 @@ service:
       response:
         docs: Request was successful
         type: root.ScriptApplyList
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -125,11 +116,8 @@ service:
       method: DELETE
       auth: true
       docs: >
-        Delete the custom code block that an app created for a Site
-
-
-        <Note>Access to this endpoint requires a bearer token from a [Data
-        Client App](/data/docs/getting-started-data-clients).</Note>    
+        Remove scripts from a site applied by the App. This endpoint will not
+        remove scripts from the site's registered scripts.
 
 
         Required scope | `custom_code:write`
@@ -154,11 +142,15 @@ service:
       method: GET
       auth: true
       docs: >
-        Get all instances of Custom Code applied to a Site or Pages. 
+        Get a list of scripts that have been applied to a site and/or individual
+        pages. 
 
 
-        <Note>Access to this endpoint requires a bearer token from a [Data
-        Client App](/data/docs/getting-started-data-clients).</Note>    
+        <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`
@@ -183,6 +175,7 @@ service:
       response:
         docs: Request was successful
         type: root.ListCustomCodeBlocks
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -196,7 +189,6 @@ service:
             body:
               blocks:
                 - siteId: 6258612d1ee792848f805dcf
-                  pageId: pageId
                   type: site
                   scripts:
                     - id: chartjs