webflow-api 2.4.0 → 2.5.0

package/.mock/definition/collections.yml

@@ -0,0 +1,185 @@
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    list:
+      path: /sites/{site_id}/collections
+      method: GET
+      auth: true
+      docs: |
+        List of all Collections within a Site.
+
+        Required scope | `cms:read`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+      display-name: List Collections
+      response:
+        docs: Request was successful
+        type: root.CollectionList
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          response:
+            body:
+              collections:
+                - id: 63692ab61fb2852f582ba8f5
+                  displayName: Products
+                  singularName: Product
+                  slug: product
+                  createdOn: '2019-06-12T13:35:14Z'
+                  lastUpdated: '2022-11-17T15:08:50Z'
+                - id: 63692ab61fb2856e6a2ba8f6
+                  displayName: Categories
+                  singularName: Category
+                  slug: category
+                  createdOn: '2019-06-12T13:35:14Z'
+                  lastUpdated: '2022-11-17T15:08:50Z'
+                - id: 63692ab61fb285a8562ba8f4
+                  displayName: SKUs
+                  singularName: SKU
+                  slug: sku
+                  createdOn: '2019-06-12T13:35:14Z'
+                  lastUpdated: '2022-11-17T15:08:50Z'
+    create:
+      path: /sites/{site_id}/collections
+      method: POST
+      auth: true
+      docs: |
+        Create a Collection for a site.
+
+        Required scope | `cms:write`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+      display-name: Create Collection
+      request:
+        name: CollectionsCreateRequest
+        body:
+          properties:
+            displayName:
+              type: string
+              docs: Name of the collection. Each collection name must be distinct.
+            singularName:
+              type: string
+              docs: Singular name of each item.
+            slug:
+              type: optional<string>
+              docs: Part of a URL that identifier
+        content-type: application/json
+      response:
+        docs: Request was successful
+        type: root.Collection
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          request:
+            displayName: Blog Posts
+            singularName: Blog Post
+            slug: posts
+          response:
+            body:
+              id: 580e63fc8c9a982ac9b8b745
+              displayName: Blog Posts
+              singularName: Blog Post
+              slug: post
+              createdOn: '2016-10-24T19:41:48Z'
+              lastUpdated: '2016-10-24T19:42:38Z'
+              fields:
+                - id: 23cc2d952d4e4631ffd4345d2743db4e
+                  isRequired: true
+                  isEditable: true
+                  type: PlainText
+                  slug: name
+                  displayName: Name
+                  helpText: helpText
+    get:
+      path: /collections/{collection_id}
+      method: GET
+      auth: true
+      docs: |
+        Get the full details of a collection from its ID.
+
+        Required scope | `cms:read`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        collection_id:
+          type: string
+          docs: Unique identifier for a Collection
+      display-name: Get Collection Details
+      response:
+        docs: Request was successful
+        type: root.Collection
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            collection_id: 580e63fc8c9a982ac9b8b745
+          response:
+            body:
+              id: 580e63fc8c9a982ac9b8b745
+              displayName: Blog Posts
+              singularName: Blog Post
+              slug: post
+              createdOn: '2016-10-24T19:41:48Z'
+              lastUpdated: '2016-10-24T19:42:38Z'
+              fields:
+                - id: 23cc2d952d4e4631ffd4345d2743db4e
+                  isRequired: true
+                  isEditable: true
+                  type: PlainText
+                  slug: name
+                  displayName: Name
+                  helpText: helpText
+    delete:
+      path: /collections/{collection_id}
+      method: DELETE
+      auth: true
+      docs: |
+        Delete a collection using its ID.
+
+        Required scope | `cms:write`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        collection_id:
+          type: string
+          docs: Unique identifier for a Collection
+      display-name: Delete Collection
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            collection_id: 580e63fc8c9a982ac9b8b745
+  source:
+    openapi: ../../../referenced-specs/v2.yml
+  display-name: Collections

package/.mock/definition/ecommerce.yml

@@ -0,0 +1,42 @@
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    get-settings:
+      path: /sites/{site_id}/ecommerce/settings
+      method: GET
+      auth: true
+      docs: |
+        Retrieve ecommerce settings for a site.
+
+        Required scope | `ecommerce:read`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+      display-name: Get Ecommerce Settings
+      response:
+        docs: Request was successful
+        type: root.EcommerceSettings
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.ForbiddenError
+        - root.NotFoundError
+        - root.ConflictError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          response:
+            body:
+              siteId: 5eb0b5583bf24e2d3a488969
+              createdOn: '2018-10-04T15:21:02Z'
+              defaultCurrency: USD
+  source:
+    openapi: ../../../referenced-specs/v2.yml

