webflow-api 3.2.0 → 3.3.0-beta

package/.mock/definition/pages/scripts.yml

@@ -7,7 +7,9 @@ service:
     get-custom-code:
       path: /pages/{page_id}/custom_code
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - custom_code:read
       docs: |
         Get all scripts applied to a page. 
 
@@ -45,14 +47,22 @@ service:
     upsert-custom-code:
       path: /pages/{page_id}/custom_code
       method: PUT
-      auth: true
-      docs: |
-        Apply scripts to a page.
+      auth:
+        - OAuth2:
+            - custom_code:write
+      docs: >
+        Apply registered scripts to a page. If you have multiple scripts your
+        App needs to apply or maintain on a page, ensure they are always
+        included in the request body for this endpoint. To remove individual
+        scripts, simply call this endpoint without the script in the request
+        body.
+
 
         <Note title="Script Registration">
           To apply a script to a 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
@@ -106,13 +116,22 @@ service:
     delete-custom-code:
       path: /pages/{page_id}/custom_code
       method: DELETE
-      auth: true
+      auth:
+        - OAuth2:
+            - custom_code:write
       docs: >
-        Delete a custom code block that the App created on a page.
+        Remove all scripts from a page applied by the App. This endpoint will
+        not remove scripts from the site's registered scripts.
+
+
+        To remove individual scripts applied by the App, use the [Add/Update
+        Custom
+        Code](/data/reference/custom-code/custom-code-pages/upsert-custom-code)
+        endpoint.
 
 
-        <Note>Access to this endpoint requires a bearer token from a [Data
-        Client App](/data/docs/getting-started-data-clients).</Note>
+        <Note>Access to this endpoint requires a bearer token obtained from an
+        [OAuth Code Grant Flow](/data/reference/oauth-app).</Note>
 
 
         Required scope | `custom_code:write`

package/.mock/definition/pages.yml

@@ -7,7 +7,9 @@ service:
     list:
       path: /sites/{site_id}/pages
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - page:read
       docs: |
         List of all pages for a site.
 
@@ -24,9 +26,12 @@ service:
         query-parameters:
           localeId:
             type: optional<string>
-            docs: >-
-              Unique identifier for a specific locale. Applicable, when using
-              localization.
+            docs: >
+              Unique identifier for a specific Locale.
+
+
+              [Lear more about
+              localization.](/data/v2.0.0/docs/working-with-localization)
           limit:
             type: optional<double>
             docs: 'Maximum number of records to be returned (max limit: 100)'
@@ -50,6 +55,8 @@ service:
             site_id: 580e63e98c9a982ac9b8b741
           query-parameters:
             localeId: 65427cf400e02b306eaa04a0
+            limit: 1.1
+            offset: 1.1
           response:
             body:
               pages:
@@ -57,6 +64,8 @@ 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
@@ -82,12 +91,15 @@ 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
                   draft: false
                   canBranch: true
                   isBranch: false
+                  branchId: 68026fa68ef6dc744c75b833
                   seo:
                     title: Celebrate Towel Day - The Hitchhiker's Guide to the Galaxy
                     description: >-
@@ -111,7 +123,9 @@ service:
     get-metadata:
       path: /pages/{page_id}
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - page:read
       docs: |
         Get metadata information for a single page.
 
@@ -128,9 +142,12 @@ service:
         query-parameters:
           localeId:
             type: optional<string>
-            docs: >-
-              Unique identifier for a specific locale. Applicable, when using
-              localization.
+            docs: >
+              Unique identifier for a specific Locale.
+
+
+              [Lear more about
+              localization.](/data/v2.0.0/docs/working-with-localization)
       response:
         docs: Request was successful
         type: root.Page
@@ -152,6 +169,8 @@ 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
@@ -176,14 +195,12 @@ service:
     update-page-settings:
       path: /pages/{page_id}
       method: PUT
-      auth: true
+      auth:
+        - OAuth2:
+            - page:write
       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: ../../../openapi/referenced-specs/v2.yml
@@ -197,9 +214,12 @@ service:
         query-parameters:
           localeId:
             type: optional<string>
-            docs: >-
-              Unique identifier for a specific locale. Applicable, when using
-              localization.
+            docs: >
+              Unique identifier for a specific Locale.
+
+
+              [Lear more about
+              localization.](/data/v2.0.0/docs/working-with-localization)
         body:
           properties:
             title:
@@ -207,7 +227,14 @@ service:
               docs: Title for the page
             slug:
               type: optional<string>
-              docs: Slug for the page
+              docs: >
+                Slug for the page. 
+
+
+
+                **Note:** Updating slugs in secondary locales is only supported
+                in <a href="https://webflow.com/localization">Advanced and
+                Enterprise localization add-on plans.</a>
             seo:
               type: optional<PageMetadataWriteSeo>
               docs: SEO-related fields for the Page
@@ -251,6 +278,8 @@ 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
@@ -275,24 +304,13 @@ service:
     get-content:
       path: /pages/{page_id}/dom
       method: GET
-      auth: true
-      docs: >
-        Get content from a static page. This includes text nodes, image nodes,
-        select nodes, text input nodes, submit button 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.
-
-
-        <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>
+      auth:
+        - OAuth2:
+            - page:read
+      docs: |
+        Get text and component instance content from a static page.
 
+        <Badge intent="info">Localization</Badge> 
 
         Required scope | `pages:read`
       source:
@@ -307,9 +325,12 @@ service:
         query-parameters:
           localeId:
             type: optional<string>
-            docs: >-
-              Unique identifier for a specific locale. Applicable, when using
-              localization.
+            docs: >
+              Unique identifier for a specific Locale.
+
+
+              [Lear more about
+              localization.](/data/v2.0.0/docs/working-with-localization)
           limit:
             type: optional<double>
             docs: 'Maximum number of records to be returned (max limit: 100)'
@@ -334,6 +355,8 @@ service:
             page_id: 63c720f9347c2139b248e552
           query-parameters:
             localeId: 65427cf400e02b306eaa04a0
+            limit: 1.1
+            offset: 1.1
           response:
             body:
               pageId: 658205daa3e8206a523b5ad4
@@ -384,7 +407,9 @@ service:
     update-static-content:
       path: /pages/{page_id}/dom
       method: POST
-      auth: true
+      auth:
+        - OAuth2:
+            - page:write
       docs: >
         This endpoint updates content on a static page in **secondary locales**.
         It supports updating up to 1000 nodes in a single request.
@@ -394,12 +419,17 @@ service:
 
         1. Use the [get page
         content](/data/reference/pages-and-components/pages/get-content)
-        endpoint to identify available content nodes and their types
+        endpoint to identify available content nodes and their types.
 
         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
+        endpoint.
+
+        3. DOM elements may include a `data-w-id` attribute. This attribute is
+        used by Webflow to maintain custom attributes and links across locales.
+        Always include the original `data-w-id` value in your update requests to
+        ensure consistent behavior across all locales.
 
 
         <Note>
@@ -514,12 +544,12 @@ types:
   PageDomWriteNodesItem:
     discriminated: false
     union:
-      - type: root.Text Node
-      - type: root.Component Instance
+      - type: root.TextNodeWrite
+      - type: root.ComponentInstanceNodePropertyOverridesWrite
       - type: root.Select
-      - type: root.Text Input
-      - type: root.Submit Button
-      - type: root.Search Button
+      - type: root.TextInputNodeWrite
+      - type: root.SubmitButtonNodeWrite
+      - type: root.SearchButtonNodeWrite
     source:
       openapi: ../../../openapi/referenced-specs/v2.yml
     inline: true

package/.mock/definition/products.yml

@@ -7,7 +7,9 @@ service:
     list:
       path: /sites/{site_id}/products
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - ecommerce:read
       docs: >
         Retrieve all products for a site. 
 
@@ -53,6 +55,9 @@ service:
       examples:
         - path-parameters:
             site_id: 580e63e98c9a982ac9b8b741
+          query-parameters:
+            offset: 1.1
+            limit: 1.1
           response:
             body:
               items:
@@ -92,7 +97,6 @@ service:
                           value: 2499
                           unit: USD
                           currency: USD
