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
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./requests"), exports);
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* @example
|
|
6
|
+
* {
|
|
7
|
+
* offset: 1,
|
|
8
|
+
* limit: 1
|
|
9
|
+
* }
|
|
10
|
+
*/
|
|
11
|
+
export interface FormsListSubmissionsRequest {
|
|
12
|
+
/**
|
|
13
|
+
* Offset used for pagination if the results have more than limit records
|
|
14
|
+
*/
|
|
15
|
+
offset?: number;
|
|
16
|
+
/**
|
|
17
|
+
* Maximum number of records to be returned (max limit: 100)
|
|
18
|
+
*/
|
|
19
|
+
limit?: number;
|
|
20
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* @example
|
|
6
|
+
* {}
|
|
7
|
+
*/
|
|
8
|
+
export interface FormsUpdateSubmissionRequest {
|
|
9
|
+
/** An existing **hidden field** defined on the form schema, and the corresponding value to set */
|
|
10
|
+
formSubmissionData?: Record<string, unknown>;
|
|
11
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./client";
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./client"), exports);
|
|
@@ -7,7 +7,9 @@ export * as plans from "./plans";
|
|
|
7
7
|
export * as robotsTxt from "./robotsTxt";
|
|
8
8
|
export * as activityLogs from "./activityLogs";
|
|
9
9
|
export * as scripts from "./scripts";
|
|
10
|
+
export * as forms from "./forms";
|
|
10
11
|
export * from "./wellKnown/client/requests";
|
|
11
12
|
export * from "./activityLogs/client/requests";
|
|
12
13
|
export * from "./comments/client/requests";
|
|
13
14
|
export * from "./scripts/client/requests";
|
|
15
|
+
export * from "./forms/client/requests";
|
|
@@ -36,7 +36,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
36
36
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
37
37
|
};
|
|
38
38
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
39
|
-
exports.scripts = exports.activityLogs = exports.robotsTxt = exports.plans = exports.redirects = exports.comments = exports.wellKnown = void 0;
|
|
39
|
+
exports.forms = exports.scripts = exports.activityLogs = exports.robotsTxt = exports.plans = exports.redirects = exports.comments = exports.wellKnown = void 0;
|
|
40
40
|
exports.wellKnown = __importStar(require("./wellKnown"));
|
|
41
41
|
__exportStar(require("./wellKnown/types"), exports);
|
|
42
42
|
exports.comments = __importStar(require("./comments"));
|
|
@@ -46,7 +46,9 @@ exports.plans = __importStar(require("./plans"));
|
|
|
46
46
|
exports.robotsTxt = __importStar(require("./robotsTxt"));
|
|
47
47
|
exports.activityLogs = __importStar(require("./activityLogs"));
|
|
48
48
|
exports.scripts = __importStar(require("./scripts"));
|
|
49
|
+
exports.forms = __importStar(require("./forms"));
|
|
49
50
|
__exportStar(require("./wellKnown/client/requests"), exports);
|
|
50
51
|
__exportStar(require("./activityLogs/client/requests"), exports);
|
|
51
52
|
__exportStar(require("./comments/client/requests"), exports);
|
|
52
53
|
__exportStar(require("./scripts/client/requests"), exports);
|
|
54
|
+
__exportStar(require("./forms/client/requests"), exports);
|
|
@@ -133,8 +133,8 @@ export declare class Scripts {
|
|
|
133
133
|
*
|
|
134
134
|
* @example
|
|
135
135
|
* await client.sites.scripts.listCustomCodeBlocks("580e63e98c9a982ac9b8b741", {
|
|
136
|
-
* offset: 1
|
|
137
|
-
* limit: 1
|
|
136
|
+
* offset: 1,
|
|
137
|
+
* limit: 1
|
|
138
138
|
* })
|
|
139
139
|
*/
|
|
140
140
|
listCustomCodeBlocks(siteId: string, request?: Webflow.sites.ScriptsListCustomCodeBlocksRequest, requestOptions?: Scripts.RequestOptions): core.HttpResponsePromise<Webflow.ListCustomCodeBlocks>;
|
|
@@ -422,8 +422,8 @@ class Scripts {
|
|
|
422
422
|
*
|
|
423
423
|
* @example
|
|
424
424
|
* await client.sites.scripts.listCustomCodeBlocks("580e63e98c9a982ac9b8b741", {
|
|
425
|
-
* offset: 1
|
|
426
|
-
* limit: 1
|
|
425
|
+
* offset: 1,
|
|
426
|
+
* limit: 1
|
|
427
427
|
* })
|
|
428
428
|
*/
|
|
429
429
|
listCustomCodeBlocks(siteId, request = {}, requestOptions) {
|
|
@@ -28,6 +28,8 @@ export declare class Users {
|
|
|
28
28
|
protected readonly _options: Users.Options;
|
|
29
29
|
constructor(_options?: Users.Options);
|
|
30
30
|
/**
|
|
31
|
+
* <Warning>As of **January 29, 2026**, User Accounts functionality has been disabled on all Webflow sites. This endpoint is no longer available.</Warning>
|
|
32
|
+
*
|
|
31
33
|
* Get a list of users for a site
|
|
32
34
|
*
|
|
33
35
|
* Required scope | `users:read`
|
|
@@ -45,14 +47,16 @@ export declare class Users {
|
|
|
45
47
|
*
|
|
46
48
|
* @example
|
|
47
49
|
* await client.users.list("580e63e98c9a982ac9b8b741", {
|
|
48
|
-
* offset: 1
|
|
49
|
-
* limit: 1
|
|
50
|
+
* offset: 1,
|
|
51
|
+
* limit: 1,
|
|
50
52
|
* sort: "CreatedOn"
|
|
51
53
|
* })
|
|
52
54
|
*/
|
|
53
55
|
list(siteId: string, request?: Webflow.UsersListRequest, requestOptions?: Users.RequestOptions): core.HttpResponsePromise<Webflow.UserList>;
|
|
54
56
|
private __list;
|
|
55
57
|
/**
|
|
58
|
+
* <Warning>As of **January 29, 2026**, User Accounts functionality has been disabled on all Webflow sites. This endpoint is no longer available.</Warning>
|
|
59
|
+
*
|
|
56
60
|
* Get a User by ID
|
|
57
61
|
*
|
|
58
62
|
* Required scope | `users:read`
|
|
@@ -74,6 +78,8 @@ export declare class Users {
|
|
|
74
78
|
get(siteId: string, userId: string, requestOptions?: Users.RequestOptions): core.HttpResponsePromise<Webflow.User>;
|
|
75
79
|
private __get;
|
|
76
80
|
/**
|
|
81
|
+
* <Warning>As of **January 29, 2026**, User Accounts functionality has been disabled on all Webflow sites. This endpoint is no longer available.</Warning>
|
|
82
|
+
*
|
|
77
83
|
* Delete a User by ID
|
|
78
84
|
*
|
|
79
85
|
* Required scope | `users:write`
|
|
@@ -95,6 +101,8 @@ export declare class Users {
|
|
|
95
101
|
delete(siteId: string, userId: string, requestOptions?: Users.RequestOptions): core.HttpResponsePromise<void>;
|
|
96
102
|
private __delete;
|
|
97
103
|
/**
|
|
104
|
+
* <Warning>As of **January 29, 2026**, User Accounts functionality has been disabled on all Webflow sites. This endpoint is no longer available.</Warning>
|
|
105
|
+
*
|
|
98
106
|
* Update a User by ID
|
|
99
107
|
*
|
|
100
108
|
* Required scope | `users:write`
|
|
@@ -132,6 +140,8 @@ export declare class Users {
|
|
|
132
140
|
update(siteId: string, userId: string, request: Webflow.User, requestOptions?: Users.RequestOptions): core.HttpResponsePromise<Webflow.User>;
|
|
133
141
|
private __update;
|
|
134
142
|
/**
|
|
143
|
+
* <Warning>As of **January 29, 2026**, User Accounts functionality has been disabled on all Webflow sites. This endpoint is no longer available.</Warning>
|
|
144
|
+
*
|
|
135
145
|
* Create and invite a user with an email address.
|
|
136
146
|
*
|
|
137
147
|
* The user will be sent and invite via email, which they will need to accept in order to join paid any paid access group.
|
|
@@ -61,6 +61,8 @@ class Users {
|
|
|
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 users for a site
|
|
65
67
|
*
|
|
66
68
|
* Required scope | `users:read`
|
|
@@ -78,8 +80,8 @@ class Users {
|
|
|
78
80
|
*
|
|
79
81
|
* @example
|
|
80
82
|
* await client.users.list("580e63e98c9a982ac9b8b741", {
|
|
81
|
-
* offset: 1
|
|
82
|
-
* limit: 1
|
|
83
|
+
* offset: 1,
|
|
84
|
+
* limit: 1,
|
|
83
85
|
* sort: "CreatedOn"
|
|
84
86
|
* })
|
|
85
87
|
*/
|
|
@@ -190,6 +192,8 @@ class Users {
|
|
|
190
192
|
});
|
|
191
193
|
}
|
|
192
194
|
/**
|
|
195
|
+
* <Warning>As of **January 29, 2026**, User Accounts functionality has been disabled on all Webflow sites. This endpoint is no longer available.</Warning>
|
|
196
|
+
*
|
|
193
197
|
* Get a User by ID
|
|
194
198
|
*
|
|
195
199
|
* Required scope | `users:read`
|
|
@@ -299,6 +303,8 @@ class Users {
|
|
|
299
303
|
});
|
|
300
304
|
}
|
|
301
305
|
/**
|
|
306
|
+
* <Warning>As of **January 29, 2026**, User Accounts functionality has been disabled on all Webflow sites. This endpoint is no longer available.</Warning>
|
|
307
|
+
*
|
|
302
308
|
* Delete a User by ID
|
|
303
309
|
*
|
|
304
310
|
* Required scope | `users:write`
|
|
@@ -399,6 +405,8 @@ class Users {
|
|
|
399
405
|
});
|
|
400
406
|
}
|
|
401
407
|
/**
|
|
408
|
+
* <Warning>As of **January 29, 2026**, User Accounts functionality has been disabled on all Webflow sites. This endpoint is no longer available.</Warning>
|
|
409
|
+
*
|
|
402
410
|
* Update a User by ID
|
|
403
411
|
*
|
|
404
412
|
* Required scope | `users:write`
|
|
@@ -531,6 +539,8 @@ class Users {
|
|
|
531
539
|
});
|
|
532
540
|
}
|
|
533
541
|
/**
|
|
542
|
+
* <Warning>As of **January 29, 2026**, User Accounts functionality has been disabled on all Webflow sites. This endpoint is no longer available.</Warning>
|
|
543
|
+
*
|
|
534
544
|
* Create and invite a user with an email address.
|
|
535
545
|
*
|
|
536
546
|
* The user will be sent and invite via email, which they will need to accept in order to join paid any paid access group.
|
|
@@ -46,8 +46,8 @@ export declare class AuditLogs {
|
|
|
46
46
|
*
|
|
47
47
|
* @example
|
|
48
48
|
* await client.workspaces.auditLogs.getWorkspaceAuditLogs("hitchhikers-workspace", {
|
|
49
|
-
* limit: 1
|
|
50
|
-
* offset: 1
|
|
49
|
+
* limit: 1,
|
|
50
|
+
* offset: 1,
|
|
51
51
|
* sortOrder: "asc",
|
|
52
52
|
* eventType: "user_access",
|
|
53
53
|
* from: new Date("2025-06-22T16:00:31.000Z"),
|
|
@@ -79,8 +79,8 @@ class AuditLogs {
|
|
|
79
79
|
*
|
|
80
80
|
* @example
|
|
81
81
|
* await client.workspaces.auditLogs.getWorkspaceAuditLogs("hitchhikers-workspace", {
|
|
82
|
-
* limit: 1
|
|
83
|
-
* offset: 1
|
|
82
|
+
* limit: 1,
|
|
83
|
+
* offset: 1,
|
|
84
84
|
* sortOrder: "asc",
|
|
85
85
|
* eventType: "user_access",
|
|
86
86
|
* from: new Date("2025-06-22T16:00:31.000Z"),
|
package/dist/Client.js
CHANGED
|
@@ -60,8 +60,8 @@ class WebflowClient {
|
|
|
60
60
|
this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
|
|
61
61
|
"X-Fern-Language": "JavaScript",
|
|
62
62
|
"X-Fern-SDK-Name": "webflow-api",
|
|
63
|
-
"X-Fern-SDK-Version": "3.2.
|
|
64
|
-
"User-Agent": "webflow-api/3.2.
|
|
63
|
+
"X-Fern-SDK-Version": "3.2.2",
|
|
64
|
+
"User-Agent": "webflow-api/3.2.2",
|
|
65
65
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
66
66
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
67
67
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
|
@@ -28,6 +28,8 @@ export declare class AccessGroups {
|
|
|
28
28
|
protected readonly _options: AccessGroups.Options;
|
|
29
29
|
constructor(_options?: AccessGroups.Options);
|
|
30
30
|
/**
|
|
31
|
+
* <Warning>As of **January 29, 2026**, User Accounts functionality has been disabled on all Webflow sites. This endpoint is no longer available.</Warning>
|
|
32
|
+
*
|
|
31
33
|
* Get a list of access groups for a site
|
|
32
34
|
*
|
|
33
35
|
* Required scope | `users:read`
|
|
@@ -45,8 +47,8 @@ export declare class AccessGroups {
|
|
|
45
47
|
*
|
|
46
48
|
* @example
|
|
47
49
|
* await client.accessGroups.list("580e63e98c9a982ac9b8b741", {
|
|
48
|
-
* offset: 1
|
|
49
|
-
* limit: 1
|
|
50
|
+
* offset: 1,
|
|
51
|
+
* limit: 1,
|
|
50
52
|
* sort: "CreatedOn"
|
|
51
53
|
* })
|
|
52
54
|
*/
|
|
@@ -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) {
|