webflow-api 3.1.0 → 3.1.1

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

@@ -68,7 +68,7 @@ types:
       openapi: ../../../openapi/referenced-specs/v2.yml
   ItemsDeleteItemsLiveRequestItemsItem:
     properties:
-      itemId:
+      id:
         type: string
         docs: Unique identifier for the Item
       cmsLocaleIds:
@@ -166,10 +166,10 @@ service:
             docs: 'Maximum number of records to be returned (max limit: 100)'
           name:
             type: optional<string>
-            docs: The name of the item(s)
+            docs: Filter by the exact name of the item(s)
           slug:
             type: optional<string>
-            docs: The slug of the item
+            docs: Filter by the exact slug of the item
           sortBy:
             type: optional<ItemsListItemsRequestSortBy>
             docs: Sort results by the provided value
@@ -179,6 +179,7 @@ service:
       response:
         docs: Request was successful
         type: root.CollectionItemList
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -246,6 +247,7 @@ service:
       response:
         docs: Request was successful
         type: root.CollectionItem
+        status-code: 202
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -322,8 +324,8 @@ service:
         Delete Items from a Collection.
 
 
-        **Note:** If the `cmsLocaleId` parameter is undefined or empty and the
-        items are localized, items will be deleted only in the primary locale.
+        <Tip title="Localization Tip">Items will only be deleted in the primary
+        locale unless a `cmsLocaleId` is included in the request.</Tip>
 
 
         Required scope | `CMS:write`
@@ -356,11 +358,14 @@ service:
       method: PATCH
       auth: true
       docs: >
-        Update a single item or multiple items (up to 100) in a Collection.
+        Update a single item or multiple items in a Collection.
+
 
+        The limit for this endpoint is 100 items.
 
-        **Note:** If the `cmsLocaleId` parameter is undefined or empty and the
-        items are localized, items will be updated only in the primary locale.
+
+        <Tip title="Localization Tip">Items will only be updated in the primary
+        locale, unless a `cmsLocaleId` is included in the request.</Tip>
 
 
         Required scope | `CMS:write`
@@ -380,6 +385,7 @@ service:
       response:
         docs: Request was successful
         type: root.CollectionItem
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -560,7 +566,7 @@ service:
       method: GET
       auth: true
       docs: |
-        List of all live Items within a Collection.
+        List all published items in a collection.
 
         Required scope | `CMS:read`
       source:
@@ -590,10 +596,10 @@ service:
             docs: 'Maximum number of records to be returned (max limit: 100)'
           name:
             type: optional<string>
-            docs: The name of the item(s)
+            docs: Filter by the exact name of the item(s)
           slug:
             type: optional<string>
-            docs: The slug of the item
+            docs: Filter by the exact slug of the item
           sortBy:
             type: optional<ItemsListItemsLiveRequestSortBy>
             docs: Sort results by the provided value
@@ -603,6 +609,7 @@ service:
       response:
         docs: Request was successful
         type: root.CollectionItemList
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -648,8 +655,8 @@ service:
       method: POST
       auth: true
       docs: >
-        Create live Item(s) in a Collection. The Item(s) will be published to
-        the live site.
+        Create item(s) in a collection that will be immediately published to the
+        live site.
 
 
 
@@ -672,6 +679,7 @@ service:
       response:
         docs: Request was successful
         type: root.CollectionItem
+        status-code: 202
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -683,6 +691,9 @@ service:
           path-parameters:
             collection_id: 580e63fc8c9a982ac9b8b745
           request:
+            lastPublished: '2023-03-17T18:47:35.560Z'
+            lastUpdated: '2023-03-17T18:47:35.560Z'
+            createdOn: '2023-03-17T18:47:35.560Z'
             isArchived: false
             isDraft: false
             fieldData:
@@ -711,14 +722,20 @@ service:
             collection_id: 580e63fc8c9a982ac9b8b745
           request:
             items:
