webflow-api 3.1.0 → 3.1.2

package/.mock/definition/forms.yml

@@ -33,6 +33,7 @@ service:
       response:
         docs: Request was successful
         type: root.FormList
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -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,6 +153,12 @@ 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: ../../../openapi/referenced-specs/v2.yml
@@ -175,6 +181,7 @@ service:
       response:
         docs: Request was successful
         type: root.FormSubmissionList
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -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
@@ -274,6 +309,7 @@ service:
       response:
         docs: Request was successful
         type: root.FormSubmission
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -296,6 +332,82 @@ 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: ../../../openapi/referenced-specs/v2.yml
   display-name: Forms

package/.mock/definition/inventory.yml

@@ -25,6 +25,7 @@ service:
       response:
         docs: Request was successful
         type: root.InventoryItem
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -88,6 +89,7 @@ service:
       response:
         docs: Request was successful
         type: root.InventoryItem
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError

package/.mock/definition/orders.yml

@@ -57,6 +57,7 @@ service:
       response:
         docs: Request was successful
         type: root.OrderList
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -81,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'
@@ -201,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:
@@ -235,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'
@@ -359,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:
@@ -436,6 +414,7 @@ service:
       response:
         docs: Request was successful
         type: root.Order
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -571,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:
@@ -586,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:
@@ -677,6 +647,7 @@ service:
       response:
         docs: Request was successful
         type: root.Order
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -813,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:
@@ -828,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:
@@ -909,6 +871,7 @@ service:
       response:
         docs: Request was successful
         type: root.Order
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -1045,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:
@@ -1060,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:
@@ -1132,6 +1086,7 @@ service:
       response:
         docs: Request was successful
         type: root.Order
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -1267,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:
@@ -1282,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:
@@ -1363,6 +1309,7 @@ service:
       response:
         docs: Request was successful
         type: root.Order
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -1499,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:
@@ -1514,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:

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

@@ -8,22 +8,8 @@ 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. 
-
-
-        <Note>Access to this endpoint requires a bearer token from a [Data
-        Client App](/data/docs/getting-started-data-clients).</Note>
-
+      docs: |
+        Get all scripts applied to a page. 
 
         Required scope | `custom_code:read`
       source:
@@ -36,6 +22,7 @@ service:
       response:
         docs: Request was successful
         type: root.ScriptApplyList
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -59,25 +46,12 @@ 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.
-
-
-        A site can have a maximum of 800 registered scripts.
-
-
-        <Note>Access to this endpoint requires a bearer token from a [Data
-        Client App](/data/docs/getting-started-data-clients).</Note>
+      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:
@@ -93,6 +67,7 @@ service:
       response:
         docs: Request was successful
         type: root.ScriptApplyList
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -133,16 +108,7 @@ 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
-
-        `custom_code` endpoints. 
+        Delete a custom code block that the App created on a page.
 
 
         <Note>Access to this endpoint requires a bearer token from a [Data

package/.mock/definition/pages.yml

@@ -38,6 +38,7 @@ service:
       response:
         docs: Request was successful
         type: root.PageList
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -56,8 +57,6 @@ service:
                   siteId: 6258612d1ee792848f805dcf
                   title: Guide to the Galaxy
                   slug: guide-to-the-galaxy
-                  parentId: 6419db964a9c435aa3af6251
-                  collectionId: 6390c49774a71f12831a08e3
                   createdOn: '2024-03-11T10:42:00Z'
                   lastUpdated: '2024-03-11T10:42:42Z'
                   archived: false
@@ -83,8 +82,6 @@ service:
                   siteId: 6258612d1ee792848f805dcf
                   title: Towel Day Celebrations
                   slug: towel-day
-                  parentId: 6419db964a9c435aa3af6251
-                  collectionId: 6390c49774a71f12831a08e3
                   createdOn: '2024-05-25T09:00:00Z'
                   lastUpdated: '2024-05-25T09:42:00Z'
                   archived: false
@@ -138,6 +135,7 @@ service:
       response:
         docs: Request was successful
         type: root.Page
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -155,8 +153,6 @@ service:
               siteId: 6258612d1ee792848f805dcf
               title: Guide to the Galaxy
               slug: guide-to-the-galaxy
-              parentId: 6419db964a9c435aa3af6251
-              collectionId: 6390c49774a71f12831a08e3
               createdOn: '2024-03-11T10:42:00Z'
               lastUpdated: '2024-03-11T10:42:42Z'
               archived: false
@@ -185,6 +181,10 @@ service:
       docs: |
         Update Page-level metadata, including SEO and Open Graph fields.
 
+        <Note>
+          Note: When updating Page Metadata in secondary locales, you may only add `slug` to the request if your Site has the [Advanced or Enterprise Localization](https://webflow.com/localization) add-on.
+        </Note>
+
         Required scope | `pages:write`
       source:
         openapi: ../../../openapi/referenced-specs/v2.yml
@@ -206,6 +206,7 @@ service:
       response:
         docs: Request was successful
         type: root.Page
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -248,8 +249,6 @@ service:
               siteId: 6258612d1ee792848f805dcf
               title: Guide to the Galaxy
               slug: guide-to-the-galaxy
-              parentId: 6419db964a9c435aa3af6251
-              collectionId: 6390c49774a71f12831a08e3
               createdOn: '2024-03-11T10:42:00Z'
               lastUpdated: '2024-03-11T10:42:42Z'
               archived: false
@@ -276,16 +275,18 @@ service:
       method: GET
       auth: true
       docs: >
-        Get static content from a static page. This includes text nodes, image
-        nodes and component instances.
+        Get content from a static page. This includes text nodes, image nodes,
+        and component instances with [property
+        overrides](https://help.webflow.com/hc/en-us/articles/33961219350547-Component-properties#how-to-modify-property-values-on-component-instances).
 
-        To retrieve the contents of components in the page use the [get
-        component
-        content](/data/reference/pages-and-components/components/get-content)
+
+        To retrieve the static content of a component instance, use the [Get
+        Component
+        Content](/data/reference/pages-and-components/components/get-content)
         endpoint.
 
 
-        <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 content that can be localized from the Primary
         locale.</Note>
 
@@ -317,6 +318,7 @@ service:
       response:
         docs: Request was successful
         type: root.Dom
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -334,39 +336,31 @@ service:
             body:
               pageId: 658205daa3e8206a523b5ad4
               nodes:
-                - type: component-instance
-                  id: a245c12d-995b-55ee-5ec7-aa36a6cad623
-                  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-aa36a6cad627
-                  componentId: nodes
-                  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
-                      label: Catchphrase
-                      text:
-                        text: Don't Panic!
-                    - propertyId: a245c12d-995b-55ee-5ec7-aa36a6cad635
-                      type: Rich Text
-                      label: Tagline
-                      text:
-                        html: <div><p>Always know where your towel is.</p></div>
+                  type: component-instance
               pagination:
                 limit: 4
                 offset: 0
                 total: 4
+              lastUpdated: '2016-10-24T19:42:38Z'
     update-static-content:
       path: /pages/{page_id}/dom
       method: POST
@@ -418,6 +412,7 @@ service:
       response:
         docs: Request was successful
         type: UpdateStaticContentResponse
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError