webflow-api 3.0.1 → 3.1.1

package/.mock/definition/forms.yml

@@ -13,7 +13,7 @@ service:
 
         Required scope | `forms:read`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -33,6 +33,7 @@ service:
       response:
         docs: Request was successful
         type: root.FormList
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -99,7 +100,7 @@ service:
 
         Required scope | `forms:read`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         form_id:
           type: string
@@ -108,6 +109,7 @@ service:
       response:
         docs: Request was successful
         type: root.Form
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -127,7 +129,6 @@ service:
                 660d5bcc9c0772150459dfb1:
                   displayName: Name
                   type: Plain
-                  placeholder: Enter your email
                   userVisible: true
                 589a331aa51e760df7ccb89d:
                   displayName: Email
@@ -137,7 +138,6 @@ service:
               responseSettings:
                 redirectUrl: https://example.com
                 redirectMethod: GET
-                redirectAction: POST https://example.com
                 sendEmailConfirmation: true
               id: 589a331aa51e760df7ccb89e
               siteId: 580e63e98c9a982ac9b8b741
@@ -153,9 +153,15 @@ service:
       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: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         form_id:
           type: string
@@ -175,6 +181,7 @@ service:
       response:
         docs: Request was successful
         type: root.FormSubmissionList
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -217,7 +224,7 @@ service:
 
         Required scope | `forms:read`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         form_submission_id:
           type: string
@@ -226,6 +233,7 @@ service:
       response:
         docs: Request was successful
         type: root.FormSubmission
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -246,6 +254,33 @@ service:
               formResponse:
                 First Name: Arthur
                 Last Name: Dent
+    delete-submission:
+      path: /form_submissions/{form_submission_id}
+      method: DELETE
+      auth: true
+      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
@@ -255,7 +290,7 @@ service:
 
         Required scope | `forms:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         form_submission_id:
           type: string
@@ -274,6 +309,7 @@ service:
       response:
         docs: Request was successful
         type: root.FormSubmission
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -296,6 +332,83 @@ service:
               formResponse:
                 First Name: Arthur
                 Last Name: Dent
+    list-submissions-by-site:
+      path: /sites/{site_id}/form_submissions
+      method: GET
+      auth: true
+      docs: >
+        List form submissions for a given site. This endpoint differs from the
+        existing [List Form Submissions
+        endpoint](/data/reference/forms/form-submissions/list-submissions) by
+        accepting `siteId` as a path parameter and `elementId` as a query
+        parameter. You can get the `elementId` from the [List forms
+        endpoint](/data/reference/forms/forms/list).
+
+
+
+
+        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 Form Submissions by Site
+      request:
+        name: FormsListSubmissionsBySiteRequest
+        query-parameters:
+          elementId:
+            type: optional<string>
+            docs: Identifier for an element
+          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:
+            site_id: 580e63e98c9a982ac9b8b741
+          query-parameters:
+            elementId: 18259716-3e5a-646a-5f41-5dc4b9405aa0
+          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
   source:
-    openapi: ../../../referenced-specs/v2.yml
+    openapi: ../../../openapi/referenced-specs/v2.yml
   display-name: Forms
+docs: Forms are forms that are created on your Webflow site.

package/.mock/definition/inventory.yml

@@ -13,7 +13,7 @@ service:
 
         Required scope | `ecommerce:read`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         collection_id:
           type: string
@@ -25,6 +25,7 @@ service:
       response:
         docs: Request was successful
         type: root.InventoryItem
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -62,7 +63,7 @@ service:
 
         Required scope | `ecommerce:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         collection_id:
           type: string
@@ -88,6 +89,7 @@ service:
       response:
         docs: Request was successful
         type: root.InventoryItem
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -108,13 +110,15 @@ service:
               quantity: 100
               inventoryType: finite
   source:
-    openapi: ../../../referenced-specs/v2.yml
+    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: ../../../referenced-specs/v2.yml
+      openapi: ../../../openapi/referenced-specs/v2.yml

package/.mock/definition/orders.yml

@@ -9,15 +9,16 @@ types:
       - disputed
       - unfulfilled
     source:
-      openapi: ../../../referenced-specs/v2.yml
+      openapi: ../../../openapi/referenced-specs/v2.yml
   OrdersRefundRequestReason:
     enum:
       - duplicate
       - fraudulent
       - requested
     docs: The reason for the refund
