webflow-api 3.2.0 → 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 +132 -289
- package/.mock/definition/accessGroups.yml +17 -4
- package/.mock/definition/api.yml +0 -2
- package/.mock/definition/assets.yml +41 -8
- package/.mock/definition/collections/fields.yml +9 -3
- package/.mock/definition/collections/items.yml +468 -88
- package/.mock/definition/collections.yml +15 -4
- package/.mock/definition/comments.yml +1 -0
- package/.mock/definition/components.yml +75 -31
- package/.mock/definition/ecommerce.yml +3 -1
- package/.mock/definition/forms.yml +35 -86
- package/.mock/definition/inventory.yml +25 -17
- package/.mock/definition/items.yml +29 -16
- package/.mock/definition/orders.yml +206 -112
- package/.mock/definition/pages/scripts.yml +27 -8
- package/.mock/definition/pages.yml +79 -49
- package/.mock/definition/products.yml +23 -14
- package/.mock/definition/scripts.yml +14 -4
- package/.mock/definition/sites/activityLogs.yml +12 -3
- package/.mock/definition/sites/comments.yml +47 -18
- package/.mock/definition/sites/forms.yml +316 -0
- package/.mock/definition/sites/plans.yml +3 -1
- package/.mock/definition/sites/redirects.yml +12 -4
- package/.mock/definition/sites/robotsTxt.yml +12 -4
- package/.mock/definition/sites/scripts.yml +38 -10
- package/.mock/definition/sites/wellKnown.yml +20 -4
- package/.mock/definition/sites.yml +47 -8
- package/.mock/definition/token.yml +3 -2
- package/.mock/definition/users.yml +83 -17
- package/.mock/definition/webhooks.yml +4 -4
- package/.mock/definition/workspaces/auditLogs.yml +11 -5
- package/.mock/fern.config.json +1 -1
- package/Client.d.ts +2 -2
- package/Client.js +3 -3
- package/LICENSE +21 -0
- package/api/resources/accessGroups/client/Client.d.ts +10 -4
- package/api/resources/accessGroups/client/Client.js +13 -3
- package/api/resources/accessGroups/client/requests/AccessGroupsListRequest.d.ts +5 -1
- package/api/resources/assets/client/Client.d.ts +9 -5
- package/api/resources/assets/client/Client.js +24 -7
- package/api/resources/assets/client/requests/AssetsListRequest.d.ts +20 -0
- package/api/resources/assets/client/requests/index.d.ts +1 -0
- package/api/resources/collections/client/Client.d.ts +3 -3
- package/api/resources/collections/client/Client.js +6 -2
- package/api/resources/collections/resources/fields/client/Client.d.ts +3 -3
- package/api/resources/collections/resources/fields/client/Client.js +6 -2
- package/api/resources/collections/resources/items/client/Client.d.ts +59 -25
- package/api/resources/collections/resources/items/client/Client.js +63 -25
- package/api/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.d.ts +4 -0
- package/api/resources/collections/resources/items/client/requests/ItemsCreateItemLiveRequest.d.ts +4 -2
- package/api/resources/collections/resources/items/client/requests/ItemsCreateItemRequest.d.ts +4 -2
- package/api/resources/collections/resources/items/client/requests/ItemsDeleteItemLiveRequest.d.ts +3 -1
- package/api/resources/collections/resources/items/client/requests/ItemsDeleteItemRequest.d.ts +3 -1
- package/api/resources/collections/resources/items/client/requests/ItemsGetItemLiveRequest.d.ts +3 -1
- package/api/resources/collections/resources/items/client/requests/ItemsGetItemRequest.d.ts +3 -1
- package/api/resources/collections/resources/items/client/requests/ItemsListItemsLiveRequest.d.ts +9 -1
- package/api/resources/collections/resources/items/client/requests/ItemsListItemsRequest.d.ts +9 -1
- package/api/resources/collections/resources/items/client/requests/ItemsUpdateItemLiveRequest.d.ts +3 -2
- package/api/resources/collections/resources/items/client/requests/ItemsUpdateItemRequest.d.ts +3 -2
- package/api/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.d.ts +4 -0
- package/api/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.d.ts +2 -0
- package/api/resources/components/client/Client.d.ts +18 -9
- package/api/resources/components/client/Client.js +21 -8
- package/api/resources/components/client/requests/ComponentDomWrite.d.ts +3 -1
- package/api/resources/components/client/requests/ComponentPropertiesWrite.d.ts +3 -1
- package/api/resources/components/client/requests/ComponentsGetContentRequest.d.ts +6 -2
- package/api/resources/components/client/requests/ComponentsGetPropertiesRequest.d.ts +6 -2
- package/api/resources/components/client/requests/ComponentsListRequest.d.ts +3 -1
- package/api/resources/components/types/ComponentDomWriteNodesItem.d.ts +1 -1
- package/api/resources/ecommerce/client/Client.d.ts +3 -3
- package/api/resources/ecommerce/client/Client.js +6 -2
- package/api/resources/forms/client/Client.d.ts +11 -30
- package/api/resources/forms/client/Client.js +14 -129
- package/api/resources/forms/client/requests/FormsListRequest.d.ts +4 -1
- package/api/resources/forms/client/requests/FormsListSubmissionsRequest.d.ts +4 -1
- package/api/resources/forms/client/requests/index.d.ts +0 -1
- package/api/resources/inventory/client/Client.d.ts +11 -11
- package/api/resources/inventory/client/Client.js +22 -18
- package/api/resources/orders/client/Client.d.ts +8 -4
- package/api/resources/orders/client/Client.js +11 -3
- package/api/resources/orders/client/requests/OrdersListRequest.d.ts +5 -1
- package/api/resources/pages/client/Client.d.ts +14 -15
- package/api/resources/pages/client/Client.js +17 -14
- package/api/resources/pages/client/requests/PageMetadataWrite.d.ts +9 -2
- package/api/resources/pages/client/requests/PagesGetContentRequest.d.ts +6 -2
- package/api/resources/pages/client/requests/PagesGetMetadataRequest.d.ts +3 -1
- package/api/resources/pages/client/requests/PagesListRequest.d.ts +6 -2
- package/api/resources/pages/resources/scripts/client/Client.d.ts +8 -6
- package/api/resources/pages/resources/scripts/client/Client.js +11 -5
- package/api/resources/pages/types/PageDomWriteNodesItem.d.ts +1 -1
- package/api/resources/products/client/Client.d.ts +7 -4
- package/api/resources/products/client/Client.js +10 -3
- package/api/resources/products/client/requests/ProductsListRequest.d.ts +4 -1
- package/api/resources/scripts/client/Client.d.ts +3 -3
- package/api/resources/scripts/client/Client.js +6 -2
- package/api/resources/sites/client/Client.d.ts +6 -3
- package/api/resources/sites/client/Client.js +11 -2
- package/api/resources/sites/resources/activityLogs/client/Client.d.ts +7 -4
- package/api/resources/sites/resources/activityLogs/client/Client.js +10 -3
- package/api/resources/sites/resources/activityLogs/client/requests/ActivityLogsListRequest.d.ts +4 -1
- package/api/resources/sites/resources/comments/client/Client.d.ts +18 -6
- package/api/resources/sites/resources/comments/client/Client.js +21 -5
- package/api/resources/sites/resources/comments/client/requests/CommentsGetCommentThreadRequest.d.ts +8 -2
- package/api/resources/sites/resources/comments/client/requests/CommentsListCommentRepliesRequest.d.ts +8 -2
- package/api/resources/sites/resources/comments/client/requests/CommentsListCommentThreadsRequest.d.ts +8 -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 +3 -1
- 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/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/plans/client/Client.d.ts +3 -3
- package/api/resources/sites/resources/plans/client/Client.js +6 -2
- package/api/resources/sites/resources/redirects/client/Client.d.ts +3 -3
- package/api/resources/sites/resources/redirects/client/Client.js +6 -2
- package/api/resources/sites/resources/robotsTxt/client/Client.d.ts +3 -3
- package/api/resources/sites/resources/robotsTxt/client/Client.js +6 -2
- package/api/resources/sites/resources/scripts/client/Client.d.ts +13 -6
- package/api/resources/sites/resources/scripts/client/Client.js +16 -5
- package/api/resources/sites/resources/scripts/client/requests/ScriptsListCustomCodeBlocksRequest.d.ts +4 -1
- package/api/resources/sites/resources/wellKnown/client/Client.d.ts +6 -5
- package/api/resources/sites/resources/wellKnown/client/Client.js +9 -4
- package/api/resources/sites/resources/wellKnown/client/requests/WellKnownFile.d.ts +3 -2
- package/api/resources/token/client/Client.d.ts +3 -3
- package/api/resources/token/client/Client.js +6 -2
- package/api/resources/users/client/Client.d.ts +18 -4
- package/api/resources/users/client/Client.js +21 -3
- package/api/resources/users/client/requests/UsersListRequest.d.ts +5 -1
- package/api/resources/webhooks/client/Client.d.ts +3 -3
- package/api/resources/webhooks/client/Client.js +6 -2
- package/api/resources/workspaces/client/Client.d.ts +2 -2
- package/api/resources/workspaces/client/Client.js +1 -1
- package/api/resources/workspaces/resources/auditLogs/client/Client.d.ts +9 -5
- package/api/resources/workspaces/resources/auditLogs/client/Client.js +12 -4
- package/api/resources/workspaces/resources/auditLogs/client/requests/AuditLogsGetWorkspaceAuditLogsRequest.d.ts +6 -2
- package/api/types/CollectionItemChanged.d.ts +1 -1
- package/api/types/CollectionItemCreated.d.ts +1 -1
- package/api/types/CollectionItemPublished.d.ts +9 -0
- package/api/types/{ComponentInstance.d.ts → ComponentInstanceNodePropertyOverridesWrite.d.ts} +1 -1
- package/api/types/{ComponentNodeDom.d.ts → ComponentNode.d.ts} +1 -1
- package/api/types/Dom.d.ts +1 -1
- package/{dist/api/types/ImageNodeDom.d.ts → api/types/ImageNode.d.ts} +1 -1
- package/api/types/Node.d.ts +7 -7
- package/api/types/Payload.d.ts +25 -0
- package/api/types/{SingleLocaleChangedPayloadFieldData.d.ts → PayloadFieldData.d.ts} +1 -1
- package/api/types/{SearchButtonNodeDom.d.ts → SearchButtonNode.d.ts} +1 -1
- package/api/types/{SearchButton.d.ts → SearchButtonNodeWrite.d.ts} +1 -1
- package/{dist/api/types/SelectNodeDom.d.ts → api/types/SelectNode.d.ts} +1 -1
- package/api/types/SiteMembership.d.ts +1 -0
- package/api/types/SiteMembershipAuditLogItemEventSubType.d.ts +2 -1
- package/api/types/SiteMembershipAuditLogItemEventSubType.js +1 -0
- package/api/types/SkuFieldData.d.ts +0 -4
- package/{dist/api/types/SubmitButtonNodeDom.d.ts → api/types/SubmitButtonNode.d.ts} +1 -1
- package/api/types/{SubmitButton.d.ts → SubmitButtonNodeWrite.d.ts} +1 -1
- package/api/types/{TextInputNodeDom.d.ts → TextInputNode.d.ts} +1 -1
- package/api/types/{TextInput.d.ts → TextInputNodeWrite.d.ts} +1 -1
- package/api/types/TextNode.d.ts +7 -4
- package/api/types/TextNodeWrite.d.ts +12 -0
- package/api/types/TriggerType.d.ts +2 -1
- package/api/types/TriggerType.js +1 -0
- package/api/types/WorkspaceAuditLogItemPayloadSiteMembershipGranularAccess.d.ts +9 -0
- package/api/types/WorkspaceAuditLogItemPayloadSiteMembershipMethod.d.ts +2 -1
- package/api/types/WorkspaceAuditLogItemPayloadSiteMembershipMethod.js +1 -0
- package/api/types/WorkspaceAuditLogItemPayloadWorkspaceInvitationTargetUsersItem.d.ts +7 -0
- package/api/types/WorkspaceAuditLogItemPayloadWorkspaceMembershipMethod.d.ts +2 -1
- package/api/types/WorkspaceAuditLogItemPayloadWorkspaceMembershipMethod.js +1 -0
- package/api/types/WorkspaceInvitation.d.ts +1 -0
- package/api/types/WorkspaceInvitationAuditLogItemEventSubType.d.ts +2 -1
- package/api/types/WorkspaceInvitationAuditLogItemEventSubType.js +1 -0
- package/api/types/index.d.ts +17 -20
- package/api/types/index.js +17 -20
- package/dist/Client.d.ts +2 -2
- package/dist/Client.js +3 -3
- package/dist/api/resources/accessGroups/client/Client.d.ts +10 -4
- package/dist/api/resources/accessGroups/client/Client.js +13 -3
- package/dist/api/resources/accessGroups/client/requests/AccessGroupsListRequest.d.ts +5 -1
- package/dist/api/resources/assets/client/Client.d.ts +9 -5
- package/dist/api/resources/assets/client/Client.js +24 -7
- package/dist/api/resources/assets/client/requests/AssetsListRequest.d.ts +20 -0
- package/dist/api/resources/assets/client/requests/index.d.ts +1 -0
- package/dist/api/resources/collections/client/Client.d.ts +3 -3
- package/dist/api/resources/collections/client/Client.js +6 -2
- package/dist/api/resources/collections/resources/fields/client/Client.d.ts +3 -3
- package/dist/api/resources/collections/resources/fields/client/Client.js +6 -2
- package/dist/api/resources/collections/resources/items/client/Client.d.ts +59 -25
- package/dist/api/resources/collections/resources/items/client/Client.js +63 -25
- package/dist/api/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.d.ts +4 -0
- package/dist/api/resources/collections/resources/items/client/requests/ItemsCreateItemLiveRequest.d.ts +4 -2
- package/dist/api/resources/collections/resources/items/client/requests/ItemsCreateItemRequest.d.ts +4 -2
- package/dist/api/resources/collections/resources/items/client/requests/ItemsDeleteItemLiveRequest.d.ts +3 -1
- package/dist/api/resources/collections/resources/items/client/requests/ItemsDeleteItemRequest.d.ts +3 -1
- package/dist/api/resources/collections/resources/items/client/requests/ItemsGetItemLiveRequest.d.ts +3 -1
- package/dist/api/resources/collections/resources/items/client/requests/ItemsGetItemRequest.d.ts +3 -1
- package/dist/api/resources/collections/resources/items/client/requests/ItemsListItemsLiveRequest.d.ts +9 -1
- package/dist/api/resources/collections/resources/items/client/requests/ItemsListItemsRequest.d.ts +9 -1
- package/dist/api/resources/collections/resources/items/client/requests/ItemsUpdateItemLiveRequest.d.ts +3 -2
- package/dist/api/resources/collections/resources/items/client/requests/ItemsUpdateItemRequest.d.ts +3 -2
- package/dist/api/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.d.ts +4 -0
- package/dist/api/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.d.ts +2 -0
- package/dist/api/resources/components/client/Client.d.ts +18 -9
- package/dist/api/resources/components/client/Client.js +21 -8
- package/dist/api/resources/components/client/requests/ComponentDomWrite.d.ts +3 -1
- package/dist/api/resources/components/client/requests/ComponentPropertiesWrite.d.ts +3 -1
- package/dist/api/resources/components/client/requests/ComponentsGetContentRequest.d.ts +6 -2
- package/dist/api/resources/components/client/requests/ComponentsGetPropertiesRequest.d.ts +6 -2
- package/dist/api/resources/components/client/requests/ComponentsListRequest.d.ts +3 -1
- package/dist/api/resources/components/types/ComponentDomWriteNodesItem.d.ts +1 -1
- package/dist/api/resources/ecommerce/client/Client.d.ts +3 -3
- package/dist/api/resources/ecommerce/client/Client.js +6 -2
- package/dist/api/resources/forms/client/Client.d.ts +11 -30
- package/dist/api/resources/forms/client/Client.js +14 -129
- package/dist/api/resources/forms/client/requests/FormsListRequest.d.ts +4 -1
- package/dist/api/resources/forms/client/requests/FormsListSubmissionsRequest.d.ts +4 -1
- package/dist/api/resources/forms/client/requests/index.d.ts +0 -1
- package/dist/api/resources/inventory/client/Client.d.ts +11 -11
- package/dist/api/resources/inventory/client/Client.js +22 -18
- package/dist/api/resources/orders/client/Client.d.ts +8 -4
- package/dist/api/resources/orders/client/Client.js +11 -3
- package/dist/api/resources/orders/client/requests/OrdersListRequest.d.ts +5 -1
- package/dist/api/resources/pages/client/Client.d.ts +14 -15
- package/dist/api/resources/pages/client/Client.js +17 -14
- package/dist/api/resources/pages/client/requests/PageMetadataWrite.d.ts +9 -2
- package/dist/api/resources/pages/client/requests/PagesGetContentRequest.d.ts +6 -2
- package/dist/api/resources/pages/client/requests/PagesGetMetadataRequest.d.ts +3 -1
- package/dist/api/resources/pages/client/requests/PagesListRequest.d.ts +6 -2
- package/dist/api/resources/pages/resources/scripts/client/Client.d.ts +8 -6
- package/dist/api/resources/pages/resources/scripts/client/Client.js +11 -5
- package/dist/api/resources/pages/types/PageDomWriteNodesItem.d.ts +1 -1
- package/dist/api/resources/products/client/Client.d.ts +7 -4
- package/dist/api/resources/products/client/Client.js +10 -3
- package/dist/api/resources/products/client/requests/ProductsListRequest.d.ts +4 -1
- package/dist/api/resources/scripts/client/Client.d.ts +3 -3
- package/dist/api/resources/scripts/client/Client.js +6 -2
- package/dist/api/resources/sites/client/Client.d.ts +6 -3
- package/dist/api/resources/sites/client/Client.js +11 -2
- package/dist/api/resources/sites/resources/activityLogs/client/Client.d.ts +7 -4
- package/dist/api/resources/sites/resources/activityLogs/client/Client.js +10 -3
- package/dist/api/resources/sites/resources/activityLogs/client/requests/ActivityLogsListRequest.d.ts +4 -1
- package/dist/api/resources/sites/resources/comments/client/Client.d.ts +18 -6
- package/dist/api/resources/sites/resources/comments/client/Client.js +21 -5
- package/dist/api/resources/sites/resources/comments/client/requests/CommentsGetCommentThreadRequest.d.ts +8 -2
- package/dist/api/resources/sites/resources/comments/client/requests/CommentsListCommentRepliesRequest.d.ts +8 -2
- package/dist/api/resources/sites/resources/comments/client/requests/CommentsListCommentThreadsRequest.d.ts +8 -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 +3 -1
- package/dist/api/resources/sites/resources/forms/client/requests/FormsListSubmissionsRequest.d.ts +20 -0
- package/dist/api/resources/sites/resources/forms/client/requests/FormsUpdateSubmissionRequest.d.ts +11 -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/plans/client/Client.d.ts +3 -3
- package/dist/api/resources/sites/resources/plans/client/Client.js +6 -2
- package/dist/api/resources/sites/resources/redirects/client/Client.d.ts +3 -3
- package/dist/api/resources/sites/resources/redirects/client/Client.js +6 -2
- package/dist/api/resources/sites/resources/robotsTxt/client/Client.d.ts +3 -3
- package/dist/api/resources/sites/resources/robotsTxt/client/Client.js +6 -2
- package/dist/api/resources/sites/resources/scripts/client/Client.d.ts +13 -6
- package/dist/api/resources/sites/resources/scripts/client/Client.js +16 -5
- package/dist/api/resources/sites/resources/scripts/client/requests/ScriptsListCustomCodeBlocksRequest.d.ts +4 -1
- package/dist/api/resources/sites/resources/wellKnown/client/Client.d.ts +6 -5
- package/dist/api/resources/sites/resources/wellKnown/client/Client.js +9 -4
- package/dist/api/resources/sites/resources/wellKnown/client/requests/WellKnownFile.d.ts +3 -2
- package/dist/api/resources/token/client/Client.d.ts +3 -3
- package/dist/api/resources/token/client/Client.js +6 -2
- package/dist/api/resources/users/client/Client.d.ts +18 -4
- package/dist/api/resources/users/client/Client.js +21 -3
- package/dist/api/resources/users/client/requests/UsersListRequest.d.ts +5 -1
- package/dist/api/resources/webhooks/client/Client.d.ts +3 -3
- package/dist/api/resources/webhooks/client/Client.js +6 -2
- package/dist/api/resources/workspaces/client/Client.d.ts +2 -2
- package/dist/api/resources/workspaces/client/Client.js +1 -1
- package/dist/api/resources/workspaces/resources/auditLogs/client/Client.d.ts +9 -5
- package/dist/api/resources/workspaces/resources/auditLogs/client/Client.js +12 -4
- package/dist/api/resources/workspaces/resources/auditLogs/client/requests/AuditLogsGetWorkspaceAuditLogsRequest.d.ts +6 -2
- package/dist/api/types/CollectionItemChanged.d.ts +1 -1
- package/dist/api/types/CollectionItemCreated.d.ts +1 -1
- package/dist/api/types/CollectionItemPublished.d.ts +9 -0
- package/dist/api/types/{ComponentInstance.d.ts → ComponentInstanceNodePropertyOverridesWrite.d.ts} +1 -1
- package/dist/api/types/{ComponentNodeDom.d.ts → ComponentNode.d.ts} +1 -1
- package/dist/api/types/Dom.d.ts +1 -1
- package/{api/types/ImageNodeDom.d.ts → dist/api/types/ImageNode.d.ts} +1 -1
- package/dist/api/types/Node.d.ts +7 -7
- package/dist/api/types/Payload.d.ts +25 -0
- package/dist/api/types/{SingleLocaleChangedPayloadFieldData.d.ts → PayloadFieldData.d.ts} +1 -1
- package/dist/api/types/{SearchButtonNodeDom.d.ts → SearchButtonNode.d.ts} +1 -1
- package/dist/api/types/{SearchButton.d.ts → SearchButtonNodeWrite.d.ts} +1 -1
- package/{api/types/SelectNodeDom.d.ts → dist/api/types/SelectNode.d.ts} +1 -1
- package/dist/api/types/SiteMembership.d.ts +1 -0
- package/dist/api/types/SiteMembershipAuditLogItemEventSubType.d.ts +2 -1
- package/dist/api/types/SiteMembershipAuditLogItemEventSubType.js +1 -0
- package/dist/api/types/SkuFieldData.d.ts +0 -4
- package/{api/types/SubmitButtonNodeDom.d.ts → dist/api/types/SubmitButtonNode.d.ts} +1 -1
- package/dist/api/types/{SubmitButton.d.ts → SubmitButtonNodeWrite.d.ts} +1 -1
- package/dist/api/types/{TextInputNodeDom.d.ts → TextInputNode.d.ts} +1 -1
- package/dist/api/types/{TextInput.d.ts → TextInputNodeWrite.d.ts} +1 -1
- package/dist/api/types/TextNode.d.ts +7 -4
- package/dist/api/types/TextNodeWrite.d.ts +12 -0
- package/dist/api/types/TriggerType.d.ts +2 -1
- package/dist/api/types/TriggerType.js +1 -0
- package/dist/api/types/WorkspaceAuditLogItemPayloadSiteMembershipGranularAccess.d.ts +9 -0
- package/dist/api/types/WorkspaceAuditLogItemPayloadSiteMembershipMethod.d.ts +2 -1
- package/dist/api/types/WorkspaceAuditLogItemPayloadSiteMembershipMethod.js +1 -0
- package/dist/api/types/WorkspaceAuditLogItemPayloadWorkspaceInvitationTargetUsersItem.d.ts +7 -0
- package/dist/api/types/WorkspaceAuditLogItemPayloadWorkspaceMembershipMethod.d.ts +2 -1
- package/dist/api/types/WorkspaceAuditLogItemPayloadWorkspaceMembershipMethod.js +1 -0
- package/dist/api/types/WorkspaceInvitation.d.ts +1 -0
- package/dist/api/types/WorkspaceInvitationAuditLogItemEventSubType.d.ts +2 -1
- package/dist/api/types/WorkspaceInvitationAuditLogItemEventSubType.js +1 -0
- package/dist/api/types/index.d.ts +17 -20
- package/dist/api/types/index.js +17 -20
- package/dist/environments.d.ts +0 -4
- package/dist/environments.js +0 -2
- package/dist/serialization/resources/components/types/ComponentDomWriteNodesItem.d.ts +6 -6
- package/dist/serialization/resources/components/types/ComponentDomWriteNodesItem.js +10 -10
- package/dist/serialization/resources/pages/types/PageDomWriteNodesItem.d.ts +6 -6
- package/dist/serialization/resources/pages/types/PageDomWriteNodesItem.js +10 -10
- 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/serialization/types/CollectionItemChanged.d.ts +2 -2
- package/dist/serialization/types/CollectionItemChanged.js +2 -2
- package/dist/serialization/types/CollectionItemCreated.d.ts +2 -2
- package/dist/serialization/types/CollectionItemCreated.js +2 -2
- package/dist/serialization/types/CollectionItemPublished.d.ts +14 -0
- package/dist/serialization/types/CollectionItemPublished.js +45 -0
- package/{serialization/types/ComponentInstance.d.ts → dist/serialization/types/ComponentInstanceNodePropertyOverridesWrite.d.ts} +2 -2
- package/{serialization/types/ComponentInstance.js → dist/serialization/types/ComponentInstanceNodePropertyOverridesWrite.js} +2 -2
- package/{serialization/types/ComponentNodeDom.d.ts → dist/serialization/types/ComponentNode.d.ts} +2 -2
- package/{serialization/types/ComponentNodeDom.js → dist/serialization/types/ComponentNode.js} +2 -2
- package/dist/serialization/types/FieldValidationsAdditionalPropertiesAdditionalProperties.d.ts +1 -1
- package/dist/serialization/types/FieldValidationsAdditionalPropertiesAdditionalProperties.js +1 -1
- package/dist/serialization/types/{ImageNodeDom.d.ts → ImageNode.d.ts} +2 -2
- package/dist/serialization/types/{ImageNodeDom.js → ImageNode.js} +2 -2
- package/dist/serialization/types/Node.d.ts +14 -14
- package/dist/serialization/types/Node.js +14 -14
- package/dist/serialization/types/Payload.d.ts +23 -0
- package/dist/serialization/types/{MultiLocaleChangedPayload.js → Payload.js} +8 -8
- package/dist/serialization/types/{SingleLocaleChangedPayloadFieldData.d.ts → PayloadFieldData.d.ts} +2 -2
- package/dist/serialization/types/{SingleLocaleChangedPayloadFieldData.js → PayloadFieldData.js} +2 -2
- package/{serialization/types/SearchButtonNodeDom.d.ts → dist/serialization/types/SearchButtonNode.d.ts} +2 -2
- package/{serialization/types/SearchButtonNodeDom.js → dist/serialization/types/SearchButtonNode.js} +2 -2
- package/{serialization/types/SearchButton.d.ts → dist/serialization/types/SearchButtonNodeWrite.d.ts} +2 -2
- package/{serialization/types/SearchButton.js → dist/serialization/types/SearchButtonNodeWrite.js} +2 -2
- package/dist/serialization/types/{SelectNodeDom.d.ts → SelectNode.d.ts} +2 -2
- package/{serialization/types/SelectNodeDom.js → dist/serialization/types/SelectNode.js} +2 -2
- package/dist/serialization/types/SiteMembership.d.ts +2 -0
- package/dist/serialization/types/SiteMembership.js +2 -0
- package/dist/serialization/types/SiteMembershipAuditLogItemEventSubType.d.ts +1 -1
- package/dist/serialization/types/SiteMembershipAuditLogItemEventSubType.js +1 -1
- package/dist/serialization/types/SkuFieldData.d.ts +0 -2
- package/dist/serialization/types/SkuFieldData.js +0 -2
- package/dist/serialization/types/{SubmitButtonNodeDom.d.ts → SubmitButtonNode.d.ts} +2 -2
- package/{serialization/types/SubmitButtonNodeDom.js → dist/serialization/types/SubmitButtonNode.js} +2 -2
- package/{serialization/types/SubmitButton.d.ts → dist/serialization/types/SubmitButtonNodeWrite.d.ts} +2 -2
- package/{serialization/types/SubmitButton.js → dist/serialization/types/SubmitButtonNodeWrite.js} +2 -2
- package/{serialization/types/TextInputNodeDom.d.ts → dist/serialization/types/TextInputNode.d.ts} +2 -2
- package/{serialization/types/TextInputNodeDom.js → dist/serialization/types/TextInputNode.js} +2 -2
- package/dist/serialization/types/{TextInput.d.ts → TextInputNodeWrite.d.ts} +2 -2
- package/dist/serialization/types/{TextInput.js → TextInputNodeWrite.js} +2 -2
- package/dist/serialization/types/TextNode.d.ts +4 -2
- package/dist/serialization/types/TextNode.js +4 -2
- package/dist/serialization/types/TextNodeWrite.d.ts +13 -0
- package/dist/serialization/types/TextNodeWrite.js +44 -0
- package/dist/serialization/types/TriggerType.d.ts +1 -1
- package/dist/serialization/types/TriggerType.js +1 -0
- package/dist/serialization/types/WorkspaceAuditLogItemPayloadSiteMembershipGranularAccess.d.ts +15 -0
- package/dist/serialization/types/WorkspaceAuditLogItemPayloadSiteMembershipGranularAccess.js +46 -0
- package/dist/serialization/types/WorkspaceAuditLogItemPayloadSiteMembershipMethod.d.ts +1 -1
- package/dist/serialization/types/WorkspaceAuditLogItemPayloadSiteMembershipMethod.js +1 -1
- package/dist/serialization/types/WorkspaceAuditLogItemPayloadWorkspaceInvitationTargetUsersItem.d.ts +13 -0
- package/dist/serialization/types/WorkspaceAuditLogItemPayloadWorkspaceInvitationTargetUsersItem.js +44 -0
- package/dist/serialization/types/WorkspaceAuditLogItemPayloadWorkspaceMembershipMethod.d.ts +1 -1
- package/dist/serialization/types/WorkspaceAuditLogItemPayloadWorkspaceMembershipMethod.js +1 -1
- package/dist/serialization/types/WorkspaceInvitation.d.ts +2 -0
- package/dist/serialization/types/WorkspaceInvitation.js +2 -0
- package/dist/serialization/types/WorkspaceInvitationAuditLogItemEventSubType.d.ts +1 -1
- package/dist/serialization/types/WorkspaceInvitationAuditLogItemEventSubType.js +1 -0
- package/dist/serialization/types/index.d.ts +17 -20
- package/dist/serialization/types/index.js +17 -20
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/dist/wrapper/AssetsClient.d.ts +24 -0
- package/dist/wrapper/AssetsClient.js +42 -0
- package/dist/wrapper/AssetsUtilitiesClient.d.ts +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/environments.d.ts +0 -4
- package/environments.js +0 -2
- package/jest.config.mjs +25 -8
- package/package.json +3 -2
- package/reference.md +574 -137
- package/serialization/resources/components/types/ComponentDomWriteNodesItem.d.ts +6 -6
- package/serialization/resources/components/types/ComponentDomWriteNodesItem.js +10 -10
- package/serialization/resources/pages/types/PageDomWriteNodesItem.d.ts +6 -6
- package/serialization/resources/pages/types/PageDomWriteNodesItem.js +10 -10
- 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/serialization/types/CollectionItemChanged.d.ts +2 -2
- package/serialization/types/CollectionItemChanged.js +2 -2
- package/serialization/types/CollectionItemCreated.d.ts +2 -2
- package/serialization/types/CollectionItemCreated.js +2 -2
- package/serialization/types/CollectionItemPublished.d.ts +14 -0
- package/serialization/types/CollectionItemPublished.js +45 -0
- package/{dist/serialization/types/ComponentInstance.d.ts → serialization/types/ComponentInstanceNodePropertyOverridesWrite.d.ts} +2 -2
- package/{dist/serialization/types/ComponentInstance.js → serialization/types/ComponentInstanceNodePropertyOverridesWrite.js} +2 -2
- package/{dist/serialization/types/ComponentNodeDom.d.ts → serialization/types/ComponentNode.d.ts} +2 -2
- package/{dist/serialization/types/ComponentNodeDom.js → serialization/types/ComponentNode.js} +2 -2
- package/serialization/types/FieldValidationsAdditionalPropertiesAdditionalProperties.d.ts +1 -1
- package/serialization/types/FieldValidationsAdditionalPropertiesAdditionalProperties.js +1 -1
- package/serialization/types/{ImageNodeDom.d.ts → ImageNode.d.ts} +2 -2
- package/serialization/types/{ImageNodeDom.js → ImageNode.js} +2 -2
- package/serialization/types/Node.d.ts +14 -14
- package/serialization/types/Node.js +14 -14
- package/serialization/types/Payload.d.ts +23 -0
- package/serialization/types/{MultiLocaleChangedPayload.js → Payload.js} +8 -8
- package/serialization/types/{SingleLocaleChangedPayloadFieldData.d.ts → PayloadFieldData.d.ts} +2 -2
- package/serialization/types/{SingleLocaleChangedPayloadFieldData.js → PayloadFieldData.js} +2 -2
- package/{dist/serialization/types/SearchButtonNodeDom.d.ts → serialization/types/SearchButtonNode.d.ts} +2 -2
- package/{dist/serialization/types/SearchButtonNodeDom.js → serialization/types/SearchButtonNode.js} +2 -2
- package/{dist/serialization/types/SearchButton.d.ts → serialization/types/SearchButtonNodeWrite.d.ts} +2 -2
- package/{dist/serialization/types/SearchButton.js → serialization/types/SearchButtonNodeWrite.js} +2 -2
- package/serialization/types/{SelectNodeDom.d.ts → SelectNode.d.ts} +2 -2
- package/{dist/serialization/types/SelectNodeDom.js → serialization/types/SelectNode.js} +2 -2
- package/serialization/types/SiteMembership.d.ts +2 -0
- package/serialization/types/SiteMembership.js +2 -0
- package/serialization/types/SiteMembershipAuditLogItemEventSubType.d.ts +1 -1
- package/serialization/types/SiteMembershipAuditLogItemEventSubType.js +1 -1
- package/serialization/types/SkuFieldData.d.ts +0 -2
- package/serialization/types/SkuFieldData.js +0 -2
- package/serialization/types/{SubmitButtonNodeDom.d.ts → SubmitButtonNode.d.ts} +2 -2
- package/{dist/serialization/types/SubmitButtonNodeDom.js → serialization/types/SubmitButtonNode.js} +2 -2
- package/{dist/serialization/types/SubmitButton.d.ts → serialization/types/SubmitButtonNodeWrite.d.ts} +2 -2
- package/{dist/serialization/types/SubmitButton.js → serialization/types/SubmitButtonNodeWrite.js} +2 -2
- package/{dist/serialization/types/TextInputNodeDom.d.ts → serialization/types/TextInputNode.d.ts} +2 -2
- package/{dist/serialization/types/TextInputNodeDom.js → serialization/types/TextInputNode.js} +2 -2
- package/serialization/types/{TextInput.d.ts → TextInputNodeWrite.d.ts} +2 -2
- package/serialization/types/{TextInput.js → TextInputNodeWrite.js} +2 -2
- package/serialization/types/TextNode.d.ts +4 -2
- package/serialization/types/TextNode.js +4 -2
- package/serialization/types/TextNodeWrite.d.ts +13 -0
- package/serialization/types/TextNodeWrite.js +44 -0
- package/serialization/types/TriggerType.d.ts +1 -1
- package/serialization/types/TriggerType.js +1 -0
- package/serialization/types/WorkspaceAuditLogItemPayloadSiteMembershipGranularAccess.d.ts +15 -0
- package/serialization/types/WorkspaceAuditLogItemPayloadSiteMembershipGranularAccess.js +46 -0
- package/serialization/types/WorkspaceAuditLogItemPayloadSiteMembershipMethod.d.ts +1 -1
- package/serialization/types/WorkspaceAuditLogItemPayloadSiteMembershipMethod.js +1 -1
- package/serialization/types/WorkspaceAuditLogItemPayloadWorkspaceInvitationTargetUsersItem.d.ts +13 -0
- package/serialization/types/WorkspaceAuditLogItemPayloadWorkspaceInvitationTargetUsersItem.js +44 -0
- package/serialization/types/WorkspaceAuditLogItemPayloadWorkspaceMembershipMethod.d.ts +1 -1
- package/serialization/types/WorkspaceAuditLogItemPayloadWorkspaceMembershipMethod.js +1 -1
- package/serialization/types/WorkspaceInvitation.d.ts +2 -0
- package/serialization/types/WorkspaceInvitation.js +2 -0
- package/serialization/types/WorkspaceInvitationAuditLogItemEventSubType.d.ts +1 -1
- package/serialization/types/WorkspaceInvitationAuditLogItemEventSubType.js +1 -0
- package/serialization/types/index.d.ts +17 -20
- package/serialization/types/index.js +17 -20
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/wrapper/AssetsClient.d.ts +24 -0
- package/wrapper/AssetsClient.js +42 -0
- package/wrapper/AssetsUtilitiesClient.d.ts +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/types/CollectionItemChangedPayload.d.ts +0 -5
- package/api/types/CollectionItemCreatedPayload.d.ts +0 -5
- package/api/types/LocalizedItem.d.ts +0 -31
- package/api/types/MultiLocaleChangedPayload.d.ts +0 -22
- package/api/types/MultiLocaleChangedPayloadFieldData.d.ts +0 -11
- package/api/types/MultiLocaleCreatedPayload.d.ts +0 -16
- package/api/types/SingleLocaleChangedPayload.d.ts +0 -22
- package/api/types/TextNodeDom.d.ts +0 -15
- package/dist/api/types/CollectionItemChangedPayload.d.ts +0 -5
- package/dist/api/types/CollectionItemCreatedPayload.d.ts +0 -5
- package/dist/api/types/LocalizedItem.d.ts +0 -31
- package/dist/api/types/MultiLocaleChangedPayload.d.ts +0 -22
- package/dist/api/types/MultiLocaleChangedPayloadFieldData.d.ts +0 -11
- package/dist/api/types/MultiLocaleCreatedPayload.d.ts +0 -16
- package/dist/api/types/SingleLocaleChangedPayload.d.ts +0 -22
- package/dist/api/types/TextNodeDom.d.ts +0 -15
- package/dist/serialization/types/CollectionItemChangedPayload.d.ts +0 -12
- package/dist/serialization/types/CollectionItemChangedPayload.js +0 -43
- package/dist/serialization/types/CollectionItemCreatedPayload.d.ts +0 -12
- package/dist/serialization/types/CollectionItemCreatedPayload.js +0 -43
- package/dist/serialization/types/LocalizedItem.d.ts +0 -24
- package/dist/serialization/types/LocalizedItem.js +0 -55
- package/dist/serialization/types/MultiLocaleChangedPayload.d.ts +0 -23
- package/dist/serialization/types/MultiLocaleChangedPayloadFieldData.d.ts +0 -15
- package/dist/serialization/types/MultiLocaleChangedPayloadFieldData.js +0 -47
- package/dist/serialization/types/MultiLocaleCreatedPayload.d.ts +0 -17
- package/dist/serialization/types/MultiLocaleCreatedPayload.js +0 -48
- package/dist/serialization/types/SingleLocaleChangedPayload.d.ts +0 -23
- package/dist/serialization/types/SingleLocaleChangedPayload.js +0 -54
- package/dist/serialization/types/TextNodeDom.d.ts +0 -15
- package/dist/serialization/types/TextNodeDom.js +0 -46
- package/serialization/types/CollectionItemChangedPayload.d.ts +0 -12
- package/serialization/types/CollectionItemChangedPayload.js +0 -43
- package/serialization/types/CollectionItemCreatedPayload.d.ts +0 -12
- package/serialization/types/CollectionItemCreatedPayload.js +0 -43
- package/serialization/types/LocalizedItem.d.ts +0 -24
- package/serialization/types/LocalizedItem.js +0 -55
- package/serialization/types/MultiLocaleChangedPayload.d.ts +0 -23
- package/serialization/types/MultiLocaleChangedPayloadFieldData.d.ts +0 -15
- package/serialization/types/MultiLocaleChangedPayloadFieldData.js +0 -47
- package/serialization/types/MultiLocaleCreatedPayload.d.ts +0 -17
- package/serialization/types/MultiLocaleCreatedPayload.js +0 -48
- package/serialization/types/SingleLocaleChangedPayload.d.ts +0 -23
- package/serialization/types/SingleLocaleChangedPayload.js +0 -54
- package/serialization/types/TextNodeDom.d.ts +0 -15
- package/serialization/types/TextNodeDom.js +0 -46
- /package/api/resources/{forms/client/requests/FormsListSubmissionsBySiteRequest.js → assets/client/requests/AssetsListRequest.js} +0 -0
- /package/{dist/api → api/resources/sites}/resources/forms/client/requests/FormsListSubmissionsBySiteRequest.js +0 -0
- /package/api/{types/CollectionItemChangedPayload.js → resources/sites/resources/forms/client/requests/FormsListSubmissionsRequest.js} +0 -0
- /package/api/{types/CollectionItemCreatedPayload.js → resources/sites/resources/forms/client/requests/FormsUpdateSubmissionRequest.js} +0 -0
- /package/api/types/{ComponentInstance.js → CollectionItemPublished.js} +0 -0
- /package/api/types/{ComponentNodeDom.js → ComponentInstanceNodePropertyOverridesWrite.js} +0 -0
- /package/api/types/{ImageNodeDom.js → ComponentNode.js} +0 -0
- /package/api/types/{LocalizedItem.js → ImageNode.js} +0 -0
- /package/api/types/{MultiLocaleChangedPayload.js → Payload.js} +0 -0
- /package/api/types/{MultiLocaleChangedPayloadFieldData.js → PayloadFieldData.js} +0 -0
- /package/api/types/{MultiLocaleCreatedPayload.js → SearchButtonNode.js} +0 -0
- /package/api/types/{SearchButton.js → SearchButtonNodeWrite.js} +0 -0
- /package/api/types/{SearchButtonNodeDom.js → SelectNode.js} +0 -0
- /package/api/types/{SelectNodeDom.js → SubmitButtonNode.js} +0 -0
- /package/api/types/{SingleLocaleChangedPayload.js → SubmitButtonNodeWrite.js} +0 -0
- /package/api/types/{SingleLocaleChangedPayloadFieldData.js → TextInputNode.js} +0 -0
- /package/api/types/{SubmitButton.js → TextInputNodeWrite.js} +0 -0
- /package/api/types/{SubmitButtonNodeDom.js → TextNodeWrite.js} +0 -0
- /package/api/types/{TextInput.js → WorkspaceAuditLogItemPayloadSiteMembershipGranularAccess.js} +0 -0
- /package/api/types/{TextInputNodeDom.js → WorkspaceAuditLogItemPayloadWorkspaceInvitationTargetUsersItem.js} +0 -0
- /package/{api/types/TextNodeDom.js → dist/api/resources/assets/client/requests/AssetsListRequest.js} +0 -0
- /package/dist/api/{types/CollectionItemChangedPayload.js → resources/sites/resources/forms/client/requests/FormsListSubmissionsBySiteRequest.js} +0 -0
- /package/dist/api/{types/CollectionItemCreatedPayload.js → resources/sites/resources/forms/client/requests/FormsListSubmissionsRequest.js} +0 -0
- /package/dist/api/{types/ComponentInstance.js → resources/sites/resources/forms/client/requests/FormsUpdateSubmissionRequest.js} +0 -0
- /package/dist/api/types/{ComponentNodeDom.js → CollectionItemPublished.js} +0 -0
- /package/dist/api/types/{ImageNodeDom.js → ComponentInstanceNodePropertyOverridesWrite.js} +0 -0
- /package/dist/api/types/{LocalizedItem.js → ComponentNode.js} +0 -0
- /package/dist/api/types/{MultiLocaleChangedPayload.js → ImageNode.js} +0 -0
- /package/dist/api/types/{MultiLocaleChangedPayloadFieldData.js → Payload.js} +0 -0
- /package/dist/api/types/{MultiLocaleCreatedPayload.js → PayloadFieldData.js} +0 -0
- /package/dist/api/types/{SearchButton.js → SearchButtonNode.js} +0 -0
- /package/dist/api/types/{SearchButtonNodeDom.js → SearchButtonNodeWrite.js} +0 -0
- /package/dist/api/types/{SelectNodeDom.js → SelectNode.js} +0 -0
- /package/dist/api/types/{SingleLocaleChangedPayload.js → SubmitButtonNode.js} +0 -0
- /package/dist/api/types/{SingleLocaleChangedPayloadFieldData.js → SubmitButtonNodeWrite.js} +0 -0
- /package/dist/api/types/{SubmitButton.js → TextInputNode.js} +0 -0
- /package/dist/api/types/{SubmitButtonNodeDom.js → TextInputNodeWrite.js} +0 -0
- /package/dist/api/types/{TextInput.js → TextNodeWrite.js} +0 -0
- /package/dist/api/types/{TextInputNodeDom.js → WorkspaceAuditLogItemPayloadSiteMembershipGranularAccess.js} +0 -0
- /package/dist/api/types/{TextNodeDom.js → WorkspaceAuditLogItemPayloadWorkspaceInvitationTargetUsersItem.js} +0 -0
package/reference.md
CHANGED
|
@@ -937,6 +937,8 @@ Required scope | `pages:read`
|
|
|
937
937
|
```typescript
|
|
938
938
|
await client.pages.list("580e63e98c9a982ac9b8b741", {
|
|
939
939
|
localeId: "65427cf400e02b306eaa04a0",
|
|
940
|
+
limit: 1,
|
|
941
|
+
offset: 1,
|
|
940
942
|
});
|
|
941
943
|
```
|
|
942
944
|
|
|
@@ -1069,10 +1071,6 @@ await client.pages.getMetadata("63c720f9347c2139b248e552", {
|
|
|
1069
1071
|
|
|
1070
1072
|
Update Page-level metadata, including SEO and Open Graph fields.
|
|
1071
1073
|
|
|
1072
|
-
<Note>
|
|
1073
|
-
Note: When updating Page Metadata in secondary locales, you may only add `slug` to the request if your Site has the [Advanced or Enterprise Localization](https://webflow.com/localization) add-on.
|
|
1074
|
-
</Note>
|
|
1075
|
-
|
|
1076
1074
|
Required scope | `pages:write`
|
|
1077
1075
|
|
|
1078
1076
|
</dd>
|
|
@@ -1159,11 +1157,9 @@ await client.pages.updatePageSettings("63c720f9347c2139b248e552", {
|
|
|
1159
1157
|
<dl>
|
|
1160
1158
|
<dd>
|
|
1161
1159
|
|
|
1162
|
-
Get content from a static page.
|
|
1163
|
-
|
|
1164
|
-
To retrieve the static content of a component instance, use the [Get Component Content](/data/reference/pages-and-components/components/get-content) endpoint.
|
|
1160
|
+
Get text and component instance content from a static page.
|
|
1165
1161
|
|
|
1166
|
-
<
|
|
1162
|
+
<Badge intent="info">Localization</Badge>
|
|
1167
1163
|
|
|
1168
1164
|
Required scope | `pages:read`
|
|
1169
1165
|
|
|
@@ -1183,6 +1179,8 @@ Required scope | `pages:read`
|
|
|
1183
1179
|
```typescript
|
|
1184
1180
|
await client.pages.getContent("63c720f9347c2139b248e552", {
|
|
1185
1181
|
localeId: "65427cf400e02b306eaa04a0",
|
|
1182
|
+
limit: 1,
|
|
1183
|
+
offset: 1,
|
|
1186
1184
|
});
|
|
1187
1185
|
```
|
|
1188
1186
|
|
|
@@ -1242,8 +1240,9 @@ This endpoint updates content on a static page in **secondary locales**. It supp
|
|
|
1242
1240
|
|
|
1243
1241
|
Before making updates:
|
|
1244
1242
|
|
|
1245
|
-
1. Use the [get page content](/data/reference/pages-and-components/pages/get-content) endpoint to identify available content nodes and their types
|
|
1246
|
-
2. If the page has component instances, retrieve the component's properties that you'll override using the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint
|
|
1243
|
+
1. Use the [get page content](/data/reference/pages-and-components/pages/get-content) endpoint to identify available content nodes and their types.
|
|
1244
|
+
2. If the page has component instances, retrieve the component's properties that you'll override using the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint.
|
|
1245
|
+
3. DOM elements may include a `data-w-id` attribute. This attribute is used by Webflow to maintain custom attributes and links across locales. Always include the original `data-w-id` value in your update requests to ensure consistent behavior across all locales.
|
|
1247
1246
|
|
|
1248
1247
|
<Note>
|
|
1249
1248
|
This endpoint is specifically for localized pages. Ensure that the specified `localeId` is a valid **secondary locale** for the site otherwise the request will fail.
|
|
@@ -1389,6 +1388,8 @@ Required scope | `components:read`
|
|
|
1389
1388
|
```typescript
|
|
1390
1389
|
await client.components.list("580e63e98c9a982ac9b8b741", {
|
|
1391
1390
|
branchId: "68026fa68ef6dc744c75b833",
|
|
1391
|
+
limit: 1,
|
|
1392
|
+
offset: 1,
|
|
1392
1393
|
});
|
|
1393
1394
|
```
|
|
1394
1395
|
|
|
@@ -1468,6 +1469,8 @@ Required scope | `components:read`
|
|
|
1468
1469
|
await client.components.getContent("580e63e98c9a982ac9b8b741", "8505ba55-ef72-629e-f85c-33e4b703d48b", {
|
|
1469
1470
|
localeId: "65427cf400e02b306eaa04a0",
|
|
1470
1471
|
branchId: "68026fa68ef6dc744c75b833",
|
|
1472
|
+
limit: 1,
|
|
1473
|
+
offset: 1,
|
|
1471
1474
|
});
|
|
1472
1475
|
```
|
|
1473
1476
|
|
|
@@ -1535,8 +1538,9 @@ This endpoint updates content within a component defintion for **secondary local
|
|
|
1535
1538
|
|
|
1536
1539
|
Before making updates:
|
|
1537
1540
|
|
|
1538
|
-
1. Use the [get component content](/data/reference/pages-and-components/components/get-content) endpoint to identify available content nodes and their types
|
|
1539
|
-
2. If your component definition has a component instance nested within it, retrieve the nested component instance's properties that you'll override using the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint
|
|
1541
|
+
1. Use the [get component content](/data/reference/pages-and-components/components/get-content) endpoint to identify available content nodes and their types.
|
|
1542
|
+
2. If your component definition has a component instance nested within it, retrieve the nested component instance's properties that you'll override using the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint.
|
|
1543
|
+
3. DOM elements may include a `data-w-id` attribute. This attribute is used by Webflow to maintain custom attributes and links across locales. Always include the original `data-w-id` value in your update requests to ensure consistent behavior across all locales.
|
|
1540
1544
|
|
|
1541
1545
|
<Note>
|
|
1542
1546
|
This endpoint is specifically for localizing component definitions. Ensure that the specified `localeId` is a valid **secondary locale** for the site otherwise the request will fail.
|
|
@@ -1692,6 +1696,8 @@ Required scope | `components:read`
|
|
|
1692
1696
|
await client.components.getProperties("580e63e98c9a982ac9b8b741", "8505ba55-ef72-629e-f85c-33e4b703d48b", {
|
|
1693
1697
|
localeId: "65427cf400e02b306eaa04a0",
|
|
1694
1698
|
branchId: "68026fa68ef6dc744c75b833",
|
|
1699
|
+
limit: 1,
|
|
1700
|
+
offset: 1,
|
|
1695
1701
|
});
|
|
1696
1702
|
```
|
|
1697
1703
|
|
|
@@ -1757,7 +1763,10 @@ await client.components.getProperties("580e63e98c9a982ac9b8b741", "8505ba55-ef72
|
|
|
1757
1763
|
|
|
1758
1764
|
Update the default property values of a component definition in a specificed locale.
|
|
1759
1765
|
|
|
1760
|
-
Before making updates
|
|
1766
|
+
Before making updates:
|
|
1767
|
+
|
|
1768
|
+
1. Use the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint to identify properties that can be updated in a secondary locale.
|
|
1769
|
+
2. Rich Text properties may include a `data-w-id` attribute. This attribute is used by Webflow to maintain links across locales. Always include the original `data-w-id` value in your update requests to ensure consistent behavior across all locales.
|
|
1761
1770
|
|
|
1762
1771
|
<Note>The request requires a secondary locale ID. If a `localeId` is missing, the request will not be processed and will result in an error.</Note>
|
|
1763
1772
|
|
|
@@ -2077,7 +2086,7 @@ await client.scripts.registerInline("580e63e98c9a982ac9b8b741", {
|
|
|
2077
2086
|
|
|
2078
2087
|
## Assets
|
|
2079
2088
|
|
|
2080
|
-
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">list</a>(siteId) -> Webflow.Assets</code></summary>
|
|
2089
|
+
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">list</a>(siteId, { ...params }) -> Webflow.Assets</code></summary>
|
|
2081
2090
|
<dl>
|
|
2082
2091
|
<dd>
|
|
2083
2092
|
|
|
@@ -2107,7 +2116,10 @@ Required scope | `assets:read`
|
|
|
2107
2116
|
<dd>
|
|
2108
2117
|
|
|
2109
2118
|
```typescript
|
|
2110
|
-
await client.assets.list("580e63e98c9a982ac9b8b741"
|
|
2119
|
+
await client.assets.list("580e63e98c9a982ac9b8b741", {
|
|
2120
|
+
offset: 1,
|
|
2121
|
+
limit: 1,
|
|
2122
|
+
});
|
|
2111
2123
|
```
|
|
2112
2124
|
|
|
2113
2125
|
</dd>
|
|
@@ -2131,6 +2143,14 @@ await client.assets.list("580e63e98c9a982ac9b8b741");
|
|
|
2131
2143
|
<dl>
|
|
2132
2144
|
<dd>
|
|
2133
2145
|
|
|
2146
|
+
**request:** `Webflow.AssetsListRequest`
|
|
2147
|
+
|
|
2148
|
+
</dd>
|
|
2149
|
+
</dl>
|
|
2150
|
+
|
|
2151
|
+
<dl>
|
|
2152
|
+
<dd>
|
|
2153
|
+
|
|
2134
2154
|
**requestOptions:** `Assets.RequestOptions`
|
|
2135
2155
|
|
|
2136
2156
|
</dd>
|
|
@@ -2945,7 +2965,10 @@ Required scope | `forms:read`
|
|
|
2945
2965
|
<dd>
|
|
2946
2966
|
|
|
2947
2967
|
```typescript
|
|
2948
|
-
await client.forms.list("580e63e98c9a982ac9b8b741"
|
|
2968
|
+
await client.forms.list("580e63e98c9a982ac9b8b741", {
|
|
2969
|
+
limit: 1,
|
|
2970
|
+
offset: 1,
|
|
2971
|
+
});
|
|
2949
2972
|
```
|
|
2950
2973
|
|
|
2951
2974
|
</dd>
|
|
@@ -3089,7 +3112,10 @@ Required scope | `forms:read`
|
|
|
3089
3112
|
<dd>
|
|
3090
3113
|
|
|
3091
3114
|
```typescript
|
|
3092
|
-
await client.forms.listSubmissions("580e63e98c9a982ac9b8b741"
|
|
3115
|
+
await client.forms.listSubmissions("580e63e98c9a982ac9b8b741", {
|
|
3116
|
+
offset: 1,
|
|
3117
|
+
limit: 1,
|
|
3118
|
+
});
|
|
3093
3119
|
```
|
|
3094
3120
|
|
|
3095
3121
|
</dd>
|
|
@@ -3335,81 +3361,6 @@ await client.forms.updateSubmission("580e63e98c9a982ac9b8b741");
|
|
|
3335
3361
|
</dl>
|
|
3336
3362
|
</details>
|
|
3337
3363
|
|
|
3338
|
-
<details><summary><code>client.forms.<a href="/src/api/resources/forms/client/Client.ts">listSubmissionsBySite</a>(siteId, { ...params }) -> Webflow.FormSubmissionList</code></summary>
|
|
3339
|
-
<dl>
|
|
3340
|
-
<dd>
|
|
3341
|
-
|
|
3342
|
-
#### 📝 Description
|
|
3343
|
-
|
|
3344
|
-
<dl>
|
|
3345
|
-
<dd>
|
|
3346
|
-
|
|
3347
|
-
<dl>
|
|
3348
|
-
<dd>
|
|
3349
|
-
|
|
3350
|
-
List form submissions for a given site. This endpoint differs from the existing [List Form Submissions endpoint](/data/reference/forms/form-submissions/list-submissions) by accepting `siteId` as a path parameter and `elementId` as a query parameter. You can get the `elementId` from the [List forms endpoint](/data/reference/forms/forms/list).
|
|
3351
|
-
|
|
3352
|
-
Required scope | `forms:read`
|
|
3353
|
-
|
|
3354
|
-
</dd>
|
|
3355
|
-
</dl>
|
|
3356
|
-
</dd>
|
|
3357
|
-
</dl>
|
|
3358
|
-
|
|
3359
|
-
#### 🔌 Usage
|
|
3360
|
-
|
|
3361
|
-
<dl>
|
|
3362
|
-
<dd>
|
|
3363
|
-
|
|
3364
|
-
<dl>
|
|
3365
|
-
<dd>
|
|
3366
|
-
|
|
3367
|
-
```typescript
|
|
3368
|
-
await client.forms.listSubmissionsBySite("580e63e98c9a982ac9b8b741", {
|
|
3369
|
-
elementId: "18259716-3e5a-646a-5f41-5dc4b9405aa0",
|
|
3370
|
-
});
|
|
3371
|
-
```
|
|
3372
|
-
|
|
3373
|
-
</dd>
|
|
3374
|
-
</dl>
|
|
3375
|
-
</dd>
|
|
3376
|
-
</dl>
|
|
3377
|
-
|
|
3378
|
-
#### ⚙️ Parameters
|
|
3379
|
-
|
|
3380
|
-
<dl>
|
|
3381
|
-
<dd>
|
|
3382
|
-
|
|
3383
|
-
<dl>
|
|
3384
|
-
<dd>
|
|
3385
|
-
|
|
3386
|
-
**siteId:** `string` — Unique identifier for a Site
|
|
3387
|
-
|
|
3388
|
-
</dd>
|
|
3389
|
-
</dl>
|
|
3390
|
-
|
|
3391
|
-
<dl>
|
|
3392
|
-
<dd>
|
|
3393
|
-
|
|
3394
|
-
**request:** `Webflow.FormsListSubmissionsBySiteRequest`
|
|
3395
|
-
|
|
3396
|
-
</dd>
|
|
3397
|
-
</dl>
|
|
3398
|
-
|
|
3399
|
-
<dl>
|
|
3400
|
-
<dd>
|
|
3401
|
-
|
|
3402
|
-
**requestOptions:** `Forms.RequestOptions`
|
|
3403
|
-
|
|
3404
|
-
</dd>
|
|
3405
|
-
</dl>
|
|
3406
|
-
</dd>
|
|
3407
|
-
</dl>
|
|
3408
|
-
|
|
3409
|
-
</dd>
|
|
3410
|
-
</dl>
|
|
3411
|
-
</details>
|
|
3412
|
-
|
|
3413
3364
|
## Users
|
|
3414
3365
|
|
|
3415
3366
|
<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">list</a>(siteId, { ...params }) -> Webflow.UserList</code></summary>
|
|
@@ -3424,6 +3375,8 @@ await client.forms.listSubmissionsBySite("580e63e98c9a982ac9b8b741", {
|
|
|
3424
3375
|
<dl>
|
|
3425
3376
|
<dd>
|
|
3426
3377
|
|
|
3378
|
+
<Warning>As of **January 29, 2026**, User Accounts functionality has been disabled on all Webflow sites. This endpoint is no longer available.</Warning>
|
|
3379
|
+
|
|
3427
3380
|
Get a list of users for a site
|
|
3428
3381
|
|
|
3429
3382
|
Required scope | `users:read`
|
|
@@ -3442,7 +3395,11 @@ Required scope | `users:read`
|
|
|
3442
3395
|
<dd>
|
|
3443
3396
|
|
|
3444
3397
|
```typescript
|
|
3445
|
-
await client.users.list("580e63e98c9a982ac9b8b741"
|
|
3398
|
+
await client.users.list("580e63e98c9a982ac9b8b741", {
|
|
3399
|
+
offset: 1,
|
|
3400
|
+
limit: 1,
|
|
3401
|
+
sort: "CreatedOn",
|
|
3402
|
+
});
|
|
3446
3403
|
```
|
|
3447
3404
|
|
|
3448
3405
|
</dd>
|
|
@@ -3497,6 +3454,8 @@ await client.users.list("580e63e98c9a982ac9b8b741");
|
|
|
3497
3454
|
<dl>
|
|
3498
3455
|
<dd>
|
|
3499
3456
|
|
|
3457
|
+
<Warning>As of **January 29, 2026**, User Accounts functionality has been disabled on all Webflow sites. This endpoint is no longer available.</Warning>
|
|
3458
|
+
|
|
3500
3459
|
Get a User by ID
|
|
3501
3460
|
|
|
3502
3461
|
Required scope | `users:read`
|
|
@@ -3570,6 +3529,8 @@ await client.users.get("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741");
|
|
|
3570
3529
|
<dl>
|
|
3571
3530
|
<dd>
|
|
3572
3531
|
|
|
3532
|
+
<Warning>As of **January 29, 2026**, User Accounts functionality has been disabled on all Webflow sites. This endpoint is no longer available.</Warning>
|
|
3533
|
+
|
|
3573
3534
|
Delete a User by ID
|
|
3574
3535
|
|
|
3575
3536
|
Required scope | `users:write`
|
|
@@ -3643,6 +3604,8 @@ await client.users.delete("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741"
|
|
|
3643
3604
|
<dl>
|
|
3644
3605
|
<dd>
|
|
3645
3606
|
|
|
3607
|
+
<Warning>As of **January 29, 2026**, User Accounts functionality has been disabled on all Webflow sites. This endpoint is no longer available.</Warning>
|
|
3608
|
+
|
|
3646
3609
|
Update a User by ID
|
|
3647
3610
|
|
|
3648
3611
|
Required scope | `users:write`
|
|
@@ -3741,6 +3704,8 @@ await client.users.update("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741"
|
|
|
3741
3704
|
<dl>
|
|
3742
3705
|
<dd>
|
|
3743
3706
|
|
|
3707
|
+
<Warning>As of **January 29, 2026**, User Accounts functionality has been disabled on all Webflow sites. This endpoint is no longer available.</Warning>
|
|
3708
|
+
|
|
3744
3709
|
Create and invite a user with an email address.
|
|
3745
3710
|
|
|
3746
3711
|
The user will be sent and invite via email, which they will need to accept in order to join paid any paid access group.
|
|
@@ -3821,6 +3786,8 @@ await client.users.invite("580e63e98c9a982ac9b8b741", {
|
|
|
3821
3786
|
<dl>
|
|
3822
3787
|
<dd>
|
|
3823
3788
|
|
|
3789
|
+
<Warning>As of **January 29, 2026**, User Accounts functionality has been disabled on all Webflow sites. This endpoint is no longer available.</Warning>
|
|
3790
|
+
|
|
3824
3791
|
Get a list of access groups for a site
|
|
3825
3792
|
|
|
3826
3793
|
Required scope | `users:read`
|
|
@@ -3839,7 +3806,11 @@ Required scope | `users:read`
|
|
|
3839
3806
|
<dd>
|
|
3840
3807
|
|
|
3841
3808
|
```typescript
|
|
3842
|
-
await client.accessGroups.list("580e63e98c9a982ac9b8b741"
|
|
3809
|
+
await client.accessGroups.list("580e63e98c9a982ac9b8b741", {
|
|
3810
|
+
offset: 1,
|
|
3811
|
+
limit: 1,
|
|
3812
|
+
sort: "CreatedOn",
|
|
3813
|
+
});
|
|
3843
3814
|
```
|
|
3844
3815
|
|
|
3845
3816
|
</dd>
|
|
@@ -3917,7 +3888,10 @@ Required scope | `ecommerce:read`
|
|
|
3917
3888
|
<dd>
|
|
3918
3889
|
|
|
3919
3890
|
```typescript
|
|
3920
|
-
await client.products.list("580e63e98c9a982ac9b8b741"
|
|
3891
|
+
await client.products.list("580e63e98c9a982ac9b8b741", {
|
|
3892
|
+
offset: 1,
|
|
3893
|
+
limit: 1,
|
|
3894
|
+
});
|
|
3921
3895
|
```
|
|
3922
3896
|
|
|
3923
3897
|
</dd>
|
|
@@ -4506,7 +4480,11 @@ Required scope | `ecommerce:read`
|
|
|
4506
4480
|
<dd>
|
|
4507
4481
|
|
|
4508
4482
|
```typescript
|
|
4509
|
-
await client.orders.list("580e63e98c9a982ac9b8b741"
|
|
4483
|
+
await client.orders.list("580e63e98c9a982ac9b8b741", {
|
|
4484
|
+
status: "pending",
|
|
4485
|
+
offset: 1,
|
|
4486
|
+
limit: 1,
|
|
4487
|
+
});
|
|
4510
4488
|
```
|
|
4511
4489
|
|
|
4512
4490
|
</dd>
|
|
@@ -4944,7 +4922,7 @@ await client.orders.refund("580e63e98c9a982ac9b8b741", "5e8518516e147040726cc415
|
|
|
4944
4922
|
|
|
4945
4923
|
## Inventory
|
|
4946
4924
|
|
|
4947
|
-
<details><summary><code>client.inventory.<a href="/src/api/resources/inventory/client/Client.ts">list</a>(
|
|
4925
|
+
<details><summary><code>client.inventory.<a href="/src/api/resources/inventory/client/Client.ts">list</a>(skuCollectionId, skuId) -> Webflow.InventoryItem</code></summary>
|
|
4948
4926
|
<dl>
|
|
4949
4927
|
<dd>
|
|
4950
4928
|
|
|
@@ -4974,7 +4952,7 @@ Required scope | `ecommerce:read`
|
|
|
4974
4952
|
<dd>
|
|
4975
4953
|
|
|
4976
4954
|
```typescript
|
|
4977
|
-
await client.inventory.list("
|
|
4955
|
+
await client.inventory.list("6377a7c4b7a79608c34a46f7", "5e8518516e147040726cc415");
|
|
4978
4956
|
```
|
|
4979
4957
|
|
|
4980
4958
|
</dd>
|
|
@@ -4990,7 +4968,7 @@ await client.inventory.list("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b75
|
|
|
4990
4968
|
<dl>
|
|
4991
4969
|
<dd>
|
|
4992
4970
|
|
|
4993
|
-
**
|
|
4971
|
+
**skuCollectionId:** `string` — Unique identifier for a SKU collection. Use the List Collections API to find this ID.
|
|
4994
4972
|
|
|
4995
4973
|
</dd>
|
|
4996
4974
|
</dl>
|
|
@@ -4998,7 +4976,7 @@ await client.inventory.list("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b75
|
|
|
4998
4976
|
<dl>
|
|
4999
4977
|
<dd>
|
|
5000
4978
|
|
|
5001
|
-
**
|
|
4979
|
+
**skuId:** `string` — Unique identifier for a SKU
|
|
5002
4980
|
|
|
5003
4981
|
</dd>
|
|
5004
4982
|
</dl>
|
|
@@ -5017,7 +4995,7 @@ await client.inventory.list("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b75
|
|
|
5017
4995
|
</dl>
|
|
5018
4996
|
</details>
|
|
5019
4997
|
|
|
5020
|
-
<details><summary><code>client.inventory.<a href="/src/api/resources/inventory/client/Client.ts">update</a>(
|
|
4998
|
+
<details><summary><code>client.inventory.<a href="/src/api/resources/inventory/client/Client.ts">update</a>(skuCollectionId, skuId, { ...params }) -> Webflow.InventoryItem</code></summary>
|
|
5021
4999
|
<dl>
|
|
5022
5000
|
<dd>
|
|
5023
5001
|
|
|
@@ -5052,7 +5030,7 @@ Required scope | `ecommerce:write`
|
|
|
5052
5030
|
<dd>
|
|
5053
5031
|
|
|
5054
5032
|
```typescript
|
|
5055
|
-
await client.inventory.update("
|
|
5033
|
+
await client.inventory.update("6377a7c4b7a79608c34a46f7", "5e8518516e147040726cc415", {
|
|
5056
5034
|
inventoryType: "infinite",
|
|
5057
5035
|
});
|
|
5058
5036
|
```
|
|
@@ -5070,7 +5048,7 @@ await client.inventory.update("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b
|
|
|
5070
5048
|
<dl>
|
|
5071
5049
|
<dd>
|
|
5072
5050
|
|
|
5073
|
-
**
|
|
5051
|
+
**skuCollectionId:** `string` — Unique identifier for a SKU collection. Use the List Collections API to find this ID.
|
|
5074
5052
|
|
|
5075
5053
|
</dd>
|
|
5076
5054
|
</dl>
|
|
@@ -5078,7 +5056,7 @@ await client.inventory.update("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b
|
|
|
5078
5056
|
<dl>
|
|
5079
5057
|
<dd>
|
|
5080
5058
|
|
|
5081
|
-
**
|
|
5059
|
+
**skuId:** `string` — Unique identifier for a SKU
|
|
5082
5060
|
|
|
5083
5061
|
</dd>
|
|
5084
5062
|
</dl>
|
|
@@ -5448,7 +5426,15 @@ Required scope | `CMS:read`
|
|
|
5448
5426
|
<dd>
|
|
5449
5427
|
|
|
5450
5428
|
```typescript
|
|
5451
|
-
await client.collections.items.listItems("580e63fc8c9a982ac9b8b745"
|
|
5429
|
+
await client.collections.items.listItems("580e63fc8c9a982ac9b8b745", {
|
|
5430
|
+
cmsLocaleId: "cmsLocaleId",
|
|
5431
|
+
offset: 1,
|
|
5432
|
+
limit: 1,
|
|
5433
|
+
name: "name",
|
|
5434
|
+
slug: "slug",
|
|
5435
|
+
sortBy: "lastPublished",
|
|
5436
|
+
sortOrder: "asc",
|
|
5437
|
+
});
|
|
5452
5438
|
```
|
|
5453
5439
|
|
|
5454
5440
|
</dd>
|
|
@@ -5524,12 +5510,13 @@ Required scope | `CMS:write`
|
|
|
5524
5510
|
|
|
5525
5511
|
```typescript
|
|
5526
5512
|
await client.collections.items.createItem("580e63fc8c9a982ac9b8b745", {
|
|
5513
|
+
skipInvalidFiles: true,
|
|
5527
5514
|
body: {
|
|
5528
5515
|
isArchived: false,
|
|
5529
5516
|
isDraft: false,
|
|
5530
5517
|
fieldData: {
|
|
5531
|
-
name: "
|
|
5532
|
-
slug: "
|
|
5518
|
+
name: "The Hitchhiker's Guide to the Galaxy",
|
|
5519
|
+
slug: "hitchhikers-guide-to-the-galaxy",
|
|
5533
5520
|
},
|
|
5534
5521
|
},
|
|
5535
5522
|
});
|
|
@@ -5691,6 +5678,7 @@ Required scope | `CMS:write`
|
|
|
5691
5678
|
|
|
5692
5679
|
```typescript
|
|
5693
5680
|
await client.collections.items.updateItems("580e63fc8c9a982ac9b8b745", {
|
|
5681
|
+
skipInvalidFiles: true,
|
|
5694
5682
|
items: [
|
|
5695
5683
|
{
|
|
5696
5684
|
id: "66f6ed9576ddacf3149d5ea6",
|
|
@@ -5782,10 +5770,9 @@ await client.collections.items.updateItems("580e63fc8c9a982ac9b8b745", {
|
|
|
5782
5770
|
|
|
5783
5771
|
List all published items in a collection.
|
|
5784
5772
|
|
|
5785
|
-
<
|
|
5786
|
-
|
|
5787
|
-
|
|
5788
|
-
</Note>
|
|
5773
|
+
<Tip title="Serve data with the Content Delivery API">
|
|
5774
|
+
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.
|
|
5775
|
+
</Tip>
|
|
5789
5776
|
|
|
5790
5777
|
Required scope | `CMS:read`
|
|
5791
5778
|
|
|
@@ -5803,7 +5790,15 @@ Required scope | `CMS:read`
|
|
|
5803
5790
|
<dd>
|
|
5804
5791
|
|
|
5805
5792
|
```typescript
|
|
5806
|
-
await client.collections.items.listItemsLive("580e63fc8c9a982ac9b8b745"
|
|
5793
|
+
await client.collections.items.listItemsLive("580e63fc8c9a982ac9b8b745", {
|
|
5794
|
+
cmsLocaleId: "cmsLocaleId",
|
|
5795
|
+
offset: 1,
|
|
5796
|
+
limit: 1,
|
|
5797
|
+
name: "name",
|
|
5798
|
+
slug: "slug",
|
|
5799
|
+
sortBy: "lastPublished",
|
|
5800
|
+
sortOrder: "asc",
|
|
5801
|
+
});
|
|
5807
5802
|
```
|
|
5808
5803
|
|
|
5809
5804
|
</dd>
|
|
@@ -5879,12 +5874,13 @@ Required scope | `CMS:write`
|
|
|
5879
5874
|
|
|
5880
5875
|
```typescript
|
|
5881
5876
|
await client.collections.items.createItemLive("580e63fc8c9a982ac9b8b745", {
|
|
5877
|
+
skipInvalidFiles: true,
|
|
5882
5878
|
body: {
|
|
5883
5879
|
isArchived: false,
|
|
5884
5880
|
isDraft: false,
|
|
5885
5881
|
fieldData: {
|
|
5886
|
-
name: "
|
|
5887
|
-
slug: "
|
|
5882
|
+
name: "The Hitchhiker's Guide to the Galaxy",
|
|
5883
|
+
slug: "hitchhikers-guide-to-the-galaxy",
|
|
5888
5884
|
},
|
|
5889
5885
|
},
|
|
5890
5886
|
});
|
|
@@ -6044,6 +6040,7 @@ Required scope | `CMS:write`
|
|
|
6044
6040
|
|
|
6045
6041
|
```typescript
|
|
6046
6042
|
await client.collections.items.updateItemsLive("580e63fc8c9a982ac9b8b745", {
|
|
6043
|
+
skipInvalidFiles: true,
|
|
6047
6044
|
items: [
|
|
6048
6045
|
{
|
|
6049
6046
|
id: "66f6ed9576ddacf3149d5ea6",
|
|
@@ -6157,6 +6154,7 @@ Required scope | `CMS:write`
|
|
|
6157
6154
|
|
|
6158
6155
|
```typescript
|
|
6159
6156
|
await client.collections.items.createItems("580e63fc8c9a982ac9b8b745", {
|
|
6157
|
+
skipInvalidFiles: true,
|
|
6160
6158
|
cmsLocaleIds: ["66f6e966c9e1dc700a857ca3", "66f6e966c9e1dc700a857ca4", "66f6e966c9e1dc700a857ca5"],
|
|
6161
6159
|
isArchived: false,
|
|
6162
6160
|
isDraft: false,
|
|
@@ -6237,7 +6235,9 @@ Required scope | `CMS:read`
|
|
|
6237
6235
|
<dd>
|
|
6238
6236
|
|
|
6239
6237
|
```typescript
|
|
6240
|
-
await client.collections.items.getItem("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754"
|
|
6238
|
+
await client.collections.items.getItem("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754", {
|
|
6239
|
+
cmsLocaleId: "cmsLocaleId",
|
|
6240
|
+
});
|
|
6241
6241
|
```
|
|
6242
6242
|
|
|
6243
6243
|
</dd>
|
|
@@ -6318,7 +6318,9 @@ Required scope | `CMS:write`
|
|
|
6318
6318
|
<dd>
|
|
6319
6319
|
|
|
6320
6320
|
```typescript
|
|
6321
|
-
await client.collections.items.deleteItem("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754"
|
|
6321
|
+
await client.collections.items.deleteItem("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754", {
|
|
6322
|
+
cmsLocaleId: "cmsLocaleId",
|
|
6323
|
+
});
|
|
6322
6324
|
```
|
|
6323
6325
|
|
|
6324
6326
|
</dd>
|
|
@@ -6400,12 +6402,13 @@ Required scope | `CMS:write`
|
|
|
6400
6402
|
|
|
6401
6403
|
```typescript
|
|
6402
6404
|
await client.collections.items.updateItem("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754", {
|
|
6405
|
+
skipInvalidFiles: true,
|
|
6403
6406
|
body: {
|
|
6404
6407
|
isArchived: false,
|
|
6405
6408
|
isDraft: false,
|
|
6406
6409
|
fieldData: {
|
|
6407
|
-
name: "
|
|
6408
|
-
slug: "
|
|
6410
|
+
name: "The Hitchhiker's Guide to the Galaxy",
|
|
6411
|
+
slug: "hitchhikers-guide-to-the-galaxy",
|
|
6409
6412
|
},
|
|
6410
6413
|
},
|
|
6411
6414
|
});
|
|
@@ -6473,10 +6476,9 @@ await client.collections.items.updateItem("580e63fc8c9a982ac9b8b745", "580e64008
|
|
|
6473
6476
|
|
|
6474
6477
|
Get details of a selected Collection live Item.
|
|
6475
6478
|
|
|
6476
|
-
<
|
|
6477
|
-
|
|
6478
|
-
|
|
6479
|
-
</Note>
|
|
6479
|
+
<Tip title="Serve data with the Content Delivery API">
|
|
6480
|
+
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.
|
|
6481
|
+
</Tip>
|
|
6480
6482
|
|
|
6481
6483
|
Required scope | `CMS:read`
|
|
6482
6484
|
|
|
@@ -6494,7 +6496,9 @@ Required scope | `CMS:read`
|
|
|
6494
6496
|
<dd>
|
|
6495
6497
|
|
|
6496
6498
|
```typescript
|
|
6497
|
-
await client.collections.items.getItemLive("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754"
|
|
6499
|
+
await client.collections.items.getItemLive("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754", {
|
|
6500
|
+
cmsLocaleId: "cmsLocaleId",
|
|
6501
|
+
});
|
|
6498
6502
|
```
|
|
6499
6503
|
|
|
6500
6504
|
</dd>
|
|
@@ -6577,7 +6581,9 @@ Required scope | `CMS:write`
|
|
|
6577
6581
|
<dd>
|
|
6578
6582
|
|
|
6579
6583
|
```typescript
|
|
6580
|
-
await client.collections.items.deleteItemLive("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754"
|
|
6584
|
+
await client.collections.items.deleteItemLive("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754", {
|
|
6585
|
+
cmsLocaleId: "cmsLocaleId",
|
|
6586
|
+
});
|
|
6581
6587
|
```
|
|
6582
6588
|
|
|
6583
6589
|
</dd>
|
|
@@ -6659,12 +6665,13 @@ Required scope | `CMS:write`
|
|
|
6659
6665
|
|
|
6660
6666
|
```typescript
|
|
6661
6667
|
await client.collections.items.updateItemLive("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754", {
|
|
6668
|
+
skipInvalidFiles: true,
|
|
6662
6669
|
body: {
|
|
6663
6670
|
isArchived: false,
|
|
6664
6671
|
isDraft: false,
|
|
6665
6672
|
fieldData: {
|
|
6666
|
-
name: "
|
|
6667
|
-
slug: "
|
|
6673
|
+
name: "The Hitchhiker's Guide to the Galaxy",
|
|
6674
|
+
slug: "hitchhikers-guide-to-the-galaxy",
|
|
6668
6675
|
},
|
|
6669
6676
|
},
|
|
6670
6677
|
});
|
|
@@ -6872,7 +6879,7 @@ await client.pages.scripts.getCustomCode("63c720f9347c2139b248e552");
|
|
|
6872
6879
|
<dl>
|
|
6873
6880
|
<dd>
|
|
6874
6881
|
|
|
6875
|
-
Apply scripts to a page.
|
|
6882
|
+
Apply registered scripts to a page. If you have multiple scripts your App needs to apply or maintain on a page, ensure they are always included in the request body for this endpoint. To remove individual scripts, simply call this endpoint without the script in the request body.
|
|
6876
6883
|
|
|
6877
6884
|
<Note title="Script Registration">
|
|
6878
6885
|
To apply a script to a page, the script must first be registered to a Site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information.
|
|
@@ -6965,9 +6972,11 @@ await client.pages.scripts.upsertCustomCode("63c720f9347c2139b248e552", {
|
|
|
6965
6972
|
<dl>
|
|
6966
6973
|
<dd>
|
|
6967
6974
|
|
|
6968
|
-
|
|
6975
|
+
Remove all scripts from a page applied by the App. This endpoint will not remove scripts from the site's registered scripts.
|
|
6969
6976
|
|
|
6970
|
-
|
|
6977
|
+
To remove individual scripts applied by the App, use the [Add/Update Custom Code](/data/reference/custom-code/custom-code-pages/upsert-custom-code) endpoint.
|
|
6978
|
+
|
|
6979
|
+
<Note>Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app).</Note>
|
|
6971
6980
|
|
|
6972
6981
|
Required scope | `custom_code:write`
|
|
6973
6982
|
|
|
@@ -7772,8 +7781,10 @@ Required scope: `site_config:write`
|
|
|
7772
7781
|
|
|
7773
7782
|
```typescript
|
|
7774
7783
|
await client.sites.wellKnown.put("580e63e98c9a982ac9b8b741", {
|
|
7775
|
-
fileName: "
|
|
7776
|
-
fileData:
|
|
7784
|
+
fileName: "apple-app-site-association.txt",
|
|
7785
|
+
fileData:
|
|
7786
|
+
'{\n "applinks": {\n "apps": [],\n "details": [\n {\n "appID": "ABCDE12345.com.example.app",\n "paths": [ "/*", "/some/path/*" ]\n }\n ]\n }\n}\n',
|
|
7787
|
+
contentType: "application/json",
|
|
7777
7788
|
});
|
|
7778
7789
|
```
|
|
7779
7790
|
|
|
@@ -7926,7 +7937,10 @@ Required scope: `site_activity:read`
|
|
|
7926
7937
|
<dd>
|
|
7927
7938
|
|
|
7928
7939
|
```typescript
|
|
7929
|
-
await client.sites.activityLogs.list("580e63e98c9a982ac9b8b741"
|
|
7940
|
+
await client.sites.activityLogs.list("580e63e98c9a982ac9b8b741", {
|
|
7941
|
+
limit: 1,
|
|
7942
|
+
offset: 1,
|
|
7943
|
+
});
|
|
7930
7944
|
```
|
|
7931
7945
|
|
|
7932
7946
|
</dd>
|
|
@@ -8007,6 +8021,10 @@ Required scope | `comments:read`
|
|
|
8007
8021
|
```typescript
|
|
8008
8022
|
await client.sites.comments.listCommentThreads("580e63e98c9a982ac9b8b741", {
|
|
8009
8023
|
localeId: "65427cf400e02b306eaa04a0",
|
|
8024
|
+
offset: 1,
|
|
8025
|
+
limit: 1,
|
|
8026
|
+
sortBy: "createdOn",
|
|
8027
|
+
sortOrder: "asc",
|
|
8010
8028
|
});
|
|
8011
8029
|
```
|
|
8012
8030
|
|
|
@@ -8086,6 +8104,10 @@ Required scope | `comments:read`
|
|
|
8086
8104
|
```typescript
|
|
8087
8105
|
await client.sites.comments.getCommentThread("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741", {
|
|
8088
8106
|
localeId: "65427cf400e02b306eaa04a0",
|
|
8107
|
+
offset: 1,
|
|
8108
|
+
limit: 1,
|
|
8109
|
+
sortBy: "createdOn",
|
|
8110
|
+
sortOrder: "asc",
|
|
8089
8111
|
});
|
|
8090
8112
|
```
|
|
8091
8113
|
|
|
@@ -8173,6 +8195,10 @@ Required scope | `comments:read`
|
|
|
8173
8195
|
```typescript
|
|
8174
8196
|
await client.sites.comments.listCommentReplies("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741", {
|
|
8175
8197
|
localeId: "65427cf400e02b306eaa04a0",
|
|
8198
|
+
offset: 1,
|
|
8199
|
+
limit: 1,
|
|
8200
|
+
sortBy: "createdOn",
|
|
8201
|
+
sortOrder: "asc",
|
|
8176
8202
|
});
|
|
8177
8203
|
```
|
|
8178
8204
|
|
|
@@ -8307,7 +8333,7 @@ await client.sites.scripts.getCustomCode("580e63e98c9a982ac9b8b741");
|
|
|
8307
8333
|
<dl>
|
|
8308
8334
|
<dd>
|
|
8309
8335
|
|
|
8310
|
-
Apply registered scripts to a site.
|
|
8336
|
+
Apply registered scripts to a site. If you have multiple scripts your App needs to apply or maintain on a site, ensure they are always included in the request body for this endpoint. To remove individual scripts, simply call this endpoint without the script in the request body.
|
|
8311
8337
|
|
|
8312
8338
|
<Note title="Script Registration">
|
|
8313
8339
|
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.
|
|
@@ -8400,7 +8426,11 @@ await client.sites.scripts.upsertCustomCode("580e63e98c9a982ac9b8b741", {
|
|
|
8400
8426
|
<dl>
|
|
8401
8427
|
<dd>
|
|
8402
8428
|
|
|
8403
|
-
Remove scripts from a site applied by the App. This endpoint will not remove scripts from the site's registered scripts.
|
|
8429
|
+
Remove all scripts from a site applied by the App. This endpoint will not remove scripts from the site's registered scripts.
|
|
8430
|
+
|
|
8431
|
+
To remove individual scripts applied by the App, use the [Add/Update Custom Code](/data/reference/custom-code/custom-code-sites/upsert-custom-code) endpoint.
|
|
8432
|
+
|
|
8433
|
+
<Note>Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app).</Note>
|
|
8404
8434
|
|
|
8405
8435
|
Required scope | `custom_code:write`
|
|
8406
8436
|
|
|
@@ -8489,7 +8519,10 @@ Required scope | `custom_code:read`
|
|
|
8489
8519
|
<dd>
|
|
8490
8520
|
|
|
8491
8521
|
```typescript
|
|
8492
|
-
await client.sites.scripts.listCustomCodeBlocks("580e63e98c9a982ac9b8b741"
|
|
8522
|
+
await client.sites.scripts.listCustomCodeBlocks("580e63e98c9a982ac9b8b741", {
|
|
8523
|
+
offset: 1,
|
|
8524
|
+
limit: 1,
|
|
8525
|
+
});
|
|
8493
8526
|
```
|
|
8494
8527
|
|
|
8495
8528
|
</dd>
|
|
@@ -8532,6 +8565,406 @@ await client.sites.scripts.listCustomCodeBlocks("580e63e98c9a982ac9b8b741");
|
|
|
8532
8565
|
</dl>
|
|
8533
8566
|
</details>
|
|
8534
8567
|
|
|
8568
|
+
## Sites Forms
|
|
8569
|
+
|
|
8570
|
+
<details><summary><code>client.sites.forms.<a href="/src/api/resources/sites/resources/forms/client/Client.ts">listSubmissionsBySite</a>(siteId, { ...params }) -> Webflow.FormSubmissionList</code></summary>
|
|
8571
|
+
<dl>
|
|
8572
|
+
<dd>
|
|
8573
|
+
|
|
8574
|
+
#### 📝 Description
|
|
8575
|
+
|
|
8576
|
+
<dl>
|
|
8577
|
+
<dd>
|
|
8578
|
+
|
|
8579
|
+
<dl>
|
|
8580
|
+
<dd>
|
|
8581
|
+
|
|
8582
|
+
List all form submissions for a given site with the ability to filter submissions by a centralized `elementId`.
|
|
8583
|
+
|
|
8584
|
+
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).
|
|
8585
|
+
|
|
8586
|
+
<Note title="Forms in components">
|
|
8587
|
+
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.
|
|
8588
|
+
</Note>
|
|
8589
|
+
|
|
8590
|
+
Use the [List Form Submissions endpoint](/data/reference/forms/form-submissions/list-submissions) to list form submissions for a given form ID.
|
|
8591
|
+
|
|
8592
|
+
Required scope | `forms:read`
|
|
8593
|
+
|
|
8594
|
+
</dd>
|
|
8595
|
+
</dl>
|
|
8596
|
+
</dd>
|
|
8597
|
+
</dl>
|
|
8598
|
+
|
|
8599
|
+
#### 🔌 Usage
|
|
8600
|
+
|
|
8601
|
+
<dl>
|
|
8602
|
+
<dd>
|
|
8603
|
+
|
|
8604
|
+
<dl>
|
|
8605
|
+
<dd>
|
|
8606
|
+
|
|
8607
|
+
```typescript
|
|
8608
|
+
await client.sites.forms.listSubmissionsBySite("580e63e98c9a982ac9b8b741", {
|
|
8609
|
+
elementId: "18259716-3e5a-646a-5f41-5dc4b9405aa0",
|
|
8610
|
+
offset: 1,
|
|
8611
|
+
limit: 1,
|
|
8612
|
+
});
|
|
8613
|
+
```
|
|
8614
|
+
|
|
8615
|
+
</dd>
|
|
8616
|
+
</dl>
|
|
8617
|
+
</dd>
|
|
8618
|
+
</dl>
|
|
8619
|
+
|
|
8620
|
+
#### ⚙️ Parameters
|
|
8621
|
+
|
|
8622
|
+
<dl>
|
|
8623
|
+
<dd>
|
|
8624
|
+
|
|
8625
|
+
<dl>
|
|
8626
|
+
<dd>
|
|
8627
|
+
|
|
8628
|
+
**siteId:** `string` — Unique identifier for a Site
|
|
8629
|
+
|
|
8630
|
+
</dd>
|
|
8631
|
+
</dl>
|
|
8632
|
+
|
|
8633
|
+
<dl>
|
|
8634
|
+
<dd>
|
|
8635
|
+
|
|
8636
|
+
**request:** `Webflow.sites.FormsListSubmissionsBySiteRequest`
|
|
8637
|
+
|
|
8638
|
+
</dd>
|
|
8639
|
+
</dl>
|
|
8640
|
+
|
|
8641
|
+
<dl>
|
|
8642
|
+
<dd>
|
|
8643
|
+
|
|
8644
|
+
**requestOptions:** `Forms.RequestOptions`
|
|
8645
|
+
|
|
8646
|
+
</dd>
|
|
8647
|
+
</dl>
|
|
8648
|
+
</dd>
|
|
8649
|
+
</dl>
|
|
8650
|
+
|
|
8651
|
+
</dd>
|
|
8652
|
+
</dl>
|
|
8653
|
+
</details>
|
|
8654
|
+
|
|
8655
|
+
<details><summary><code>client.sites.forms.<a href="/src/api/resources/sites/resources/forms/client/Client.ts">listSubmissions</a>(siteId, formId, { ...params }) -> Webflow.FormSubmissionList</code></summary>
|
|
8656
|
+
<dl>
|
|
8657
|
+
<dd>
|
|
8658
|
+
|
|
8659
|
+
#### 📝 Description
|
|
8660
|
+
|
|
8661
|
+
<dl>
|
|
8662
|
+
<dd>
|
|
8663
|
+
|
|
8664
|
+
<dl>
|
|
8665
|
+
<dd>
|
|
8666
|
+
|
|
8667
|
+
List form submissions for a given form ID within a specific site.
|
|
8668
|
+
|
|
8669
|
+
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`.
|
|
8670
|
+
|
|
8671
|
+
Required scope | `forms:read`
|
|
8672
|
+
|
|
8673
|
+
</dd>
|
|
8674
|
+
</dl>
|
|
8675
|
+
</dd>
|
|
8676
|
+
</dl>
|
|
8677
|
+
|
|
8678
|
+
#### 🔌 Usage
|
|
8679
|
+
|
|
8680
|
+
<dl>
|
|
8681
|
+
<dd>
|
|
8682
|
+
|
|
8683
|
+
<dl>
|
|
8684
|
+
<dd>
|
|
8685
|
+
|
|
8686
|
+
```typescript
|
|
8687
|
+
await client.sites.forms.listSubmissions("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741", {
|
|
8688
|
+
offset: 1,
|
|
8689
|
+
limit: 1,
|
|
8690
|
+
});
|
|
8691
|
+
```
|
|
8692
|
+
|
|
8693
|
+
</dd>
|
|
8694
|
+
</dl>
|
|
8695
|
+
</dd>
|
|
8696
|
+
</dl>
|
|
8697
|
+
|
|
8698
|
+
#### ⚙️ Parameters
|
|
8699
|
+
|
|
8700
|
+
<dl>
|
|
8701
|
+
<dd>
|
|
8702
|
+
|
|
8703
|
+
<dl>
|
|
8704
|
+
<dd>
|
|
8705
|
+
|
|
8706
|
+
**siteId:** `string` — Unique identifier for a Site
|
|
8707
|
+
|
|
8708
|
+
</dd>
|
|
8709
|
+
</dl>
|
|
8710
|
+
|
|
8711
|
+
<dl>
|
|
8712
|
+
<dd>
|
|
8713
|
+
|
|
8714
|
+
**formId:** `string` — Unique identifier for a Form
|
|
8715
|
+
|
|
8716
|
+
</dd>
|
|
8717
|
+
</dl>
|
|
8718
|
+
|
|
8719
|
+
<dl>
|
|
8720
|
+
<dd>
|
|
8721
|
+
|
|
8722
|
+
**request:** `Webflow.sites.FormsListSubmissionsRequest`
|
|
8723
|
+
|
|
8724
|
+
</dd>
|
|
8725
|
+
</dl>
|
|
8726
|
+
|
|
8727
|
+
<dl>
|
|
8728
|
+
<dd>
|
|
8729
|
+
|
|
8730
|
+
**requestOptions:** `Forms.RequestOptions`
|
|
8731
|
+
|
|
8732
|
+
</dd>
|
|
8733
|
+
</dl>
|
|
8734
|
+
</dd>
|
|
8735
|
+
</dl>
|
|
8736
|
+
|
|
8737
|
+
</dd>
|
|
8738
|
+
</dl>
|
|
8739
|
+
</details>
|
|
8740
|
+
|
|
8741
|
+
<details><summary><code>client.sites.forms.<a href="/src/api/resources/sites/resources/forms/client/Client.ts">getSubmission</a>(siteId, formSubmissionId) -> Webflow.FormSubmission</code></summary>
|
|
8742
|
+
<dl>
|
|
8743
|
+
<dd>
|
|
8744
|
+
|
|
8745
|
+
#### 📝 Description
|
|
8746
|
+
|
|
8747
|
+
<dl>
|
|
8748
|
+
<dd>
|
|
8749
|
+
|
|
8750
|
+
<dl>
|
|
8751
|
+
<dd>
|
|
8752
|
+
|
|
8753
|
+
Get information about a form submission within a specific site.
|
|
8754
|
+
|
|
8755
|
+
Required scope | `forms:read`
|
|
8756
|
+
|
|
8757
|
+
</dd>
|
|
8758
|
+
</dl>
|
|
8759
|
+
</dd>
|
|
8760
|
+
</dl>
|
|
8761
|
+
|
|
8762
|
+
#### 🔌 Usage
|
|
8763
|
+
|
|
8764
|
+
<dl>
|
|
8765
|
+
<dd>
|
|
8766
|
+
|
|
8767
|
+
<dl>
|
|
8768
|
+
<dd>
|
|
8769
|
+
|
|
8770
|
+
```typescript
|
|
8771
|
+
await client.sites.forms.getSubmission("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741");
|
|
8772
|
+
```
|
|
8773
|
+
|
|
8774
|
+
</dd>
|
|
8775
|
+
</dl>
|
|
8776
|
+
</dd>
|
|
8777
|
+
</dl>
|
|
8778
|
+
|
|
8779
|
+
#### ⚙️ Parameters
|
|
8780
|
+
|
|
8781
|
+
<dl>
|
|
8782
|
+
<dd>
|
|
8783
|
+
|
|
8784
|
+
<dl>
|
|
8785
|
+
<dd>
|
|
8786
|
+
|
|
8787
|
+
**siteId:** `string` — Unique identifier for a Site
|
|
8788
|
+
|
|
8789
|
+
</dd>
|
|
8790
|
+
</dl>
|
|
8791
|
+
|
|
8792
|
+
<dl>
|
|
8793
|
+
<dd>
|
|
8794
|
+
|
|
8795
|
+
**formSubmissionId:** `string` — Unique identifier for a Form Submission
|
|
8796
|
+
|
|
8797
|
+
</dd>
|
|
8798
|
+
</dl>
|
|
8799
|
+
|
|
8800
|
+
<dl>
|
|
8801
|
+
<dd>
|
|
8802
|
+
|
|
8803
|
+
**requestOptions:** `Forms.RequestOptions`
|
|
8804
|
+
|
|
8805
|
+
</dd>
|
|
8806
|
+
</dl>
|
|
8807
|
+
</dd>
|
|
8808
|
+
</dl>
|
|
8809
|
+
|
|
8810
|
+
</dd>
|
|
8811
|
+
</dl>
|
|
8812
|
+
</details>
|
|
8813
|
+
|
|
8814
|
+
<details><summary><code>client.sites.forms.<a href="/src/api/resources/sites/resources/forms/client/Client.ts">deleteSubmission</a>(siteId, formSubmissionId) -> void</code></summary>
|
|
8815
|
+
<dl>
|
|
8816
|
+
<dd>
|
|
8817
|
+
|
|
8818
|
+
#### 📝 Description
|
|
8819
|
+
|
|
8820
|
+
<dl>
|
|
8821
|
+
<dd>
|
|
8822
|
+
|
|
8823
|
+
<dl>
|
|
8824
|
+
<dd>
|
|
8825
|
+
|
|
8826
|
+
Delete a form submission within a specific site.
|
|
8827
|
+
|
|
8828
|
+
Required scope | `forms:write`
|
|
8829
|
+
|
|
8830
|
+
</dd>
|
|
8831
|
+
</dl>
|
|
8832
|
+
</dd>
|
|
8833
|
+
</dl>
|
|
8834
|
+
|
|
8835
|
+
#### 🔌 Usage
|
|
8836
|
+
|
|
8837
|
+
<dl>
|
|
8838
|
+
<dd>
|
|
8839
|
+
|
|
8840
|
+
<dl>
|
|
8841
|
+
<dd>
|
|
8842
|
+
|
|
8843
|
+
```typescript
|
|
8844
|
+
await client.sites.forms.deleteSubmission("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741");
|
|
8845
|
+
```
|
|
8846
|
+
|
|
8847
|
+
</dd>
|
|
8848
|
+
</dl>
|
|
8849
|
+
</dd>
|
|
8850
|
+
</dl>
|
|
8851
|
+
|
|
8852
|
+
#### ⚙️ Parameters
|
|
8853
|
+
|
|
8854
|
+
<dl>
|
|
8855
|
+
<dd>
|
|
8856
|
+
|
|
8857
|
+
<dl>
|
|
8858
|
+
<dd>
|
|
8859
|
+
|
|
8860
|
+
**siteId:** `string` — Unique identifier for a Site
|
|
8861
|
+
|
|
8862
|
+
</dd>
|
|
8863
|
+
</dl>
|
|
8864
|
+
|
|
8865
|
+
<dl>
|
|
8866
|
+
<dd>
|
|
8867
|
+
|
|
8868
|
+
**formSubmissionId:** `string` — Unique identifier for a Form Submission
|
|
8869
|
+
|
|
8870
|
+
</dd>
|
|
8871
|
+
</dl>
|
|
8872
|
+
|
|
8873
|
+
<dl>
|
|
8874
|
+
<dd>
|
|
8875
|
+
|
|
8876
|
+
**requestOptions:** `Forms.RequestOptions`
|
|
8877
|
+
|
|
8878
|
+
</dd>
|
|
8879
|
+
</dl>
|
|
8880
|
+
</dd>
|
|
8881
|
+
</dl>
|
|
8882
|
+
|
|
8883
|
+
</dd>
|
|
8884
|
+
</dl>
|
|
8885
|
+
</details>
|
|
8886
|
+
|
|
8887
|
+
<details><summary><code>client.sites.forms.<a href="/src/api/resources/sites/resources/forms/client/Client.ts">updateSubmission</a>(siteId, formSubmissionId, { ...params }) -> Webflow.FormSubmission</code></summary>
|
|
8888
|
+
<dl>
|
|
8889
|
+
<dd>
|
|
8890
|
+
|
|
8891
|
+
#### 📝 Description
|
|
8892
|
+
|
|
8893
|
+
<dl>
|
|
8894
|
+
<dd>
|
|
8895
|
+
|
|
8896
|
+
<dl>
|
|
8897
|
+
<dd>
|
|
8898
|
+
|
|
8899
|
+
Update hidden fields on a form submission within a specific site.
|
|
8900
|
+
|
|
8901
|
+
Required scope | `forms:write`
|
|
8902
|
+
|
|
8903
|
+
</dd>
|
|
8904
|
+
</dl>
|
|
8905
|
+
</dd>
|
|
8906
|
+
</dl>
|
|
8907
|
+
|
|
8908
|
+
#### 🔌 Usage
|
|
8909
|
+
|
|
8910
|
+
<dl>
|
|
8911
|
+
<dd>
|
|
8912
|
+
|
|
8913
|
+
<dl>
|
|
8914
|
+
<dd>
|
|
8915
|
+
|
|
8916
|
+
```typescript
|
|
8917
|
+
await client.sites.forms.updateSubmission("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741");
|
|
8918
|
+
```
|
|
8919
|
+
|
|
8920
|
+
</dd>
|
|
8921
|
+
</dl>
|
|
8922
|
+
</dd>
|
|
8923
|
+
</dl>
|
|
8924
|
+
|
|
8925
|
+
#### ⚙️ Parameters
|
|
8926
|
+
|
|
8927
|
+
<dl>
|
|
8928
|
+
<dd>
|
|
8929
|
+
|
|
8930
|
+
<dl>
|
|
8931
|
+
<dd>
|
|
8932
|
+
|
|
8933
|
+
**siteId:** `string` — Unique identifier for a Site
|
|
8934
|
+
|
|
8935
|
+
</dd>
|
|
8936
|
+
</dl>
|
|
8937
|
+
|
|
8938
|
+
<dl>
|
|
8939
|
+
<dd>
|
|
8940
|
+
|
|
8941
|
+
**formSubmissionId:** `string` — Unique identifier for a Form Submission
|
|
8942
|
+
|
|
8943
|
+
</dd>
|
|
8944
|
+
</dl>
|
|
8945
|
+
|
|
8946
|
+
<dl>
|
|
8947
|
+
<dd>
|
|
8948
|
+
|
|
8949
|
+
**request:** `Webflow.sites.FormsUpdateSubmissionRequest`
|
|
8950
|
+
|
|
8951
|
+
</dd>
|
|
8952
|
+
</dl>
|
|
8953
|
+
|
|
8954
|
+
<dl>
|
|
8955
|
+
<dd>
|
|
8956
|
+
|
|
8957
|
+
**requestOptions:** `Forms.RequestOptions`
|
|
8958
|
+
|
|
8959
|
+
</dd>
|
|
8960
|
+
</dl>
|
|
8961
|
+
</dd>
|
|
8962
|
+
</dl>
|
|
8963
|
+
|
|
8964
|
+
</dd>
|
|
8965
|
+
</dl>
|
|
8966
|
+
</details>
|
|
8967
|
+
|
|
8535
8968
|
## Workspaces AuditLogs
|
|
8536
8969
|
|
|
8537
8970
|
<details><summary><code>client.workspaces.auditLogs.<a href="/src/api/resources/workspaces/resources/auditLogs/client/Client.ts">getWorkspaceAuditLogs</a>(workspaceIdOrSlug, { ...params }) -> Webflow.WorkspaceAuditLogResponse</code></summary>
|
|
@@ -8567,8 +9000,12 @@ Required scope | `workspace_activity:read`
|
|
|
8567
9000
|
|
|
8568
9001
|
```typescript
|
|
8569
9002
|
await client.workspaces.auditLogs.getWorkspaceAuditLogs("hitchhikers-workspace", {
|
|
8570
|
-
|
|
8571
|
-
|
|
9003
|
+
limit: 1,
|
|
9004
|
+
offset: 1,
|
|
9005
|
+
sortOrder: "asc",
|
|
9006
|
+
eventType: "user_access",
|
|
9007
|
+
from: new Date("2025-06-22T16:00:31.000Z"),
|
|
9008
|
+
to: new Date("2025-07-22T16:00:31.000Z"),
|
|
8572
9009
|
});
|
|
8573
9010
|
```
|
|
8574
9011
|
|