package/.mock/definition/forms.yml

@@ -0,0 +1,301 @@
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    list:
+      path: /sites/{site_id}/forms
+      method: GET
+      auth: true
+      docs: |
+        List forms for a given site.
+
+        Required scope | `forms:read`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+      display-name: List Forms
+      request:
+        name: FormsListRequest
+        query-parameters:
+          limit:
+            type: optional<double>
+            docs: 'Maximum number of records to be returned (max limit: 100)'
+          offset:
+            type: optional<double>
+            docs: >-
+              Offset used for pagination if the results have more than limit
+              records
+      response:
+        docs: Request was successful
+        type: root.FormList
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.ForbiddenError
+        - root.NotFoundError
+        - root.ConflictError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          response:
+            body:
+              forms:
+                - displayName: Email Form
+                  createdOn: '2016-10-24T19:41:29Z'
+                  lastUpdated: '2016-10-24T19:43:17Z'
+                  fields:
+                    '0':
+                      displayName: Email
+                      userVisible: true
+                    '1':
+                      displayName: Email
+                      userVisible: true
+                  responseSettings:
+                    redirectUrl: https://example.com
+                    redirectMethod: GET
+                    sendEmailConfirmation: true
+                  id: 589a331aa51e760df7ccb89e
+                  siteId: 580e63e98c9a982ac9b8b741
+                  siteDomainId: 6419db964a9c436a4baf6248
+                  pageId: 6419db964a9c43f6a3af6348
+                  pageName: Home
+                  formElementId: 4e038d2c-6a1e-4953-7be9-a59a2b453177
+                  workspaceId: 580e63fc8c9a982ac9b8b744
+                - displayName: Name Form
+                  createdOn: '2016-10-24T19:41:29Z'
+                  lastUpdated: '2016-10-24T19:43:17Z'
+                  fields:
+                    '0':
+                      displayName: Email
+                      userVisible: true
+                  responseSettings:
+                    redirectUrl: https://example.com
+                    redirectMethod: GET
+                    sendEmailConfirmation: false
+                  id: 580ff8d7ba3e45ba9fe588e9
+                  siteId: 580e63e98c9a982ac9b8b741
+                  siteDomainId: 6419db964a9c436a4baf6248
+                  pageId: 6419db964a9c43f6a3af6348
+                  pageName: Home
+                  formElementId: 4e038d2c-6a1e-4953-7be9-a59a2b453177
+                  workspaceId: 580e63fc8c9a982ac9b8b744
+              pagination:
+                limit: 25
+                offset: 0
+                total: 2
+    get:
+      path: /forms/{form_id}
+      method: GET
+      auth: true
+      docs: |
+        Get information about a given form.
+
+        Required scope | `forms:read`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        form_id:
+          type: string
+          docs: Unique identifier for a Form
+      display-name: Get Form Schema
+      response:
+        docs: Request was successful
+        type: root.Form
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.ForbiddenError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            form_id: 580e63e98c9a982ac9b8b741
+          response:
+            body:
+              displayName: Email Form
+              createdOn: '2016-10-24T19:41:29Z'
+              lastUpdated: '2016-10-24T19:43:17Z'
+              fields:
+                660d5bcc9c0772150459dfb1:
+                  displayName: Name
+                  type: Plain
+                  placeholder: Enter your email
+                  userVisible: true
+                589a331aa51e760df7ccb89d:
+                  displayName: Email
+                  type: 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
+              siteDomainId: 6419db964a9c436a4baf6248
+              pageId: 6419db964a9c43f6a3af6348
+              pageName: Home
+              formElementId: 4e038d2c-6a1e-4953-7be9-a59a2b453177
+              workspaceId: 580e63fc8c9a982ac9b8b744
+    list-submissions:
+      path: /forms/{form_id}/submissions
+      method: GET
+      auth: true
+      docs: |
+        List form submissions for a given form
+
+        Required scope | `forms:read`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        form_id:
+          type: string
+          docs: Unique identifier for a Form
+      display-name: List Form Submissions
+      request:
+        name: FormsListSubmissionsRequest
+        query-parameters:
+          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
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.ForbiddenError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            form_id: 580e63e98c9a982ac9b8b741
+          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
+    get-submission:
+      path: /form_submissions/{form_submission_id}
+      method: GET
+      auth: true
+      docs: |
+        Get information about a given form submissio.
+
+        Required scope | `forms:read`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        form_submission_id:
+          type: string
+          docs: Unique identifier for a Form Submission
+      display-name: Get Form Submission
+      response:
+        docs: Request was successful
+        type: root.FormSubmission
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.ForbiddenError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            form_submission_id: 580e63e98c9a982ac9b8b741
+          response:
+            body:
+              id: 6321ca84df3949bfc6752327
+              displayName: Sample Form
+              siteId: 62749158efef318abc8d5a0f
+              workspaceId: 62749158efef318abc8d5a0f
+              dateSubmitted: '2022-09-14T12:35:16Z'
+              formResponse:
+                First Name: Arthur
+                Last Name: Dent
+    update-submission:
+      path: /form_submissions/{form_submission_id}
+      method: PATCH
+      auth: true
+      docs: |
+        Update hidden fields on a form submission
+
+        Required scope | `forms:write`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        form_submission_id:
+          type: string
+          docs: Unique identifier for a Form Submission
+      display-name: Modify Form Submission
+      request:
+        name: FormsUpdateSubmissionRequest
+        body:
+          properties:
+            formSubmissionData:
+              type: optional<map<string, unknown>>
+              docs: >-
+                An existing **hidden field** defined on the form schema, and the
+                corresponding value to set
+        content-type: application/json
+      response:
+        docs: Request was successful
+        type: root.FormSubmission
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.ForbiddenError
+        - root.NotFoundError
+        - root.ConflictError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            form_submission_id: 580e63e98c9a982ac9b8b741
+          request: {}
+          response:
+            body:
+              id: 6321ca84df3949bfc6752327
+              displayName: Sample Form
+              siteId: 62749158efef318abc8d5a0f
+              workspaceId: 62749158efef318abc8d5a0f
+              dateSubmitted: '2022-09-14T12:35:16Z'
+              formResponse:
+                First Name: Arthur
+                Last Name: Dent
+  source:
+    openapi: ../../../referenced-specs/v2.yml
+  display-name: Forms

