webflow-api 3.3.0-beta → 3.3.1
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/BaseClient.d.ts +1 -1
- package/Client.d.ts +1 -7
- package/Client.js +31 -41
- package/LICENSE +18 -18
- package/README.md +55 -28
- package/api/resources/assets/client/Client.d.ts +4 -4
- package/api/resources/assets/client/Client.js +7 -8
- package/api/resources/assets/client/requests/AssetsListRequest.d.ts +2 -2
- package/api/resources/collections/client/Client.d.ts +2 -2
- package/api/resources/collections/client/Client.js +3 -6
- package/api/resources/collections/resources/fields/client/Client.d.ts +2 -2
- package/api/resources/collections/resources/fields/client/Client.js +4 -6
- package/api/resources/collections/resources/items/client/Client.d.ts +6 -6
- package/api/resources/collections/resources/items/client/Client.js +24 -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/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +1 -1
- package/{dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts → api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataOneItem.d.ts} +1 -1
- package/api/resources/collections/resources/items/types/index.d.ts +1 -1
- package/api/resources/collections/resources/items/types/index.js +1 -1
- package/api/resources/components/client/Client.d.ts +8 -8
- package/api/resources/components/client/Client.js +10 -12
- 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/ecommerce/client/Client.d.ts +2 -2
- package/api/resources/ecommerce/client/Client.js +2 -6
- package/api/resources/forms/client/Client.d.ts +6 -6
- package/api/resources/forms/client/Client.js +7 -10
- 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/index.d.ts +0 -6
- package/api/resources/index.js +1 -7
- package/api/resources/inventory/client/Client.d.ts +2 -2
- package/api/resources/inventory/client/Client.js +3 -6
- package/api/resources/orders/client/Client.d.ts +4 -4
- package/api/resources/orders/client/Client.js +8 -8
- package/api/resources/orders/client/requests/OrdersListRequest.d.ts +2 -2
- package/api/resources/pages/client/Client.d.ts +6 -6
- package/api/resources/pages/client/Client.js +8 -10
- 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/pages/resources/scripts/client/Client.d.ts +2 -2
- package/api/resources/pages/resources/scripts/client/Client.js +3 -6
- package/api/resources/products/client/Client.d.ts +4 -4
- package/api/resources/products/client/Client.js +8 -8
- package/api/resources/products/client/requests/ProductsListRequest.d.ts +2 -2
- package/api/resources/scripts/client/Client.d.ts +2 -2
- package/api/resources/scripts/client/Client.js +4 -6
- package/api/resources/sites/client/Client.d.ts +2 -2
- package/api/resources/sites/client/Client.js +5 -6
- package/api/resources/sites/resources/activityLogs/client/Client.d.ts +4 -4
- package/api/resources/sites/resources/activityLogs/client/Client.js +4 -8
- package/api/resources/sites/resources/activityLogs/client/requests/ActivityLogsListRequest.d.ts +2 -2
- package/api/resources/sites/resources/comments/client/Client.d.ts +8 -8
- package/api/resources/sites/resources/comments/client/Client.js +14 -12
- 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 +6 -6
- package/api/resources/sites/resources/forms/client/Client.js +7 -10
- package/api/resources/sites/resources/forms/client/requests/FormsListSubmissionsBySiteRequest.d.ts +2 -2
- package/api/resources/sites/resources/forms/client/requests/FormsListSubmissionsRequest.d.ts +2 -2
- package/api/resources/sites/resources/plans/client/Client.d.ts +2 -2
- package/api/resources/sites/resources/plans/client/Client.js +2 -6
- package/api/resources/sites/resources/redirects/client/Client.d.ts +4 -4
- package/api/resources/sites/resources/redirects/client/Client.js +6 -8
- package/api/resources/sites/resources/robotsTxt/client/Client.d.ts +2 -2
- package/api/resources/sites/resources/robotsTxt/client/Client.js +5 -6
- package/api/resources/sites/resources/scripts/client/Client.d.ts +4 -4
- package/api/resources/sites/resources/scripts/client/Client.js +5 -8
- package/api/resources/sites/resources/scripts/client/requests/ScriptsListCustomCodeBlocksRequest.d.ts +2 -2
- package/api/resources/sites/resources/wellKnown/client/Client.d.ts +2 -2
- package/api/resources/sites/resources/wellKnown/client/Client.js +4 -6
- package/api/resources/token/client/Client.d.ts +2 -2
- package/api/resources/token/client/Client.js +2 -6
- package/api/resources/webhooks/client/Client.d.ts +2 -2
- package/api/resources/webhooks/client/Client.js +3 -6
- package/api/resources/workspaces/client/Client.d.ts +1 -1
- package/api/resources/workspaces/client/Client.js +1 -1
- package/api/resources/workspaces/resources/auditLogs/client/Client.d.ts +4 -4
- package/api/resources/workspaces/resources/auditLogs/client/Client.js +6 -8
- package/api/resources/workspaces/resources/auditLogs/client/requests/AuditLogsGetWorkspaceAuditLogsRequest.d.ts +2 -2
- package/api/resources/workspaces/resources/auditLogs/types/AuditLogsGetWorkspaceAuditLogsRequestEventType.d.ts +1 -0
- package/api/resources/workspaces/resources/auditLogs/types/AuditLogsGetWorkspaceAuditLogsRequestEventType.js +1 -0
- package/api/types/AssetVariant.d.ts +6 -6
- package/api/types/ComponentDom.d.ts +1 -1
- package/api/types/ForbiddenErrorBody.d.ts +1 -1
- package/api/types/ProductFieldData.d.ts +1 -1
- package/api/types/SettingChange.d.ts +7 -0
- package/api/types/SettingChangeAuditLogItem.d.ts +5 -0
- package/api/types/TriggerType.d.ts +0 -3
- package/api/types/TriggerType.js +0 -3
- package/api/types/WorkspaceAuditLogItem.d.ts +4 -1
- package/api/types/WorkspaceAuditLogItemPayloadSettingChangeMethod.d.ts +5 -0
- package/api/types/WorkspaceAuditLogItemPayloadSettingChangeMethod.js +8 -0
- package/api/types/index.d.ts +3 -13
- package/api/types/index.js +3 -13
- package/dist/BaseClient.d.ts +1 -1
- package/dist/Client.d.ts +1 -7
- package/dist/Client.js +31 -41
- package/dist/api/resources/assets/client/Client.d.ts +4 -4
- package/dist/api/resources/assets/client/Client.js +7 -8
- package/dist/api/resources/assets/client/requests/AssetsListRequest.d.ts +2 -2
- package/dist/api/resources/collections/client/Client.d.ts +2 -2
- package/dist/api/resources/collections/client/Client.js +3 -6
- package/dist/api/resources/collections/resources/fields/client/Client.d.ts +2 -2
- package/dist/api/resources/collections/resources/fields/client/Client.js +4 -6
- package/dist/api/resources/collections/resources/items/client/Client.d.ts +6 -6
- package/dist/api/resources/collections/resources/items/client/Client.js +24 -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/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +1 -1
- package/{api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts → dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataOneItem.d.ts} +1 -1
- package/dist/api/resources/collections/resources/items/types/index.d.ts +1 -1
- package/dist/api/resources/collections/resources/items/types/index.js +1 -1
- package/dist/api/resources/components/client/Client.d.ts +8 -8
- package/dist/api/resources/components/client/Client.js +10 -12
- 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/ecommerce/client/Client.d.ts +2 -2
- package/dist/api/resources/ecommerce/client/Client.js +2 -6
- package/dist/api/resources/forms/client/Client.d.ts +6 -6
- package/dist/api/resources/forms/client/Client.js +7 -10
- 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/index.d.ts +0 -6
- package/dist/api/resources/index.js +1 -7
- package/dist/api/resources/inventory/client/Client.d.ts +2 -2
- package/dist/api/resources/inventory/client/Client.js +3 -6
- package/dist/api/resources/orders/client/Client.d.ts +4 -4
- package/dist/api/resources/orders/client/Client.js +8 -8
- package/dist/api/resources/orders/client/requests/OrdersListRequest.d.ts +2 -2
- package/dist/api/resources/pages/client/Client.d.ts +6 -6
- package/dist/api/resources/pages/client/Client.js +8 -10
- 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/pages/resources/scripts/client/Client.d.ts +2 -2
- package/dist/api/resources/pages/resources/scripts/client/Client.js +3 -6
- package/dist/api/resources/products/client/Client.d.ts +4 -4
- package/dist/api/resources/products/client/Client.js +8 -8
- package/dist/api/resources/products/client/requests/ProductsListRequest.d.ts +2 -2
- package/dist/api/resources/scripts/client/Client.d.ts +2 -2
- package/dist/api/resources/scripts/client/Client.js +4 -6
- package/dist/api/resources/sites/client/Client.d.ts +2 -2
- package/dist/api/resources/sites/client/Client.js +5 -6
- package/dist/api/resources/sites/resources/activityLogs/client/Client.d.ts +4 -4
- package/dist/api/resources/sites/resources/activityLogs/client/Client.js +4 -8
- 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 +8 -8
- package/dist/api/resources/sites/resources/comments/client/Client.js +14 -12
- 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 +6 -6
- package/dist/api/resources/sites/resources/forms/client/Client.js +7 -10
- package/dist/api/resources/sites/resources/forms/client/requests/FormsListSubmissionsBySiteRequest.d.ts +2 -2
- package/dist/api/resources/sites/resources/forms/client/requests/FormsListSubmissionsRequest.d.ts +2 -2
- package/dist/api/resources/sites/resources/plans/client/Client.d.ts +2 -2
- package/dist/api/resources/sites/resources/plans/client/Client.js +2 -6
- package/dist/api/resources/sites/resources/redirects/client/Client.d.ts +4 -4
- package/dist/api/resources/sites/resources/redirects/client/Client.js +6 -8
- package/dist/api/resources/sites/resources/robotsTxt/client/Client.d.ts +2 -2
- package/dist/api/resources/sites/resources/robotsTxt/client/Client.js +5 -6
- package/dist/api/resources/sites/resources/scripts/client/Client.d.ts +4 -4
- package/dist/api/resources/sites/resources/scripts/client/Client.js +5 -8
- package/dist/api/resources/sites/resources/scripts/client/requests/ScriptsListCustomCodeBlocksRequest.d.ts +2 -2
- package/dist/api/resources/sites/resources/wellKnown/client/Client.d.ts +2 -2
- package/dist/api/resources/sites/resources/wellKnown/client/Client.js +4 -6
- package/dist/api/resources/token/client/Client.d.ts +2 -2
- package/dist/api/resources/token/client/Client.js +2 -6
- package/dist/api/resources/webhooks/client/Client.d.ts +2 -2
- package/dist/api/resources/webhooks/client/Client.js +3 -6
- package/dist/api/resources/workspaces/client/Client.d.ts +1 -1
- package/dist/api/resources/workspaces/client/Client.js +1 -1
- package/dist/api/resources/workspaces/resources/auditLogs/client/Client.d.ts +4 -4
- package/dist/api/resources/workspaces/resources/auditLogs/client/Client.js +6 -8
- package/dist/api/resources/workspaces/resources/auditLogs/client/requests/AuditLogsGetWorkspaceAuditLogsRequest.d.ts +2 -2
- package/dist/api/resources/workspaces/resources/auditLogs/types/AuditLogsGetWorkspaceAuditLogsRequestEventType.d.ts +1 -0
- package/dist/api/resources/workspaces/resources/auditLogs/types/AuditLogsGetWorkspaceAuditLogsRequestEventType.js +1 -0
- package/dist/api/types/AssetVariant.d.ts +6 -6
- package/dist/api/types/ComponentDom.d.ts +1 -1
- package/dist/api/types/ForbiddenErrorBody.d.ts +1 -1
- package/dist/api/types/ProductFieldData.d.ts +1 -1
- package/dist/api/types/SettingChange.d.ts +7 -0
- package/dist/api/types/SettingChangeAuditLogItem.d.ts +5 -0
- package/dist/api/types/TriggerType.d.ts +0 -3
- package/dist/api/types/TriggerType.js +0 -3
- package/dist/api/types/WorkspaceAuditLogItem.d.ts +4 -1
- package/dist/api/types/WorkspaceAuditLogItemPayloadSettingChangeMethod.d.ts +5 -0
- package/dist/api/types/WorkspaceAuditLogItemPayloadSettingChangeMethod.js +8 -0
- package/dist/api/types/index.d.ts +3 -13
- package/dist/api/types/index.js +3 -13
- package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +2 -2
- package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.js +2 -2
- package/{serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts → dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataOneItem.d.ts} +2 -2
- package/{serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.js → dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataOneItem.js} +2 -2
- package/dist/serialization/resources/collections/resources/items/types/index.d.ts +1 -1
- package/dist/serialization/resources/collections/resources/items/types/index.js +1 -1
- package/dist/serialization/resources/index.d.ts +0 -5
- package/dist/serialization/resources/index.js +1 -6
- package/dist/serialization/resources/workspaces/resources/auditLogs/types/AuditLogsGetWorkspaceAuditLogsRequestEventType.d.ts +1 -1
- package/dist/serialization/resources/workspaces/resources/auditLogs/types/AuditLogsGetWorkspaceAuditLogsRequestEventType.js +1 -0
- package/dist/serialization/types/AssetVariant.d.ts +6 -6
- package/dist/serialization/types/AssetVariant.js +6 -6
- package/dist/serialization/types/ForbiddenErrorBody.d.ts +2 -2
- package/dist/serialization/types/ForbiddenErrorBody.js +2 -2
- package/dist/serialization/types/SettingChange.d.ts +13 -0
- package/dist/serialization/types/{AccessGroup.js → SettingChange.js} +7 -7
- package/dist/serialization/types/SettingChangeAuditLogItem.d.ts +11 -0
- package/dist/serialization/types/{UserAccessGroupsItem.js → SettingChangeAuditLogItem.js} +5 -5
- package/dist/serialization/types/TriggerType.d.ts +1 -1
- package/dist/serialization/types/TriggerType.js +0 -3
- package/dist/serialization/types/WorkspaceAuditLogItem.d.ts +5 -1
- package/dist/serialization/types/WorkspaceAuditLogItem.js +2 -0
- package/dist/serialization/types/WorkspaceAuditLogItemPayloadSettingChangeMethod.d.ts +7 -0
- package/dist/serialization/types/{UserStatus.js → WorkspaceAuditLogItemPayloadSettingChangeMethod.js} +2 -2
- package/dist/serialization/types/index.d.ts +3 -13
- package/dist/serialization/types/index.js +3 -13
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/dist/wrapper/AssetsUtilitiesClient.d.ts +1 -1
- package/dist/wrapper/FormsClient.js +5 -5
- package/dist/wrapper/ItemsClient.js +20 -20
- package/dist/wrapper/PagesClient.js +5 -5
- package/dist/wrapper/WebflowClient.js +1 -1
- package/jest.config.mjs +1 -1
- package/package.json +2 -1
- package/reference.md +68 -544
- package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +2 -2
- package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.js +2 -2
- package/{dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts → serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataOneItem.d.ts} +2 -2
- package/{dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.js → serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataOneItem.js} +2 -2
- package/serialization/resources/collections/resources/items/types/index.d.ts +1 -1
- package/serialization/resources/collections/resources/items/types/index.js +1 -1
- package/serialization/resources/index.d.ts +0 -5
- package/serialization/resources/index.js +1 -6
- package/serialization/resources/workspaces/resources/auditLogs/types/AuditLogsGetWorkspaceAuditLogsRequestEventType.d.ts +1 -1
- package/serialization/resources/workspaces/resources/auditLogs/types/AuditLogsGetWorkspaceAuditLogsRequestEventType.js +1 -0
- package/serialization/types/AssetVariant.d.ts +6 -6
- package/serialization/types/AssetVariant.js +6 -6
- package/serialization/types/ForbiddenErrorBody.d.ts +2 -2
- package/serialization/types/ForbiddenErrorBody.js +2 -2
- package/serialization/types/SettingChange.d.ts +13 -0
- package/{dist/serialization/types/AccessGroupList.js → serialization/types/SettingChange.js} +7 -8
- package/serialization/types/SettingChangeAuditLogItem.d.ts +11 -0
- package/serialization/types/{UserAccessGroupsItem.js → SettingChangeAuditLogItem.js} +5 -5
- package/serialization/types/TriggerType.d.ts +1 -1
- package/serialization/types/TriggerType.js +0 -3
- package/serialization/types/WorkspaceAuditLogItem.d.ts +5 -1
- package/serialization/types/WorkspaceAuditLogItem.js +2 -0
- package/serialization/types/WorkspaceAuditLogItemPayloadSettingChangeMethod.d.ts +7 -0
- package/{dist/serialization/types/UserLimitReached.js → serialization/types/WorkspaceAuditLogItemPayloadSettingChangeMethod.js} +2 -2
- package/serialization/types/index.d.ts +3 -13
- package/serialization/types/index.js +3 -13
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/wrapper/AssetsUtilitiesClient.d.ts +1 -1
- package/wrapper/FormsClient.js +5 -5
- package/wrapper/ItemsClient.js +20 -20
- package/wrapper/PagesClient.js +5 -5
- package/wrapper/WebflowClient.js +1 -1
- package/.mock/definition/__package__.yml +0 -4471
- package/.mock/definition/accessGroups.yml +0 -87
- package/.mock/definition/api.yml +0 -18
- package/.mock/definition/assets.yml +0 -487
- package/.mock/definition/collections/fields.yml +0 -212
- package/.mock/definition/collections/items.yml +0 -2145
- package/.mock/definition/collections.yml +0 -350
- package/.mock/definition/comments.yml +0 -41
- package/.mock/definition/components.yml +0 -548
- package/.mock/definition/ecommerce.yml +0 -45
- package/.mock/definition/forms.yml +0 -399
- package/.mock/definition/inventory.yml +0 -152
- package/.mock/definition/items.yml +0 -112
- package/.mock/definition/orders.yml +0 -1971
- package/.mock/definition/pages/scripts.yml +0 -155
- package/.mock/definition/pages.yml +0 -611
- package/.mock/definition/products.yml +0 -642
- package/.mock/definition/scripts.yml +0 -236
- package/.mock/definition/sites/activityLogs.yml +0 -77
- package/.mock/definition/sites/comments.yml +0 -352
- package/.mock/definition/sites/forms.yml +0 -316
- package/.mock/definition/sites/plans.yml +0 -48
- package/.mock/definition/sites/redirects.yml +0 -221
- package/.mock/definition/sites/robotsTxt.yml +0 -229
- package/.mock/definition/sites/scripts.yml +0 -243
- package/.mock/definition/sites/wellKnown.yml +0 -130
- package/.mock/definition/sites.yml +0 -558
- package/.mock/definition/token.yml +0 -75
- package/.mock/definition/users.yml +0 -594
- package/.mock/definition/webhooks.yml +0 -188
- package/.mock/definition/workspaces/auditLogs.yml +0 -125
- package/.mock/fern.config.json +0 -4
- package/api/resources/accessGroups/client/Client.d.ts +0 -39
- package/api/resources/accessGroups/client/Client.js +0 -197
- package/api/resources/accessGroups/client/index.d.ts +0 -1
- package/api/resources/accessGroups/client/index.js +0 -17
- package/api/resources/accessGroups/client/requests/AccessGroupsListRequest.d.ts +0 -20
- package/api/resources/accessGroups/client/requests/index.d.ts +0 -1
- package/api/resources/accessGroups/client/requests/index.js +0 -2
- package/api/resources/accessGroups/index.d.ts +0 -2
- package/api/resources/accessGroups/index.js +0 -18
- package/api/resources/accessGroups/types/AccessGroupsListRequestSort.d.ts +0 -9
- package/api/resources/accessGroups/types/AccessGroupsListRequestSort.js +0 -12
- package/api/resources/accessGroups/types/index.d.ts +0 -1
- package/api/resources/accessGroups/types/index.js +0 -17
- package/api/resources/users/client/Client.d.ts +0 -145
- package/api/resources/users/client/Client.js +0 -670
- package/api/resources/users/client/index.d.ts +0 -1
- package/api/resources/users/client/index.js +0 -17
- package/api/resources/users/client/requests/UsersInviteRequest.d.ts +0 -13
- package/api/resources/users/client/requests/UsersListRequest.d.ts +0 -23
- package/api/resources/users/client/requests/index.d.ts +0 -2
- package/api/resources/users/client/requests/index.js +0 -2
- package/api/resources/users/index.d.ts +0 -2
- package/api/resources/users/index.js +0 -18
- package/api/resources/users/types/UserAccountAddedPayload.d.ts +0 -5
- package/api/resources/users/types/UserAccountAddedPayloadPayload.d.ts +0 -20
- package/api/resources/users/types/UserAccountAddedPayloadPayloadData.d.ts +0 -9
- package/api/resources/users/types/UserAccountAddedPayloadPayloadData.js +0 -3
- package/api/resources/users/types/UserAccountDeletedPayload.d.ts +0 -5
- package/api/resources/users/types/UserAccountDeletedPayload.js +0 -3
- package/api/resources/users/types/UserAccountDeletedPayloadPayload.d.ts +0 -20
- package/api/resources/users/types/UserAccountDeletedPayloadPayload.js +0 -3
- package/api/resources/users/types/UserAccountDeletedPayloadPayloadData.d.ts +0 -9
- package/api/resources/users/types/UserAccountDeletedPayloadPayloadData.js +0 -3
- package/api/resources/users/types/UserAccountUpdatedPayload.d.ts +0 -5
- package/api/resources/users/types/UserAccountUpdatedPayload.js +0 -3
- package/api/resources/users/types/UserAccountUpdatedPayloadPayload.d.ts +0 -20
- package/api/resources/users/types/UserAccountUpdatedPayloadPayload.js +0 -3
- package/api/resources/users/types/UserAccountUpdatedPayloadPayloadData.d.ts +0 -9
- package/api/resources/users/types/UserAccountUpdatedPayloadPayloadData.js +0 -3
- package/api/resources/users/types/UsersListRequestSort.d.ts +0 -33
- package/api/resources/users/types/UsersListRequestSort.js +0 -36
- package/api/resources/users/types/index.d.ts +0 -10
- package/api/resources/users/types/index.js +0 -26
- package/api/types/AccessGroup.d.ts +0 -12
- package/api/types/AccessGroup.js +0 -3
- package/api/types/AccessGroupList.d.ts +0 -16
- package/api/types/AccessGroupList.js +0 -3
- package/api/types/ConflictErrorBody.d.ts +0 -2
- package/api/types/ConflictErrorBody.js +0 -3
- package/api/types/DuplicateUserEmail.d.ts +0 -1
- package/api/types/DuplicateUserEmail.js +0 -3
- package/api/types/User.d.ts +0 -22
- package/api/types/User.js +0 -3
- package/api/types/UserAccessGroupsItem.d.ts +0 -14
- package/api/types/UserAccessGroupsItem.js +0 -3
- package/api/types/UserAccessGroupsItemType.d.ts +0 -10
- package/api/types/UserAccessGroupsItemType.js +0 -13
- package/api/types/UserData.d.ts +0 -7
- package/api/types/UserData.js +0 -3
- package/api/types/UserDataData.d.ts +0 -12
- package/api/types/UserDataData.js +0 -3
- package/api/types/UserLimitReached.d.ts +0 -1
- package/api/types/UserLimitReached.js +0 -3
- package/api/types/UserList.d.ts +0 -16
- package/api/types/UserList.js +0 -3
- package/api/types/UserStatus.d.ts +0 -7
- package/api/types/UserStatus.js +0 -10
- package/api/types/UsersNotEnabled.d.ts +0 -1
- package/api/types/UsersNotEnabled.js +0 -3
- package/dist/api/resources/accessGroups/client/Client.d.ts +0 -39
- package/dist/api/resources/accessGroups/client/Client.js +0 -197
- package/dist/api/resources/accessGroups/client/index.d.ts +0 -1
- package/dist/api/resources/accessGroups/client/index.js +0 -17
- package/dist/api/resources/accessGroups/client/requests/AccessGroupsListRequest.d.ts +0 -20
- package/dist/api/resources/accessGroups/client/requests/AccessGroupsListRequest.js +0 -3
- package/dist/api/resources/accessGroups/client/requests/index.d.ts +0 -1
- package/dist/api/resources/accessGroups/client/requests/index.js +0 -2
- package/dist/api/resources/accessGroups/index.d.ts +0 -2
- package/dist/api/resources/accessGroups/index.js +0 -18
- package/dist/api/resources/accessGroups/types/AccessGroupsListRequestSort.d.ts +0 -9
- package/dist/api/resources/accessGroups/types/AccessGroupsListRequestSort.js +0 -12
- package/dist/api/resources/accessGroups/types/index.d.ts +0 -1
- package/dist/api/resources/accessGroups/types/index.js +0 -17
- package/dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.js +0 -3
- package/dist/api/resources/users/client/Client.d.ts +0 -145
- package/dist/api/resources/users/client/Client.js +0 -670
- package/dist/api/resources/users/client/index.d.ts +0 -1
- package/dist/api/resources/users/client/index.js +0 -17
- package/dist/api/resources/users/client/requests/UsersInviteRequest.d.ts +0 -13
- package/dist/api/resources/users/client/requests/UsersInviteRequest.js +0 -3
- package/dist/api/resources/users/client/requests/UsersListRequest.d.ts +0 -23
- package/dist/api/resources/users/client/requests/UsersListRequest.js +0 -3
- package/dist/api/resources/users/client/requests/index.d.ts +0 -2
- package/dist/api/resources/users/client/requests/index.js +0 -2
- package/dist/api/resources/users/index.d.ts +0 -2
- package/dist/api/resources/users/index.js +0 -18
- package/dist/api/resources/users/types/UserAccountAddedPayload.d.ts +0 -5
- package/dist/api/resources/users/types/UserAccountAddedPayload.js +0 -3
- package/dist/api/resources/users/types/UserAccountAddedPayloadPayload.d.ts +0 -20
- package/dist/api/resources/users/types/UserAccountAddedPayloadPayload.js +0 -3
- package/dist/api/resources/users/types/UserAccountAddedPayloadPayloadData.d.ts +0 -9
- package/dist/api/resources/users/types/UserAccountAddedPayloadPayloadData.js +0 -3
- package/dist/api/resources/users/types/UserAccountDeletedPayload.d.ts +0 -5
- package/dist/api/resources/users/types/UserAccountDeletedPayload.js +0 -3
- package/dist/api/resources/users/types/UserAccountDeletedPayloadPayload.d.ts +0 -20
- package/dist/api/resources/users/types/UserAccountDeletedPayloadPayload.js +0 -3
- package/dist/api/resources/users/types/UserAccountDeletedPayloadPayloadData.d.ts +0 -9
- package/dist/api/resources/users/types/UserAccountDeletedPayloadPayloadData.js +0 -3
- package/dist/api/resources/users/types/UserAccountUpdatedPayload.d.ts +0 -5
- package/dist/api/resources/users/types/UserAccountUpdatedPayload.js +0 -3
- package/dist/api/resources/users/types/UserAccountUpdatedPayloadPayload.d.ts +0 -20
- package/dist/api/resources/users/types/UserAccountUpdatedPayloadPayload.js +0 -3
- package/dist/api/resources/users/types/UserAccountUpdatedPayloadPayloadData.d.ts +0 -9
- package/dist/api/resources/users/types/UserAccountUpdatedPayloadPayloadData.js +0 -3
- package/dist/api/resources/users/types/UsersListRequestSort.d.ts +0 -33
- package/dist/api/resources/users/types/UsersListRequestSort.js +0 -36
- package/dist/api/resources/users/types/index.d.ts +0 -10
- package/dist/api/resources/users/types/index.js +0 -26
- package/dist/api/types/AccessGroup.d.ts +0 -12
- package/dist/api/types/AccessGroup.js +0 -3
- package/dist/api/types/AccessGroupList.d.ts +0 -16
- package/dist/api/types/AccessGroupList.js +0 -3
- package/dist/api/types/ConflictErrorBody.d.ts +0 -2
- package/dist/api/types/ConflictErrorBody.js +0 -3
- package/dist/api/types/DuplicateUserEmail.d.ts +0 -1
- package/dist/api/types/DuplicateUserEmail.js +0 -3
- package/dist/api/types/User.d.ts +0 -22
- package/dist/api/types/User.js +0 -3
- package/dist/api/types/UserAccessGroupsItem.d.ts +0 -14
- package/dist/api/types/UserAccessGroupsItem.js +0 -3
- package/dist/api/types/UserAccessGroupsItemType.d.ts +0 -10
- package/dist/api/types/UserAccessGroupsItemType.js +0 -13
- package/dist/api/types/UserData.d.ts +0 -7
- package/dist/api/types/UserData.js +0 -3
- package/dist/api/types/UserDataData.d.ts +0 -12
- package/dist/api/types/UserDataData.js +0 -3
- package/dist/api/types/UserLimitReached.d.ts +0 -1
- package/dist/api/types/UserLimitReached.js +0 -3
- package/dist/api/types/UserList.d.ts +0 -16
- package/dist/api/types/UserList.js +0 -3
- package/dist/api/types/UserStatus.d.ts +0 -7
- package/dist/api/types/UserStatus.js +0 -10
- package/dist/api/types/UsersNotEnabled.d.ts +0 -1
- package/dist/api/types/UsersNotEnabled.js +0 -3
- package/dist/serialization/resources/accessGroups/index.d.ts +0 -1
- package/dist/serialization/resources/accessGroups/index.js +0 -17
- package/dist/serialization/resources/accessGroups/types/AccessGroupsListRequestSort.d.ts +0 -7
- package/dist/serialization/resources/accessGroups/types/AccessGroupsListRequestSort.js +0 -39
- package/dist/serialization/resources/accessGroups/types/index.d.ts +0 -1
- package/dist/serialization/resources/accessGroups/types/index.js +0 -17
- package/dist/serialization/resources/users/client/index.d.ts +0 -1
- package/dist/serialization/resources/users/client/index.js +0 -17
- package/dist/serialization/resources/users/client/requests/UsersInviteRequest.d.ts +0 -10
- package/dist/serialization/resources/users/client/requests/UsersInviteRequest.js +0 -42
- package/dist/serialization/resources/users/client/requests/index.d.ts +0 -1
- package/dist/serialization/resources/users/client/requests/index.js +0 -5
- package/dist/serialization/resources/users/index.d.ts +0 -2
- package/dist/serialization/resources/users/index.js +0 -18
- package/dist/serialization/resources/users/types/UserAccountAddedPayload.d.ts +0 -11
- package/dist/serialization/resources/users/types/UserAccountAddedPayload.js +0 -43
- package/dist/serialization/resources/users/types/UserAccountAddedPayloadPayload.d.ts +0 -20
- package/dist/serialization/resources/users/types/UserAccountAddedPayloadPayload.js +0 -52
- package/dist/serialization/resources/users/types/UserAccountAddedPayloadPayloadData.d.ts +0 -12
- package/dist/serialization/resources/users/types/UserAccountAddedPayloadPayloadData.js +0 -44
- package/dist/serialization/resources/users/types/UserAccountDeletedPayload.d.ts +0 -11
- package/dist/serialization/resources/users/types/UserAccountDeletedPayload.js +0 -43
- package/dist/serialization/resources/users/types/UserAccountDeletedPayloadPayload.d.ts +0 -20
- package/dist/serialization/resources/users/types/UserAccountDeletedPayloadPayload.js +0 -52
- package/dist/serialization/resources/users/types/UserAccountDeletedPayloadPayloadData.d.ts +0 -12
- package/dist/serialization/resources/users/types/UserAccountDeletedPayloadPayloadData.js +0 -44
- package/dist/serialization/resources/users/types/UserAccountUpdatedPayload.d.ts +0 -11
- package/dist/serialization/resources/users/types/UserAccountUpdatedPayload.js +0 -43
- package/dist/serialization/resources/users/types/UserAccountUpdatedPayloadPayload.d.ts +0 -20
- package/dist/serialization/resources/users/types/UserAccountUpdatedPayloadPayload.js +0 -52
- package/dist/serialization/resources/users/types/UserAccountUpdatedPayloadPayloadData.d.ts +0 -12
- package/dist/serialization/resources/users/types/UserAccountUpdatedPayloadPayloadData.js +0 -44
- package/dist/serialization/resources/users/types/UsersListRequestSort.d.ts +0 -7
- package/dist/serialization/resources/users/types/UsersListRequestSort.js +0 -50
- package/dist/serialization/resources/users/types/index.d.ts +0 -10
- package/dist/serialization/resources/users/types/index.js +0 -26
- package/dist/serialization/types/AccessGroup.d.ts +0 -13
- package/dist/serialization/types/AccessGroupList.d.ts +0 -14
- package/dist/serialization/types/ConflictErrorBody.d.ts +0 -9
- package/dist/serialization/types/ConflictErrorBody.js +0 -41
- package/dist/serialization/types/DuplicateUserEmail.d.ts +0 -7
- package/dist/serialization/types/DuplicateUserEmail.js +0 -39
- package/dist/serialization/types/User.d.ts +0 -20
- package/dist/serialization/types/User.js +0 -52
- package/dist/serialization/types/UserAccessGroupsItem.d.ts +0 -11
- package/dist/serialization/types/UserAccessGroupsItemType.d.ts +0 -7
- package/dist/serialization/types/UserAccessGroupsItemType.js +0 -39
- package/dist/serialization/types/UserData.d.ts +0 -10
- package/dist/serialization/types/UserData.js +0 -42
- package/dist/serialization/types/UserDataData.d.ts +0 -13
- package/dist/serialization/types/UserDataData.js +0 -45
- package/dist/serialization/types/UserLimitReached.d.ts +0 -7
- package/dist/serialization/types/UserList.d.ts +0 -14
- package/dist/serialization/types/UserList.js +0 -46
- package/dist/serialization/types/UserStatus.d.ts +0 -7
- package/dist/serialization/types/UsersNotEnabled.d.ts +0 -7
- package/dist/serialization/types/UsersNotEnabled.js +0 -39
- package/serialization/resources/accessGroups/index.d.ts +0 -1
- package/serialization/resources/accessGroups/index.js +0 -17
- package/serialization/resources/accessGroups/types/AccessGroupsListRequestSort.d.ts +0 -7
- package/serialization/resources/accessGroups/types/AccessGroupsListRequestSort.js +0 -39
- package/serialization/resources/accessGroups/types/index.d.ts +0 -1
- package/serialization/resources/accessGroups/types/index.js +0 -17
- package/serialization/resources/users/client/index.d.ts +0 -1
- package/serialization/resources/users/client/index.js +0 -17
- package/serialization/resources/users/client/requests/UsersInviteRequest.d.ts +0 -10
- package/serialization/resources/users/client/requests/UsersInviteRequest.js +0 -42
- package/serialization/resources/users/client/requests/index.d.ts +0 -1
- package/serialization/resources/users/client/requests/index.js +0 -5
- package/serialization/resources/users/index.d.ts +0 -2
- package/serialization/resources/users/index.js +0 -18
- package/serialization/resources/users/types/UserAccountAddedPayload.d.ts +0 -11
- package/serialization/resources/users/types/UserAccountAddedPayload.js +0 -43
- package/serialization/resources/users/types/UserAccountAddedPayloadPayload.d.ts +0 -20
- package/serialization/resources/users/types/UserAccountAddedPayloadPayload.js +0 -52
- package/serialization/resources/users/types/UserAccountAddedPayloadPayloadData.d.ts +0 -12
- package/serialization/resources/users/types/UserAccountAddedPayloadPayloadData.js +0 -44
- package/serialization/resources/users/types/UserAccountDeletedPayload.d.ts +0 -11
- package/serialization/resources/users/types/UserAccountDeletedPayload.js +0 -43
- package/serialization/resources/users/types/UserAccountDeletedPayloadPayload.d.ts +0 -20
- package/serialization/resources/users/types/UserAccountDeletedPayloadPayload.js +0 -52
- package/serialization/resources/users/types/UserAccountDeletedPayloadPayloadData.d.ts +0 -12
- package/serialization/resources/users/types/UserAccountDeletedPayloadPayloadData.js +0 -44
- package/serialization/resources/users/types/UserAccountUpdatedPayload.d.ts +0 -11
- package/serialization/resources/users/types/UserAccountUpdatedPayload.js +0 -43
- package/serialization/resources/users/types/UserAccountUpdatedPayloadPayload.d.ts +0 -20
- package/serialization/resources/users/types/UserAccountUpdatedPayloadPayload.js +0 -52
- package/serialization/resources/users/types/UserAccountUpdatedPayloadPayloadData.d.ts +0 -12
- package/serialization/resources/users/types/UserAccountUpdatedPayloadPayloadData.js +0 -44
- package/serialization/resources/users/types/UsersListRequestSort.d.ts +0 -7
- package/serialization/resources/users/types/UsersListRequestSort.js +0 -50
- package/serialization/resources/users/types/index.d.ts +0 -10
- package/serialization/resources/users/types/index.js +0 -26
- package/serialization/types/AccessGroup.d.ts +0 -13
- package/serialization/types/AccessGroup.js +0 -45
- package/serialization/types/AccessGroupList.d.ts +0 -14
- package/serialization/types/AccessGroupList.js +0 -46
- package/serialization/types/ConflictErrorBody.d.ts +0 -9
- package/serialization/types/ConflictErrorBody.js +0 -41
- package/serialization/types/DuplicateUserEmail.d.ts +0 -7
- package/serialization/types/DuplicateUserEmail.js +0 -39
- package/serialization/types/User.d.ts +0 -20
- package/serialization/types/User.js +0 -52
- package/serialization/types/UserAccessGroupsItem.d.ts +0 -11
- package/serialization/types/UserAccessGroupsItemType.d.ts +0 -7
- package/serialization/types/UserAccessGroupsItemType.js +0 -39
- package/serialization/types/UserData.d.ts +0 -10
- package/serialization/types/UserData.js +0 -42
- package/serialization/types/UserDataData.d.ts +0 -13
- package/serialization/types/UserDataData.js +0 -45
- package/serialization/types/UserLimitReached.d.ts +0 -7
- package/serialization/types/UserLimitReached.js +0 -39
- package/serialization/types/UserList.d.ts +0 -14
- package/serialization/types/UserList.js +0 -46
- package/serialization/types/UserStatus.d.ts +0 -7
- package/serialization/types/UserStatus.js +0 -39
- package/serialization/types/UsersNotEnabled.d.ts +0 -7
- package/serialization/types/UsersNotEnabled.js +0 -39
- /package/api/resources/{accessGroups/client/requests/AccessGroupsListRequest.js → collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataOneItem.js} +0 -0
- /package/api/{resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.js → types/SettingChange.js} +0 -0
- /package/api/{resources/users/client/requests/UsersInviteRequest.js → types/SettingChangeAuditLogItem.js} +0 -0
- /package/{api/resources/users/client/requests/UsersListRequest.js → dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataOneItem.js} +0 -0
- /package/{api/resources/users/types/UserAccountAddedPayload.js → dist/api/types/SettingChange.js} +0 -0
- /package/{api/resources/users/types/UserAccountAddedPayloadPayload.js → dist/api/types/SettingChangeAuditLogItem.js} +0 -0
package/reference.md
CHANGED
|
@@ -127,7 +127,7 @@ await client.token.introspect();
|
|
|
127
127
|
<dl>
|
|
128
128
|
<dd>
|
|
129
129
|
|
|
130
|
-
Create a site.
|
|
130
|
+
Create a site.
|
|
131
131
|
|
|
132
132
|
<Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
|
|
133
133
|
|
|
@@ -326,7 +326,7 @@ await client.sites.get("580e63e98c9a982ac9b8b741");
|
|
|
326
326
|
<dl>
|
|
327
327
|
<dd>
|
|
328
328
|
|
|
329
|
-
Delete a site.
|
|
329
|
+
Delete a site.
|
|
330
330
|
|
|
331
331
|
<Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
|
|
332
332
|
|
|
@@ -393,7 +393,7 @@ await client.sites.delete("580e63e98c9a982ac9b8b741");
|
|
|
393
393
|
<dl>
|
|
394
394
|
<dd>
|
|
395
395
|
|
|
396
|
-
Update a site.
|
|
396
|
+
Update a site.
|
|
397
397
|
|
|
398
398
|
<Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
|
|
399
399
|
|
|
@@ -533,7 +533,7 @@ await client.sites.getCustomDomain("580e63e98c9a982ac9b8b741");
|
|
|
533
533
|
<dl>
|
|
534
534
|
<dd>
|
|
535
535
|
|
|
536
|
-
Publishes a site to one or more more domains.
|
|
536
|
+
Publishes a site to one or more more domains.
|
|
537
537
|
|
|
538
538
|
To publish to a specific custom domain, use the domain IDs from the [Get Custom Domains](/data/reference/sites/get-custom-domain) endpoint.
|
|
539
539
|
|
|
@@ -927,8 +927,8 @@ Required scope | `pages:read`
|
|
|
927
927
|
```typescript
|
|
928
928
|
await client.pages.list("580e63e98c9a982ac9b8b741", {
|
|
929
929
|
localeId: "65427cf400e02b306eaa04a0",
|
|
930
|
-
limit: 1
|
|
931
|
-
offset: 1
|
|
930
|
+
limit: 1,
|
|
931
|
+
offset: 1
|
|
932
932
|
});
|
|
933
933
|
|
|
934
934
|
```
|
|
@@ -1149,7 +1149,7 @@ await client.pages.updatePageSettings("63c720f9347c2139b248e552", {
|
|
|
1149
1149
|
|
|
1150
1150
|
Get text and component instance content from a static page.
|
|
1151
1151
|
|
|
1152
|
-
<Badge intent="info">Localization</Badge>
|
|
1152
|
+
<Badge intent="info">Localization</Badge>
|
|
1153
1153
|
|
|
1154
1154
|
Required scope | `pages:read`
|
|
1155
1155
|
</dd>
|
|
@@ -1168,8 +1168,8 @@ Required scope | `pages:read`
|
|
|
1168
1168
|
```typescript
|
|
1169
1169
|
await client.pages.getContent("63c720f9347c2139b248e552", {
|
|
1170
1170
|
localeId: "65427cf400e02b306eaa04a0",
|
|
1171
|
-
limit: 1
|
|
1172
|
-
offset: 1
|
|
1171
|
+
limit: 1,
|
|
1172
|
+
offset: 1
|
|
1173
1173
|
});
|
|
1174
1174
|
|
|
1175
1175
|
```
|
|
@@ -1362,8 +1362,8 @@ Required scope | `components:read`
|
|
|
1362
1362
|
```typescript
|
|
1363
1363
|
await client.components.list("580e63e98c9a982ac9b8b741", {
|
|
1364
1364
|
branchId: "68026fa68ef6dc744c75b833",
|
|
1365
|
-
limit: 1
|
|
1366
|
-
offset: 1
|
|
1365
|
+
limit: 1,
|
|
1366
|
+
offset: 1
|
|
1367
1367
|
});
|
|
1368
1368
|
|
|
1369
1369
|
```
|
|
@@ -1443,8 +1443,8 @@ Required scope | `components:read`
|
|
|
1443
1443
|
await client.components.getContent("580e63e98c9a982ac9b8b741", "8505ba55-ef72-629e-f85c-33e4b703d48b", {
|
|
1444
1444
|
localeId: "65427cf400e02b306eaa04a0",
|
|
1445
1445
|
branchId: "68026fa68ef6dc744c75b833",
|
|
1446
|
-
limit: 1
|
|
1447
|
-
offset: 1
|
|
1446
|
+
limit: 1,
|
|
1447
|
+
offset: 1
|
|
1448
1448
|
});
|
|
1449
1449
|
|
|
1450
1450
|
```
|
|
@@ -1656,8 +1656,8 @@ Required scope | `components:read`
|
|
|
1656
1656
|
await client.components.getProperties("580e63e98c9a982ac9b8b741", "8505ba55-ef72-629e-f85c-33e4b703d48b", {
|
|
1657
1657
|
localeId: "65427cf400e02b306eaa04a0",
|
|
1658
1658
|
branchId: "68026fa68ef6dc744c75b833",
|
|
1659
|
-
limit: 1
|
|
1660
|
-
offset: 1
|
|
1659
|
+
limit: 1,
|
|
1660
|
+
offset: 1
|
|
1661
1661
|
});
|
|
1662
1662
|
|
|
1663
1663
|
```
|
|
@@ -2071,8 +2071,8 @@ Required scope | `assets:read`
|
|
|
2071
2071
|
|
|
2072
2072
|
```typescript
|
|
2073
2073
|
await client.assets.list("580e63e98c9a982ac9b8b741", {
|
|
2074
|
-
offset: 1
|
|
2075
|
-
limit: 1
|
|
2074
|
+
offset: 1,
|
|
2075
|
+
limit: 1
|
|
2076
2076
|
});
|
|
2077
2077
|
|
|
2078
2078
|
```
|
|
@@ -2129,7 +2129,7 @@ await client.assets.list("580e63e98c9a982ac9b8b741", {
|
|
|
2129
2129
|
<dl>
|
|
2130
2130
|
<dd>
|
|
2131
2131
|
|
|
2132
|
-
The first step in uploading an asset to a site.
|
|
2132
|
+
The first step in uploading an asset to a site.
|
|
2133
2133
|
|
|
2134
2134
|
|
|
2135
2135
|
This endpoint generates a response with the following information: `uploadUrl` and `uploadDetails`.
|
|
@@ -2139,7 +2139,7 @@ Use these properties in the header of a [POST request to Amazson s3](https://doc
|
|
|
2139
2139
|
|
|
2140
2140
|
|
|
2141
2141
|
To learn more about how to upload assets to Webflow, see our [assets guide](/data/docs/working-with-assets).
|
|
2142
|
-
|
|
2142
|
+
|
|
2143
2143
|
Required scope | `assets:write`
|
|
2144
2144
|
</dd>
|
|
2145
2145
|
</dl>
|
|
@@ -2921,8 +2921,8 @@ Required scope | `forms:read`
|
|
|
2921
2921
|
|
|
2922
2922
|
```typescript
|
|
2923
2923
|
await client.forms.list("580e63e98c9a982ac9b8b741", {
|
|
2924
|
-
limit: 1
|
|
2925
|
-
offset: 1
|
|
2924
|
+
limit: 1,
|
|
2925
|
+
offset: 1
|
|
2926
2926
|
});
|
|
2927
2927
|
|
|
2928
2928
|
```
|
|
@@ -3048,7 +3048,7 @@ List form submissions for a given form
|
|
|
3048
3048
|
|
|
3049
3049
|
<Note title="Forms in components">
|
|
3050
3050
|
When a form is used in a component definition, each instance of the form is considered a unique form.
|
|
3051
|
-
|
|
3051
|
+
|
|
3052
3052
|
To get a combined list of submissions for a form that appears across multiple component instances, use the [List Form Submissions by Site](/data/reference/forms/form-submissions/list-submissions-by-site) endpoint.
|
|
3053
3053
|
</Note>
|
|
3054
3054
|
|
|
@@ -3068,8 +3068,8 @@ Required scope | `forms:read`
|
|
|
3068
3068
|
|
|
3069
3069
|
```typescript
|
|
3070
3070
|
await client.forms.listSubmissions("580e63e98c9a982ac9b8b741", {
|
|
3071
|
-
offset: 1
|
|
3072
|
-
limit: 1
|
|
3071
|
+
offset: 1,
|
|
3072
|
+
limit: 1
|
|
3073
3073
|
});
|
|
3074
3074
|
|
|
3075
3075
|
```
|
|
@@ -3314,482 +3314,6 @@ await client.forms.updateSubmission("580e63e98c9a982ac9b8b741");
|
|
|
3314
3314
|
</dl>
|
|
3315
3315
|
|
|
3316
3316
|
|
|
3317
|
-
</dd>
|
|
3318
|
-
</dl>
|
|
3319
|
-
</details>
|
|
3320
|
-
|
|
3321
|
-
## Users
|
|
3322
|
-
<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">list</a>(siteId, { ...params }) -> Webflow.UserList</code></summary>
|
|
3323
|
-
<dl>
|
|
3324
|
-
<dd>
|
|
3325
|
-
|
|
3326
|
-
#### 📝 Description
|
|
3327
|
-
|
|
3328
|
-
<dl>
|
|
3329
|
-
<dd>
|
|
3330
|
-
|
|
3331
|
-
<dl>
|
|
3332
|
-
<dd>
|
|
3333
|
-
|
|
3334
|
-
Get a list of users for a site
|
|
3335
|
-
|
|
3336
|
-
Required scope | `users:read`
|
|
3337
|
-
</dd>
|
|
3338
|
-
</dl>
|
|
3339
|
-
</dd>
|
|
3340
|
-
</dl>
|
|
3341
|
-
|
|
3342
|
-
#### 🔌 Usage
|
|
3343
|
-
|
|
3344
|
-
<dl>
|
|
3345
|
-
<dd>
|
|
3346
|
-
|
|
3347
|
-
<dl>
|
|
3348
|
-
<dd>
|
|
3349
|
-
|
|
3350
|
-
```typescript
|
|
3351
|
-
await client.users.list("580e63e98c9a982ac9b8b741", {
|
|
3352
|
-
offset: 1.1,
|
|
3353
|
-
limit: 1.1,
|
|
3354
|
-
sort: "CreatedOn"
|
|
3355
|
-
});
|
|
3356
|
-
|
|
3357
|
-
```
|
|
3358
|
-
</dd>
|
|
3359
|
-
</dl>
|
|
3360
|
-
</dd>
|
|
3361
|
-
</dl>
|
|
3362
|
-
|
|
3363
|
-
#### ⚙️ Parameters
|
|
3364
|
-
|
|
3365
|
-
<dl>
|
|
3366
|
-
<dd>
|
|
3367
|
-
|
|
3368
|
-
<dl>
|
|
3369
|
-
<dd>
|
|
3370
|
-
|
|
3371
|
-
**siteId:** `string` — Unique identifier for a Site
|
|
3372
|
-
|
|
3373
|
-
</dd>
|
|
3374
|
-
</dl>
|
|
3375
|
-
|
|
3376
|
-
<dl>
|
|
3377
|
-
<dd>
|
|
3378
|
-
|
|
3379
|
-
**request:** `Webflow.UsersListRequest`
|
|
3380
|
-
|
|
3381
|
-
</dd>
|
|
3382
|
-
</dl>
|
|
3383
|
-
|
|
3384
|
-
<dl>
|
|
3385
|
-
<dd>
|
|
3386
|
-
|
|
3387
|
-
**requestOptions:** `Users.RequestOptions`
|
|
3388
|
-
|
|
3389
|
-
</dd>
|
|
3390
|
-
</dl>
|
|
3391
|
-
</dd>
|
|
3392
|
-
</dl>
|
|
3393
|
-
|
|
3394
|
-
|
|
3395
|
-
</dd>
|
|
3396
|
-
</dl>
|
|
3397
|
-
</details>
|
|
3398
|
-
|
|
3399
|
-
<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">get</a>(siteId, userId) -> Webflow.User</code></summary>
|
|
3400
|
-
<dl>
|
|
3401
|
-
<dd>
|
|
3402
|
-
|
|
3403
|
-
#### 📝 Description
|
|
3404
|
-
|
|
3405
|
-
<dl>
|
|
3406
|
-
<dd>
|
|
3407
|
-
|
|
3408
|
-
<dl>
|
|
3409
|
-
<dd>
|
|
3410
|
-
|
|
3411
|
-
Get a User by ID
|
|
3412
|
-
|
|
3413
|
-
Required scope | `users:read`
|
|
3414
|
-
</dd>
|
|
3415
|
-
</dl>
|
|
3416
|
-
</dd>
|
|
3417
|
-
</dl>
|
|
3418
|
-
|
|
3419
|
-
#### 🔌 Usage
|
|
3420
|
-
|
|
3421
|
-
<dl>
|
|
3422
|
-
<dd>
|
|
3423
|
-
|
|
3424
|
-
<dl>
|
|
3425
|
-
<dd>
|
|
3426
|
-
|
|
3427
|
-
```typescript
|
|
3428
|
-
await client.users.get("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741");
|
|
3429
|
-
|
|
3430
|
-
```
|
|
3431
|
-
</dd>
|
|
3432
|
-
</dl>
|
|
3433
|
-
</dd>
|
|
3434
|
-
</dl>
|
|
3435
|
-
|
|
3436
|
-
#### ⚙️ Parameters
|
|
3437
|
-
|
|
3438
|
-
<dl>
|
|
3439
|
-
<dd>
|
|
3440
|
-
|
|
3441
|
-
<dl>
|
|
3442
|
-
<dd>
|
|
3443
|
-
|
|
3444
|
-
**siteId:** `string` — Unique identifier for a Site
|
|
3445
|
-
|
|
3446
|
-
</dd>
|
|
3447
|
-
</dl>
|
|
3448
|
-
|
|
3449
|
-
<dl>
|
|
3450
|
-
<dd>
|
|
3451
|
-
|
|
3452
|
-
**userId:** `string` — Unique identifier for a User
|
|
3453
|
-
|
|
3454
|
-
</dd>
|
|
3455
|
-
</dl>
|
|
3456
|
-
|
|
3457
|
-
<dl>
|
|
3458
|
-
<dd>
|
|
3459
|
-
|
|
3460
|
-
**requestOptions:** `Users.RequestOptions`
|
|
3461
|
-
|
|
3462
|
-
</dd>
|
|
3463
|
-
</dl>
|
|
3464
|
-
</dd>
|
|
3465
|
-
</dl>
|
|
3466
|
-
|
|
3467
|
-
|
|
3468
|
-
</dd>
|
|
3469
|
-
</dl>
|
|
3470
|
-
</details>
|
|
3471
|
-
|
|
3472
|
-
<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">delete</a>(siteId, userId) -> void</code></summary>
|
|
3473
|
-
<dl>
|
|
3474
|
-
<dd>
|
|
3475
|
-
|
|
3476
|
-
#### 📝 Description
|
|
3477
|
-
|
|
3478
|
-
<dl>
|
|
3479
|
-
<dd>
|
|
3480
|
-
|
|
3481
|
-
<dl>
|
|
3482
|
-
<dd>
|
|
3483
|
-
|
|
3484
|
-
Delete a User by ID
|
|
3485
|
-
|
|
3486
|
-
Required scope | `users:write`
|
|
3487
|
-
</dd>
|
|
3488
|
-
</dl>
|
|
3489
|
-
</dd>
|
|
3490
|
-
</dl>
|
|
3491
|
-
|
|
3492
|
-
#### 🔌 Usage
|
|
3493
|
-
|
|
3494
|
-
<dl>
|
|
3495
|
-
<dd>
|
|
3496
|
-
|
|
3497
|
-
<dl>
|
|
3498
|
-
<dd>
|
|
3499
|
-
|
|
3500
|
-
```typescript
|
|
3501
|
-
await client.users.delete("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741");
|
|
3502
|
-
|
|
3503
|
-
```
|
|
3504
|
-
</dd>
|
|
3505
|
-
</dl>
|
|
3506
|
-
</dd>
|
|
3507
|
-
</dl>
|
|
3508
|
-
|
|
3509
|
-
#### ⚙️ Parameters
|
|
3510
|
-
|
|
3511
|
-
<dl>
|
|
3512
|
-
<dd>
|
|
3513
|
-
|
|
3514
|
-
<dl>
|
|
3515
|
-
<dd>
|
|
3516
|
-
|
|
3517
|
-
**siteId:** `string` — Unique identifier for a Site
|
|
3518
|
-
|
|
3519
|
-
</dd>
|
|
3520
|
-
</dl>
|
|
3521
|
-
|
|
3522
|
-
<dl>
|
|
3523
|
-
<dd>
|
|
3524
|
-
|
|
3525
|
-
**userId:** `string` — Unique identifier for a User
|
|
3526
|
-
|
|
3527
|
-
</dd>
|
|
3528
|
-
</dl>
|
|
3529
|
-
|
|
3530
|
-
<dl>
|
|
3531
|
-
<dd>
|
|
3532
|
-
|
|
3533
|
-
**requestOptions:** `Users.RequestOptions`
|
|
3534
|
-
|
|
3535
|
-
</dd>
|
|
3536
|
-
</dl>
|
|
3537
|
-
</dd>
|
|
3538
|
-
</dl>
|
|
3539
|
-
|
|
3540
|
-
|
|
3541
|
-
</dd>
|
|
3542
|
-
</dl>
|
|
3543
|
-
</details>
|
|
3544
|
-
|
|
3545
|
-
<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">update</a>(siteId, userId, { ...params }) -> Webflow.User</code></summary>
|
|
3546
|
-
<dl>
|
|
3547
|
-
<dd>
|
|
3548
|
-
|
|
3549
|
-
#### 📝 Description
|
|
3550
|
-
|
|
3551
|
-
<dl>
|
|
3552
|
-
<dd>
|
|
3553
|
-
|
|
3554
|
-
<dl>
|
|
3555
|
-
<dd>
|
|
3556
|
-
|
|
3557
|
-
Update a User by ID
|
|
3558
|
-
|
|
3559
|
-
Required scope | `users:write`
|
|
3560
|
-
|
|
3561
|
-
<Note class="notice">The <code>email</code> and <code>password</code>
|
|
3562
|
-
fields cannot be updated using this endpoint</Note>
|
|
3563
|
-
</dd>
|
|
3564
|
-
</dl>
|
|
3565
|
-
</dd>
|
|
3566
|
-
</dl>
|
|
3567
|
-
|
|
3568
|
-
#### 🔌 Usage
|
|
3569
|
-
|
|
3570
|
-
<dl>
|
|
3571
|
-
<dd>
|
|
3572
|
-
|
|
3573
|
-
<dl>
|
|
3574
|
-
<dd>
|
|
3575
|
-
|
|
3576
|
-
```typescript
|
|
3577
|
-
await client.users.update("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741", {
|
|
3578
|
-
id: "6287ec36a841b25637c663df",
|
|
3579
|
-
isEmailVerified: true,
|
|
3580
|
-
lastUpdated: new Date("2022-05-20T13:46:12.000Z"),
|
|
3581
|
-
invitedOn: new Date("2022-05-20T13:46:12.000Z"),
|
|
3582
|
-
createdOn: new Date("2022-05-20T13:46:12.000Z"),
|
|
3583
|
-
lastLogin: new Date("2022-05-20T13:46:12.000Z"),
|
|
3584
|
-
status: "verified",
|
|
3585
|
-
accessGroups: [{
|
|
3586
|
-
slug: "webflowers",
|
|
3587
|
-
type: "admin"
|
|
3588
|
-
}]
|
|
3589
|
-
});
|
|
3590
|
-
|
|
3591
|
-
```
|
|
3592
|
-
</dd>
|
|
3593
|
-
</dl>
|
|
3594
|
-
</dd>
|
|
3595
|
-
</dl>
|
|
3596
|
-
|
|
3597
|
-
#### ⚙️ Parameters
|
|
3598
|
-
|
|
3599
|
-
<dl>
|
|
3600
|
-
<dd>
|
|
3601
|
-
|
|
3602
|
-
<dl>
|
|
3603
|
-
<dd>
|
|
3604
|
-
|
|
3605
|
-
**siteId:** `string` — Unique identifier for a Site
|
|
3606
|
-
|
|
3607
|
-
</dd>
|
|
3608
|
-
</dl>
|
|
3609
|
-
|
|
3610
|
-
<dl>
|
|
3611
|
-
<dd>
|
|
3612
|
-
|
|
3613
|
-
**userId:** `string` — Unique identifier for a User
|
|
3614
|
-
|
|
3615
|
-
</dd>
|
|
3616
|
-
</dl>
|
|
3617
|
-
|
|
3618
|
-
<dl>
|
|
3619
|
-
<dd>
|
|
3620
|
-
|
|
3621
|
-
**request:** `Webflow.User`
|
|
3622
|
-
|
|
3623
|
-
</dd>
|
|
3624
|
-
</dl>
|
|
3625
|
-
|
|
3626
|
-
<dl>
|
|
3627
|
-
<dd>
|
|
3628
|
-
|
|
3629
|
-
**requestOptions:** `Users.RequestOptions`
|
|
3630
|
-
|
|
3631
|
-
</dd>
|
|
3632
|
-
</dl>
|
|
3633
|
-
</dd>
|
|
3634
|
-
</dl>
|
|
3635
|
-
|
|
3636
|
-
|
|
3637
|
-
</dd>
|
|
3638
|
-
</dl>
|
|
3639
|
-
</details>
|
|
3640
|
-
|
|
3641
|
-
<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">invite</a>(siteId, { ...params }) -> Webflow.User</code></summary>
|
|
3642
|
-
<dl>
|
|
3643
|
-
<dd>
|
|
3644
|
-
|
|
3645
|
-
#### 📝 Description
|
|
3646
|
-
|
|
3647
|
-
<dl>
|
|
3648
|
-
<dd>
|
|
3649
|
-
|
|
3650
|
-
<dl>
|
|
3651
|
-
<dd>
|
|
3652
|
-
|
|
3653
|
-
Create and invite a user with an email address.
|
|
3654
|
-
|
|
3655
|
-
The user will be sent and invite via email, which they will need to accept in order to join paid any paid access group.
|
|
3656
|
-
|
|
3657
|
-
Required scope | `users:write`
|
|
3658
|
-
</dd>
|
|
3659
|
-
</dl>
|
|
3660
|
-
</dd>
|
|
3661
|
-
</dl>
|
|
3662
|
-
|
|
3663
|
-
#### 🔌 Usage
|
|
3664
|
-
|
|
3665
|
-
<dl>
|
|
3666
|
-
<dd>
|
|
3667
|
-
|
|
3668
|
-
<dl>
|
|
3669
|
-
<dd>
|
|
3670
|
-
|
|
3671
|
-
```typescript
|
|
3672
|
-
await client.users.invite("580e63e98c9a982ac9b8b741", {
|
|
3673
|
-
email: "some.one@home.com",
|
|
3674
|
-
accessGroups: ["accessGroups"]
|
|
3675
|
-
});
|
|
3676
|
-
|
|
3677
|
-
```
|
|
3678
|
-
</dd>
|
|
3679
|
-
</dl>
|
|
3680
|
-
</dd>
|
|
3681
|
-
</dl>
|
|
3682
|
-
|
|
3683
|
-
#### ⚙️ Parameters
|
|
3684
|
-
|
|
3685
|
-
<dl>
|
|
3686
|
-
<dd>
|
|
3687
|
-
|
|
3688
|
-
<dl>
|
|
3689
|
-
<dd>
|
|
3690
|
-
|
|
3691
|
-
**siteId:** `string` — Unique identifier for a Site
|
|
3692
|
-
|
|
3693
|
-
</dd>
|
|
3694
|
-
</dl>
|
|
3695
|
-
|
|
3696
|
-
<dl>
|
|
3697
|
-
<dd>
|
|
3698
|
-
|
|
3699
|
-
**request:** `Webflow.UsersInviteRequest`
|
|
3700
|
-
|
|
3701
|
-
</dd>
|
|
3702
|
-
</dl>
|
|
3703
|
-
|
|
3704
|
-
<dl>
|
|
3705
|
-
<dd>
|
|
3706
|
-
|
|
3707
|
-
**requestOptions:** `Users.RequestOptions`
|
|
3708
|
-
|
|
3709
|
-
</dd>
|
|
3710
|
-
</dl>
|
|
3711
|
-
</dd>
|
|
3712
|
-
</dl>
|
|
3713
|
-
|
|
3714
|
-
|
|
3715
|
-
</dd>
|
|
3716
|
-
</dl>
|
|
3717
|
-
</details>
|
|
3718
|
-
|
|
3719
|
-
## AccessGroups
|
|
3720
|
-
<details><summary><code>client.accessGroups.<a href="/src/api/resources/accessGroups/client/Client.ts">list</a>(siteId, { ...params }) -> Webflow.AccessGroupList</code></summary>
|
|
3721
|
-
<dl>
|
|
3722
|
-
<dd>
|
|
3723
|
-
|
|
3724
|
-
#### 📝 Description
|
|
3725
|
-
|
|
3726
|
-
<dl>
|
|
3727
|
-
<dd>
|
|
3728
|
-
|
|
3729
|
-
<dl>
|
|
3730
|
-
<dd>
|
|
3731
|
-
|
|
3732
|
-
Get a list of access groups for a site
|
|
3733
|
-
|
|
3734
|
-
Required scope | `users:read`
|
|
3735
|
-
</dd>
|
|
3736
|
-
</dl>
|
|
3737
|
-
</dd>
|
|
3738
|
-
</dl>
|
|
3739
|
-
|
|
3740
|
-
#### 🔌 Usage
|
|
3741
|
-
|
|
3742
|
-
<dl>
|
|
3743
|
-
<dd>
|
|
3744
|
-
|
|
3745
|
-
<dl>
|
|
3746
|
-
<dd>
|
|
3747
|
-
|
|
3748
|
-
```typescript
|
|
3749
|
-
await client.accessGroups.list("580e63e98c9a982ac9b8b741", {
|
|
3750
|
-
offset: 1.1,
|
|
3751
|
-
limit: 1.1,
|
|
3752
|
-
sort: "CreatedOn"
|
|
3753
|
-
});
|
|
3754
|
-
|
|
3755
|
-
```
|
|
3756
|
-
</dd>
|
|
3757
|
-
</dl>
|
|
3758
|
-
</dd>
|
|
3759
|
-
</dl>
|
|
3760
|
-
|
|
3761
|
-
#### ⚙️ Parameters
|
|
3762
|
-
|
|
3763
|
-
<dl>
|
|
3764
|
-
<dd>
|
|
3765
|
-
|
|
3766
|
-
<dl>
|
|
3767
|
-
<dd>
|
|
3768
|
-
|
|
3769
|
-
**siteId:** `string` — Unique identifier for a Site
|
|
3770
|
-
|
|
3771
|
-
</dd>
|
|
3772
|
-
</dl>
|
|
3773
|
-
|
|
3774
|
-
<dl>
|
|
3775
|
-
<dd>
|
|
3776
|
-
|
|
3777
|
-
**request:** `Webflow.AccessGroupsListRequest`
|
|
3778
|
-
|
|
3779
|
-
</dd>
|
|
3780
|
-
</dl>
|
|
3781
|
-
|
|
3782
|
-
<dl>
|
|
3783
|
-
<dd>
|
|
3784
|
-
|
|
3785
|
-
**requestOptions:** `AccessGroups.RequestOptions`
|
|
3786
|
-
|
|
3787
|
-
</dd>
|
|
3788
|
-
</dl>
|
|
3789
|
-
</dd>
|
|
3790
|
-
</dl>
|
|
3791
|
-
|
|
3792
|
-
|
|
3793
3317
|
</dd>
|
|
3794
3318
|
</dl>
|
|
3795
3319
|
</details>
|
|
@@ -3807,7 +3331,7 @@ await client.accessGroups.list("580e63e98c9a982ac9b8b741", {
|
|
|
3807
3331
|
<dl>
|
|
3808
3332
|
<dd>
|
|
3809
3333
|
|
|
3810
|
-
Retrieve all products for a site.
|
|
3334
|
+
Retrieve all products for a site.
|
|
3811
3335
|
|
|
3812
3336
|
Use `limit` and `offset` to page through all products with subsequent requests. All SKUs for each product
|
|
3813
3337
|
will also be fetched and returned. The `limit`, `offset` and `total` values represent Products only and do not include any SKUs.
|
|
@@ -3828,8 +3352,8 @@ Required scope | `ecommerce:read`
|
|
|
3828
3352
|
|
|
3829
3353
|
```typescript
|
|
3830
3354
|
await client.products.list("580e63e98c9a982ac9b8b741", {
|
|
3831
|
-
offset: 1
|
|
3832
|
-
limit: 1
|
|
3355
|
+
offset: 1,
|
|
3356
|
+
limit: 1
|
|
3833
3357
|
});
|
|
3834
3358
|
|
|
3835
3359
|
```
|
|
@@ -4405,8 +3929,8 @@ Required scope | `ecommerce:read`
|
|
|
4405
3929
|
```typescript
|
|
4406
3930
|
await client.orders.list("580e63e98c9a982ac9b8b741", {
|
|
4407
3931
|
status: "pending",
|
|
4408
|
-
offset: 1
|
|
4409
|
-
limit: 1
|
|
3932
|
+
offset: 1,
|
|
3933
|
+
limit: 1
|
|
4410
3934
|
});
|
|
4411
3935
|
|
|
4412
3936
|
```
|
|
@@ -4930,10 +4454,10 @@ await client.inventory.list("6377a7c4b7a79608c34a46f7", "5e8518516e147040726cc41
|
|
|
4930
4454
|
<dl>
|
|
4931
4455
|
<dd>
|
|
4932
4456
|
|
|
4933
|
-
Updates the current inventory levels for a particular SKU item.
|
|
4457
|
+
Updates the current inventory levels for a particular SKU item.
|
|
4934
4458
|
|
|
4935
|
-
Updates may be given in one or two methods, absolutely or incrementally.
|
|
4936
|
-
- Absolute updates are done by setting `quantity` directly.
|
|
4459
|
+
Updates may be given in one or two methods, absolutely or incrementally.
|
|
4460
|
+
- Absolute updates are done by setting `quantity` directly.
|
|
4937
4461
|
- Incremental updates are by specifying the inventory delta in `updateQuantity` which is then added to the `quantity` stored on the server.
|
|
4938
4462
|
|
|
4939
4463
|
Required scope | `ecommerce:write`
|
|
@@ -5346,8 +4870,8 @@ Required scope | `CMS:read`
|
|
|
5346
4870
|
```typescript
|
|
5347
4871
|
await client.collections.items.listItems("580e63fc8c9a982ac9b8b745", {
|
|
5348
4872
|
cmsLocaleId: "cmsLocaleId",
|
|
5349
|
-
offset: 1
|
|
5350
|
-
limit: 1
|
|
4873
|
+
offset: 1,
|
|
4874
|
+
limit: 1,
|
|
5351
4875
|
name: "name",
|
|
5352
4876
|
slug: "slug",
|
|
5353
4877
|
sortBy: "lastPublished",
|
|
@@ -5742,8 +5266,8 @@ Required scope | `CMS:read`
|
|
|
5742
5266
|
```typescript
|
|
5743
5267
|
await client.collections.items.listItemsLive("580e63fc8c9a982ac9b8b745", {
|
|
5744
5268
|
cmsLocaleId: "cmsLocaleId",
|
|
5745
|
-
offset: 1
|
|
5746
|
-
limit: 1
|
|
5269
|
+
offset: 1,
|
|
5270
|
+
limit: 1,
|
|
5747
5271
|
name: "name",
|
|
5748
5272
|
slug: "slug",
|
|
5749
5273
|
sortBy: "lastPublished",
|
|
@@ -5925,7 +5449,7 @@ await client.collections.items.createItemLive("580e63fc8c9a982ac9b8b745", {
|
|
|
5925
5449
|
<dl>
|
|
5926
5450
|
<dd>
|
|
5927
5451
|
|
|
5928
|
-
Unpublish up to 100 items from the live site and set the `isDraft` property to `true`.
|
|
5452
|
+
Unpublish up to 100 items from the live site and set the `isDraft` property to `true`.
|
|
5929
5453
|
|
|
5930
5454
|
<Tip title="Localization Tip">Items will only be unpublished in the primary locale unless a `cmsLocaleId` is included in the request.</Tip>
|
|
5931
5455
|
|
|
@@ -6284,7 +5808,7 @@ await client.collections.items.getItem("580e63fc8c9a982ac9b8b745", "580e64008c9a
|
|
|
6284
5808
|
<dl>
|
|
6285
5809
|
<dd>
|
|
6286
5810
|
|
|
6287
|
-
Delete an item from a collection.
|
|
5811
|
+
Delete an item from a collection.
|
|
6288
5812
|
|
|
6289
5813
|
Required scope | `CMS:write`
|
|
6290
5814
|
</dd>
|
|
@@ -6579,7 +6103,7 @@ await client.collections.items.getItemLive("580e63fc8c9a982ac9b8b745", "580e6400
|
|
|
6579
6103
|
<dl>
|
|
6580
6104
|
<dd>
|
|
6581
6105
|
|
|
6582
|
-
Unpublish a live item from the site and set the `isDraft` property to `true`.
|
|
6106
|
+
Unpublish a live item from the site and set the `isDraft` property to `true`.
|
|
6583
6107
|
|
|
6584
6108
|
For bulk unpublishing, please use [this endpoint.](/data/v2.0.0/reference/cms/collection-items/live-items/delete-items-live)
|
|
6585
6109
|
|
|
@@ -6865,7 +6389,7 @@ await client.collections.items.publishItem("580e63fc8c9a982ac9b8b745", {
|
|
|
6865
6389
|
<dl>
|
|
6866
6390
|
<dd>
|
|
6867
6391
|
|
|
6868
|
-
Get all scripts applied to a page.
|
|
6392
|
+
Get all scripts applied to a page.
|
|
6869
6393
|
|
|
6870
6394
|
Required scope | `custom_code:read`
|
|
6871
6395
|
</dd>
|
|
@@ -7285,7 +6809,7 @@ await client.sites.redirects.delete("580e63e98c9a982ac9b8b741", "66c4cb9a20cac35
|
|
|
7285
6809
|
<dl>
|
|
7286
6810
|
<dd>
|
|
7287
6811
|
|
|
7288
|
-
**redirectId:** `string` — Unique identifier site
|
|
6812
|
+
**redirectId:** `string` — Unique identifier site redirect
|
|
7289
6813
|
|
|
7290
6814
|
</dd>
|
|
7291
6815
|
</dl>
|
|
@@ -7364,7 +6888,7 @@ await client.sites.redirects.update("580e63e98c9a982ac9b8b741", "66c4cb9a20cac35
|
|
|
7364
6888
|
<dl>
|
|
7365
6889
|
<dd>
|
|
7366
6890
|
|
|
7367
|
-
**redirectId:** `string` — Unique identifier site
|
|
6891
|
+
**redirectId:** `string` — Unique identifier site redirect
|
|
7368
6892
|
|
|
7369
6893
|
</dd>
|
|
7370
6894
|
</dl>
|
|
@@ -7793,8 +7317,8 @@ Upload a supported well-known file to a site.
|
|
|
7793
7317
|
The current restrictions on well-known files are as follows:
|
|
7794
7318
|
- Each file must be smaller than 100kb
|
|
7795
7319
|
- Less than 30 total files
|
|
7796
|
-
- Have one of the following file extensions (or no extension): `.txt`, `.json`, `.noext`
|
|
7797
|
-
|
|
7320
|
+
- Have one of the following file extensions (or no extension): `.txt`, `.json`, `.noext`
|
|
7321
|
+
|
|
7798
7322
|
<Note title=".noext">
|
|
7799
7323
|
`.noext` is a special file extension that removes other extensions. For example, `apple-app-site-association.noext.txt` will be uploaded as `apple-app-site-association`. Use this extension for tools that have trouble uploading extensionless files.
|
|
7800
7324
|
</Note>
|
|
@@ -7952,7 +7476,7 @@ await client.sites.wellKnown.delete("580e63e98c9a982ac9b8b741");
|
|
|
7952
7476
|
<dl>
|
|
7953
7477
|
<dd>
|
|
7954
7478
|
|
|
7955
|
-
Retrieve Activity Logs for a specific Site.
|
|
7479
|
+
Retrieve Activity Logs for a specific Site.
|
|
7956
7480
|
|
|
7957
7481
|
<Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
|
|
7958
7482
|
|
|
@@ -7972,8 +7496,8 @@ Required scope: `site_activity:read`
|
|
|
7972
7496
|
|
|
7973
7497
|
```typescript
|
|
7974
7498
|
await client.sites.activityLogs.list("580e63e98c9a982ac9b8b741", {
|
|
7975
|
-
limit: 1
|
|
7976
|
-
offset: 1
|
|
7499
|
+
limit: 1,
|
|
7500
|
+
offset: 1
|
|
7977
7501
|
});
|
|
7978
7502
|
|
|
7979
7503
|
```
|
|
@@ -8054,8 +7578,8 @@ Required scope | `comments:read`
|
|
|
8054
7578
|
```typescript
|
|
8055
7579
|
await client.sites.comments.listCommentThreads("580e63e98c9a982ac9b8b741", {
|
|
8056
7580
|
localeId: "65427cf400e02b306eaa04a0",
|
|
8057
|
-
offset: 1
|
|
8058
|
-
limit: 1
|
|
7581
|
+
offset: 1,
|
|
7582
|
+
limit: 1,
|
|
8059
7583
|
sortBy: "createdOn",
|
|
8060
7584
|
sortOrder: "asc"
|
|
8061
7585
|
});
|
|
@@ -8137,8 +7661,8 @@ Required scope | `comments:read`
|
|
|
8137
7661
|
```typescript
|
|
8138
7662
|
await client.sites.comments.getCommentThread("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741", {
|
|
8139
7663
|
localeId: "65427cf400e02b306eaa04a0",
|
|
8140
|
-
offset: 1
|
|
8141
|
-
limit: 1
|
|
7664
|
+
offset: 1,
|
|
7665
|
+
limit: 1,
|
|
8142
7666
|
sortBy: "createdOn",
|
|
8143
7667
|
sortOrder: "asc"
|
|
8144
7668
|
});
|
|
@@ -8228,8 +7752,8 @@ Required scope | `comments:read`
|
|
|
8228
7752
|
```typescript
|
|
8229
7753
|
await client.sites.comments.listCommentReplies("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741", {
|
|
8230
7754
|
localeId: "65427cf400e02b306eaa04a0",
|
|
8231
|
-
offset: 1
|
|
8232
|
-
limit: 1
|
|
7755
|
+
offset: 1,
|
|
7756
|
+
limit: 1,
|
|
8233
7757
|
sortBy: "createdOn",
|
|
8234
7758
|
sortOrder: "asc"
|
|
8235
7759
|
});
|
|
@@ -8297,11 +7821,11 @@ await client.sites.comments.listCommentReplies("580e63e98c9a982ac9b8b741", "580e
|
|
|
8297
7821
|
<dl>
|
|
8298
7822
|
<dd>
|
|
8299
7823
|
|
|
8300
|
-
Get all scripts applied to a site by the App.
|
|
7824
|
+
Get all scripts applied to a site by the App.
|
|
8301
7825
|
|
|
8302
7826
|
<Note title="Script Registration">
|
|
8303
7827
|
To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information.
|
|
8304
|
-
</Note>
|
|
7828
|
+
</Note>
|
|
8305
7829
|
|
|
8306
7830
|
Required scope | `custom_code:read`
|
|
8307
7831
|
</dd>
|
|
@@ -8525,11 +8049,11 @@ await client.sites.scripts.deleteCustomCode("580e63e98c9a982ac9b8b741");
|
|
|
8525
8049
|
<dl>
|
|
8526
8050
|
<dd>
|
|
8527
8051
|
|
|
8528
|
-
Get a list of scripts that have been applied to a site and/or individual pages.
|
|
8052
|
+
Get a list of scripts that have been applied to a site and/or individual pages.
|
|
8529
8053
|
|
|
8530
8054
|
<Note title="Script Registration">
|
|
8531
|
-
To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints.
|
|
8532
|
-
|
|
8055
|
+
To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints.
|
|
8056
|
+
|
|
8533
8057
|
See the documentation on [working with Custom Code](/data/docs/custom-code) for more information.
|
|
8534
8058
|
</Note>
|
|
8535
8059
|
|
|
@@ -8549,8 +8073,8 @@ Required scope | `custom_code:read`
|
|
|
8549
8073
|
|
|
8550
8074
|
```typescript
|
|
8551
8075
|
await client.sites.scripts.listCustomCodeBlocks("580e63e98c9a982ac9b8b741", {
|
|
8552
|
-
offset: 1
|
|
8553
|
-
limit: 1
|
|
8076
|
+
offset: 1,
|
|
8077
|
+
limit: 1
|
|
8554
8078
|
});
|
|
8555
8079
|
|
|
8556
8080
|
```
|
|
@@ -8610,7 +8134,7 @@ await client.sites.scripts.listCustomCodeBlocks("580e63e98c9a982ac9b8b741", {
|
|
|
8610
8134
|
|
|
8611
8135
|
List all form submissions for a given site with the ability to filter submissions by a centralized `elementId`.
|
|
8612
8136
|
|
|
8613
|
-
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).
|
|
8137
|
+
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).
|
|
8614
8138
|
|
|
8615
8139
|
<Note title="Forms in components">
|
|
8616
8140
|
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.
|
|
@@ -8635,8 +8159,8 @@ Required scope | `forms:read`
|
|
|
8635
8159
|
```typescript
|
|
8636
8160
|
await client.sites.forms.listSubmissionsBySite("580e63e98c9a982ac9b8b741", {
|
|
8637
8161
|
elementId: "18259716-3e5a-646a-5f41-5dc4b9405aa0",
|
|
8638
|
-
offset: 1
|
|
8639
|
-
limit: 1
|
|
8162
|
+
offset: 1,
|
|
8163
|
+
limit: 1
|
|
8640
8164
|
});
|
|
8641
8165
|
|
|
8642
8166
|
```
|
|
@@ -8693,7 +8217,7 @@ await client.sites.forms.listSubmissionsBySite("580e63e98c9a982ac9b8b741", {
|
|
|
8693
8217
|
<dl>
|
|
8694
8218
|
<dd>
|
|
8695
8219
|
|
|
8696
|
-
List form submissions for a given form ID within a specific site.
|
|
8220
|
+
List form submissions for a given form ID within a specific site.
|
|
8697
8221
|
|
|
8698
8222
|
Use the [List Form Submissions by Site endpoint](/data/reference/forms/form-submissions/list-submissions-by-site) to list form submissions for a given site with the ability to filter by a `formElementId`.
|
|
8699
8223
|
|
|
@@ -8713,8 +8237,8 @@ Required scope | `forms:read`
|
|
|
8713
8237
|
|
|
8714
8238
|
```typescript
|
|
8715
8239
|
await client.sites.forms.listSubmissions("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741", {
|
|
8716
|
-
offset: 1
|
|
8717
|
-
limit: 1
|
|
8240
|
+
offset: 1,
|
|
8241
|
+
limit: 1
|
|
8718
8242
|
});
|
|
8719
8243
|
|
|
8720
8244
|
```
|
|
@@ -9027,8 +8551,8 @@ Required scope | `workspace_activity:read`
|
|
|
9027
8551
|
|
|
9028
8552
|
```typescript
|
|
9029
8553
|
await client.workspaces.auditLogs.getWorkspaceAuditLogs("hitchhikers-workspace", {
|
|
9030
|
-
limit: 1
|
|
9031
|
-
offset: 1
|
|
8554
|
+
limit: 1,
|
|
8555
|
+
offset: 1,
|
|
9032
8556
|
sortOrder: "asc",
|
|
9033
8557
|
eventType: "user_access",
|
|
9034
8558
|
from: new Date("2025-06-22T16:00:31.000Z"),
|