webflow-api 3.1.4 → 3.2.1

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:
@@ -73,11 +78,11 @@ service:
                         - id: Color
                           name: Color
                           enum:
-                            - id: id
+                            - id: royal-blue
                               name: Royal Blue
                               slug: royal-blue
                   skus:
-                    - id: 580e63fc8c9a982ac9b8b745
+                    - id: 66072fb71b89448912e2681c
                       cmsLocaleId: 653ad57de882f528b32e810e
                       lastPublished: '2023-03-17T18:47:35Z'
                       lastUpdated: '2023-03-17T18:47:35Z'
@@ -92,14 +97,13 @@ service:
                           value: 2499
                           unit: USD
                           currency: USD
-                        quantity: 10
                         main-image: https://www.example.com/image.jpg
                         sku: '1234567890'
                         sku-properties:
                           - id: Color
                             name: Color
                             enum:
-                              - id: id
+                              - id: royal-blue
                                 name: Royal Blue
                                 slug: royal-blue
               pagination:
@@ -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.
@@ -219,16 +225,16 @@ service:
                     - id: Color
                       name: Color
                       enum:
-                        - id: id
+                        - id: royal-blue
                           name: Royal Blue
                           slug: royal-blue
-                  categories:
-                    - categories
+                  category:
+                    - category
                   tax-category: standard-taxable
                   default-sku: default-sku
                   ec-product-type: ff42fee0113744f693a764e3431a9cc2
               skus:
-                - id: 580e63fc8c9a982ac9b8b745
+                - id: 66072fb71b89448912e2681c
                   cmsLocaleId: 653ad57de882f528b32e810e
                   lastPublished: '2023-03-17T18:47:35Z'
                   lastUpdated: '2023-03-17T18:47:35Z'
@@ -243,20 +249,21 @@ service:
                       value: 2499
                       unit: USD
                       currency: USD
-                    quantity: 10
                     main-image: https://www.example.com/image.jpg
                     sku: '1234567890'
                     sku-properties:
                       - id: Color
                         name: Color
                         enum:
-                          - id: id
+                          - id: royal-blue
                             name: Royal Blue
                             slug: royal-blue
     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.
@@ -307,16 +314,16 @@ service:
                     - id: Color
                       name: Color
                       enum:
-                        - id: id
+                        - id: royal-blue
                           name: Royal Blue
                           slug: royal-blue
-                  categories:
-                    - categories
+                  category:
+                    - category
                   tax-category: standard-taxable
                   default-sku: default-sku
                   ec-product-type: ff42fee0113744f693a764e3431a9cc2
               skus:
-                - id: 580e63fc8c9a982ac9b8b745
+                - id: 66072fb71b89448912e2681c
                   cmsLocaleId: 653ad57de882f528b32e810e
                   lastPublished: '2023-03-17T18:47:35Z'
                   lastUpdated: '2023-03-17T18:47:35Z'
@@ -331,20 +338,21 @@ service:
                       value: 2499
                       unit: USD
                       currency: USD
-                    quantity: 10
                     main-image: https://www.example.com/image.jpg
                     sku: '1234567890'
                     sku-properties:
                       - id: Color
                         name: Color
                         enum:
-                          - id: id
+                          - id: royal-blue
                             name: Royal Blue
                             slug: royal-blue
     update:
       path: /sites/{site_id}/products/{product_id}
       method: PATCH
-      auth: true
+      auth:
+        - OAuth2:
+            - ecommerce:write
       docs: >
         Update an existing Product.
 
@@ -408,18 +416,20 @@ service:
                   - id: Color
                     name: Color
                     enum:
-                      - id: id
+                      - id: royal-blue
                         name: Royal Blue
                         slug: royal-blue
-                categories:
-                  - categories
+                category:
+                  - category
                 tax-category: standard-taxable
                 default-sku: default-sku
                 ec-product-type: ff42fee0113744f693a764e3431a9cc2
     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)
@@ -468,7 +478,12 @@ service:
             product_id: 580e63fc8c9a982ac9b8b745
           request:
             skus:
-              - fieldData:
+              - id: 66072fb71b89448912e2681c
+                cmsLocaleId: 653ad57de882f528b32e810e
+                lastPublished: '2023-03-17T18:47:35Z'
+                lastUpdated: '2023-03-17T18:47:35Z'
+                createdOn: '2023-03-17T18:47:35Z'
+                fieldData:
                   name: Colorful T-shirt - Default
                   slug: colorful-t-shirt-default
                   price:
@@ -478,7 +493,7 @@ service:
           response:
             body:
               skus:
-                - id: 580e63fc8c9a982ac9b8b745
+                - id: 66072fb71b89448912e2681c
                   cmsLocaleId: 653ad57de882f528b32e810e
                   lastPublished: '2023-03-17T18:47:35Z'
                   lastUpdated: '2023-03-17T18:47:35Z'
@@ -493,20 +508,21 @@ service:
                       value: 2499
                       unit: USD
                       currency: USD
-                    quantity: 10
                     main-image: https://www.example.com/image.jpg
                     sku: '1234567890'
                     sku-properties:
                       - id: Color
                         name: Color
                         enum:
-                          - id: id
+                          - id: royal-blue
                             name: Royal Blue
                             slug: royal-blue
     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.
 
@@ -556,6 +572,11 @@ service:
             sku_id: 5e8518516e147040726cc415
           request:
             sku:
+              id: 66072fb71b89448912e2681c
+              cmsLocaleId: 653ad57de882f528b32e810e
+              lastPublished: '2023-03-17T18:47:35Z'
+              lastUpdated: '2023-03-17T18:47:35Z'
+              createdOn: '2023-03-17T18:47:35Z'
               fieldData:
                 name: Colorful T-shirt - Default
                 slug: colorful-t-shirt-default
@@ -565,7 +586,7 @@ service:
                   currency: USD
           response:
             body:
-              id: 580e63fc8c9a982ac9b8b745
+              id: 66072fb71b89448912e2681c
               cmsLocaleId: 653ad57de882f528b32e810e
               lastPublished: '2023-03-17T18:47:35Z'
               lastUpdated: '2023-03-17T18:47:35Z'
@@ -590,15 +611,13 @@ service:
                   trial: 7
                   plans:
                     - {}
-                track-inventory: true
-                quantity: 10
                 main-image: https://www.example.com/image.jpg
                 sku: '1234567890'
                 sku-properties:
                   - id: Color
                     name: Color
                     enum:
-                      - id: id
+                      - id: royal-blue
                         name: Royal Blue
                         slug: royal-blue
   source:

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.
@@ -65,10 +67,16 @@ service:
                   createdOn: '2022-10-26T00:28:54.191Z'
                   lastUpdated: lastUpdated
                   version: 1.0.0
+              pagination:
+                limit: 100
+                offset: 0
+                total: 3
     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.
 
@@ -143,7 +151,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.

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:

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,7 +115,6 @@ 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
@@ -126,7 +134,6 @@ 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
@@ -151,7 +158,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.
 
@@ -175,9 +184,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: >-
@@ -210,6 +222,10 @@ service:
             comment_thread_id: 580e63e98c9a982ac9b8b741
           query-parameters:
             localeId: 65427cf400e02b306eaa04a0
+            offset: 1.1
+            limit: 1.1
+            sortBy: createdOn
+            sortOrder: asc
           response:
             body:
               id: 580e64008c9a982ac9b8b754
@@ -235,7 +251,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.
 
@@ -259,9 +277,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: >-
@@ -294,6 +315,10 @@ service:
             comment_thread_id: 580e63e98c9a982ac9b8b741
           query-parameters:
             localeId: 65427cf400e02b306eaa04a0
+            offset: 1.1
+            limit: 1.1
+            sortBy: createdOn
+            sortOrder: asc
           response:
             body:
               comments:

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

@@ -7,7 +7,9 @@ service:
     get-site-plan:
       path: /sites/{site_id}/plan
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - sites:read
       docs: >
         Get site plan details for the specified Site.
 

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

@@ -7,7 +7,9 @@ service:
     list:
       path: /sites/{site_id}/redirects
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - sites:read
       docs: >
         Fetch a list of all 301 redirect rules configured for a specific site.
 
@@ -57,7 +59,9 @@ service:
     create:
       path: /sites/{site_id}/redirects
       method: POST
-      auth: true
+      auth:
+        - OAuth2:
+            - sites:write
       docs: >
         Add a new 301 redirection rule to a site.
 
@@ -108,7 +112,9 @@ service:
     delete:
       path: /sites/{site_id}/redirects/{redirect_id}
       method: DELETE
-      auth: true
+      auth:
+        - OAuth2:
+            - sites:write
       docs: >
         Remove a 301 redirection rule from a site.
 
@@ -163,7 +169,9 @@ service:
     update:
       path: /sites/{site_id}/redirects/{redirect_id}
       method: PATCH
-      auth: true
+      auth:
+        - OAuth2:
+            - sites:write
       docs: >
         Update a 301 redirection rule from a site.
 

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

@@ -7,7 +7,9 @@ service:
     get:
       path: /sites/{site_id}/robots_txt
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - site_config:read
       docs: >
         Retrieve the robots.txt configuration for various user agents.
 
@@ -50,7 +52,9 @@ service:
     put:
       path: /sites/{site_id}/robots_txt
       method: PUT
-      auth: true
+      auth:
+        - OAuth2:
+            - site_config:write
       docs: >
         Replace the `robots.txt` configuration for various user agents.
 
@@ -105,7 +109,9 @@ service:
     delete:
       path: /sites/{site_id}/robots_txt
       method: DELETE
-      auth: true
+      auth:
+        - OAuth2:
+            - site_config:write
       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
@@ -165,7 +171,9 @@ service:
     patch:
       path: /sites/{site_id}/robots_txt
       method: PATCH
-      auth: true
+      auth:
+        - OAuth2:
+            - site_config:write
       docs: >
         Update the `robots.txt` configuration for various user agents.
 

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

@@ -7,7 +7,9 @@ service:
     get-custom-code:
       path: /sites/{site_id}/custom_code
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - custom_code:read
       docs: |
         Get all scripts applied to a site by the App. 
 
@@ -54,14 +56,22 @@ service:
     upsert-custom-code:
       path: /sites/{site_id}/custom_code
       method: PUT
-      auth: true
-      docs: |
-        Apply registered scripts to a site.
+      auth:
+        - OAuth2:
+            - custom_code:write
+      docs: >
+        Apply registered scripts to a site. If you have multiple scripts your
+        App needs to apply or maintain on a site, 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 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: ../../../openapi/referenced-specs/v2.yml
@@ -114,10 +124,22 @@ service:
     delete-custom-code:
       path: /sites/{site_id}/custom_code
       method: DELETE
-      auth: true
+      auth:
+        - OAuth2:
+            - custom_code:write
       docs: >
-        Remove scripts from a site applied by the App. This endpoint will not
-        remove scripts from the site's registered scripts.
+        Remove all scripts from a site 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-sites/upsert-custom-code)
+        endpoint.
+
+
+        <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`
@@ -140,7 +162,9 @@ service:
     list-custom-code-blocks:
       path: /sites/{site_id}/custom_code/blocks
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - custom_code:read
       docs: >
         Get a list of scripts that have been applied to a site and/or individual
         pages. 
@@ -185,6 +209,9 @@ service:
       examples:
         - path-parameters:
             site_id: 580e63e98c9a982ac9b8b741
+          query-parameters:
+            offset: 1.1
+            limit: 1.1
           response:
             body:
               blocks:

package/.mock/definition/sites/wellKnown.yml

@@ -19,7 +19,9 @@ service:
     put:
       path: /sites/{site_id}/well_known
       method: PUT
-      auth: true
+      auth:
+        - OAuth2:
+            - site_config:write
       docs: >
         Upload a supported well-known file to a site.
 
@@ -70,12 +72,26 @@ service:
         - path-parameters:
             site_id: 580e63e98c9a982ac9b8b741
           request:
-            fileName: fileName
-            fileData: fileData
+            fileName: apple-app-site-association.txt
+            fileData: |
+              {
+                "applinks": {
+                  "apps": [],
+                  "details": [
+                {
+                  "appID": "ABCDE12345.com.example.app",
+                  "paths": [ "/*", "/some/path/*" ]
+                    }
+                  ]
+                }
+              }
+            contentType: application/json
     delete:
       path: /sites/{site_id}/well_known
       method: DELETE
-      auth: true
+      auth:
+        - OAuth2:
+            - site_config:write
       docs: >
         Delete existing well-known files from a site.