-                        quantity: 10
                         main-image: https://www.example.com/image.jpg
                         sku: '1234567890'
                         sku-properties:
@@ -109,7 +113,9 @@ service:
     create:
       path: /sites/{site_id}/products
       method: POST
-      auth: true
+      auth:
+        - OAuth2:
+            - ecommerce:write
       docs: >
         Create a new ecommerce product and defaultSKU. A product, at minimum,
         must have a single SKU.
@@ -243,7 +249,6 @@ service:
                       value: 2499
                       unit: USD
                       currency: USD
-                    quantity: 10
                     main-image: https://www.example.com/image.jpg
                     sku: '1234567890'
                     sku-properties:
@@ -256,7 +261,9 @@ service:
     get:
       path: /sites/{site_id}/products/{product_id}
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - ecommerce:read
       docs: |
         Retrieve a single product by its ID. All of its SKUs will also be
         retrieved.
@@ -331,7 +338,6 @@ service:
                       value: 2499
                       unit: USD
                       currency: USD
-                    quantity: 10
                     main-image: https://www.example.com/image.jpg
                     sku: '1234567890'
                     sku-properties:
@@ -344,7 +350,9 @@ service:
     update:
       path: /sites/{site_id}/products/{product_id}
       method: PATCH
-      auth: true
+      auth:
+        - OAuth2:
+            - ecommerce:write
       docs: >
         Update an existing Product.
 
@@ -419,7 +427,9 @@ service:
     create-sku:
       path: /sites/{site_id}/products/{product_id}/skus
       method: POST