-              - isArchived: false
+              - lastPublished: '2023-03-17T18:47:35.560Z'
+                lastUpdated: '2023-03-17T18:47:35.560Z'
+                createdOn: '2023-03-17T18:47:35.560Z'
+                isArchived: false
                 isDraft: false
                 fieldData:
                   name: Senior Data Analyst
                   slug: senior-data-analyst
                   url: https://boards.greenhouse.io/webflow/jobs/26567701
                   department: Data
-              - isArchived: false
+              - lastPublished: '2023-03-17T18:47:35.560Z'
+                lastUpdated: '2023-03-17T18:47:35.560Z'
+                createdOn: '2023-03-17T18:47:35.560Z'
+                isArchived: false
                 isDraft: false
                 fieldData:
                   name: Product Manager
@@ -746,13 +763,15 @@ service:
       auth: true
       docs: >
         Remove an item or multiple items (up to 100 items) from the live site.
-        Deleting published items will unpublish the items from the live site and
-        set them to draft. 
 
 
-        **Note:** If the `cmsLocaleId` parameter is undefined or empty and the
-        items are localized, items will be unpublished only in the primary
-        locale.
+        Using this endpoint to delete published item(s) will unpublish the
+        item(s) from the live site and set the item(s) `isDraft` property to
+        `true`. 
+
+
+        <Tip title="Localization Tip">Items will only be unpublished in the
+        primary locale unless a `cmsLocaleId` is included in the request.</Tip>
 
 
         Required scope | `CMS:write`
@@ -784,12 +803,12 @@ service:
       method: PATCH
       auth: true
       docs: >
-        Update a single live item or multiple live items (up to 100) in a
-        Collection
+        Update a single published item or multiple published items (up to 100)
+        in a Collection
 
 
-        **Note:** If the `cmsLocaleId` parameter is undefined or empty and the
-        items are localized, items will be updated only in the primary locale. 
+        <Tip title="Localization Tip">Items will only be updated in the primary
+        locale, unless a `cmsLocaleId` is included in the request.</Tip>
 
 
         Required scope | `CMS:write`
@@ -809,10 +828,12 @@ service:
       response:
         docs: Request was successful
         type: root.CollectionItemListNoPagination
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
         - root.NotFoundError
+        - root.ConflictError
         - root.TooManyRequestsError
         - root.InternalServerError
       examples:
@@ -1101,9 +1122,11 @@ service:
         corresponding locales.
 
 
-        **Notes:**
+        <Note>
           - This endpoint can create up to 100 items in a request.
-          - If the `cmsLocaleIds` parameter is undefined or empty and localization is enabled, items will only be created in the primary locale.
+          - If the `cmsLocaleIds` parameter is not included in the request, an item will only be created in the primary locale.
+        </Note>
+
 
         Required scope | `CMS:write`
       source:
@@ -1135,6 +1158,7 @@ service:
       response:
         docs: Request was successful
         type: root.BulkCollectionItem
+        status-code: 202
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -1298,6 +1322,7 @@ service:
       response:
         docs: Request was successful
         type: root.CollectionItem
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -1327,10 +1352,8 @@ service:
       path: /collections/{collection_id}/items/{item_id}
       method: DELETE
       auth: true
-      docs: >
-        Delete an Item from a Collection. This endpoint does not currently
-        support bulk deletion.
-
+      docs: |
+        Delete an item from a collection. 
 
         Required scope | `CMS:write`
       source:
@@ -1387,6 +1410,7 @@ service:
       response:
         docs: Request was successful
         type: root.CollectionItem
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -1452,6 +1476,7 @@ service:
       response:
         docs: Request was successful
         type: root.CollectionItem
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -1546,10 +1571,12 @@ service:
       response:
         docs: Request was successful
         type: root.CollectionItem
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
         - root.NotFoundError
+        - root.ConflictError
         - root.TooManyRequestsError
         - root.InternalServerError
       examples:
@@ -1604,6 +1631,7 @@ service:
       response:
         docs: Request was successful
         type: ItemsPublishItemResponse
+        status-code: 202
       errors:
         - root.BadRequestError
         - root.UnauthorizedError

package/.mock/definition/collections.yml

@@ -22,6 +22,7 @@ service:
       response:
         docs: Request was successful
         type: root.CollectionList
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -80,14 +81,19 @@ service:
             slug:
               type: optional<string>
               docs: Part of a URL that identifier
+            fields:
+              type: optional<list<root.FieldCreate>>
+              docs: An array of custom fields to add to the collection
         content-type: application/json
       response:
         docs: Request was successful
         type: root.Collection
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
         - root.NotFoundError
+        - root.ConflictError
         - root.TooManyRequestsError
         - root.InternalServerError
       examples:
@@ -97,22 +103,51 @@ service:
             displayName: Blog Posts
             singularName: Blog Post
             slug: posts
+            fields:
+              - isRequired: true
+                type: PlainText
+                displayName: Title
+                helpText: The title of the blog post
+              - isRequired: true
+                type: RichText
+                displayName: Content
+                helpText: The content of the blog post
+              - isRequired: true
+                type: Reference
+                displayName: Author
+                helpText: The author of the blog post
+                metadata:
+                  collectionId: 23cc2d952d4e4631ffd4345d2743db4e
           response:
             body:
-              id: 580e63fc8c9a982ac9b8b745
+              id: 562ac0395358780a1f5e6fbd
               displayName: Blog Posts
               singularName: Blog Post
-              slug: post
+              slug: posts
               createdOn: '2016-10-24T19:41:48Z'
               lastUpdated: '2016-10-24T19:42:38Z'
               fields:
-                - id: 23cc2d952d4e4631ffd4345d2743db4e
+                - id: id
                   isRequired: true
                   isEditable: true
                   type: PlainText
-                  slug: name
-                  displayName: Name
-                  helpText: helpText
+                  slug: title
+                  displayName: Title
+                  helpText: The title of the blog post
+                - id: id
+                  isRequired: true
+                  isEditable: true
+                  type: RichText
+                  slug: content
+                  displayName: Content
+                  helpText: The content of the blog post
+                - id: id
+                  isRequired: true
+                  isEditable: true
+                  type: Reference
+                  slug: author
+                  displayName: Author
+                  helpText: The author of the blog post
     get:
       path: /collections/{collection_id}
       method: GET
@@ -131,6 +166,7 @@ service:
       response:
         docs: Request was successful
         type: root.Collection
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -155,7 +191,6 @@ service:
                   type: PlainText
                   slug: name
                   displayName: Name
-                  helpText: helpText
     delete:
       path: /collections/{collection_id}
       method: DELETE

package/.mock/definition/components.yml

@@ -33,6 +33,7 @@ service:
       response:
         docs: Request was successful
         type: root.ComponentList
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -59,13 +60,9 @@ 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
@@ -120,6 +117,7 @@ service:
       response:
         docs: Request was successful
         type: root.ComponentDom
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -137,33 +135,26 @@ service:
             body:
               componentId: 69118560-d0bc-15fc-bbf8-b8fe5f6535b5
               nodes:
-                - type: component-instance
-                  id: a245c12d-995b-55ee-5ec7-aa36a6cad623
-                  componentId: nodes
-                  propertyOverrides:
-                    - propertyId: 7dd14c08-2e96-8d3d-2b19-b5c03642a0f0
-                - type: component-instance
-                  id: a245c12d-995b-55ee-5ec7-aa36a6cad627
-                  componentId: nodes
+                - id: id
+                  text: {}
+                  attributes:
+                    key: value
+                  type: text
+                - id: id
+                  text: {}
+                  attributes:
+                    key: value
+                  type: text
+                - id: id
+                  image: {}
+                  attributes:
+                    key: value
+                  type: image
+                - id: id
+                  componentId: componentId
                   propertyOverrides:
                     - propertyId: 7dd14c08-2e96-8d3d-2b19-b5c03642a0f0
-                - type: component-instance
-                  id: a245c12d-995b-55ee-5ec7-aa36a6cad629
-                  componentId: nodes
-                  propertyOverrides:
-                    - propertyId: 7dd14c08-2e96-8d3d-2b19-b5c03642a0f0
-                - type: component-instance
-                  id: a245c12d-995b-55ee-5ec7-aa36a6cad631
-                  componentId: 6258612d1ee792848f805dcf
-                  propertyOverrides:
-                    - propertyId: a245c12d-995b-55ee-5ec7-aa36a6cad633
-                      type: Plain Text
-                      text:
-                        text: Don't Panic!
-                    - propertyId: a245c12d-995b-55ee-5ec7-aa36a6cad635
-                      type: Rich Text
-                      text:
-                        html: <div><p>Always know where your towel is.</p></div>
+                  type: component-instance
               pagination:
                 limit: 4
                 offset: 0
@@ -178,21 +169,21 @@ service:
             body:
               componentId: 69118560-d0bc-15fc-bbf8-b8fe5f6535b5
               nodes:
-                - type: component-instance
-                  id: 69118560-d0bc-15fc-bbf8-b8fe5f6535b8
-                  componentId: nodes
+                - id: id
+                  image: {}
+                  attributes:
+                    key: value
+                  type: image
+                - id: id
+                  text: {}
+                  attributes:
+                    key: value
+                  type: text
+                - id: id
+                  componentId: componentId
                   propertyOverrides:
                     - propertyId: 7dd14c08-2e96-8d3d-2b19-b5c03642a0f0
-                - type: component-instance
-                  id: 8ebfb409-7493-3bca-5d48-0e547befb960
-                  componentId: nodes
-                  propertyOverrides:
-                    - propertyId: 7dd14c08-2e96-8d3d-2b19-b5c03642a0f0
-                - type: component-instance
-                  id: 69118560-d0bc-15fc-bbf8-b8fe5f6535c2
-                  componentId: 69118560-d0bc-15fc-bbf8-b8fe5f6535b5
-                  propertyOverrides:
-                    - propertyId: a245c12d-995b-55ee-5ec7-aa36a6cad623
+                  type: component-instance
               pagination:
                 limit: 100
                 offset: 0
@@ -255,6 +246,7 @@ service:
       response:
         docs: Request was successful
         type: ComponentsUpdateContentResponse
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -291,10 +283,10 @@ service:
       method: GET
       auth: true
       docs: >
-        Get the property default values of a component definition.
+        Get the default property values of a component definition.
 
 
-        <Note>If you do not provide a Locale ID in your request, the response
+        <Note>If you do not include a `localeId` in your request, the response
         will return any properties that can be localized from the Primary
         locale.</Note>
 
@@ -329,6 +321,7 @@ service:
       response:
         docs: Request was successful
         type: root.ComponentProperties
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -366,18 +359,17 @@ service:
       method: POST
       auth: true
       docs: >
-        Update the property default values of a component definition in a
+        Update the default property values of a component definition in a
         specificed locale.
 
 
-        Before making updates:
-
-        1. Use the [get component
+        Before making updates, use the [get component
         properties](/data/reference/pages-and-components/components/get-properties)
-        endpoint to identify available properties
+        endpoint to identify properties that can be updated in a secondary
+        locale.
 
 
-        <Note>The request requires a secondary locale ID. If a locale is
+        <Note>The request requires a secondary locale ID. If a `localeId` is
         missing, the request will not be processed and will result in an
         error.</Note>
 
@@ -412,6 +404,7 @@ service:
       response:
         docs: Request was successful
         type: ComponentsUpdatePropertiesResponse
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError

package/.mock/definition/ecommerce.yml

@@ -22,6 +22,7 @@ service:
       response:
         docs: Request was successful
         type: root.EcommerceSettings
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError