webflow-api 3.2.0 → 3.3.0-beta

package/.mock/definition/collections.yml

@@ -7,7 +7,9 @@ service:
     list:
       path: /sites/{site_id}/collections
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - cms:read
       docs: |
         List of all Collections within a Site.
 
@@ -56,7 +58,9 @@ service:
     create:
       path: /sites/{site_id}/collections
       method: POST
-      auth: true
+      auth:
+        - OAuth2:
+            - cms:write
       docs: >
         Create a Collection for a site with collection fields.
 
@@ -159,7 +163,9 @@ service:
     get:
       path: /collections/{collection_id}
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - cms:read
       docs: |
         Get the full details of a collection from its ID.
 
@@ -297,22 +303,27 @@ service:
                   type: File
                   slug: guide-file
                   displayName: Guide File
+                  helpText: helpText
                 - id: 7f8e9d0c1b2a3f4e5d6c8b9e
                   isRequired: false
                   isEditable: true
                   type: Email
                   slug: contributor-email
                   displayName: Contributor Email
+                  helpText: helpText
                 - id: 3a4f5e6d7c8b9a0e1d2c4b5f
                   isRequired: false
                   isEditable: true
                   type: Phone
                   slug: emergency-contact
                   displayName: Emergency Contact
+                  helpText: helpText
     delete:
       path: /collections/{collection_id}
       method: DELETE
-      auth: true
+      auth:
+        - OAuth2:
+            - cms:write
       docs: |
         Delete a collection using its ID.
 

package/.mock/definition/comments.yml

@@ -17,6 +17,7 @@ webhooks:
             siteId: 679826b3b20b045e176bc4b5
             pageId: 679826b3b20b045e176bc4bc
             localeId: 67993753d910db250db64b3e
+            itemId: 580e64008c9a982ac9b8b754
             breakpoint: main
             url: >-
               https://webflow.com/design/site-slug-4ec832?workflow=comment&commentId=679d2ddb5196117ad04d1ffa&pageId=679826b3b20b045e176bc4bc

package/.mock/definition/components.yml

@@ -7,7 +7,9 @@ service:
     list:
       path: /sites/{site_id}/components
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - components:read
       docs: |
         List of all components for a site.
 
@@ -48,6 +50,8 @@ service:
             site_id: 580e63e98c9a982ac9b8b741
           query-parameters:
             branchId: 68026fa68ef6dc744c75b833
+            limit: 1.1
+            offset: 1.1
           response:
             body:
               components:
@@ -65,9 +69,13 @@ service:
                   readonly: true
                 - id: 6258612d1ee792848f805dcf
                   name: Card
+                  group: Buttons
+                  description: A button component that can be used across the site
                   readonly: true
                 - id: 68a2b1d1ee792848f805dcf
                   name: Nav
+                  group: Buttons
+                  description: A button component that can be used across the site
                   readonly: true
               pagination:
                 limit: 20
@@ -76,7 +84,9 @@ service:
     get-content:
       path: /sites/{site_id}/components/{component_id}/dom
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - components:read
       docs: >
         Get static content from a component definition. This includes text
         nodes, image nodes, select nodes, text input nodes, submit button nodes,
@@ -109,9 +119,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)
           branchId:
             type: optional<string>
             docs: Scope the operation to work on a specific branch.
@@ -140,6 +153,8 @@ service:
           query-parameters:
             localeId: 65427cf400e02b306eaa04a0
             branchId: 68026fa68ef6dc744c75b833
+            limit: 1.1
+            offset: 1.1
           response:
             body:
               componentId: 69118560-d0bc-15fc-bbf8-b8fe5f6535b5
@@ -189,7 +204,9 @@ service:
     update-content:
       path: /sites/{site_id}/components/{component_id}/dom
       method: POST
-      auth: true
+      auth:
+        - OAuth2:
+            - components:write
       docs: >
         This endpoint updates content within a component defintion for
         **secondary locales**. It supports updating up to 1000 nodes in a single
@@ -200,13 +217,18 @@ service:
 
         1. Use the [get component
         content](/data/reference/pages-and-components/components/get-content)
-        endpoint to identify available content nodes and their types
+        endpoint to identify available content nodes and their types.
 
         2. If your component definition has a component instance nested within
         it, retrieve the nested component instance'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>
@@ -230,9 +252,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)
           branchId:
             type: optional<string>
             docs: Scope the operation to work on a specific branch.
@@ -294,7 +319,9 @@ service:
     get-properties:
       path: /sites/{site_id}/components/{component_id}/properties
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - components:read
       docs: >
         Get the default property values of a component definition.
 
@@ -320,9 +347,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)
           branchId:
             type: optional<string>
             docs: Scope the operation to work on a specific branch.
@@ -351,6 +381,8 @@ service:
           query-parameters:
             localeId: 65427cf400e02b306eaa04a0
             branchId: 68026fa68ef6dc744c75b833
+            limit: 1.1
+            offset: 1.1
           response:
             body:
               componentId: 658205daa3e8206a523b5ad4
@@ -374,17 +406,26 @@ service:
     update-properties:
       path: /sites/{site_id}/components/{component_id}/properties
       method: POST
-      auth: true
+      auth:
+        - OAuth2:
+            - components:write
       docs: >
         Update the default property values of a component definition in a
         specificed locale.
 
 
-        Before making updates, use the [get component
+        Before making updates:
+
+        1. Use the [get component
         properties](/data/reference/pages-and-components/components/get-properties)
         endpoint to identify properties that can be updated in a secondary
         locale.
 
+        2. Rich Text properties may include a `data-w-id` attribute. This
+        attribute is used by Webflow to maintain links across locales. Always
+        include the original `data-w-id` value in your update requests to ensure
+        consistent behavior across all locales.
+
 
         <Note>The request requires a secondary locale ID. If a `localeId` is
         missing, the request will not be processed and will result in an
@@ -407,9 +448,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)
           branchId:
             type: optional<string>
             docs: Scope the operation to work on a specific branch.
@@ -456,12 +500,12 @@ types:
   ComponentDomWriteNodesItem:
     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/ecommerce.yml

@@ -7,7 +7,9 @@ service:
     get-settings:
       path: /sites/{site_id}/ecommerce/settings
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - ecommerce:read
       docs: |
         Retrieve ecommerce settings for a site.
 

package/.mock/definition/forms.yml

@@ -7,7 +7,9 @@ service:
     list:
       path: /sites/{site_id}/forms
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - forms:read
       docs: |
         List forms for a given site.
 
@@ -45,6 +47,9 @@ service:
       examples:
         - path-parameters:
             site_id: 580e63e98c9a982ac9b8b741
+          query-parameters:
+            limit: 1.1
+            offset: 1.1
           response:
             body:
               forms:
@@ -54,13 +59,16 @@ service:
                   fields:
                     '0':
                       displayName: Email
+                      placeholder: Enter your email
                       userVisible: true
                     '1':
                       displayName: Email
+                      placeholder: Enter your email
                       userVisible: true
                   responseSettings:
                     redirectUrl: https://example.com
                     redirectMethod: GET
+                    redirectAction: POST https://example.com
                     sendEmailConfirmation: true
                   id: 589a331aa51e760df7ccb89e
                   siteId: 580e63e98c9a982ac9b8b741
@@ -75,10 +83,12 @@ service:
                   fields:
                     '0':
                       displayName: Email
+                      placeholder: Enter your email
                       userVisible: true
                   responseSettings:
                     redirectUrl: https://example.com
                     redirectMethod: GET
+                    redirectAction: POST https://example.com
                     sendEmailConfirmation: false
                   id: 580ff8d7ba3e45ba9fe588e9
                   siteId: 580e63e98c9a982ac9b8b741
@@ -94,7 +104,9 @@ service:
     get:
       path: /forms/{form_id}
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - forms:read
       docs: |
         Get information about a given form.
 
@@ -129,6 +141,7 @@ service:
                 660d5bcc9c0772150459dfb1:
                   displayName: Name
                   type: Plain
+                  placeholder: Enter your email
                   userVisible: true
                 589a331aa51e760df7ccb89d:
                   displayName: Email
@@ -138,6 +151,7 @@ service:
               responseSettings:
                 redirectUrl: https://example.com
                 redirectMethod: GET
+                redirectAction: POST https://example.com
                 sendEmailConfirmation: true
               id: 589a331aa51e760df7ccb89e
               siteId: 580e63e98c9a982ac9b8b741
@@ -149,7 +163,9 @@ service:
     list-submissions:
       path: /forms/{form_id}/submissions
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - forms:read
       docs: |
         List form submissions for a given form
 
@@ -192,6 +208,9 @@ service:
       examples:
         - path-parameters:
             form_id: 580e63e98c9a982ac9b8b741
+          query-parameters:
+            offset: 1.1
+            limit: 1.1
           response:
             body:
               formSubmissions:
@@ -218,7 +237,9 @@ service:
     get-submission:
       path: /form_submissions/{form_submission_id}
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - forms:read
       docs: |
         Get information about a given form submissio.
 
@@ -257,7 +278,9 @@ service:
     delete-submission:
       path: /form_submissions/{form_submission_id}
       method: DELETE
-      auth: true
+      auth:
+        - OAuth2:
+            - forms:write
       docs: |
         Delete a form submission
 
@@ -284,7 +307,9 @@ service:
     update-submission:
       path: /form_submissions/{form_submission_id}
       method: PATCH
-      auth: true
+      auth:
+        - OAuth2:
+            - forms:write
       docs: |
         Update hidden fields on a form submission
 
@@ -332,82 +357,6 @@ service:
               formResponse:
                 First Name: Arthur
                 Last Name: Dent
-    list-submissions-by-site:
-      path: /sites/{site_id}/form_submissions
-      method: GET
-      auth: true
-      docs: >
-        List form submissions for a given site. This endpoint differs from the
-        existing [List Form Submissions
-        endpoint](/data/reference/forms/form-submissions/list-submissions) by
-        accepting `siteId` as a path parameter and `elementId` as a query
-        parameter. You can get the `elementId` from the [List forms
-        endpoint](/data/reference/forms/forms/list).
-
-
-
-
-        Required scope | `forms:read`
-      source:
-        openapi: ../../../openapi/referenced-specs/v2.yml
-      path-parameters:
-        site_id:
-          type: string
-          docs: Unique identifier for a Site
-      display-name: List Form Submissions by Site
-      request:
-        name: FormsListSubmissionsBySiteRequest
-        query-parameters:
-          elementId:
-            type: optional<string>
-            docs: Identifier for an element
-          offset:
-            type: optional<double>
-            docs: >-
-              Offset used for pagination if the results have more than limit
-              records
-          limit:
-            type: optional<double>
-            docs: 'Maximum number of records to be returned (max limit: 100)'
-      response:
-        docs: Request was successful
-        type: root.FormSubmissionList
-        status-code: 200
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.ForbiddenError
-        - root.NotFoundError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            site_id: 580e63e98c9a982ac9b8b741
-          query-parameters:
-            elementId: 18259716-3e5a-646a-5f41-5dc4b9405aa0
-          response:
-            body:
-              formSubmissions:
-                - id: 6321ca84df3949bfc6752327
-                  displayName: Sample Form
-                  siteId: 62749158efef318abc8d5a0f
-                  workspaceId: 62749158efef318abc8d5a0f
-                  dateSubmitted: '2022-09-14T12:35:16Z'
-                  formResponse:
-                    First Name: Arthur
-                    Last Name: Dent
-                - id: 660d64fabf6e0a0d4edab981
-                  displayName: Sample Form
-                  siteId: 62749158efef318abc8d5a0f
-                  workspaceId: 62749158efef318abc8d5a0f
-                  dateSubmitted: '2022-09-14T12:35:16Z'
-                  formResponse:
-                    First Name: Ford
-                    Last Name: Prefect
-              pagination:
-                limit: 25
-                offset: 0
-                total: 2
   source:
     openapi: ../../../openapi/referenced-specs/v2.yml
   display-name: Forms

package/.mock/definition/inventory.yml

@@ -5,9 +5,11 @@ service:
   base-path: ''
   endpoints:
     list:
-      path: /collections/{collection_id}/items/{item_id}/inventory
+      path: /collections/{sku_collection_id}/items/{sku_id}/inventory
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - ecommerce:read
       docs: |
         List the current inventory levels for a particular SKU item.
 
@@ -15,12 +17,14 @@ service:
       source:
         openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
-        collection_id:
+        sku_collection_id:
           type: string
-          docs: Unique identifier for a Collection
-        item_id:
+          docs: >-
+            Unique identifier for a SKU collection. Use the List Collections API
+            to find this ID.
+        sku_id:
           type: string
-          docs: Unique identifier for an Item
+          docs: Unique identifier for a SKU
       display-name: List Inventory
       response:
         docs: Request was successful
@@ -36,17 +40,19 @@ service:
         - root.InternalServerError
       examples:
         - path-parameters:
-            collection_id: 580e63fc8c9a982ac9b8b745
-            item_id: 580e64008c9a982ac9b8b754
+            sku_collection_id: 6377a7c4b7a79608c34a46f7
+            sku_id: 5e8518516e147040726cc415
           response:
             body:
               id: 5bfedb42bab0ad90fa7dad39
               quantity: 100
               inventoryType: finite
     update:
-      path: /collections/{collection_id}/items/{item_id}/inventory
+      path: /collections/{sku_collection_id}/items/{sku_id}/inventory
       method: PATCH
-      auth: true
+      auth:
+        - OAuth2:
+            - ecommerce:write
       docs: >
         Updates the current inventory levels for a particular SKU item. 
 
@@ -65,12 +71,14 @@ service:
       source:
         openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
-        collection_id:
+        sku_collection_id:
           type: string
-          docs: Unique identifier for a Collection
-        item_id:
+          docs: >-
+            Unique identifier for a SKU collection. Use the List Collections API
+            to find this ID.
+        sku_id:
           type: string
-          docs: Unique identifier for an Item
+          docs: Unique identifier for a SKU
       display-name: Update Item Inventory
       request:
         name: InventoryUpdateRequest
@@ -100,8 +108,8 @@ service:
         - root.InternalServerError
       examples:
         - path-parameters:
-            collection_id: 580e63fc8c9a982ac9b8b745
-            item_id: 580e64008c9a982ac9b8b754
+            sku_collection_id: 6377a7c4b7a79608c34a46f7
+            sku_id: 5e8518516e147040726cc415
           request:
             inventoryType: infinite
           response:
@@ -140,5 +148,5 @@ webhooks:
         payload:
           triggerType: ecomm_inventory_changed
           payload:
-            ref: ./schemas/inventory.yml#/InventoryItem/example
+            \$ref: ./schemas/inventory.yml#/InventoryItem/example
     docs: Information about updated ecommerce inventory values

package/.mock/definition/items.yml

@@ -15,7 +15,7 @@ webhooks:
             workspaceId: 625860a7a6c16d624927122f
             siteId: 65427cf400e02b306eaa049c
             collectionId: 664243617fcc8b464b23c4ee
-            cmsLocaleId: 681442a144bb80bd00480fda
+            lastPublished: '2023-03-17T18:47:35Z'
             lastUpdated: '2023-03-17T18:47:35Z'
             createdOn: '2023-03-17T18:47:35Z'
             isArchived: false
@@ -34,18 +34,13 @@ webhooks:
       - payload:
           triggerType: collection_item_changed
           payload:
-            id: 580e64008c9a982ac9b8b754
-            workspaceId: 625860a7a6c16d624927122f
-            siteId: 65427cf400e02b306eaa049c
-            collectionId: 664243617fcc8b464b23c4ee
-            cmsLocaleId: 681442a144bb80bd00480fda
-            lastUpdated: '2023-03-17T18:47:35Z'
-            createdOn: '2023-03-17T18:47:35Z'
-            isArchived: false
-            isDraft: false
+            id: id
+            workspaceId: workspaceId
+            siteId: siteId
+            collectionId: collectionId
             fieldData:
-              name: Pan-Galactic Gargle Blaster
-              slug: pan-galactic-gargle-blaster
+              name: name
+              slug: slug
     docs: Information about an updated collection item
   collection_item_deleted:
     audiences: []
@@ -67,11 +62,29 @@ webhooks:
             isArchived: false
             isDraft: false
             fieldData:
-              name: Anna Gunn
-              slug: anna-gunn
-              _locale: 681442a144bb80bd00480fda
-              _noSearch: false
+              name: Earth
+              slug: earth
+              description: Mostly harmless
+              color: '#0000FF'
+              type: planet
+              galaxy: Milky Way
     docs: Information about a deleted collection item
+  collection_item_published:
+    audiences: []
+    method: POST
+    display-name: Collection Item Published
+    headers: {}
+    payload: root.CollectionItemPublished
+    examples:
+      - payload:
+          triggerType: collection_item_published
+          payload:
+            id: 6321ca84df3949bfc6752327
+            siteId: 65427cf400e02b306eaa049c
+            workspaceId: 625860a7a6c16d624927122f
+            collectionId: 664243617fcc8b464b23c4ee
+            cmsLocaleId: 681442a144bb80bd00480fda
+    docs: Information about a collection item that was published
   collection_item_unpublished:
     audiences: []
     method: POST