webflow-api 3.0.1 → 3.1.1

package/.mock/definition/pages.yml

@@ -13,7 +13,7 @@ service:
 
         Required scope | `pages:read`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -38,6 +38,7 @@ service:
       response:
         docs: Request was successful
         type: root.PageList
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -56,8 +57,6 @@ service:
                   siteId: 6258612d1ee792848f805dcf
                   title: Guide to the Galaxy
                   slug: guide-to-the-galaxy
-                  parentId: 6419db964a9c435aa3af6251
-                  collectionId: 6390c49774a71f12831a08e3
                   createdOn: '2024-03-11T10:42:00Z'
                   lastUpdated: '2024-03-11T10:42:42Z'
                   archived: false
@@ -83,8 +82,6 @@ service:
                   siteId: 6258612d1ee792848f805dcf
                   title: Towel Day Celebrations
                   slug: towel-day
-                  parentId: 6419db964a9c435aa3af6251
-                  collectionId: 6390c49774a71f12831a08e3
                   createdOn: '2024-05-25T09:00:00Z'
                   lastUpdated: '2024-05-25T09:42:00Z'
                   archived: false
@@ -121,7 +118,7 @@ service:
 
         Required scope | `pages:read`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         page_id:
           type: string
@@ -138,6 +135,7 @@ service:
       response:
         docs: Request was successful
         type: root.Page
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -155,8 +153,6 @@ service:
               siteId: 6258612d1ee792848f805dcf
               title: Guide to the Galaxy
               slug: guide-to-the-galaxy
-              parentId: 6419db964a9c435aa3af6251
-              collectionId: 6390c49774a71f12831a08e3
               createdOn: '2024-03-11T10:42:00Z'
               lastUpdated: '2024-03-11T10:42:42Z'
               archived: false
@@ -185,9 +181,13 @@ service:
       docs: |
         Update Page-level metadata, including SEO and Open Graph fields.
 
+        <Note>
+          Note: When updating Page Metadata in secondary locales, you may only add `slug` to the request if your Site has the [Advanced or Enterprise Localization](https://webflow.com/localization) add-on.
+        </Note>
+
         Required scope | `pages:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         page_id:
           type: string
@@ -206,6 +206,7 @@ service:
       response:
         docs: Request was successful
         type: root.Page
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -248,8 +249,6 @@ service:
               siteId: 6258612d1ee792848f805dcf
               title: Guide to the Galaxy
               slug: guide-to-the-galaxy
-              parentId: 6419db964a9c435aa3af6251
-              collectionId: 6390c49774a71f12831a08e3
               createdOn: '2024-03-11T10:42:00Z'
               lastUpdated: '2024-03-11T10:42:42Z'
               archived: false
@@ -276,16 +275,25 @@ service:
       method: GET
       auth: true
       docs: >
-        Get static content from a static page.
+        Get content from a static page. This includes text nodes, image nodes,
+        and component instances with [property
+        overrides](https://help.webflow.com/hc/en-us/articles/33961219350547-Component-properties#how-to-modify-property-values-on-component-instances).
+
+
+        To retrieve the static content of a component instance, use the [Get
+        Component
+        Content](/data/reference/pages-and-components/components/get-content)
+        endpoint.
 
 
-        If you do not provide a Locale ID in your request, the response will
-        return any content that can be localized from the Primary locale.
+        <Note>If you do not include a `localeId` in your request, the response
+        will return any content that can be localized from the Primary
+        locale.</Note>
 
 
         Required scope | `pages:read`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         page_id:
           type: string
@@ -310,6 +318,7 @@ service:
       response:
         docs: Request was successful
         type: root.Dom
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -318,7 +327,8 @@ service:
         - root.TooManyRequestsError
         - root.InternalServerError
       examples:
-        - path-parameters:
+        - name: PageDOM
+          path-parameters:
             page_id: 63c720f9347c2139b248e552
           query-parameters:
             localeId: 65427cf400e02b306eaa04a0
@@ -326,69 +336,83 @@ service:
             body:
               pageId: 658205daa3e8206a523b5ad4
               nodes:
-                - id: a245c12d-995b-55ee-5ec7-aa36a6cad623
-                  type: text
-                  text:
-                    html: <h1>The Hitchhiker's Guide to the Galaxy</h1>
-                    text: The Hitchhiker's Guide to the Galaxy
+                - id: id
+                  text: {}
                   attributes:
                     key: value
-                - id: a245c12d-995b-55ee-5ec7-aa36a6cad627
                   type: text
-                  text:
-                    html: >-
-                      <div><h3>Don't Panic!</h3><p>Always know where your towel
-                      is.</p></div>
+                - id: id
+                  text: {}
                   attributes:
                     key: value
-                - id: a245c12d-995b-55ee-5ec7-aa36a6cad629
-                  type: image
-                  image:
-                    alt: Marvin, the Paranoid Android
-                    assetId: 659595234426a9fcbad57043
+                  type: text
+                - id: id
+                  image: {}
                   attributes:
                     key: value
+                  type: image
+                - id: id
+                  componentId: componentId
+                  propertyOverrides:
+                    - propertyId: 7dd14c08-2e96-8d3d-2b19-b5c03642a0f0
+                  type: component-instance
               pagination:
-                limit: 3
+                limit: 4
                 offset: 0
-                total: 3
+                total: 4
+              lastUpdated: '2016-10-24T19:42:38Z'
     update-static-content:
       path: /pages/{page_id}/dom
       method: POST
       auth: true
       docs: >
-        This endpoint allows for updating static content on a static page within
-        a secondary locale. It is designed specifically for localized pages and
-        can handle up to 1000 nodes per request.
+        This endpoint updates content on a static page in **secondary locales**.
+        It supports updating up to 1000 nodes in a single request.
+
+
+        Before making updates:
+
+        1. Use the [get page
+        content](/data/reference/pages-and-components/pages/get-content)
+        endpoint to identify available content nodes and their types
 
-        <blockquote class="callout callout_info"><p><strong>Note:</strong>This
-        endpoint is specifically for localized pages. Ensure that the locale
-        specified is a valid secondary locale for the site.</p></blockquote>
+        2. If the page has component instances, retrieve the component's
+        properties that you'll override using the [get component
+        properties](/data/reference/pages-and-components/components/get-properties)
+        endpoint
+
+
+        <Note>
+          This endpoint is specifically for localized pages. Ensure that the specified `localeId` is a valid **secondary locale** for the site otherwise the request will fail.
+        </Note>
 
 
         Required scope | `pages:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         page_id:
           type: string
           docs: Unique identifier for a Page
       display-name: Update Page Content
       request:
-        name: DomWrite
+        name: PageDomWrite
         query-parameters:
           localeId:
-            type: optional<string>
-            docs: >-
-              Unique identifier for a specific locale. Applicable, when using
-              localization.
+            type: string
+            docs: The locale identifier.
         body:
           properties:
-            nodes: list<DomWriteNodesItem>
+            nodes:
+              docs: >-
+                List of DOM Nodes with the new content that will be updated in
+                each node.
+              type: list<PageDomWriteNodesItem>
         content-type: application/json
       response:
         docs: Request was successful
         type: UpdateStaticContentResponse
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -400,39 +424,37 @@ service:
         - path-parameters:
             page_id: 63c720f9347c2139b248e552
           query-parameters:
-            localeId: 65427cf400e02b306eaa04a0
+            localeId: localeId
           request:
             nodes:
               - nodeId: a245c12d-995b-55ee-5ec7-aa36a6cad623
-                text: <h1>The Hitchhiker’s Guide to the Galaxy</h1>
+                text: <h1>The Hitchhiker's Guide to the Galaxy</h1>
               - nodeId: a245c12d-995b-55ee-5ec7-aa36a6cad627
                 text: >-
-                  <div><h3>Don’t Panic!</h3><p>Always know where your towel
+                  <div><h3>Don't Panic!</h3><p>Always know where your towel
                   is.</p></div>
               - nodeId: a245c12d-995b-55ee-5ec7-aa36a6cad629
-                text: >-
-                  <img alt="Marvin, the Paranoid Android"
-                  src="path/to/image/with/assetId/659595234426a9fcbad57043"/>
+                propertyOverrides:
+                  - propertyId: 7dd14c08-2e96-8d3d-2b19-b5c03642a0f0
+                    text: <div><h1>Time is an <em>illusion</em></h1></div>
+                  - propertyId: 7dd14c08-2e96-8d3d-2b19-b5c03642a0f1
+                    text: Life, the Universe and Everything
           response:
             body:
               errors:
                 - errors
   source:
-    openapi: ../../../referenced-specs/v2.yml
+    openapi: ../../../openapi/referenced-specs/v2.yml
   display-name: Pages
+docs: Pages are the pages in your Webflow site.
 types:
-  DomWriteNodesItem:
-    properties:
-      nodeId:
-        type: string
-        docs: Node UUID
-      text:
-        type: string
-        docs: >-
-          HTML content of the node, including the HTML tag. The HTML tags must
-          be the same as what's returned from the Get Content endpoint.
+  PageDomWriteNodesItem:
+    discriminated: false
+    union:
+      - root.TextNodeWrite
+      - root.ComponentInstanceNodePropertyOverridesWrite
     source:
-      openapi: ../../../referenced-specs/v2.yml
+      openapi: ../../../openapi/referenced-specs/v2.yml
     inline: true
   UpdateStaticContentResponse:
     properties:
@@ -440,4 +462,4 @@ types:
         docs: A list of error messages, if any.
         type: list<string>
     source:
-      openapi: ../../../referenced-specs/v2.yml
+      openapi: ../../../openapi/referenced-specs/v2.yml

package/.mock/definition/products.yml

@@ -21,7 +21,7 @@ service:
 
         Required scope | `ecommerce:read`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -41,6 +41,7 @@ service:
       response:
         docs: Request was successful
         type: root.ProductAndSkUsList
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -112,7 +113,7 @@ service:
           - A single `sku-property` would be `color`. Within the `color` property, list the various colors of T-shirts as an array of `enum` values: `royal-blue`, `crimson-red`, and `forrest-green`. 
           - Once, you've created a Product and its `sku-properties` with `enum` values, Webflow will create a **default SKU**, which will automatically be a combination of the first `sku-properties` you've created.
           - In our example, the default SKU will be a Royal Blue T-Shirt, because our first `enum` of our Color `sku-property` is Royal Blue. 
-          - After you've created your product, you can create additional SKUs using the [Create SKU endpoint.](/data/reference/ecommerce/products-sk-us/create-sku)
+          - After you've created your product, you can create additional SKUs using the [Create SKU endpoint.](/data/reference/ecommerce/products/create-sku)
 
         Upon creation, the default product type will be `Advanced`, which
         ensures all Product and SKU fields will be shown to users in the
@@ -121,7 +122,7 @@ service:
 
         Required scope | `ecommerce:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -138,6 +139,7 @@ service:
       response:
         docs: Request was successful
         type: root.ProductAndSkUs
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -202,7 +204,7 @@ service:
 
         Required scope | `ecommerce:read`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -214,6 +216,7 @@ service:
       response:
         docs: Request was successful
         type: root.ProductAndSkUs
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -283,7 +286,7 @@ service:
 
         Required scope | `ecommerce:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -303,6 +306,7 @@ service:
       response:
         docs: Request was successful
         type: root.Product
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -358,7 +362,7 @@ service:
 
         Required scope | `ecommerce:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -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
@@ -426,7 +433,7 @@ service:
 
         Required scope | `ecommerce:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -448,6 +455,7 @@ service:
       response:
         docs: Request was successful
         type: root.Sku
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -491,10 +499,11 @@ service:
                 track-inventory: true
                 quantity: 10
   source:
-    openapi: ../../../referenced-specs/v2.yml
+    openapi: ../../../openapi/referenced-specs/v2.yml
 types:
   ProductsCreateSkuResponse:
     properties:
+      required: optional<unknown>
       skus: optional<list<root.Sku>>
     source:
-      openapi: ../../../referenced-specs/v2.yml
+      openapi: ../../../openapi/referenced-specs/v2.yml

package/.mock/definition/scripts.yml

@@ -9,29 +9,18 @@ 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.
-
-        <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
@@ -40,6 +29,7 @@ service:
       response:
         docs: Request was successful
         type: root.RegisteredScriptList
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -56,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
@@ -64,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
@@ -81,30 +69,16 @@ 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.  
-
-        <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: |
+        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: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -140,6 +114,7 @@ service:
       response:
         docs: Request was successful
         type: root.CustomCodeHostedResponse
+        status-code: 201
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -170,28 +145,18 @@ 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.
 
 
-        <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:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -229,6 +194,7 @@ service:
       response:
         docs: Created
         type: root.CustomCodeInlineResponse
+        status-code: 201
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -249,9 +215,8 @@ 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
   source:
-    openapi: ../../../referenced-specs/v2.yml
+    openapi: ../../../openapi/referenced-specs/v2.yml

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

@@ -8,11 +8,17 @@ 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: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -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,13 +60,9 @@ service:
                     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
+    openapi: ../../../openapi/referenced-specs/v2.yml