-      auth: true
+      auth:
+        - OAuth2:
+            - ecommerce:write
       docs: >
         Create additional SKUs to manage every [option and variant of your
         Product.](https://help.webflow.com/hc/en-us/articles/33961334531347-Create-product-options-and-variants)
@@ -498,7 +508,6 @@ service:
                       value: 2499
                       unit: USD
                       currency: USD
-                    quantity: 10
                     main-image: https://www.example.com/image.jpg
                     sku: '1234567890'
                     sku-properties:
@@ -511,7 +520,9 @@ service:
     update-sku:
       path: /sites/{site_id}/products/{product_id}/skus/{sku_id}
       method: PATCH
-      auth: true
+      auth:
+        - OAuth2:
+            - ecommerce:write
       docs: >
         Update a specified SKU.
 
@@ -600,8 +611,6 @@ service:
                   trial: 7
                   plans:
                     - {}
-                track-inventory: true
-                quantity: 10
                 main-image: https://www.example.com/image.jpg
                 sku: '1234567890'
                 sku-properties:

package/.mock/definition/scripts.yml

@@ -7,7 +7,9 @@ service:
     list:
       path: /sites/{site_id}/registered_scripts
       method: GET
-      auth: true
+      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.
@@ -46,6 +48,7 @@ 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
@@ -53,6 +56,7 @@ 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
@@ -72,7 +76,9 @@ service:
     register-hosted:
       path: /sites/{site_id}/registered_scripts/hosted
       method: POST
-      auth: true
+      auth:
+        - OAuth2:
+            - custom_code:write
       docs: |
         Register a hosted script to a site.
 
@@ -147,7 +153,9 @@ service:
     register-inline:
       path: /sites/{site_id}/registered_scripts/inline
       method: POST
-      auth: true
+      auth:
+        - OAuth2:
+            - custom_code:write
       docs: >
         Register an inline script to a site. Inline scripts are limited to 2000
         characters.
@@ -206,7 +214,8 @@ service:
         - root.TooManyRequestsError
         - root.InternalServerError
       examples:
-        - path-parameters:
+        - name: CustomCodeInlineResponse
+          path-parameters:
             site_id: 580e63e98c9a982ac9b8b741
           request:
             sourceCode: alert('hello world');
@@ -219,6 +228,7 @@ 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

@@ -7,7 +7,9 @@ service:
     list:
       path: /sites/{site_id}/activity_logs
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - site_activity:read
       docs: >
         Retrieve Activity Logs for a specific Site. 
 
@@ -47,6 +49,9 @@ service:
       examples:
         - path-parameters:
             site_id: 580e63e98c9a982ac9b8b741
+          query-parameters:
+            limit: 1.1
+            offset: 1.1
           response:
             body:
               items:
@@ -60,6 +65,10 @@ 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/comments.yml

@@ -44,7 +44,9 @@ service:
     list-comment-threads:
       path: /sites/{site_id}/comments
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - comments:read
       docs: |
         List all comment threads for a site.
 
@@ -65,9 +67,12 @@ service:
         query-parameters:
           localeId:
             type: optional<string>
-            docs: >-
-              Unique identifier for a specific locale. Applicable, when using
-              localization.
+            docs: >
+              Unique identifier for a specific Locale.
+
+
+              [Lear more about
+              localization.](/data/v2.0.0/docs/working-with-localization)
           offset:
             type: optional<double>
             docs: >-
@@ -99,6 +104,10 @@ service:
             site_id: 580e63e98c9a982ac9b8b741
           query-parameters:
             localeId: 65427cf400e02b306eaa04a0
+            offset: 1.1
+            limit: 1.1
+            sortBy: createdOn
+            sortOrder: asc
           response:
             body:
               comments:
@@ -106,6 +115,7 @@ service:
                   siteId: 679826b3b20b045e176bc4b5
                   pageId: 679826b3b20b045e176bc4bc
                   localeId: 67993753d910db250db64b3e
+                  itemId: 580e64008c9a982ac9b8b754
                   breakpoint: main
                   url: >-
                     https://webflow.com/design/site-slug-4ec832?workflow=comment&commentId=679d2ddb5196117ad04d1ff8&pageId=679826b3b20b045e176bc4bc
@@ -125,6 +135,7 @@ service:
                   siteId: 679826b3b20b045e176bc4b5
                   pageId: 679826b3b20b045e176bc4bc
                   localeId: 67993753d910db250db64b3e
+                  itemId: 580e64008c9a982ac9b8b754
                   breakpoint: main
                   url: >-
                     https://webflow.com/design/site-slug-4ec832?workflow=comment&commentId=679d2ddb5196117ad04d1ff8&pageId=679826b3b20b045e176bc4bc
@@ -149,7 +160,9 @@ service:
     get-comment-thread:
       path: /sites/{site_id}/comments/{comment_thread_id}
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - comments:read
       docs: |
         Get details of a specific comment thread.
 
@@ -173,9 +186,12 @@ service:
         query-parameters:
           localeId:
             type: optional<string>
-            docs: >-
-              Unique identifier for a specific locale. Applicable, when using
-              localization.
+            docs: >
+              Unique identifier for a specific Locale.
+
+
+              [Lear more about
+              localization.](/data/v2.0.0/docs/working-with-localization)
           offset:
             type: optional<double>
             docs: >-
@@ -208,6 +224,10 @@ service:
             comment_thread_id: 580e63e98c9a982ac9b8b741
           query-parameters:
             localeId: 65427cf400e02b306eaa04a0
+            offset: 1.1
+            limit: 1.1
+            sortBy: createdOn
+            sortOrder: asc
           response:
             body:
               id: 580e64008c9a982ac9b8b754
@@ -233,7 +253,9 @@ service:
     list-comment-replies:
       path: /sites/{site_id}/comments/{comment_thread_id}/replies
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - comments:read
       docs: |
         List all replies to a specific comment thread.
 
@@ -257,9 +279,12 @@ service:
         query-parameters:
           localeId:
             type: optional<string>
-            docs: >-
-              Unique identifier for a specific locale. Applicable, when using
-              localization.
+            docs: >
+              Unique identifier for a specific Locale.
+
+
+              [Lear more about
+              localization.](/data/v2.0.0/docs/working-with-localization)
           offset:
             type: optional<double>
             docs: >-
@@ -292,6 +317,10 @@ service:
             comment_thread_id: 580e63e98c9a982ac9b8b741
           query-parameters:
             localeId: 65427cf400e02b306eaa04a0
+            offset: 1.1
+            limit: 1.1
+            sortBy: createdOn
+            sortOrder: asc
           response:
             body:
               comments: