webflow-api 3.2.0 → 3.2.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/.mock/definition/__package__.yml +112 -269
- package/.mock/definition/accessGroups.yml +7 -1
- package/.mock/definition/api.yml +0 -2
- package/.mock/definition/assets.yml +38 -8
- package/.mock/definition/collections/fields.yml +9 -3
- package/.mock/definition/collections/items.yml +458 -76
- package/.mock/definition/collections.yml +12 -4
- package/.mock/definition/components.yml +65 -25
- package/.mock/definition/ecommerce.yml +3 -1
- package/.mock/definition/forms.yml +29 -7
- package/.mock/definition/inventory.yml +25 -17
- package/.mock/definition/items.yml +28 -16
- package/.mock/definition/orders.yml +126 -110
- package/.mock/definition/pages/scripts.yml +27 -8
- package/.mock/definition/pages.yml +66 -45
- package/.mock/definition/products.yml +21 -12
- package/.mock/definition/scripts.yml +9 -3
- package/.mock/definition/sites/activityLogs.yml +6 -1
- package/.mock/definition/sites/comments.yml +39 -12
- 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 +35 -8
- package/.mock/definition/sites/wellKnown.yml +20 -4
- package/.mock/definition/sites.yml +23 -8
- package/.mock/definition/token.yml +3 -2
- package/.mock/definition/users.yml +19 -5
- package/.mock/definition/webhooks.yml +0 -4
- package/.mock/definition/workspaces/auditLogs.yml +9 -3
- package/.mock/fern.config.json +1 -1
- package/Client.d.ts +2 -2
- package/Client.js +3 -3
- package/api/resources/accessGroups/client/Client.d.ts +8 -4
- package/api/resources/accessGroups/client/Client.js +11 -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 +53 -17
- package/api/resources/collections/resources/items/client/Client.js +57 -17
- 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 +14 -6
- package/api/resources/forms/client/Client.js +17 -5
- package/api/resources/forms/client/requests/FormsListRequest.d.ts +4 -1
- package/api/resources/forms/client/requests/FormsListSubmissionsBySiteRequest.d.ts +3 -1
- package/api/resources/forms/client/requests/FormsListSubmissionsRequest.d.ts +4 -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 +3 -3
- package/api/resources/sites/client/Client.js +6 -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/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 +8 -4
- package/api/resources/users/client/Client.js +11 -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/api/types/{ImageNodeDom.d.ts → 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/api/types/{SelectNodeDom.d.ts → 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/{dist/api/types/SubmitButton.d.ts → api/types/SubmitButtonNodeWrite.d.ts} +1 -1
- package/{dist/api/types/TextInputNodeDom.d.ts → api/types/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 +8 -4
- package/dist/api/resources/accessGroups/client/Client.js +11 -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 +53 -17
- package/dist/api/resources/collections/resources/items/client/Client.js +57 -17
- 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 +14 -6
- package/dist/api/resources/forms/client/Client.js +17 -5
- package/dist/api/resources/forms/client/requests/FormsListRequest.d.ts +4 -1
- package/dist/api/resources/forms/client/requests/FormsListSubmissionsBySiteRequest.d.ts +3 -1
- package/dist/api/resources/forms/client/requests/FormsListSubmissionsRequest.d.ts +4 -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 +3 -3
- package/dist/api/resources/sites/client/Client.js +6 -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/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 +8 -4
- package/dist/api/resources/users/client/Client.js +11 -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/dist/api/types/{ImageNodeDom.d.ts → 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/dist/api/types/{SelectNodeDom.d.ts → 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/{api/types/SubmitButton.d.ts → dist/api/types/SubmitButtonNodeWrite.d.ts} +1 -1
- package/{api/types/TextInputNodeDom.d.ts → dist/api/types/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/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/{serialization/types/SelectNodeDom.d.ts → dist/serialization/types/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/environments.d.ts +0 -4
- package/environments.js +0 -2
- package/jest.config.mjs +0 -4
- package/package.json +3 -3
- package/reference.md +158 -54
- 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/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/{dist/serialization/types/SelectNodeDom.d.ts → serialization/types/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/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/SubmitButtonNodeDom.js +0 -5
- package/dist/api/types/TextInput.js +0 -5
- package/dist/api/types/TextInputNodeDom.js +0 -5
- package/dist/api/types/TextNodeDom.d.ts +0 -15
- package/dist/api/types/TextNodeDom.js +0 -5
- 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/{types/CollectionItemChangedPayload.js → resources/assets/client/requests/AssetsListRequest.js} +0 -0
- /package/api/types/{CollectionItemCreatedPayload.js → CollectionItemPublished.js} +0 -0
- /package/api/types/{ComponentInstance.js → ComponentInstanceNodePropertyOverridesWrite.js} +0 -0
- /package/api/types/{ComponentNodeDom.js → ComponentNode.js} +0 -0
- /package/api/types/{ImageNodeDom.js → ImageNode.js} +0 -0
- /package/api/types/{LocalizedItem.js → Payload.js} +0 -0
- /package/api/types/{MultiLocaleChangedPayload.js → PayloadFieldData.js} +0 -0
- /package/api/types/{MultiLocaleChangedPayloadFieldData.js → SearchButtonNode.js} +0 -0
- /package/api/types/{MultiLocaleCreatedPayload.js → SearchButtonNodeWrite.js} +0 -0
- /package/api/types/{SearchButton.js → SelectNode.js} +0 -0
- /package/api/types/{SearchButtonNodeDom.js → SubmitButtonNode.js} +0 -0
- /package/api/types/{SelectNodeDom.js → SubmitButtonNodeWrite.js} +0 -0
- /package/api/types/{SingleLocaleChangedPayload.js → TextInputNode.js} +0 -0
- /package/api/types/{SingleLocaleChangedPayloadFieldData.js → TextInputNodeWrite.js} +0 -0
- /package/api/types/{SubmitButton.js → TextNodeWrite.js} +0 -0
- /package/api/types/{SubmitButtonNodeDom.js → WorkspaceAuditLogItemPayloadSiteMembershipGranularAccess.js} +0 -0
- /package/api/types/{TextInput.js → WorkspaceAuditLogItemPayloadWorkspaceInvitationTargetUsersItem.js} +0 -0
- /package/{api/types/TextInputNodeDom.js → dist/api/resources/assets/client/requests/AssetsListRequest.js} +0 -0
- /package/{api/types/TextNodeDom.js → dist/api/types/CollectionItemPublished.js} +0 -0
- /package/dist/api/types/{CollectionItemChangedPayload.js → ComponentInstanceNodePropertyOverridesWrite.js} +0 -0
- /package/dist/api/types/{CollectionItemCreatedPayload.js → ComponentNode.js} +0 -0
- /package/dist/api/types/{ComponentInstance.js → ImageNode.js} +0 -0
- /package/dist/api/types/{ComponentNodeDom.js → Payload.js} +0 -0
- /package/dist/api/types/{ImageNodeDom.js → PayloadFieldData.js} +0 -0
- /package/dist/api/types/{LocalizedItem.js → SearchButtonNode.js} +0 -0
- /package/dist/api/types/{MultiLocaleChangedPayload.js → SearchButtonNodeWrite.js} +0 -0
- /package/dist/api/types/{MultiLocaleChangedPayloadFieldData.js → SelectNode.js} +0 -0
- /package/dist/api/types/{MultiLocaleCreatedPayload.js → SubmitButtonNode.js} +0 -0
- /package/dist/api/types/{SearchButton.js → SubmitButtonNodeWrite.js} +0 -0
- /package/dist/api/types/{SearchButtonNodeDom.js → TextInputNode.js} +0 -0
- /package/dist/api/types/{SelectNodeDom.js → TextInputNodeWrite.js} +0 -0
- /package/dist/api/types/{SingleLocaleChangedPayload.js → TextNodeWrite.js} +0 -0
- /package/dist/api/types/{SingleLocaleChangedPayloadFieldData.js → WorkspaceAuditLogItemPayloadSiteMembershipGranularAccess.js} +0 -0
- /package/dist/api/types/{SubmitButton.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.1,
|
|
941
|
+
offset: 1.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.
|
|
1160
|
+
Get text and component instance content from a static page.
|
|
1163
1161
|
|
|
1164
|
-
|
|
1165
|
-
|
|
1166
|
-
<Note>If you do not include a `localeId` in your request, the response will return any content that can be localized from the Primary locale.</Note>
|
|
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.1,
|
|
1183
|
+
offset: 1.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.1,
|
|
1392
|
+
offset: 1.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.1,
|
|
1473
|
+
offset: 1.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.1,
|
|
1700
|
+
offset: 1.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.1,
|
|
2121
|
+
limit: 1.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.1,
|
|
2970
|
+
offset: 1.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.1,
|
|
3117
|
+
limit: 1.1,
|
|
3118
|
+
});
|
|
3093
3119
|
```
|
|
3094
3120
|
|
|
3095
3121
|
</dd>
|
|
@@ -3367,6 +3393,8 @@ Required scope | `forms:read`
|
|
|
3367
3393
|
```typescript
|
|
3368
3394
|
await client.forms.listSubmissionsBySite("580e63e98c9a982ac9b8b741", {
|
|
3369
3395
|
elementId: "18259716-3e5a-646a-5f41-5dc4b9405aa0",
|
|
3396
|
+
offset: 1.1,
|
|
3397
|
+
limit: 1.1,
|
|
3370
3398
|
});
|
|
3371
3399
|
```
|
|
3372
3400
|
|
|
@@ -3442,7 +3470,11 @@ Required scope | `users:read`
|
|
|
3442
3470
|
<dd>
|
|
3443
3471
|
|
|
3444
3472
|
```typescript
|
|
3445
|
-
await client.users.list("580e63e98c9a982ac9b8b741"
|
|
3473
|
+
await client.users.list("580e63e98c9a982ac9b8b741", {
|
|
3474
|
+
offset: 1.1,
|
|
3475
|
+
limit: 1.1,
|
|
3476
|
+
sort: "CreatedOn",
|
|
3477
|
+
});
|
|
3446
3478
|
```
|
|
3447
3479
|
|
|
3448
3480
|
</dd>
|
|
@@ -3839,7 +3871,11 @@ Required scope | `users:read`
|
|
|
3839
3871
|
<dd>
|
|
3840
3872
|
|
|
3841
3873
|
```typescript
|
|
3842
|
-
await client.accessGroups.list("580e63e98c9a982ac9b8b741"
|
|
3874
|
+
await client.accessGroups.list("580e63e98c9a982ac9b8b741", {
|
|
3875
|
+
offset: 1.1,
|
|
3876
|
+
limit: 1.1,
|
|
3877
|
+
sort: "CreatedOn",
|
|
3878
|
+
});
|
|
3843
3879
|
```
|
|
3844
3880
|
|
|
3845
3881
|
</dd>
|
|
@@ -3917,7 +3953,10 @@ Required scope | `ecommerce:read`
|
|
|
3917
3953
|
<dd>
|
|
3918
3954
|
|
|
3919
3955
|
```typescript
|
|
3920
|
-
await client.products.list("580e63e98c9a982ac9b8b741"
|
|
3956
|
+
await client.products.list("580e63e98c9a982ac9b8b741", {
|
|
3957
|
+
offset: 1.1,
|
|
3958
|
+
limit: 1.1,
|
|
3959
|
+
});
|
|
3921
3960
|
```
|
|
3922
3961
|
|
|
3923
3962
|
</dd>
|
|
@@ -4506,7 +4545,11 @@ Required scope | `ecommerce:read`
|
|
|
4506
4545
|
<dd>
|
|
4507
4546
|
|
|
4508
4547
|
```typescript
|
|
4509
|
-
await client.orders.list("580e63e98c9a982ac9b8b741"
|
|
4548
|
+
await client.orders.list("580e63e98c9a982ac9b8b741", {
|
|
4549
|
+
status: "pending",
|
|
4550
|
+
offset: 1.1,
|
|
4551
|
+
limit: 1.1,
|
|
4552
|
+
});
|
|
4510
4553
|
```
|
|
4511
4554
|
|
|
4512
4555
|
</dd>
|
|
@@ -4944,7 +4987,7 @@ await client.orders.refund("580e63e98c9a982ac9b8b741", "5e8518516e147040726cc415
|
|
|
4944
4987
|
|
|
4945
4988
|
## Inventory
|
|
4946
4989
|
|
|
4947
|
-
<details><summary><code>client.inventory.<a href="/src/api/resources/inventory/client/Client.ts">list</a>(
|
|
4990
|
+
<details><summary><code>client.inventory.<a href="/src/api/resources/inventory/client/Client.ts">list</a>(skuCollectionId, skuId) -> Webflow.InventoryItem</code></summary>
|
|
4948
4991
|
<dl>
|
|
4949
4992
|
<dd>
|
|
4950
4993
|
|
|
@@ -4974,7 +5017,7 @@ Required scope | `ecommerce:read`
|
|
|
4974
5017
|
<dd>
|
|
4975
5018
|
|
|
4976
5019
|
```typescript
|
|
4977
|
-
await client.inventory.list("
|
|
5020
|
+
await client.inventory.list("6377a7c4b7a79608c34a46f7", "5e8518516e147040726cc415");
|
|
4978
5021
|
```
|
|
4979
5022
|
|
|
4980
5023
|
</dd>
|
|
@@ -4990,7 +5033,7 @@ await client.inventory.list("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b75
|
|
|
4990
5033
|
<dl>
|
|
4991
5034
|
<dd>
|
|
4992
5035
|
|
|
4993
|
-
**
|
|
5036
|
+
**skuCollectionId:** `string` — Unique identifier for a SKU collection. Use the List Collections API to find this ID.
|
|
4994
5037
|
|
|
4995
5038
|
</dd>
|
|
4996
5039
|
</dl>
|
|
@@ -4998,7 +5041,7 @@ await client.inventory.list("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b75
|
|
|
4998
5041
|
<dl>
|
|
4999
5042
|
<dd>
|
|
5000
5043
|
|
|
5001
|
-
**
|
|
5044
|
+
**skuId:** `string` — Unique identifier for a SKU
|
|
5002
5045
|
|
|
5003
5046
|
</dd>
|
|
5004
5047
|
</dl>
|
|
@@ -5017,7 +5060,7 @@ await client.inventory.list("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b75
|
|
|
5017
5060
|
</dl>
|
|
5018
5061
|
</details>
|
|
5019
5062
|
|
|
5020
|
-
<details><summary><code>client.inventory.<a href="/src/api/resources/inventory/client/Client.ts">update</a>(
|
|
5063
|
+
<details><summary><code>client.inventory.<a href="/src/api/resources/inventory/client/Client.ts">update</a>(skuCollectionId, skuId, { ...params }) -> Webflow.InventoryItem</code></summary>
|
|
5021
5064
|
<dl>
|
|
5022
5065
|
<dd>
|
|
5023
5066
|
|
|
@@ -5052,7 +5095,7 @@ Required scope | `ecommerce:write`
|
|
|
5052
5095
|
<dd>
|
|
5053
5096
|
|
|
5054
5097
|
```typescript
|
|
5055
|
-
await client.inventory.update("
|
|
5098
|
+
await client.inventory.update("6377a7c4b7a79608c34a46f7", "5e8518516e147040726cc415", {
|
|
5056
5099
|
inventoryType: "infinite",
|
|
5057
5100
|
});
|
|
5058
5101
|
```
|
|
@@ -5070,7 +5113,7 @@ await client.inventory.update("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b
|
|
|
5070
5113
|
<dl>
|
|
5071
5114
|
<dd>
|
|
5072
5115
|
|
|
5073
|
-
**
|
|
5116
|
+
**skuCollectionId:** `string` — Unique identifier for a SKU collection. Use the List Collections API to find this ID.
|
|
5074
5117
|
|
|
5075
5118
|
</dd>
|
|
5076
5119
|
</dl>
|
|
@@ -5078,7 +5121,7 @@ await client.inventory.update("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b
|
|
|
5078
5121
|
<dl>
|
|
5079
5122
|
<dd>
|
|
5080
5123
|
|
|
5081
|
-
**
|
|
5124
|
+
**skuId:** `string` — Unique identifier for a SKU
|
|
5082
5125
|
|
|
5083
5126
|
</dd>
|
|
5084
5127
|
</dl>
|
|
@@ -5448,7 +5491,15 @@ Required scope | `CMS:read`
|
|
|
5448
5491
|
<dd>
|
|
5449
5492
|
|
|
5450
5493
|
```typescript
|
|
5451
|
-
await client.collections.items.listItems("580e63fc8c9a982ac9b8b745"
|
|
5494
|
+
await client.collections.items.listItems("580e63fc8c9a982ac9b8b745", {
|
|
5495
|
+
cmsLocaleId: "cmsLocaleId",
|
|
5496
|
+
offset: 1.1,
|
|
5497
|
+
limit: 1.1,
|
|
5498
|
+
name: "name",
|
|
5499
|
+
slug: "slug",
|
|
5500
|
+
sortBy: "lastPublished",
|
|
5501
|
+
sortOrder: "asc",
|
|
5502
|
+
});
|
|
5452
5503
|
```
|
|
5453
5504
|
|
|
5454
5505
|
</dd>
|
|
@@ -5524,12 +5575,13 @@ Required scope | `CMS:write`
|
|
|
5524
5575
|
|
|
5525
5576
|
```typescript
|
|
5526
5577
|
await client.collections.items.createItem("580e63fc8c9a982ac9b8b745", {
|
|
5578
|
+
skipInvalidFiles: true,
|
|
5527
5579
|
body: {
|
|
5528
5580
|
isArchived: false,
|
|
5529
5581
|
isDraft: false,
|
|
5530
5582
|
fieldData: {
|
|
5531
|
-
name: "
|
|
5532
|
-
slug: "
|
|
5583
|
+
name: "The Hitchhiker's Guide to the Galaxy",
|
|
5584
|
+
slug: "hitchhikers-guide-to-the-galaxy",
|
|
5533
5585
|
},
|
|
5534
5586
|
},
|
|
5535
5587
|
});
|
|
@@ -5691,6 +5743,7 @@ Required scope | `CMS:write`
|
|
|
5691
5743
|
|
|
5692
5744
|
```typescript
|
|
5693
5745
|
await client.collections.items.updateItems("580e63fc8c9a982ac9b8b745", {
|
|
5746
|
+
skipInvalidFiles: true,
|
|
5694
5747
|
items: [
|
|
5695
5748
|
{
|
|
5696
5749
|
id: "66f6ed9576ddacf3149d5ea6",
|
|
@@ -5803,7 +5856,15 @@ Required scope | `CMS:read`
|
|
|
5803
5856
|
<dd>
|
|
5804
5857
|
|
|
5805
5858
|
```typescript
|
|
5806
|
-
await client.collections.items.listItemsLive("580e63fc8c9a982ac9b8b745"
|
|
5859
|
+
await client.collections.items.listItemsLive("580e63fc8c9a982ac9b8b745", {
|
|
5860
|
+
cmsLocaleId: "cmsLocaleId",
|
|
5861
|
+
offset: 1.1,
|
|
5862
|
+
limit: 1.1,
|
|
5863
|
+
name: "name",
|
|
5864
|
+
slug: "slug",
|
|
5865
|
+
sortBy: "lastPublished",
|
|
5866
|
+
sortOrder: "asc",
|
|
5867
|
+
});
|
|
5807
5868
|
```
|
|
5808
5869
|
|
|
5809
5870
|
</dd>
|
|
@@ -5879,12 +5940,13 @@ Required scope | `CMS:write`
|
|
|
5879
5940
|
|
|
5880
5941
|
```typescript
|
|
5881
5942
|
await client.collections.items.createItemLive("580e63fc8c9a982ac9b8b745", {
|
|
5943
|
+
skipInvalidFiles: true,
|
|
5882
5944
|
body: {
|
|
5883
5945
|
isArchived: false,
|
|
5884
5946
|
isDraft: false,
|
|
5885
5947
|
fieldData: {
|
|
5886
|
-
name: "
|
|
5887
|
-
slug: "
|
|
5948
|
+
name: "The Hitchhiker's Guide to the Galaxy",
|
|
5949
|
+
slug: "hitchhikers-guide-to-the-galaxy",
|
|
5888
5950
|
},
|
|
5889
5951
|
},
|
|
5890
5952
|
});
|
|
@@ -6044,6 +6106,7 @@ Required scope | `CMS:write`
|
|
|
6044
6106
|
|
|
6045
6107
|
```typescript
|
|
6046
6108
|
await client.collections.items.updateItemsLive("580e63fc8c9a982ac9b8b745", {
|
|
6109
|
+
skipInvalidFiles: true,
|
|
6047
6110
|
items: [
|
|
6048
6111
|
{
|
|
6049
6112
|
id: "66f6ed9576ddacf3149d5ea6",
|
|
@@ -6157,6 +6220,7 @@ Required scope | `CMS:write`
|
|
|
6157
6220
|
|
|
6158
6221
|
```typescript
|
|
6159
6222
|
await client.collections.items.createItems("580e63fc8c9a982ac9b8b745", {
|
|
6223
|
+
skipInvalidFiles: true,
|
|
6160
6224
|
cmsLocaleIds: ["66f6e966c9e1dc700a857ca3", "66f6e966c9e1dc700a857ca4", "66f6e966c9e1dc700a857ca5"],
|
|
6161
6225
|
isArchived: false,
|
|
6162
6226
|
isDraft: false,
|
|
@@ -6237,7 +6301,9 @@ Required scope | `CMS:read`
|
|
|
6237
6301
|
<dd>
|
|
6238
6302
|
|
|
6239
6303
|
```typescript
|
|
6240
|
-
await client.collections.items.getItem("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754"
|
|
6304
|
+
await client.collections.items.getItem("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754", {
|
|
6305
|
+
cmsLocaleId: "cmsLocaleId",
|
|
6306
|
+
});
|
|
6241
6307
|
```
|
|
6242
6308
|
|
|
6243
6309
|
</dd>
|
|
@@ -6318,7 +6384,9 @@ Required scope | `CMS:write`
|
|
|
6318
6384
|
<dd>
|
|
6319
6385
|
|
|
6320
6386
|
```typescript
|
|
6321
|
-
await client.collections.items.deleteItem("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754"
|
|
6387
|
+
await client.collections.items.deleteItem("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754", {
|
|
6388
|
+
cmsLocaleId: "cmsLocaleId",
|
|
6389
|
+
});
|
|
6322
6390
|
```
|
|
6323
6391
|
|
|
6324
6392
|
</dd>
|
|
@@ -6400,12 +6468,13 @@ Required scope | `CMS:write`
|
|
|
6400
6468
|
|
|
6401
6469
|
```typescript
|
|
6402
6470
|
await client.collections.items.updateItem("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754", {
|
|
6471
|
+
skipInvalidFiles: true,
|
|
6403
6472
|
body: {
|
|
6404
6473
|
isArchived: false,
|
|
6405
6474
|
isDraft: false,
|
|
6406
6475
|
fieldData: {
|
|
6407
|
-
name: "
|
|
6408
|
-
slug: "
|
|
6476
|
+
name: "The Hitchhiker's Guide to the Galaxy",
|
|
6477
|
+
slug: "hitchhikers-guide-to-the-galaxy",
|
|
6409
6478
|
},
|
|
6410
6479
|
},
|
|
6411
6480
|
});
|
|
@@ -6494,7 +6563,9 @@ Required scope | `CMS:read`
|
|
|
6494
6563
|
<dd>
|
|
6495
6564
|
|
|
6496
6565
|
```typescript
|
|
6497
|
-
await client.collections.items.getItemLive("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754"
|
|
6566
|
+
await client.collections.items.getItemLive("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754", {
|
|
6567
|
+
cmsLocaleId: "cmsLocaleId",
|
|
6568
|
+
});
|
|
6498
6569
|
```
|
|
6499
6570
|
|
|
6500
6571
|
</dd>
|
|
@@ -6577,7 +6648,9 @@ Required scope | `CMS:write`
|
|
|
6577
6648
|
<dd>
|
|
6578
6649
|
|
|
6579
6650
|
```typescript
|
|
6580
|
-
await client.collections.items.deleteItemLive("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754"
|
|
6651
|
+
await client.collections.items.deleteItemLive("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754", {
|
|
6652
|
+
cmsLocaleId: "cmsLocaleId",
|
|
6653
|
+
});
|
|
6581
6654
|
```
|
|
6582
6655
|
|
|
6583
6656
|
</dd>
|
|
@@ -6659,12 +6732,13 @@ Required scope | `CMS:write`
|
|
|
6659
6732
|
|
|
6660
6733
|
```typescript
|
|
6661
6734
|
await client.collections.items.updateItemLive("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754", {
|
|
6735
|
+
skipInvalidFiles: true,
|
|
6662
6736
|
body: {
|
|
6663
6737
|
isArchived: false,
|
|
6664
6738
|
isDraft: false,
|
|
6665
6739
|
fieldData: {
|
|
6666
|
-
name: "
|
|
6667
|
-
slug: "
|
|
6740
|
+
name: "The Hitchhiker's Guide to the Galaxy",
|
|
6741
|
+
slug: "hitchhikers-guide-to-the-galaxy",
|
|
6668
6742
|
},
|
|
6669
6743
|
},
|
|
6670
6744
|
});
|
|
@@ -6872,7 +6946,7 @@ await client.pages.scripts.getCustomCode("63c720f9347c2139b248e552");
|
|
|
6872
6946
|
<dl>
|
|
6873
6947
|
<dd>
|
|
6874
6948
|
|
|
6875
|
-
Apply scripts to a page.
|
|
6949
|
+
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
6950
|
|
|
6877
6951
|
<Note title="Script Registration">
|
|
6878
6952
|
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 +7039,11 @@ await client.pages.scripts.upsertCustomCode("63c720f9347c2139b248e552", {
|
|
|
6965
7039
|
<dl>
|
|
6966
7040
|
<dd>
|
|
6967
7041
|
|
|
6968
|
-
|
|
7042
|
+
Remove all scripts from a page applied by the App. This endpoint will not remove scripts from the site's registered scripts.
|
|
6969
7043
|
|
|
6970
|
-
|
|
7044
|
+
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.
|
|
7045
|
+
|
|
7046
|
+
<Note>Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app).</Note>
|
|
6971
7047
|
|
|
6972
7048
|
Required scope | `custom_code:write`
|
|
6973
7049
|
|
|
@@ -7772,8 +7848,10 @@ Required scope: `site_config:write`
|
|
|
7772
7848
|
|
|
7773
7849
|
```typescript
|
|
7774
7850
|
await client.sites.wellKnown.put("580e63e98c9a982ac9b8b741", {
|
|
7775
|
-
fileName: "
|
|
7776
|
-
fileData:
|
|
7851
|
+
fileName: "apple-app-site-association.txt",
|
|
7852
|
+
fileData:
|
|
7853
|
+
'{\n "applinks": {\n "apps": [],\n "details": [\n {\n "appID": "ABCDE12345.com.example.app",\n "paths": [ "/*", "/some/path/*" ]\n }\n ]\n }\n}\n',
|
|
7854
|
+
contentType: "application/json",
|
|
7777
7855
|
});
|
|
7778
7856
|
```
|
|
7779
7857
|
|
|
@@ -7926,7 +8004,10 @@ Required scope: `site_activity:read`
|
|
|
7926
8004
|
<dd>
|
|
7927
8005
|
|
|
7928
8006
|
```typescript
|
|
7929
|
-
await client.sites.activityLogs.list("580e63e98c9a982ac9b8b741"
|
|
8007
|
+
await client.sites.activityLogs.list("580e63e98c9a982ac9b8b741", {
|
|
8008
|
+
limit: 1.1,
|
|
8009
|
+
offset: 1.1,
|
|
8010
|
+
});
|
|
7930
8011
|
```
|
|
7931
8012
|
|
|
7932
8013
|
</dd>
|
|
@@ -8007,6 +8088,10 @@ Required scope | `comments:read`
|
|
|
8007
8088
|
```typescript
|
|
8008
8089
|
await client.sites.comments.listCommentThreads("580e63e98c9a982ac9b8b741", {
|
|
8009
8090
|
localeId: "65427cf400e02b306eaa04a0",
|
|
8091
|
+
offset: 1.1,
|
|
8092
|
+
limit: 1.1,
|
|
8093
|
+
sortBy: "createdOn",
|
|
8094
|
+
sortOrder: "asc",
|
|
8010
8095
|
});
|
|
8011
8096
|
```
|
|
8012
8097
|
|
|
@@ -8086,6 +8171,10 @@ Required scope | `comments:read`
|
|
|
8086
8171
|
```typescript
|
|
8087
8172
|
await client.sites.comments.getCommentThread("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741", {
|
|
8088
8173
|
localeId: "65427cf400e02b306eaa04a0",
|
|
8174
|
+
offset: 1.1,
|
|
8175
|
+
limit: 1.1,
|
|
8176
|
+
sortBy: "createdOn",
|
|
8177
|
+
sortOrder: "asc",
|
|
8089
8178
|
});
|
|
8090
8179
|
```
|
|
8091
8180
|
|
|
@@ -8173,6 +8262,10 @@ Required scope | `comments:read`
|
|
|
8173
8262
|
```typescript
|
|
8174
8263
|
await client.sites.comments.listCommentReplies("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741", {
|
|
8175
8264
|
localeId: "65427cf400e02b306eaa04a0",
|
|
8265
|
+
offset: 1.1,
|
|
8266
|
+
limit: 1.1,
|
|
8267
|
+
sortBy: "createdOn",
|
|
8268
|
+
sortOrder: "asc",
|
|
8176
8269
|
});
|
|
8177
8270
|
```
|
|
8178
8271
|
|
|
@@ -8307,7 +8400,7 @@ await client.sites.scripts.getCustomCode("580e63e98c9a982ac9b8b741");
|
|
|
8307
8400
|
<dl>
|
|
8308
8401
|
<dd>
|
|
8309
8402
|
|
|
8310
|
-
Apply registered scripts to a site.
|
|
8403
|
+
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
8404
|
|
|
8312
8405
|
<Note title="Script Registration">
|
|
8313
8406
|
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 +8493,11 @@ await client.sites.scripts.upsertCustomCode("580e63e98c9a982ac9b8b741", {
|
|
|
8400
8493
|
<dl>
|
|
8401
8494
|
<dd>
|
|
8402
8495
|
|
|
8403
|
-
Remove scripts from a site applied by the App. This endpoint will not remove scripts from the site's registered scripts.
|
|
8496
|
+
Remove all scripts from a site applied by the App. This endpoint will not remove scripts from the site's registered scripts.
|
|
8497
|
+
|
|
8498
|
+
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.
|
|
8499
|
+
|
|
8500
|
+
<Note>Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app).</Note>
|
|
8404
8501
|
|
|
8405
8502
|
Required scope | `custom_code:write`
|
|
8406
8503
|
|
|
@@ -8489,7 +8586,10 @@ Required scope | `custom_code:read`
|
|
|
8489
8586
|
<dd>
|
|
8490
8587
|
|
|
8491
8588
|
```typescript
|
|
8492
|
-
await client.sites.scripts.listCustomCodeBlocks("580e63e98c9a982ac9b8b741"
|
|
8589
|
+
await client.sites.scripts.listCustomCodeBlocks("580e63e98c9a982ac9b8b741", {
|
|
8590
|
+
offset: 1.1,
|
|
8591
|
+
limit: 1.1,
|
|
8592
|
+
});
|
|
8493
8593
|
```
|
|
8494
8594
|
|
|
8495
8595
|
</dd>
|
|
@@ -8567,8 +8667,12 @@ Required scope | `workspace_activity:read`
|
|
|
8567
8667
|
|
|
8568
8668
|
```typescript
|
|
8569
8669
|
await client.workspaces.auditLogs.getWorkspaceAuditLogs("hitchhikers-workspace", {
|
|
8570
|
-
|
|
8571
|
-
|
|
8670
|
+
limit: 1.1,
|
|
8671
|
+
offset: 1.1,
|
|
8672
|
+
sortOrder: "asc",
|
|
8673
|
+
eventType: "user_access",
|
|
8674
|
+
from: new Date("2025-06-22T16:00:31.000Z"),
|
|
8675
|
+
to: new Date("2025-07-22T16:00:31.000Z"),
|
|
8572
8676
|
});
|
|
8573
8677
|
```
|
|
8574
8678
|
|
|
@@ -4,13 +4,13 @@
|
|
|
4
4
|
import * as serializers from "../../../index";
|
|
5
5
|
import * as Webflow from "../../../../api/index";
|
|
6
6
|
import * as core from "../../../../core";
|
|
7
|
-
import {
|
|
8
|
-
import {
|
|
7
|
+
import { TextNodeWrite } from "../../../types/TextNodeWrite";
|
|
8
|
+
import { ComponentInstanceNodePropertyOverridesWrite } from "../../../types/ComponentInstanceNodePropertyOverridesWrite";
|
|
9
9
|
import { Select } from "../../../types/Select";
|
|
10
|
-
import {
|
|
11
|
-
import {
|
|
12
|
-
import {
|
|
10
|
+
import { TextInputNodeWrite } from "../../../types/TextInputNodeWrite";
|
|
11
|
+
import { SubmitButtonNodeWrite } from "../../../types/SubmitButtonNodeWrite";
|
|
12
|
+
import { SearchButtonNodeWrite } from "../../../types/SearchButtonNodeWrite";
|
|
13
13
|
export declare const ComponentDomWriteNodesItem: core.serialization.Schema<serializers.ComponentDomWriteNodesItem.Raw, Webflow.ComponentDomWriteNodesItem>;
|
|
14
14
|
export declare namespace ComponentDomWriteNodesItem {
|
|
15
|
-
type Raw =
|
|
15
|
+
type Raw = TextNodeWrite.Raw | ComponentInstanceNodePropertyOverridesWrite.Raw | Select.Raw | TextInputNodeWrite.Raw | SubmitButtonNodeWrite.Raw | SearchButtonNodeWrite.Raw;
|
|
16
16
|
}
|
|
@@ -38,17 +38,17 @@ var __importStar = (this && this.__importStar) || (function () {
|
|
|
38
38
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
39
39
|
exports.ComponentDomWriteNodesItem = void 0;
|
|
40
40
|
const core = __importStar(require("../../../../core"));
|
|
41
|
-
const
|
|
42
|
-
const
|
|
41
|
+
const TextNodeWrite_1 = require("../../../types/TextNodeWrite");
|
|
42
|
+
const ComponentInstanceNodePropertyOverridesWrite_1 = require("../../../types/ComponentInstanceNodePropertyOverridesWrite");
|
|
43
43
|
const Select_1 = require("../../../types/Select");
|
|
44
|
-
const
|
|
45
|
-
const
|
|
46
|
-
const
|
|
44
|
+
const TextInputNodeWrite_1 = require("../../../types/TextInputNodeWrite");
|
|
45
|
+
const SubmitButtonNodeWrite_1 = require("../../../types/SubmitButtonNodeWrite");
|
|
46
|
+
const SearchButtonNodeWrite_1 = require("../../../types/SearchButtonNodeWrite");
|
|
47
47
|
exports.ComponentDomWriteNodesItem = core.serialization.undiscriminatedUnion([
|
|
48
|
-
|
|
49
|
-
|
|
48
|
+
TextNodeWrite_1.TextNodeWrite,
|
|
49
|
+
ComponentInstanceNodePropertyOverridesWrite_1.ComponentInstanceNodePropertyOverridesWrite,
|
|
50
50
|
Select_1.Select,
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
51
|
+
TextInputNodeWrite_1.TextInputNodeWrite,
|
|
52
|
+
SubmitButtonNodeWrite_1.SubmitButtonNodeWrite,
|
|
53
|
+
SearchButtonNodeWrite_1.SearchButtonNodeWrite,
|
|
54
54
|
]);
|
|
@@ -4,13 +4,13 @@
|
|
|
4
4
|
import * as serializers from "../../../index";
|
|
5
5
|
import * as Webflow from "../../../../api/index";
|
|
6
6
|
import * as core from "../../../../core";
|
|
7
|
-
import {
|
|
8
|
-
import {
|
|
7
|
+
import { TextNodeWrite } from "../../../types/TextNodeWrite";
|
|
8
|
+
import { ComponentInstanceNodePropertyOverridesWrite } from "../../../types/ComponentInstanceNodePropertyOverridesWrite";
|
|
9
9
|
import { Select } from "../../../types/Select";
|
|
10
|
-
import {
|
|
11
|
-
import {
|
|
12
|
-
import {
|
|
10
|
+
import { TextInputNodeWrite } from "../../../types/TextInputNodeWrite";
|
|
11
|
+
import { SubmitButtonNodeWrite } from "../../../types/SubmitButtonNodeWrite";
|
|
12
|
+
import { SearchButtonNodeWrite } from "../../../types/SearchButtonNodeWrite";
|
|
13
13
|
export declare const PageDomWriteNodesItem: core.serialization.Schema<serializers.PageDomWriteNodesItem.Raw, Webflow.PageDomWriteNodesItem>;
|
|
14
14
|
export declare namespace PageDomWriteNodesItem {
|
|
15
|
-
type Raw =
|
|
15
|
+
type Raw = TextNodeWrite.Raw | ComponentInstanceNodePropertyOverridesWrite.Raw | Select.Raw | TextInputNodeWrite.Raw | SubmitButtonNodeWrite.Raw | SearchButtonNodeWrite.Raw;
|
|
16
16
|
}
|