package/.mock/definition/inventory.yml

@@ -0,0 +1,120 @@
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    list:
+      path: /collections/{collection_id}/items/{item_id}/inventory
+      method: GET
+      auth: true
+      docs: |
+        List the current inventory levels for a particular SKU item.
+
+        Required scope | `ecommerce:read`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        collection_id:
+          type: string
+          docs: Unique identifier for a Collection
+        item_id:
+          type: string
+          docs: Unique identifier for an Item
+      display-name: List Inventory
+      response:
+        docs: Request was successful
+        type: root.InventoryItem
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.ForbiddenError
+        - root.NotFoundError
+        - root.ConflictError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            collection_id: 580e63fc8c9a982ac9b8b745
+            item_id: 580e64008c9a982ac9b8b754
+          response:
+            body:
+              id: 5bfedb42bab0ad90fa7dad39
+              quantity: 100
+              inventoryType: infinite
+    update:
+      path: /collections/{collection_id}/items/{item_id}/inventory
+      method: PATCH
+      auth: true
+      docs: >
+        Updates the current inventory levels for a particular SKU item. 
+
+
+        Updates may be given in one or two methods, absolutely or
+        incrementally. 
+
+        - Absolute updates are done by setting `quantity` directly. 
+
+        - Incremental updates are by specifying the inventory delta in
+        `updateQuantity` which is then added to the `quantity` stored on the
+        server.
+
+
+        Required scope | `ecommerce:write`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        collection_id:
+          type: string
+          docs: Unique identifier for a Collection
+        item_id:
+          type: string
+          docs: Unique identifier for an Item
+      display-name: Update Item Inventory
+      request:
+        name: InventoryUpdateRequest
+        body:
+          properties:
+            inventoryType:
+              type: InventoryUpdateRequestInventoryType
+              docs: infinite or finite
+            updateQuantity:
+              type: optional<double>
+              docs: Adds this quantity to currently store quantity. Can be negative.
+            quantity:
+              type: optional<double>
+              docs: Immediately sets quantity to this value.
+        content-type: application/json
+      response:
+        docs: Request was successful
+        type: root.InventoryItem
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.ForbiddenError
+        - root.NotFoundError
+        - root.ConflictError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            collection_id: 580e63fc8c9a982ac9b8b745
+            item_id: 580e64008c9a982ac9b8b754
+          request:
+            inventoryType: infinite
+          response:
+            body:
+              id: 5bfedb42bab0ad90fa7dad39
+              quantity: 100
+              inventoryType: infinite
+  source:
+    openapi: ../../../referenced-specs/v2.yml
+  display-name: Inventory
+types:
+  InventoryUpdateRequestInventoryType:
+    enum:
+      - infinite
+      - finite
+    docs: infinite or finite
+    source:
+      openapi: ../../../referenced-specs/v2.yml