webflow-api 3.1.2 → 3.1.3

package/.mock/definition/api.yml

@@ -3,8 +3,15 @@ error-discrimination:
   strategy: status-code
 display-name: Data API
 environments:
-  Default: https://api.webflow.com/v2
-default-environment: Default
+  Data API:
+    urls:
+      Base: https://api.webflow.com/v2
+      Data API: https://api.webflow.com/v2
+      Content Delivery API: https://api-cdn.webflow.com/v2
+      Production: https://api.webflow.com/v2
+      CDN: https://api-cdn.webflow.com/v2
+default-environment: Data API
+default-url: Base
 auth-schemes:
   BearerToken:
     scheme: bearer

package/.mock/definition/collections/items.yml

@@ -340,7 +340,7 @@ service:
         name: ItemsDeleteItemsRequest
         body:
           properties:
-            items: optional<list<ItemsDeleteItemsRequestItemsItem>>
+            items: list<ItemsDeleteItemsRequestItemsItem>
         content-type: application/json
       errors:
         - root.BadRequestError
@@ -352,7 +352,9 @@ service:
       examples:
         - path-parameters:
             collection_id: 580e63fc8c9a982ac9b8b745
-          request: {}
+          request:
+            items:
+              - id: 580e64008c9a982ac9b8b754
     update-items:
       path: /collections/{collection_id}/items
       method: PATCH
@@ -568,6 +570,11 @@ service:
       docs: |
         List all published items in a collection.
 
+        <Note title="Serve data with the Content Delivery API">
+          To serve content to your other frontends applications, enterprise sites have access to a dedicated [content delivery API](/data/docs/cms-content-delivery), available at api-cdn.webflow.com.
+
+        </Note>
+
         Required scope | `CMS:read`
       source:
         openapi: ../../../openapi/referenced-specs/v2.yml
@@ -610,6 +617,7 @@ service:
         docs: Request was successful
         type: root.CollectionItemList
         status-code: 200
+      url: Data API
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -786,7 +794,7 @@ service:
         name: ItemsDeleteItemsLiveRequest
         body:
           properties:
-            items: optional<list<ItemsDeleteItemsLiveRequestItemsItem>>
+            items: list<ItemsDeleteItemsLiveRequestItemsItem>
         content-type: application/json
       errors:
         - root.BadRequestError
@@ -797,7 +805,9 @@ service:
       examples:
         - path-parameters:
             collection_id: 580e63fc8c9a982ac9b8b745
-          request: {}
+          request:
+            items:
+              - id: 580e64008c9a982ac9b8b754
     update-items-live:
       path: /collections/{collection_id}/items/live
       method: PATCH
@@ -1323,6 +1333,7 @@ service:
         docs: Request was successful
         type: root.CollectionItem
         status-code: 200
+      url: Production
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -1452,6 +1463,11 @@ service:
       docs: |
         Get details of a selected Collection live Item.
 
+        <Note title="Serve data with the Content Delivery API">
+          To serve content to your other frontends applications, enterprise sites have access to a dedicated [content delivery API](/data/docs/cms-content-delivery), available at api-cdn.webflow.com.
+
+        </Note>
+
         Required scope | `CMS:read`
       source:
         openapi: ../../../openapi/referenced-specs/v2.yml
@@ -1477,6 +1493,7 @@ service:
         docs: Request was successful
         type: root.CollectionItem
         status-code: 200
+      url: Data API
       errors:
         - root.BadRequestError
         - root.UnauthorizedError

package/.mock/definition/components.yml

@@ -74,7 +74,8 @@ service:
       auth: true
       docs: >
         Get static content from a component definition. This includes text
-        nodes, image nodes and nested component instances.
+        nodes, image nodes, select nodes, text input nodes, submit button nodes,
+        and nested component instances.
 
         To retrieve dynamic content set by component properties, use the [get
         component
@@ -125,8 +126,7 @@ service:
         - root.TooManyRequestsError
         - root.InternalServerError
       examples:
-        - name: ComponentDOM
-          path-parameters:
+        - path-parameters:
             site_id: 580e63e98c9a982ac9b8b741
             component_id: 8505ba55-ef72-629e-f85c-33e4b703d48b
           query-parameters:
@@ -151,43 +151,32 @@ service:
                     key: value
                   type: image
                 - id: id
-                  componentId: componentId
-                  propertyOverrides:
-                    - propertyId: 7dd14c08-2e96-8d3d-2b19-b5c03642a0f0
-                  type: component-instance
-              pagination:
-                limit: 4
-                offset: 0
-                total: 4
-        - name: LocalizedComponentDOM
-          path-parameters:
-            site_id: 580e63e98c9a982ac9b8b741
-            component_id: 8505ba55-ef72-629e-f85c-33e4b703d48b
-          query-parameters:
-            localeId: 65427cf400e02b306eaa04a0
-          response:
-            body:
-              componentId: 69118560-d0bc-15fc-bbf8-b8fe5f6535b5
-              nodes:
+                  placeholder: placeholder
+                  attributes:
+                    key: value
+                  type: text-input
                 - id: id
-                  image: {}
+                  choices:
+                    - value: value
+                      text: text
                   attributes:
                     key: value
-                  type: image
+                  type: select
                 - id: id
-                  text: {}
+                  value: value
+                  waitingText: waitingText
                   attributes:
                     key: value
-                  type: text
+                  type: submit-button
                 - id: id
                   componentId: componentId
                   propertyOverrides:
                     - propertyId: 7dd14c08-2e96-8d3d-2b19-b5c03642a0f0
                   type: component-instance
               pagination:
-                limit: 100
+                limit: 7
                 offset: 0
-                total: 3
+                total: 7
     update-content:
       path: /sites/{site_id}/components/{component_id}/dom
       method: POST
@@ -268,6 +257,17 @@ service:
                 text: >-
                   <div><h3>Don't Panic!</h3><p>Always know where your towel
                   is.</p></div>
+              - nodeId: a245c12d-995b-55ee-5ec7-aa36a6cad635
+                choices:
+                  - value: choice-1
+                    text: First choice
+                  - value: choice-2
+                    text: Second choice
+              - nodeId: a245c12d-995b-55ee-5ec7-aa36a6cad642
+                placeholder: Enter something here...
+              - nodeId: a245c12d-995b-55ee-5ec7-aa36a6cad671
+                value: Submit
+                waitingText: Submitting...
               - nodeId: a245c12d-995b-55ee-5ec7-aa36a6cad629
                 propertyOverrides:
                   - propertyId: 7dd14c08-2e96-8d3d-2b19-b5c03642a0f0
@@ -437,6 +437,10 @@ types:
     union:
       - root.TextNodeWrite
       - root.ComponentInstanceNodePropertyOverridesWrite
+      - root.SelectNodeWrite
+      - root.TextInputNodeWrite
+      - root.SubmitButtonNodeWrite
+      - root.SearchButtonNodeWrite
     source:
       openapi: ../../../openapi/referenced-specs/v2.yml
     inline: true

package/.mock/definition/pages.yml

@@ -276,7 +276,8 @@ service:
       auth: true
       docs: >
         Get content from a static page. This includes text nodes, image nodes,
-        and component instances with [property
+        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).
 
 
@@ -327,8 +328,7 @@ service:
         - root.TooManyRequestsError
         - root.InternalServerError
       examples:
-        - name: PageDOM
-          path-parameters:
+        - path-parameters:
             page_id: 63c720f9347c2139b248e552
           query-parameters:
             localeId: 65427cf400e02b306eaa04a0
@@ -351,6 +351,23 @@ service:
                   attributes:
                     key: value
                   type: image
+                - id: id
+                  choices:
+                    - value: value
+                      text: text
+                  attributes:
+                    key: value
+                  type: select
+                - id: id
+                  placeholder: placeholder
+                  attributes:
+                    key: value
+                  type: text-input
+                - id: id
+                  text: {}
+                  attributes:
+                    key: value
+                  type: text
                 - id: id
                   componentId: componentId
                   propertyOverrides:
@@ -433,6 +450,17 @@ service:
                 text: >-
                   <div><h3>Don't Panic!</h3><p>Always know where your towel
                   is.</p></div>
+              - nodeId: a245c12d-995b-55ee-5ec7-aa36a6cad635
+                choices:
+                  - value: choice-1
+                    text: First choice
+                  - value: choice-2
+                    text: Second choice
+              - nodeId: a245c12d-995b-55ee-5ec7-aa36a6cad642
+                placeholder: Enter something here...
+              - nodeId: a245c12d-995b-55ee-5ec7-aa36a6cad671
+                value: Submit
+                waitingText: Submitting...
               - nodeId: a245c12d-995b-55ee-5ec7-aa36a6cad629
                 propertyOverrides:
                   - propertyId: 7dd14c08-2e96-8d3d-2b19-b5c03642a0f0
@@ -453,6 +481,10 @@ types:
     union:
       - root.TextNodeWrite
       - root.ComponentInstanceNodePropertyOverridesWrite
+      - root.SelectNodeWrite
+      - root.TextInputNodeWrite
+      - root.SubmitButtonNodeWrite
+      - root.SearchButtonNodeWrite
     source:
       openapi: ../../../openapi/referenced-specs/v2.yml
     inline: true

package/.mock/definition/products.yml

@@ -84,13 +84,24 @@ service:
                       createdOn: '2023-03-17T18:47:35Z'
                       fieldData:
                         sku-values:
-                          ff42fee0113744f693a764e3431a9cc2: 64a74715c456e36762fc39a1
-                        name: Blue T-shirt
-                        slug: t-shirt-blue
+                          color: blue
+                          size: small
+                        name: Colorful T-shirt - Default
+                        slug: colorful-t-shirt-default
                         price:
-                          value: 100
+                          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
+                                name: Royal Blue
+                                slug: royal-blue
               pagination:
                 limit: 100
                 offset: 0
@@ -100,20 +111,14 @@ service:
       method: POST
       auth: true
       docs: >
-        Create a new product and SKU.
+        Create a new ecommerce product and defaultSKU. A product, at minimum,
+        must have a single SKU.
 
 
-        When you create a product, you will always create a SKU, since a Product
-        Item must have, at minimum, a single SKU.
-
-
-        To create a Product with multiple SKUs - for example a T-shirt in sizes
-        small, medium and large:
-          - Create parameters in `sku-properties`, also known as [product options and variants.](https://help.webflow.com/hc/en-us/articles/33961334531347-Create-product-options-and-variants).
-          - 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/create-sku)
+        To create a product with multiple SKUs:
+          - First, create a list of `sku-properties`, also known as [product options](https://help.webflow.com/hc/en-us/articles/33961334531347-Create-product-options-and-variants). For example, a T-shirt product may have a "color" `sku-property`, with a list of enum values: red, yellow, and blue, another `sku-property` may be "size", with a list of enum values: small, medium, and large.
+          - Once, a product is created with a list of `sku-properties`, Webflow will create a **default SKU**, which is always a combination of the first `enum` values of each `sku-property`. (e.g. Small - Red - T-Shirt)
+          - After creation, you can create additional SKUs for the product, using the [Create SKUs 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
@@ -133,8 +138,8 @@ service:
         body:
           properties:
             publishStatus: optional<root.PublishStatus>
-            product: optional<root.Product>
-            sku: optional<root.Sku>
+            product: ProductSkuCreateProduct
+            sku: ProductSkuCreateSku
         content-type: application/json
       response:
         docs: Request was successful
@@ -151,7 +156,50 @@ service:
       examples:
         - path-parameters:
             site_id: 580e63e98c9a982ac9b8b741
-          request: {}
+          request:
+            publishStatus: staging
+            product:
+              fieldData:
+                name: Colorful T-shirt
+                slug: colorful-t-shirt
+                description: >-
+                  Our best-selling t-shirt available in multiple colors and
+                  sizes
+                sku-properties:
+                  - id: color
+                    name: Color
+                    enum:
+                      - id: red
+                        name: Red
+                        slug: red
+                      - id: yellow
+                        name: Yellow
+                        slug: yellow
+                      - id: blue
+                        name: Blue
+                        slug: blue
+                  - id: size
+                    name: Size
+                    enum:
+                      - id: small
+                        name: Small
+                        slug: small
+                      - id: medium
+                        name: Medium
+                        slug: medium
+                      - id: large
+                        name: Large
+                        slug: large
+            sku:
+              fieldData:
+                name: Colorful T-shirt - Red Small
+                slug: colorful-t-shirt-red-small
+                price:
+                  value: 2499
+                  unit: USD
+                  currency: USD
+                main-image: >-
+                  https://rocketamp-sample-store.myshopify.com/cdn/shop/products/Gildan_2000_Antique_Cherry_Red_Front_1024x1024.jpg?v=1527232987
           response:
             body:
               product:
@@ -187,13 +235,24 @@ service:
                   createdOn: '2023-03-17T18:47:35Z'
                   fieldData:
                     sku-values:
-                      ff42fee0113744f693a764e3431a9cc2: 64a74715c456e36762fc39a1
-                    name: Blue T-shirt
-                    slug: t-shirt-blue
+                      color: blue
+                      size: small
+                    name: Colorful T-shirt - Default
+                    slug: colorful-t-shirt-default
                     price:
-                      value: 100
+                      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
+                            name: Royal Blue
+                            slug: royal-blue
     get:
       path: /sites/{site_id}/products/{product_id}
       method: GET
@@ -264,13 +323,24 @@ service:
                   createdOn: '2023-03-17T18:47:35Z'
                   fieldData:
                     sku-values:
-                      ff42fee0113744f693a764e3431a9cc2: 64a74715c456e36762fc39a1
-                    name: Blue T-shirt
-                    slug: t-shirt-blue
+                      color: blue
+                      size: small
+                    name: Colorful T-shirt - Default
+                    slug: colorful-t-shirt-default
                     price:
-                      value: 100
+                      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
+                            name: Royal Blue
+                            slug: royal-blue
     update:
       path: /sites/{site_id}/products/{product_id}
       method: PATCH
@@ -370,7 +440,7 @@ service:
         product_id:
           type: string
           docs: Unique identifier for a Product
-      display-name: Create SKU
+      display-name: Create SKUs
       request:
         name: ProductsCreateSkuRequest
         body:
@@ -398,11 +468,15 @@ service:
             product_id: 580e63fc8c9a982ac9b8b745
           request:
             skus:
-              - {}
+              - fieldData:
+                  name: Colorful T-shirt - Default
+                  slug: colorful-t-shirt-default
+                  price:
+                    value: 2499
+                    unit: USD
+                    currency: USD
           response:
             body:
-              required:
-                key: value
               skus:
                 - id: 580e63fc8c9a982ac9b8b745
                   cmsLocaleId: 653ad57de882f528b32e810e
@@ -411,13 +485,24 @@ service:
                   createdOn: '2023-03-17T18:47:35Z'
                   fieldData:
                     sku-values:
-                      ff42fee0113744f693a764e3431a9cc2: 64a74715c456e36762fc39a1
-                    name: Blue T-shirt
-                    slug: t-shirt-blue
+                      color: blue
+                      size: small
+                    name: Colorful T-shirt - Default
+                    slug: colorful-t-shirt-default
                     price:
-                      value: 100
+                      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
+                            name: Royal Blue
+                            slug: royal-blue
     update-sku:
       path: /sites/{site_id}/products/{product_id}/skus/{sku_id}
       method: PATCH
@@ -470,7 +555,14 @@ service:
             product_id: 580e63fc8c9a982ac9b8b745
             sku_id: 5e8518516e147040726cc415
           request:
-            sku: {}
+            sku:
+              fieldData:
+                name: Colorful T-shirt - Default
+                slug: colorful-t-shirt-default
+                price:
+                  value: 2499
+                  unit: USD
+                  currency: USD
           response:
             body:
               id: 580e63fc8c9a982ac9b8b745
@@ -480,12 +572,14 @@ service:
               createdOn: '2023-03-17T18:47:35Z'
               fieldData:
                 sku-values:
-                  ff42fee0113744f693a764e3431a9cc2: 64a74715c456e36762fc39a1
-                name: Blue T-shirt
-                slug: t-shirt-blue
+                  color: blue
+                  size: small
+                name: Colorful T-shirt - Default
+                slug: colorful-t-shirt-default
                 price:
-                  value: 100
+                  value: 2499
                   unit: USD
+                  currency: USD
                 compare-at-price:
                   value: 100
                   unit: USD
@@ -498,12 +592,32 @@ service:
                     - {}
                 track-inventory: true
                 quantity: 10
+                main-image: https://www.example.com/image.jpg
+                sku: '1234567890'
+                sku-properties:
+                  - id: Color
+                    name: Color
+                    enum:
+                      - id: id
+                        name: Royal Blue
+                        slug: royal-blue
   source:
     openapi: ../../../openapi/referenced-specs/v2.yml
 types:
+  ProductSkuCreateProduct:
+    properties:
+      fieldData: optional<root.ProductFieldData>
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+    inline: true
+  ProductSkuCreateSku:
+    properties:
+      fieldData: optional<root.SkuFieldData>
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+    inline: true
   ProductsCreateSkuResponse:
     properties:
-      required: optional<unknown>
-      skus: optional<list<root.Sku>>
+      skus: list<root.Sku>
     source:
       openapi: ../../../openapi/referenced-specs/v2.yml