+    inline: true
     source:
-      openapi: ../../../referenced-specs/v2.yml
+      openapi: ../../../openapi/referenced-specs/v2.yml
 imports:
   root: __package__.yml
 service:
@@ -33,7 +34,7 @@ service:
 
         Required scope | `ecommerce:read`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -56,6 +57,7 @@ service:
       response:
         docs: Request was successful
         type: root.OrderList
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -80,11 +82,6 @@ service:
                     Please gift wrap with a personal note saying "Happy
                     Birthday, Ford! 🎉
                   acceptedOn: '2024-04-10T13:16:21Z'
-                  fulfilledOn: '2018-12-03T22:06:15Z'
-                  refundedOn: '2018-12-03T22:06:15Z'
-                  disputedOn: '2018-12-03T22:06:15Z'
-                  disputeUpdatedOn: '2018-12-03T22:06:15Z'
-                  disputeLastStatus: warning_needs_response
                   customerPaid:
                     unit: USD
                     value: '5892'
@@ -200,13 +197,6 @@ service:
                     expires:
                       year: 2025
                       month: 4
-                  paypalDetails:
-                    orderId: 1a2b3c4d5e6f7g8h9i0j
-                    payerId: 9k8j7i6h5g4f3e2d1c0b
-                    captureId: qwe123rty456uio789p
-                    refundId: abcde12345fghij67890
-                    refundReason: Customer requested refund
-                    disputeId: zxcvbnm987poiuytrewq
                   customData:
                     - key: value
                   metadata:
@@ -234,11 +224,7 @@ service:
                   comment: Example comment to myself
                   orderComment: ''
                   acceptedOn: '2024-03-29T21:29:21Z'
-                  fulfilledOn: '2018-12-03T22:06:15Z'
                   refundedOn: '2024-04-08T18:25:04Z'
-                  disputedOn: '2018-12-03T22:06:15Z'
-                  disputeUpdatedOn: '2018-12-03T22:06:15Z'
-                  disputeLastStatus: warning_needs_response
                   customerPaid:
                     unit: USD
                     value: '5892'
@@ -358,13 +344,6 @@ service:
                     expires:
                       year: 2024
                       month: 4
-                  paypalDetails:
-                    orderId: 1a2b3c4d5e6f7g8h9i0j
-                    payerId: 9k8j7i6h5g4f3e2d1c0b
-                    captureId: qwe123rty456uio789p
-                    refundId: abcde12345fghij67890
-                    refundReason: Customer requested refund
-                    disputeId: zxcvbnm987poiuytrewq
                   customData:
                     - key: value
                   metadata:
@@ -423,7 +402,7 @@ service:
 
         Required scope | `ecommerce:read`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -435,6 +414,7 @@ service:
       response:
         docs: Request was successful
         type: root.Order
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -570,12 +550,10 @@ service:
                   length: 40
               purchasedItemsCount: 2
               stripeDetails:
-                subscriptionId: sub_1J6xwG2eZvKYlo2CXu9Zt0Tn
                 paymentMethod: pm_1OzmzBJYFi4lcbXWHKNdXU7j
                 paymentIntentId: pi_3OzmzDJYFi4lcbXW1hTBW6ft
                 customerId: cus_PpRsNHwWdUoRKR
                 chargeId: ch_3OzmzDJYFi4lcbXW1ndkkrH2
-                disputeId: disputeId
                 refundId: re_3OzmzDJYFi4lcbXW1kFAmlBk
                 refundReason: fraudulent
               stripeCard:
@@ -585,13 +563,6 @@ service:
                 expires:
                   year: 2024
                   month: 4
-              paypalDetails:
-                orderId: 1a2b3c4d5e6f7g8h9i0j
-                payerId: 9k8j7i6h5g4f3e2d1c0b
-                captureId: qwe123rty456uio789p
-                refundId: abcde12345fghij67890
-                refundReason: Customer requested refund
-                disputeId: zxcvbnm987poiuytrewq
               customData:
                 - key: value
               metadata:
@@ -647,7 +618,7 @@ service:
 
         Required scope | `ecommerce:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -676,6 +647,7 @@ service:
       response:
         docs: Request was successful
         type: root.Order
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -812,12 +784,10 @@ service:
                   length: 40
               purchasedItemsCount: 2
               stripeDetails:
-                subscriptionId: sub_1J6xwG2eZvKYlo2CXu9Zt0Tn
                 paymentMethod: pm_1OzmzBJYFi4lcbXWHKNdXU7j
                 paymentIntentId: pi_3OzmzDJYFi4lcbXW1hTBW6ft
                 customerId: cus_PpRsNHwWdUoRKR
                 chargeId: ch_3OzmzDJYFi4lcbXW1ndkkrH2
-                disputeId: disputeId
                 refundId: re_3OzmzDJYFi4lcbXW1kFAmlBk
                 refundReason: fraudulent
               stripeCard:
@@ -827,13 +797,6 @@ service:
                 expires:
                   year: 2024
                   month: 4
-              paypalDetails:
-                orderId: 1a2b3c4d5e6f7g8h9i0j
-                payerId: 9k8j7i6h5g4f3e2d1c0b
-                captureId: qwe123rty456uio789p
-                refundId: abcde12345fghij67890
-                refundReason: Customer requested refund
-                disputeId: zxcvbnm987poiuytrewq
               customData:
                 - key: value
               metadata:
@@ -887,7 +850,7 @@ service:
 
         Required scope | `ecommerce:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -908,6 +871,7 @@ service:
       response:
         docs: Request was successful
         type: root.Order
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -1044,12 +1008,10 @@ service:
                   length: 40
               purchasedItemsCount: 2
               stripeDetails:
-                subscriptionId: sub_1J6xwG2eZvKYlo2CXu9Zt0Tn
                 paymentMethod: pm_1OzmzBJYFi4lcbXWHKNdXU7j
                 paymentIntentId: pi_3OzmzDJYFi4lcbXW1hTBW6ft
                 customerId: cus_PpRsNHwWdUoRKR
                 chargeId: ch_3OzmzDJYFi4lcbXW1ndkkrH2
-                disputeId: disputeId
                 refundId: re_3OzmzDJYFi4lcbXW1kFAmlBk
                 refundReason: fraudulent
               stripeCard:
@@ -1059,13 +1021,6 @@ service:
                 expires:
                   year: 2024
                   month: 4
-              paypalDetails:
-                orderId: 1a2b3c4d5e6f7g8h9i0j
-                payerId: 9k8j7i6h5g4f3e2d1c0b
-                captureId: qwe123rty456uio789p
-                refundId: abcde12345fghij67890
-                refundReason: Customer requested refund
-                disputeId: zxcvbnm987poiuytrewq
               customData:
                 - key: value
               metadata:
@@ -1119,7 +1074,7 @@ service:
 
         Required scope | `ecommerce:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -1131,6 +1086,7 @@ service:
       response:
         docs: Request was successful
         type: root.Order
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -1266,12 +1222,10 @@ service:
                   length: 40
               purchasedItemsCount: 2
               stripeDetails:
-                subscriptionId: sub_1J6xwG2eZvKYlo2CXu9Zt0Tn
                 paymentMethod: pm_1OzmzBJYFi4lcbXWHKNdXU7j
                 paymentIntentId: pi_3OzmzDJYFi4lcbXW1hTBW6ft
                 customerId: cus_PpRsNHwWdUoRKR
                 chargeId: ch_3OzmzDJYFi4lcbXW1ndkkrH2
-                disputeId: disputeId
                 refundId: re_3OzmzDJYFi4lcbXW1kFAmlBk
                 refundReason: fraudulent
               stripeCard:
@@ -1281,13 +1235,6 @@ service:
                 expires:
                   year: 2024
                   month: 4
-              paypalDetails:
-                orderId: 1a2b3c4d5e6f7g8h9i0j
-                payerId: 9k8j7i6h5g4f3e2d1c0b
-                captureId: qwe123rty456uio789p
-                refundId: abcde12345fghij67890
-                refundReason: Customer requested refund
-                disputeId: zxcvbnm987poiuytrewq
               customData:
                 - key: value
               metadata:
@@ -1342,7 +1289,7 @@ service:
 
         Required scope | `ecommerce:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -1362,6 +1309,7 @@ service:
       response:
         docs: Request was successful
         type: root.Order
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -1498,12 +1446,10 @@ service:
                   length: 40
               purchasedItemsCount: 2
               stripeDetails:
-                subscriptionId: sub_1J6xwG2eZvKYlo2CXu9Zt0Tn
                 paymentMethod: pm_1OzmzBJYFi4lcbXWHKNdXU7j
                 paymentIntentId: pi_3OzmzDJYFi4lcbXW1hTBW6ft
                 customerId: cus_PpRsNHwWdUoRKR
                 chargeId: ch_3OzmzDJYFi4lcbXW1ndkkrH2
-                disputeId: disputeId
                 refundId: re_3OzmzDJYFi4lcbXW1kFAmlBk
                 refundReason: fraudulent
               stripeCard:
@@ -1513,13 +1459,6 @@ service:
                 expires:
                   year: 2024
                   month: 4
-              paypalDetails:
-                orderId: 1a2b3c4d5e6f7g8h9i0j
-                payerId: 9k8j7i6h5g4f3e2d1c0b
-                captureId: qwe123rty456uio789p
-                refundId: abcde12345fghij67890
-                refundReason: Customer requested refund
-                disputeId: zxcvbnm987poiuytrewq
               customData:
                 - key: value
               metadata:
@@ -1565,5 +1504,6 @@ service:
                   url: >-
                     https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa
   source:
-    openapi: ../../../referenced-specs/v2.yml
+    openapi: ../../../openapi/referenced-specs/v2.yml
   display-name: Orders
+docs: Orders are the orders for your Webflow site.

package/.mock/definition/pages/scripts.yml

@@ -8,27 +8,12 @@ service:
       path: /pages/{page_id}/custom_code
       method: GET
       auth: true
-      docs: >
-        Get all registered scripts that have been applied to a specific Page. 
-
-
-        In order to use the Custom Code APIs for Sites and Pages, Custom Code
-        Scripts must first be registered 
-
-        to a Site via the `registered_scripts` endpoints, and then applied to a
-        Site or Page using the appropriate
-
-        `custom_code` endpoints. 
-
-        <blockquote class="callout callout_info" theme="📘">Access to this
-        endpoint requires a bearer token from a <a
-        href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data
-        Client App</a>.</blockquote>
-
+      docs: |
+        Get all scripts applied to a page. 
 
         Required scope | `custom_code:read`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         page_id:
           type: string
@@ -37,6 +22,7 @@ service:
       response:
         docs: Request was successful
         type: root.ScriptApplyList
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -60,27 +46,16 @@ service:
       path: /pages/{page_id}/custom_code
       method: PUT
       auth: true
-      docs: >
-        Add a registered script to a Page. 
-
-
-        In order to use the Custom Code APIs for Sites and Pages, Custom Code
-        Scripts must first be registered 
-
-        to a Site via the `registered_scripts` endpoints, and then applied to a
-        Site or Page using the appropriate
-
-        `custom_code` endpoints. 
-
-        <blockquote class="callout callout_info" theme="📘">Access to this
-        endpoint requires a bearer token from a <a
-        href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data
-        Client App</a>.</blockquote>
+      docs: |
+        Apply scripts to a page.
 
+        <Note title="Script Registration">
+          To apply a script to a page, the script must first be registered to a Site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information.
+        </Note>
 
         Required scope | `custom_code:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         page_id:
           type: string
@@ -92,10 +67,12 @@ service:
       response:
         docs: Request was successful
         type: root.ScriptApplyList
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
         - root.NotFoundError
+        - root.ConflictError
         - root.TooManyRequestsError
         - root.InternalServerError
       examples:
@@ -131,26 +108,16 @@ service:
       method: DELETE
       auth: true
       docs: >
-        Delete the custom code block that an app has created for a page
-
-
-        In order to use the Custom Code APIs for Sites and Pages, Custom Code
-        Scripts must first be registered 
-
-        to a Site via the `registered_scripts` endpoints, and then applied to a
-        Site or Page using the appropriate
+        Delete a custom code block that the App created on a page.
 
-        `custom_code` endpoints. 
 
-        <blockquote class="callout callout_info" theme="📘">Access to this
-        endpoint requires a bearer token from a <a
-        href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data
-        Client App</a>.</blockquote>
+        <Note>Access to this endpoint requires a bearer token from a [Data
+        Client App](/data/docs/getting-started-data-clients).</Note>
 
 
         Required scope | `custom_code:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         page_id:
           type: string
@@ -166,4 +133,4 @@ service:
         - path-parameters:
             page_id: 63c720f9347c2139b248e552
   source:
-    openapi: ../../../referenced-specs/v2.yml
+    openapi: ../../../openapi/referenced-specs/v2.yml