webflow-api 3.1.2 → 3.1.4

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

package/.mock/definition/sites/comments.yml

@@ -0,0 +1,325 @@
+types:
+  CommentsListCommentThreadsRequestSortBy:
+    enum:
+      - createdOn
+      - lastUpdated
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  CommentsListCommentThreadsRequestSortOrder:
+    enum:
+      - asc
+      - desc
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  CommentsGetCommentThreadRequestSortBy:
+    enum:
+      - createdOn
+      - lastUpdated
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  CommentsGetCommentThreadRequestSortOrder:
+    enum:
+      - asc
+      - desc
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  CommentsListCommentRepliesRequestSortBy:
+    enum:
+      - createdOn
+      - lastUpdated
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  CommentsListCommentRepliesRequestSortOrder:
+    enum:
+      - asc
+      - desc
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+imports:
+  root: ../__package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    list-comment-threads:
+      path: /sites/{site_id}/comments
+      method: GET
+      auth: true
+      docs: |
+        List all comment threads for a site.
+
+        <Note title="Timing of comment threads">
+          There may be a delay of up to 5 minutes before new comments appear in the system.
+        </Note>
+
+        Required scope | `comments:read`
+      source:
+        openapi: ../../../openapi/referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+      display-name: List Comment Threads
+      request:
+        name: CommentsListCommentThreadsRequest
+        query-parameters:
+          localeId:
+            type: optional<string>
+            docs: >-
+              Unique identifier for a specific locale. Applicable, when using
+              localization.
+          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)'
+          sortBy:
+            type: optional<CommentsListCommentThreadsRequestSortBy>
+            docs: >-
+              Sort results by the provided value. Only allowed when sortOrder is
+              provided.
+          sortOrder:
+            type: optional<CommentsListCommentThreadsRequestSortOrder>
+            docs: Sorts the results by asc or desc
+      response:
+        docs: Request was successful
+        type: root.CommentThreadList
+        status-code: 200
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          query-parameters:
+            localeId: 65427cf400e02b306eaa04a0
+          response:
+            body:
+              comments:
+                - id: 679d2ddb5196117ad04d1ffa
+                  siteId: 679826b3b20b045e176bc4b5
+                  pageId: 679826b3b20b045e176bc4bc
+                  localeId: 67993753d910db250db64b3e
+                  itemId: 580e64008c9a982ac9b8b754
+                  breakpoint: main
+                  url: >-
+                    https://webflow.com/design/site-slug-4ec832?workflow=comment&commentId=679d2ddb5196117ad04d1ff8&pageId=679826b3b20b045e176bc4bc
+                  content: 'Let''s go to the pub! [[6287ec36a841b25637c663df]] '
+                  isResolved: false
+                  author:
+                    userId: 6287ec36a841b25637c663df
+                    email: ford.prefect@heartofgold.spaceship
+                    name: Ford Prefect
+                  mentionedUsers:
+                    - userId: 6287ec36a841b25637c663df
+                      email: arthur.dent@heartofgold.spaceship
+                      name: Arthur Dent
+                  createdOn: '2025-01-31T20:08:59.759Z'
+                  lastUpdated: '2025-01-31T20:08:59.759Z'
+                - id: 679d2ddb5196117ad04d1ffc
+                  siteId: 679826b3b20b045e176bc4b5
+                  pageId: 679826b3b20b045e176bc4bc
+                  localeId: 67993753d910db250db64b3e
+                  itemId: 580e64008c9a982ac9b8b754
+                  breakpoint: main
+                  url: >-
+                    https://webflow.com/design/site-slug-4ec832?workflow=comment&commentId=679d2ddb5196117ad04d1ff8&pageId=679826b3b20b045e176bc4bc
+                  content: >-
+                    You have five minutes left to drink it
+                    [[6287ec36a841b25637c663df]] 
+                  isResolved: false
+                  author:
+                    userId: 6287ec36a841b25637c663df
+                    email: ford.prefect@heartofgold.spaceship
+                    name: Ford Prefect
+                  mentionedUsers:
+                    - userId: 6287ec36a841b25637c663df
+                      email: arthur.dent@heartofgold.spaceship
+                      name: Arthur Dent
+                  createdOn: '2025-01-31T20:08:59.759Z'
+                  lastUpdated: '2025-01-31T20:08:59.759Z'
+              pagination:
+                limit: 2
+                offset: 0
+                total: 2
+    get-comment-thread:
+      path: /sites/{site_id}/comments/{comment_thread_id}
+      method: GET
+      auth: true
+      docs: |
+        Get details of a specific comment thread.
+
+          <Note title="Timing of comment threads">
+            There may be a delay of up to 5 minutes before new comments appear in the system.
+          </Note>
+
+        Required scope | `comments:read`
+      source:
+        openapi: ../../../openapi/referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+        comment_thread_id:
+          type: string
+          docs: Unique identifier for a Comment Thread
+      display-name: Get Comment Thread
+      request:
+        name: CommentsGetCommentThreadRequest
+        query-parameters:
+          localeId:
+            type: optional<string>
+            docs: >-
+              Unique identifier for a specific locale. Applicable, when using
+              localization.
+          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)'
+          sortBy:
+            type: optional<CommentsGetCommentThreadRequestSortBy>
+            docs: >-
+              Sort results by the provided value. Only allowed when sortOrder is
+              provided.
+          sortOrder:
+            type: optional<CommentsGetCommentThreadRequestSortOrder>
+            docs: Sorts the results by asc or desc
+      response:
+        docs: Request was successful
+        type: root.CommentThread
+        status-code: 200
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+            comment_thread_id: 580e63e98c9a982ac9b8b741
+          query-parameters:
+            localeId: 65427cf400e02b306eaa04a0
+          response:
+            body:
+              id: 580e64008c9a982ac9b8b754
+              siteId: 580e64008c9a982ac9b8b754
+              pageId: 580e64008c9a982ac9b8b754
+              localeId: 580e64008c9a982ac9b8b754
+              itemId: 580e64008c9a982ac9b8b754
+              breakpoint: main
+              url: >-
+                https://webflow.com/design/site-slug-4ec832?workflow=comment&commentId=679d2ddb5196117ad04d1ff8&pageId=679826b3b20b045e176bc4bc
+              content: This is a comment reply
+              isResolved: true
+              author:
+                userId: userId
+                email: email
+                name: name
+              mentionedUsers:
+                - userId: 6287ec36a841b25637c663df
+                  email: arthur.dent@heartofgold.spaceship
+                  name: Arthur Dent
+              createdOn: '2023-03-17T18:47:35.560Z'
+              lastUpdated: '2023-03-17T18:47:35.560Z'
+    list-comment-replies:
+      path: /sites/{site_id}/comments/{comment_thread_id}/replies
+      method: GET
+      auth: true
+      docs: |
+        List all replies to a specific comment thread.
+
+        <Note title="Timing of comment threads">
+          There may be a delay of up to 5 minutes before new comments appear in the system.
+        </Note>
+
+        Required scope | `comments:read`
+      source:
+        openapi: ../../../openapi/referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+        comment_thread_id:
+          type: string
+          docs: Unique identifier for a Comment Thread
+      display-name: List Comment Replies
+      request:
+        name: CommentsListCommentRepliesRequest
+        query-parameters:
+          localeId:
+            type: optional<string>
+            docs: >-
+              Unique identifier for a specific locale. Applicable, when using
+              localization.
+          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)'
+          sortBy:
+            type: optional<CommentsListCommentRepliesRequestSortBy>
+            docs: >-
+              Sort results by the provided value. Only allowed when sortOrder is
+              provided.
+          sortOrder:
+            type: optional<CommentsListCommentRepliesRequestSortOrder>
+            docs: Sorts the results by asc or desc
+      response:
+        docs: Request was successful
+        type: root.CommentReplyList
+        status-code: 200
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+            comment_thread_id: 580e63e98c9a982ac9b8b741
+          query-parameters:
+            localeId: 65427cf400e02b306eaa04a0
+          response:
+            body:
+              comments:
+                - id: 679d2ddb5196117ad04d1ffa
+                  commentId: 679d2ddb5196117ad04d1ff8
+                  siteId: 679826b3b20b045e176bc4b5
+                  pageId: 679826b3b20b045e176bc4bc
+                  localeId: 67993753d910db250db64b3e
+                  breakpoint: main
+                  content: >-
+                    This comment mentions another user
+                    [[6287ec36a841b25637c663df]] 
+                  isResolved: false
+                  author:
+                    id: id
+                    email: email
+                    name: name
+                  mentionedUsers:
+                    - id: id
+                      email: arthur.dent@example.com
+                      name: Arthur Dent
+                  lastUpdated: '2025-01-31T20:08:59.759Z'
+                  createdOn: '2025-01-31T20:08:59.759Z'
+              pagination:
+                limit: 2
+                offset: 0
+                total: 1
+  source:
+    openapi: ../../../openapi/referenced-specs/v2.yml

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

@@ -9,7 +9,7 @@ service:
       method: GET
       auth: true
       docs: >
-        Fetch a list of all URL redirect rules configured for a specific site.
+        Fetch a list of all 301 redirect rules configured for a specific site.
 
 
         Use this endpoint to review, audit, or manage the redirection rules that
@@ -27,7 +27,7 @@ service:
         site_id:
           type: string
           docs: Unique identifier for a Site
-      display-name: Get URL redirects
+      display-name: Get 301 redirects
       response:
         docs: Request was successful
         type: root.Redirects
@@ -59,7 +59,7 @@ service:
       method: POST
       auth: true
       docs: >
-        Add a new URL redirection rule to a site.
+        Add a new 301 redirection rule to a site.
 
 
         This endpoint allows you to define a source path (`fromUrl`) and its
@@ -79,7 +79,7 @@ service:
         site_id:
           type: string
           docs: Unique identifier for a Site
-      display-name: Create a URL redirect
+      display-name: Create a 301 redirect
       request:
         body: root.Redirect
         content-type: application/json
@@ -110,7 +110,7 @@ service:
       method: DELETE
       auth: true
       docs: >
-        Remove a URL redirection rule from a site.
+        Remove a 301 redirection rule from a site.
 
 
         This is useful for cleaning up outdated or unnecessary redirects,
@@ -132,7 +132,7 @@ service:
         redirect_id:
           type: string
           docs: Unique identifier site rediect
-      display-name: Delete URL redirects
+      display-name: Delete 301 redirects
       response:
         docs: Request was successful
         type: root.Redirects
@@ -165,7 +165,7 @@ service:
       method: PATCH
       auth: true
       docs: >
-        Update a URL redirection rule from a site.
+        Update a 301 redirection rule from a site.
 
 
         <Warning title="Enterprise Only">This endpoint requires an Enterprise
@@ -182,7 +182,7 @@ service:
         redirect_id:
           type: string
           docs: Unique identifier site rediect
-      display-name: Update URL redirect
+      display-name: Update 301 redirect
       request:
         body: root.Redirect
         content-type: application/json