webflow-api 3.3.0-beta → 3.3.1

package/.mock/definition/forms.yml

@@ -1,399 +0,0 @@
-imports:
-  root: __package__.yml
-service:
-  auth: false
-  base-path: ''
-  endpoints:
-    list:
-      path: /sites/{site_id}/forms
-      method: GET
-      auth:
-        - OAuth2:
-            - forms:read
-      docs: |
-        List forms for a given site.
-
-        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 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
-        status-code: 200
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.ForbiddenError
-        - root.NotFoundError
-        - root.ConflictError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            site_id: 580e63e98c9a982ac9b8b741
-          query-parameters:
-            limit: 1.1
-            offset: 1.1
-          response:
-            body:
-              forms:
-                - displayName: Email Form
-                  createdOn: '2016-10-24T19:41:29Z'
-                  lastUpdated: '2016-10-24T19:43:17Z'
-                  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
-                  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
-                      placeholder: Enter your email
-                      userVisible: true
-                  responseSettings:
-                    redirectUrl: https://example.com
-                    redirectMethod: GET
-                    redirectAction: POST https://example.com
-                    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:
-        - OAuth2:
-            - forms:read
-      docs: |
-        Get information about a given form.
-
-        Required scope | `forms:read`
-      source:
-        openapi: ../../../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
-        status-code: 200
-      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:
-        - OAuth2:
-            - forms:read
-      docs: |
-        List form submissions for a given form
-
-        <Note title="Forms in components">
-          When a form is used in a component definition, each instance of the form is considered a unique form.
-          
-          To get a combined list of submissions for a form that appears across multiple component instances, use the [List Form Submissions by Site](/data/reference/forms/form-submissions/list-submissions-by-site) endpoint.
-        </Note>
-
-        Required scope | `forms:read`
-      source:
-        openapi: ../../../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
-        status-code: 200
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.ForbiddenError
-        - root.NotFoundError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            form_id: 580e63e98c9a982ac9b8b741
-          query-parameters:
-            offset: 1.1
-            limit: 1.1
-          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:
-        - OAuth2:
-            - forms:read
-      docs: |
-        Get information about a given form submissio.
-
-        Required scope | `forms:read`
-      source:
-        openapi: ../../../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
-        status-code: 200
-      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
-    delete-submission:
-      path: /form_submissions/{form_submission_id}
-      method: DELETE
-      auth:
-        - OAuth2:
-            - forms:write
-      docs: |
-        Delete a form submission
-
-
-        Required scope | `forms:write`
-      source:
-        openapi: ../../../openapi/referenced-specs/v2.yml
-      path-parameters:
-        form_submission_id:
-          type: string
-          docs: Unique identifier for a Form Submission
-      display-name: Delete Form Submission
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.ForbiddenError
-        - root.NotFoundError
-        - root.ConflictError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            form_submission_id: 580e63e98c9a982ac9b8b741
-    update-submission:
-      path: /form_submissions/{form_submission_id}
-      method: PATCH
-      auth:
-        - OAuth2:
-            - forms:write
-      docs: |
-        Update hidden fields on a form submission
-
-        Required scope | `forms:write`
-      source:
-        openapi: ../../../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
-        status-code: 200
-      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: ../../../openapi/referenced-specs/v2.yml
-  display-name: Forms
-docs: Forms are forms that are created on your Webflow site.
-webhooks:
-  form_submission:
-    audiences: []
-    method: POST
-    display-name: Form Submission
-    headers: {}
-    payload: root.FormSubmissionTrigger
-    examples:
-      - payload:
-          triggerType: form_submission
-          payload:
-            name: Contact Us
-            siteId: 65427cf400e02b306eaa049c
-            data:
-              First Name: Zaphod
-              Last Name: Beeblebrox
-              email: zaphod@heartofgold.ai
-              Phone Number: 15550000000
-            schema:
-              - fieldName: First Name
-                fieldType: FormTextInput
-                fieldElementId: 285042f7-d554-dc7f-102c-aa10d6a2d2c4
-              - fieldName: Last Name
-                fieldType: FormTextInput
-                fieldElementId: 285042f7-d554-dc7f-102c-aa10d6a2d2c5
-              - fieldName: email
-                fieldType: FormTextInput
-                fieldElementId: 285042f7-d554-dc7f-102c-aa10d6a2d2c6
-              - fieldName: Phone Number
-                fieldType: FormTextInput
-                fieldElementId: 285042f7-d554-dc7f-102c-aa10d6a2d2c7
-            submittedAt: '2022-09-14T12:35:16.117Z'
-            id: 6321ca84df3949bfc6752327
-            formId: 65429eadebe8a9f3a30f62d0
-            formElementId: 4e038d2c-6a1e-4953-7be9-a59a2b453177
-    docs: Information about a form that was subitted

package/.mock/definition/inventory.yml

@@ -1,152 +0,0 @@
-imports:
-  root: __package__.yml
-service:
-  auth: false
-  base-path: ''
-  endpoints:
-    list:
-      path: /collections/{sku_collection_id}/items/{sku_id}/inventory
-      method: GET
-      auth:
-        - OAuth2:
-            - ecommerce:read
-      docs: |
-        List the current inventory levels for a particular SKU item.
-
-        Required scope | `ecommerce:read`
-      source:
-        openapi: ../../../openapi/referenced-specs/v2.yml
-      path-parameters:
-        sku_collection_id:
-          type: string
-          docs: >-
-            Unique identifier for a SKU collection. Use the List Collections API
-            to find this ID.
-        sku_id:
-          type: string
-          docs: Unique identifier for a SKU
-      display-name: List Inventory
-      response:
-        docs: Request was successful
-        type: root.InventoryItem
-        status-code: 200
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.ForbiddenError
-        - root.NotFoundError
-        - root.ConflictError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            sku_collection_id: 6377a7c4b7a79608c34a46f7
-            sku_id: 5e8518516e147040726cc415
-          response:
-            body:
-              id: 5bfedb42bab0ad90fa7dad39
-              quantity: 100
-              inventoryType: finite
-    update:
-      path: /collections/{sku_collection_id}/items/{sku_id}/inventory
-      method: PATCH
-      auth:
-        - OAuth2:
-            - ecommerce:write
-      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: ../../../openapi/referenced-specs/v2.yml
-      path-parameters:
-        sku_collection_id:
-          type: string
-          docs: >-
-            Unique identifier for a SKU collection. Use the List Collections API
-            to find this ID.
-        sku_id:
-          type: string
-          docs: Unique identifier for a SKU
-      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
-        status-code: 200
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.ForbiddenError
-        - root.NotFoundError
-        - root.ConflictError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            sku_collection_id: 6377a7c4b7a79608c34a46f7
-            sku_id: 5e8518516e147040726cc415
-          request:
-            inventoryType: infinite
-          response:
-            body:
-              id: 5bfedb42bab0ad90fa7dad39
-              quantity: 100
-              inventoryType: finite
-  source:
-    openapi: ../../../openapi/referenced-specs/v2.yml
-  display-name: Inventory
-docs: Inventory is the stock of e-commerce items in your Webflow site.
-types:
-  InventoryUpdateRequestInventoryType:
-    enum:
-      - infinite
-      - finite
-    docs: infinite or finite
-    inline: true
-    source:
-      openapi: ../../../openapi/referenced-specs/v2.yml
-  EcommInventoryChangedPayload:
-    properties:
-      triggerType: optional<literal<"ecomm_inventory_changed">>
-      payload: optional<root.InventoryItem>
-    source:
-      openapi: ../../../openapi/referenced-specs/v2.yml
-webhooks:
-  ecomm_inventory_changed:
-    audiences: []
-    method: POST
-    display-name: Updated eComm Inventory
-    headers: {}
-    payload: EcommInventoryChangedPayload
-    examples:
-      - name: WebhookInventoryChanged
-        payload:
-          triggerType: ecomm_inventory_changed
-          payload:
-            \$ref: ./schemas/inventory.yml#/InventoryItem/example
-    docs: Information about updated ecommerce inventory values

package/.mock/definition/items.yml

@@ -1,112 +0,0 @@
-imports:
-  root: __package__.yml
-webhooks:
-  collection_item_created:
-    audiences: []
-    method: POST
-    display-name: Collection Item Created
-    headers: {}
-    payload: root.CollectionItemCreated
-    examples:
-      - payload:
-          triggerType: collection_item_created
-          payload:
-            id: 580e64008c9a982ac9b8b754
-            workspaceId: 625860a7a6c16d624927122f
-            siteId: 65427cf400e02b306eaa049c
-            collectionId: 664243617fcc8b464b23c4ee
-            lastPublished: '2023-03-17T18:47:35Z'
-            lastUpdated: '2023-03-17T18:47:35Z'
-            createdOn: '2023-03-17T18:47:35Z'
-            isArchived: false
-            isDraft: false
-            fieldData:
-              name: Pan-Galactic Gargle Blaster
-              slug: pan-galactic-gargle-blaster
-    docs: Information about a new collection item
-  collection_item_changed:
-    audiences: []
-    method: POST
-    display-name: Collection Item Updated
-    headers: {}
-    payload: root.CollectionItemChanged
-    examples:
-      - payload:
-          triggerType: collection_item_changed
-          payload:
-            id: id
-            workspaceId: workspaceId
-            siteId: siteId
-            collectionId: collectionId
-            fieldData:
-              name: name
-              slug: slug
-    docs: Information about an updated collection item
-  collection_item_deleted:
-    audiences: []
-    method: POST
-    display-name: Collection Item Deleted
-    headers: {}
-    payload: root.CollectionItemRemoved
-    examples:
-      - payload:
-          triggerType: collection_item_deleted
-          payload:
-            id: 66424365e972c886137a1cf1
-            siteId: 65427cf400e02b306eaa049c
-            workspaceId: 625860a7a6c16d624927122f
-            collectionId: 664243617fcc8b464b23c4ee
-            cmsLocaleId: 681442a144bb80bd00480fda
-            lastUpdated: '2025-05-28T04:44:33Z'
-            createdOn: '2025-05-28T04:27:12Z'
-            isArchived: false
-            isDraft: false
-            fieldData:
-              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
-    display-name: Collection Item Unpublished
-    headers: {}
-    payload: root.CollectionItemUnpublished
-    examples:
-      - payload:
-          triggerType: collection_item_unpublished
-          payload:
-            id: 66424365e972c886137a1cf1
-            siteId: 65427cf400e02b306eaa049c
-            workspaceId: 625860a7a6c16d624927122f
-            collectionId: 664243617fcc8b464b23c4ee
-            cmsLocaleId: 681442a144bb80bd00480fda
-            lastUpdated: '2025-05-28T04:44:33Z'
-            createdOn: '2025-05-28T04:27:12Z'
-            isArchived: false
-            isDraft: false
-            fieldData:
-              name: Anna Gunn
-              slug: anna-gunn
-              _locale: 681442a144bb80bd00480fda
-              _noSearch: false
-    docs: Information about a collection item that was removed from the live site