From 4b9f5a43df4aba320689a2c332675558575e8fc1 Mon Sep 17 00:00:00 2001
From: "fern-api[bot]" <115122769+fern-api[bot]@users.noreply.github.com>
Date: Mon, 24 Nov 2025 17:34:47 +0000
Subject: [PATCH] SDK regeneration
---
.mock/definition/assets.yml | 3 +
.mock/definition/collections.yml | 3 +
.mock/definition/collections/items.yml | 14 +-
.mock/definition/comments.yml | 1 +
.mock/definition/components.yml | 4 +
.mock/definition/forms.yml | 87 +-
.mock/definition/items.yml | 1 +
.mock/definition/orders.yml | 78 ++
.mock/definition/pages.yml | 9 +
.mock/definition/scripts.yml | 3 +
.mock/definition/sites.yml | 24 +
.mock/definition/sites/activityLogs.yml | 4 +
.mock/definition/sites/comments.yml | 2 +
.mock/definition/sites/forms.yml | 309 +++++++
.mock/definition/sites/scripts.yml | 1 +
.mock/definition/webhooks.yml | 4 +
.mock/fern.config.json | 2 +-
package.json | 4 +-
reference.md | 487 +++++++++--
src/Client.ts | 4 +-
.../resources/items/client/Client.ts | 14 +-
src/api/resources/forms/client/Client.ts | 161 ----
.../resources/forms/client/requests/index.ts | 1 -
src/api/resources/sites/client/Client.ts | 6 +
.../sites/resources/forms/client/Client.ts | 805 ++++++++++++++++++
.../sites/resources/forms/client/index.ts | 2 +
...ormsListSubmissionsByFormAndSiteRequest.ts | 21 +
.../FormsListSubmissionsBySiteRequest.ts | 0
.../requests/FormsUpdateSubmissionRequest.ts | 12 +
.../resources/forms/client/requests/index.ts | 3 +
.../resources/sites/resources/forms/index.ts | 1 +
src/api/resources/sites/resources/index.ts | 2 +
.../sites/resources/forms/client/index.ts | 1 +
.../requests/FormsUpdateSubmissionRequest.ts | 20 +
.../resources/forms/client/requests/index.ts | 1 +
.../resources/sites/resources/forms/index.ts | 1 +
.../resources/sites/resources/index.ts | 2 +
src/version.ts | 2 +-
tests/wire/assets.test.ts | 6 +
tests/wire/collections.test.ts | 6 +
tests/wire/components.test.ts | 20 +-
tests/wire/forms.test.ts | 97 +--
tests/wire/orders.test.ts | 158 ++++
tests/wire/pages.test.ts | 18 +
tests/wire/scripts.test.ts | 6 +
tests/wire/sites.test.ts | 56 ++
tests/wire/sites/activityLogs.test.ts | 8 +
tests/wire/sites/comments.test.ts | 4 +
tests/wire/sites/forms.test.ts | 258 ++++++
tests/wire/sites/scripts.test.ts | 2 +
tests/wire/webhooks.test.ts | 8 +
yarn.lock | 235 +++--
52 files changed, 2433 insertions(+), 548 deletions(-)
create mode 100644 .mock/definition/sites/forms.yml
create mode 100644 src/api/resources/sites/resources/forms/client/Client.ts
create mode 100644 src/api/resources/sites/resources/forms/client/index.ts
create mode 100644 src/api/resources/sites/resources/forms/client/requests/FormsListSubmissionsByFormAndSiteRequest.ts
rename src/api/resources/{ => sites/resources}/forms/client/requests/FormsListSubmissionsBySiteRequest.ts (100%)
create mode 100644 src/api/resources/sites/resources/forms/client/requests/FormsUpdateSubmissionRequest.ts
create mode 100644 src/api/resources/sites/resources/forms/client/requests/index.ts
create mode 100644 src/api/resources/sites/resources/forms/index.ts
create mode 100644 src/serialization/resources/sites/resources/forms/client/index.ts
create mode 100644 src/serialization/resources/sites/resources/forms/client/requests/FormsUpdateSubmissionRequest.ts
create mode 100644 src/serialization/resources/sites/resources/forms/client/requests/index.ts
create mode 100644 src/serialization/resources/sites/resources/forms/index.ts
create mode 100644 tests/wire/sites/forms.test.ts
diff --git a/.mock/definition/assets.yml b/.mock/definition/assets.yml
index 73c7559c..8c142ae3 100644
--- a/.mock/definition/assets.yml
+++ b/.mock/definition/assets.yml
@@ -242,6 +242,7 @@ service:
width: 500
height: 900
quality: 100
+ error: error
altText: A single candy wrapper
delete:
path: /assets/{asset_id}
@@ -335,6 +336,7 @@ service:
width: 500
height: 900
quality: 100
+ error: error
altText: A single candy wrapper
list-folders:
path: /sites/{site_id}/asset_folders
@@ -371,6 +373,7 @@ service:
assetFolders:
- id: 6390c49774a71f0e3c1a08ee
displayName: emoji icons
+ parentFolder: 6390c49774a71f99f21a08eb
assets:
- 63e5889e7fe4eafa7384cea4
- 659595234426a9fcbad57043
diff --git a/.mock/definition/collections.yml b/.mock/definition/collections.yml
index 5ddf39bb..b9ee7cd1 100644
--- a/.mock/definition/collections.yml
+++ b/.mock/definition/collections.yml
@@ -303,18 +303,21 @@ service:
type: File
slug: guide-file
displayName: Guide File
+ helpText: helpText
- id: 7f8e9d0c1b2a3f4e5d6c8b9e
isRequired: false
isEditable: true
type: Email
slug: contributor-email
displayName: Contributor Email
+ helpText: helpText
- id: 3a4f5e6d7c8b9a0e1d2c4b5f
isRequired: false
isEditable: true
type: Phone
slug: emergency-contact
displayName: Emergency Contact
+ helpText: helpText
delete:
path: /collections/{collection_id}
method: DELETE
diff --git a/.mock/definition/collections/items.yml b/.mock/definition/collections/items.yml
index 09d267c4..53672488 100644
--- a/.mock/definition/collections/items.yml
+++ b/.mock/definition/collections/items.yml
@@ -673,10 +673,9 @@ service:
docs: |
List all published items in a collection.
-
- To serve content to your other frontends applications, enterprise sites have access to a dedicated [content delivery API](/data/docs/cms-content-delivery), available at api-cdn.webflow.com.
-
-
+
+ Serving data to applications in real-time? Use the Content Delivery API at `api-cdn.webflow.com` for better performance. The CDN-backed endpoint is optimized for high-volume reads, while the Data API is designed for writes and management operations.
+
Required scope | `CMS:read`
source:
@@ -1797,10 +1796,9 @@ service:
docs: |
Get details of a selected Collection live Item.
-
- To serve content to your other frontends applications, enterprise sites have access to a dedicated [content delivery API](/data/docs/cms-content-delivery), available at api-cdn.webflow.com.
-
-
+
+ Serving data to applications in real-time? Use the Content Delivery API at `api-cdn.webflow.com` for better performance. The CDN-backed endpoint is optimized for high-volume reads, while the Data API is designed for writes and management operations.
+
Required scope | `CMS:read`
source:
diff --git a/.mock/definition/comments.yml b/.mock/definition/comments.yml
index 91de1be8..573e375e 100644
--- a/.mock/definition/comments.yml
+++ b/.mock/definition/comments.yml
@@ -17,6 +17,7 @@ webhooks:
siteId: 679826b3b20b045e176bc4b5
pageId: 679826b3b20b045e176bc4bc
localeId: 67993753d910db250db64b3e
+ itemId: 580e64008c9a982ac9b8b754
breakpoint: main
url: >-
https://webflow.com/design/site-slug-4ec832?workflow=comment&commentId=679d2ddb5196117ad04d1ffa&pageId=679826b3b20b045e176bc4bc
diff --git a/.mock/definition/components.yml b/.mock/definition/components.yml
index 6a8a0077..9bca51f3 100644
--- a/.mock/definition/components.yml
+++ b/.mock/definition/components.yml
@@ -69,9 +69,13 @@ service:
readonly: true
- id: 6258612d1ee792848f805dcf
name: Card
+ group: Buttons
+ description: A button component that can be used across the site
readonly: true
- id: 68a2b1d1ee792848f805dcf
name: Nav
+ group: Buttons
+ description: A button component that can be used across the site
readonly: true
pagination:
limit: 20
diff --git a/.mock/definition/forms.yml b/.mock/definition/forms.yml
index 44592f7d..14bc2ad6 100644
--- a/.mock/definition/forms.yml
+++ b/.mock/definition/forms.yml
@@ -59,13 +59,16 @@ service:
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
@@ -80,10 +83,12 @@ service:
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
@@ -136,6 +141,7 @@ service:
660d5bcc9c0772150459dfb1:
displayName: Name
type: Plain
+ placeholder: Enter your email
userVisible: true
589a331aa51e760df7ccb89d:
displayName: Email
@@ -145,6 +151,7 @@ service:
responseSettings:
redirectUrl: https://example.com
redirectMethod: GET
+ redirectAction: POST https://example.com
sendEmailConfirmation: true
id: 589a331aa51e760df7ccb89e
siteId: 580e63e98c9a982ac9b8b741
@@ -350,86 +357,6 @@ service:
formResponse:
First Name: Arthur
Last Name: Dent
- list-submissions-by-site:
- path: /sites/{site_id}/form_submissions
- method: GET
- auth:
- - OAuth2:
- - forms:read
- 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
- docs: Identifier for an element
- offset:
- type: optional
- docs: >-
- Offset used for pagination if the results have more than limit
- records
- limit:
- type: optional
- 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
- 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
source:
openapi: ../../../openapi/referenced-specs/v2.yml
display-name: Forms
diff --git a/.mock/definition/items.yml b/.mock/definition/items.yml
index f65b6d7b..634f1f75 100644
--- a/.mock/definition/items.yml
+++ b/.mock/definition/items.yml
@@ -83,6 +83,7 @@ webhooks:
siteId: 65427cf400e02b306eaa049c
workspaceId: 625860a7a6c16d624927122f
collectionId: 664243617fcc8b464b23c4ee
+ cmsLocaleId: 681442a144bb80bd00480fda
docs: Information about a collection item that was published
collection_item_unpublished:
audiences: []
diff --git a/.mock/definition/orders.yml b/.mock/definition/orders.yml
index 0eeeabde..82affd79 100644
--- a/.mock/definition/orders.yml
+++ b/.mock/definition/orders.yml
@@ -88,6 +88,11 @@ 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'
@@ -187,15 +192,18 @@ service:
unit: USD
value: '5892'
string: \$ 83.09 USD
+ weight: 5
width: 19
height: 72
length: 18
purchasedItemsCount: 3
stripeDetails:
+ subscriptionId: sub_1J6xwG2eZvKYlo2CXu9Zt0Tn
paymentMethod: pm_1P410gJYFi4lcbXWbeKghqjK
paymentIntentId: pi_3P410iJYFi4lcbXW0EKKgcVg
customerId: cus_Ptod8KJBiiPgnH
chargeId: ch_3P410iJYFi4lcbXW0DxUkzCH
+ refundReason: requested_by_customer
stripeCard:
last4: '4242'
brand: Visa
@@ -203,6 +211,13 @@ 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:
@@ -230,7 +245,11 @@ 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'
@@ -337,6 +356,7 @@ service:
length: 40
purchasedItemsCount: 2
stripeDetails:
+ subscriptionId: sub_1J6xwG2eZvKYlo2CXu9Zt0Tn
paymentMethod: pm_1OzmzBJYFi4lcbXWHKNdXU7j
paymentIntentId: pi_3OzmzDJYFi4lcbXW1hTBW6ft
customerId: cus_PpRsNHwWdUoRKR
@@ -350,6 +370,13 @@ 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:
@@ -558,10 +585,12 @@ 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:
@@ -571,6 +600,13 @@ 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:
@@ -794,10 +830,12 @@ 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:
@@ -807,6 +845,13 @@ 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:
@@ -1020,10 +1065,12 @@ 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:
@@ -1033,6 +1080,13 @@ 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:
@@ -1236,10 +1290,12 @@ 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:
@@ -1249,6 +1305,13 @@ 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:
@@ -1462,10 +1525,12 @@ 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:
@@ -1475,6 +1540,13 @@ 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:
@@ -1544,6 +1616,10 @@ webhooks:
Please gift wrap with a personal note saying "Happy Birthday,
Ford! 🎉
acceptedOn: '2024-03-29T21:29: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'
customerPaid:
unit: USD
value: '5892'
@@ -1647,6 +1723,7 @@ webhooks:
length: 40
purchasedItemsCount: 2
stripeDetails:
+ subscriptionId: sub_1J6xwG2eZvKYlo2CXu9Zt0Tn
paymentMethod: pm_1OzmzBJYFi4lcbXWHKNdXU7j
paymentIntentId: pi_3OzmzDJYFi4lcbXW1hTBW6ft
customerId: cus_PpRsNHwWdUoRKR
@@ -1833,6 +1910,7 @@ webhooks:
length: 40
purchasedItemsCount: 2
stripeDetails:
+ subscriptionId: sub_1J6xwG2eZvKYlo2CXu9Zt0Tn
paymentMethod: pm_1OzmzBJYFi4lcbXWHKNdXU7j
paymentIntentId: pi_3OzmzDJYFi4lcbXW1hTBW6ft
customerId: cus_PpRsNHwWdUoRKR
diff --git a/.mock/definition/pages.yml b/.mock/definition/pages.yml
index 88b8aa21..a4f63b00 100644
--- a/.mock/definition/pages.yml
+++ b/.mock/definition/pages.yml
@@ -64,6 +64,8 @@ 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
@@ -89,12 +91,15 @@ 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
draft: false
canBranch: true
isBranch: false
+ branchId: 68026fa68ef6dc744c75b833
seo:
title: Celebrate Towel Day - The Hitchhiker's Guide to the Galaxy
description: >-
@@ -164,6 +169,8 @@ 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
@@ -271,6 +278,8 @@ 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
diff --git a/.mock/definition/scripts.yml b/.mock/definition/scripts.yml
index 0989ace5..4ff0c7d9 100644
--- a/.mock/definition/scripts.yml
+++ b/.mock/definition/scripts.yml
@@ -48,6 +48,7 @@ service:
canCopy: false
displayName: Alert
hostedLocation: https://cdn.webflow.io/.../alert-0.0.1.js
+ integrityHash: integrityHash
createdOn: '2022-10-26T00:28:54.191Z'
lastUpdated: lastUpdated
version: 0.0.1
@@ -55,6 +56,7 @@ service:
canCopy: false
displayName: Alert
hostedLocation: https://cdn.webflow.io/.../alert-0.0.2.js
+ integrityHash: integrityHash
createdOn: '2022-10-26T00:28:54.191Z'
lastUpdated: lastUpdated
version: 0.0.2
@@ -225,6 +227,7 @@ service:
displayName: Alert
hostedLocation: >-
https://uploads-ssl.webflow.com/6258612d1ee792848f805dcf%2F64b6c769ff52ba6c3d904a91%2F660d6e15b3d1696f2d2b1447%2Falert-0.0.1.js
+ integrityHash: integrityHash
createdOn: '2022-10-26T00:28:54.191Z'
lastUpdated: lastUpdated
version: 0.0.1
diff --git a/.mock/definition/sites.yml b/.mock/definition/sites.yml
index 052dbbc2..ebc7cd09 100644
--- a/.mock/definition/sites.yml
+++ b/.mock/definition/sites.yml
@@ -64,12 +64,34 @@ service:
createdOn: '2024-10-15T20:24:38Z'
displayName: The Hitchiker's Guide
shortName: hitchikers-guide
+ lastPublished: '2016-10-24T19:43:17Z'
lastUpdated: '2024-10-15T20:24:38Z'
+ previewUrl: >-
+ https://dev-assets.website-files.com/580e63e98c9a982ac9b8b741/201610241243.png
+ timeZone: America/Los_Angeles
parentFolderId: 670ece123598db72d9648be1
customDomains:
- id: 589a331aa51e760df7ccb89d
url: test-api-domain.com
lastPublished: '2022-12-07T16:51:37Z'
+ locales:
+ primary:
+ id: 653fd9af6a07fc9cfd7a5e57
+ cmsLocaleId: 653ad57de882f528b32e810e
+ enabled: false
+ displayName: English (United States)
+ displayImageId: displayImageId
+ redirect: true
+ subdirectory: ''
+ tag: en-US
+ secondary:
+ - id: 653fd9af6a07fc9cfd7a5e57
+ cmsLocaleId: 653ad57de882f528b32e810e
+ enabled: false
+ displayName: English (United States)
+ redirect: true
+ subdirectory: ''
+ tag: en-US
dataCollectionEnabled: true
dataCollectionType: always
list:
@@ -148,6 +170,7 @@ service:
previewUrl: >-
https://dev-assets.website-files.com/42e63e98c9a982ac9b8b742/198110121200.png
timeZone: DeepSpace/Depression
+ parentFolderId: 1as2d3f4g5h6j7k8l9z0x1c2v3b4n5m6
customDomains:
- id: 589a331aa51e760df7ccb89f
url: marvin.blog
@@ -181,6 +204,7 @@ service:
previewUrl: >-
https://dev-assets.website-files.com/42e63e98c9a982ac9b8b743/198210121200.png
timeZone: Vogsphere/PoetryHall
+ parentFolderId: 1as2d3f4g5h6j7k8l9z0x1c2v3b4n5m6
customDomains:
- id: 589a331aa51e760df7ccb8a0
url: vogonpoetry.galaxy
diff --git a/.mock/definition/sites/activityLogs.yml b/.mock/definition/sites/activityLogs.yml
index 88d0822f..fc8d76f3 100644
--- a/.mock/definition/sites/activityLogs.yml
+++ b/.mock/definition/sites/activityLogs.yml
@@ -65,6 +65,10 @@ service:
displayName: John Doe
resourceId: 654c16c7b229e56bcf26870c
resourceName: foo-bar
+ newValue: newValue
+ previousValue: previousValue
+ payload:
+ key: value
pagination:
limit: 25
offset: 0
diff --git a/.mock/definition/sites/comments.yml b/.mock/definition/sites/comments.yml
index ac8b3a2d..e2afdd16 100644
--- a/.mock/definition/sites/comments.yml
+++ b/.mock/definition/sites/comments.yml
@@ -115,6 +115,7 @@ service:
siteId: 679826b3b20b045e176bc4b5
pageId: 679826b3b20b045e176bc4bc
localeId: 67993753d910db250db64b3e
+ itemId: 580e64008c9a982ac9b8b754
breakpoint: main
url: >-
https://webflow.com/design/site-slug-4ec832?workflow=comment&commentId=679d2ddb5196117ad04d1ff8&pageId=679826b3b20b045e176bc4bc
@@ -134,6 +135,7 @@ service:
siteId: 679826b3b20b045e176bc4b5
pageId: 679826b3b20b045e176bc4bc
localeId: 67993753d910db250db64b3e
+ itemId: 580e64008c9a982ac9b8b754
breakpoint: main
url: >-
https://webflow.com/design/site-slug-4ec832?workflow=comment&commentId=679d2ddb5196117ad04d1ff8&pageId=679826b3b20b045e176bc4bc
diff --git a/.mock/definition/sites/forms.yml b/.mock/definition/sites/forms.yml
new file mode 100644
index 00000000..0d5d9a9d
--- /dev/null
+++ b/.mock/definition/sites/forms.yml
@@ -0,0 +1,309 @@
+imports:
+ root: ../__package__.yml
+service:
+ auth: false
+ base-path: ''
+ endpoints:
+ list-submissions-by-site:
+ path: /sites/{site_id}/form_submissions
+ method: GET
+ auth:
+ - OAuth2:
+ - forms:read
+ 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.
+
+
+ Add `elementId` when you want to filter form submissions to a specific
+ form in a site. You can get the `elementId` from the [List forms
+ endpoint](/data/reference/forms/forms/list) (displayed as
+ `formElementId` in the response).
+
+
+
+
+ When a form is used in a Webflow component definition, each instance of
+ the component will yield a unique form. Adding the `elementId` in this
+ request ensures this API response includes all submissions from that
+ core form, wherever that form is used in instantiated components.
+
+
+
+
+
+
+ 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
+ docs: Identifier for an element
+ offset:
+ type: optional
+ docs: >-
+ Offset used for pagination if the results have more than limit
+ records
+ limit:
+ type: optional
+ 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
+ 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
+ list-submissions-by-form-and-site:
+ path: /sites/{site_id}/forms/{form_id}/submissions
+ method: GET
+ auth:
+ - OAuth2:
+ - forms:read
+ docs: |
+ List form submissions for a given form within a specific site.
+
+ Required scope | `forms:read`
+ source:
+ openapi: ../../../openapi/referenced-specs/v2.yml
+ path-parameters:
+ site_id:
+ type: string
+ docs: Unique identifier for a Site
+ form_id:
+ type: string
+ docs: Unique identifier for a Form
+ display-name: List Form Submissions by Form and Site
+ request:
+ name: FormsListSubmissionsByFormAndSiteRequest
+ query-parameters:
+ offset:
+ type: optional
+ docs: >-
+ Offset used for pagination if the results have more than limit
+ records
+ limit:
+ type: optional
+ 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
+ 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: /sites/{site_id}/form_submissions/{form_submission_id}
+ method: GET
+ auth:
+ - OAuth2:
+ - forms:read
+ docs: |
+ Get information about a form submission within a specific site.
+
+ Required scope | `forms:read`
+ source:
+ openapi: ../../../openapi/referenced-specs/v2.yml
+ path-parameters:
+ site_id:
+ type: string
+ docs: Unique identifier for a Site
+ form_submission_id:
+ type: string
+ docs: Unique identifier for a Form Submission
+ display-name: Get Form Submission by Site
+ 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:
+ site_id: 580e63e98c9a982ac9b8b741
+ 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: /sites/{site_id}/form_submissions/{form_submission_id}
+ method: DELETE
+ auth:
+ - OAuth2:
+ - forms:write
+ docs: |
+ Delete a form submission within a specific site.
+
+ Required scope | `forms:write`
+ source:
+ openapi: ../../../openapi/referenced-specs/v2.yml
+ path-parameters:
+ site_id:
+ type: string
+ docs: Unique identifier for a Site
+ form_submission_id:
+ type: string
+ docs: Unique identifier for a Form Submission
+ display-name: Delete Form Submission by Site
+ errors:
+ - root.BadRequestError
+ - root.UnauthorizedError
+ - root.ForbiddenError
+ - root.NotFoundError
+ - root.ConflictError
+ - root.TooManyRequestsError
+ - root.InternalServerError
+ examples:
+ - path-parameters:
+ site_id: 580e63e98c9a982ac9b8b741
+ form_submission_id: 580e63e98c9a982ac9b8b741
+ update-submission:
+ path: /sites/{site_id}/form_submissions/{form_submission_id}
+ method: PATCH
+ auth:
+ - OAuth2:
+ - forms:write
+ docs: |
+ Update hidden fields on a form submission within a specific site.
+
+ Required scope | `forms:write`
+ source:
+ openapi: ../../../openapi/referenced-specs/v2.yml
+ path-parameters:
+ site_id:
+ type: string
+ docs: Unique identifier for a Site
+ form_submission_id:
+ type: string
+ docs: Unique identifier for a Form Submission
+ display-name: Modify Form Submission by Site
+ request:
+ name: FormsUpdateSubmissionRequest
+ body:
+ properties:
+ formSubmissionData:
+ type: optional