webflow-api 3.2.1 → 3.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.mock/definition/__package__.yml +20 -20
- package/.mock/definition/accessGroups.yml +12 -5
- package/.mock/definition/assets.yml +7 -4
- package/.mock/definition/collections/items.yml +14 -16
- package/.mock/definition/collections.yml +3 -0
- package/.mock/definition/comments.yml +1 -0
- package/.mock/definition/components.yml +16 -12
- package/.mock/definition/forms.yml +15 -88
- package/.mock/definition/items.yml +1 -0
- package/.mock/definition/orders.yml +82 -4
- package/.mock/definition/pages.yml +17 -8
- package/.mock/definition/products.yml +4 -4
- package/.mock/definition/scripts.yml +5 -1
- package/.mock/definition/sites/activityLogs.yml +8 -4
- package/.mock/definition/sites/comments.yml +14 -12
- package/.mock/definition/sites/forms.yml +316 -0
- package/.mock/definition/sites/scripts.yml +5 -4
- package/.mock/definition/sites.yml +24 -0
- package/.mock/definition/users.yml +66 -14
- package/.mock/definition/webhooks.yml +4 -0
- package/.mock/definition/workspaces/auditLogs.yml +4 -4
- package/.mock/fern.config.json +1 -1
- package/Client.js +2 -2
- package/LICENSE +21 -0
- package/api/resources/accessGroups/client/Client.d.ts +4 -2
- package/api/resources/accessGroups/client/Client.js +4 -2
- package/api/resources/accessGroups/client/requests/AccessGroupsListRequest.d.ts +2 -2
- package/api/resources/assets/client/Client.d.ts +2 -2
- package/api/resources/assets/client/Client.js +2 -2
- package/api/resources/assets/client/requests/AssetsListRequest.d.ts +2 -2
- package/api/resources/collections/resources/items/client/Client.d.ts +10 -12
- package/api/resources/collections/resources/items/client/Client.js +10 -12
- package/api/resources/collections/resources/items/client/requests/ItemsListItemsLiveRequest.d.ts +2 -2
- package/api/resources/collections/resources/items/client/requests/ItemsListItemsRequest.d.ts +2 -2
- package/api/resources/components/client/Client.d.ts +6 -6
- package/api/resources/components/client/Client.js +6 -6
- package/api/resources/components/client/requests/ComponentsGetContentRequest.d.ts +2 -2
- package/api/resources/components/client/requests/ComponentsGetPropertiesRequest.d.ts +2 -2
- package/api/resources/components/client/requests/ComponentsListRequest.d.ts +2 -2
- package/api/resources/forms/client/Client.d.ts +4 -31
- package/api/resources/forms/client/Client.js +4 -131
- package/api/resources/forms/client/requests/FormsListRequest.d.ts +2 -2
- package/api/resources/forms/client/requests/FormsListSubmissionsRequest.d.ts +2 -2
- package/api/resources/forms/client/requests/index.d.ts +0 -1
- package/api/resources/orders/client/Client.d.ts +2 -2
- package/api/resources/orders/client/Client.js +2 -2
- package/api/resources/orders/client/requests/OrdersListRequest.d.ts +2 -2
- package/api/resources/pages/client/Client.d.ts +4 -4
- package/api/resources/pages/client/Client.js +4 -4
- package/api/resources/pages/client/requests/PagesGetContentRequest.d.ts +2 -2
- package/api/resources/pages/client/requests/PagesListRequest.d.ts +2 -2
- package/api/resources/products/client/Client.d.ts +2 -2
- package/api/resources/products/client/Client.js +2 -2
- package/api/resources/products/client/requests/ProductsListRequest.d.ts +2 -2
- package/api/resources/sites/client/Client.d.ts +3 -0
- package/api/resources/sites/client/Client.js +5 -0
- package/api/resources/sites/resources/activityLogs/client/Client.d.ts +2 -2
- package/api/resources/sites/resources/activityLogs/client/Client.js +2 -2
- package/api/resources/sites/resources/activityLogs/client/requests/ActivityLogsListRequest.d.ts +2 -2
- package/api/resources/sites/resources/comments/client/Client.d.ts +6 -6
- package/api/resources/sites/resources/comments/client/Client.js +6 -6
- package/api/resources/sites/resources/comments/client/requests/CommentsGetCommentThreadRequest.d.ts +2 -2
- package/api/resources/sites/resources/comments/client/requests/CommentsListCommentRepliesRequest.d.ts +2 -2
- package/api/resources/sites/resources/comments/client/requests/CommentsListCommentThreadsRequest.d.ts +2 -2
- package/api/resources/sites/resources/forms/client/Client.d.ts +157 -0
- package/api/resources/sites/resources/forms/client/Client.js +662 -0
- package/api/resources/sites/resources/forms/client/index.d.ts +2 -0
- package/api/resources/sites/resources/forms/client/index.js +17 -0
- package/api/resources/{forms → sites/resources/forms}/client/requests/FormsListSubmissionsBySiteRequest.d.ts +2 -2
- package/api/resources/sites/resources/forms/client/requests/FormsListSubmissionsRequest.d.ts +20 -0
- package/api/resources/sites/resources/forms/client/requests/FormsUpdateSubmissionRequest.d.ts +11 -0
- package/api/resources/sites/resources/forms/client/requests/FormsUpdateSubmissionRequest.js +5 -0
- package/api/resources/sites/resources/forms/client/requests/index.d.ts +3 -0
- package/api/resources/sites/resources/forms/client/requests/index.js +2 -0
- package/api/resources/sites/resources/forms/index.d.ts +1 -0
- package/api/resources/sites/resources/forms/index.js +17 -0
- package/api/resources/sites/resources/index.d.ts +2 -0
- package/api/resources/sites/resources/index.js +3 -1
- package/api/resources/sites/resources/scripts/client/Client.d.ts +2 -2
- package/api/resources/sites/resources/scripts/client/Client.js +2 -2
- package/api/resources/sites/resources/scripts/client/requests/ScriptsListCustomCodeBlocksRequest.d.ts +2 -2
- package/api/resources/users/client/Client.d.ts +12 -2
- package/api/resources/users/client/Client.js +12 -2
- package/api/resources/users/client/requests/UsersListRequest.d.ts +2 -2
- package/api/resources/workspaces/resources/auditLogs/client/Client.d.ts +2 -2
- package/api/resources/workspaces/resources/auditLogs/client/Client.js +2 -2
- package/api/resources/workspaces/resources/auditLogs/client/requests/AuditLogsGetWorkspaceAuditLogsRequest.d.ts +2 -2
- package/dist/Client.js +2 -2
- package/dist/api/resources/accessGroups/client/Client.d.ts +4 -2
- package/dist/api/resources/accessGroups/client/Client.js +4 -2
- package/dist/api/resources/accessGroups/client/requests/AccessGroupsListRequest.d.ts +2 -2
- package/dist/api/resources/assets/client/Client.d.ts +2 -2
- package/dist/api/resources/assets/client/Client.js +2 -2
- package/dist/api/resources/assets/client/requests/AssetsListRequest.d.ts +2 -2
- package/dist/api/resources/collections/resources/items/client/Client.d.ts +10 -12
- package/dist/api/resources/collections/resources/items/client/Client.js +10 -12
- package/dist/api/resources/collections/resources/items/client/requests/ItemsListItemsLiveRequest.d.ts +2 -2
- package/dist/api/resources/collections/resources/items/client/requests/ItemsListItemsRequest.d.ts +2 -2
- package/dist/api/resources/components/client/Client.d.ts +6 -6
- package/dist/api/resources/components/client/Client.js +6 -6
- package/dist/api/resources/components/client/requests/ComponentsGetContentRequest.d.ts +2 -2
- package/dist/api/resources/components/client/requests/ComponentsGetPropertiesRequest.d.ts +2 -2
- package/dist/api/resources/components/client/requests/ComponentsListRequest.d.ts +2 -2
- package/dist/api/resources/forms/client/Client.d.ts +4 -31
- package/dist/api/resources/forms/client/Client.js +4 -131
- package/dist/api/resources/forms/client/requests/FormsListRequest.d.ts +2 -2
- package/dist/api/resources/forms/client/requests/FormsListSubmissionsRequest.d.ts +2 -2
- package/dist/api/resources/forms/client/requests/index.d.ts +0 -1
- package/dist/api/resources/orders/client/Client.d.ts +2 -2
- package/dist/api/resources/orders/client/Client.js +2 -2
- package/dist/api/resources/orders/client/requests/OrdersListRequest.d.ts +2 -2
- package/dist/api/resources/pages/client/Client.d.ts +4 -4
- package/dist/api/resources/pages/client/Client.js +4 -4
- package/dist/api/resources/pages/client/requests/PagesGetContentRequest.d.ts +2 -2
- package/dist/api/resources/pages/client/requests/PagesListRequest.d.ts +2 -2
- package/dist/api/resources/products/client/Client.d.ts +2 -2
- package/dist/api/resources/products/client/Client.js +2 -2
- package/dist/api/resources/products/client/requests/ProductsListRequest.d.ts +2 -2
- package/dist/api/resources/sites/client/Client.d.ts +3 -0
- package/dist/api/resources/sites/client/Client.js +5 -0
- package/dist/api/resources/sites/resources/activityLogs/client/Client.d.ts +2 -2
- package/dist/api/resources/sites/resources/activityLogs/client/Client.js +2 -2
- package/dist/api/resources/sites/resources/activityLogs/client/requests/ActivityLogsListRequest.d.ts +2 -2
- package/dist/api/resources/sites/resources/comments/client/Client.d.ts +6 -6
- package/dist/api/resources/sites/resources/comments/client/Client.js +6 -6
- package/dist/api/resources/sites/resources/comments/client/requests/CommentsGetCommentThreadRequest.d.ts +2 -2
- package/dist/api/resources/sites/resources/comments/client/requests/CommentsListCommentRepliesRequest.d.ts +2 -2
- package/dist/api/resources/sites/resources/comments/client/requests/CommentsListCommentThreadsRequest.d.ts +2 -2
- package/dist/api/resources/sites/resources/forms/client/Client.d.ts +157 -0
- package/dist/api/resources/sites/resources/forms/client/Client.js +662 -0
- package/dist/api/resources/sites/resources/forms/client/index.d.ts +2 -0
- package/dist/api/resources/sites/resources/forms/client/index.js +17 -0
- package/dist/api/resources/{forms → sites/resources/forms}/client/requests/FormsListSubmissionsBySiteRequest.d.ts +2 -2
- package/dist/api/resources/sites/resources/forms/client/requests/FormsListSubmissionsBySiteRequest.js +5 -0
- package/dist/api/resources/sites/resources/forms/client/requests/FormsListSubmissionsRequest.d.ts +20 -0
- package/dist/api/resources/sites/resources/forms/client/requests/FormsListSubmissionsRequest.js +5 -0
- package/dist/api/resources/sites/resources/forms/client/requests/FormsUpdateSubmissionRequest.d.ts +11 -0
- package/dist/api/resources/sites/resources/forms/client/requests/FormsUpdateSubmissionRequest.js +5 -0
- package/dist/api/resources/sites/resources/forms/client/requests/index.d.ts +3 -0
- package/dist/api/resources/sites/resources/forms/client/requests/index.js +2 -0
- package/dist/api/resources/sites/resources/forms/index.d.ts +1 -0
- package/dist/api/resources/sites/resources/forms/index.js +17 -0
- package/dist/api/resources/sites/resources/index.d.ts +2 -0
- package/dist/api/resources/sites/resources/index.js +3 -1
- package/dist/api/resources/sites/resources/scripts/client/Client.d.ts +2 -2
- package/dist/api/resources/sites/resources/scripts/client/Client.js +2 -2
- package/dist/api/resources/sites/resources/scripts/client/requests/ScriptsListCustomCodeBlocksRequest.d.ts +2 -2
- package/dist/api/resources/users/client/Client.d.ts +12 -2
- package/dist/api/resources/users/client/Client.js +12 -2
- package/dist/api/resources/users/client/requests/UsersListRequest.d.ts +2 -2
- package/dist/api/resources/workspaces/resources/auditLogs/client/Client.d.ts +2 -2
- package/dist/api/resources/workspaces/resources/auditLogs/client/Client.js +2 -2
- package/dist/api/resources/workspaces/resources/auditLogs/client/requests/AuditLogsGetWorkspaceAuditLogsRequest.d.ts +2 -2
- package/dist/serialization/resources/sites/resources/forms/client/index.d.ts +1 -0
- package/dist/serialization/resources/sites/resources/forms/client/index.js +17 -0
- package/dist/serialization/resources/sites/resources/forms/client/requests/FormsUpdateSubmissionRequest.d.ts +12 -0
- package/dist/serialization/resources/sites/resources/forms/client/requests/FormsUpdateSubmissionRequest.js +43 -0
- package/dist/serialization/resources/sites/resources/forms/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/sites/resources/forms/client/requests/index.js +5 -0
- package/dist/serialization/resources/sites/resources/forms/index.d.ts +1 -0
- package/dist/serialization/resources/sites/resources/forms/index.js +17 -0
- package/dist/serialization/resources/sites/resources/index.d.ts +2 -0
- package/dist/serialization/resources/sites/resources/index.js +3 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/dist/wrapper/FormsClient.d.ts +37 -0
- package/dist/wrapper/FormsClient.js +193 -0
- package/dist/wrapper/ItemsClient.js +18 -14
- package/dist/wrapper/PagesClient.js +6 -5
- package/dist/wrapper/WebflowClient.d.ts +3 -0
- package/dist/wrapper/WebflowClient.js +6 -5
- package/jest.config.mjs +26 -5
- package/package.json +3 -2
- package/reference.md +458 -125
- package/serialization/resources/sites/resources/forms/client/index.d.ts +1 -0
- package/serialization/resources/sites/resources/forms/client/index.js +17 -0
- package/serialization/resources/sites/resources/forms/client/requests/FormsUpdateSubmissionRequest.d.ts +12 -0
- package/serialization/resources/sites/resources/forms/client/requests/FormsUpdateSubmissionRequest.js +43 -0
- package/serialization/resources/sites/resources/forms/client/requests/index.d.ts +1 -0
- package/serialization/resources/sites/resources/forms/client/requests/index.js +5 -0
- package/serialization/resources/sites/resources/forms/index.d.ts +1 -0
- package/serialization/resources/sites/resources/forms/index.js +17 -0
- package/serialization/resources/sites/resources/index.d.ts +2 -0
- package/serialization/resources/sites/resources/index.js +3 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/wrapper/FormsClient.d.ts +37 -0
- package/wrapper/FormsClient.js +193 -0
- package/wrapper/ItemsClient.js +18 -14
- package/wrapper/PagesClient.js +6 -5
- package/wrapper/WebflowClient.d.ts +3 -0
- package/wrapper/WebflowClient.js +6 -5
- /package/api/resources/{forms → sites/resources/forms}/client/requests/FormsListSubmissionsBySiteRequest.js +0 -0
- /package/{dist/api/resources/forms/client/requests/FormsListSubmissionsBySiteRequest.js → api/resources/sites/resources/forms/client/requests/FormsListSubmissionsRequest.js} +0 -0
|
@@ -61,6 +61,8 @@ class AccessGroups {
|
|
|
61
61
|
this._options = _options;
|
|
62
62
|
}
|
|
63
63
|
/**
|
|
64
|
+
* <Warning>As of **January 29, 2026**, User Accounts functionality has been disabled on all Webflow sites. This endpoint is no longer available.</Warning>
|
|
65
|
+
*
|
|
64
66
|
* Get a list of access groups for a site
|
|
65
67
|
*
|
|
66
68
|
* Required scope | `users:read`
|
|
@@ -78,8 +80,8 @@ class AccessGroups {
|
|
|
78
80
|
*
|
|
79
81
|
* @example
|
|
80
82
|
* await client.accessGroups.list("580e63e98c9a982ac9b8b741", {
|
|
81
|
-
* offset: 1
|
|
82
|
-
* limit: 1
|
|
83
|
+
* offset: 1,
|
|
84
|
+
* limit: 1,
|
|
83
85
|
* sort: "CreatedOn"
|
|
84
86
|
* })
|
|
85
87
|
*/
|
|
@@ -47,8 +47,8 @@ export declare class Assets {
|
|
|
47
47
|
*
|
|
48
48
|
* @example
|
|
49
49
|
* await client.assets.list("580e63e98c9a982ac9b8b741", {
|
|
50
|
-
* offset: 1
|
|
51
|
-
* limit: 1
|
|
50
|
+
* offset: 1,
|
|
51
|
+
* limit: 1
|
|
52
52
|
* })
|
|
53
53
|
*/
|
|
54
54
|
list(siteId: string, request?: Webflow.AssetsListRequest, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<Webflow.Assets>;
|
|
@@ -45,8 +45,8 @@ export declare class Items {
|
|
|
45
45
|
* @example
|
|
46
46
|
* await client.collections.items.listItems("580e63fc8c9a982ac9b8b745", {
|
|
47
47
|
* cmsLocaleId: "cmsLocaleId",
|
|
48
|
-
* offset: 1
|
|
49
|
-
* limit: 1
|
|
48
|
+
* offset: 1,
|
|
49
|
+
* limit: 1,
|
|
50
50
|
* name: "name",
|
|
51
51
|
* slug: "slug",
|
|
52
52
|
* sortBy: "lastPublished",
|
|
@@ -217,10 +217,9 @@ export declare class Items {
|
|
|
217
217
|
/**
|
|
218
218
|
* List all published items in a collection.
|
|
219
219
|
*
|
|
220
|
-
* <
|
|
221
|
-
*
|
|
222
|
-
*
|
|
223
|
-
* </Note>
|
|
220
|
+
* <Tip title="Serve data with the Content Delivery API">
|
|
221
|
+
* 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.
|
|
222
|
+
* </Tip>
|
|
224
223
|
*
|
|
225
224
|
* Required scope | `CMS:read`
|
|
226
225
|
*
|
|
@@ -237,8 +236,8 @@ export declare class Items {
|
|
|
237
236
|
* @example
|
|
238
237
|
* await client.collections.items.listItemsLive("580e63fc8c9a982ac9b8b745", {
|
|
239
238
|
* cmsLocaleId: "cmsLocaleId",
|
|
240
|
-
* offset: 1
|
|
241
|
-
* limit: 1
|
|
239
|
+
* offset: 1,
|
|
240
|
+
* limit: 1,
|
|
242
241
|
* name: "name",
|
|
243
242
|
* slug: "slug",
|
|
244
243
|
* sortBy: "lastPublished",
|
|
@@ -534,10 +533,9 @@ export declare class Items {
|
|
|
534
533
|
/**
|
|
535
534
|
* Get details of a selected Collection live Item.
|
|
536
535
|
*
|
|
537
|
-
* <
|
|
538
|
-
*
|
|
539
|
-
*
|
|
540
|
-
* </Note>
|
|
536
|
+
* <Tip title="Serve data with the Content Delivery API">
|
|
537
|
+
* 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.
|
|
538
|
+
* </Tip>
|
|
541
539
|
*
|
|
542
540
|
* Required scope | `CMS:read`
|
|
543
541
|
*
|
|
@@ -89,8 +89,8 @@ class Items {
|
|
|
89
89
|
* @example
|
|
90
90
|
* await client.collections.items.listItems("580e63fc8c9a982ac9b8b745", {
|
|
91
91
|
* cmsLocaleId: "cmsLocaleId",
|
|
92
|
-
* offset: 1
|
|
93
|
-
* limit: 1
|
|
92
|
+
* offset: 1,
|
|
93
|
+
* limit: 1,
|
|
94
94
|
* name: "name",
|
|
95
95
|
* slug: "slug",
|
|
96
96
|
* sortBy: "lastPublished",
|
|
@@ -671,10 +671,9 @@ class Items {
|
|
|
671
671
|
/**
|
|
672
672
|
* List all published items in a collection.
|
|
673
673
|
*
|
|
674
|
-
* <
|
|
675
|
-
*
|
|
676
|
-
*
|
|
677
|
-
* </Note>
|
|
674
|
+
* <Tip title="Serve data with the Content Delivery API">
|
|
675
|
+
* 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.
|
|
676
|
+
* </Tip>
|
|
678
677
|
*
|
|
679
678
|
* Required scope | `CMS:read`
|
|
680
679
|
*
|
|
@@ -691,8 +690,8 @@ class Items {
|
|
|
691
690
|
* @example
|
|
692
691
|
* await client.collections.items.listItemsLive("580e63fc8c9a982ac9b8b745", {
|
|
693
692
|
* cmsLocaleId: "cmsLocaleId",
|
|
694
|
-
* offset: 1
|
|
695
|
-
* limit: 1
|
|
693
|
+
* offset: 1,
|
|
694
|
+
* limit: 1,
|
|
696
695
|
* name: "name",
|
|
697
696
|
* slug: "slug",
|
|
698
697
|
* sortBy: "lastPublished",
|
|
@@ -1771,10 +1770,9 @@ class Items {
|
|
|
1771
1770
|
/**
|
|
1772
1771
|
* Get details of a selected Collection live Item.
|
|
1773
1772
|
*
|
|
1774
|
-
* <
|
|
1775
|
-
*
|
|
1776
|
-
*
|
|
1777
|
-
* </Note>
|
|
1773
|
+
* <Tip title="Serve data with the Content Delivery API">
|
|
1774
|
+
* 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.
|
|
1775
|
+
* </Tip>
|
|
1778
1776
|
*
|
|
1779
1777
|
* Required scope | `CMS:read`
|
|
1780
1778
|
*
|
|
@@ -45,8 +45,8 @@ export declare class Components {
|
|
|
45
45
|
* @example
|
|
46
46
|
* await client.components.list("580e63e98c9a982ac9b8b741", {
|
|
47
47
|
* branchId: "68026fa68ef6dc744c75b833",
|
|
48
|
-
* limit: 1
|
|
49
|
-
* offset: 1
|
|
48
|
+
* limit: 1,
|
|
49
|
+
* offset: 1
|
|
50
50
|
* })
|
|
51
51
|
*/
|
|
52
52
|
list(siteId: string, request?: Webflow.ComponentsListRequest, requestOptions?: Components.RequestOptions): core.HttpResponsePromise<Webflow.ComponentList>;
|
|
@@ -74,8 +74,8 @@ export declare class Components {
|
|
|
74
74
|
* await client.components.getContent("580e63e98c9a982ac9b8b741", "8505ba55-ef72-629e-f85c-33e4b703d48b", {
|
|
75
75
|
* localeId: "65427cf400e02b306eaa04a0",
|
|
76
76
|
* branchId: "68026fa68ef6dc744c75b833",
|
|
77
|
-
* limit: 1
|
|
78
|
-
* offset: 1
|
|
77
|
+
* limit: 1,
|
|
78
|
+
* offset: 1
|
|
79
79
|
* })
|
|
80
80
|
*/
|
|
81
81
|
getContent(siteId: string, componentId: string, request?: Webflow.ComponentsGetContentRequest, requestOptions?: Components.RequestOptions): core.HttpResponsePromise<Webflow.ComponentDom>;
|
|
@@ -168,8 +168,8 @@ export declare class Components {
|
|
|
168
168
|
* await client.components.getProperties("580e63e98c9a982ac9b8b741", "8505ba55-ef72-629e-f85c-33e4b703d48b", {
|
|
169
169
|
* localeId: "65427cf400e02b306eaa04a0",
|
|
170
170
|
* branchId: "68026fa68ef6dc744c75b833",
|
|
171
|
-
* limit: 1
|
|
172
|
-
* offset: 1
|
|
171
|
+
* limit: 1,
|
|
172
|
+
* offset: 1
|
|
173
173
|
* })
|
|
174
174
|
*/
|
|
175
175
|
getProperties(siteId: string, componentId: string, request?: Webflow.ComponentsGetPropertiesRequest, requestOptions?: Components.RequestOptions): core.HttpResponsePromise<Webflow.ComponentProperties>;
|
|
@@ -89,8 +89,8 @@ class Components {
|
|
|
89
89
|
* @example
|
|
90
90
|
* await client.components.list("580e63e98c9a982ac9b8b741", {
|
|
91
91
|
* branchId: "68026fa68ef6dc744c75b833",
|
|
92
|
-
* limit: 1
|
|
93
|
-
* offset: 1
|
|
92
|
+
* limit: 1,
|
|
93
|
+
* offset: 1
|
|
94
94
|
* })
|
|
95
95
|
*/
|
|
96
96
|
list(siteId, request = {}, requestOptions) {
|
|
@@ -216,8 +216,8 @@ class Components {
|
|
|
216
216
|
* await client.components.getContent("580e63e98c9a982ac9b8b741", "8505ba55-ef72-629e-f85c-33e4b703d48b", {
|
|
217
217
|
* localeId: "65427cf400e02b306eaa04a0",
|
|
218
218
|
* branchId: "68026fa68ef6dc744c75b833",
|
|
219
|
-
* limit: 1
|
|
220
|
-
* offset: 1
|
|
219
|
+
* limit: 1,
|
|
220
|
+
* offset: 1
|
|
221
221
|
* })
|
|
222
222
|
*/
|
|
223
223
|
getContent(siteId, componentId, request = {}, requestOptions) {
|
|
@@ -515,8 +515,8 @@ class Components {
|
|
|
515
515
|
* await client.components.getProperties("580e63e98c9a982ac9b8b741", "8505ba55-ef72-629e-f85c-33e4b703d48b", {
|
|
516
516
|
* localeId: "65427cf400e02b306eaa04a0",
|
|
517
517
|
* branchId: "68026fa68ef6dc744c75b833",
|
|
518
|
-
* limit: 1
|
|
519
|
-
* offset: 1
|
|
518
|
+
* limit: 1,
|
|
519
|
+
* offset: 1
|
|
520
520
|
* })
|
|
521
521
|
*/
|
|
522
522
|
getProperties(siteId, componentId, request = {}, requestOptions) {
|
|
@@ -49,8 +49,8 @@ export declare class Forms {
|
|
|
49
49
|
*
|
|
50
50
|
* @example
|
|
51
51
|
* await client.forms.list("580e63e98c9a982ac9b8b741", {
|
|
52
|
-
* limit: 1
|
|
53
|
-
* offset: 1
|
|
52
|
+
* limit: 1,
|
|
53
|
+
* offset: 1
|
|
54
54
|
* })
|
|
55
55
|
*/
|
|
56
56
|
list(siteId: string, request?: Webflow.FormsListRequest, requestOptions?: Forms.RequestOptions): core.HttpResponsePromise<Webflow.FormList>;
|
|
@@ -99,8 +99,8 @@ export declare class Forms {
|
|
|
99
99
|
*
|
|
100
100
|
* @example
|
|
101
101
|
* await client.forms.listSubmissions("580e63e98c9a982ac9b8b741", {
|
|
102
|
-
* offset: 1
|
|
103
|
-
* limit: 1
|
|
102
|
+
* offset: 1,
|
|
103
|
+
* limit: 1
|
|
104
104
|
* })
|
|
105
105
|
*/
|
|
106
106
|
listSubmissions(formId: string, request?: Webflow.FormsListSubmissionsRequest, requestOptions?: Forms.RequestOptions): core.HttpResponsePromise<Webflow.FormSubmissionList>;
|
|
@@ -169,32 +169,5 @@ export declare class Forms {
|
|
|
169
169
|
*/
|
|
170
170
|
updateSubmission(formSubmissionId: string, request?: Webflow.FormsUpdateSubmissionRequest, requestOptions?: Forms.RequestOptions): core.HttpResponsePromise<Webflow.FormSubmission>;
|
|
171
171
|
private __updateSubmission;
|
|
172
|
-
/**
|
|
173
|
-
* 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).
|
|
174
|
-
*
|
|
175
|
-
*
|
|
176
|
-
*
|
|
177
|
-
* Required scope | `forms:read`
|
|
178
|
-
*
|
|
179
|
-
* @param {string} siteId - Unique identifier for a Site
|
|
180
|
-
* @param {Webflow.FormsListSubmissionsBySiteRequest} request
|
|
181
|
-
* @param {Forms.RequestOptions} requestOptions - Request-specific configuration.
|
|
182
|
-
*
|
|
183
|
-
* @throws {@link Webflow.BadRequestError}
|
|
184
|
-
* @throws {@link Webflow.UnauthorizedError}
|
|
185
|
-
* @throws {@link Webflow.ForbiddenError}
|
|
186
|
-
* @throws {@link Webflow.NotFoundError}
|
|
187
|
-
* @throws {@link Webflow.TooManyRequestsError}
|
|
188
|
-
* @throws {@link Webflow.InternalServerError}
|
|
189
|
-
*
|
|
190
|
-
* @example
|
|
191
|
-
* await client.forms.listSubmissionsBySite("580e63e98c9a982ac9b8b741", {
|
|
192
|
-
* elementId: "18259716-3e5a-646a-5f41-5dc4b9405aa0",
|
|
193
|
-
* offset: 1.1,
|
|
194
|
-
* limit: 1.1
|
|
195
|
-
* })
|
|
196
|
-
*/
|
|
197
|
-
listSubmissionsBySite(siteId: string, request?: Webflow.FormsListSubmissionsBySiteRequest, requestOptions?: Forms.RequestOptions): core.HttpResponsePromise<Webflow.FormSubmissionList>;
|
|
198
|
-
private __listSubmissionsBySite;
|
|
199
172
|
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
200
173
|
}
|
|
@@ -82,8 +82,8 @@ class Forms {
|
|
|
82
82
|
*
|
|
83
83
|
* @example
|
|
84
84
|
* await client.forms.list("580e63e98c9a982ac9b8b741", {
|
|
85
|
-
* limit: 1
|
|
86
|
-
* offset: 1
|
|
85
|
+
* limit: 1,
|
|
86
|
+
* offset: 1
|
|
87
87
|
* })
|
|
88
88
|
*/
|
|
89
89
|
list(siteId, request = {}, requestOptions) {
|
|
@@ -319,8 +319,8 @@ class Forms {
|
|
|
319
319
|
*
|
|
320
320
|
* @example
|
|
321
321
|
* await client.forms.listSubmissions("580e63e98c9a982ac9b8b741", {
|
|
322
|
-
* offset: 1
|
|
323
|
-
* limit: 1
|
|
322
|
+
* offset: 1,
|
|
323
|
+
* limit: 1
|
|
324
324
|
* })
|
|
325
325
|
*/
|
|
326
326
|
listSubmissions(formId, request = {}, requestOptions) {
|
|
@@ -752,133 +752,6 @@ class Forms {
|
|
|
752
752
|
}
|
|
753
753
|
});
|
|
754
754
|
}
|
|
755
|
-
/**
|
|
756
|
-
* 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).
|
|
757
|
-
*
|
|
758
|
-
*
|
|
759
|
-
*
|
|
760
|
-
* Required scope | `forms:read`
|
|
761
|
-
*
|
|
762
|
-
* @param {string} siteId - Unique identifier for a Site
|
|
763
|
-
* @param {Webflow.FormsListSubmissionsBySiteRequest} request
|
|
764
|
-
* @param {Forms.RequestOptions} requestOptions - Request-specific configuration.
|
|
765
|
-
*
|
|
766
|
-
* @throws {@link Webflow.BadRequestError}
|
|
767
|
-
* @throws {@link Webflow.UnauthorizedError}
|
|
768
|
-
* @throws {@link Webflow.ForbiddenError}
|
|
769
|
-
* @throws {@link Webflow.NotFoundError}
|
|
770
|
-
* @throws {@link Webflow.TooManyRequestsError}
|
|
771
|
-
* @throws {@link Webflow.InternalServerError}
|
|
772
|
-
*
|
|
773
|
-
* @example
|
|
774
|
-
* await client.forms.listSubmissionsBySite("580e63e98c9a982ac9b8b741", {
|
|
775
|
-
* elementId: "18259716-3e5a-646a-5f41-5dc4b9405aa0",
|
|
776
|
-
* offset: 1.1,
|
|
777
|
-
* limit: 1.1
|
|
778
|
-
* })
|
|
779
|
-
*/
|
|
780
|
-
listSubmissionsBySite(siteId, request = {}, requestOptions) {
|
|
781
|
-
return core.HttpResponsePromise.fromPromise(this.__listSubmissionsBySite(siteId, request, requestOptions));
|
|
782
|
-
}
|
|
783
|
-
__listSubmissionsBySite(siteId_1) {
|
|
784
|
-
return __awaiter(this, arguments, void 0, function* (siteId, request = {}, requestOptions) {
|
|
785
|
-
var _a, _b, _c;
|
|
786
|
-
const { elementId, offset, limit } = request;
|
|
787
|
-
const _queryParams = {};
|
|
788
|
-
if (elementId != null) {
|
|
789
|
-
_queryParams["elementId"] = elementId;
|
|
790
|
-
}
|
|
791
|
-
if (offset != null) {
|
|
792
|
-
_queryParams["offset"] = offset.toString();
|
|
793
|
-
}
|
|
794
|
-
if (limit != null) {
|
|
795
|
-
_queryParams["limit"] = limit.toString();
|
|
796
|
-
}
|
|
797
|
-
const _response = yield core.fetcher({
|
|
798
|
-
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.WebflowEnvironment.DataApi)
|
|
799
|
-
.base, `sites/${encodeURIComponent(siteId)}/form_submissions`),
|
|
800
|
-
method: "GET",
|
|
801
|
-
headers: (0, headers_js_1.mergeHeaders)((_c = this._options) === null || _c === void 0 ? void 0 : _c.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
802
|
-
queryParameters: _queryParams,
|
|
803
|
-
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
804
|
-
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
805
|
-
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
806
|
-
});
|
|
807
|
-
if (_response.ok) {
|
|
808
|
-
return {
|
|
809
|
-
data: serializers.FormSubmissionList.parseOrThrow(_response.body, {
|
|
810
|
-
unrecognizedObjectKeys: "passthrough",
|
|
811
|
-
allowUnrecognizedUnionMembers: true,
|
|
812
|
-
allowUnrecognizedEnumValues: true,
|
|
813
|
-
skipValidation: true,
|
|
814
|
-
breadcrumbsPrefix: ["response"],
|
|
815
|
-
}),
|
|
816
|
-
rawResponse: _response.rawResponse,
|
|
817
|
-
};
|
|
818
|
-
}
|
|
819
|
-
if (_response.error.reason === "status-code") {
|
|
820
|
-
switch (_response.error.statusCode) {
|
|
821
|
-
case 400:
|
|
822
|
-
throw new Webflow.BadRequestError(_response.error.body, _response.rawResponse);
|
|
823
|
-
case 401:
|
|
824
|
-
throw new Webflow.UnauthorizedError(serializers.Error_.parseOrThrow(_response.error.body, {
|
|
825
|
-
unrecognizedObjectKeys: "passthrough",
|
|
826
|
-
allowUnrecognizedUnionMembers: true,
|
|
827
|
-
allowUnrecognizedEnumValues: true,
|
|
828
|
-
skipValidation: true,
|
|
829
|
-
breadcrumbsPrefix: ["response"],
|
|
830
|
-
}), _response.rawResponse);
|
|
831
|
-
case 403:
|
|
832
|
-
throw new Webflow.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
833
|
-
case 404:
|
|
834
|
-
throw new Webflow.NotFoundError(serializers.Error_.parseOrThrow(_response.error.body, {
|
|
835
|
-
unrecognizedObjectKeys: "passthrough",
|
|
836
|
-
allowUnrecognizedUnionMembers: true,
|
|
837
|
-
allowUnrecognizedEnumValues: true,
|
|
838
|
-
skipValidation: true,
|
|
839
|
-
breadcrumbsPrefix: ["response"],
|
|
840
|
-
}), _response.rawResponse);
|
|
841
|
-
case 429:
|
|
842
|
-
throw new Webflow.TooManyRequestsError(serializers.Error_.parseOrThrow(_response.error.body, {
|
|
843
|
-
unrecognizedObjectKeys: "passthrough",
|
|
844
|
-
allowUnrecognizedUnionMembers: true,
|
|
845
|
-
allowUnrecognizedEnumValues: true,
|
|
846
|
-
skipValidation: true,
|
|
847
|
-
breadcrumbsPrefix: ["response"],
|
|
848
|
-
}), _response.rawResponse);
|
|
849
|
-
case 500:
|
|
850
|
-
throw new Webflow.InternalServerError(serializers.Error_.parseOrThrow(_response.error.body, {
|
|
851
|
-
unrecognizedObjectKeys: "passthrough",
|
|
852
|
-
allowUnrecognizedUnionMembers: true,
|
|
853
|
-
allowUnrecognizedEnumValues: true,
|
|
854
|
-
skipValidation: true,
|
|
855
|
-
breadcrumbsPrefix: ["response"],
|
|
856
|
-
}), _response.rawResponse);
|
|
857
|
-
default:
|
|
858
|
-
throw new errors.WebflowError({
|
|
859
|
-
statusCode: _response.error.statusCode,
|
|
860
|
-
body: _response.error.body,
|
|
861
|
-
rawResponse: _response.rawResponse,
|
|
862
|
-
});
|
|
863
|
-
}
|
|
864
|
-
}
|
|
865
|
-
switch (_response.error.reason) {
|
|
866
|
-
case "non-json":
|
|
867
|
-
throw new errors.WebflowError({
|
|
868
|
-
statusCode: _response.error.statusCode,
|
|
869
|
-
body: _response.error.rawBody,
|
|
870
|
-
rawResponse: _response.rawResponse,
|
|
871
|
-
});
|
|
872
|
-
case "timeout":
|
|
873
|
-
throw new errors.WebflowTimeoutError("Timeout exceeded when calling GET /sites/{site_id}/form_submissions.");
|
|
874
|
-
case "unknown":
|
|
875
|
-
throw new errors.WebflowError({
|
|
876
|
-
message: _response.error.errorMessage,
|
|
877
|
-
rawResponse: _response.rawResponse,
|
|
878
|
-
});
|
|
879
|
-
}
|
|
880
|
-
});
|
|
881
|
-
}
|
|
882
755
|
_getAuthorizationHeader() {
|
|
883
756
|
return __awaiter(this, void 0, void 0, function* () {
|
|
884
757
|
const bearer = yield core.Supplier.get(this._options.accessToken);
|
|
@@ -1,4 +1,3 @@
|
|
|
1
1
|
export { type FormsListRequest } from "./FormsListRequest";
|
|
2
2
|
export { type FormsListSubmissionsRequest } from "./FormsListSubmissionsRequest";
|
|
3
3
|
export { type FormsUpdateSubmissionRequest } from "./FormsUpdateSubmissionRequest";
|
|
4
|
-
export { type FormsListSubmissionsBySiteRequest } from "./FormsListSubmissionsBySiteRequest";
|
|
@@ -50,8 +50,8 @@ export declare class Orders {
|
|
|
50
50
|
* @example
|
|
51
51
|
* await client.orders.list("580e63e98c9a982ac9b8b741", {
|
|
52
52
|
* status: "pending",
|
|
53
|
-
* offset: 1
|
|
54
|
-
* limit: 1
|
|
53
|
+
* offset: 1,
|
|
54
|
+
* limit: 1
|
|
55
55
|
* })
|
|
56
56
|
*/
|
|
57
57
|
list(siteId: string, request?: Webflow.OrdersListRequest, requestOptions?: Orders.RequestOptions): core.HttpResponsePromise<Webflow.OrderList>;
|
|
@@ -51,8 +51,8 @@ export declare class Pages {
|
|
|
51
51
|
* @example
|
|
52
52
|
* await client.pages.list("580e63e98c9a982ac9b8b741", {
|
|
53
53
|
* localeId: "65427cf400e02b306eaa04a0",
|
|
54
|
-
* limit: 1
|
|
55
|
-
* offset: 1
|
|
54
|
+
* limit: 1,
|
|
55
|
+
* offset: 1
|
|
56
56
|
* })
|
|
57
57
|
*/
|
|
58
58
|
list(siteId: string, request?: Webflow.PagesListRequest, requestOptions?: Pages.RequestOptions): core.HttpResponsePromise<Webflow.PageList>;
|
|
@@ -134,8 +134,8 @@ export declare class Pages {
|
|
|
134
134
|
* @example
|
|
135
135
|
* await client.pages.getContent("63c720f9347c2139b248e552", {
|
|
136
136
|
* localeId: "65427cf400e02b306eaa04a0",
|
|
137
|
-
* limit: 1
|
|
138
|
-
* offset: 1
|
|
137
|
+
* limit: 1,
|
|
138
|
+
* offset: 1
|
|
139
139
|
* })
|
|
140
140
|
*/
|
|
141
141
|
getContent(pageId: string, request?: Webflow.PagesGetContentRequest, requestOptions?: Pages.RequestOptions): core.HttpResponsePromise<Webflow.Dom>;
|
|
@@ -97,8 +97,8 @@ class Pages {
|
|
|
97
97
|
* @example
|
|
98
98
|
* await client.pages.list("580e63e98c9a982ac9b8b741", {
|
|
99
99
|
* localeId: "65427cf400e02b306eaa04a0",
|
|
100
|
-
* limit: 1
|
|
101
|
-
* offset: 1
|
|
100
|
+
* limit: 1,
|
|
101
|
+
* offset: 1
|
|
102
102
|
* })
|
|
103
103
|
*/
|
|
104
104
|
list(siteId, request = {}, requestOptions) {
|
|
@@ -469,8 +469,8 @@ class Pages {
|
|
|
469
469
|
* @example
|
|
470
470
|
* await client.pages.getContent("63c720f9347c2139b248e552", {
|
|
471
471
|
* localeId: "65427cf400e02b306eaa04a0",
|
|
472
|
-
* limit: 1
|
|
473
|
-
* offset: 1
|
|
472
|
+
* limit: 1,
|
|
473
|
+
* offset: 1
|
|
474
474
|
* })
|
|
475
475
|
*/
|
|
476
476
|
getContent(pageId, request = {}, requestOptions) {
|