webflow-api 3.0.1 → 3.1.1

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

@@ -0,0 +1,46 @@
+imports:
+  root: ../__package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    get-site-plan:
+      path: /sites/{site_id}/plan
+      method: GET
+      auth: true
+      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
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+      display-name: Get Site Plan
+      response:
+        docs: Request was successful
+        type: root.SitePlan
+        status-code: 200
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          response:
+            body:
+              id: hosting-business-v4
+              name: Business Hosting
+              pricingInfo: https://webflow.com/pricing
+  source:
+    openapi: ../../../openapi/referenced-specs/v2.yml

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

@@ -0,0 +1,213 @@
+imports:
+  root: ../__package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    list:
+      path: /sites/{site_id}/redirects
+      method: GET
+      auth: true
+      docs: >
+        Fetch a list of all URL redirect rules configured for a specific site.
+
+
+        Use this endpoint to review, audit, or manage the redirection rules that
+        control how traffic is rerouted on your site.
+
+
+        <Warning title="Enterprise Only">This endpoint requires an Enterprise
+        workspace.</Warning>
+
+
+        Required scope: `sites:read`
+      source:
+        openapi: ../../../openapi/referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+      display-name: Get URL redirects
+      response:
+        docs: Request was successful
+        type: root.Redirects
+        status-code: 200
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          response:
+            body:
+              redirects:
+                - id: 42e1a2b7aa1a13f768a0042a
+                  fromUrl: /mostly-harmless
+                  toUrl: /earth
+                - id: 6x9e7f8d9a4b1c2d3e4f5678
+                  fromUrl: /babel-fish
+                  toUrl: /translate
+              pagination:
+                limit: 100
+                offset: 0
+                total: 2
+    create:
+      path: /sites/{site_id}/redirects
+      method: POST
+      auth: true
+      docs: >
+        Add a new URL redirection rule to a site.
+
+
+        This endpoint allows you to define a source path (`fromUrl`) and its
+        corresponding destination path (`toUrl`), which will dictate how traffic
+        is rerouted on your site. This is useful for managing site changes,
+        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
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+      display-name: Create a URL redirect
+      request:
+        body: root.Redirect
+        content-type: application/json
+      response:
+        docs: Request was successful
+        type: root.Redirect
+        status-code: 200
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          request:
+            id: 42e1a2b7aa1a13f768a0042a
+            fromUrl: /mostly-harmless
+            toUrl: /earth
+          response:
+            body:
+              id: 42e1a2b7aa1a13f768a0042a
+              fromUrl: /mostly-harmless
+              toUrl: /earth
+    delete:
+      path: /sites/{site_id}/redirects/{redirect_id}
+      method: DELETE
+      auth: true
+      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
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+        redirect_id:
+          type: string
+          docs: Unique identifier site rediect
+      display-name: Delete URL redirects
+      response:
+        docs: Request was successful
+        type: root.Redirects
+        status-code: 200
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+            redirect_id: 66c4cb9a20cac35ed19500e6
+          response:
+            body:
+              redirects:
+                - id: 42e1a2b7aa1a13f768a0042a
+                  fromUrl: /mostly-harmless
+                  toUrl: /earth
+                - id: 6x9e7f8d9a4b1c2d3e4f5678
+                  fromUrl: /babel-fish
+                  toUrl: /translate
+              pagination:
+                limit: 100
+                offset: 0
+                total: 2
+    update:
+      path: /sites/{site_id}/redirects/{redirect_id}
+      method: PATCH
+      auth: true
+      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
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+        redirect_id:
+          type: string
+          docs: Unique identifier site rediect
+      display-name: Update URL redirect
+      request:
+        body: root.Redirect
+        content-type: application/json
+      response:
+        docs: Request was successful
+        type: root.Redirect
+        status-code: 200
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+            redirect_id: 66c4cb9a20cac35ed19500e6
+          request:
+            id: 42e1a2b7aa1a13f768a0042a
+            fromUrl: /mostly-harmless
+            toUrl: /earth
+          response:
+            body:
+              id: 42e1a2b7aa1a13f768a0042a
+              fromUrl: /mostly-harmless
+              toUrl: /earth
+  source:
+    openapi: ../../../openapi/referenced-specs/v2.yml

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,18 +8,16 @@ service:
       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>    
+      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:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -28,6 +26,7 @@ service:
       response:
         docs: Request was successful
         type: root.ScriptApplyList
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -56,27 +55,16 @@ 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. 
-
-        <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>    
+      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:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -88,6 +76,7 @@ service:
       response:
         docs: Request was successful
         type: root.ScriptApplyList
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -127,18 +116,13 @@ service:
       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>    
+        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`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -158,17 +142,20 @@ 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. 
+
 
-        <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>    
+        <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: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -188,6 +175,7 @@ service:
       response:
         docs: Request was successful
         type: root.ListCustomCodeBlocks
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -201,7 +189,6 @@ service:
             body:
               blocks:
                 - siteId: 6258612d1ee792848f805dcf
-                  pageId: pageId
                   type: site
                   scripts:
                     - id: chartjs
@@ -225,4 +212,4 @@ service:
                 offset: 0
                 total: 1
   source:
-    openapi: ../../../referenced-specs/v2.yml
+    openapi: ../../../openapi/referenced-specs/v2.yml