webflow-api 3.0.1 → 3.1.0
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 +526 -221
- package/.mock/definition/accessGroups.yml +3 -3
- package/.mock/definition/assets.yml +10 -9
- package/.mock/definition/collections/fields.yml +16 -14
- package/.mock/definition/collections/items.yml +168 -35
- package/.mock/definition/collections.yml +6 -5
- package/.mock/definition/components.yml +486 -0
- package/.mock/definition/ecommerce.yml +2 -2
- package/.mock/definition/forms.yml +7 -6
- package/.mock/definition/inventory.yml +6 -4
- package/.mock/definition/orders.yml +11 -9
- package/.mock/definition/pages/scripts.yml +18 -17
- package/.mock/definition/pages.yml +91 -64
- package/.mock/definition/products.yml +9 -9
- package/.mock/definition/scripts.yml +12 -16
- package/.mock/definition/sites/activityLogs.yml +2 -2
- package/.mock/definition/sites/plans.yml +40 -0
- package/.mock/definition/sites/redirects.yml +190 -0
- package/.mock/definition/sites/scripts.yml +16 -21
- package/.mock/definition/sites.yml +202 -6
- package/.mock/definition/token.yml +5 -4
- package/.mock/definition/users.yml +8 -8
- package/.mock/definition/webhooks.yml +9 -9
- package/.mock/fern.config.json +1 -1
- package/Client.d.ts +3 -0
- package/Client.js +25 -20
- package/api/errors/index.d.ts +1 -1
- package/api/errors/index.js +1 -1
- package/api/resources/accessGroups/client/Client.js +1 -1
- package/api/resources/assets/client/Client.d.ts +5 -0
- package/api/resources/assets/client/Client.js +13 -8
- package/api/resources/collections/client/Client.d.ts +3 -0
- package/api/resources/collections/client/Client.js +7 -4
- package/api/resources/collections/resources/fields/client/Client.js +3 -3
- package/api/resources/collections/resources/fields/types/FieldCreateType.d.ts +11 -10
- package/api/resources/collections/resources/fields/types/FieldCreateType.js +10 -9
- package/api/resources/collections/resources/items/client/Client.d.ts +8 -5
- package/api/resources/collections/resources/items/client/Client.js +26 -21
- package/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.d.ts +1 -1
- package/api/resources/collections/resources/items/types/MultipleItems.d.ts +2 -2
- package/api/resources/collections/resources/items/types/MultipleLiveItems.d.ts +8 -0
- package/api/resources/collections/resources/items/types/index.d.ts +1 -0
- package/api/resources/collections/resources/items/types/index.js +1 -0
- package/api/resources/components/client/Client.d.ts +176 -0
- package/api/resources/components/client/Client.js +670 -0
- package/api/resources/components/client/index.d.ts +1 -0
- package/api/resources/components/client/index.js +17 -0
- package/api/resources/components/client/requests/ComponentDomWrite.d.ts +34 -0
- package/api/resources/components/client/requests/ComponentPropertiesWrite.d.ts +25 -0
- package/api/resources/components/client/requests/ComponentsGetContentRequest.d.ts +28 -0
- package/api/resources/components/client/requests/ComponentsGetPropertiesRequest.d.ts +23 -0
- package/api/resources/components/client/requests/ComponentsListRequest.d.ts +17 -0
- package/api/resources/components/client/requests/index.d.ts +5 -0
- package/api/resources/components/client/requests/index.js +2 -0
- package/api/resources/components/index.d.ts +2 -0
- package/api/resources/components/index.js +18 -0
- package/api/resources/components/types/ComponentDomWriteNodesItem.d.ts +5 -0
- package/api/resources/components/types/ComponentDomWriteNodesItem.js +5 -0
- package/api/resources/components/types/ComponentPropertiesWritePropertiesItem.d.ts +16 -0
- package/api/resources/components/types/ComponentPropertiesWritePropertiesItem.js +5 -0
- package/api/resources/components/types/ComponentsUpdateContentResponse.d.ts +7 -0
- package/api/resources/components/types/ComponentsUpdateContentResponse.js +5 -0
- package/api/resources/components/types/ComponentsUpdatePropertiesResponse.d.ts +7 -0
- package/api/resources/components/types/ComponentsUpdatePropertiesResponse.js +5 -0
- package/api/resources/components/types/index.d.ts +4 -0
- package/api/resources/components/types/index.js +20 -0
- package/api/resources/ecommerce/client/Client.js +1 -1
- package/api/resources/forms/client/Client.d.ts +3 -0
- package/api/resources/forms/client/Client.js +8 -5
- package/api/resources/index.d.ts +3 -0
- package/api/resources/index.js +4 -1
- package/api/resources/inventory/client/Client.d.ts +3 -1
- package/api/resources/inventory/client/Client.js +5 -3
- package/api/resources/orders/client/Client.d.ts +3 -0
- package/api/resources/orders/client/Client.js +9 -6
- package/api/resources/pages/client/Client.d.ts +26 -10
- package/api/resources/pages/client/Client.js +32 -18
- package/api/resources/pages/client/requests/PageDomWrite.d.ts +34 -0
- package/api/resources/pages/client/requests/PageDomWrite.js +5 -0
- package/api/resources/pages/client/requests/index.d.ts +1 -1
- package/api/resources/pages/resources/scripts/client/Client.d.ts +6 -3
- package/api/resources/pages/resources/scripts/client/Client.js +11 -6
- package/api/resources/pages/types/PageDomWriteNodesItem.d.ts +5 -0
- package/api/resources/pages/types/PageDomWriteNodesItem.js +5 -0
- package/api/resources/pages/types/index.d.ts +1 -1
- package/api/resources/pages/types/index.js +1 -1
- package/api/resources/products/client/Client.d.ts +5 -6
- package/api/resources/products/client/Client.js +11 -12
- package/api/resources/scripts/client/Client.d.ts +3 -3
- package/api/resources/scripts/client/Client.js +6 -6
- package/api/resources/sites/client/Client.d.ts +70 -0
- package/api/resources/sites/client/Client.js +330 -9
- package/api/resources/sites/client/requests/SitesCreateRequest.d.ts +17 -0
- package/api/resources/sites/client/requests/SitesCreateRequest.js +5 -0
- package/api/resources/sites/client/requests/SitesUpdateRequest.d.ts +13 -0
- package/api/resources/sites/client/requests/SitesUpdateRequest.js +5 -0
- package/api/resources/sites/client/requests/index.d.ts +2 -0
- package/api/resources/sites/resources/activityLogs/client/Client.d.ts +1 -1
- package/api/resources/sites/resources/activityLogs/client/Client.js +2 -2
- 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 +45 -0
- package/api/resources/sites/resources/plans/client/Client.js +155 -0
- package/api/resources/sites/resources/plans/client/index.d.ts +1 -0
- package/api/resources/sites/resources/plans/client/index.js +2 -0
- package/api/resources/sites/resources/plans/index.d.ts +1 -0
- package/api/resources/sites/resources/plans/index.js +17 -0
- package/api/resources/sites/resources/redirects/client/Client.d.ts +115 -0
- package/api/resources/sites/resources/redirects/client/Client.js +472 -0
- package/api/resources/sites/resources/redirects/client/index.d.ts +1 -0
- package/api/resources/sites/resources/redirects/client/index.js +2 -0
- package/api/resources/sites/resources/redirects/index.d.ts +1 -0
- package/api/resources/sites/resources/redirects/index.js +17 -0
- package/api/resources/sites/resources/scripts/client/Client.d.ts +4 -4
- package/api/resources/sites/resources/scripts/client/Client.js +8 -8
- package/api/resources/token/client/Client.d.ts +2 -1
- package/api/resources/token/client/Client.js +4 -3
- package/api/resources/users/client/Client.d.ts +1 -1
- package/api/resources/users/client/Client.js +6 -6
- package/api/resources/webhooks/client/Client.d.ts +4 -1
- package/api/resources/webhooks/client/Client.js +8 -5
- package/api/types/CollectionItem.d.ts +5 -1
- package/api/types/CollectionItemPostSingle.d.ts +7 -3
- package/api/types/Component.d.ts +18 -0
- package/api/types/Component.js +5 -0
- package/api/types/ComponentDom.d.ts +13 -0
- package/api/types/ComponentDom.js +5 -0
- package/api/types/ComponentInstanceNodePropertyOverridesWrite.d.ts +13 -0
- package/api/types/ComponentInstanceNodePropertyOverridesWrite.js +5 -0
- package/api/types/ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem.d.ts +14 -0
- package/api/types/ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem.js +5 -0
- package/api/types/ComponentList.d.ts +11 -0
- package/api/types/ComponentList.js +5 -0
- package/api/types/ComponentNode.d.ts +15 -0
- package/api/types/ComponentNode.js +5 -0
- package/api/types/ComponentProperties.d.ts +13 -0
- package/api/types/ComponentProperties.js +5 -0
- package/api/types/ComponentProperty.d.ts +17 -0
- package/api/types/ComponentProperty.js +5 -0
- package/api/types/ComponentPropertyType.d.ts +12 -0
- package/api/types/ComponentPropertyType.js +11 -0
- package/api/types/Dom.d.ts +1 -1
- package/api/types/Domain.d.ts +2 -0
- package/api/types/Error_.d.ts +1 -1
- package/api/types/FieldType.d.ts +10 -10
- package/api/types/FieldType.js +9 -9
- package/api/types/ImageNode.d.ts +6 -2
- package/api/types/ImageNodeImage.d.ts +7 -0
- package/api/types/ImageNodeImage.js +5 -0
- package/api/types/Node.d.ts +11 -8
- package/api/types/{ErrorDetailsItem.d.ts → NotEnterprisePlanWorkspace.d.ts} +1 -1
- package/api/types/NotEnterprisePlanWorkspace.js +5 -0
- package/api/types/ProductFieldData.d.ts +1 -1
- package/api/types/Redirect.d.ts +14 -0
- package/api/types/Redirect.js +5 -0
- package/api/types/Redirects.d.ts +12 -0
- package/api/types/Redirects.js +5 -0
- package/api/types/ScriptApply.d.ts +1 -1
- package/api/types/SitePlan.d.ts +12 -0
- package/api/types/SitePlan.js +5 -0
- package/api/types/SitePlanId.d.ts +21 -0
- package/api/types/SitePlanId.js +20 -0
- package/api/types/SitePlanName.d.ts +15 -0
- package/api/types/SitePlanName.js +14 -0
- package/api/types/Text.d.ts +9 -0
- package/api/types/Text.js +5 -0
- package/api/types/TextNode.d.ts +7 -3
- package/api/types/TextNodeText.d.ts +9 -0
- package/api/types/TextNodeText.js +5 -0
- package/api/{resources/pages/types/DomWriteNodesItem.d.ts → types/TextNodeWrite.d.ts} +4 -1
- package/api/types/TextNodeWrite.js +5 -0
- package/api/types/TriggerType.d.ts +15 -15
- package/api/types/UserAccessGroupsItem.d.ts +2 -3
- package/api/types/UserAccessGroupsItemType.d.ts +2 -3
- package/api/types/index.d.ts +23 -6
- package/api/types/index.js +23 -6
- package/dist/Client.d.ts +3 -0
- package/dist/Client.js +25 -20
- package/dist/api/errors/index.d.ts +1 -1
- package/dist/api/errors/index.js +1 -1
- package/dist/api/resources/accessGroups/client/Client.js +1 -1
- package/dist/api/resources/assets/client/Client.d.ts +5 -0
- package/dist/api/resources/assets/client/Client.js +13 -8
- package/dist/api/resources/collections/client/Client.d.ts +3 -0
- package/dist/api/resources/collections/client/Client.js +7 -4
- package/dist/api/resources/collections/resources/fields/client/Client.js +3 -3
- package/dist/api/resources/collections/resources/fields/types/FieldCreateType.d.ts +11 -10
- package/dist/api/resources/collections/resources/fields/types/FieldCreateType.js +10 -9
- package/dist/api/resources/collections/resources/items/client/Client.d.ts +8 -5
- package/dist/api/resources/collections/resources/items/client/Client.js +26 -21
- package/dist/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.d.ts +1 -1
- package/dist/api/resources/collections/resources/items/types/MultipleItems.d.ts +2 -2
- package/dist/api/resources/collections/resources/items/types/MultipleLiveItems.d.ts +8 -0
- package/dist/api/resources/collections/resources/items/types/MultipleLiveItems.js +5 -0
- package/dist/api/resources/collections/resources/items/types/index.d.ts +1 -0
- package/dist/api/resources/collections/resources/items/types/index.js +1 -0
- package/dist/api/resources/components/client/Client.d.ts +176 -0
- package/dist/api/resources/components/client/Client.js +670 -0
- package/dist/api/resources/components/client/index.d.ts +1 -0
- package/dist/api/resources/components/client/index.js +17 -0
- package/dist/api/resources/components/client/requests/ComponentDomWrite.d.ts +34 -0
- package/dist/api/resources/components/client/requests/ComponentDomWrite.js +5 -0
- package/dist/api/resources/components/client/requests/ComponentPropertiesWrite.d.ts +25 -0
- package/dist/api/resources/components/client/requests/ComponentPropertiesWrite.js +5 -0
- package/dist/api/resources/components/client/requests/ComponentsGetContentRequest.d.ts +28 -0
- package/dist/api/resources/components/client/requests/ComponentsGetContentRequest.js +5 -0
- package/dist/api/resources/components/client/requests/ComponentsGetPropertiesRequest.d.ts +23 -0
- package/dist/api/resources/components/client/requests/ComponentsGetPropertiesRequest.js +5 -0
- package/dist/api/resources/components/client/requests/ComponentsListRequest.d.ts +17 -0
- package/dist/api/resources/components/client/requests/ComponentsListRequest.js +5 -0
- package/dist/api/resources/components/client/requests/index.d.ts +5 -0
- package/dist/api/resources/components/client/requests/index.js +2 -0
- package/dist/api/resources/components/index.d.ts +2 -0
- package/dist/api/resources/components/index.js +18 -0
- package/dist/api/resources/components/types/ComponentDomWriteNodesItem.d.ts +5 -0
- package/dist/api/resources/components/types/ComponentDomWriteNodesItem.js +5 -0
- package/dist/api/resources/components/types/ComponentPropertiesWritePropertiesItem.d.ts +16 -0
- package/dist/api/resources/components/types/ComponentPropertiesWritePropertiesItem.js +5 -0
- package/dist/api/resources/components/types/ComponentsUpdateContentResponse.d.ts +7 -0
- package/dist/api/resources/components/types/ComponentsUpdateContentResponse.js +5 -0
- package/dist/api/resources/components/types/ComponentsUpdatePropertiesResponse.d.ts +7 -0
- package/dist/api/resources/components/types/ComponentsUpdatePropertiesResponse.js +5 -0
- package/dist/api/resources/components/types/index.d.ts +4 -0
- package/dist/api/resources/components/types/index.js +20 -0
- package/dist/api/resources/ecommerce/client/Client.js +1 -1
- package/dist/api/resources/forms/client/Client.d.ts +3 -0
- package/dist/api/resources/forms/client/Client.js +8 -5
- package/dist/api/resources/index.d.ts +3 -0
- package/dist/api/resources/index.js +4 -1
- package/dist/api/resources/inventory/client/Client.d.ts +3 -1
- package/dist/api/resources/inventory/client/Client.js +5 -3
- package/dist/api/resources/orders/client/Client.d.ts +3 -0
- package/dist/api/resources/orders/client/Client.js +9 -6
- package/dist/api/resources/pages/client/Client.d.ts +26 -10
- package/dist/api/resources/pages/client/Client.js +32 -18
- package/dist/api/resources/pages/client/requests/PageDomWrite.d.ts +34 -0
- package/dist/api/resources/pages/client/requests/PageDomWrite.js +5 -0
- package/dist/api/resources/pages/client/requests/index.d.ts +1 -1
- package/dist/api/resources/pages/resources/scripts/client/Client.d.ts +6 -3
- package/dist/api/resources/pages/resources/scripts/client/Client.js +11 -6
- package/dist/api/resources/pages/types/PageDomWriteNodesItem.d.ts +5 -0
- package/dist/api/resources/pages/types/PageDomWriteNodesItem.js +5 -0
- package/dist/api/resources/pages/types/index.d.ts +1 -1
- package/dist/api/resources/pages/types/index.js +1 -1
- package/dist/api/resources/products/client/Client.d.ts +5 -6
- package/dist/api/resources/products/client/Client.js +11 -12
- package/dist/api/resources/scripts/client/Client.d.ts +3 -3
- package/dist/api/resources/scripts/client/Client.js +6 -6
- package/dist/api/resources/sites/client/Client.d.ts +70 -0
- package/dist/api/resources/sites/client/Client.js +330 -9
- package/dist/api/resources/sites/client/requests/SitesCreateRequest.d.ts +17 -0
- package/dist/api/resources/sites/client/requests/SitesCreateRequest.js +5 -0
- package/dist/api/resources/sites/client/requests/SitesUpdateRequest.d.ts +13 -0
- package/dist/api/resources/sites/client/requests/SitesUpdateRequest.js +5 -0
- package/dist/api/resources/sites/client/requests/index.d.ts +2 -0
- package/dist/api/resources/sites/resources/activityLogs/client/Client.d.ts +1 -1
- package/dist/api/resources/sites/resources/activityLogs/client/Client.js +2 -2
- 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 +45 -0
- package/dist/api/resources/sites/resources/plans/client/Client.js +155 -0
- package/dist/api/resources/sites/resources/plans/client/index.d.ts +1 -0
- package/dist/api/resources/sites/resources/plans/client/index.js +2 -0
- package/dist/api/resources/sites/resources/plans/index.d.ts +1 -0
- package/dist/api/resources/sites/resources/plans/index.js +17 -0
- package/dist/api/resources/sites/resources/redirects/client/Client.d.ts +115 -0
- package/dist/api/resources/sites/resources/redirects/client/Client.js +472 -0
- package/dist/api/resources/sites/resources/redirects/client/index.d.ts +1 -0
- package/dist/api/resources/sites/resources/redirects/client/index.js +2 -0
- package/dist/api/resources/sites/resources/redirects/index.d.ts +1 -0
- package/dist/api/resources/sites/resources/redirects/index.js +17 -0
- package/dist/api/resources/sites/resources/scripts/client/Client.d.ts +4 -4
- package/dist/api/resources/sites/resources/scripts/client/Client.js +8 -8
- package/dist/api/resources/token/client/Client.d.ts +2 -1
- package/dist/api/resources/token/client/Client.js +4 -3
- package/dist/api/resources/users/client/Client.d.ts +1 -1
- package/dist/api/resources/users/client/Client.js +6 -6
- package/dist/api/resources/webhooks/client/Client.d.ts +4 -1
- package/dist/api/resources/webhooks/client/Client.js +8 -5
- package/dist/api/types/CollectionItem.d.ts +5 -1
- package/dist/api/types/CollectionItemPostSingle.d.ts +7 -3
- package/dist/api/types/Component.d.ts +18 -0
- package/dist/api/types/Component.js +5 -0
- package/dist/api/types/ComponentDom.d.ts +13 -0
- package/dist/api/types/ComponentDom.js +5 -0
- package/dist/api/types/ComponentInstanceNodePropertyOverridesWrite.d.ts +13 -0
- package/dist/api/types/ComponentInstanceNodePropertyOverridesWrite.js +5 -0
- package/dist/api/types/ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem.d.ts +14 -0
- package/dist/api/types/ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem.js +5 -0
- package/dist/api/types/ComponentList.d.ts +11 -0
- package/dist/api/types/ComponentList.js +5 -0
- package/dist/api/types/ComponentNode.d.ts +15 -0
- package/dist/api/types/ComponentNode.js +5 -0
- package/dist/api/types/ComponentProperties.d.ts +13 -0
- package/dist/api/types/ComponentProperties.js +5 -0
- package/dist/api/types/ComponentProperty.d.ts +17 -0
- package/dist/api/types/ComponentProperty.js +5 -0
- package/dist/api/types/ComponentPropertyType.d.ts +12 -0
- package/dist/api/types/ComponentPropertyType.js +11 -0
- package/dist/api/types/Dom.d.ts +1 -1
- package/dist/api/types/Domain.d.ts +2 -0
- package/dist/api/types/Error_.d.ts +1 -1
- package/dist/api/types/FieldType.d.ts +10 -10
- package/dist/api/types/FieldType.js +9 -9
- package/dist/api/types/ImageNode.d.ts +6 -2
- package/dist/api/types/ImageNodeImage.d.ts +7 -0
- package/dist/api/types/ImageNodeImage.js +5 -0
- package/dist/api/types/Node.d.ts +11 -8
- package/dist/api/types/{ErrorDetailsItem.d.ts → NotEnterprisePlanWorkspace.d.ts} +1 -1
- package/dist/api/types/NotEnterprisePlanWorkspace.js +5 -0
- package/dist/api/types/ProductFieldData.d.ts +1 -1
- package/dist/api/types/Redirect.d.ts +14 -0
- package/dist/api/types/Redirect.js +5 -0
- package/dist/api/types/Redirects.d.ts +12 -0
- package/dist/api/types/Redirects.js +5 -0
- package/dist/api/types/ScriptApply.d.ts +1 -1
- package/dist/api/types/SitePlan.d.ts +12 -0
- package/dist/api/types/SitePlan.js +5 -0
- package/dist/api/types/SitePlanId.d.ts +21 -0
- package/dist/api/types/SitePlanId.js +20 -0
- package/dist/api/types/SitePlanName.d.ts +15 -0
- package/dist/api/types/SitePlanName.js +14 -0
- package/dist/api/types/Text.d.ts +9 -0
- package/dist/api/types/Text.js +5 -0
- package/dist/api/types/TextNode.d.ts +7 -3
- package/dist/api/types/TextNodeText.d.ts +9 -0
- package/dist/api/types/TextNodeText.js +5 -0
- package/dist/api/{resources/pages/types/DomWriteNodesItem.d.ts → types/TextNodeWrite.d.ts} +4 -1
- package/dist/api/types/TextNodeWrite.js +5 -0
- package/dist/api/types/TriggerType.d.ts +15 -15
- package/dist/api/types/UserAccessGroupsItem.d.ts +2 -3
- package/dist/api/types/UserAccessGroupsItemType.d.ts +2 -3
- package/dist/api/types/index.d.ts +23 -6
- package/dist/api/types/index.js +23 -6
- package/dist/serialization/resources/collections/resources/fields/types/FieldCreateType.d.ts +1 -1
- package/dist/serialization/resources/collections/resources/fields/types/FieldCreateType.js +10 -9
- package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.d.ts +2 -2
- package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.js +2 -2
- package/dist/serialization/resources/collections/resources/items/types/MultipleItems.d.ts +2 -2
- package/dist/serialization/resources/collections/resources/items/types/MultipleItems.js +2 -2
- package/dist/serialization/resources/collections/resources/items/types/MultipleLiveItems.d.ts +13 -0
- package/dist/serialization/resources/collections/resources/items/types/MultipleLiveItems.js +34 -0
- package/dist/serialization/resources/collections/resources/items/types/index.d.ts +1 -0
- package/dist/serialization/resources/collections/resources/items/types/index.js +1 -0
- package/dist/serialization/resources/components/client/index.d.ts +1 -0
- package/dist/serialization/resources/components/client/index.js +17 -0
- package/dist/serialization/resources/components/client/requests/ComponentDomWrite.d.ts +13 -0
- package/dist/serialization/resources/components/client/requests/ComponentDomWrite.js +34 -0
- package/dist/serialization/resources/components/client/requests/ComponentPropertiesWrite.d.ts +13 -0
- package/dist/serialization/resources/components/client/requests/ComponentPropertiesWrite.js +34 -0
- package/dist/serialization/resources/components/client/requests/index.d.ts +2 -0
- package/dist/serialization/resources/components/client/requests/index.js +7 -0
- package/dist/serialization/resources/components/index.d.ts +2 -0
- package/dist/serialization/resources/components/index.js +18 -0
- package/dist/serialization/resources/components/types/ComponentDomWriteNodesItem.d.ts +12 -0
- package/dist/serialization/resources/components/types/ComponentDomWriteNodesItem.js +33 -0
- package/dist/serialization/resources/components/types/ComponentPropertiesWritePropertiesItem.d.ts +13 -0
- package/dist/serialization/resources/components/types/ComponentPropertiesWritePropertiesItem.js +34 -0
- package/dist/serialization/resources/components/types/ComponentsUpdateContentResponse.d.ts +12 -0
- package/dist/serialization/resources/components/types/ComponentsUpdateContentResponse.js +33 -0
- package/dist/serialization/resources/components/types/ComponentsUpdatePropertiesResponse.d.ts +12 -0
- package/dist/serialization/resources/components/types/ComponentsUpdatePropertiesResponse.js +33 -0
- package/dist/serialization/resources/components/types/index.d.ts +4 -0
- package/dist/serialization/resources/components/types/index.js +20 -0
- package/dist/serialization/resources/index.d.ts +3 -0
- package/dist/serialization/resources/index.js +4 -1
- package/dist/serialization/resources/pages/client/requests/PageDomWrite.d.ts +13 -0
- package/dist/serialization/resources/pages/client/requests/PageDomWrite.js +34 -0
- package/dist/serialization/resources/pages/client/requests/index.d.ts +1 -1
- package/dist/serialization/resources/pages/client/requests/index.js +3 -3
- package/dist/serialization/resources/pages/types/PageDomWriteNodesItem.d.ts +12 -0
- package/dist/serialization/resources/pages/types/PageDomWriteNodesItem.js +33 -0
- package/dist/serialization/resources/pages/types/index.d.ts +1 -1
- package/dist/serialization/resources/pages/types/index.js +1 -1
- package/dist/serialization/resources/sites/client/requests/SitesCreateRequest.d.ts +14 -0
- package/dist/serialization/resources/sites/client/requests/SitesCreateRequest.js +35 -0
- package/dist/serialization/resources/sites/client/requests/SitesUpdateRequest.d.ts +13 -0
- package/{serialization/resources/pages/client/requests/DomWrite.js → dist/serialization/resources/sites/client/requests/SitesUpdateRequest.js} +4 -4
- package/dist/serialization/resources/sites/client/requests/index.d.ts +2 -0
- package/dist/serialization/resources/sites/client/requests/index.js +5 -1
- package/dist/serialization/types/Component.d.ts +16 -0
- package/dist/serialization/types/Component.js +37 -0
- package/dist/serialization/types/ComponentDom.d.ts +16 -0
- package/dist/serialization/types/ComponentDom.js +37 -0
- package/dist/serialization/types/ComponentInstanceNodePropertyOverridesWrite.d.ts +14 -0
- package/dist/serialization/types/ComponentInstanceNodePropertyOverridesWrite.js +35 -0
- package/dist/serialization/types/ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem.d.ts +13 -0
- package/dist/serialization/types/ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem.js +34 -0
- package/dist/serialization/types/ComponentList.d.ts +15 -0
- package/dist/serialization/types/ComponentList.js +36 -0
- package/dist/serialization/types/ComponentNode.d.ts +15 -0
- package/dist/serialization/types/ComponentNode.js +36 -0
- package/dist/serialization/types/ComponentProperties.d.ts +16 -0
- package/dist/serialization/types/ComponentProperties.js +37 -0
- package/dist/serialization/types/ComponentProperty.d.ts +17 -0
- package/dist/serialization/types/ComponentProperty.js +38 -0
- package/dist/serialization/types/ComponentPropertyType.d.ts +10 -0
- package/dist/serialization/types/{ErrorDetailsItem.js → ComponentPropertyType.js} +2 -5
- package/dist/serialization/types/Domain.d.ts +1 -0
- package/dist/serialization/types/Domain.js +1 -0
- package/dist/serialization/types/Error_.d.ts +1 -2
- package/dist/serialization/types/Error_.js +1 -2
- package/dist/serialization/types/FieldType.d.ts +1 -1
- package/dist/serialization/types/FieldType.js +9 -9
- package/dist/serialization/types/ImageNode.d.ts +4 -2
- package/dist/serialization/types/ImageNode.js +4 -2
- package/dist/serialization/types/ImageNodeImage.d.ts +13 -0
- package/{serialization/types/ErrorDetailsItem.js → dist/serialization/types/ImageNodeImage.js} +5 -5
- package/dist/serialization/types/Node.d.ts +11 -8
- package/dist/serialization/types/Node.js +10 -7
- package/dist/serialization/types/NotEnterprisePlanWorkspace.d.ts +10 -0
- package/dist/serialization/types/{NodeType.js → NotEnterprisePlanWorkspace.js} +2 -2
- package/dist/serialization/types/Redirect.d.ts +14 -0
- package/dist/serialization/types/Redirect.js +35 -0
- package/dist/serialization/types/Redirects.d.ts +15 -0
- package/dist/serialization/types/Redirects.js +36 -0
- package/dist/serialization/types/SitePlan.d.ts +16 -0
- package/dist/serialization/types/SitePlan.js +37 -0
- package/dist/serialization/types/SitePlanId.d.ts +10 -0
- package/dist/serialization/types/SitePlanId.js +44 -0
- package/dist/serialization/types/SitePlanName.d.ts +10 -0
- package/dist/serialization/types/SitePlanName.js +38 -0
- package/dist/serialization/types/Text.d.ts +13 -0
- package/dist/serialization/types/Text.js +34 -0
- package/dist/serialization/types/TextNode.d.ts +4 -2
- package/dist/serialization/types/TextNode.js +4 -2
- package/dist/serialization/types/TextNodeText.d.ts +13 -0
- package/dist/serialization/types/TextNodeText.js +34 -0
- package/dist/serialization/types/TextNodeWrite.d.ts +13 -0
- package/{serialization/resources/pages/types/DomWriteNodesItem.js → dist/serialization/types/TextNodeWrite.js} +3 -3
- package/dist/serialization/types/index.d.ts +23 -6
- package/dist/serialization/types/index.js +23 -6
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
- package/reference.md +1844 -778
- package/serialization/resources/collections/resources/fields/types/FieldCreateType.d.ts +1 -1
- package/serialization/resources/collections/resources/fields/types/FieldCreateType.js +10 -9
- package/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.d.ts +2 -2
- package/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.js +2 -2
- package/serialization/resources/collections/resources/items/types/MultipleItems.d.ts +2 -2
- package/serialization/resources/collections/resources/items/types/MultipleItems.js +2 -2
- package/serialization/resources/collections/resources/items/types/MultipleLiveItems.d.ts +13 -0
- package/serialization/resources/collections/resources/items/types/MultipleLiveItems.js +34 -0
- package/serialization/resources/collections/resources/items/types/index.d.ts +1 -0
- package/serialization/resources/collections/resources/items/types/index.js +1 -0
- package/serialization/resources/components/client/index.d.ts +1 -0
- package/serialization/resources/components/client/index.js +17 -0
- package/serialization/resources/components/client/requests/ComponentDomWrite.d.ts +13 -0
- package/serialization/resources/components/client/requests/ComponentDomWrite.js +34 -0
- package/serialization/resources/components/client/requests/ComponentPropertiesWrite.d.ts +13 -0
- package/serialization/resources/components/client/requests/ComponentPropertiesWrite.js +34 -0
- package/serialization/resources/components/client/requests/index.d.ts +2 -0
- package/serialization/resources/components/client/requests/index.js +7 -0
- package/serialization/resources/components/index.d.ts +2 -0
- package/serialization/resources/components/index.js +18 -0
- package/serialization/resources/components/types/ComponentDomWriteNodesItem.d.ts +12 -0
- package/serialization/resources/components/types/ComponentDomWriteNodesItem.js +33 -0
- package/serialization/resources/components/types/ComponentPropertiesWritePropertiesItem.d.ts +13 -0
- package/serialization/resources/components/types/ComponentPropertiesWritePropertiesItem.js +34 -0
- package/serialization/resources/components/types/ComponentsUpdateContentResponse.d.ts +12 -0
- package/serialization/resources/components/types/ComponentsUpdateContentResponse.js +33 -0
- package/serialization/resources/components/types/ComponentsUpdatePropertiesResponse.d.ts +12 -0
- package/serialization/resources/components/types/ComponentsUpdatePropertiesResponse.js +33 -0
- package/serialization/resources/components/types/index.d.ts +4 -0
- package/serialization/resources/components/types/index.js +20 -0
- package/serialization/resources/index.d.ts +3 -0
- package/serialization/resources/index.js +4 -1
- package/serialization/resources/pages/client/requests/PageDomWrite.d.ts +13 -0
- package/serialization/resources/pages/client/requests/PageDomWrite.js +34 -0
- package/serialization/resources/pages/client/requests/index.d.ts +1 -1
- package/serialization/resources/pages/client/requests/index.js +3 -3
- package/serialization/resources/pages/types/PageDomWriteNodesItem.d.ts +12 -0
- package/serialization/resources/pages/types/PageDomWriteNodesItem.js +33 -0
- package/serialization/resources/pages/types/index.d.ts +1 -1
- package/serialization/resources/pages/types/index.js +1 -1
- package/serialization/resources/sites/client/requests/SitesCreateRequest.d.ts +14 -0
- package/serialization/resources/sites/client/requests/SitesCreateRequest.js +35 -0
- package/serialization/resources/sites/client/requests/SitesUpdateRequest.d.ts +13 -0
- package/{dist/serialization/resources/pages/client/requests/DomWrite.js → serialization/resources/sites/client/requests/SitesUpdateRequest.js} +4 -4
- package/serialization/resources/sites/client/requests/index.d.ts +2 -0
- package/serialization/resources/sites/client/requests/index.js +5 -1
- package/serialization/types/Component.d.ts +16 -0
- package/serialization/types/Component.js +37 -0
- package/serialization/types/ComponentDom.d.ts +16 -0
- package/serialization/types/ComponentDom.js +37 -0
- package/serialization/types/ComponentInstanceNodePropertyOverridesWrite.d.ts +14 -0
- package/serialization/types/ComponentInstanceNodePropertyOverridesWrite.js +35 -0
- package/serialization/types/ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem.d.ts +13 -0
- package/serialization/types/ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem.js +34 -0
- package/serialization/types/ComponentList.d.ts +15 -0
- package/serialization/types/ComponentList.js +36 -0
- package/serialization/types/ComponentNode.d.ts +15 -0
- package/serialization/types/ComponentNode.js +36 -0
- package/serialization/types/ComponentProperties.d.ts +16 -0
- package/serialization/types/ComponentProperties.js +37 -0
- package/serialization/types/ComponentProperty.d.ts +17 -0
- package/serialization/types/ComponentProperty.js +38 -0
- package/serialization/types/ComponentPropertyType.d.ts +10 -0
- package/serialization/types/ComponentPropertyType.js +31 -0
- package/serialization/types/Domain.d.ts +1 -0
- package/serialization/types/Domain.js +1 -0
- package/serialization/types/Error_.d.ts +1 -2
- package/serialization/types/Error_.js +1 -2
- package/serialization/types/FieldType.d.ts +1 -1
- package/serialization/types/FieldType.js +9 -9
- package/serialization/types/ImageNode.d.ts +4 -2
- package/serialization/types/ImageNode.js +4 -2
- package/serialization/types/ImageNodeImage.d.ts +13 -0
- package/serialization/types/ImageNodeImage.js +34 -0
- package/serialization/types/Node.d.ts +11 -8
- package/serialization/types/Node.js +10 -7
- package/serialization/types/NotEnterprisePlanWorkspace.d.ts +10 -0
- package/serialization/types/{NodeType.js → NotEnterprisePlanWorkspace.js} +2 -2
- package/serialization/types/Redirect.d.ts +14 -0
- package/serialization/types/Redirect.js +35 -0
- package/serialization/types/Redirects.d.ts +15 -0
- package/serialization/types/Redirects.js +36 -0
- package/serialization/types/SitePlan.d.ts +16 -0
- package/serialization/types/SitePlan.js +37 -0
- package/serialization/types/SitePlanId.d.ts +10 -0
- package/serialization/types/SitePlanId.js +44 -0
- package/serialization/types/SitePlanName.d.ts +10 -0
- package/serialization/types/SitePlanName.js +38 -0
- package/serialization/types/Text.d.ts +13 -0
- package/serialization/types/Text.js +34 -0
- package/serialization/types/TextNode.d.ts +4 -2
- package/serialization/types/TextNode.js +4 -2
- package/serialization/types/TextNodeText.d.ts +13 -0
- package/serialization/types/TextNodeText.js +34 -0
- package/serialization/types/TextNodeWrite.d.ts +13 -0
- package/{dist/serialization/resources/pages/types/DomWriteNodesItem.js → serialization/types/TextNodeWrite.js} +3 -3
- package/serialization/types/index.d.ts +23 -6
- package/serialization/types/index.js +23 -6
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/api/resources/pages/client/requests/DomWrite.d.ts +0 -27
- package/api/types/NodeType.d.ts +0 -8
- package/api/types/NodeType.js +0 -10
- package/dist/api/resources/pages/client/requests/DomWrite.d.ts +0 -27
- package/dist/api/types/NodeType.d.ts +0 -8
- package/dist/api/types/NodeType.js +0 -10
- package/dist/serialization/resources/pages/client/requests/DomWrite.d.ts +0 -13
- package/dist/serialization/resources/pages/types/DomWriteNodesItem.d.ts +0 -13
- package/dist/serialization/types/ErrorDetailsItem.d.ts +0 -10
- package/dist/serialization/types/NodeType.d.ts +0 -10
- package/serialization/resources/pages/client/requests/DomWrite.d.ts +0 -13
- package/serialization/resources/pages/types/DomWriteNodesItem.d.ts +0 -13
- package/serialization/types/ErrorDetailsItem.d.ts +0 -10
- package/serialization/types/NodeType.d.ts +0 -10
- /package/api/resources/{pages/client/requests/DomWrite.js → collections/resources/items/types/MultipleLiveItems.js} +0 -0
- /package/api/resources/{pages/types/DomWriteNodesItem.js → components/client/requests/ComponentDomWrite.js} +0 -0
- /package/api/{types/ErrorDetailsItem.js → resources/components/client/requests/ComponentPropertiesWrite.js} +0 -0
- /package/{dist/api/resources/pages/client/requests/DomWrite.js → api/resources/components/client/requests/ComponentsGetContentRequest.js} +0 -0
- /package/{dist/api/resources/pages/types/DomWriteNodesItem.js → api/resources/components/client/requests/ComponentsGetPropertiesRequest.js} +0 -0
- /package/{dist/api/types/ErrorDetailsItem.js → api/resources/components/client/requests/ComponentsListRequest.js} +0 -0
package/reference.md
CHANGED
|
@@ -72,7 +72,8 @@ await client.token.authorizedBy();
|
|
|
72
72
|
<dd>
|
|
73
73
|
|
|
74
74
|
Information about the authorization token
|
|
75
|
-
|
|
75
|
+
|
|
76
|
+
<Note>Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients).</Note>
|
|
76
77
|
|
|
77
78
|
</dd>
|
|
78
79
|
</dl>
|
|
@@ -117,6 +118,81 @@ await client.token.introspect();
|
|
|
117
118
|
|
|
118
119
|
## Sites
|
|
119
120
|
|
|
121
|
+
<details><summary><code>client.sites.<a href="/src/api/resources/sites/client/Client.ts">create</a>(workspaceId, { ...params }) -> Webflow.Site</code></summary>
|
|
122
|
+
<dl>
|
|
123
|
+
<dd>
|
|
124
|
+
|
|
125
|
+
#### 📝 Description
|
|
126
|
+
|
|
127
|
+
<dl>
|
|
128
|
+
<dd>
|
|
129
|
+
|
|
130
|
+
<dl>
|
|
131
|
+
<dd>
|
|
132
|
+
|
|
133
|
+
Create a site. This endpoint requires an Enterprise workspace.
|
|
134
|
+
|
|
135
|
+
Required scope | `workspace:write`
|
|
136
|
+
|
|
137
|
+
</dd>
|
|
138
|
+
</dl>
|
|
139
|
+
</dd>
|
|
140
|
+
</dl>
|
|
141
|
+
|
|
142
|
+
#### 🔌 Usage
|
|
143
|
+
|
|
144
|
+
<dl>
|
|
145
|
+
<dd>
|
|
146
|
+
|
|
147
|
+
<dl>
|
|
148
|
+
<dd>
|
|
149
|
+
|
|
150
|
+
```typescript
|
|
151
|
+
await client.sites.create("580e63e98c9a982ac9b8b741", {
|
|
152
|
+
name: "The Hitchhiker's Guide to the Galaxy",
|
|
153
|
+
});
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
</dd>
|
|
157
|
+
</dl>
|
|
158
|
+
</dd>
|
|
159
|
+
</dl>
|
|
160
|
+
|
|
161
|
+
#### ⚙️ Parameters
|
|
162
|
+
|
|
163
|
+
<dl>
|
|
164
|
+
<dd>
|
|
165
|
+
|
|
166
|
+
<dl>
|
|
167
|
+
<dd>
|
|
168
|
+
|
|
169
|
+
**workspaceId:** `string` — Unique identifier for a Workspace
|
|
170
|
+
|
|
171
|
+
</dd>
|
|
172
|
+
</dl>
|
|
173
|
+
|
|
174
|
+
<dl>
|
|
175
|
+
<dd>
|
|
176
|
+
|
|
177
|
+
**request:** `Webflow.SitesCreateRequest`
|
|
178
|
+
|
|
179
|
+
</dd>
|
|
180
|
+
</dl>
|
|
181
|
+
|
|
182
|
+
<dl>
|
|
183
|
+
<dd>
|
|
184
|
+
|
|
185
|
+
**requestOptions:** `Sites.RequestOptions`
|
|
186
|
+
|
|
187
|
+
</dd>
|
|
188
|
+
</dl>
|
|
189
|
+
</dd>
|
|
190
|
+
</dl>
|
|
191
|
+
|
|
192
|
+
</dd>
|
|
193
|
+
</dl>
|
|
194
|
+
</details>
|
|
195
|
+
|
|
120
196
|
<details><summary><code>client.sites.<a href="/src/api/resources/sites/client/Client.ts">list</a>() -> Webflow.Sites</code></summary>
|
|
121
197
|
<dl>
|
|
122
198
|
<dd>
|
|
@@ -239,6 +315,144 @@ await client.sites.get("580e63e98c9a982ac9b8b741");
|
|
|
239
315
|
</dl>
|
|
240
316
|
</details>
|
|
241
317
|
|
|
318
|
+
<details><summary><code>client.sites.<a href="/src/api/resources/sites/client/Client.ts">delete</a>(siteId) -> void</code></summary>
|
|
319
|
+
<dl>
|
|
320
|
+
<dd>
|
|
321
|
+
|
|
322
|
+
#### 📝 Description
|
|
323
|
+
|
|
324
|
+
<dl>
|
|
325
|
+
<dd>
|
|
326
|
+
|
|
327
|
+
<dl>
|
|
328
|
+
<dd>
|
|
329
|
+
|
|
330
|
+
Delete a site. This endpoint requires an Enterprise workspace.
|
|
331
|
+
|
|
332
|
+
Required scope | `sites:write`
|
|
333
|
+
|
|
334
|
+
</dd>
|
|
335
|
+
</dl>
|
|
336
|
+
</dd>
|
|
337
|
+
</dl>
|
|
338
|
+
|
|
339
|
+
#### 🔌 Usage
|
|
340
|
+
|
|
341
|
+
<dl>
|
|
342
|
+
<dd>
|
|
343
|
+
|
|
344
|
+
<dl>
|
|
345
|
+
<dd>
|
|
346
|
+
|
|
347
|
+
```typescript
|
|
348
|
+
await client.sites.delete("580e63e98c9a982ac9b8b741");
|
|
349
|
+
```
|
|
350
|
+
|
|
351
|
+
</dd>
|
|
352
|
+
</dl>
|
|
353
|
+
</dd>
|
|
354
|
+
</dl>
|
|
355
|
+
|
|
356
|
+
#### ⚙️ Parameters
|
|
357
|
+
|
|
358
|
+
<dl>
|
|
359
|
+
<dd>
|
|
360
|
+
|
|
361
|
+
<dl>
|
|
362
|
+
<dd>
|
|
363
|
+
|
|
364
|
+
**siteId:** `string` — Unique identifier for a Site
|
|
365
|
+
|
|
366
|
+
</dd>
|
|
367
|
+
</dl>
|
|
368
|
+
|
|
369
|
+
<dl>
|
|
370
|
+
<dd>
|
|
371
|
+
|
|
372
|
+
**requestOptions:** `Sites.RequestOptions`
|
|
373
|
+
|
|
374
|
+
</dd>
|
|
375
|
+
</dl>
|
|
376
|
+
</dd>
|
|
377
|
+
</dl>
|
|
378
|
+
|
|
379
|
+
</dd>
|
|
380
|
+
</dl>
|
|
381
|
+
</details>
|
|
382
|
+
|
|
383
|
+
<details><summary><code>client.sites.<a href="/src/api/resources/sites/client/Client.ts">update</a>(siteId, { ...params }) -> Webflow.Site</code></summary>
|
|
384
|
+
<dl>
|
|
385
|
+
<dd>
|
|
386
|
+
|
|
387
|
+
#### 📝 Description
|
|
388
|
+
|
|
389
|
+
<dl>
|
|
390
|
+
<dd>
|
|
391
|
+
|
|
392
|
+
<dl>
|
|
393
|
+
<dd>
|
|
394
|
+
|
|
395
|
+
Update a site. This endpoint requires an Enterprise workspace.
|
|
396
|
+
|
|
397
|
+
Required scope | `sites:write`
|
|
398
|
+
|
|
399
|
+
</dd>
|
|
400
|
+
</dl>
|
|
401
|
+
</dd>
|
|
402
|
+
</dl>
|
|
403
|
+
|
|
404
|
+
#### 🔌 Usage
|
|
405
|
+
|
|
406
|
+
<dl>
|
|
407
|
+
<dd>
|
|
408
|
+
|
|
409
|
+
<dl>
|
|
410
|
+
<dd>
|
|
411
|
+
|
|
412
|
+
```typescript
|
|
413
|
+
await client.sites.update("580e63e98c9a982ac9b8b741");
|
|
414
|
+
```
|
|
415
|
+
|
|
416
|
+
</dd>
|
|
417
|
+
</dl>
|
|
418
|
+
</dd>
|
|
419
|
+
</dl>
|
|
420
|
+
|
|
421
|
+
#### ⚙️ Parameters
|
|
422
|
+
|
|
423
|
+
<dl>
|
|
424
|
+
<dd>
|
|
425
|
+
|
|
426
|
+
<dl>
|
|
427
|
+
<dd>
|
|
428
|
+
|
|
429
|
+
**siteId:** `string` — Unique identifier for a Site
|
|
430
|
+
|
|
431
|
+
</dd>
|
|
432
|
+
</dl>
|
|
433
|
+
|
|
434
|
+
<dl>
|
|
435
|
+
<dd>
|
|
436
|
+
|
|
437
|
+
**request:** `Webflow.SitesUpdateRequest`
|
|
438
|
+
|
|
439
|
+
</dd>
|
|
440
|
+
</dl>
|
|
441
|
+
|
|
442
|
+
<dl>
|
|
443
|
+
<dd>
|
|
444
|
+
|
|
445
|
+
**requestOptions:** `Sites.RequestOptions`
|
|
446
|
+
|
|
447
|
+
</dd>
|
|
448
|
+
</dl>
|
|
449
|
+
</dd>
|
|
450
|
+
</dl>
|
|
451
|
+
|
|
452
|
+
</dd>
|
|
453
|
+
</dl>
|
|
454
|
+
</details>
|
|
455
|
+
|
|
242
456
|
<details><summary><code>client.sites.<a href="/src/api/resources/sites/client/Client.ts">getCustomDomain</a>(siteId) -> Webflow.Domains</code></summary>
|
|
243
457
|
<dl>
|
|
244
458
|
<dd>
|
|
@@ -917,9 +1131,10 @@ await client.pages.updatePageSettings("63c720f9347c2139b248e552", {
|
|
|
917
1131
|
<dl>
|
|
918
1132
|
<dd>
|
|
919
1133
|
|
|
920
|
-
Get static content from a static page.
|
|
1134
|
+
Get static content from a static page. This includes text nodes, image nodes and component instances.
|
|
1135
|
+
To retrieve the contents of components in the page use the [get component content](/data/reference/pages-and-components/components/get-content) endpoint.
|
|
921
1136
|
|
|
922
|
-
If you do not provide a Locale ID in your request, the response will return any content that can be localized from the Primary locale
|
|
1137
|
+
<Note>If you do not provide a Locale ID in your request, the response will return any content that can be localized from the Primary locale.</Note>
|
|
923
1138
|
|
|
924
1139
|
Required scope | `pages:read`
|
|
925
1140
|
|
|
@@ -994,9 +1209,16 @@ await client.pages.getContent("63c720f9347c2139b248e552", {
|
|
|
994
1209
|
<dl>
|
|
995
1210
|
<dd>
|
|
996
1211
|
|
|
997
|
-
This endpoint
|
|
1212
|
+
This endpoint updates content on a static page in **secondary locales**. It supports updating up to 1000 nodes in a single request.
|
|
998
1213
|
|
|
999
|
-
|
|
1214
|
+
Before making updates:
|
|
1215
|
+
|
|
1216
|
+
1. Use the [get page content](/data/reference/pages-and-components/pages/get-content) endpoint to identify available content nodes and their types
|
|
1217
|
+
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
|
|
1218
|
+
|
|
1219
|
+
<Note>
|
|
1220
|
+
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.
|
|
1221
|
+
</Note>
|
|
1000
1222
|
|
|
1001
1223
|
Required scope | `pages:write`
|
|
1002
1224
|
|
|
@@ -1015,19 +1237,28 @@ Required scope | `pages:write`
|
|
|
1015
1237
|
|
|
1016
1238
|
```typescript
|
|
1017
1239
|
await client.pages.updateStaticContent("63c720f9347c2139b248e552", {
|
|
1018
|
-
localeId: "
|
|
1240
|
+
localeId: "localeId",
|
|
1019
1241
|
nodes: [
|
|
1020
1242
|
{
|
|
1021
1243
|
nodeId: "a245c12d-995b-55ee-5ec7-aa36a6cad623",
|
|
1022
|
-
text: "<h1>The Hitchhiker
|
|
1244
|
+
text: "<h1>The Hitchhiker's Guide to the Galaxy</h1>",
|
|
1023
1245
|
},
|
|
1024
1246
|
{
|
|
1025
1247
|
nodeId: "a245c12d-995b-55ee-5ec7-aa36a6cad627",
|
|
1026
|
-
text: "<div><h3>Don
|
|
1248
|
+
text: "<div><h3>Don't Panic!</h3><p>Always know where your towel is.</p></div>",
|
|
1027
1249
|
},
|
|
1028
1250
|
{
|
|
1029
1251
|
nodeId: "a245c12d-995b-55ee-5ec7-aa36a6cad629",
|
|
1030
|
-
|
|
1252
|
+
propertyOverrides: [
|
|
1253
|
+
{
|
|
1254
|
+
propertyId: "7dd14c08-2e96-8d3d-2b19-b5c03642a0f0",
|
|
1255
|
+
text: "<div><h1>Time is an <em>illusion</em></h1></div>",
|
|
1256
|
+
},
|
|
1257
|
+
{
|
|
1258
|
+
propertyId: "7dd14c08-2e96-8d3d-2b19-b5c03642a0f1",
|
|
1259
|
+
text: "Life, the Universe and Everything",
|
|
1260
|
+
},
|
|
1261
|
+
],
|
|
1031
1262
|
},
|
|
1032
1263
|
],
|
|
1033
1264
|
});
|
|
@@ -1054,7 +1285,7 @@ await client.pages.updateStaticContent("63c720f9347c2139b248e552", {
|
|
|
1054
1285
|
<dl>
|
|
1055
1286
|
<dd>
|
|
1056
1287
|
|
|
1057
|
-
**request:** `Webflow.
|
|
1288
|
+
**request:** `Webflow.PageDomWrite`
|
|
1058
1289
|
|
|
1059
1290
|
</dd>
|
|
1060
1291
|
</dl>
|
|
@@ -1073,9 +1304,9 @@ await client.pages.updateStaticContent("63c720f9347c2139b248e552", {
|
|
|
1073
1304
|
</dl>
|
|
1074
1305
|
</details>
|
|
1075
1306
|
|
|
1076
|
-
##
|
|
1307
|
+
## Components
|
|
1077
1308
|
|
|
1078
|
-
<details><summary><code>client.
|
|
1309
|
+
<details><summary><code>client.components.<a href="/src/api/resources/components/client/Client.ts">list</a>(siteId, { ...params }) -> Webflow.ComponentList</code></summary>
|
|
1079
1310
|
<dl>
|
|
1080
1311
|
<dd>
|
|
1081
1312
|
|
|
@@ -1087,16 +1318,9 @@ await client.pages.updateStaticContent("63c720f9347c2139b248e552", {
|
|
|
1087
1318
|
<dl>
|
|
1088
1319
|
<dd>
|
|
1089
1320
|
|
|
1090
|
-
List of
|
|
1091
|
-
|
|
1092
|
-
In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered
|
|
1093
|
-
to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate
|
|
1094
|
-
`custom_code` endpoints.
|
|
1095
|
-
Additionally, Scripts can be remotely hosted, or registered as inline snippets.
|
|
1096
|
-
|
|
1097
|
-
<blockquote class="callout callout_info" theme="📘">Access to this endpoint requires a bearer token from a <a href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data Client App</a>.</blockquote>
|
|
1321
|
+
List of all components for a site.
|
|
1098
1322
|
|
|
1099
|
-
Required scope | `
|
|
1323
|
+
Required scope | `components:read`
|
|
1100
1324
|
|
|
1101
1325
|
</dd>
|
|
1102
1326
|
</dl>
|
|
@@ -1112,7 +1336,7 @@ Required scope | `custom_code:read`
|
|
|
1112
1336
|
<dd>
|
|
1113
1337
|
|
|
1114
1338
|
```typescript
|
|
1115
|
-
await client.
|
|
1339
|
+
await client.components.list("580e63e98c9a982ac9b8b741");
|
|
1116
1340
|
```
|
|
1117
1341
|
|
|
1118
1342
|
</dd>
|
|
@@ -1136,7 +1360,15 @@ await client.scripts.list("580e63e98c9a982ac9b8b741");
|
|
|
1136
1360
|
<dl>
|
|
1137
1361
|
<dd>
|
|
1138
1362
|
|
|
1139
|
-
**
|
|
1363
|
+
**request:** `Webflow.ComponentsListRequest`
|
|
1364
|
+
|
|
1365
|
+
</dd>
|
|
1366
|
+
</dl>
|
|
1367
|
+
|
|
1368
|
+
<dl>
|
|
1369
|
+
<dd>
|
|
1370
|
+
|
|
1371
|
+
**requestOptions:** `Components.RequestOptions`
|
|
1140
1372
|
|
|
1141
1373
|
</dd>
|
|
1142
1374
|
</dl>
|
|
@@ -1147,7 +1379,7 @@ await client.scripts.list("580e63e98c9a982ac9b8b741");
|
|
|
1147
1379
|
</dl>
|
|
1148
1380
|
</details>
|
|
1149
1381
|
|
|
1150
|
-
<details><summary><code>client.
|
|
1382
|
+
<details><summary><code>client.components.<a href="/src/api/resources/components/client/Client.ts">getContent</a>(siteId, componentId, { ...params }) -> Webflow.ComponentDom</code></summary>
|
|
1151
1383
|
<dl>
|
|
1152
1384
|
<dd>
|
|
1153
1385
|
|
|
@@ -1159,16 +1391,12 @@ await client.scripts.list("580e63e98c9a982ac9b8b741");
|
|
|
1159
1391
|
<dl>
|
|
1160
1392
|
<dd>
|
|
1161
1393
|
|
|
1162
|
-
|
|
1163
|
-
|
|
1164
|
-
In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered
|
|
1165
|
-
to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate
|
|
1166
|
-
`custom_code` endpoints.
|
|
1167
|
-
Additionally, Scripts can be remotely hosted, or registered as inline snippets.
|
|
1394
|
+
Get static content from a component definition. This includes text nodes, image nodes and nested component instances.
|
|
1395
|
+
To retrieve dynamic content set by component properties, use the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint.
|
|
1168
1396
|
|
|
1169
|
-
<
|
|
1397
|
+
<Note>If you do not provide a Locale ID in your request, the response will return any content that can be localized from the Primary locale.</Note>
|
|
1170
1398
|
|
|
1171
|
-
Required scope | `
|
|
1399
|
+
Required scope | `components:read`
|
|
1172
1400
|
|
|
1173
1401
|
</dd>
|
|
1174
1402
|
</dl>
|
|
@@ -1184,11 +1412,8 @@ Required scope | `custom_code:write`
|
|
|
1184
1412
|
<dd>
|
|
1185
1413
|
|
|
1186
1414
|
```typescript
|
|
1187
|
-
await client.
|
|
1188
|
-
|
|
1189
|
-
integrityHash: "integrityHash",
|
|
1190
|
-
version: "version",
|
|
1191
|
-
displayName: "displayName",
|
|
1415
|
+
await client.components.getContent("580e63e98c9a982ac9b8b741", "8505ba55-ef72-629e-f85c-33e4b703d48b", {
|
|
1416
|
+
localeId: "65427cf400e02b306eaa04a0",
|
|
1192
1417
|
});
|
|
1193
1418
|
```
|
|
1194
1419
|
|
|
@@ -1213,7 +1438,7 @@ await client.scripts.registerHosted("580e63e98c9a982ac9b8b741", {
|
|
|
1213
1438
|
<dl>
|
|
1214
1439
|
<dd>
|
|
1215
1440
|
|
|
1216
|
-
**
|
|
1441
|
+
**componentId:** `string` — Unique identifier for a Component
|
|
1217
1442
|
|
|
1218
1443
|
</dd>
|
|
1219
1444
|
</dl>
|
|
@@ -1221,7 +1446,15 @@ await client.scripts.registerHosted("580e63e98c9a982ac9b8b741", {
|
|
|
1221
1446
|
<dl>
|
|
1222
1447
|
<dd>
|
|
1223
1448
|
|
|
1224
|
-
**
|
|
1449
|
+
**request:** `Webflow.ComponentsGetContentRequest`
|
|
1450
|
+
|
|
1451
|
+
</dd>
|
|
1452
|
+
</dl>
|
|
1453
|
+
|
|
1454
|
+
<dl>
|
|
1455
|
+
<dd>
|
|
1456
|
+
|
|
1457
|
+
**requestOptions:** `Components.RequestOptions`
|
|
1225
1458
|
|
|
1226
1459
|
</dd>
|
|
1227
1460
|
</dl>
|
|
@@ -1232,7 +1465,7 @@ await client.scripts.registerHosted("580e63e98c9a982ac9b8b741", {
|
|
|
1232
1465
|
</dl>
|
|
1233
1466
|
</details>
|
|
1234
1467
|
|
|
1235
|
-
<details><summary><code>client.
|
|
1468
|
+
<details><summary><code>client.components.<a href="/src/api/resources/components/client/Client.ts">updateContent</a>(siteId, componentId, { ...params }) -> Webflow.ComponentsUpdateContentResponse</code></summary>
|
|
1236
1469
|
<dl>
|
|
1237
1470
|
<dd>
|
|
1238
1471
|
|
|
@@ -1244,15 +1477,18 @@ await client.scripts.registerHosted("580e63e98c9a982ac9b8b741", {
|
|
|
1244
1477
|
<dl>
|
|
1245
1478
|
<dd>
|
|
1246
1479
|
|
|
1247
|
-
|
|
1480
|
+
This endpoint updates content within a component defintion for **secondary locales**. It supports updating up to 1000 nodes in a single request.
|
|
1248
1481
|
|
|
1249
|
-
|
|
1250
|
-
to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate
|
|
1251
|
-
`custom_code` endpoints.
|
|
1482
|
+
Before making updates:
|
|
1252
1483
|
|
|
1253
|
-
|
|
1484
|
+
1. Use the [get component content](/data/reference/pages-and-components/components/get-content) endpoint to identify available content nodes and their types
|
|
1485
|
+
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
|
|
1254
1486
|
|
|
1255
|
-
|
|
1487
|
+
<Note>
|
|
1488
|
+
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.
|
|
1489
|
+
</Note>
|
|
1490
|
+
|
|
1491
|
+
Required scope | `components:write`
|
|
1256
1492
|
|
|
1257
1493
|
</dd>
|
|
1258
1494
|
</dl>
|
|
@@ -1268,10 +1504,31 @@ Required scope | `custom_code:write`
|
|
|
1268
1504
|
<dd>
|
|
1269
1505
|
|
|
1270
1506
|
```typescript
|
|
1271
|
-
await client.
|
|
1272
|
-
|
|
1273
|
-
|
|
1274
|
-
|
|
1507
|
+
await client.components.updateContent("580e63e98c9a982ac9b8b741", "8505ba55-ef72-629e-f85c-33e4b703d48b", {
|
|
1508
|
+
localeId: "65427cf400e02b306eaa04a0",
|
|
1509
|
+
nodes: [
|
|
1510
|
+
{
|
|
1511
|
+
nodeId: "a245c12d-995b-55ee-5ec7-aa36a6cad623",
|
|
1512
|
+
text: "<h1>The Hitchhiker's Guide to the Galaxy</h1>",
|
|
1513
|
+
},
|
|
1514
|
+
{
|
|
1515
|
+
nodeId: "a245c12d-995b-55ee-5ec7-aa36a6cad627",
|
|
1516
|
+
text: "<div><h3>Don't Panic!</h3><p>Always know where your towel is.</p></div>",
|
|
1517
|
+
},
|
|
1518
|
+
{
|
|
1519
|
+
nodeId: "a245c12d-995b-55ee-5ec7-aa36a6cad629",
|
|
1520
|
+
propertyOverrides: [
|
|
1521
|
+
{
|
|
1522
|
+
propertyId: "7dd14c08-2e96-8d3d-2b19-b5c03642a0f0",
|
|
1523
|
+
text: "<div><h1>Time is an <em>illusion</em></h1></div>",
|
|
1524
|
+
},
|
|
1525
|
+
{
|
|
1526
|
+
propertyId: "7dd14c08-2e96-8d3d-2b19-b5c03642a0f1",
|
|
1527
|
+
text: "Life, the Universe and Everything",
|
|
1528
|
+
},
|
|
1529
|
+
],
|
|
1530
|
+
},
|
|
1531
|
+
],
|
|
1275
1532
|
});
|
|
1276
1533
|
```
|
|
1277
1534
|
|
|
@@ -1296,7 +1553,7 @@ await client.scripts.registerInline("580e63e98c9a982ac9b8b741", {
|
|
|
1296
1553
|
<dl>
|
|
1297
1554
|
<dd>
|
|
1298
1555
|
|
|
1299
|
-
**
|
|
1556
|
+
**componentId:** `string` — Unique identifier for a Component
|
|
1300
1557
|
|
|
1301
1558
|
</dd>
|
|
1302
1559
|
</dl>
|
|
@@ -1304,7 +1561,15 @@ await client.scripts.registerInline("580e63e98c9a982ac9b8b741", {
|
|
|
1304
1561
|
<dl>
|
|
1305
1562
|
<dd>
|
|
1306
1563
|
|
|
1307
|
-
**
|
|
1564
|
+
**request:** `Webflow.ComponentDomWrite`
|
|
1565
|
+
|
|
1566
|
+
</dd>
|
|
1567
|
+
</dl>
|
|
1568
|
+
|
|
1569
|
+
<dl>
|
|
1570
|
+
<dd>
|
|
1571
|
+
|
|
1572
|
+
**requestOptions:** `Components.RequestOptions`
|
|
1308
1573
|
|
|
1309
1574
|
</dd>
|
|
1310
1575
|
</dl>
|
|
@@ -1315,9 +1580,7 @@ await client.scripts.registerInline("580e63e98c9a982ac9b8b741", {
|
|
|
1315
1580
|
</dl>
|
|
1316
1581
|
</details>
|
|
1317
1582
|
|
|
1318
|
-
|
|
1319
|
-
|
|
1320
|
-
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">list</a>(siteId) -> Webflow.Assets</code></summary>
|
|
1583
|
+
<details><summary><code>client.components.<a href="/src/api/resources/components/client/Client.ts">getProperties</a>(siteId, componentId, { ...params }) -> Webflow.ComponentProperties</code></summary>
|
|
1321
1584
|
<dl>
|
|
1322
1585
|
<dd>
|
|
1323
1586
|
|
|
@@ -1329,9 +1592,11 @@ await client.scripts.registerInline("580e63e98c9a982ac9b8b741", {
|
|
|
1329
1592
|
<dl>
|
|
1330
1593
|
<dd>
|
|
1331
1594
|
|
|
1332
|
-
|
|
1595
|
+
Get the property default values of a component definition.
|
|
1333
1596
|
|
|
1334
|
-
|
|
1597
|
+
<Note>If you do not provide a Locale ID in your request, the response will return any properties that can be localized from the Primary locale.</Note>
|
|
1598
|
+
|
|
1599
|
+
Required scope | `components:read`
|
|
1335
1600
|
|
|
1336
1601
|
</dd>
|
|
1337
1602
|
</dl>
|
|
@@ -1347,7 +1612,9 @@ Required scope | `assets:read`
|
|
|
1347
1612
|
<dd>
|
|
1348
1613
|
|
|
1349
1614
|
```typescript
|
|
1350
|
-
await client.
|
|
1615
|
+
await client.components.getProperties("580e63e98c9a982ac9b8b741", "8505ba55-ef72-629e-f85c-33e4b703d48b", {
|
|
1616
|
+
localeId: "65427cf400e02b306eaa04a0",
|
|
1617
|
+
});
|
|
1351
1618
|
```
|
|
1352
1619
|
|
|
1353
1620
|
</dd>
|
|
@@ -1371,7 +1638,23 @@ await client.assets.list("580e63e98c9a982ac9b8b741");
|
|
|
1371
1638
|
<dl>
|
|
1372
1639
|
<dd>
|
|
1373
1640
|
|
|
1374
|
-
**
|
|
1641
|
+
**componentId:** `string` — Unique identifier for a Component
|
|
1642
|
+
|
|
1643
|
+
</dd>
|
|
1644
|
+
</dl>
|
|
1645
|
+
|
|
1646
|
+
<dl>
|
|
1647
|
+
<dd>
|
|
1648
|
+
|
|
1649
|
+
**request:** `Webflow.ComponentsGetPropertiesRequest`
|
|
1650
|
+
|
|
1651
|
+
</dd>
|
|
1652
|
+
</dl>
|
|
1653
|
+
|
|
1654
|
+
<dl>
|
|
1655
|
+
<dd>
|
|
1656
|
+
|
|
1657
|
+
**requestOptions:** `Components.RequestOptions`
|
|
1375
1658
|
|
|
1376
1659
|
</dd>
|
|
1377
1660
|
</dl>
|
|
@@ -1382,7 +1665,7 @@ await client.assets.list("580e63e98c9a982ac9b8b741");
|
|
|
1382
1665
|
</dl>
|
|
1383
1666
|
</details>
|
|
1384
1667
|
|
|
1385
|
-
<details><summary><code>client.
|
|
1668
|
+
<details><summary><code>client.components.<a href="/src/api/resources/components/client/Client.ts">updateProperties</a>(siteId, componentId, { ...params }) -> Webflow.ComponentsUpdatePropertiesResponse</code></summary>
|
|
1386
1669
|
<dl>
|
|
1387
1670
|
<dd>
|
|
1388
1671
|
|
|
@@ -1394,13 +1677,15 @@ await client.assets.list("580e63e98c9a982ac9b8b741");
|
|
|
1394
1677
|
<dl>
|
|
1395
1678
|
<dd>
|
|
1396
1679
|
|
|
1397
|
-
|
|
1680
|
+
Update the property default values of a component definition in a specificed locale.
|
|
1398
1681
|
|
|
1399
|
-
|
|
1400
|
-
You can use these two properties to [upload the file to Amazon s3 by making a POST](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOST.html)
|
|
1401
|
-
request to the `uploadUrl` with the `uploadDetails` object as your header information in the request.
|
|
1682
|
+
Before making updates:
|
|
1402
1683
|
|
|
1403
|
-
|
|
1684
|
+
1. Use the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint to identify available properties
|
|
1685
|
+
|
|
1686
|
+
<Note>The request requires a secondary locale ID. If a locale is missing, the request will not be processed and will result in an error.</Note>
|
|
1687
|
+
|
|
1688
|
+
Required scope | `components:write`
|
|
1404
1689
|
|
|
1405
1690
|
</dd>
|
|
1406
1691
|
</dl>
|
|
@@ -1416,9 +1701,18 @@ Required scope | `assets:write`
|
|
|
1416
1701
|
<dd>
|
|
1417
1702
|
|
|
1418
1703
|
```typescript
|
|
1419
|
-
await client.
|
|
1420
|
-
|
|
1421
|
-
|
|
1704
|
+
await client.components.updateProperties("580e63e98c9a982ac9b8b741", "8505ba55-ef72-629e-f85c-33e4b703d48b", {
|
|
1705
|
+
localeId: "65427cf400e02b306eaa04a0",
|
|
1706
|
+
properties: [
|
|
1707
|
+
{
|
|
1708
|
+
propertyId: "a245c12d-995b-55ee-5ec7-aa36a6cad623",
|
|
1709
|
+
text: "The Hitchhiker\u2019s Guide to the Galaxy",
|
|
1710
|
+
},
|
|
1711
|
+
{
|
|
1712
|
+
propertyId: "a245c12d-995b-55ee-5ec7-aa36a6cad627",
|
|
1713
|
+
text: "<div><h3>Dont Panic!</h3><p>Always know where your towel is.</p></div>",
|
|
1714
|
+
},
|
|
1715
|
+
],
|
|
1422
1716
|
});
|
|
1423
1717
|
```
|
|
1424
1718
|
|
|
@@ -1443,7 +1737,7 @@ await client.assets.create("580e63e98c9a982ac9b8b741", {
|
|
|
1443
1737
|
<dl>
|
|
1444
1738
|
<dd>
|
|
1445
1739
|
|
|
1446
|
-
**
|
|
1740
|
+
**componentId:** `string` — Unique identifier for a Component
|
|
1447
1741
|
|
|
1448
1742
|
</dd>
|
|
1449
1743
|
</dl>
|
|
@@ -1451,7 +1745,15 @@ await client.assets.create("580e63e98c9a982ac9b8b741", {
|
|
|
1451
1745
|
<dl>
|
|
1452
1746
|
<dd>
|
|
1453
1747
|
|
|
1454
|
-
**
|
|
1748
|
+
**request:** `Webflow.ComponentPropertiesWrite`
|
|
1749
|
+
|
|
1750
|
+
</dd>
|
|
1751
|
+
</dl>
|
|
1752
|
+
|
|
1753
|
+
<dl>
|
|
1754
|
+
<dd>
|
|
1755
|
+
|
|
1756
|
+
**requestOptions:** `Components.RequestOptions`
|
|
1455
1757
|
|
|
1456
1758
|
</dd>
|
|
1457
1759
|
</dl>
|
|
@@ -1462,7 +1764,9 @@ await client.assets.create("580e63e98c9a982ac9b8b741", {
|
|
|
1462
1764
|
</dl>
|
|
1463
1765
|
</details>
|
|
1464
1766
|
|
|
1465
|
-
|
|
1767
|
+
## Scripts
|
|
1768
|
+
|
|
1769
|
+
<details><summary><code>client.scripts.<a href="/src/api/resources/scripts/client/Client.ts">list</a>(siteId) -> Webflow.RegisteredScriptList</code></summary>
|
|
1466
1770
|
<dl>
|
|
1467
1771
|
<dd>
|
|
1468
1772
|
|
|
@@ -1474,9 +1778,16 @@ await client.assets.create("580e63e98c9a982ac9b8b741", {
|
|
|
1474
1778
|
<dl>
|
|
1475
1779
|
<dd>
|
|
1476
1780
|
|
|
1477
|
-
|
|
1781
|
+
List of scripts registered to a Site.
|
|
1478
1782
|
|
|
1479
|
-
|
|
1783
|
+
In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered
|
|
1784
|
+
to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate
|
|
1785
|
+
`custom_code` endpoints.
|
|
1786
|
+
Additionally, Scripts can be remotely hosted, or registered as inline snippets.
|
|
1787
|
+
|
|
1788
|
+
<Note>Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients).</Note>
|
|
1789
|
+
|
|
1790
|
+
Required scope | `custom_code:read`
|
|
1480
1791
|
|
|
1481
1792
|
</dd>
|
|
1482
1793
|
</dl>
|
|
@@ -1492,7 +1803,7 @@ Required scope | `assets:read`
|
|
|
1492
1803
|
<dd>
|
|
1493
1804
|
|
|
1494
1805
|
```typescript
|
|
1495
|
-
await client.
|
|
1806
|
+
await client.scripts.list("580e63e98c9a982ac9b8b741");
|
|
1496
1807
|
```
|
|
1497
1808
|
|
|
1498
1809
|
</dd>
|
|
@@ -1508,7 +1819,7 @@ await client.assets.get("580e63fc8c9a982ac9b8b745");
|
|
|
1508
1819
|
<dl>
|
|
1509
1820
|
<dd>
|
|
1510
1821
|
|
|
1511
|
-
**
|
|
1822
|
+
**siteId:** `string` — Unique identifier for a Site
|
|
1512
1823
|
|
|
1513
1824
|
</dd>
|
|
1514
1825
|
</dl>
|
|
@@ -1516,7 +1827,7 @@ await client.assets.get("580e63fc8c9a982ac9b8b745");
|
|
|
1516
1827
|
<dl>
|
|
1517
1828
|
<dd>
|
|
1518
1829
|
|
|
1519
|
-
**requestOptions:** `
|
|
1830
|
+
**requestOptions:** `Scripts.RequestOptions`
|
|
1520
1831
|
|
|
1521
1832
|
</dd>
|
|
1522
1833
|
</dl>
|
|
@@ -1527,7 +1838,7 @@ await client.assets.get("580e63fc8c9a982ac9b8b745");
|
|
|
1527
1838
|
</dl>
|
|
1528
1839
|
</details>
|
|
1529
1840
|
|
|
1530
|
-
<details><summary><code>client.
|
|
1841
|
+
<details><summary><code>client.scripts.<a href="/src/api/resources/scripts/client/Client.ts">registerHosted</a>(siteId, { ...params }) -> Webflow.CustomCodeHostedResponse</code></summary>
|
|
1531
1842
|
<dl>
|
|
1532
1843
|
<dd>
|
|
1533
1844
|
|
|
@@ -1539,9 +1850,16 @@ await client.assets.get("580e63fc8c9a982ac9b8b745");
|
|
|
1539
1850
|
<dl>
|
|
1540
1851
|
<dd>
|
|
1541
1852
|
|
|
1542
|
-
|
|
1853
|
+
Add a script to a Site's Custom Code registry.
|
|
1543
1854
|
|
|
1544
|
-
|
|
1855
|
+
In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered
|
|
1856
|
+
to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate
|
|
1857
|
+
`custom_code` endpoints.
|
|
1858
|
+
Additionally, Scripts can be remotely hosted, or registered as inline snippets.
|
|
1859
|
+
|
|
1860
|
+
<Note>Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients).</Note>
|
|
1861
|
+
|
|
1862
|
+
Required scope | `custom_code:write`
|
|
1545
1863
|
|
|
1546
1864
|
</dd>
|
|
1547
1865
|
</dl>
|
|
@@ -1557,7 +1875,12 @@ Required Scope: `assets: write`
|
|
|
1557
1875
|
<dd>
|
|
1558
1876
|
|
|
1559
1877
|
```typescript
|
|
1560
|
-
await client.
|
|
1878
|
+
await client.scripts.registerHosted("580e63e98c9a982ac9b8b741", {
|
|
1879
|
+
hostedLocation: "hostedLocation",
|
|
1880
|
+
integrityHash: "integrityHash",
|
|
1881
|
+
version: "version",
|
|
1882
|
+
displayName: "displayName",
|
|
1883
|
+
});
|
|
1561
1884
|
```
|
|
1562
1885
|
|
|
1563
1886
|
</dd>
|
|
@@ -1573,7 +1896,7 @@ await client.assets.delete("580e63fc8c9a982ac9b8b745");
|
|
|
1573
1896
|
<dl>
|
|
1574
1897
|
<dd>
|
|
1575
1898
|
|
|
1576
|
-
**
|
|
1899
|
+
**siteId:** `string` — Unique identifier for a Site
|
|
1577
1900
|
|
|
1578
1901
|
</dd>
|
|
1579
1902
|
</dl>
|
|
@@ -1581,7 +1904,15 @@ await client.assets.delete("580e63fc8c9a982ac9b8b745");
|
|
|
1581
1904
|
<dl>
|
|
1582
1905
|
<dd>
|
|
1583
1906
|
|
|
1584
|
-
**
|
|
1907
|
+
**request:** `Webflow.CustomCodeHostedRequest`
|
|
1908
|
+
|
|
1909
|
+
</dd>
|
|
1910
|
+
</dl>
|
|
1911
|
+
|
|
1912
|
+
<dl>
|
|
1913
|
+
<dd>
|
|
1914
|
+
|
|
1915
|
+
**requestOptions:** `Scripts.RequestOptions`
|
|
1585
1916
|
|
|
1586
1917
|
</dd>
|
|
1587
1918
|
</dl>
|
|
@@ -1592,7 +1923,7 @@ await client.assets.delete("580e63fc8c9a982ac9b8b745");
|
|
|
1592
1923
|
</dl>
|
|
1593
1924
|
</details>
|
|
1594
1925
|
|
|
1595
|
-
<details><summary><code>client.
|
|
1926
|
+
<details><summary><code>client.scripts.<a href="/src/api/resources/scripts/client/Client.ts">registerInline</a>(siteId, { ...params }) -> Webflow.CustomCodeInlineResponse</code></summary>
|
|
1596
1927
|
<dl>
|
|
1597
1928
|
<dd>
|
|
1598
1929
|
|
|
@@ -1604,9 +1935,15 @@ await client.assets.delete("580e63fc8c9a982ac9b8b745");
|
|
|
1604
1935
|
<dl>
|
|
1605
1936
|
<dd>
|
|
1606
1937
|
|
|
1607
|
-
|
|
1938
|
+
Add a script to a Site's Custom Code registry. Inline scripts can be between 1 and 2000 characters.
|
|
1608
1939
|
|
|
1609
|
-
|
|
1940
|
+
In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered
|
|
1941
|
+
to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate
|
|
1942
|
+
`custom_code` endpoints.
|
|
1943
|
+
|
|
1944
|
+
<Note>Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients).</Note>
|
|
1945
|
+
|
|
1946
|
+
Required scope | `custom_code:write`
|
|
1610
1947
|
|
|
1611
1948
|
</dd>
|
|
1612
1949
|
</dl>
|
|
@@ -1622,7 +1959,11 @@ Required scope | `assets:write`
|
|
|
1622
1959
|
<dd>
|
|
1623
1960
|
|
|
1624
1961
|
```typescript
|
|
1625
|
-
await client.
|
|
1962
|
+
await client.scripts.registerInline("580e63e98c9a982ac9b8b741", {
|
|
1963
|
+
sourceCode: "alert('hello world');",
|
|
1964
|
+
version: "0.0.1",
|
|
1965
|
+
displayName: "Alert",
|
|
1966
|
+
});
|
|
1626
1967
|
```
|
|
1627
1968
|
|
|
1628
1969
|
</dd>
|
|
@@ -1638,7 +1979,7 @@ await client.assets.update("580e63fc8c9a982ac9b8b745");
|
|
|
1638
1979
|
<dl>
|
|
1639
1980
|
<dd>
|
|
1640
1981
|
|
|
1641
|
-
**
|
|
1982
|
+
**siteId:** `string` — Unique identifier for a Site
|
|
1642
1983
|
|
|
1643
1984
|
</dd>
|
|
1644
1985
|
</dl>
|
|
@@ -1646,7 +1987,7 @@ await client.assets.update("580e63fc8c9a982ac9b8b745");
|
|
|
1646
1987
|
<dl>
|
|
1647
1988
|
<dd>
|
|
1648
1989
|
|
|
1649
|
-
**request:** `Webflow.
|
|
1990
|
+
**request:** `Webflow.CustomCodeInlineRequest`
|
|
1650
1991
|
|
|
1651
1992
|
</dd>
|
|
1652
1993
|
</dl>
|
|
@@ -1654,7 +1995,7 @@ await client.assets.update("580e63fc8c9a982ac9b8b745");
|
|
|
1654
1995
|
<dl>
|
|
1655
1996
|
<dd>
|
|
1656
1997
|
|
|
1657
|
-
**requestOptions:** `
|
|
1998
|
+
**requestOptions:** `Scripts.RequestOptions`
|
|
1658
1999
|
|
|
1659
2000
|
</dd>
|
|
1660
2001
|
</dl>
|
|
@@ -1665,7 +2006,9 @@ await client.assets.update("580e63fc8c9a982ac9b8b745");
|
|
|
1665
2006
|
</dl>
|
|
1666
2007
|
</details>
|
|
1667
2008
|
|
|
1668
|
-
|
|
2009
|
+
## Assets
|
|
2010
|
+
|
|
2011
|
+
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">list</a>(siteId) -> Webflow.Assets</code></summary>
|
|
1669
2012
|
<dl>
|
|
1670
2013
|
<dd>
|
|
1671
2014
|
|
|
@@ -1677,7 +2020,7 @@ await client.assets.update("580e63fc8c9a982ac9b8b745");
|
|
|
1677
2020
|
<dl>
|
|
1678
2021
|
<dd>
|
|
1679
2022
|
|
|
1680
|
-
List
|
|
2023
|
+
List assets for a given site
|
|
1681
2024
|
|
|
1682
2025
|
Required scope | `assets:read`
|
|
1683
2026
|
|
|
@@ -1695,7 +2038,7 @@ Required scope | `assets:read`
|
|
|
1695
2038
|
<dd>
|
|
1696
2039
|
|
|
1697
2040
|
```typescript
|
|
1698
|
-
await client.assets.
|
|
2041
|
+
await client.assets.list("580e63e98c9a982ac9b8b741");
|
|
1699
2042
|
```
|
|
1700
2043
|
|
|
1701
2044
|
</dd>
|
|
@@ -1730,7 +2073,7 @@ await client.assets.listFolders("580e63e98c9a982ac9b8b741");
|
|
|
1730
2073
|
</dl>
|
|
1731
2074
|
</details>
|
|
1732
2075
|
|
|
1733
|
-
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">
|
|
2076
|
+
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">create</a>(siteId, { ...params }) -> Webflow.AssetUpload</code></summary>
|
|
1734
2077
|
<dl>
|
|
1735
2078
|
<dd>
|
|
1736
2079
|
|
|
@@ -1742,7 +2085,11 @@ await client.assets.listFolders("580e63e98c9a982ac9b8b741");
|
|
|
1742
2085
|
<dl>
|
|
1743
2086
|
<dd>
|
|
1744
2087
|
|
|
1745
|
-
Create
|
|
2088
|
+
Create a new asset entry.
|
|
2089
|
+
|
|
2090
|
+
This endpoint generates a response with the following information: `uploadUrl` and `uploadDetails`.
|
|
2091
|
+
You can use these two properties to [upload the file to Amazon s3 by making a POST](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOST.html)
|
|
2092
|
+
request to the `uploadUrl` with the `uploadDetails` object as your header information in the request.
|
|
1746
2093
|
|
|
1747
2094
|
Required scope | `assets:write`
|
|
1748
2095
|
|
|
@@ -1760,8 +2107,9 @@ Required scope | `assets:write`
|
|
|
1760
2107
|
<dd>
|
|
1761
2108
|
|
|
1762
2109
|
```typescript
|
|
1763
|
-
await client.assets.
|
|
1764
|
-
|
|
2110
|
+
await client.assets.create("580e63e98c9a982ac9b8b741", {
|
|
2111
|
+
fileName: "file.png",
|
|
2112
|
+
fileHash: "3c7d87c9575702bc3b1e991f4d3c638e",
|
|
1765
2113
|
});
|
|
1766
2114
|
```
|
|
1767
2115
|
|
|
@@ -1786,7 +2134,7 @@ await client.assets.createFolder("580e63e98c9a982ac9b8b741", {
|
|
|
1786
2134
|
<dl>
|
|
1787
2135
|
<dd>
|
|
1788
2136
|
|
|
1789
|
-
**request:** `Webflow.
|
|
2137
|
+
**request:** `Webflow.AssetsCreateRequest`
|
|
1790
2138
|
|
|
1791
2139
|
</dd>
|
|
1792
2140
|
</dl>
|
|
@@ -1805,7 +2153,7 @@ await client.assets.createFolder("580e63e98c9a982ac9b8b741", {
|
|
|
1805
2153
|
</dl>
|
|
1806
2154
|
</details>
|
|
1807
2155
|
|
|
1808
|
-
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">
|
|
2156
|
+
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">get</a>(assetId) -> Webflow.Asset</code></summary>
|
|
1809
2157
|
<dl>
|
|
1810
2158
|
<dd>
|
|
1811
2159
|
|
|
@@ -1817,7 +2165,7 @@ await client.assets.createFolder("580e63e98c9a982ac9b8b741", {
|
|
|
1817
2165
|
<dl>
|
|
1818
2166
|
<dd>
|
|
1819
2167
|
|
|
1820
|
-
Get
|
|
2168
|
+
Get an Asset
|
|
1821
2169
|
|
|
1822
2170
|
Required scope | `assets:read`
|
|
1823
2171
|
|
|
@@ -1835,7 +2183,7 @@ Required scope | `assets:read`
|
|
|
1835
2183
|
<dd>
|
|
1836
2184
|
|
|
1837
2185
|
```typescript
|
|
1838
|
-
await client.assets.
|
|
2186
|
+
await client.assets.get("580e63fc8c9a982ac9b8b745");
|
|
1839
2187
|
```
|
|
1840
2188
|
|
|
1841
2189
|
</dd>
|
|
@@ -1851,7 +2199,7 @@ await client.assets.getFolder("6390c49774a71f0e3c1a08ee");
|
|
|
1851
2199
|
<dl>
|
|
1852
2200
|
<dd>
|
|
1853
2201
|
|
|
1854
|
-
**
|
|
2202
|
+
**assetId:** `string` — Unique identifier for an Asset on a site
|
|
1855
2203
|
|
|
1856
2204
|
</dd>
|
|
1857
2205
|
</dl>
|
|
@@ -1870,9 +2218,7 @@ await client.assets.getFolder("6390c49774a71f0e3c1a08ee");
|
|
|
1870
2218
|
</dl>
|
|
1871
2219
|
</details>
|
|
1872
2220
|
|
|
1873
|
-
|
|
1874
|
-
|
|
1875
|
-
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">list</a>(siteId) -> Webflow.WebhookList</code></summary>
|
|
2221
|
+
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">delete</a>(assetId) -> void</code></summary>
|
|
1876
2222
|
<dl>
|
|
1877
2223
|
<dd>
|
|
1878
2224
|
|
|
@@ -1884,9 +2230,9 @@ await client.assets.getFolder("6390c49774a71f0e3c1a08ee");
|
|
|
1884
2230
|
<dl>
|
|
1885
2231
|
<dd>
|
|
1886
2232
|
|
|
1887
|
-
|
|
2233
|
+
Delete an Asset
|
|
1888
2234
|
|
|
1889
|
-
Required
|
|
2235
|
+
Required Scope: `assets: write`
|
|
1890
2236
|
|
|
1891
2237
|
</dd>
|
|
1892
2238
|
</dl>
|
|
@@ -1902,7 +2248,7 @@ Required scope | `sites:read`
|
|
|
1902
2248
|
<dd>
|
|
1903
2249
|
|
|
1904
2250
|
```typescript
|
|
1905
|
-
await client.
|
|
2251
|
+
await client.assets.delete("580e63fc8c9a982ac9b8b745");
|
|
1906
2252
|
```
|
|
1907
2253
|
|
|
1908
2254
|
</dd>
|
|
@@ -1918,7 +2264,7 @@ await client.webhooks.list("580e63e98c9a982ac9b8b741");
|
|
|
1918
2264
|
<dl>
|
|
1919
2265
|
<dd>
|
|
1920
2266
|
|
|
1921
|
-
**
|
|
2267
|
+
**assetId:** `string` — Unique identifier for an Asset on a site
|
|
1922
2268
|
|
|
1923
2269
|
</dd>
|
|
1924
2270
|
</dl>
|
|
@@ -1926,7 +2272,7 @@ await client.webhooks.list("580e63e98c9a982ac9b8b741");
|
|
|
1926
2272
|
<dl>
|
|
1927
2273
|
<dd>
|
|
1928
2274
|
|
|
1929
|
-
**requestOptions:** `
|
|
2275
|
+
**requestOptions:** `Assets.RequestOptions`
|
|
1930
2276
|
|
|
1931
2277
|
</dd>
|
|
1932
2278
|
</dl>
|
|
@@ -1937,7 +2283,7 @@ await client.webhooks.list("580e63e98c9a982ac9b8b741");
|
|
|
1937
2283
|
</dl>
|
|
1938
2284
|
</details>
|
|
1939
2285
|
|
|
1940
|
-
<details><summary><code>client.
|
|
2286
|
+
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">update</a>(assetId, { ...params }) -> Webflow.Asset</code></summary>
|
|
1941
2287
|
<dl>
|
|
1942
2288
|
<dd>
|
|
1943
2289
|
|
|
@@ -1949,12 +2295,10 @@ await client.webhooks.list("580e63e98c9a982ac9b8b741");
|
|
|
1949
2295
|
<dl>
|
|
1950
2296
|
<dd>
|
|
1951
2297
|
|
|
1952
|
-
|
|
2298
|
+
Update an Asset
|
|
1953
2299
|
|
|
1954
|
-
|
|
2300
|
+
Required scope | `assets:write`
|
|
1955
2301
|
|
|
1956
|
-
<blockquote class="callout callout_info" theme="📘">Access to this endpoint requires a bearer token from a <a href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data Client App</a>.</blockquote>
|
|
1957
|
-
Required scope | `sites:write`
|
|
1958
2302
|
</dd>
|
|
1959
2303
|
</dl>
|
|
1960
2304
|
</dd>
|
|
@@ -1969,15 +2313,7 @@ Required scope | `sites:write`
|
|
|
1969
2313
|
<dd>
|
|
1970
2314
|
|
|
1971
2315
|
```typescript
|
|
1972
|
-
await client.
|
|
1973
|
-
id: "582266e0cd48de0f0e3c6d8b",
|
|
1974
|
-
triggerType: "form_submission",
|
|
1975
|
-
url: "https://webhook.site/7f7f7f7f-7f7f-7f7f-7f7f-7f7f7f7f7f7f",
|
|
1976
|
-
workspaceId: "4f4e46fd476ea8c507000001",
|
|
1977
|
-
siteId: "562ac0395358780a1f5e6fbd",
|
|
1978
|
-
lastTriggered: "2023-02-08T23:59:28Z",
|
|
1979
|
-
createdOn: "2022-11-08T23:59:28Z",
|
|
1980
|
-
});
|
|
2316
|
+
await client.assets.update("580e63fc8c9a982ac9b8b745");
|
|
1981
2317
|
```
|
|
1982
2318
|
|
|
1983
2319
|
</dd>
|
|
@@ -1993,7 +2329,7 @@ await client.webhooks.create("580e63e98c9a982ac9b8b741", {
|
|
|
1993
2329
|
<dl>
|
|
1994
2330
|
<dd>
|
|
1995
2331
|
|
|
1996
|
-
**
|
|
2332
|
+
**assetId:** `string` — Unique identifier for an Asset on a site
|
|
1997
2333
|
|
|
1998
2334
|
</dd>
|
|
1999
2335
|
</dl>
|
|
@@ -2001,7 +2337,7 @@ await client.webhooks.create("580e63e98c9a982ac9b8b741", {
|
|
|
2001
2337
|
<dl>
|
|
2002
2338
|
<dd>
|
|
2003
2339
|
|
|
2004
|
-
**request:** `Webflow.
|
|
2340
|
+
**request:** `Webflow.AssetsUpdateRequest`
|
|
2005
2341
|
|
|
2006
2342
|
</dd>
|
|
2007
2343
|
</dl>
|
|
@@ -2009,7 +2345,7 @@ await client.webhooks.create("580e63e98c9a982ac9b8b741", {
|
|
|
2009
2345
|
<dl>
|
|
2010
2346
|
<dd>
|
|
2011
2347
|
|
|
2012
|
-
**requestOptions:** `
|
|
2348
|
+
**requestOptions:** `Assets.RequestOptions`
|
|
2013
2349
|
|
|
2014
2350
|
</dd>
|
|
2015
2351
|
</dl>
|
|
@@ -2020,7 +2356,7 @@ await client.webhooks.create("580e63e98c9a982ac9b8b741", {
|
|
|
2020
2356
|
</dl>
|
|
2021
2357
|
</details>
|
|
2022
2358
|
|
|
2023
|
-
<details><summary><code>client.
|
|
2359
|
+
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">listFolders</a>(siteId) -> Webflow.AssetFolderList</code></summary>
|
|
2024
2360
|
<dl>
|
|
2025
2361
|
<dd>
|
|
2026
2362
|
|
|
@@ -2032,9 +2368,9 @@ await client.webhooks.create("580e63e98c9a982ac9b8b741", {
|
|
|
2032
2368
|
<dl>
|
|
2033
2369
|
<dd>
|
|
2034
2370
|
|
|
2035
|
-
|
|
2371
|
+
List Asset Folders within a given site
|
|
2036
2372
|
|
|
2037
|
-
Required scope
|
|
2373
|
+
Required scope | `assets:read`
|
|
2038
2374
|
|
|
2039
2375
|
</dd>
|
|
2040
2376
|
</dl>
|
|
@@ -2050,7 +2386,7 @@ Required scope: `sites:read`
|
|
|
2050
2386
|
<dd>
|
|
2051
2387
|
|
|
2052
2388
|
```typescript
|
|
2053
|
-
await client.
|
|
2389
|
+
await client.assets.listFolders("580e63e98c9a982ac9b8b741");
|
|
2054
2390
|
```
|
|
2055
2391
|
|
|
2056
2392
|
</dd>
|
|
@@ -2066,7 +2402,7 @@ await client.webhooks.get("580e64008c9a982ac9b8b754");
|
|
|
2066
2402
|
<dl>
|
|
2067
2403
|
<dd>
|
|
2068
2404
|
|
|
2069
|
-
**
|
|
2405
|
+
**siteId:** `string` — Unique identifier for a Site
|
|
2070
2406
|
|
|
2071
2407
|
</dd>
|
|
2072
2408
|
</dl>
|
|
@@ -2074,7 +2410,7 @@ await client.webhooks.get("580e64008c9a982ac9b8b754");
|
|
|
2074
2410
|
<dl>
|
|
2075
2411
|
<dd>
|
|
2076
2412
|
|
|
2077
|
-
**requestOptions:** `
|
|
2413
|
+
**requestOptions:** `Assets.RequestOptions`
|
|
2078
2414
|
|
|
2079
2415
|
</dd>
|
|
2080
2416
|
</dl>
|
|
@@ -2085,7 +2421,7 @@ await client.webhooks.get("580e64008c9a982ac9b8b754");
|
|
|
2085
2421
|
</dl>
|
|
2086
2422
|
</details>
|
|
2087
2423
|
|
|
2088
|
-
<details><summary><code>client.
|
|
2424
|
+
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">createFolder</a>(siteId, { ...params }) -> Webflow.AssetFolder</code></summary>
|
|
2089
2425
|
<dl>
|
|
2090
2426
|
<dd>
|
|
2091
2427
|
|
|
@@ -2097,9 +2433,9 @@ await client.webhooks.get("580e64008c9a982ac9b8b754");
|
|
|
2097
2433
|
<dl>
|
|
2098
2434
|
<dd>
|
|
2099
2435
|
|
|
2100
|
-
|
|
2436
|
+
Create an Asset Folder within a given site
|
|
2101
2437
|
|
|
2102
|
-
Required scope
|
|
2438
|
+
Required scope | `assets:write`
|
|
2103
2439
|
|
|
2104
2440
|
</dd>
|
|
2105
2441
|
</dl>
|
|
@@ -2115,7 +2451,9 @@ Required scope: `sites:read`
|
|
|
2115
2451
|
<dd>
|
|
2116
2452
|
|
|
2117
2453
|
```typescript
|
|
2118
|
-
await client.
|
|
2454
|
+
await client.assets.createFolder("580e63e98c9a982ac9b8b741", {
|
|
2455
|
+
displayName: "my asset folder",
|
|
2456
|
+
});
|
|
2119
2457
|
```
|
|
2120
2458
|
|
|
2121
2459
|
</dd>
|
|
@@ -2131,7 +2469,7 @@ await client.webhooks.delete("580e64008c9a982ac9b8b754");
|
|
|
2131
2469
|
<dl>
|
|
2132
2470
|
<dd>
|
|
2133
2471
|
|
|
2134
|
-
**
|
|
2472
|
+
**siteId:** `string` — Unique identifier for a Site
|
|
2135
2473
|
|
|
2136
2474
|
</dd>
|
|
2137
2475
|
</dl>
|
|
@@ -2139,7 +2477,15 @@ await client.webhooks.delete("580e64008c9a982ac9b8b754");
|
|
|
2139
2477
|
<dl>
|
|
2140
2478
|
<dd>
|
|
2141
2479
|
|
|
2142
|
-
**
|
|
2480
|
+
**request:** `Webflow.AssetsCreateFolderRequest`
|
|
2481
|
+
|
|
2482
|
+
</dd>
|
|
2483
|
+
</dl>
|
|
2484
|
+
|
|
2485
|
+
<dl>
|
|
2486
|
+
<dd>
|
|
2487
|
+
|
|
2488
|
+
**requestOptions:** `Assets.RequestOptions`
|
|
2143
2489
|
|
|
2144
2490
|
</dd>
|
|
2145
2491
|
</dl>
|
|
@@ -2150,9 +2496,7 @@ await client.webhooks.delete("580e64008c9a982ac9b8b754");
|
|
|
2150
2496
|
</dl>
|
|
2151
2497
|
</details>
|
|
2152
2498
|
|
|
2153
|
-
|
|
2154
|
-
|
|
2155
|
-
<details><summary><code>client.forms.<a href="/src/api/resources/forms/client/Client.ts">list</a>(siteId, { ...params }) -> Webflow.FormList</code></summary>
|
|
2499
|
+
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">getFolder</a>(assetFolderId) -> Webflow.AssetFolder</code></summary>
|
|
2156
2500
|
<dl>
|
|
2157
2501
|
<dd>
|
|
2158
2502
|
|
|
@@ -2164,9 +2508,9 @@ await client.webhooks.delete("580e64008c9a982ac9b8b754");
|
|
|
2164
2508
|
<dl>
|
|
2165
2509
|
<dd>
|
|
2166
2510
|
|
|
2167
|
-
|
|
2511
|
+
Get details about a specific Asset Folder
|
|
2168
2512
|
|
|
2169
|
-
Required scope | `
|
|
2513
|
+
Required scope | `assets:read`
|
|
2170
2514
|
|
|
2171
2515
|
</dd>
|
|
2172
2516
|
</dl>
|
|
@@ -2182,7 +2526,7 @@ Required scope | `forms:read`
|
|
|
2182
2526
|
<dd>
|
|
2183
2527
|
|
|
2184
2528
|
```typescript
|
|
2185
|
-
await client.
|
|
2529
|
+
await client.assets.getFolder("6390c49774a71f0e3c1a08ee");
|
|
2186
2530
|
```
|
|
2187
2531
|
|
|
2188
2532
|
</dd>
|
|
@@ -2198,15 +2542,7 @@ await client.forms.list("580e63e98c9a982ac9b8b741");
|
|
|
2198
2542
|
<dl>
|
|
2199
2543
|
<dd>
|
|
2200
2544
|
|
|
2201
|
-
**
|
|
2202
|
-
|
|
2203
|
-
</dd>
|
|
2204
|
-
</dl>
|
|
2205
|
-
|
|
2206
|
-
<dl>
|
|
2207
|
-
<dd>
|
|
2208
|
-
|
|
2209
|
-
**request:** `Webflow.FormsListRequest`
|
|
2545
|
+
**assetFolderId:** `string` — Unique identifier for an Asset Folder
|
|
2210
2546
|
|
|
2211
2547
|
</dd>
|
|
2212
2548
|
</dl>
|
|
@@ -2214,7 +2550,7 @@ await client.forms.list("580e63e98c9a982ac9b8b741");
|
|
|
2214
2550
|
<dl>
|
|
2215
2551
|
<dd>
|
|
2216
2552
|
|
|
2217
|
-
**requestOptions:** `
|
|
2553
|
+
**requestOptions:** `Assets.RequestOptions`
|
|
2218
2554
|
|
|
2219
2555
|
</dd>
|
|
2220
2556
|
</dl>
|
|
@@ -2225,7 +2561,9 @@ await client.forms.list("580e63e98c9a982ac9b8b741");
|
|
|
2225
2561
|
</dl>
|
|
2226
2562
|
</details>
|
|
2227
2563
|
|
|
2228
|
-
|
|
2564
|
+
## Webhooks
|
|
2565
|
+
|
|
2566
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">list</a>(siteId) -> Webflow.WebhookList</code></summary>
|
|
2229
2567
|
<dl>
|
|
2230
2568
|
<dd>
|
|
2231
2569
|
|
|
@@ -2237,9 +2575,9 @@ await client.forms.list("580e63e98c9a982ac9b8b741");
|
|
|
2237
2575
|
<dl>
|
|
2238
2576
|
<dd>
|
|
2239
2577
|
|
|
2240
|
-
|
|
2578
|
+
List all App-created Webhooks registered for a given site
|
|
2241
2579
|
|
|
2242
|
-
Required scope | `
|
|
2580
|
+
Required scope | `sites:read`
|
|
2243
2581
|
|
|
2244
2582
|
</dd>
|
|
2245
2583
|
</dl>
|
|
@@ -2255,7 +2593,7 @@ Required scope | `forms:read`
|
|
|
2255
2593
|
<dd>
|
|
2256
2594
|
|
|
2257
2595
|
```typescript
|
|
2258
|
-
await client.
|
|
2596
|
+
await client.webhooks.list("580e63e98c9a982ac9b8b741");
|
|
2259
2597
|
```
|
|
2260
2598
|
|
|
2261
2599
|
</dd>
|
|
@@ -2271,7 +2609,7 @@ await client.forms.get("580e63e98c9a982ac9b8b741");
|
|
|
2271
2609
|
<dl>
|
|
2272
2610
|
<dd>
|
|
2273
2611
|
|
|
2274
|
-
**
|
|
2612
|
+
**siteId:** `string` — Unique identifier for a Site
|
|
2275
2613
|
|
|
2276
2614
|
</dd>
|
|
2277
2615
|
</dl>
|
|
@@ -2279,7 +2617,7 @@ await client.forms.get("580e63e98c9a982ac9b8b741");
|
|
|
2279
2617
|
<dl>
|
|
2280
2618
|
<dd>
|
|
2281
2619
|
|
|
2282
|
-
**requestOptions:** `
|
|
2620
|
+
**requestOptions:** `Webhooks.RequestOptions`
|
|
2283
2621
|
|
|
2284
2622
|
</dd>
|
|
2285
2623
|
</dl>
|
|
@@ -2290,7 +2628,7 @@ await client.forms.get("580e63e98c9a982ac9b8b741");
|
|
|
2290
2628
|
</dl>
|
|
2291
2629
|
</details>
|
|
2292
2630
|
|
|
2293
|
-
<details><summary><code>client.
|
|
2631
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">create</a>(siteId, { ...params }) -> Webflow.Webhook</code></summary>
|
|
2294
2632
|
<dl>
|
|
2295
2633
|
<dd>
|
|
2296
2634
|
|
|
@@ -2302,9 +2640,12 @@ await client.forms.get("580e63e98c9a982ac9b8b741");
|
|
|
2302
2640
|
<dl>
|
|
2303
2641
|
<dd>
|
|
2304
2642
|
|
|
2305
|
-
|
|
2643
|
+
Create a new Webhook.
|
|
2306
2644
|
|
|
2307
|
-
|
|
2645
|
+
Limit of 75 registrations per `triggerType`, per site.
|
|
2646
|
+
|
|
2647
|
+
<Note>Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients).</Note>
|
|
2648
|
+
Required scope | `sites:write`
|
|
2308
2649
|
|
|
2309
2650
|
</dd>
|
|
2310
2651
|
</dl>
|
|
@@ -2320,7 +2661,15 @@ Required scope | `forms:read`
|
|
|
2320
2661
|
<dd>
|
|
2321
2662
|
|
|
2322
2663
|
```typescript
|
|
2323
|
-
await client.
|
|
2664
|
+
await client.webhooks.create("580e63e98c9a982ac9b8b741", {
|
|
2665
|
+
id: "582266e0cd48de0f0e3c6d8b",
|
|
2666
|
+
triggerType: "form_submission",
|
|
2667
|
+
url: "https://webhook.site/7f7f7f7f-7f7f-7f7f-7f7f-7f7f7f7f7f7f",
|
|
2668
|
+
workspaceId: "4f4e46fd476ea8c507000001",
|
|
2669
|
+
siteId: "562ac0395358780a1f5e6fbd",
|
|
2670
|
+
lastTriggered: "2023-02-08T23:59:28Z",
|
|
2671
|
+
createdOn: "2022-11-08T23:59:28Z",
|
|
2672
|
+
});
|
|
2324
2673
|
```
|
|
2325
2674
|
|
|
2326
2675
|
</dd>
|
|
@@ -2336,7 +2685,7 @@ await client.forms.listSubmissions("580e63e98c9a982ac9b8b741");
|
|
|
2336
2685
|
<dl>
|
|
2337
2686
|
<dd>
|
|
2338
2687
|
|
|
2339
|
-
**
|
|
2688
|
+
**siteId:** `string` — Unique identifier for a Site
|
|
2340
2689
|
|
|
2341
2690
|
</dd>
|
|
2342
2691
|
</dl>
|
|
@@ -2344,7 +2693,7 @@ await client.forms.listSubmissions("580e63e98c9a982ac9b8b741");
|
|
|
2344
2693
|
<dl>
|
|
2345
2694
|
<dd>
|
|
2346
2695
|
|
|
2347
|
-
**request:** `Webflow.
|
|
2696
|
+
**request:** `Webflow.Webhook`
|
|
2348
2697
|
|
|
2349
2698
|
</dd>
|
|
2350
2699
|
</dl>
|
|
@@ -2352,7 +2701,7 @@ await client.forms.listSubmissions("580e63e98c9a982ac9b8b741");
|
|
|
2352
2701
|
<dl>
|
|
2353
2702
|
<dd>
|
|
2354
2703
|
|
|
2355
|
-
**requestOptions:** `
|
|
2704
|
+
**requestOptions:** `Webhooks.RequestOptions`
|
|
2356
2705
|
|
|
2357
2706
|
</dd>
|
|
2358
2707
|
</dl>
|
|
@@ -2363,7 +2712,7 @@ await client.forms.listSubmissions("580e63e98c9a982ac9b8b741");
|
|
|
2363
2712
|
</dl>
|
|
2364
2713
|
</details>
|
|
2365
2714
|
|
|
2366
|
-
<details><summary><code>client.
|
|
2715
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">get</a>(webhookId) -> Webflow.Webhook</code></summary>
|
|
2367
2716
|
<dl>
|
|
2368
2717
|
<dd>
|
|
2369
2718
|
|
|
@@ -2375,9 +2724,9 @@ await client.forms.listSubmissions("580e63e98c9a982ac9b8b741");
|
|
|
2375
2724
|
<dl>
|
|
2376
2725
|
<dd>
|
|
2377
2726
|
|
|
2378
|
-
Get
|
|
2727
|
+
Get a specific Webhook instance
|
|
2379
2728
|
|
|
2380
|
-
Required scope
|
|
2729
|
+
Required scope: `sites:read`
|
|
2381
2730
|
|
|
2382
2731
|
</dd>
|
|
2383
2732
|
</dl>
|
|
@@ -2393,7 +2742,7 @@ Required scope | `forms:read`
|
|
|
2393
2742
|
<dd>
|
|
2394
2743
|
|
|
2395
2744
|
```typescript
|
|
2396
|
-
await client.
|
|
2745
|
+
await client.webhooks.get("580e64008c9a982ac9b8b754");
|
|
2397
2746
|
```
|
|
2398
2747
|
|
|
2399
2748
|
</dd>
|
|
@@ -2409,7 +2758,7 @@ await client.forms.getSubmission("580e63e98c9a982ac9b8b741");
|
|
|
2409
2758
|
<dl>
|
|
2410
2759
|
<dd>
|
|
2411
2760
|
|
|
2412
|
-
**
|
|
2761
|
+
**webhookId:** `string` — Unique identifier for a Webhook
|
|
2413
2762
|
|
|
2414
2763
|
</dd>
|
|
2415
2764
|
</dl>
|
|
@@ -2417,7 +2766,7 @@ await client.forms.getSubmission("580e63e98c9a982ac9b8b741");
|
|
|
2417
2766
|
<dl>
|
|
2418
2767
|
<dd>
|
|
2419
2768
|
|
|
2420
|
-
**requestOptions:** `
|
|
2769
|
+
**requestOptions:** `Webhooks.RequestOptions`
|
|
2421
2770
|
|
|
2422
2771
|
</dd>
|
|
2423
2772
|
</dl>
|
|
@@ -2428,7 +2777,7 @@ await client.forms.getSubmission("580e63e98c9a982ac9b8b741");
|
|
|
2428
2777
|
</dl>
|
|
2429
2778
|
</details>
|
|
2430
2779
|
|
|
2431
|
-
<details><summary><code>client.
|
|
2780
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">delete</a>(webhookId) -> void</code></summary>
|
|
2432
2781
|
<dl>
|
|
2433
2782
|
<dd>
|
|
2434
2783
|
|
|
@@ -2440,9 +2789,9 @@ await client.forms.getSubmission("580e63e98c9a982ac9b8b741");
|
|
|
2440
2789
|
<dl>
|
|
2441
2790
|
<dd>
|
|
2442
2791
|
|
|
2443
|
-
|
|
2792
|
+
Remove a Webhook
|
|
2444
2793
|
|
|
2445
|
-
Required scope
|
|
2794
|
+
Required scope: `sites:read`
|
|
2446
2795
|
|
|
2447
2796
|
</dd>
|
|
2448
2797
|
</dl>
|
|
@@ -2458,7 +2807,7 @@ Required scope | `forms:write`
|
|
|
2458
2807
|
<dd>
|
|
2459
2808
|
|
|
2460
2809
|
```typescript
|
|
2461
|
-
await client.
|
|
2810
|
+
await client.webhooks.delete("580e64008c9a982ac9b8b754");
|
|
2462
2811
|
```
|
|
2463
2812
|
|
|
2464
2813
|
</dd>
|
|
@@ -2474,15 +2823,7 @@ await client.forms.updateSubmission("580e63e98c9a982ac9b8b741");
|
|
|
2474
2823
|
<dl>
|
|
2475
2824
|
<dd>
|
|
2476
2825
|
|
|
2477
|
-
**
|
|
2478
|
-
|
|
2479
|
-
</dd>
|
|
2480
|
-
</dl>
|
|
2481
|
-
|
|
2482
|
-
<dl>
|
|
2483
|
-
<dd>
|
|
2484
|
-
|
|
2485
|
-
**request:** `Webflow.FormsUpdateSubmissionRequest`
|
|
2826
|
+
**webhookId:** `string` — Unique identifier for a Webhook
|
|
2486
2827
|
|
|
2487
2828
|
</dd>
|
|
2488
2829
|
</dl>
|
|
@@ -2490,7 +2831,7 @@ await client.forms.updateSubmission("580e63e98c9a982ac9b8b741");
|
|
|
2490
2831
|
<dl>
|
|
2491
2832
|
<dd>
|
|
2492
2833
|
|
|
2493
|
-
**requestOptions:** `
|
|
2834
|
+
**requestOptions:** `Webhooks.RequestOptions`
|
|
2494
2835
|
|
|
2495
2836
|
</dd>
|
|
2496
2837
|
</dl>
|
|
@@ -2501,9 +2842,9 @@ await client.forms.updateSubmission("580e63e98c9a982ac9b8b741");
|
|
|
2501
2842
|
</dl>
|
|
2502
2843
|
</details>
|
|
2503
2844
|
|
|
2504
|
-
##
|
|
2845
|
+
## Forms
|
|
2505
2846
|
|
|
2506
|
-
<details><summary><code>client.
|
|
2847
|
+
<details><summary><code>client.forms.<a href="/src/api/resources/forms/client/Client.ts">list</a>(siteId, { ...params }) -> Webflow.FormList</code></summary>
|
|
2507
2848
|
<dl>
|
|
2508
2849
|
<dd>
|
|
2509
2850
|
|
|
@@ -2515,9 +2856,9 @@ await client.forms.updateSubmission("580e63e98c9a982ac9b8b741");
|
|
|
2515
2856
|
<dl>
|
|
2516
2857
|
<dd>
|
|
2517
2858
|
|
|
2518
|
-
|
|
2859
|
+
List forms for a given site.
|
|
2519
2860
|
|
|
2520
|
-
Required scope | `
|
|
2861
|
+
Required scope | `forms:read`
|
|
2521
2862
|
|
|
2522
2863
|
</dd>
|
|
2523
2864
|
</dl>
|
|
@@ -2533,7 +2874,7 @@ Required scope | `users:read`
|
|
|
2533
2874
|
<dd>
|
|
2534
2875
|
|
|
2535
2876
|
```typescript
|
|
2536
|
-
await client.
|
|
2877
|
+
await client.forms.list("580e63e98c9a982ac9b8b741");
|
|
2537
2878
|
```
|
|
2538
2879
|
|
|
2539
2880
|
</dd>
|
|
@@ -2557,7 +2898,7 @@ await client.users.list("580e63e98c9a982ac9b8b741");
|
|
|
2557
2898
|
<dl>
|
|
2558
2899
|
<dd>
|
|
2559
2900
|
|
|
2560
|
-
**request:** `Webflow.
|
|
2901
|
+
**request:** `Webflow.FormsListRequest`
|
|
2561
2902
|
|
|
2562
2903
|
</dd>
|
|
2563
2904
|
</dl>
|
|
@@ -2565,7 +2906,7 @@ await client.users.list("580e63e98c9a982ac9b8b741");
|
|
|
2565
2906
|
<dl>
|
|
2566
2907
|
<dd>
|
|
2567
2908
|
|
|
2568
|
-
**requestOptions:** `
|
|
2909
|
+
**requestOptions:** `Forms.RequestOptions`
|
|
2569
2910
|
|
|
2570
2911
|
</dd>
|
|
2571
2912
|
</dl>
|
|
@@ -2576,7 +2917,7 @@ await client.users.list("580e63e98c9a982ac9b8b741");
|
|
|
2576
2917
|
</dl>
|
|
2577
2918
|
</details>
|
|
2578
2919
|
|
|
2579
|
-
<details><summary><code>client.
|
|
2920
|
+
<details><summary><code>client.forms.<a href="/src/api/resources/forms/client/Client.ts">get</a>(formId) -> Webflow.Form</code></summary>
|
|
2580
2921
|
<dl>
|
|
2581
2922
|
<dd>
|
|
2582
2923
|
|
|
@@ -2588,9 +2929,9 @@ await client.users.list("580e63e98c9a982ac9b8b741");
|
|
|
2588
2929
|
<dl>
|
|
2589
2930
|
<dd>
|
|
2590
2931
|
|
|
2591
|
-
Get a
|
|
2932
|
+
Get information about a given form.
|
|
2592
2933
|
|
|
2593
|
-
Required scope | `
|
|
2934
|
+
Required scope | `forms:read`
|
|
2594
2935
|
|
|
2595
2936
|
</dd>
|
|
2596
2937
|
</dl>
|
|
@@ -2606,7 +2947,7 @@ Required scope | `users:read`
|
|
|
2606
2947
|
<dd>
|
|
2607
2948
|
|
|
2608
2949
|
```typescript
|
|
2609
|
-
await client.
|
|
2950
|
+
await client.forms.get("580e63e98c9a982ac9b8b741");
|
|
2610
2951
|
```
|
|
2611
2952
|
|
|
2612
2953
|
</dd>
|
|
@@ -2622,15 +2963,7 @@ await client.users.get("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741");
|
|
|
2622
2963
|
<dl>
|
|
2623
2964
|
<dd>
|
|
2624
2965
|
|
|
2625
|
-
**
|
|
2626
|
-
|
|
2627
|
-
</dd>
|
|
2628
|
-
</dl>
|
|
2629
|
-
|
|
2630
|
-
<dl>
|
|
2631
|
-
<dd>
|
|
2632
|
-
|
|
2633
|
-
**userId:** `string` — Unique identifier for a User
|
|
2966
|
+
**formId:** `string` — Unique identifier for a Form
|
|
2634
2967
|
|
|
2635
2968
|
</dd>
|
|
2636
2969
|
</dl>
|
|
@@ -2638,7 +2971,7 @@ await client.users.get("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741");
|
|
|
2638
2971
|
<dl>
|
|
2639
2972
|
<dd>
|
|
2640
2973
|
|
|
2641
|
-
**requestOptions:** `
|
|
2974
|
+
**requestOptions:** `Forms.RequestOptions`
|
|
2642
2975
|
|
|
2643
2976
|
</dd>
|
|
2644
2977
|
</dl>
|
|
@@ -2649,7 +2982,7 @@ await client.users.get("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741");
|
|
|
2649
2982
|
</dl>
|
|
2650
2983
|
</details>
|
|
2651
2984
|
|
|
2652
|
-
<details><summary><code>client.
|
|
2985
|
+
<details><summary><code>client.forms.<a href="/src/api/resources/forms/client/Client.ts">listSubmissions</a>(formId, { ...params }) -> Webflow.FormSubmissionList</code></summary>
|
|
2653
2986
|
<dl>
|
|
2654
2987
|
<dd>
|
|
2655
2988
|
|
|
@@ -2661,9 +2994,9 @@ await client.users.get("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741");
|
|
|
2661
2994
|
<dl>
|
|
2662
2995
|
<dd>
|
|
2663
2996
|
|
|
2664
|
-
|
|
2997
|
+
List form submissions for a given form
|
|
2665
2998
|
|
|
2666
|
-
Required scope | `
|
|
2999
|
+
Required scope | `forms:read`
|
|
2667
3000
|
|
|
2668
3001
|
</dd>
|
|
2669
3002
|
</dl>
|
|
@@ -2679,7 +3012,7 @@ Required scope | `users:write`
|
|
|
2679
3012
|
<dd>
|
|
2680
3013
|
|
|
2681
3014
|
```typescript
|
|
2682
|
-
await client.
|
|
3015
|
+
await client.forms.listSubmissions("580e63e98c9a982ac9b8b741");
|
|
2683
3016
|
```
|
|
2684
3017
|
|
|
2685
3018
|
</dd>
|
|
@@ -2695,7 +3028,7 @@ await client.users.delete("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741"
|
|
|
2695
3028
|
<dl>
|
|
2696
3029
|
<dd>
|
|
2697
3030
|
|
|
2698
|
-
**
|
|
3031
|
+
**formId:** `string` — Unique identifier for a Form
|
|
2699
3032
|
|
|
2700
3033
|
</dd>
|
|
2701
3034
|
</dl>
|
|
@@ -2703,7 +3036,7 @@ await client.users.delete("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741"
|
|
|
2703
3036
|
<dl>
|
|
2704
3037
|
<dd>
|
|
2705
3038
|
|
|
2706
|
-
**
|
|
3039
|
+
**request:** `Webflow.FormsListSubmissionsRequest`
|
|
2707
3040
|
|
|
2708
3041
|
</dd>
|
|
2709
3042
|
</dl>
|
|
@@ -2711,7 +3044,7 @@ await client.users.delete("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741"
|
|
|
2711
3044
|
<dl>
|
|
2712
3045
|
<dd>
|
|
2713
3046
|
|
|
2714
|
-
**requestOptions:** `
|
|
3047
|
+
**requestOptions:** `Forms.RequestOptions`
|
|
2715
3048
|
|
|
2716
3049
|
</dd>
|
|
2717
3050
|
</dl>
|
|
@@ -2722,7 +3055,7 @@ await client.users.delete("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741"
|
|
|
2722
3055
|
</dl>
|
|
2723
3056
|
</details>
|
|
2724
3057
|
|
|
2725
|
-
<details><summary><code>client.
|
|
3058
|
+
<details><summary><code>client.forms.<a href="/src/api/resources/forms/client/Client.ts">getSubmission</a>(formSubmissionId) -> Webflow.FormSubmission</code></summary>
|
|
2726
3059
|
<dl>
|
|
2727
3060
|
<dd>
|
|
2728
3061
|
|
|
@@ -2734,12 +3067,9 @@ await client.users.delete("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741"
|
|
|
2734
3067
|
<dl>
|
|
2735
3068
|
<dd>
|
|
2736
3069
|
|
|
2737
|
-
|
|
2738
|
-
|
|
2739
|
-
Required scope | `users:write`
|
|
3070
|
+
Get information about a given form submissio.
|
|
2740
3071
|
|
|
2741
|
-
|
|
2742
|
-
fields cannot be updated using this endpoint</Note>
|
|
3072
|
+
Required scope | `forms:read`
|
|
2743
3073
|
|
|
2744
3074
|
</dd>
|
|
2745
3075
|
</dl>
|
|
@@ -2755,14 +3085,7 @@ fields cannot be updated using this endpoint</Note>
|
|
|
2755
3085
|
<dd>
|
|
2756
3086
|
|
|
2757
3087
|
```typescript
|
|
2758
|
-
await client.
|
|
2759
|
-
data: {
|
|
2760
|
-
name: "Some One",
|
|
2761
|
-
acceptPrivacy: false,
|
|
2762
|
-
acceptCommunications: false,
|
|
2763
|
-
},
|
|
2764
|
-
accessGroups: ["webflowers", "platinum", "free-tier"],
|
|
2765
|
-
});
|
|
3088
|
+
await client.forms.getSubmission("580e63e98c9a982ac9b8b741");
|
|
2766
3089
|
```
|
|
2767
3090
|
|
|
2768
3091
|
</dd>
|
|
@@ -2778,23 +3101,7 @@ await client.users.update("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741"
|
|
|
2778
3101
|
<dl>
|
|
2779
3102
|
<dd>
|
|
2780
3103
|
|
|
2781
|
-
**
|
|
2782
|
-
|
|
2783
|
-
</dd>
|
|
2784
|
-
</dl>
|
|
2785
|
-
|
|
2786
|
-
<dl>
|
|
2787
|
-
<dd>
|
|
2788
|
-
|
|
2789
|
-
**userId:** `string` — Unique identifier for a User
|
|
2790
|
-
|
|
2791
|
-
</dd>
|
|
2792
|
-
</dl>
|
|
2793
|
-
|
|
2794
|
-
<dl>
|
|
2795
|
-
<dd>
|
|
2796
|
-
|
|
2797
|
-
**request:** `Webflow.UsersUpdateRequest`
|
|
3104
|
+
**formSubmissionId:** `string` — Unique identifier for a Form Submission
|
|
2798
3105
|
|
|
2799
3106
|
</dd>
|
|
2800
3107
|
</dl>
|
|
@@ -2802,7 +3109,7 @@ await client.users.update("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741"
|
|
|
2802
3109
|
<dl>
|
|
2803
3110
|
<dd>
|
|
2804
3111
|
|
|
2805
|
-
**requestOptions:** `
|
|
3112
|
+
**requestOptions:** `Forms.RequestOptions`
|
|
2806
3113
|
|
|
2807
3114
|
</dd>
|
|
2808
3115
|
</dl>
|
|
@@ -2813,7 +3120,7 @@ await client.users.update("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741"
|
|
|
2813
3120
|
</dl>
|
|
2814
3121
|
</details>
|
|
2815
3122
|
|
|
2816
|
-
<details><summary><code>client.
|
|
3123
|
+
<details><summary><code>client.forms.<a href="/src/api/resources/forms/client/Client.ts">updateSubmission</a>(formSubmissionId, { ...params }) -> Webflow.FormSubmission</code></summary>
|
|
2817
3124
|
<dl>
|
|
2818
3125
|
<dd>
|
|
2819
3126
|
|
|
@@ -2825,11 +3132,9 @@ await client.users.update("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741"
|
|
|
2825
3132
|
<dl>
|
|
2826
3133
|
<dd>
|
|
2827
3134
|
|
|
2828
|
-
|
|
2829
|
-
|
|
2830
|
-
The user will be sent and invite via email, which they will need to accept in order to join paid any paid access group.
|
|
3135
|
+
Update hidden fields on a form submission
|
|
2831
3136
|
|
|
2832
|
-
Required scope | `
|
|
3137
|
+
Required scope | `forms:write`
|
|
2833
3138
|
|
|
2834
3139
|
</dd>
|
|
2835
3140
|
</dl>
|
|
@@ -2845,10 +3150,7 @@ Required scope | `users:write`
|
|
|
2845
3150
|
<dd>
|
|
2846
3151
|
|
|
2847
3152
|
```typescript
|
|
2848
|
-
await client.
|
|
2849
|
-
email: "some.one@home.com",
|
|
2850
|
-
accessGroups: ["webflowers"],
|
|
2851
|
-
});
|
|
3153
|
+
await client.forms.updateSubmission("580e63e98c9a982ac9b8b741");
|
|
2852
3154
|
```
|
|
2853
3155
|
|
|
2854
3156
|
</dd>
|
|
@@ -2864,7 +3166,7 @@ await client.users.invite("580e63e98c9a982ac9b8b741", {
|
|
|
2864
3166
|
<dl>
|
|
2865
3167
|
<dd>
|
|
2866
3168
|
|
|
2867
|
-
**
|
|
3169
|
+
**formSubmissionId:** `string` — Unique identifier for a Form Submission
|
|
2868
3170
|
|
|
2869
3171
|
</dd>
|
|
2870
3172
|
</dl>
|
|
@@ -2872,7 +3174,7 @@ await client.users.invite("580e63e98c9a982ac9b8b741", {
|
|
|
2872
3174
|
<dl>
|
|
2873
3175
|
<dd>
|
|
2874
3176
|
|
|
2875
|
-
**request:** `Webflow.
|
|
3177
|
+
**request:** `Webflow.FormsUpdateSubmissionRequest`
|
|
2876
3178
|
|
|
2877
3179
|
</dd>
|
|
2878
3180
|
</dl>
|
|
@@ -2880,7 +3182,7 @@ await client.users.invite("580e63e98c9a982ac9b8b741", {
|
|
|
2880
3182
|
<dl>
|
|
2881
3183
|
<dd>
|
|
2882
3184
|
|
|
2883
|
-
**requestOptions:** `
|
|
3185
|
+
**requestOptions:** `Forms.RequestOptions`
|
|
2884
3186
|
|
|
2885
3187
|
</dd>
|
|
2886
3188
|
</dl>
|
|
@@ -2891,9 +3193,9 @@ await client.users.invite("580e63e98c9a982ac9b8b741", {
|
|
|
2891
3193
|
</dl>
|
|
2892
3194
|
</details>
|
|
2893
3195
|
|
|
2894
|
-
##
|
|
3196
|
+
## Users
|
|
2895
3197
|
|
|
2896
|
-
<details><summary><code>client.
|
|
3198
|
+
<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">list</a>(siteId, { ...params }) -> Webflow.UserList</code></summary>
|
|
2897
3199
|
<dl>
|
|
2898
3200
|
<dd>
|
|
2899
3201
|
|
|
@@ -2905,7 +3207,7 @@ await client.users.invite("580e63e98c9a982ac9b8b741", {
|
|
|
2905
3207
|
<dl>
|
|
2906
3208
|
<dd>
|
|
2907
3209
|
|
|
2908
|
-
Get a list of
|
|
3210
|
+
Get a list of users for a site
|
|
2909
3211
|
|
|
2910
3212
|
Required scope | `users:read`
|
|
2911
3213
|
|
|
@@ -2923,7 +3225,7 @@ Required scope | `users:read`
|
|
|
2923
3225
|
<dd>
|
|
2924
3226
|
|
|
2925
3227
|
```typescript
|
|
2926
|
-
await client.
|
|
3228
|
+
await client.users.list("580e63e98c9a982ac9b8b741");
|
|
2927
3229
|
```
|
|
2928
3230
|
|
|
2929
3231
|
</dd>
|
|
@@ -2947,7 +3249,7 @@ await client.accessGroups.list("580e63e98c9a982ac9b8b741");
|
|
|
2947
3249
|
<dl>
|
|
2948
3250
|
<dd>
|
|
2949
3251
|
|
|
2950
|
-
**request:** `Webflow.
|
|
3252
|
+
**request:** `Webflow.UsersListRequest`
|
|
2951
3253
|
|
|
2952
3254
|
</dd>
|
|
2953
3255
|
</dl>
|
|
@@ -2955,7 +3257,7 @@ await client.accessGroups.list("580e63e98c9a982ac9b8b741");
|
|
|
2955
3257
|
<dl>
|
|
2956
3258
|
<dd>
|
|
2957
3259
|
|
|
2958
|
-
**requestOptions:** `
|
|
3260
|
+
**requestOptions:** `Users.RequestOptions`
|
|
2959
3261
|
|
|
2960
3262
|
</dd>
|
|
2961
3263
|
</dl>
|
|
@@ -2966,9 +3268,7 @@ await client.accessGroups.list("580e63e98c9a982ac9b8b741");
|
|
|
2966
3268
|
</dl>
|
|
2967
3269
|
</details>
|
|
2968
3270
|
|
|
2969
|
-
|
|
2970
|
-
|
|
2971
|
-
<details><summary><code>client.products.<a href="/src/api/resources/products/client/Client.ts">list</a>(siteId, { ...params }) -> Webflow.ProductAndSkUsList</code></summary>
|
|
3271
|
+
<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">get</a>(siteId, userId) -> Webflow.User</code></summary>
|
|
2972
3272
|
<dl>
|
|
2973
3273
|
<dd>
|
|
2974
3274
|
|
|
@@ -2980,12 +3280,9 @@ await client.accessGroups.list("580e63e98c9a982ac9b8b741");
|
|
|
2980
3280
|
<dl>
|
|
2981
3281
|
<dd>
|
|
2982
3282
|
|
|
2983
|
-
|
|
2984
|
-
|
|
2985
|
-
Use `limit` and `offset` to page through all products with subsequent requests. All SKUs for each product
|
|
2986
|
-
will also be fetched and returned. The `limit`, `offset` and `total` values represent Products only and do not include any SKUs.
|
|
3283
|
+
Get a User by ID
|
|
2987
3284
|
|
|
2988
|
-
Required scope | `
|
|
3285
|
+
Required scope | `users:read`
|
|
2989
3286
|
|
|
2990
3287
|
</dd>
|
|
2991
3288
|
</dl>
|
|
@@ -3001,7 +3298,7 @@ Required scope | `ecommerce:read`
|
|
|
3001
3298
|
<dd>
|
|
3002
3299
|
|
|
3003
3300
|
```typescript
|
|
3004
|
-
await client.
|
|
3301
|
+
await client.users.get("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741");
|
|
3005
3302
|
```
|
|
3006
3303
|
|
|
3007
3304
|
</dd>
|
|
@@ -3025,7 +3322,7 @@ await client.products.list("580e63e98c9a982ac9b8b741");
|
|
|
3025
3322
|
<dl>
|
|
3026
3323
|
<dd>
|
|
3027
3324
|
|
|
3028
|
-
**
|
|
3325
|
+
**userId:** `string` — Unique identifier for a User
|
|
3029
3326
|
|
|
3030
3327
|
</dd>
|
|
3031
3328
|
</dl>
|
|
@@ -3033,7 +3330,7 @@ await client.products.list("580e63e98c9a982ac9b8b741");
|
|
|
3033
3330
|
<dl>
|
|
3034
3331
|
<dd>
|
|
3035
3332
|
|
|
3036
|
-
**requestOptions:** `
|
|
3333
|
+
**requestOptions:** `Users.RequestOptions`
|
|
3037
3334
|
|
|
3038
3335
|
</dd>
|
|
3039
3336
|
</dl>
|
|
@@ -3044,7 +3341,7 @@ await client.products.list("580e63e98c9a982ac9b8b741");
|
|
|
3044
3341
|
</dl>
|
|
3045
3342
|
</details>
|
|
3046
3343
|
|
|
3047
|
-
<details><summary><code>client.
|
|
3344
|
+
<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">delete</a>(siteId, userId) -> void</code></summary>
|
|
3048
3345
|
<dl>
|
|
3049
3346
|
<dd>
|
|
3050
3347
|
|
|
@@ -3056,21 +3353,9 @@ await client.products.list("580e63e98c9a982ac9b8b741");
|
|
|
3056
3353
|
<dl>
|
|
3057
3354
|
<dd>
|
|
3058
3355
|
|
|
3059
|
-
|
|
3060
|
-
|
|
3061
|
-
When you create a product, you will always create a SKU, since a Product Item must have, at minimum, a single SKU.
|
|
3062
|
-
|
|
3063
|
-
To create a Product with multiple SKUs - for example a T-shirt in sizes small, medium and large:
|
|
3064
|
-
|
|
3065
|
-
- Create parameters in `sku-properties`, also known as [product options and variants.](https://help.webflow.com/hc/en-us/articles/33961334531347-Create-product-options-and-variants).
|
|
3066
|
-
- A single `sku-property` would be `color`. Within the `color` property, list the various colors of T-shirts as an array of `enum` values: `royal-blue`, `crimson-red`, and `forrest-green`.
|
|
3067
|
-
- Once, you've created a Product and its `sku-properties` with `enum` values, Webflow will create a **default SKU**, which will automatically be a combination of the first `sku-properties` you've created.
|
|
3068
|
-
- In our example, the default SKU will be a Royal Blue T-Shirt, because our first `enum` of our Color `sku-property` is Royal Blue.
|
|
3069
|
-
- After you've created your product, you can create additional SKUs using the [Create SKU endpoint.](/data/reference/ecommerce/products-sk-us/create-sku)
|
|
3070
|
-
|
|
3071
|
-
Upon creation, the default product type will be `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer.
|
|
3356
|
+
Delete a User by ID
|
|
3072
3357
|
|
|
3073
|
-
Required scope | `
|
|
3358
|
+
Required scope | `users:write`
|
|
3074
3359
|
|
|
3075
3360
|
</dd>
|
|
3076
3361
|
</dl>
|
|
@@ -3086,7 +3371,7 @@ Required scope | `ecommerce:write`
|
|
|
3086
3371
|
<dd>
|
|
3087
3372
|
|
|
3088
3373
|
```typescript
|
|
3089
|
-
await client.
|
|
3374
|
+
await client.users.delete("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741");
|
|
3090
3375
|
```
|
|
3091
3376
|
|
|
3092
3377
|
</dd>
|
|
@@ -3110,7 +3395,7 @@ await client.products.create("580e63e98c9a982ac9b8b741");
|
|
|
3110
3395
|
<dl>
|
|
3111
3396
|
<dd>
|
|
3112
3397
|
|
|
3113
|
-
**
|
|
3398
|
+
**userId:** `string` — Unique identifier for a User
|
|
3114
3399
|
|
|
3115
3400
|
</dd>
|
|
3116
3401
|
</dl>
|
|
@@ -3118,7 +3403,7 @@ await client.products.create("580e63e98c9a982ac9b8b741");
|
|
|
3118
3403
|
<dl>
|
|
3119
3404
|
<dd>
|
|
3120
3405
|
|
|
3121
|
-
**requestOptions:** `
|
|
3406
|
+
**requestOptions:** `Users.RequestOptions`
|
|
3122
3407
|
|
|
3123
3408
|
</dd>
|
|
3124
3409
|
</dl>
|
|
@@ -3129,7 +3414,7 @@ await client.products.create("580e63e98c9a982ac9b8b741");
|
|
|
3129
3414
|
</dl>
|
|
3130
3415
|
</details>
|
|
3131
3416
|
|
|
3132
|
-
<details><summary><code>client.
|
|
3417
|
+
<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">update</a>(siteId, userId, { ...params }) -> Webflow.User</code></summary>
|
|
3133
3418
|
<dl>
|
|
3134
3419
|
<dd>
|
|
3135
3420
|
|
|
@@ -3141,10 +3426,12 @@ await client.products.create("580e63e98c9a982ac9b8b741");
|
|
|
3141
3426
|
<dl>
|
|
3142
3427
|
<dd>
|
|
3143
3428
|
|
|
3144
|
-
|
|
3145
|
-
retrieved.
|
|
3429
|
+
Update a User by ID
|
|
3146
3430
|
|
|
3147
|
-
Required scope | `
|
|
3431
|
+
Required scope | `users:write`
|
|
3432
|
+
|
|
3433
|
+
<Note class="notice">The <code>email</code> and <code>password</code>
|
|
3434
|
+
fields cannot be updated using this endpoint</Note>
|
|
3148
3435
|
|
|
3149
3436
|
</dd>
|
|
3150
3437
|
</dl>
|
|
@@ -3160,12 +3447,19 @@ Required scope | `ecommerce:read`
|
|
|
3160
3447
|
<dd>
|
|
3161
3448
|
|
|
3162
3449
|
```typescript
|
|
3163
|
-
await client.
|
|
3164
|
-
|
|
3165
|
-
|
|
3166
|
-
|
|
3167
|
-
|
|
3168
|
-
|
|
3450
|
+
await client.users.update("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741", {
|
|
3451
|
+
data: {
|
|
3452
|
+
name: "Some One",
|
|
3453
|
+
acceptPrivacy: false,
|
|
3454
|
+
acceptCommunications: false,
|
|
3455
|
+
},
|
|
3456
|
+
accessGroups: ["webflowers", "platinum", "free-tier"],
|
|
3457
|
+
});
|
|
3458
|
+
```
|
|
3459
|
+
|
|
3460
|
+
</dd>
|
|
3461
|
+
</dl>
|
|
3462
|
+
</dd>
|
|
3169
3463
|
</dl>
|
|
3170
3464
|
|
|
3171
3465
|
#### ⚙️ Parameters
|
|
@@ -3184,7 +3478,7 @@ await client.products.get("580e63e98c9a982ac9b8b741", "580e63fc8c9a982ac9b8b745"
|
|
|
3184
3478
|
<dl>
|
|
3185
3479
|
<dd>
|
|
3186
3480
|
|
|
3187
|
-
**
|
|
3481
|
+
**userId:** `string` — Unique identifier for a User
|
|
3188
3482
|
|
|
3189
3483
|
</dd>
|
|
3190
3484
|
</dl>
|
|
@@ -3192,7 +3486,15 @@ await client.products.get("580e63e98c9a982ac9b8b741", "580e63fc8c9a982ac9b8b745"
|
|
|
3192
3486
|
<dl>
|
|
3193
3487
|
<dd>
|
|
3194
3488
|
|
|
3195
|
-
**
|
|
3489
|
+
**request:** `Webflow.UsersUpdateRequest`
|
|
3490
|
+
|
|
3491
|
+
</dd>
|
|
3492
|
+
</dl>
|
|
3493
|
+
|
|
3494
|
+
<dl>
|
|
3495
|
+
<dd>
|
|
3496
|
+
|
|
3497
|
+
**requestOptions:** `Users.RequestOptions`
|
|
3196
3498
|
|
|
3197
3499
|
</dd>
|
|
3198
3500
|
</dl>
|
|
@@ -3203,7 +3505,7 @@ await client.products.get("580e63e98c9a982ac9b8b741", "580e63fc8c9a982ac9b8b745"
|
|
|
3203
3505
|
</dl>
|
|
3204
3506
|
</details>
|
|
3205
3507
|
|
|
3206
|
-
<details><summary><code>client.
|
|
3508
|
+
<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">invite</a>(siteId, { ...params }) -> Webflow.User</code></summary>
|
|
3207
3509
|
<dl>
|
|
3208
3510
|
<dd>
|
|
3209
3511
|
|
|
@@ -3215,11 +3517,11 @@ await client.products.get("580e63e98c9a982ac9b8b741", "580e63fc8c9a982ac9b8b745"
|
|
|
3215
3517
|
<dl>
|
|
3216
3518
|
<dd>
|
|
3217
3519
|
|
|
3218
|
-
|
|
3520
|
+
Create and invite a user with an email address.
|
|
3219
3521
|
|
|
3220
|
-
|
|
3522
|
+
The user will be sent and invite via email, which they will need to accept in order to join paid any paid access group.
|
|
3221
3523
|
|
|
3222
|
-
Required scope | `
|
|
3524
|
+
Required scope | `users:write`
|
|
3223
3525
|
|
|
3224
3526
|
</dd>
|
|
3225
3527
|
</dl>
|
|
@@ -3235,7 +3537,10 @@ Required scope | `ecommerce:write`
|
|
|
3235
3537
|
<dd>
|
|
3236
3538
|
|
|
3237
3539
|
```typescript
|
|
3238
|
-
await client.
|
|
3540
|
+
await client.users.invite("580e63e98c9a982ac9b8b741", {
|
|
3541
|
+
email: "some.one@home.com",
|
|
3542
|
+
accessGroups: ["webflowers"],
|
|
3543
|
+
});
|
|
3239
3544
|
```
|
|
3240
3545
|
|
|
3241
3546
|
</dd>
|
|
@@ -3259,15 +3564,7 @@ await client.products.update("580e63e98c9a982ac9b8b741", "580e63fc8c9a982ac9b8b7
|
|
|
3259
3564
|
<dl>
|
|
3260
3565
|
<dd>
|
|
3261
3566
|
|
|
3262
|
-
**
|
|
3263
|
-
|
|
3264
|
-
</dd>
|
|
3265
|
-
</dl>
|
|
3266
|
-
|
|
3267
|
-
<dl>
|
|
3268
|
-
<dd>
|
|
3269
|
-
|
|
3270
|
-
**request:** `Webflow.ProductSkuUpdate`
|
|
3567
|
+
**request:** `Webflow.UsersInviteRequest`
|
|
3271
3568
|
|
|
3272
3569
|
</dd>
|
|
3273
3570
|
</dl>
|
|
@@ -3275,7 +3572,7 @@ await client.products.update("580e63e98c9a982ac9b8b741", "580e63fc8c9a982ac9b8b7
|
|
|
3275
3572
|
<dl>
|
|
3276
3573
|
<dd>
|
|
3277
3574
|
|
|
3278
|
-
**requestOptions:** `
|
|
3575
|
+
**requestOptions:** `Users.RequestOptions`
|
|
3279
3576
|
|
|
3280
3577
|
</dd>
|
|
3281
3578
|
</dl>
|
|
@@ -3286,7 +3583,9 @@ await client.products.update("580e63e98c9a982ac9b8b741", "580e63fc8c9a982ac9b8b7
|
|
|
3286
3583
|
</dl>
|
|
3287
3584
|
</details>
|
|
3288
3585
|
|
|
3289
|
-
|
|
3586
|
+
## AccessGroups
|
|
3587
|
+
|
|
3588
|
+
<details><summary><code>client.accessGroups.<a href="/src/api/resources/accessGroups/client/Client.ts">list</a>(siteId, { ...params }) -> Webflow.AccessGroupList</code></summary>
|
|
3290
3589
|
<dl>
|
|
3291
3590
|
<dd>
|
|
3292
3591
|
|
|
@@ -3298,11 +3597,9 @@ await client.products.update("580e63e98c9a982ac9b8b741", "580e63fc8c9a982ac9b8b7
|
|
|
3298
3597
|
<dl>
|
|
3299
3598
|
<dd>
|
|
3300
3599
|
|
|
3301
|
-
|
|
3302
|
-
|
|
3303
|
-
Creating SKUs through the API will set the product type to `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer.
|
|
3600
|
+
Get a list of access groups for a site
|
|
3304
3601
|
|
|
3305
|
-
Required scope | `
|
|
3602
|
+
Required scope | `users:read`
|
|
3306
3603
|
|
|
3307
3604
|
</dd>
|
|
3308
3605
|
</dl>
|
|
@@ -3318,9 +3615,7 @@ Required scope | `ecommerce:write`
|
|
|
3318
3615
|
<dd>
|
|
3319
3616
|
|
|
3320
3617
|
```typescript
|
|
3321
|
-
await client.
|
|
3322
|
-
skus: [{}],
|
|
3323
|
-
});
|
|
3618
|
+
await client.accessGroups.list("580e63e98c9a982ac9b8b741");
|
|
3324
3619
|
```
|
|
3325
3620
|
|
|
3326
3621
|
</dd>
|
|
@@ -3344,15 +3639,7 @@ await client.products.createSku("580e63e98c9a982ac9b8b741", "580e63fc8c9a982ac9b
|
|
|
3344
3639
|
<dl>
|
|
3345
3640
|
<dd>
|
|
3346
3641
|
|
|
3347
|
-
**
|
|
3348
|
-
|
|
3349
|
-
</dd>
|
|
3350
|
-
</dl>
|
|
3351
|
-
|
|
3352
|
-
<dl>
|
|
3353
|
-
<dd>
|
|
3354
|
-
|
|
3355
|
-
**request:** `Webflow.ProductsCreateSkuRequest`
|
|
3642
|
+
**request:** `Webflow.AccessGroupsListRequest`
|
|
3356
3643
|
|
|
3357
3644
|
</dd>
|
|
3358
3645
|
</dl>
|
|
@@ -3360,7 +3647,7 @@ await client.products.createSku("580e63e98c9a982ac9b8b741", "580e63fc8c9a982ac9b
|
|
|
3360
3647
|
<dl>
|
|
3361
3648
|
<dd>
|
|
3362
3649
|
|
|
3363
|
-
**requestOptions:** `
|
|
3650
|
+
**requestOptions:** `AccessGroups.RequestOptions`
|
|
3364
3651
|
|
|
3365
3652
|
</dd>
|
|
3366
3653
|
</dl>
|
|
@@ -3371,7 +3658,9 @@ await client.products.createSku("580e63e98c9a982ac9b8b741", "580e63fc8c9a982ac9b
|
|
|
3371
3658
|
</dl>
|
|
3372
3659
|
</details>
|
|
3373
3660
|
|
|
3374
|
-
|
|
3661
|
+
## Products
|
|
3662
|
+
|
|
3663
|
+
<details><summary><code>client.products.<a href="/src/api/resources/products/client/Client.ts">list</a>(siteId, { ...params }) -> Webflow.ProductAndSkUsList</code></summary>
|
|
3375
3664
|
<dl>
|
|
3376
3665
|
<dd>
|
|
3377
3666
|
|
|
@@ -3383,11 +3672,12 @@ await client.products.createSku("580e63e98c9a982ac9b8b741", "580e63fc8c9a982ac9b
|
|
|
3383
3672
|
<dl>
|
|
3384
3673
|
<dd>
|
|
3385
3674
|
|
|
3386
|
-
|
|
3675
|
+
Retrieve all products for a site.
|
|
3387
3676
|
|
|
3388
|
-
|
|
3677
|
+
Use `limit` and `offset` to page through all products with subsequent requests. All SKUs for each product
|
|
3678
|
+
will also be fetched and returned. The `limit`, `offset` and `total` values represent Products only and do not include any SKUs.
|
|
3389
3679
|
|
|
3390
|
-
Required scope | `ecommerce:
|
|
3680
|
+
Required scope | `ecommerce:read`
|
|
3391
3681
|
|
|
3392
3682
|
</dd>
|
|
3393
3683
|
</dl>
|
|
@@ -3403,9 +3693,7 @@ Required scope | `ecommerce:write`
|
|
|
3403
3693
|
<dd>
|
|
3404
3694
|
|
|
3405
3695
|
```typescript
|
|
3406
|
-
await client.products.
|
|
3407
|
-
sku: {},
|
|
3408
|
-
});
|
|
3696
|
+
await client.products.list("580e63e98c9a982ac9b8b741");
|
|
3409
3697
|
```
|
|
3410
3698
|
|
|
3411
3699
|
</dd>
|
|
@@ -3429,23 +3717,7 @@ await client.products.updateSku("580e63e98c9a982ac9b8b741", "580e63fc8c9a982ac9b
|
|
|
3429
3717
|
<dl>
|
|
3430
3718
|
<dd>
|
|
3431
3719
|
|
|
3432
|
-
**
|
|
3433
|
-
|
|
3434
|
-
</dd>
|
|
3435
|
-
</dl>
|
|
3436
|
-
|
|
3437
|
-
<dl>
|
|
3438
|
-
<dd>
|
|
3439
|
-
|
|
3440
|
-
**skuId:** `string` — Unique identifier for a SKU
|
|
3441
|
-
|
|
3442
|
-
</dd>
|
|
3443
|
-
</dl>
|
|
3444
|
-
|
|
3445
|
-
<dl>
|
|
3446
|
-
<dd>
|
|
3447
|
-
|
|
3448
|
-
**request:** `Webflow.ProductsUpdateSkuRequest`
|
|
3720
|
+
**request:** `Webflow.ProductsListRequest`
|
|
3449
3721
|
|
|
3450
3722
|
</dd>
|
|
3451
3723
|
</dl>
|
|
@@ -3464,9 +3736,7 @@ await client.products.updateSku("580e63e98c9a982ac9b8b741", "580e63fc8c9a982ac9b
|
|
|
3464
3736
|
</dl>
|
|
3465
3737
|
</details>
|
|
3466
3738
|
|
|
3467
|
-
|
|
3468
|
-
|
|
3469
|
-
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">list</a>(siteId, { ...params }) -> Webflow.OrderList</code></summary>
|
|
3739
|
+
<details><summary><code>client.products.<a href="/src/api/resources/products/client/Client.ts">create</a>(siteId, { ...params }) -> Webflow.ProductAndSkUs</code></summary>
|
|
3470
3740
|
<dl>
|
|
3471
3741
|
<dd>
|
|
3472
3742
|
|
|
@@ -3478,9 +3748,21 @@ await client.products.updateSku("580e63e98c9a982ac9b8b741", "580e63fc8c9a982ac9b
|
|
|
3478
3748
|
<dl>
|
|
3479
3749
|
<dd>
|
|
3480
3750
|
|
|
3481
|
-
|
|
3751
|
+
Create a new product and SKU.
|
|
3482
3752
|
|
|
3483
|
-
|
|
3753
|
+
When you create a product, you will always create a SKU, since a Product Item must have, at minimum, a single SKU.
|
|
3754
|
+
|
|
3755
|
+
To create a Product with multiple SKUs - for example a T-shirt in sizes small, medium and large:
|
|
3756
|
+
|
|
3757
|
+
- Create parameters in `sku-properties`, also known as [product options and variants.](https://help.webflow.com/hc/en-us/articles/33961334531347-Create-product-options-and-variants).
|
|
3758
|
+
- A single `sku-property` would be `color`. Within the `color` property, list the various colors of T-shirts as an array of `enum` values: `royal-blue`, `crimson-red`, and `forrest-green`.
|
|
3759
|
+
- Once, you've created a Product and its `sku-properties` with `enum` values, Webflow will create a **default SKU**, which will automatically be a combination of the first `sku-properties` you've created.
|
|
3760
|
+
- In our example, the default SKU will be a Royal Blue T-Shirt, because our first `enum` of our Color `sku-property` is Royal Blue.
|
|
3761
|
+
- After you've created your product, you can create additional SKUs using the [Create SKU endpoint.](/data/reference/ecommerce/products/create-sku)
|
|
3762
|
+
|
|
3763
|
+
Upon creation, the default product type will be `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer.
|
|
3764
|
+
|
|
3765
|
+
Required scope | `ecommerce:write`
|
|
3484
3766
|
|
|
3485
3767
|
</dd>
|
|
3486
3768
|
</dl>
|
|
@@ -3496,7 +3778,7 @@ Required scope | `ecommerce:read`
|
|
|
3496
3778
|
<dd>
|
|
3497
3779
|
|
|
3498
3780
|
```typescript
|
|
3499
|
-
await client.
|
|
3781
|
+
await client.products.create("580e63e98c9a982ac9b8b741");
|
|
3500
3782
|
```
|
|
3501
3783
|
|
|
3502
3784
|
</dd>
|
|
@@ -3520,7 +3802,7 @@ await client.orders.list("580e63e98c9a982ac9b8b741");
|
|
|
3520
3802
|
<dl>
|
|
3521
3803
|
<dd>
|
|
3522
3804
|
|
|
3523
|
-
**request:** `Webflow.
|
|
3805
|
+
**request:** `Webflow.ProductSkuCreate`
|
|
3524
3806
|
|
|
3525
3807
|
</dd>
|
|
3526
3808
|
</dl>
|
|
@@ -3528,7 +3810,7 @@ await client.orders.list("580e63e98c9a982ac9b8b741");
|
|
|
3528
3810
|
<dl>
|
|
3529
3811
|
<dd>
|
|
3530
3812
|
|
|
3531
|
-
**requestOptions:** `
|
|
3813
|
+
**requestOptions:** `Products.RequestOptions`
|
|
3532
3814
|
|
|
3533
3815
|
</dd>
|
|
3534
3816
|
</dl>
|
|
@@ -3539,7 +3821,7 @@ await client.orders.list("580e63e98c9a982ac9b8b741");
|
|
|
3539
3821
|
</dl>
|
|
3540
3822
|
</details>
|
|
3541
3823
|
|
|
3542
|
-
<details><summary><code>client.
|
|
3824
|
+
<details><summary><code>client.products.<a href="/src/api/resources/products/client/Client.ts">get</a>(siteId, productId) -> Webflow.ProductAndSkUs</code></summary>
|
|
3543
3825
|
<dl>
|
|
3544
3826
|
<dd>
|
|
3545
3827
|
|
|
@@ -3570,7 +3852,7 @@ Required scope | `ecommerce:read`
|
|
|
3570
3852
|
<dd>
|
|
3571
3853
|
|
|
3572
3854
|
```typescript
|
|
3573
|
-
await client.
|
|
3855
|
+
await client.products.get("580e63e98c9a982ac9b8b741", "580e63fc8c9a982ac9b8b745");
|
|
3574
3856
|
```
|
|
3575
3857
|
|
|
3576
3858
|
</dd>
|
|
@@ -3594,7 +3876,7 @@ await client.orders.get("580e63e98c9a982ac9b8b741", "5e8518516e147040726cc415");
|
|
|
3594
3876
|
<dl>
|
|
3595
3877
|
<dd>
|
|
3596
3878
|
|
|
3597
|
-
**
|
|
3879
|
+
**productId:** `string` — Unique identifier for a Product
|
|
3598
3880
|
|
|
3599
3881
|
</dd>
|
|
3600
3882
|
</dl>
|
|
@@ -3602,7 +3884,7 @@ await client.orders.get("580e63e98c9a982ac9b8b741", "5e8518516e147040726cc415");
|
|
|
3602
3884
|
<dl>
|
|
3603
3885
|
<dd>
|
|
3604
3886
|
|
|
3605
|
-
**requestOptions:** `
|
|
3887
|
+
**requestOptions:** `Products.RequestOptions`
|
|
3606
3888
|
|
|
3607
3889
|
</dd>
|
|
3608
3890
|
</dl>
|
|
@@ -3613,7 +3895,7 @@ await client.orders.get("580e63e98c9a982ac9b8b741", "5e8518516e147040726cc415");
|
|
|
3613
3895
|
</dl>
|
|
3614
3896
|
</details>
|
|
3615
3897
|
|
|
3616
|
-
<details><summary><code>client.
|
|
3898
|
+
<details><summary><code>client.products.<a href="/src/api/resources/products/client/Client.ts">update</a>(siteId, productId, { ...params }) -> Webflow.Product</code></summary>
|
|
3617
3899
|
<dl>
|
|
3618
3900
|
<dd>
|
|
3619
3901
|
|
|
@@ -3625,9 +3907,9 @@ await client.orders.get("580e63e98c9a982ac9b8b741", "5e8518516e147040726cc415");
|
|
|
3625
3907
|
<dl>
|
|
3626
3908
|
<dd>
|
|
3627
3909
|
|
|
3628
|
-
|
|
3629
|
-
|
|
3630
|
-
|
|
3910
|
+
Update an existing Product.
|
|
3911
|
+
|
|
3912
|
+
Updating an existing Product will set the product type to `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer.
|
|
3631
3913
|
|
|
3632
3914
|
Required scope | `ecommerce:write`
|
|
3633
3915
|
|
|
@@ -3645,7 +3927,7 @@ Required scope | `ecommerce:write`
|
|
|
3645
3927
|
<dd>
|
|
3646
3928
|
|
|
3647
3929
|
```typescript
|
|
3648
|
-
await client.
|
|
3930
|
+
await client.products.update("580e63e98c9a982ac9b8b741", "580e63fc8c9a982ac9b8b745");
|
|
3649
3931
|
```
|
|
3650
3932
|
|
|
3651
3933
|
</dd>
|
|
@@ -3669,7 +3951,7 @@ await client.orders.update("580e63e98c9a982ac9b8b741", "5e8518516e147040726cc415
|
|
|
3669
3951
|
<dl>
|
|
3670
3952
|
<dd>
|
|
3671
3953
|
|
|
3672
|
-
**
|
|
3954
|
+
**productId:** `string` — Unique identifier for a Product
|
|
3673
3955
|
|
|
3674
3956
|
</dd>
|
|
3675
3957
|
</dl>
|
|
@@ -3677,7 +3959,7 @@ await client.orders.update("580e63e98c9a982ac9b8b741", "5e8518516e147040726cc415
|
|
|
3677
3959
|
<dl>
|
|
3678
3960
|
<dd>
|
|
3679
3961
|
|
|
3680
|
-
**request:** `Webflow.
|
|
3962
|
+
**request:** `Webflow.ProductSkuUpdate`
|
|
3681
3963
|
|
|
3682
3964
|
</dd>
|
|
3683
3965
|
</dl>
|
|
@@ -3685,7 +3967,7 @@ await client.orders.update("580e63e98c9a982ac9b8b741", "5e8518516e147040726cc415
|
|
|
3685
3967
|
<dl>
|
|
3686
3968
|
<dd>
|
|
3687
3969
|
|
|
3688
|
-
**requestOptions:** `
|
|
3970
|
+
**requestOptions:** `Products.RequestOptions`
|
|
3689
3971
|
|
|
3690
3972
|
</dd>
|
|
3691
3973
|
</dl>
|
|
@@ -3696,7 +3978,7 @@ await client.orders.update("580e63e98c9a982ac9b8b741", "5e8518516e147040726cc415
|
|
|
3696
3978
|
</dl>
|
|
3697
3979
|
</details>
|
|
3698
3980
|
|
|
3699
|
-
<details><summary><code>client.
|
|
3981
|
+
<details><summary><code>client.products.<a href="/src/api/resources/products/client/Client.ts">createSku</a>(siteId, productId, { ...params }) -> Webflow.ProductsCreateSkuResponse</code></summary>
|
|
3700
3982
|
<dl>
|
|
3701
3983
|
<dd>
|
|
3702
3984
|
|
|
@@ -3708,7 +3990,9 @@ await client.orders.update("580e63e98c9a982ac9b8b741", "5e8518516e147040726cc415
|
|
|
3708
3990
|
<dl>
|
|
3709
3991
|
<dd>
|
|
3710
3992
|
|
|
3711
|
-
|
|
3993
|
+
Create additional SKUs to manage every [option and variant of your Product.](https://help.webflow.com/hc/en-us/articles/33961334531347-Create-product-options-and-variants)
|
|
3994
|
+
|
|
3995
|
+
Creating SKUs through the API will set the product type to `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer.
|
|
3712
3996
|
|
|
3713
3997
|
Required scope | `ecommerce:write`
|
|
3714
3998
|
|
|
@@ -3726,7 +4010,9 @@ Required scope | `ecommerce:write`
|
|
|
3726
4010
|
<dd>
|
|
3727
4011
|
|
|
3728
4012
|
```typescript
|
|
3729
|
-
await client.
|
|
4013
|
+
await client.products.createSku("580e63e98c9a982ac9b8b741", "580e63fc8c9a982ac9b8b745", {
|
|
4014
|
+
skus: [{}],
|
|
4015
|
+
});
|
|
3730
4016
|
```
|
|
3731
4017
|
|
|
3732
4018
|
</dd>
|
|
@@ -3750,7 +4036,7 @@ await client.orders.updateFulfill("580e63e98c9a982ac9b8b741", "5e8518516e1470407
|
|
|
3750
4036
|
<dl>
|
|
3751
4037
|
<dd>
|
|
3752
4038
|
|
|
3753
|
-
**
|
|
4039
|
+
**productId:** `string` — Unique identifier for a Product
|
|
3754
4040
|
|
|
3755
4041
|
</dd>
|
|
3756
4042
|
</dl>
|
|
@@ -3758,7 +4044,7 @@ await client.orders.updateFulfill("580e63e98c9a982ac9b8b741", "5e8518516e1470407
|
|
|
3758
4044
|
<dl>
|
|
3759
4045
|
<dd>
|
|
3760
4046
|
|
|
3761
|
-
**request:** `Webflow.
|
|
4047
|
+
**request:** `Webflow.ProductsCreateSkuRequest`
|
|
3762
4048
|
|
|
3763
4049
|
</dd>
|
|
3764
4050
|
</dl>
|
|
@@ -3766,7 +4052,7 @@ await client.orders.updateFulfill("580e63e98c9a982ac9b8b741", "5e8518516e1470407
|
|
|
3766
4052
|
<dl>
|
|
3767
4053
|
<dd>
|
|
3768
4054
|
|
|
3769
|
-
**requestOptions:** `
|
|
4055
|
+
**requestOptions:** `Products.RequestOptions`
|
|
3770
4056
|
|
|
3771
4057
|
</dd>
|
|
3772
4058
|
</dl>
|
|
@@ -3777,7 +4063,7 @@ await client.orders.updateFulfill("580e63e98c9a982ac9b8b741", "5e8518516e1470407
|
|
|
3777
4063
|
</dl>
|
|
3778
4064
|
</details>
|
|
3779
4065
|
|
|
3780
|
-
<details><summary><code>client.
|
|
4066
|
+
<details><summary><code>client.products.<a href="/src/api/resources/products/client/Client.ts">updateSku</a>(siteId, productId, skuId, { ...params }) -> Webflow.Sku</code></summary>
|
|
3781
4067
|
<dl>
|
|
3782
4068
|
<dd>
|
|
3783
4069
|
|
|
@@ -3789,7 +4075,9 @@ await client.orders.updateFulfill("580e63e98c9a982ac9b8b741", "5e8518516e1470407
|
|
|
3789
4075
|
<dl>
|
|
3790
4076
|
<dd>
|
|
3791
4077
|
|
|
3792
|
-
|
|
4078
|
+
Update a specified SKU.
|
|
4079
|
+
|
|
4080
|
+
Updating an existing SKU will set the Product type to `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer.
|
|
3793
4081
|
|
|
3794
4082
|
Required scope | `ecommerce:write`
|
|
3795
4083
|
|
|
@@ -3807,7 +4095,9 @@ Required scope | `ecommerce:write`
|
|
|
3807
4095
|
<dd>
|
|
3808
4096
|
|
|
3809
4097
|
```typescript
|
|
3810
|
-
await client.
|
|
4098
|
+
await client.products.updateSku("580e63e98c9a982ac9b8b741", "580e63fc8c9a982ac9b8b745", "5e8518516e147040726cc415", {
|
|
4099
|
+
sku: {},
|
|
4100
|
+
});
|
|
3811
4101
|
```
|
|
3812
4102
|
|
|
3813
4103
|
</dd>
|
|
@@ -3831,7 +4121,7 @@ await client.orders.updateUnfulfill("580e63e98c9a982ac9b8b741", "5e8518516e14704
|
|
|
3831
4121
|
<dl>
|
|
3832
4122
|
<dd>
|
|
3833
4123
|
|
|
3834
|
-
**
|
|
4124
|
+
**productId:** `string` — Unique identifier for a Product
|
|
3835
4125
|
|
|
3836
4126
|
</dd>
|
|
3837
4127
|
</dl>
|
|
@@ -3839,7 +4129,23 @@ await client.orders.updateUnfulfill("580e63e98c9a982ac9b8b741", "5e8518516e14704
|
|
|
3839
4129
|
<dl>
|
|
3840
4130
|
<dd>
|
|
3841
4131
|
|
|
3842
|
-
**
|
|
4132
|
+
**skuId:** `string` — Unique identifier for a SKU
|
|
4133
|
+
|
|
4134
|
+
</dd>
|
|
4135
|
+
</dl>
|
|
4136
|
+
|
|
4137
|
+
<dl>
|
|
4138
|
+
<dd>
|
|
4139
|
+
|
|
4140
|
+
**request:** `Webflow.ProductsUpdateSkuRequest`
|
|
4141
|
+
|
|
4142
|
+
</dd>
|
|
4143
|
+
</dl>
|
|
4144
|
+
|
|
4145
|
+
<dl>
|
|
4146
|
+
<dd>
|
|
4147
|
+
|
|
4148
|
+
**requestOptions:** `Products.RequestOptions`
|
|
3843
4149
|
|
|
3844
4150
|
</dd>
|
|
3845
4151
|
</dl>
|
|
@@ -3850,7 +4156,9 @@ await client.orders.updateUnfulfill("580e63e98c9a982ac9b8b741", "5e8518516e14704
|
|
|
3850
4156
|
</dl>
|
|
3851
4157
|
</details>
|
|
3852
4158
|
|
|
3853
|
-
|
|
4159
|
+
## Orders
|
|
4160
|
+
|
|
4161
|
+
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">list</a>(siteId, { ...params }) -> Webflow.OrderList</code></summary>
|
|
3854
4162
|
<dl>
|
|
3855
4163
|
<dd>
|
|
3856
4164
|
|
|
@@ -3862,10 +4170,9 @@ await client.orders.updateUnfulfill("580e63e98c9a982ac9b8b741", "5e8518516e14704
|
|
|
3862
4170
|
<dl>
|
|
3863
4171
|
<dd>
|
|
3864
4172
|
|
|
3865
|
-
|
|
3866
|
-
customer. It will also set the order's status to `refunded`.
|
|
4173
|
+
List all orders created for a given site.
|
|
3867
4174
|
|
|
3868
|
-
Required scope | `ecommerce:
|
|
4175
|
+
Required scope | `ecommerce:read`
|
|
3869
4176
|
|
|
3870
4177
|
</dd>
|
|
3871
4178
|
</dl>
|
|
@@ -3881,7 +4188,7 @@ Required scope | `ecommerce:write`
|
|
|
3881
4188
|
<dd>
|
|
3882
4189
|
|
|
3883
4190
|
```typescript
|
|
3884
|
-
await client.orders.
|
|
4191
|
+
await client.orders.list("580e63e98c9a982ac9b8b741");
|
|
3885
4192
|
```
|
|
3886
4193
|
|
|
3887
4194
|
</dd>
|
|
@@ -3905,15 +4212,7 @@ await client.orders.refund("580e63e98c9a982ac9b8b741", "5e8518516e147040726cc415
|
|
|
3905
4212
|
<dl>
|
|
3906
4213
|
<dd>
|
|
3907
4214
|
|
|
3908
|
-
**
|
|
3909
|
-
|
|
3910
|
-
</dd>
|
|
3911
|
-
</dl>
|
|
3912
|
-
|
|
3913
|
-
<dl>
|
|
3914
|
-
<dd>
|
|
3915
|
-
|
|
3916
|
-
**request:** `Webflow.OrdersRefundRequest`
|
|
4215
|
+
**request:** `Webflow.OrdersListRequest`
|
|
3917
4216
|
|
|
3918
4217
|
</dd>
|
|
3919
4218
|
</dl>
|
|
@@ -3932,9 +4231,7 @@ await client.orders.refund("580e63e98c9a982ac9b8b741", "5e8518516e147040726cc415
|
|
|
3932
4231
|
</dl>
|
|
3933
4232
|
</details>
|
|
3934
4233
|
|
|
3935
|
-
|
|
3936
|
-
|
|
3937
|
-
<details><summary><code>client.inventory.<a href="/src/api/resources/inventory/client/Client.ts">list</a>(collectionId, itemId) -> Webflow.InventoryItem</code></summary>
|
|
4234
|
+
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">get</a>(siteId, orderId) -> Webflow.Order</code></summary>
|
|
3938
4235
|
<dl>
|
|
3939
4236
|
<dd>
|
|
3940
4237
|
|
|
@@ -3946,7 +4243,8 @@ await client.orders.refund("580e63e98c9a982ac9b8b741", "5e8518516e147040726cc415
|
|
|
3946
4243
|
<dl>
|
|
3947
4244
|
<dd>
|
|
3948
4245
|
|
|
3949
|
-
|
|
4246
|
+
Retrieve a single product by its ID. All of its SKUs will also be
|
|
4247
|
+
retrieved.
|
|
3950
4248
|
|
|
3951
4249
|
Required scope | `ecommerce:read`
|
|
3952
4250
|
|
|
@@ -3964,7 +4262,7 @@ Required scope | `ecommerce:read`
|
|
|
3964
4262
|
<dd>
|
|
3965
4263
|
|
|
3966
4264
|
```typescript
|
|
3967
|
-
await client.
|
|
4265
|
+
await client.orders.get("580e63e98c9a982ac9b8b741", "5e8518516e147040726cc415");
|
|
3968
4266
|
```
|
|
3969
4267
|
|
|
3970
4268
|
</dd>
|
|
@@ -3980,7 +4278,7 @@ await client.inventory.list("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b75
|
|
|
3980
4278
|
<dl>
|
|
3981
4279
|
<dd>
|
|
3982
4280
|
|
|
3983
|
-
**
|
|
4281
|
+
**siteId:** `string` — Unique identifier for a Site
|
|
3984
4282
|
|
|
3985
4283
|
</dd>
|
|
3986
4284
|
</dl>
|
|
@@ -3988,7 +4286,7 @@ await client.inventory.list("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b75
|
|
|
3988
4286
|
<dl>
|
|
3989
4287
|
<dd>
|
|
3990
4288
|
|
|
3991
|
-
**
|
|
4289
|
+
**orderId:** `string` — Unique identifier for an Order
|
|
3992
4290
|
|
|
3993
4291
|
</dd>
|
|
3994
4292
|
</dl>
|
|
@@ -3996,7 +4294,7 @@ await client.inventory.list("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b75
|
|
|
3996
4294
|
<dl>
|
|
3997
4295
|
<dd>
|
|
3998
4296
|
|
|
3999
|
-
**requestOptions:** `
|
|
4297
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
4000
4298
|
|
|
4001
4299
|
</dd>
|
|
4002
4300
|
</dl>
|
|
@@ -4007,7 +4305,7 @@ await client.inventory.list("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b75
|
|
|
4007
4305
|
</dl>
|
|
4008
4306
|
</details>
|
|
4009
4307
|
|
|
4010
|
-
<details><summary><code>client.
|
|
4308
|
+
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">update</a>(siteId, orderId, { ...params }) -> Webflow.Order</code></summary>
|
|
4011
4309
|
<dl>
|
|
4012
4310
|
<dd>
|
|
4013
4311
|
|
|
@@ -4019,12 +4317,9 @@ await client.inventory.list("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b75
|
|
|
4019
4317
|
<dl>
|
|
4020
4318
|
<dd>
|
|
4021
4319
|
|
|
4022
|
-
|
|
4023
|
-
|
|
4024
|
-
|
|
4025
|
-
|
|
4026
|
-
- Absolute updates are done by setting `quantity` directly.
|
|
4027
|
-
- Incremental updates are by specifying the inventory delta in `updateQuantity` which is then added to the `quantity` stored on the server.
|
|
4320
|
+
This API lets you update the fields, `comment`, `shippingProvider`,
|
|
4321
|
+
and/or `shippingTracking` for a given order. All three fields can be
|
|
4322
|
+
updated simultaneously or independently.
|
|
4028
4323
|
|
|
4029
4324
|
Required scope | `ecommerce:write`
|
|
4030
4325
|
|
|
@@ -4042,9 +4337,7 @@ Required scope | `ecommerce:write`
|
|
|
4042
4337
|
<dd>
|
|
4043
4338
|
|
|
4044
4339
|
```typescript
|
|
4045
|
-
await client.
|
|
4046
|
-
inventoryType: "infinite",
|
|
4047
|
-
});
|
|
4340
|
+
await client.orders.update("580e63e98c9a982ac9b8b741", "5e8518516e147040726cc415");
|
|
4048
4341
|
```
|
|
4049
4342
|
|
|
4050
4343
|
</dd>
|
|
@@ -4060,7 +4353,7 @@ await client.inventory.update("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b
|
|
|
4060
4353
|
<dl>
|
|
4061
4354
|
<dd>
|
|
4062
4355
|
|
|
4063
|
-
**
|
|
4356
|
+
**siteId:** `string` — Unique identifier for a Site
|
|
4064
4357
|
|
|
4065
4358
|
</dd>
|
|
4066
4359
|
</dl>
|
|
@@ -4068,7 +4361,7 @@ await client.inventory.update("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b
|
|
|
4068
4361
|
<dl>
|
|
4069
4362
|
<dd>
|
|
4070
4363
|
|
|
4071
|
-
**
|
|
4364
|
+
**orderId:** `string` — Unique identifier for an Order
|
|
4072
4365
|
|
|
4073
4366
|
</dd>
|
|
4074
4367
|
</dl>
|
|
@@ -4076,7 +4369,7 @@ await client.inventory.update("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b
|
|
|
4076
4369
|
<dl>
|
|
4077
4370
|
<dd>
|
|
4078
4371
|
|
|
4079
|
-
**request:** `Webflow.
|
|
4372
|
+
**request:** `Webflow.OrdersUpdateRequest`
|
|
4080
4373
|
|
|
4081
4374
|
</dd>
|
|
4082
4375
|
</dl>
|
|
@@ -4084,7 +4377,7 @@ await client.inventory.update("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b
|
|
|
4084
4377
|
<dl>
|
|
4085
4378
|
<dd>
|
|
4086
4379
|
|
|
4087
|
-
**requestOptions:** `
|
|
4380
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
4088
4381
|
|
|
4089
4382
|
</dd>
|
|
4090
4383
|
</dl>
|
|
@@ -4095,9 +4388,7 @@ await client.inventory.update("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b
|
|
|
4095
4388
|
</dl>
|
|
4096
4389
|
</details>
|
|
4097
4390
|
|
|
4098
|
-
|
|
4099
|
-
|
|
4100
|
-
<details><summary><code>client.ecommerce.<a href="/src/api/resources/ecommerce/client/Client.ts">getSettings</a>(siteId) -> Webflow.EcommerceSettings</code></summary>
|
|
4391
|
+
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">updateFulfill</a>(siteId, orderId, { ...params }) -> Webflow.Order</code></summary>
|
|
4101
4392
|
<dl>
|
|
4102
4393
|
<dd>
|
|
4103
4394
|
|
|
@@ -4109,9 +4400,9 @@ await client.inventory.update("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b
|
|
|
4109
4400
|
<dl>
|
|
4110
4401
|
<dd>
|
|
4111
4402
|
|
|
4112
|
-
|
|
4403
|
+
Updates an order's status to fulfilled
|
|
4113
4404
|
|
|
4114
|
-
Required scope | `ecommerce:
|
|
4405
|
+
Required scope | `ecommerce:write`
|
|
4115
4406
|
|
|
4116
4407
|
</dd>
|
|
4117
4408
|
</dl>
|
|
@@ -4127,7 +4418,7 @@ Required scope | `ecommerce:read`
|
|
|
4127
4418
|
<dd>
|
|
4128
4419
|
|
|
4129
4420
|
```typescript
|
|
4130
|
-
await client.
|
|
4421
|
+
await client.orders.updateFulfill("580e63e98c9a982ac9b8b741", "5e8518516e147040726cc415");
|
|
4131
4422
|
```
|
|
4132
4423
|
|
|
4133
4424
|
</dd>
|
|
@@ -4151,20 +4442,34 @@ await client.ecommerce.getSettings("580e63e98c9a982ac9b8b741");
|
|
|
4151
4442
|
<dl>
|
|
4152
4443
|
<dd>
|
|
4153
4444
|
|
|
4154
|
-
**
|
|
4445
|
+
**orderId:** `string` — Unique identifier for an Order
|
|
4155
4446
|
|
|
4156
4447
|
</dd>
|
|
4157
4448
|
</dl>
|
|
4449
|
+
|
|
4450
|
+
<dl>
|
|
4451
|
+
<dd>
|
|
4452
|
+
|
|
4453
|
+
**request:** `Webflow.OrdersUpdateFulfillRequest`
|
|
4454
|
+
|
|
4158
4455
|
</dd>
|
|
4159
4456
|
</dl>
|
|
4160
4457
|
|
|
4458
|
+
<dl>
|
|
4459
|
+
<dd>
|
|
4460
|
+
|
|
4461
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
4462
|
+
|
|
4463
|
+
</dd>
|
|
4464
|
+
</dl>
|
|
4161
4465
|
</dd>
|
|
4162
4466
|
</dl>
|
|
4163
|
-
</details>
|
|
4164
4467
|
|
|
4165
|
-
|
|
4468
|
+
</dd>
|
|
4469
|
+
</dl>
|
|
4470
|
+
</details>
|
|
4166
4471
|
|
|
4167
|
-
<details><summary><code>client.
|
|
4472
|
+
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">updateUnfulfill</a>(siteId, orderId) -> Webflow.Order</code></summary>
|
|
4168
4473
|
<dl>
|
|
4169
4474
|
<dd>
|
|
4170
4475
|
|
|
@@ -4176,16 +4481,9 @@ await client.ecommerce.getSettings("580e63e98c9a982ac9b8b741");
|
|
|
4176
4481
|
<dl>
|
|
4177
4482
|
<dd>
|
|
4178
4483
|
|
|
4179
|
-
|
|
4180
|
-
|
|
4181
|
-
Slugs must be all lowercase letters without spaces.
|
|
4182
|
-
If you pass a string with uppercase letters and/or spaces to the "Slug" property, Webflow will
|
|
4183
|
-
convert the slug to lowercase and replace spaces with "-."
|
|
4184
|
-
|
|
4185
|
-
Only some field types can be created through the API.
|
|
4186
|
-
This endpoint does not currently support bulk creation.
|
|
4484
|
+
Updates an order's status to unfulfilled
|
|
4187
4485
|
|
|
4188
|
-
Required scope | `
|
|
4486
|
+
Required scope | `ecommerce:write`
|
|
4189
4487
|
|
|
4190
4488
|
</dd>
|
|
4191
4489
|
</dl>
|
|
@@ -4201,12 +4499,7 @@ Required scope | `cms:write`
|
|
|
4201
4499
|
<dd>
|
|
4202
4500
|
|
|
4203
4501
|
```typescript
|
|
4204
|
-
await client.
|
|
4205
|
-
isRequired: false,
|
|
4206
|
-
type: "RichText",
|
|
4207
|
-
displayName: "Post Body",
|
|
4208
|
-
helpText: "Add the body of your post here",
|
|
4209
|
-
});
|
|
4502
|
+
await client.orders.updateUnfulfill("580e63e98c9a982ac9b8b741", "5e8518516e147040726cc415");
|
|
4210
4503
|
```
|
|
4211
4504
|
|
|
4212
4505
|
</dd>
|
|
@@ -4222,7 +4515,7 @@ await client.collections.fields.create("580e63fc8c9a982ac9b8b745", {
|
|
|
4222
4515
|
<dl>
|
|
4223
4516
|
<dd>
|
|
4224
4517
|
|
|
4225
|
-
**
|
|
4518
|
+
**siteId:** `string` — Unique identifier for a Site
|
|
4226
4519
|
|
|
4227
4520
|
</dd>
|
|
4228
4521
|
</dl>
|
|
@@ -4230,7 +4523,7 @@ await client.collections.fields.create("580e63fc8c9a982ac9b8b745", {
|
|
|
4230
4523
|
<dl>
|
|
4231
4524
|
<dd>
|
|
4232
4525
|
|
|
4233
|
-
**
|
|
4526
|
+
**orderId:** `string` — Unique identifier for an Order
|
|
4234
4527
|
|
|
4235
4528
|
</dd>
|
|
4236
4529
|
</dl>
|
|
@@ -4238,7 +4531,7 @@ await client.collections.fields.create("580e63fc8c9a982ac9b8b745", {
|
|
|
4238
4531
|
<dl>
|
|
4239
4532
|
<dd>
|
|
4240
4533
|
|
|
4241
|
-
**requestOptions:** `
|
|
4534
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
4242
4535
|
|
|
4243
4536
|
</dd>
|
|
4244
4537
|
</dl>
|
|
@@ -4249,7 +4542,7 @@ await client.collections.fields.create("580e63fc8c9a982ac9b8b745", {
|
|
|
4249
4542
|
</dl>
|
|
4250
4543
|
</details>
|
|
4251
4544
|
|
|
4252
|
-
<details><summary><code>client.
|
|
4545
|
+
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">refund</a>(siteId, orderId, { ...params }) -> Webflow.Order</code></summary>
|
|
4253
4546
|
<dl>
|
|
4254
4547
|
<dd>
|
|
4255
4548
|
|
|
@@ -4261,9 +4554,10 @@ await client.collections.fields.create("580e63fc8c9a982ac9b8b745", {
|
|
|
4261
4554
|
<dl>
|
|
4262
4555
|
<dd>
|
|
4263
4556
|
|
|
4264
|
-
|
|
4557
|
+
This API will reverse a Stripe charge and refund an order back to a
|
|
4558
|
+
customer. It will also set the order's status to `refunded`.
|
|
4265
4559
|
|
|
4266
|
-
Required scope | `
|
|
4560
|
+
Required scope | `ecommerce:write`
|
|
4267
4561
|
|
|
4268
4562
|
</dd>
|
|
4269
4563
|
</dl>
|
|
@@ -4279,7 +4573,7 @@ Required scope | `cms:write`
|
|
|
4279
4573
|
<dd>
|
|
4280
4574
|
|
|
4281
4575
|
```typescript
|
|
4282
|
-
await client.
|
|
4576
|
+
await client.orders.refund("580e63e98c9a982ac9b8b741", "5e8518516e147040726cc415");
|
|
4283
4577
|
```
|
|
4284
4578
|
|
|
4285
4579
|
</dd>
|
|
@@ -4295,7 +4589,7 @@ await client.collections.fields.delete("580e63fc8c9a982ac9b8b745", "580e63fc8c9a
|
|
|
4295
4589
|
<dl>
|
|
4296
4590
|
<dd>
|
|
4297
4591
|
|
|
4298
|
-
**
|
|
4592
|
+
**siteId:** `string` — Unique identifier for a Site
|
|
4299
4593
|
|
|
4300
4594
|
</dd>
|
|
4301
4595
|
</dl>
|
|
@@ -4303,7 +4597,7 @@ await client.collections.fields.delete("580e63fc8c9a982ac9b8b745", "580e63fc8c9a
|
|
|
4303
4597
|
<dl>
|
|
4304
4598
|
<dd>
|
|
4305
4599
|
|
|
4306
|
-
**
|
|
4600
|
+
**orderId:** `string` — Unique identifier for an Order
|
|
4307
4601
|
|
|
4308
4602
|
</dd>
|
|
4309
4603
|
</dl>
|
|
@@ -4311,7 +4605,15 @@ await client.collections.fields.delete("580e63fc8c9a982ac9b8b745", "580e63fc8c9a
|
|
|
4311
4605
|
<dl>
|
|
4312
4606
|
<dd>
|
|
4313
4607
|
|
|
4314
|
-
**
|
|
4608
|
+
**request:** `Webflow.OrdersRefundRequest`
|
|
4609
|
+
|
|
4610
|
+
</dd>
|
|
4611
|
+
</dl>
|
|
4612
|
+
|
|
4613
|
+
<dl>
|
|
4614
|
+
<dd>
|
|
4615
|
+
|
|
4616
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
4315
4617
|
|
|
4316
4618
|
</dd>
|
|
4317
4619
|
</dl>
|
|
@@ -4322,7 +4624,9 @@ await client.collections.fields.delete("580e63fc8c9a982ac9b8b745", "580e63fc8c9a
|
|
|
4322
4624
|
</dl>
|
|
4323
4625
|
</details>
|
|
4324
4626
|
|
|
4325
|
-
|
|
4627
|
+
## Inventory
|
|
4628
|
+
|
|
4629
|
+
<details><summary><code>client.inventory.<a href="/src/api/resources/inventory/client/Client.ts">list</a>(collectionId, itemId) -> Webflow.InventoryItem</code></summary>
|
|
4326
4630
|
<dl>
|
|
4327
4631
|
<dd>
|
|
4328
4632
|
|
|
@@ -4334,9 +4638,9 @@ await client.collections.fields.delete("580e63fc8c9a982ac9b8b745", "580e63fc8c9a
|
|
|
4334
4638
|
<dl>
|
|
4335
4639
|
<dd>
|
|
4336
4640
|
|
|
4337
|
-
|
|
4641
|
+
List the current inventory levels for a particular SKU item.
|
|
4338
4642
|
|
|
4339
|
-
Required scope | `
|
|
4643
|
+
Required scope | `ecommerce:read`
|
|
4340
4644
|
|
|
4341
4645
|
</dd>
|
|
4342
4646
|
</dl>
|
|
@@ -4352,11 +4656,7 @@ Required scope | `cms:write`
|
|
|
4352
4656
|
<dd>
|
|
4353
4657
|
|
|
4354
4658
|
```typescript
|
|
4355
|
-
await client.
|
|
4356
|
-
isRequired: false,
|
|
4357
|
-
displayName: "Post Body",
|
|
4358
|
-
helpText: "Add the body of your post here",
|
|
4359
|
-
});
|
|
4659
|
+
await client.inventory.list("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754");
|
|
4360
4660
|
```
|
|
4361
4661
|
|
|
4362
4662
|
</dd>
|
|
@@ -4380,15 +4680,7 @@ await client.collections.fields.update("580e63fc8c9a982ac9b8b745", "580e63fc8c9a
|
|
|
4380
4680
|
<dl>
|
|
4381
4681
|
<dd>
|
|
4382
4682
|
|
|
4383
|
-
**
|
|
4384
|
-
|
|
4385
|
-
</dd>
|
|
4386
|
-
</dl>
|
|
4387
|
-
|
|
4388
|
-
<dl>
|
|
4389
|
-
<dd>
|
|
4390
|
-
|
|
4391
|
-
**request:** `Webflow.collections.FieldUpdate`
|
|
4683
|
+
**itemId:** `string` — Unique identifier for an Item
|
|
4392
4684
|
|
|
4393
4685
|
</dd>
|
|
4394
4686
|
</dl>
|
|
@@ -4396,7 +4688,7 @@ await client.collections.fields.update("580e63fc8c9a982ac9b8b745", "580e63fc8c9a
|
|
|
4396
4688
|
<dl>
|
|
4397
4689
|
<dd>
|
|
4398
4690
|
|
|
4399
|
-
**requestOptions:** `
|
|
4691
|
+
**requestOptions:** `Inventory.RequestOptions`
|
|
4400
4692
|
|
|
4401
4693
|
</dd>
|
|
4402
4694
|
</dl>
|
|
@@ -4407,9 +4699,7 @@ await client.collections.fields.update("580e63fc8c9a982ac9b8b745", "580e63fc8c9a
|
|
|
4407
4699
|
</dl>
|
|
4408
4700
|
</details>
|
|
4409
4701
|
|
|
4410
|
-
|
|
4411
|
-
|
|
4412
|
-
<details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">listItems</a>(collectionId, { ...params }) -> Webflow.CollectionItemList</code></summary>
|
|
4702
|
+
<details><summary><code>client.inventory.<a href="/src/api/resources/inventory/client/Client.ts">update</a>(collectionId, itemId, { ...params }) -> Webflow.InventoryItem</code></summary>
|
|
4413
4703
|
<dl>
|
|
4414
4704
|
<dd>
|
|
4415
4705
|
|
|
@@ -4421,9 +4711,14 @@ await client.collections.fields.update("580e63fc8c9a982ac9b8b745", "580e63fc8c9a
|
|
|
4421
4711
|
<dl>
|
|
4422
4712
|
<dd>
|
|
4423
4713
|
|
|
4424
|
-
|
|
4714
|
+
Updates the current inventory levels for a particular SKU item.
|
|
4425
4715
|
|
|
4426
|
-
|
|
4716
|
+
Updates may be given in one or two methods, absolutely or incrementally.
|
|
4717
|
+
|
|
4718
|
+
- Absolute updates are done by setting `quantity` directly.
|
|
4719
|
+
- Incremental updates are by specifying the inventory delta in `updateQuantity` which is then added to the `quantity` stored on the server.
|
|
4720
|
+
|
|
4721
|
+
Required scope | `ecommerce:write`
|
|
4427
4722
|
|
|
4428
4723
|
</dd>
|
|
4429
4724
|
</dl>
|
|
@@ -4439,7 +4734,9 @@ Required scope | `CMS:read`
|
|
|
4439
4734
|
<dd>
|
|
4440
4735
|
|
|
4441
4736
|
```typescript
|
|
4442
|
-
await client.
|
|
4737
|
+
await client.inventory.update("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754", {
|
|
4738
|
+
inventoryType: "infinite",
|
|
4739
|
+
});
|
|
4443
4740
|
```
|
|
4444
4741
|
|
|
4445
4742
|
</dd>
|
|
@@ -4463,7 +4760,7 @@ await client.collections.items.listItems("580e63fc8c9a982ac9b8b745");
|
|
|
4463
4760
|
<dl>
|
|
4464
4761
|
<dd>
|
|
4465
4762
|
|
|
4466
|
-
**
|
|
4763
|
+
**itemId:** `string` — Unique identifier for an Item
|
|
4467
4764
|
|
|
4468
4765
|
</dd>
|
|
4469
4766
|
</dl>
|
|
@@ -4471,7 +4768,15 @@ await client.collections.items.listItems("580e63fc8c9a982ac9b8b745");
|
|
|
4471
4768
|
<dl>
|
|
4472
4769
|
<dd>
|
|
4473
4770
|
|
|
4474
|
-
**
|
|
4771
|
+
**request:** `Webflow.InventoryUpdateRequest`
|
|
4772
|
+
|
|
4773
|
+
</dd>
|
|
4774
|
+
</dl>
|
|
4775
|
+
|
|
4776
|
+
<dl>
|
|
4777
|
+
<dd>
|
|
4778
|
+
|
|
4779
|
+
**requestOptions:** `Inventory.RequestOptions`
|
|
4475
4780
|
|
|
4476
4781
|
</dd>
|
|
4477
4782
|
</dl>
|
|
@@ -4482,7 +4787,9 @@ await client.collections.items.listItems("580e63fc8c9a982ac9b8b745");
|
|
|
4482
4787
|
</dl>
|
|
4483
4788
|
</details>
|
|
4484
4789
|
|
|
4485
|
-
|
|
4790
|
+
## Ecommerce
|
|
4791
|
+
|
|
4792
|
+
<details><summary><code>client.ecommerce.<a href="/src/api/resources/ecommerce/client/Client.ts">getSettings</a>(siteId) -> Webflow.EcommerceSettings</code></summary>
|
|
4486
4793
|
<dl>
|
|
4487
4794
|
<dd>
|
|
4488
4795
|
|
|
@@ -4494,11 +4801,9 @@ await client.collections.items.listItems("580e63fc8c9a982ac9b8b745");
|
|
|
4494
4801
|
<dl>
|
|
4495
4802
|
<dd>
|
|
4496
4803
|
|
|
4497
|
-
|
|
4498
|
-
|
|
4499
|
-
To create items across multiple locales, please use [this endpoint.](/data/v2.0.0/reference/cms/collection-items/bulk-items/create-items)
|
|
4804
|
+
Retrieve ecommerce settings for a site.
|
|
4500
4805
|
|
|
4501
|
-
Required scope | `
|
|
4806
|
+
Required scope | `ecommerce:read`
|
|
4502
4807
|
|
|
4503
4808
|
</dd>
|
|
4504
4809
|
</dl>
|
|
@@ -4514,14 +4819,7 @@ Required scope | `CMS:write`
|
|
|
4514
4819
|
<dd>
|
|
4515
4820
|
|
|
4516
4821
|
```typescript
|
|
4517
|
-
await client.
|
|
4518
|
-
isArchived: false,
|
|
4519
|
-
isDraft: false,
|
|
4520
|
-
fieldData: {
|
|
4521
|
-
name: "Pan Galactic Gargle Blaster Recipe",
|
|
4522
|
-
slug: "pan-galactic-gargle-blaster",
|
|
4523
|
-
},
|
|
4524
|
-
});
|
|
4822
|
+
await client.ecommerce.getSettings("580e63e98c9a982ac9b8b741");
|
|
4525
4823
|
```
|
|
4526
4824
|
|
|
4527
4825
|
</dd>
|
|
@@ -4537,15 +4835,7 @@ await client.collections.items.createItem("580e63fc8c9a982ac9b8b745", {
|
|
|
4537
4835
|
<dl>
|
|
4538
4836
|
<dd>
|
|
4539
4837
|
|
|
4540
|
-
**
|
|
4541
|
-
|
|
4542
|
-
</dd>
|
|
4543
|
-
</dl>
|
|
4544
|
-
|
|
4545
|
-
<dl>
|
|
4546
|
-
<dd>
|
|
4547
|
-
|
|
4548
|
-
**request:** `Webflow.ItemsCreateItemRequest`
|
|
4838
|
+
**siteId:** `string` — Unique identifier for a Site
|
|
4549
4839
|
|
|
4550
4840
|
</dd>
|
|
4551
4841
|
</dl>
|
|
@@ -4553,7 +4843,7 @@ await client.collections.items.createItem("580e63fc8c9a982ac9b8b745", {
|
|
|
4553
4843
|
<dl>
|
|
4554
4844
|
<dd>
|
|
4555
4845
|
|
|
4556
|
-
**requestOptions:** `
|
|
4846
|
+
**requestOptions:** `Ecommerce.RequestOptions`
|
|
4557
4847
|
|
|
4558
4848
|
</dd>
|
|
4559
4849
|
</dl>
|
|
@@ -4564,7 +4854,9 @@ await client.collections.items.createItem("580e63fc8c9a982ac9b8b745", {
|
|
|
4564
4854
|
</dl>
|
|
4565
4855
|
</details>
|
|
4566
4856
|
|
|
4567
|
-
|
|
4857
|
+
## Collections Fields
|
|
4858
|
+
|
|
4859
|
+
<details><summary><code>client.collections.fields.<a href="/src/api/resources/collections/resources/fields/client/Client.ts">create</a>(collectionId, { ...params }) -> Webflow.Field</code></summary>
|
|
4568
4860
|
<dl>
|
|
4569
4861
|
<dd>
|
|
4570
4862
|
|
|
@@ -4576,11 +4868,16 @@ await client.collections.items.createItem("580e63fc8c9a982ac9b8b745", {
|
|
|
4576
4868
|
<dl>
|
|
4577
4869
|
<dd>
|
|
4578
4870
|
|
|
4579
|
-
|
|
4871
|
+
Create a custom field in a collection.
|
|
4580
4872
|
|
|
4581
|
-
|
|
4873
|
+
Slugs must be all lowercase letters without spaces.
|
|
4874
|
+
If you pass a string with uppercase letters and/or spaces to the "Slug" property, Webflow will
|
|
4875
|
+
convert the slug to lowercase and replace spaces with "-."
|
|
4582
4876
|
|
|
4583
|
-
|
|
4877
|
+
Only some field types can be created through the API.
|
|
4878
|
+
This endpoint does not currently support bulk creation.
|
|
4879
|
+
|
|
4880
|
+
Required scope | `cms:write`
|
|
4584
4881
|
|
|
4585
4882
|
</dd>
|
|
4586
4883
|
</dl>
|
|
@@ -4596,7 +4893,12 @@ Required scope | `CMS:write`
|
|
|
4596
4893
|
<dd>
|
|
4597
4894
|
|
|
4598
4895
|
```typescript
|
|
4599
|
-
await client.collections.
|
|
4896
|
+
await client.collections.fields.create("580e63fc8c9a982ac9b8b745", {
|
|
4897
|
+
isRequired: false,
|
|
4898
|
+
type: "RichText",
|
|
4899
|
+
displayName: "Post Body",
|
|
4900
|
+
helpText: "Add the body of your post here",
|
|
4901
|
+
});
|
|
4600
4902
|
```
|
|
4601
4903
|
|
|
4602
4904
|
</dd>
|
|
@@ -4620,7 +4922,7 @@ await client.collections.items.deleteItems("580e63fc8c9a982ac9b8b745");
|
|
|
4620
4922
|
<dl>
|
|
4621
4923
|
<dd>
|
|
4622
4924
|
|
|
4623
|
-
**request:** `Webflow.collections.
|
|
4925
|
+
**request:** `Webflow.collections.FieldCreate`
|
|
4624
4926
|
|
|
4625
4927
|
</dd>
|
|
4626
4928
|
</dl>
|
|
@@ -4628,7 +4930,7 @@ await client.collections.items.deleteItems("580e63fc8c9a982ac9b8b745");
|
|
|
4628
4930
|
<dl>
|
|
4629
4931
|
<dd>
|
|
4630
4932
|
|
|
4631
|
-
**requestOptions:** `
|
|
4933
|
+
**requestOptions:** `Fields.RequestOptions`
|
|
4632
4934
|
|
|
4633
4935
|
</dd>
|
|
4634
4936
|
</dl>
|
|
@@ -4639,7 +4941,7 @@ await client.collections.items.deleteItems("580e63fc8c9a982ac9b8b745");
|
|
|
4639
4941
|
</dl>
|
|
4640
4942
|
</details>
|
|
4641
4943
|
|
|
4642
|
-
<details><summary><code>client.collections.
|
|
4944
|
+
<details><summary><code>client.collections.fields.<a href="/src/api/resources/collections/resources/fields/client/Client.ts">delete</a>(collectionId, fieldId) -> void</code></summary>
|
|
4643
4945
|
<dl>
|
|
4644
4946
|
<dd>
|
|
4645
4947
|
|
|
@@ -4651,11 +4953,9 @@ await client.collections.items.deleteItems("580e63fc8c9a982ac9b8b745");
|
|
|
4651
4953
|
<dl>
|
|
4652
4954
|
<dd>
|
|
4653
4955
|
|
|
4654
|
-
|
|
4655
|
-
|
|
4656
|
-
**Note:** If the `cmsLocaleId` parameter is undefined or empty and the items are localized, items will be updated only in the primary locale.
|
|
4956
|
+
Delete a custom field in a collection. This endpoint does not currently support bulk deletion.
|
|
4657
4957
|
|
|
4658
|
-
Required scope | `
|
|
4958
|
+
Required scope | `cms:write`
|
|
4659
4959
|
|
|
4660
4960
|
</dd>
|
|
4661
4961
|
</dl>
|
|
@@ -4671,42 +4971,7 @@ Required scope | `CMS:write`
|
|
|
4671
4971
|
<dd>
|
|
4672
4972
|
|
|
4673
4973
|
```typescript
|
|
4674
|
-
await client.collections.
|
|
4675
|
-
items: [
|
|
4676
|
-
{
|
|
4677
|
-
id: "66f6ed9576ddacf3149d5ea6",
|
|
4678
|
-
cmsLocaleId: "66f6e966c9e1dc700a857ca5",
|
|
4679
|
-
fieldData: {
|
|
4680
|
-
name: "Ne Paniquez Pas",
|
|
4681
|
-
slug: "ne-paniquez-pas",
|
|
4682
|
-
},
|
|
4683
|
-
},
|
|
4684
|
-
{
|
|
4685
|
-
id: "66f6ed9576ddacf3149d5ea6",
|
|
4686
|
-
cmsLocaleId: "66f6e966c9e1dc700a857ca4",
|
|
4687
|
-
fieldData: {
|
|
4688
|
-
name: "No Entrar en P\u00E1nico",
|
|
4689
|
-
slug: "no-entrar-en-panico",
|
|
4690
|
-
},
|
|
4691
|
-
},
|
|
4692
|
-
{
|
|
4693
|
-
id: "66f6ed9576ddacf3149d5eaa",
|
|
4694
|
-
cmsLocaleId: "66f6e966c9e1dc700a857ca5",
|
|
4695
|
-
fieldData: {
|
|
4696
|
-
name: "Au Revoir et Merci pour Tous les Poissons",
|
|
4697
|
-
slug: "au-revoir-et-merci",
|
|
4698
|
-
},
|
|
4699
|
-
},
|
|
4700
|
-
{
|
|
4701
|
-
id: "66f6ed9576ddacf3149d5eaa",
|
|
4702
|
-
cmsLocaleId: "66f6e966c9e1dc700a857ca4",
|
|
4703
|
-
fieldData: {
|
|
4704
|
-
name: "Hasta Luego y Gracias por Todo el Pescado",
|
|
4705
|
-
slug: "hasta-luego-y-gracias",
|
|
4706
|
-
},
|
|
4707
|
-
},
|
|
4708
|
-
],
|
|
4709
|
-
});
|
|
4974
|
+
await client.collections.fields.delete("580e63fc8c9a982ac9b8b745", "580e63fc8c9a982ac9b8b745");
|
|
4710
4975
|
```
|
|
4711
4976
|
|
|
4712
4977
|
</dd>
|
|
@@ -4730,7 +4995,7 @@ await client.collections.items.updateItems("580e63fc8c9a982ac9b8b745", {
|
|
|
4730
4995
|
<dl>
|
|
4731
4996
|
<dd>
|
|
4732
4997
|
|
|
4733
|
-
**
|
|
4998
|
+
**fieldId:** `string` — Unique identifier for a Field in a collection
|
|
4734
4999
|
|
|
4735
5000
|
</dd>
|
|
4736
5001
|
</dl>
|
|
@@ -4738,7 +5003,7 @@ await client.collections.items.updateItems("580e63fc8c9a982ac9b8b745", {
|
|
|
4738
5003
|
<dl>
|
|
4739
5004
|
<dd>
|
|
4740
5005
|
|
|
4741
|
-
**requestOptions:** `
|
|
5006
|
+
**requestOptions:** `Fields.RequestOptions`
|
|
4742
5007
|
|
|
4743
5008
|
</dd>
|
|
4744
5009
|
</dl>
|
|
@@ -4749,7 +5014,7 @@ await client.collections.items.updateItems("580e63fc8c9a982ac9b8b745", {
|
|
|
4749
5014
|
</dl>
|
|
4750
5015
|
</details>
|
|
4751
5016
|
|
|
4752
|
-
<details><summary><code>client.collections.
|
|
5017
|
+
<details><summary><code>client.collections.fields.<a href="/src/api/resources/collections/resources/fields/client/Client.ts">update</a>(collectionId, fieldId, { ...params }) -> Webflow.Field</code></summary>
|
|
4753
5018
|
<dl>
|
|
4754
5019
|
<dd>
|
|
4755
5020
|
|
|
@@ -4761,9 +5026,9 @@ await client.collections.items.updateItems("580e63fc8c9a982ac9b8b745", {
|
|
|
4761
5026
|
<dl>
|
|
4762
5027
|
<dd>
|
|
4763
5028
|
|
|
4764
|
-
|
|
5029
|
+
Update a custom field in a collection.
|
|
4765
5030
|
|
|
4766
|
-
Required scope | `
|
|
5031
|
+
Required scope | `cms:write`
|
|
4767
5032
|
|
|
4768
5033
|
</dd>
|
|
4769
5034
|
</dl>
|
|
@@ -4779,10 +5044,14 @@ Required scope | `CMS:read`
|
|
|
4779
5044
|
<dd>
|
|
4780
5045
|
|
|
4781
5046
|
```typescript
|
|
4782
|
-
await client.collections.
|
|
4783
|
-
|
|
4784
|
-
|
|
4785
|
-
|
|
5047
|
+
await client.collections.fields.update("580e63fc8c9a982ac9b8b745", "580e63fc8c9a982ac9b8b745", {
|
|
5048
|
+
isRequired: false,
|
|
5049
|
+
displayName: "Post Body",
|
|
5050
|
+
helpText: "Add the body of your post here",
|
|
5051
|
+
});
|
|
5052
|
+
```
|
|
5053
|
+
|
|
5054
|
+
</dd>
|
|
4786
5055
|
</dl>
|
|
4787
5056
|
</dd>
|
|
4788
5057
|
</dl>
|
|
@@ -4803,7 +5072,90 @@ await client.collections.items.listItemsLive("580e63fc8c9a982ac9b8b745");
|
|
|
4803
5072
|
<dl>
|
|
4804
5073
|
<dd>
|
|
4805
5074
|
|
|
4806
|
-
**
|
|
5075
|
+
**fieldId:** `string` — Unique identifier for a Field in a collection
|
|
5076
|
+
|
|
5077
|
+
</dd>
|
|
5078
|
+
</dl>
|
|
5079
|
+
|
|
5080
|
+
<dl>
|
|
5081
|
+
<dd>
|
|
5082
|
+
|
|
5083
|
+
**request:** `Webflow.collections.FieldUpdate`
|
|
5084
|
+
|
|
5085
|
+
</dd>
|
|
5086
|
+
</dl>
|
|
5087
|
+
|
|
5088
|
+
<dl>
|
|
5089
|
+
<dd>
|
|
5090
|
+
|
|
5091
|
+
**requestOptions:** `Fields.RequestOptions`
|
|
5092
|
+
|
|
5093
|
+
</dd>
|
|
5094
|
+
</dl>
|
|
5095
|
+
</dd>
|
|
5096
|
+
</dl>
|
|
5097
|
+
|
|
5098
|
+
</dd>
|
|
5099
|
+
</dl>
|
|
5100
|
+
</details>
|
|
5101
|
+
|
|
5102
|
+
## Collections Items
|
|
5103
|
+
|
|
5104
|
+
<details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">listItems</a>(collectionId, { ...params }) -> Webflow.CollectionItemList</code></summary>
|
|
5105
|
+
<dl>
|
|
5106
|
+
<dd>
|
|
5107
|
+
|
|
5108
|
+
#### 📝 Description
|
|
5109
|
+
|
|
5110
|
+
<dl>
|
|
5111
|
+
<dd>
|
|
5112
|
+
|
|
5113
|
+
<dl>
|
|
5114
|
+
<dd>
|
|
5115
|
+
|
|
5116
|
+
List of all Items within a Collection.
|
|
5117
|
+
|
|
5118
|
+
Required scope | `CMS:read`
|
|
5119
|
+
|
|
5120
|
+
</dd>
|
|
5121
|
+
</dl>
|
|
5122
|
+
</dd>
|
|
5123
|
+
</dl>
|
|
5124
|
+
|
|
5125
|
+
#### 🔌 Usage
|
|
5126
|
+
|
|
5127
|
+
<dl>
|
|
5128
|
+
<dd>
|
|
5129
|
+
|
|
5130
|
+
<dl>
|
|
5131
|
+
<dd>
|
|
5132
|
+
|
|
5133
|
+
```typescript
|
|
5134
|
+
await client.collections.items.listItems("580e63fc8c9a982ac9b8b745");
|
|
5135
|
+
```
|
|
5136
|
+
|
|
5137
|
+
</dd>
|
|
5138
|
+
</dl>
|
|
5139
|
+
</dd>
|
|
5140
|
+
</dl>
|
|
5141
|
+
|
|
5142
|
+
#### ⚙️ Parameters
|
|
5143
|
+
|
|
5144
|
+
<dl>
|
|
5145
|
+
<dd>
|
|
5146
|
+
|
|
5147
|
+
<dl>
|
|
5148
|
+
<dd>
|
|
5149
|
+
|
|
5150
|
+
**collectionId:** `string` — Unique identifier for a Collection
|
|
5151
|
+
|
|
5152
|
+
</dd>
|
|
5153
|
+
</dl>
|
|
5154
|
+
|
|
5155
|
+
<dl>
|
|
5156
|
+
<dd>
|
|
5157
|
+
|
|
5158
|
+
**request:** `Webflow.collections.ItemsListItemsRequest`
|
|
4807
5159
|
|
|
4808
5160
|
</dd>
|
|
4809
5161
|
</dl>
|
|
@@ -4822,7 +5174,7 @@ await client.collections.items.listItemsLive("580e63fc8c9a982ac9b8b745");
|
|
|
4822
5174
|
</dl>
|
|
4823
5175
|
</details>
|
|
4824
5176
|
|
|
4825
|
-
<details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">
|
|
5177
|
+
<details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">createItem</a>(collectionId, { ...params }) -> Webflow.CollectionItem</code></summary>
|
|
4826
5178
|
<dl>
|
|
4827
5179
|
<dd>
|
|
4828
5180
|
|
|
@@ -4834,9 +5186,9 @@ await client.collections.items.listItemsLive("580e63fc8c9a982ac9b8b745");
|
|
|
4834
5186
|
<dl>
|
|
4835
5187
|
<dd>
|
|
4836
5188
|
|
|
4837
|
-
Create
|
|
5189
|
+
Create Item(s) in a Collection.
|
|
4838
5190
|
|
|
4839
|
-
To create items across multiple locales,
|
|
5191
|
+
To create items across multiple locales, please use [this endpoint.](/v2.0.0/data/reference/cms/collection-items/staged-items/create-items)
|
|
4840
5192
|
|
|
4841
5193
|
Required scope | `CMS:write`
|
|
4842
5194
|
|
|
@@ -4854,7 +5206,7 @@ Required scope | `CMS:write`
|
|
|
4854
5206
|
<dd>
|
|
4855
5207
|
|
|
4856
5208
|
```typescript
|
|
4857
|
-
await client.collections.items.
|
|
5209
|
+
await client.collections.items.createItem("580e63fc8c9a982ac9b8b745", {
|
|
4858
5210
|
isArchived: false,
|
|
4859
5211
|
isDraft: false,
|
|
4860
5212
|
fieldData: {
|
|
@@ -4885,7 +5237,7 @@ await client.collections.items.createItemLive("580e63fc8c9a982ac9b8b745", {
|
|
|
4885
5237
|
<dl>
|
|
4886
5238
|
<dd>
|
|
4887
5239
|
|
|
4888
|
-
**request:** `Webflow.
|
|
5240
|
+
**request:** `Webflow.ItemsCreateItemRequest`
|
|
4889
5241
|
|
|
4890
5242
|
</dd>
|
|
4891
5243
|
</dl>
|
|
@@ -4904,7 +5256,7 @@ await client.collections.items.createItemLive("580e63fc8c9a982ac9b8b745", {
|
|
|
4904
5256
|
</dl>
|
|
4905
5257
|
</details>
|
|
4906
5258
|
|
|
4907
|
-
<details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">
|
|
5259
|
+
<details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">deleteItems</a>(collectionId, { ...params }) -> void</code></summary>
|
|
4908
5260
|
<dl>
|
|
4909
5261
|
<dd>
|
|
4910
5262
|
|
|
@@ -4916,9 +5268,9 @@ await client.collections.items.createItemLive("580e63fc8c9a982ac9b8b745", {
|
|
|
4916
5268
|
<dl>
|
|
4917
5269
|
<dd>
|
|
4918
5270
|
|
|
4919
|
-
|
|
5271
|
+
Delete Items from a Collection.
|
|
4920
5272
|
|
|
4921
|
-
**Note:** If the `cmsLocaleId` parameter is undefined or empty and the items are localized, items will be
|
|
5273
|
+
**Note:** If the `cmsLocaleId` parameter is undefined or empty and the items are localized, items will be deleted only in the primary locale.
|
|
4922
5274
|
|
|
4923
5275
|
Required scope | `CMS:write`
|
|
4924
5276
|
|
|
@@ -4936,7 +5288,7 @@ Required scope | `CMS:write`
|
|
|
4936
5288
|
<dd>
|
|
4937
5289
|
|
|
4938
5290
|
```typescript
|
|
4939
|
-
await client.collections.items.
|
|
5291
|
+
await client.collections.items.deleteItems("580e63fc8c9a982ac9b8b745");
|
|
4940
5292
|
```
|
|
4941
5293
|
|
|
4942
5294
|
</dd>
|
|
@@ -4960,7 +5312,7 @@ await client.collections.items.deleteItemsLive("580e63fc8c9a982ac9b8b745");
|
|
|
4960
5312
|
<dl>
|
|
4961
5313
|
<dd>
|
|
4962
5314
|
|
|
4963
|
-
**request:** `Webflow.collections.
|
|
5315
|
+
**request:** `Webflow.collections.ItemsDeleteItemsRequest`
|
|
4964
5316
|
|
|
4965
5317
|
</dd>
|
|
4966
5318
|
</dl>
|
|
@@ -4979,7 +5331,7 @@ await client.collections.items.deleteItemsLive("580e63fc8c9a982ac9b8b745");
|
|
|
4979
5331
|
</dl>
|
|
4980
5332
|
</details>
|
|
4981
5333
|
|
|
4982
|
-
<details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">
|
|
5334
|
+
<details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">updateItems</a>(collectionId, { ...params }) -> Webflow.CollectionItem</code></summary>
|
|
4983
5335
|
<dl>
|
|
4984
5336
|
<dd>
|
|
4985
5337
|
|
|
@@ -4991,7 +5343,7 @@ await client.collections.items.deleteItemsLive("580e63fc8c9a982ac9b8b745");
|
|
|
4991
5343
|
<dl>
|
|
4992
5344
|
<dd>
|
|
4993
5345
|
|
|
4994
|
-
Update a single
|
|
5346
|
+
Update a single item or multiple items (up to 100) in a Collection.
|
|
4995
5347
|
|
|
4996
5348
|
**Note:** If the `cmsLocaleId` parameter is undefined or empty and the items are localized, items will be updated only in the primary locale.
|
|
4997
5349
|
|
|
@@ -5011,7 +5363,7 @@ Required scope | `CMS:write`
|
|
|
5011
5363
|
<dd>
|
|
5012
5364
|
|
|
5013
5365
|
```typescript
|
|
5014
|
-
await client.collections.items.
|
|
5366
|
+
await client.collections.items.updateItems("580e63fc8c9a982ac9b8b745", {
|
|
5015
5367
|
items: [
|
|
5016
5368
|
{
|
|
5017
5369
|
id: "66f6ed9576ddacf3149d5ea6",
|
|
@@ -5070,7 +5422,7 @@ await client.collections.items.updateItemsLive("580e63fc8c9a982ac9b8b745", {
|
|
|
5070
5422
|
<dl>
|
|
5071
5423
|
<dd>
|
|
5072
5424
|
|
|
5073
|
-
**request:** `Webflow.collections.
|
|
5425
|
+
**request:** `Webflow.collections.ItemsUpdateItemsRequest`
|
|
5074
5426
|
|
|
5075
5427
|
</dd>
|
|
5076
5428
|
</dl>
|
|
@@ -5089,7 +5441,7 @@ await client.collections.items.updateItemsLive("580e63fc8c9a982ac9b8b745", {
|
|
|
5089
5441
|
</dl>
|
|
5090
5442
|
</details>
|
|
5091
5443
|
|
|
5092
|
-
<details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">
|
|
5444
|
+
<details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">listItemsLive</a>(collectionId, { ...params }) -> Webflow.CollectionItemList</code></summary>
|
|
5093
5445
|
<dl>
|
|
5094
5446
|
<dd>
|
|
5095
5447
|
|
|
@@ -5101,12 +5453,82 @@ await client.collections.items.updateItemsLive("580e63fc8c9a982ac9b8b745", {
|
|
|
5101
5453
|
<dl>
|
|
5102
5454
|
<dd>
|
|
5103
5455
|
|
|
5104
|
-
|
|
5456
|
+
List of all live Items within a Collection.
|
|
5105
5457
|
|
|
5106
|
-
|
|
5458
|
+
Required scope | `CMS:read`
|
|
5107
5459
|
|
|
5108
|
-
|
|
5109
|
-
|
|
5460
|
+
</dd>
|
|
5461
|
+
</dl>
|
|
5462
|
+
</dd>
|
|
5463
|
+
</dl>
|
|
5464
|
+
|
|
5465
|
+
#### 🔌 Usage
|
|
5466
|
+
|
|
5467
|
+
<dl>
|
|
5468
|
+
<dd>
|
|
5469
|
+
|
|
5470
|
+
<dl>
|
|
5471
|
+
<dd>
|
|
5472
|
+
|
|
5473
|
+
```typescript
|
|
5474
|
+
await client.collections.items.listItemsLive("580e63fc8c9a982ac9b8b745");
|
|
5475
|
+
```
|
|
5476
|
+
|
|
5477
|
+
</dd>
|
|
5478
|
+
</dl>
|
|
5479
|
+
</dd>
|
|
5480
|
+
</dl>
|
|
5481
|
+
|
|
5482
|
+
#### ⚙️ Parameters
|
|
5483
|
+
|
|
5484
|
+
<dl>
|
|
5485
|
+
<dd>
|
|
5486
|
+
|
|
5487
|
+
<dl>
|
|
5488
|
+
<dd>
|
|
5489
|
+
|
|
5490
|
+
**collectionId:** `string` — Unique identifier for a Collection
|
|
5491
|
+
|
|
5492
|
+
</dd>
|
|
5493
|
+
</dl>
|
|
5494
|
+
|
|
5495
|
+
<dl>
|
|
5496
|
+
<dd>
|
|
5497
|
+
|
|
5498
|
+
**request:** `Webflow.collections.ItemsListItemsLiveRequest`
|
|
5499
|
+
|
|
5500
|
+
</dd>
|
|
5501
|
+
</dl>
|
|
5502
|
+
|
|
5503
|
+
<dl>
|
|
5504
|
+
<dd>
|
|
5505
|
+
|
|
5506
|
+
**requestOptions:** `Items.RequestOptions`
|
|
5507
|
+
|
|
5508
|
+
</dd>
|
|
5509
|
+
</dl>
|
|
5510
|
+
</dd>
|
|
5511
|
+
</dl>
|
|
5512
|
+
|
|
5513
|
+
</dd>
|
|
5514
|
+
</dl>
|
|
5515
|
+
</details>
|
|
5516
|
+
|
|
5517
|
+
<details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">createItemLive</a>(collectionId, { ...params }) -> Webflow.CollectionItem</code></summary>
|
|
5518
|
+
<dl>
|
|
5519
|
+
<dd>
|
|
5520
|
+
|
|
5521
|
+
#### 📝 Description
|
|
5522
|
+
|
|
5523
|
+
<dl>
|
|
5524
|
+
<dd>
|
|
5525
|
+
|
|
5526
|
+
<dl>
|
|
5527
|
+
<dd>
|
|
5528
|
+
|
|
5529
|
+
Create live Item(s) in a Collection. The Item(s) will be published to the live site.
|
|
5530
|
+
|
|
5531
|
+
To create items across multiple locales, [please use this endpoint.](/v2.0.0/data/reference/cms/collection-items/staged-items/create-items)
|
|
5110
5532
|
|
|
5111
5533
|
Required scope | `CMS:write`
|
|
5112
5534
|
|
|
@@ -5124,13 +5546,12 @@ Required scope | `CMS:write`
|
|
|
5124
5546
|
<dd>
|
|
5125
5547
|
|
|
5126
5548
|
```typescript
|
|
5127
|
-
await client.collections.items.
|
|
5128
|
-
cmsLocaleIds: ["66f6e966c9e1dc700a857ca3", "66f6e966c9e1dc700a857ca4", "66f6e966c9e1dc700a857ca5"],
|
|
5549
|
+
await client.collections.items.createItemLive("580e63fc8c9a982ac9b8b745", {
|
|
5129
5550
|
isArchived: false,
|
|
5130
5551
|
isDraft: false,
|
|
5131
5552
|
fieldData: {
|
|
5132
|
-
name: "
|
|
5133
|
-
slug: "
|
|
5553
|
+
name: "Pan Galactic Gargle Blaster Recipe",
|
|
5554
|
+
slug: "pan-galactic-gargle-blaster",
|
|
5134
5555
|
},
|
|
5135
5556
|
});
|
|
5136
5557
|
```
|
|
@@ -5156,7 +5577,7 @@ await client.collections.items.createItems("580e63fc8c9a982ac9b8b745", {
|
|
|
5156
5577
|
<dl>
|
|
5157
5578
|
<dd>
|
|
5158
5579
|
|
|
5159
|
-
**request:** `Webflow.
|
|
5580
|
+
**request:** `Webflow.ItemsCreateItemLiveRequest`
|
|
5160
5581
|
|
|
5161
5582
|
</dd>
|
|
5162
5583
|
</dl>
|
|
@@ -5175,7 +5596,7 @@ await client.collections.items.createItems("580e63fc8c9a982ac9b8b745", {
|
|
|
5175
5596
|
</dl>
|
|
5176
5597
|
</details>
|
|
5177
5598
|
|
|
5178
|
-
<details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">
|
|
5599
|
+
<details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">deleteItemsLive</a>(collectionId, { ...params }) -> void</code></summary>
|
|
5179
5600
|
<dl>
|
|
5180
5601
|
<dd>
|
|
5181
5602
|
|
|
@@ -5187,9 +5608,11 @@ await client.collections.items.createItems("580e63fc8c9a982ac9b8b745", {
|
|
|
5187
5608
|
<dl>
|
|
5188
5609
|
<dd>
|
|
5189
5610
|
|
|
5190
|
-
|
|
5611
|
+
Remove an item or multiple items (up to 100 items) from the live site. Deleting published items will unpublish the items from the live site and set them to draft.
|
|
5191
5612
|
|
|
5192
|
-
|
|
5613
|
+
**Note:** If the `cmsLocaleId` parameter is undefined or empty and the items are localized, items will be unpublished only in the primary locale.
|
|
5614
|
+
|
|
5615
|
+
Required scope | `CMS:write`
|
|
5193
5616
|
|
|
5194
5617
|
</dd>
|
|
5195
5618
|
</dl>
|
|
@@ -5205,7 +5628,697 @@ Required scope | `CMS:read`
|
|
|
5205
5628
|
<dd>
|
|
5206
5629
|
|
|
5207
5630
|
```typescript
|
|
5208
|
-
await client.collections.items.
|
|
5631
|
+
await client.collections.items.deleteItemsLive("580e63fc8c9a982ac9b8b745");
|
|
5632
|
+
```
|
|
5633
|
+
|
|
5634
|
+
</dd>
|
|
5635
|
+
</dl>
|
|
5636
|
+
</dd>
|
|
5637
|
+
</dl>
|
|
5638
|
+
|
|
5639
|
+
#### ⚙️ Parameters
|
|
5640
|
+
|
|
5641
|
+
<dl>
|
|
5642
|
+
<dd>
|
|
5643
|
+
|
|
5644
|
+
<dl>
|
|
5645
|
+
<dd>
|
|
5646
|
+
|
|
5647
|
+
**collectionId:** `string` — Unique identifier for a Collection
|
|
5648
|
+
|
|
5649
|
+
</dd>
|
|
5650
|
+
</dl>
|
|
5651
|
+
|
|
5652
|
+
<dl>
|
|
5653
|
+
<dd>
|
|
5654
|
+
|
|
5655
|
+
**request:** `Webflow.collections.ItemsDeleteItemsLiveRequest`
|
|
5656
|
+
|
|
5657
|
+
</dd>
|
|
5658
|
+
</dl>
|
|
5659
|
+
|
|
5660
|
+
<dl>
|
|
5661
|
+
<dd>
|
|
5662
|
+
|
|
5663
|
+
**requestOptions:** `Items.RequestOptions`
|
|
5664
|
+
|
|
5665
|
+
</dd>
|
|
5666
|
+
</dl>
|
|
5667
|
+
</dd>
|
|
5668
|
+
</dl>
|
|
5669
|
+
|
|
5670
|
+
</dd>
|
|
5671
|
+
</dl>
|
|
5672
|
+
</details>
|
|
5673
|
+
|
|
5674
|
+
<details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">updateItemsLive</a>(collectionId, { ...params }) -> Webflow.CollectionItemListNoPagination</code></summary>
|
|
5675
|
+
<dl>
|
|
5676
|
+
<dd>
|
|
5677
|
+
|
|
5678
|
+
#### 📝 Description
|
|
5679
|
+
|
|
5680
|
+
<dl>
|
|
5681
|
+
<dd>
|
|
5682
|
+
|
|
5683
|
+
<dl>
|
|
5684
|
+
<dd>
|
|
5685
|
+
|
|
5686
|
+
Update a single live item or multiple live items (up to 100) in a Collection
|
|
5687
|
+
|
|
5688
|
+
**Note:** If the `cmsLocaleId` parameter is undefined or empty and the items are localized, items will be updated only in the primary locale.
|
|
5689
|
+
|
|
5690
|
+
Required scope | `CMS:write`
|
|
5691
|
+
|
|
5692
|
+
</dd>
|
|
5693
|
+
</dl>
|
|
5694
|
+
</dd>
|
|
5695
|
+
</dl>
|
|
5696
|
+
|
|
5697
|
+
#### 🔌 Usage
|
|
5698
|
+
|
|
5699
|
+
<dl>
|
|
5700
|
+
<dd>
|
|
5701
|
+
|
|
5702
|
+
<dl>
|
|
5703
|
+
<dd>
|
|
5704
|
+
|
|
5705
|
+
```typescript
|
|
5706
|
+
await client.collections.items.updateItemsLive("580e63fc8c9a982ac9b8b745", {
|
|
5707
|
+
items: [
|
|
5708
|
+
{
|
|
5709
|
+
id: "66f6ed9576ddacf3149d5ea6",
|
|
5710
|
+
cmsLocaleId: "66f6e966c9e1dc700a857ca5",
|
|
5711
|
+
fieldData: {
|
|
5712
|
+
name: "Ne Paniquez Pas",
|
|
5713
|
+
slug: "ne-paniquez-pas",
|
|
5714
|
+
},
|
|
5715
|
+
},
|
|
5716
|
+
{
|
|
5717
|
+
id: "66f6ed9576ddacf3149d5ea6",
|
|
5718
|
+
cmsLocaleId: "66f6e966c9e1dc700a857ca4",
|
|
5719
|
+
fieldData: {
|
|
5720
|
+
name: "No Entrar en P\u00E1nico",
|
|
5721
|
+
slug: "no-entrar-en-panico",
|
|
5722
|
+
},
|
|
5723
|
+
},
|
|
5724
|
+
{
|
|
5725
|
+
id: "66f6ed9576ddacf3149d5eaa",
|
|
5726
|
+
cmsLocaleId: "66f6e966c9e1dc700a857ca5",
|
|
5727
|
+
fieldData: {
|
|
5728
|
+
name: "Au Revoir et Merci pour Tous les Poissons",
|
|
5729
|
+
slug: "au-revoir-et-merci",
|
|
5730
|
+
},
|
|
5731
|
+
},
|
|
5732
|
+
{
|
|
5733
|
+
id: "66f6ed9576ddacf3149d5eaa",
|
|
5734
|
+
cmsLocaleId: "66f6e966c9e1dc700a857ca4",
|
|
5735
|
+
fieldData: {
|
|
5736
|
+
name: "Hasta Luego y Gracias por Todo el Pescado",
|
|
5737
|
+
slug: "hasta-luego-y-gracias",
|
|
5738
|
+
},
|
|
5739
|
+
},
|
|
5740
|
+
],
|
|
5741
|
+
});
|
|
5742
|
+
```
|
|
5743
|
+
|
|
5744
|
+
</dd>
|
|
5745
|
+
</dl>
|
|
5746
|
+
</dd>
|
|
5747
|
+
</dl>
|
|
5748
|
+
|
|
5749
|
+
#### ⚙️ Parameters
|
|
5750
|
+
|
|
5751
|
+
<dl>
|
|
5752
|
+
<dd>
|
|
5753
|
+
|
|
5754
|
+
<dl>
|
|
5755
|
+
<dd>
|
|
5756
|
+
|
|
5757
|
+
**collectionId:** `string` — Unique identifier for a Collection
|
|
5758
|
+
|
|
5759
|
+
</dd>
|
|
5760
|
+
</dl>
|
|
5761
|
+
|
|
5762
|
+
<dl>
|
|
5763
|
+
<dd>
|
|
5764
|
+
|
|
5765
|
+
**request:** `Webflow.collections.ItemsUpdateItemsLiveRequest`
|
|
5766
|
+
|
|
5767
|
+
</dd>
|
|
5768
|
+
</dl>
|
|
5769
|
+
|
|
5770
|
+
<dl>
|
|
5771
|
+
<dd>
|
|
5772
|
+
|
|
5773
|
+
**requestOptions:** `Items.RequestOptions`
|
|
5774
|
+
|
|
5775
|
+
</dd>
|
|
5776
|
+
</dl>
|
|
5777
|
+
</dd>
|
|
5778
|
+
</dl>
|
|
5779
|
+
|
|
5780
|
+
</dd>
|
|
5781
|
+
</dl>
|
|
5782
|
+
</details>
|
|
5783
|
+
|
|
5784
|
+
<details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">createItems</a>(collectionId, { ...params }) -> Webflow.BulkCollectionItem</code></summary>
|
|
5785
|
+
<dl>
|
|
5786
|
+
<dd>
|
|
5787
|
+
|
|
5788
|
+
#### 📝 Description
|
|
5789
|
+
|
|
5790
|
+
<dl>
|
|
5791
|
+
<dd>
|
|
5792
|
+
|
|
5793
|
+
<dl>
|
|
5794
|
+
<dd>
|
|
5795
|
+
|
|
5796
|
+
Create an item or multiple items in a CMS Collection across multiple corresponding locales.
|
|
5797
|
+
|
|
5798
|
+
**Notes:**
|
|
5799
|
+
|
|
5800
|
+
- This endpoint can create up to 100 items in a request.
|
|
5801
|
+
- If the `cmsLocaleIds` parameter is undefined or empty and localization is enabled, items will only be created in the primary locale.
|
|
5802
|
+
|
|
5803
|
+
Required scope | `CMS:write`
|
|
5804
|
+
|
|
5805
|
+
</dd>
|
|
5806
|
+
</dl>
|
|
5807
|
+
</dd>
|
|
5808
|
+
</dl>
|
|
5809
|
+
|
|
5810
|
+
#### 🔌 Usage
|
|
5811
|
+
|
|
5812
|
+
<dl>
|
|
5813
|
+
<dd>
|
|
5814
|
+
|
|
5815
|
+
<dl>
|
|
5816
|
+
<dd>
|
|
5817
|
+
|
|
5818
|
+
```typescript
|
|
5819
|
+
await client.collections.items.createItems("580e63fc8c9a982ac9b8b745", {
|
|
5820
|
+
cmsLocaleIds: ["66f6e966c9e1dc700a857ca3", "66f6e966c9e1dc700a857ca4", "66f6e966c9e1dc700a857ca5"],
|
|
5821
|
+
isArchived: false,
|
|
5822
|
+
isDraft: false,
|
|
5823
|
+
fieldData: {
|
|
5824
|
+
name: "Don\u2019t Panic",
|
|
5825
|
+
slug: "dont-panic",
|
|
5826
|
+
},
|
|
5827
|
+
});
|
|
5828
|
+
```
|
|
5829
|
+
|
|
5830
|
+
</dd>
|
|
5831
|
+
</dl>
|
|
5832
|
+
</dd>
|
|
5833
|
+
</dl>
|
|
5834
|
+
|
|
5835
|
+
#### ⚙️ Parameters
|
|
5836
|
+
|
|
5837
|
+
<dl>
|
|
5838
|
+
<dd>
|
|
5839
|
+
|
|
5840
|
+
<dl>
|
|
5841
|
+
<dd>
|
|
5842
|
+
|
|
5843
|
+
**collectionId:** `string` — Unique identifier for a Collection
|
|
5844
|
+
|
|
5845
|
+
</dd>
|
|
5846
|
+
</dl>
|
|
5847
|
+
|
|
5848
|
+
<dl>
|
|
5849
|
+
<dd>
|
|
5850
|
+
|
|
5851
|
+
**request:** `Webflow.collections.CreateBulkCollectionItemRequestBody`
|
|
5852
|
+
|
|
5853
|
+
</dd>
|
|
5854
|
+
</dl>
|
|
5855
|
+
|
|
5856
|
+
<dl>
|
|
5857
|
+
<dd>
|
|
5858
|
+
|
|
5859
|
+
**requestOptions:** `Items.RequestOptions`
|
|
5860
|
+
|
|
5861
|
+
</dd>
|
|
5862
|
+
</dl>
|
|
5863
|
+
</dd>
|
|
5864
|
+
</dl>
|
|
5865
|
+
|
|
5866
|
+
</dd>
|
|
5867
|
+
</dl>
|
|
5868
|
+
</details>
|
|
5869
|
+
|
|
5870
|
+
<details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">getItem</a>(collectionId, itemId, { ...params }) -> Webflow.CollectionItem</code></summary>
|
|
5871
|
+
<dl>
|
|
5872
|
+
<dd>
|
|
5873
|
+
|
|
5874
|
+
#### 📝 Description
|
|
5875
|
+
|
|
5876
|
+
<dl>
|
|
5877
|
+
<dd>
|
|
5878
|
+
|
|
5879
|
+
<dl>
|
|
5880
|
+
<dd>
|
|
5881
|
+
|
|
5882
|
+
Get details of a selected Collection Item.
|
|
5883
|
+
|
|
5884
|
+
Required scope | `CMS:read`
|
|
5885
|
+
|
|
5886
|
+
</dd>
|
|
5887
|
+
</dl>
|
|
5888
|
+
</dd>
|
|
5889
|
+
</dl>
|
|
5890
|
+
|
|
5891
|
+
#### 🔌 Usage
|
|
5892
|
+
|
|
5893
|
+
<dl>
|
|
5894
|
+
<dd>
|
|
5895
|
+
|
|
5896
|
+
<dl>
|
|
5897
|
+
<dd>
|
|
5898
|
+
|
|
5899
|
+
```typescript
|
|
5900
|
+
await client.collections.items.getItem("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754");
|
|
5901
|
+
```
|
|
5902
|
+
|
|
5903
|
+
</dd>
|
|
5904
|
+
</dl>
|
|
5905
|
+
</dd>
|
|
5906
|
+
</dl>
|
|
5907
|
+
|
|
5908
|
+
#### ⚙️ Parameters
|
|
5909
|
+
|
|
5910
|
+
<dl>
|
|
5911
|
+
<dd>
|
|
5912
|
+
|
|
5913
|
+
<dl>
|
|
5914
|
+
<dd>
|
|
5915
|
+
|
|
5916
|
+
**collectionId:** `string` — Unique identifier for a Collection
|
|
5917
|
+
|
|
5918
|
+
</dd>
|
|
5919
|
+
</dl>
|
|
5920
|
+
|
|
5921
|
+
<dl>
|
|
5922
|
+
<dd>
|
|
5923
|
+
|
|
5924
|
+
**itemId:** `string` — Unique identifier for an Item
|
|
5925
|
+
|
|
5926
|
+
</dd>
|
|
5927
|
+
</dl>
|
|
5928
|
+
|
|
5929
|
+
<dl>
|
|
5930
|
+
<dd>
|
|
5931
|
+
|
|
5932
|
+
**request:** `Webflow.collections.ItemsGetItemRequest`
|
|
5933
|
+
|
|
5934
|
+
</dd>
|
|
5935
|
+
</dl>
|
|
5936
|
+
|
|
5937
|
+
<dl>
|
|
5938
|
+
<dd>
|
|
5939
|
+
|
|
5940
|
+
**requestOptions:** `Items.RequestOptions`
|
|
5941
|
+
|
|
5942
|
+
</dd>
|
|
5943
|
+
</dl>
|
|
5944
|
+
</dd>
|
|
5945
|
+
</dl>
|
|
5946
|
+
|
|
5947
|
+
</dd>
|
|
5948
|
+
</dl>
|
|
5949
|
+
</details>
|
|
5950
|
+
|
|
5951
|
+
<details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">deleteItem</a>(collectionId, itemId, { ...params }) -> void</code></summary>
|
|
5952
|
+
<dl>
|
|
5953
|
+
<dd>
|
|
5954
|
+
|
|
5955
|
+
#### 📝 Description
|
|
5956
|
+
|
|
5957
|
+
<dl>
|
|
5958
|
+
<dd>
|
|
5959
|
+
|
|
5960
|
+
<dl>
|
|
5961
|
+
<dd>
|
|
5962
|
+
|
|
5963
|
+
Delete an Item from a Collection. This endpoint does not currently support bulk deletion.
|
|
5964
|
+
|
|
5965
|
+
Required scope | `CMS:write`
|
|
5966
|
+
|
|
5967
|
+
</dd>
|
|
5968
|
+
</dl>
|
|
5969
|
+
</dd>
|
|
5970
|
+
</dl>
|
|
5971
|
+
|
|
5972
|
+
#### 🔌 Usage
|
|
5973
|
+
|
|
5974
|
+
<dl>
|
|
5975
|
+
<dd>
|
|
5976
|
+
|
|
5977
|
+
<dl>
|
|
5978
|
+
<dd>
|
|
5979
|
+
|
|
5980
|
+
```typescript
|
|
5981
|
+
await client.collections.items.deleteItem("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754");
|
|
5982
|
+
```
|
|
5983
|
+
|
|
5984
|
+
</dd>
|
|
5985
|
+
</dl>
|
|
5986
|
+
</dd>
|
|
5987
|
+
</dl>
|
|
5988
|
+
|
|
5989
|
+
#### ⚙️ Parameters
|
|
5990
|
+
|
|
5991
|
+
<dl>
|
|
5992
|
+
<dd>
|
|
5993
|
+
|
|
5994
|
+
<dl>
|
|
5995
|
+
<dd>
|
|
5996
|
+
|
|
5997
|
+
**collectionId:** `string` — Unique identifier for a Collection
|
|
5998
|
+
|
|
5999
|
+
</dd>
|
|
6000
|
+
</dl>
|
|
6001
|
+
|
|
6002
|
+
<dl>
|
|
6003
|
+
<dd>
|
|
6004
|
+
|
|
6005
|
+
**itemId:** `string` — Unique identifier for an Item
|
|
6006
|
+
|
|
6007
|
+
</dd>
|
|
6008
|
+
</dl>
|
|
6009
|
+
|
|
6010
|
+
<dl>
|
|
6011
|
+
<dd>
|
|
6012
|
+
|
|
6013
|
+
**request:** `Webflow.collections.ItemsDeleteItemRequest`
|
|
6014
|
+
|
|
6015
|
+
</dd>
|
|
6016
|
+
</dl>
|
|
6017
|
+
|
|
6018
|
+
<dl>
|
|
6019
|
+
<dd>
|
|
6020
|
+
|
|
6021
|
+
**requestOptions:** `Items.RequestOptions`
|
|
6022
|
+
|
|
6023
|
+
</dd>
|
|
6024
|
+
</dl>
|
|
6025
|
+
</dd>
|
|
6026
|
+
</dl>
|
|
6027
|
+
|
|
6028
|
+
</dd>
|
|
6029
|
+
</dl>
|
|
6030
|
+
</details>
|
|
6031
|
+
|
|
6032
|
+
<details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">updateItem</a>(collectionId, itemId, { ...params }) -> Webflow.CollectionItem</code></summary>
|
|
6033
|
+
<dl>
|
|
6034
|
+
<dd>
|
|
6035
|
+
|
|
6036
|
+
#### 📝 Description
|
|
6037
|
+
|
|
6038
|
+
<dl>
|
|
6039
|
+
<dd>
|
|
6040
|
+
|
|
6041
|
+
<dl>
|
|
6042
|
+
<dd>
|
|
6043
|
+
|
|
6044
|
+
Update a selected Item in a Collection.
|
|
6045
|
+
|
|
6046
|
+
Required scope | `CMS:write`
|
|
6047
|
+
|
|
6048
|
+
</dd>
|
|
6049
|
+
</dl>
|
|
6050
|
+
</dd>
|
|
6051
|
+
</dl>
|
|
6052
|
+
|
|
6053
|
+
#### 🔌 Usage
|
|
6054
|
+
|
|
6055
|
+
<dl>
|
|
6056
|
+
<dd>
|
|
6057
|
+
|
|
6058
|
+
<dl>
|
|
6059
|
+
<dd>
|
|
6060
|
+
|
|
6061
|
+
```typescript
|
|
6062
|
+
await client.collections.items.updateItem("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754", {
|
|
6063
|
+
isArchived: false,
|
|
6064
|
+
isDraft: false,
|
|
6065
|
+
fieldData: {
|
|
6066
|
+
name: "Pan Galactic Gargle Blaster Recipe",
|
|
6067
|
+
slug: "pan-galactic-gargle-blaster",
|
|
6068
|
+
},
|
|
6069
|
+
});
|
|
6070
|
+
```
|
|
6071
|
+
|
|
6072
|
+
</dd>
|
|
6073
|
+
</dl>
|
|
6074
|
+
</dd>
|
|
6075
|
+
</dl>
|
|
6076
|
+
|
|
6077
|
+
#### ⚙️ Parameters
|
|
6078
|
+
|
|
6079
|
+
<dl>
|
|
6080
|
+
<dd>
|
|
6081
|
+
|
|
6082
|
+
<dl>
|
|
6083
|
+
<dd>
|
|
6084
|
+
|
|
6085
|
+
**collectionId:** `string` — Unique identifier for a Collection
|
|
6086
|
+
|
|
6087
|
+
</dd>
|
|
6088
|
+
</dl>
|
|
6089
|
+
|
|
6090
|
+
<dl>
|
|
6091
|
+
<dd>
|
|
6092
|
+
|
|
6093
|
+
**itemId:** `string` — Unique identifier for an Item
|
|
6094
|
+
|
|
6095
|
+
</dd>
|
|
6096
|
+
</dl>
|
|
6097
|
+
|
|
6098
|
+
<dl>
|
|
6099
|
+
<dd>
|
|
6100
|
+
|
|
6101
|
+
**request:** `Webflow.CollectionItemPatchSingle`
|
|
6102
|
+
|
|
6103
|
+
</dd>
|
|
6104
|
+
</dl>
|
|
6105
|
+
|
|
6106
|
+
<dl>
|
|
6107
|
+
<dd>
|
|
6108
|
+
|
|
6109
|
+
**requestOptions:** `Items.RequestOptions`
|
|
6110
|
+
|
|
6111
|
+
</dd>
|
|
6112
|
+
</dl>
|
|
6113
|
+
</dd>
|
|
6114
|
+
</dl>
|
|
6115
|
+
|
|
6116
|
+
</dd>
|
|
6117
|
+
</dl>
|
|
6118
|
+
</details>
|
|
6119
|
+
|
|
6120
|
+
<details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">getItemLive</a>(collectionId, itemId, { ...params }) -> Webflow.CollectionItem</code></summary>
|
|
6121
|
+
<dl>
|
|
6122
|
+
<dd>
|
|
6123
|
+
|
|
6124
|
+
#### 📝 Description
|
|
6125
|
+
|
|
6126
|
+
<dl>
|
|
6127
|
+
<dd>
|
|
6128
|
+
|
|
6129
|
+
<dl>
|
|
6130
|
+
<dd>
|
|
6131
|
+
|
|
6132
|
+
Get details of a selected Collection live Item.
|
|
6133
|
+
|
|
6134
|
+
Required scope | `CMS:read`
|
|
6135
|
+
|
|
6136
|
+
</dd>
|
|
6137
|
+
</dl>
|
|
6138
|
+
</dd>
|
|
6139
|
+
</dl>
|
|
6140
|
+
|
|
6141
|
+
#### 🔌 Usage
|
|
6142
|
+
|
|
6143
|
+
<dl>
|
|
6144
|
+
<dd>
|
|
6145
|
+
|
|
6146
|
+
<dl>
|
|
6147
|
+
<dd>
|
|
6148
|
+
|
|
6149
|
+
```typescript
|
|
6150
|
+
await client.collections.items.getItemLive("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754");
|
|
6151
|
+
```
|
|
6152
|
+
|
|
6153
|
+
</dd>
|
|
6154
|
+
</dl>
|
|
6155
|
+
</dd>
|
|
6156
|
+
</dl>
|
|
6157
|
+
|
|
6158
|
+
#### ⚙️ Parameters
|
|
6159
|
+
|
|
6160
|
+
<dl>
|
|
6161
|
+
<dd>
|
|
6162
|
+
|
|
6163
|
+
<dl>
|
|
6164
|
+
<dd>
|
|
6165
|
+
|
|
6166
|
+
**collectionId:** `string` — Unique identifier for a Collection
|
|
6167
|
+
|
|
6168
|
+
</dd>
|
|
6169
|
+
</dl>
|
|
6170
|
+
|
|
6171
|
+
<dl>
|
|
6172
|
+
<dd>
|
|
6173
|
+
|
|
6174
|
+
**itemId:** `string` — Unique identifier for an Item
|
|
6175
|
+
|
|
6176
|
+
</dd>
|
|
6177
|
+
</dl>
|
|
6178
|
+
|
|
6179
|
+
<dl>
|
|
6180
|
+
<dd>
|
|
6181
|
+
|
|
6182
|
+
**request:** `Webflow.collections.ItemsGetItemLiveRequest`
|
|
6183
|
+
|
|
6184
|
+
</dd>
|
|
6185
|
+
</dl>
|
|
6186
|
+
|
|
6187
|
+
<dl>
|
|
6188
|
+
<dd>
|
|
6189
|
+
|
|
6190
|
+
**requestOptions:** `Items.RequestOptions`
|
|
6191
|
+
|
|
6192
|
+
</dd>
|
|
6193
|
+
</dl>
|
|
6194
|
+
</dd>
|
|
6195
|
+
</dl>
|
|
6196
|
+
|
|
6197
|
+
</dd>
|
|
6198
|
+
</dl>
|
|
6199
|
+
</details>
|
|
6200
|
+
|
|
6201
|
+
<details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">deleteItemLive</a>(collectionId, itemId, { ...params }) -> void</code></summary>
|
|
6202
|
+
<dl>
|
|
6203
|
+
<dd>
|
|
6204
|
+
|
|
6205
|
+
#### 📝 Description
|
|
6206
|
+
|
|
6207
|
+
<dl>
|
|
6208
|
+
<dd>
|
|
6209
|
+
|
|
6210
|
+
<dl>
|
|
6211
|
+
<dd>
|
|
6212
|
+
|
|
6213
|
+
Remove a live item from the site. Removing a published item will unpublish the item from the live site and set it to draft.
|
|
6214
|
+
|
|
6215
|
+
This endpoint does not currently support bulk deletion.
|
|
6216
|
+
|
|
6217
|
+
Required scope | `CMS:write`
|
|
6218
|
+
|
|
6219
|
+
</dd>
|
|
6220
|
+
</dl>
|
|
6221
|
+
</dd>
|
|
6222
|
+
</dl>
|
|
6223
|
+
|
|
6224
|
+
#### 🔌 Usage
|
|
6225
|
+
|
|
6226
|
+
<dl>
|
|
6227
|
+
<dd>
|
|
6228
|
+
|
|
6229
|
+
<dl>
|
|
6230
|
+
<dd>
|
|
6231
|
+
|
|
6232
|
+
```typescript
|
|
6233
|
+
await client.collections.items.deleteItemLive("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754");
|
|
6234
|
+
```
|
|
6235
|
+
|
|
6236
|
+
</dd>
|
|
6237
|
+
</dl>
|
|
6238
|
+
</dd>
|
|
6239
|
+
</dl>
|
|
6240
|
+
|
|
6241
|
+
#### ⚙️ Parameters
|
|
6242
|
+
|
|
6243
|
+
<dl>
|
|
6244
|
+
<dd>
|
|
6245
|
+
|
|
6246
|
+
<dl>
|
|
6247
|
+
<dd>
|
|
6248
|
+
|
|
6249
|
+
**collectionId:** `string` — Unique identifier for a Collection
|
|
6250
|
+
|
|
6251
|
+
</dd>
|
|
6252
|
+
</dl>
|
|
6253
|
+
|
|
6254
|
+
<dl>
|
|
6255
|
+
<dd>
|
|
6256
|
+
|
|
6257
|
+
**itemId:** `string` — Unique identifier for an Item
|
|
6258
|
+
|
|
6259
|
+
</dd>
|
|
6260
|
+
</dl>
|
|
6261
|
+
|
|
6262
|
+
<dl>
|
|
6263
|
+
<dd>
|
|
6264
|
+
|
|
6265
|
+
**request:** `Webflow.collections.ItemsDeleteItemLiveRequest`
|
|
6266
|
+
|
|
6267
|
+
</dd>
|
|
6268
|
+
</dl>
|
|
6269
|
+
|
|
6270
|
+
<dl>
|
|
6271
|
+
<dd>
|
|
6272
|
+
|
|
6273
|
+
**requestOptions:** `Items.RequestOptions`
|
|
6274
|
+
|
|
6275
|
+
</dd>
|
|
6276
|
+
</dl>
|
|
6277
|
+
</dd>
|
|
6278
|
+
</dl>
|
|
6279
|
+
|
|
6280
|
+
</dd>
|
|
6281
|
+
</dl>
|
|
6282
|
+
</details>
|
|
6283
|
+
|
|
6284
|
+
<details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">updateItemLive</a>(collectionId, itemId, { ...params }) -> Webflow.CollectionItem</code></summary>
|
|
6285
|
+
<dl>
|
|
6286
|
+
<dd>
|
|
6287
|
+
|
|
6288
|
+
#### 📝 Description
|
|
6289
|
+
|
|
6290
|
+
<dl>
|
|
6291
|
+
<dd>
|
|
6292
|
+
|
|
6293
|
+
<dl>
|
|
6294
|
+
<dd>
|
|
6295
|
+
|
|
6296
|
+
Update a selected live Item in a Collection. The updates for this Item will be published to the live site.
|
|
6297
|
+
|
|
6298
|
+
Required scope | `CMS:write`
|
|
6299
|
+
|
|
6300
|
+
</dd>
|
|
6301
|
+
</dl>
|
|
6302
|
+
</dd>
|
|
6303
|
+
</dl>
|
|
6304
|
+
|
|
6305
|
+
#### 🔌 Usage
|
|
6306
|
+
|
|
6307
|
+
<dl>
|
|
6308
|
+
<dd>
|
|
6309
|
+
|
|
6310
|
+
<dl>
|
|
6311
|
+
<dd>
|
|
6312
|
+
|
|
6313
|
+
```typescript
|
|
6314
|
+
await client.collections.items.updateItemLive("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754", {
|
|
6315
|
+
isArchived: false,
|
|
6316
|
+
isDraft: false,
|
|
6317
|
+
fieldData: {
|
|
6318
|
+
name: "Pan Galactic Gargle Blaster Recipe",
|
|
6319
|
+
slug: "pan-galactic-gargle-blaster",
|
|
6320
|
+
},
|
|
6321
|
+
});
|
|
5209
6322
|
```
|
|
5210
6323
|
|
|
5211
6324
|
</dd>
|
|
@@ -5237,7 +6350,7 @@ await client.collections.items.getItem("580e63fc8c9a982ac9b8b745", "580e64008c9a
|
|
|
5237
6350
|
<dl>
|
|
5238
6351
|
<dd>
|
|
5239
6352
|
|
|
5240
|
-
**request:** `Webflow.
|
|
6353
|
+
**request:** `Webflow.CollectionItemPatchSingle`
|
|
5241
6354
|
|
|
5242
6355
|
</dd>
|
|
5243
6356
|
</dl>
|
|
@@ -5256,7 +6369,7 @@ await client.collections.items.getItem("580e63fc8c9a982ac9b8b745", "580e64008c9a
|
|
|
5256
6369
|
</dl>
|
|
5257
6370
|
</details>
|
|
5258
6371
|
|
|
5259
|
-
<details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">
|
|
6372
|
+
<details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">publishItem</a>(collectionId, { ...params }) -> Webflow.ItemsPublishItemResponse</code></summary>
|
|
5260
6373
|
<dl>
|
|
5261
6374
|
<dd>
|
|
5262
6375
|
|
|
@@ -5268,9 +6381,9 @@ await client.collections.items.getItem("580e63fc8c9a982ac9b8b745", "580e64008c9a
|
|
|
5268
6381
|
<dl>
|
|
5269
6382
|
<dd>
|
|
5270
6383
|
|
|
5271
|
-
|
|
6384
|
+
Publish an item or multiple items.
|
|
5272
6385
|
|
|
5273
|
-
Required scope | `
|
|
6386
|
+
Required scope | `cms:write`
|
|
5274
6387
|
|
|
5275
6388
|
</dd>
|
|
5276
6389
|
</dl>
|
|
@@ -5286,7 +6399,9 @@ Required scope | `CMS:write`
|
|
|
5286
6399
|
<dd>
|
|
5287
6400
|
|
|
5288
6401
|
```typescript
|
|
5289
|
-
await client.collections.items.
|
|
6402
|
+
await client.collections.items.publishItem("580e63fc8c9a982ac9b8b745", {
|
|
6403
|
+
itemIds: ["itemIds"],
|
|
6404
|
+
});
|
|
5290
6405
|
```
|
|
5291
6406
|
|
|
5292
6407
|
</dd>
|
|
@@ -5310,15 +6425,7 @@ await client.collections.items.deleteItem("580e63fc8c9a982ac9b8b745", "580e64008
|
|
|
5310
6425
|
<dl>
|
|
5311
6426
|
<dd>
|
|
5312
6427
|
|
|
5313
|
-
**
|
|
5314
|
-
|
|
5315
|
-
</dd>
|
|
5316
|
-
</dl>
|
|
5317
|
-
|
|
5318
|
-
<dl>
|
|
5319
|
-
<dd>
|
|
5320
|
-
|
|
5321
|
-
**request:** `Webflow.collections.ItemsDeleteItemRequest`
|
|
6428
|
+
**request:** `Webflow.collections.ItemsPublishItemRequest`
|
|
5322
6429
|
|
|
5323
6430
|
</dd>
|
|
5324
6431
|
</dl>
|
|
@@ -5337,7 +6444,9 @@ await client.collections.items.deleteItem("580e63fc8c9a982ac9b8b745", "580e64008
|
|
|
5337
6444
|
</dl>
|
|
5338
6445
|
</details>
|
|
5339
6446
|
|
|
5340
|
-
|
|
6447
|
+
## Pages Scripts
|
|
6448
|
+
|
|
6449
|
+
<details><summary><code>client.pages.scripts.<a href="/src/api/resources/pages/resources/scripts/client/Client.ts">getCustomCode</a>(pageId) -> Webflow.ScriptApplyList</code></summary>
|
|
5341
6450
|
<dl>
|
|
5342
6451
|
<dd>
|
|
5343
6452
|
|
|
@@ -5349,9 +6458,15 @@ await client.collections.items.deleteItem("580e63fc8c9a982ac9b8b745", "580e64008
|
|
|
5349
6458
|
<dl>
|
|
5350
6459
|
<dd>
|
|
5351
6460
|
|
|
5352
|
-
|
|
6461
|
+
Get all registered scripts that have been applied to a specific Page.
|
|
5353
6462
|
|
|
5354
|
-
|
|
6463
|
+
In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered
|
|
6464
|
+
to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate
|
|
6465
|
+
`custom_code` endpoints.
|
|
6466
|
+
|
|
6467
|
+
<Note>Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients).</Note>
|
|
6468
|
+
|
|
6469
|
+
Required scope | `custom_code:read`
|
|
5355
6470
|
|
|
5356
6471
|
</dd>
|
|
5357
6472
|
</dl>
|
|
@@ -5367,14 +6482,7 @@ Required scope | `CMS:write`
|
|
|
5367
6482
|
<dd>
|
|
5368
6483
|
|
|
5369
6484
|
```typescript
|
|
5370
|
-
await client.
|
|
5371
|
-
isArchived: false,
|
|
5372
|
-
isDraft: false,
|
|
5373
|
-
fieldData: {
|
|
5374
|
-
name: "Pan Galactic Gargle Blaster Recipe",
|
|
5375
|
-
slug: "pan-galactic-gargle-blaster",
|
|
5376
|
-
},
|
|
5377
|
-
});
|
|
6485
|
+
await client.pages.scripts.getCustomCode("63c720f9347c2139b248e552");
|
|
5378
6486
|
```
|
|
5379
6487
|
|
|
5380
6488
|
</dd>
|
|
@@ -5390,23 +6498,7 @@ await client.collections.items.updateItem("580e63fc8c9a982ac9b8b745", "580e64008
|
|
|
5390
6498
|
<dl>
|
|
5391
6499
|
<dd>
|
|
5392
6500
|
|
|
5393
|
-
**
|
|
5394
|
-
|
|
5395
|
-
</dd>
|
|
5396
|
-
</dl>
|
|
5397
|
-
|
|
5398
|
-
<dl>
|
|
5399
|
-
<dd>
|
|
5400
|
-
|
|
5401
|
-
**itemId:** `string` — Unique identifier for an Item
|
|
5402
|
-
|
|
5403
|
-
</dd>
|
|
5404
|
-
</dl>
|
|
5405
|
-
|
|
5406
|
-
<dl>
|
|
5407
|
-
<dd>
|
|
5408
|
-
|
|
5409
|
-
**request:** `Webflow.CollectionItemPatchSingle`
|
|
6501
|
+
**pageId:** `string` — Unique identifier for a Page
|
|
5410
6502
|
|
|
5411
6503
|
</dd>
|
|
5412
6504
|
</dl>
|
|
@@ -5414,7 +6506,7 @@ await client.collections.items.updateItem("580e63fc8c9a982ac9b8b745", "580e64008
|
|
|
5414
6506
|
<dl>
|
|
5415
6507
|
<dd>
|
|
5416
6508
|
|
|
5417
|
-
**requestOptions:** `
|
|
6509
|
+
**requestOptions:** `Scripts.RequestOptions`
|
|
5418
6510
|
|
|
5419
6511
|
</dd>
|
|
5420
6512
|
</dl>
|
|
@@ -5425,7 +6517,7 @@ await client.collections.items.updateItem("580e63fc8c9a982ac9b8b745", "580e64008
|
|
|
5425
6517
|
</dl>
|
|
5426
6518
|
</details>
|
|
5427
6519
|
|
|
5428
|
-
<details><summary><code>client.
|
|
6520
|
+
<details><summary><code>client.pages.scripts.<a href="/src/api/resources/pages/resources/scripts/client/Client.ts">upsertCustomCode</a>(pageId, { ...params }) -> Webflow.ScriptApplyList</code></summary>
|
|
5429
6521
|
<dl>
|
|
5430
6522
|
<dd>
|
|
5431
6523
|
|
|
@@ -5437,9 +6529,17 @@ await client.collections.items.updateItem("580e63fc8c9a982ac9b8b745", "580e64008
|
|
|
5437
6529
|
<dl>
|
|
5438
6530
|
<dd>
|
|
5439
6531
|
|
|
5440
|
-
|
|
6532
|
+
Add a registered script to a Page.
|
|
5441
6533
|
|
|
5442
|
-
|
|
6534
|
+
In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered
|
|
6535
|
+
to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate
|
|
6536
|
+
`custom_code` endpoints.
|
|
6537
|
+
|
|
6538
|
+
A site can have a maximum of 800 registered scripts.
|
|
6539
|
+
|
|
6540
|
+
<Note>Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients).</Note>
|
|
6541
|
+
|
|
6542
|
+
Required scope | `custom_code:write`
|
|
5443
6543
|
|
|
5444
6544
|
</dd>
|
|
5445
6545
|
</dl>
|
|
@@ -5455,7 +6555,23 @@ Required scope | `CMS:read`
|
|
|
5455
6555
|
<dd>
|
|
5456
6556
|
|
|
5457
6557
|
```typescript
|
|
5458
|
-
await client.
|
|
6558
|
+
await client.pages.scripts.upsertCustomCode("63c720f9347c2139b248e552", {
|
|
6559
|
+
scripts: [
|
|
6560
|
+
{
|
|
6561
|
+
id: "cms_slider",
|
|
6562
|
+
location: "header",
|
|
6563
|
+
version: "1.0.0",
|
|
6564
|
+
attributes: {
|
|
6565
|
+
"my-attribute": "some-value",
|
|
6566
|
+
},
|
|
6567
|
+
},
|
|
6568
|
+
{
|
|
6569
|
+
id: "alert",
|
|
6570
|
+
location: "header",
|
|
6571
|
+
version: "0.0.1",
|
|
6572
|
+
},
|
|
6573
|
+
],
|
|
6574
|
+
});
|
|
5459
6575
|
```
|
|
5460
6576
|
|
|
5461
6577
|
</dd>
|
|
@@ -5471,15 +6587,7 @@ await client.collections.items.getItemLive("580e63fc8c9a982ac9b8b745", "580e6400
|
|
|
5471
6587
|
<dl>
|
|
5472
6588
|
<dd>
|
|
5473
6589
|
|
|
5474
|
-
**
|
|
5475
|
-
|
|
5476
|
-
</dd>
|
|
5477
|
-
</dl>
|
|
5478
|
-
|
|
5479
|
-
<dl>
|
|
5480
|
-
<dd>
|
|
5481
|
-
|
|
5482
|
-
**itemId:** `string` — Unique identifier for an Item
|
|
6590
|
+
**pageId:** `string` — Unique identifier for a Page
|
|
5483
6591
|
|
|
5484
6592
|
</dd>
|
|
5485
6593
|
</dl>
|
|
@@ -5487,7 +6595,7 @@ await client.collections.items.getItemLive("580e63fc8c9a982ac9b8b745", "580e6400
|
|
|
5487
6595
|
<dl>
|
|
5488
6596
|
<dd>
|
|
5489
6597
|
|
|
5490
|
-
**request:** `Webflow.
|
|
6598
|
+
**request:** `Webflow.ScriptApplyList`
|
|
5491
6599
|
|
|
5492
6600
|
</dd>
|
|
5493
6601
|
</dl>
|
|
@@ -5495,7 +6603,7 @@ await client.collections.items.getItemLive("580e63fc8c9a982ac9b8b745", "580e6400
|
|
|
5495
6603
|
<dl>
|
|
5496
6604
|
<dd>
|
|
5497
6605
|
|
|
5498
|
-
**requestOptions:** `
|
|
6606
|
+
**requestOptions:** `Scripts.RequestOptions`
|
|
5499
6607
|
|
|
5500
6608
|
</dd>
|
|
5501
6609
|
</dl>
|
|
@@ -5506,7 +6614,7 @@ await client.collections.items.getItemLive("580e63fc8c9a982ac9b8b745", "580e6400
|
|
|
5506
6614
|
</dl>
|
|
5507
6615
|
</details>
|
|
5508
6616
|
|
|
5509
|
-
<details><summary><code>client.
|
|
6617
|
+
<details><summary><code>client.pages.scripts.<a href="/src/api/resources/pages/resources/scripts/client/Client.ts">deleteCustomCode</a>(pageId) -> void</code></summary>
|
|
5510
6618
|
<dl>
|
|
5511
6619
|
<dd>
|
|
5512
6620
|
|
|
@@ -5518,11 +6626,15 @@ await client.collections.items.getItemLive("580e63fc8c9a982ac9b8b745", "580e6400
|
|
|
5518
6626
|
<dl>
|
|
5519
6627
|
<dd>
|
|
5520
6628
|
|
|
5521
|
-
|
|
6629
|
+
Delete the custom code block that an app has created for a page
|
|
5522
6630
|
|
|
5523
|
-
|
|
6631
|
+
In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered
|
|
6632
|
+
to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate
|
|
6633
|
+
`custom_code` endpoints.
|
|
5524
6634
|
|
|
5525
|
-
|
|
6635
|
+
<Note>Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients).</Note>
|
|
6636
|
+
|
|
6637
|
+
Required scope | `custom_code:write`
|
|
5526
6638
|
|
|
5527
6639
|
</dd>
|
|
5528
6640
|
</dl>
|
|
@@ -5538,7 +6650,7 @@ Required scope | `CMS:write`
|
|
|
5538
6650
|
<dd>
|
|
5539
6651
|
|
|
5540
6652
|
```typescript
|
|
5541
|
-
await client.
|
|
6653
|
+
await client.pages.scripts.deleteCustomCode("63c720f9347c2139b248e552");
|
|
5542
6654
|
```
|
|
5543
6655
|
|
|
5544
6656
|
</dd>
|
|
@@ -5554,23 +6666,7 @@ await client.collections.items.deleteItemLive("580e63fc8c9a982ac9b8b745", "580e6
|
|
|
5554
6666
|
<dl>
|
|
5555
6667
|
<dd>
|
|
5556
6668
|
|
|
5557
|
-
**
|
|
5558
|
-
|
|
5559
|
-
</dd>
|
|
5560
|
-
</dl>
|
|
5561
|
-
|
|
5562
|
-
<dl>
|
|
5563
|
-
<dd>
|
|
5564
|
-
|
|
5565
|
-
**itemId:** `string` — Unique identifier for an Item
|
|
5566
|
-
|
|
5567
|
-
</dd>
|
|
5568
|
-
</dl>
|
|
5569
|
-
|
|
5570
|
-
<dl>
|
|
5571
|
-
<dd>
|
|
5572
|
-
|
|
5573
|
-
**request:** `Webflow.collections.ItemsDeleteItemLiveRequest`
|
|
6669
|
+
**pageId:** `string` — Unique identifier for a Page
|
|
5574
6670
|
|
|
5575
6671
|
</dd>
|
|
5576
6672
|
</dl>
|
|
@@ -5578,7 +6674,7 @@ await client.collections.items.deleteItemLive("580e63fc8c9a982ac9b8b745", "580e6
|
|
|
5578
6674
|
<dl>
|
|
5579
6675
|
<dd>
|
|
5580
6676
|
|
|
5581
|
-
**requestOptions:** `
|
|
6677
|
+
**requestOptions:** `Scripts.RequestOptions`
|
|
5582
6678
|
|
|
5583
6679
|
</dd>
|
|
5584
6680
|
</dl>
|
|
@@ -5589,7 +6685,9 @@ await client.collections.items.deleteItemLive("580e63fc8c9a982ac9b8b745", "580e6
|
|
|
5589
6685
|
</dl>
|
|
5590
6686
|
</details>
|
|
5591
6687
|
|
|
5592
|
-
|
|
6688
|
+
## Sites Redirects
|
|
6689
|
+
|
|
6690
|
+
<details><summary><code>client.sites.redirects.<a href="/src/api/resources/sites/resources/redirects/client/Client.ts">list</a>(siteId) -> Webflow.Redirects</code></summary>
|
|
5593
6691
|
<dl>
|
|
5594
6692
|
<dd>
|
|
5595
6693
|
|
|
@@ -5601,9 +6699,11 @@ await client.collections.items.deleteItemLive("580e63fc8c9a982ac9b8b745", "580e6
|
|
|
5601
6699
|
<dl>
|
|
5602
6700
|
<dd>
|
|
5603
6701
|
|
|
5604
|
-
|
|
6702
|
+
Fetch a list of all URL redirect rules configured for a specific site.
|
|
5605
6703
|
|
|
5606
|
-
|
|
6704
|
+
Use this endpoint to review, audit, or manage the redirection rules that control how traffic is rerouted on your site.
|
|
6705
|
+
|
|
6706
|
+
Required scope: `sites:read`
|
|
5607
6707
|
|
|
5608
6708
|
</dd>
|
|
5609
6709
|
</dl>
|
|
@@ -5619,14 +6719,7 @@ Required scope | `CMS:write`
|
|
|
5619
6719
|
<dd>
|
|
5620
6720
|
|
|
5621
6721
|
```typescript
|
|
5622
|
-
await client.
|
|
5623
|
-
isArchived: false,
|
|
5624
|
-
isDraft: false,
|
|
5625
|
-
fieldData: {
|
|
5626
|
-
name: "Pan Galactic Gargle Blaster Recipe",
|
|
5627
|
-
slug: "pan-galactic-gargle-blaster",
|
|
5628
|
-
},
|
|
5629
|
-
});
|
|
6722
|
+
await client.sites.redirects.list("580e63e98c9a982ac9b8b741");
|
|
5630
6723
|
```
|
|
5631
6724
|
|
|
5632
6725
|
</dd>
|
|
@@ -5642,23 +6735,7 @@ await client.collections.items.updateItemLive("580e63fc8c9a982ac9b8b745", "580e6
|
|
|
5642
6735
|
<dl>
|
|
5643
6736
|
<dd>
|
|
5644
6737
|
|
|
5645
|
-
**
|
|
5646
|
-
|
|
5647
|
-
</dd>
|
|
5648
|
-
</dl>
|
|
5649
|
-
|
|
5650
|
-
<dl>
|
|
5651
|
-
<dd>
|
|
5652
|
-
|
|
5653
|
-
**itemId:** `string` — Unique identifier for an Item
|
|
5654
|
-
|
|
5655
|
-
</dd>
|
|
5656
|
-
</dl>
|
|
5657
|
-
|
|
5658
|
-
<dl>
|
|
5659
|
-
<dd>
|
|
5660
|
-
|
|
5661
|
-
**request:** `Webflow.CollectionItemPatchSingle`
|
|
6738
|
+
**siteId:** `string` — Unique identifier for a Site
|
|
5662
6739
|
|
|
5663
6740
|
</dd>
|
|
5664
6741
|
</dl>
|
|
@@ -5666,7 +6743,7 @@ await client.collections.items.updateItemLive("580e63fc8c9a982ac9b8b745", "580e6
|
|
|
5666
6743
|
<dl>
|
|
5667
6744
|
<dd>
|
|
5668
6745
|
|
|
5669
|
-
**requestOptions:** `
|
|
6746
|
+
**requestOptions:** `Redirects.RequestOptions`
|
|
5670
6747
|
|
|
5671
6748
|
</dd>
|
|
5672
6749
|
</dl>
|
|
@@ -5677,7 +6754,7 @@ await client.collections.items.updateItemLive("580e63fc8c9a982ac9b8b745", "580e6
|
|
|
5677
6754
|
</dl>
|
|
5678
6755
|
</details>
|
|
5679
6756
|
|
|
5680
|
-
<details><summary><code>client.
|
|
6757
|
+
<details><summary><code>client.sites.redirects.<a href="/src/api/resources/sites/resources/redirects/client/Client.ts">create</a>(siteId, { ...params }) -> Webflow.Redirect</code></summary>
|
|
5681
6758
|
<dl>
|
|
5682
6759
|
<dd>
|
|
5683
6760
|
|
|
@@ -5689,9 +6766,11 @@ await client.collections.items.updateItemLive("580e63fc8c9a982ac9b8b745", "580e6
|
|
|
5689
6766
|
<dl>
|
|
5690
6767
|
<dd>
|
|
5691
6768
|
|
|
5692
|
-
|
|
6769
|
+
Add a new URL redirection rule to a site.
|
|
5693
6770
|
|
|
5694
|
-
|
|
6771
|
+
This endpoint allows you to define a source path (`fromUrl`) and its corresponding destination path (`toUrl`), which will dictate how traffic is rerouted on your site. This is useful for managing site changes, restructuring URLs, or handling outdated links.
|
|
6772
|
+
|
|
6773
|
+
Required scope: `sites:write`
|
|
5695
6774
|
|
|
5696
6775
|
</dd>
|
|
5697
6776
|
</dl>
|
|
@@ -5707,8 +6786,10 @@ Required scope | `cms:write`
|
|
|
5707
6786
|
<dd>
|
|
5708
6787
|
|
|
5709
6788
|
```typescript
|
|
5710
|
-
await client.
|
|
5711
|
-
|
|
6789
|
+
await client.sites.redirects.create("580e63e98c9a982ac9b8b741", {
|
|
6790
|
+
id: "42e1a2b7aa1a13f768a0042a",
|
|
6791
|
+
fromUrl: "/mostly-harmless",
|
|
6792
|
+
toUrl: "/earth",
|
|
5712
6793
|
});
|
|
5713
6794
|
```
|
|
5714
6795
|
|
|
@@ -5725,7 +6806,7 @@ await client.collections.items.publishItem("580e63fc8c9a982ac9b8b745", {
|
|
|
5725
6806
|
<dl>
|
|
5726
6807
|
<dd>
|
|
5727
6808
|
|
|
5728
|
-
**
|
|
6809
|
+
**siteId:** `string` — Unique identifier for a Site
|
|
5729
6810
|
|
|
5730
6811
|
</dd>
|
|
5731
6812
|
</dl>
|
|
@@ -5733,7 +6814,7 @@ await client.collections.items.publishItem("580e63fc8c9a982ac9b8b745", {
|
|
|
5733
6814
|
<dl>
|
|
5734
6815
|
<dd>
|
|
5735
6816
|
|
|
5736
|
-
**request:** `Webflow.
|
|
6817
|
+
**request:** `Webflow.Redirect`
|
|
5737
6818
|
|
|
5738
6819
|
</dd>
|
|
5739
6820
|
</dl>
|
|
@@ -5741,7 +6822,7 @@ await client.collections.items.publishItem("580e63fc8c9a982ac9b8b745", {
|
|
|
5741
6822
|
<dl>
|
|
5742
6823
|
<dd>
|
|
5743
6824
|
|
|
5744
|
-
**requestOptions:** `
|
|
6825
|
+
**requestOptions:** `Redirects.RequestOptions`
|
|
5745
6826
|
|
|
5746
6827
|
</dd>
|
|
5747
6828
|
</dl>
|
|
@@ -5752,9 +6833,7 @@ await client.collections.items.publishItem("580e63fc8c9a982ac9b8b745", {
|
|
|
5752
6833
|
</dl>
|
|
5753
6834
|
</details>
|
|
5754
6835
|
|
|
5755
|
-
|
|
5756
|
-
|
|
5757
|
-
<details><summary><code>client.pages.scripts.<a href="/src/api/resources/pages/resources/scripts/client/Client.ts">getCustomCode</a>(pageId) -> Webflow.ScriptApplyList</code></summary>
|
|
6836
|
+
<details><summary><code>client.sites.redirects.<a href="/src/api/resources/sites/resources/redirects/client/Client.ts">delete</a>(siteId, redirectId) -> Webflow.Redirects</code></summary>
|
|
5758
6837
|
<dl>
|
|
5759
6838
|
<dd>
|
|
5760
6839
|
|
|
@@ -5766,15 +6845,9 @@ await client.collections.items.publishItem("580e63fc8c9a982ac9b8b745", {
|
|
|
5766
6845
|
<dl>
|
|
5767
6846
|
<dd>
|
|
5768
6847
|
|
|
5769
|
-
|
|
5770
|
-
|
|
5771
|
-
|
|
5772
|
-
to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate
|
|
5773
|
-
`custom_code` endpoints.
|
|
5774
|
-
|
|
5775
|
-
<blockquote class="callout callout_info" theme="📘">Access to this endpoint requires a bearer token from a <a href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data Client App</a>.</blockquote>
|
|
5776
|
-
|
|
5777
|
-
Required scope | `custom_code:read`
|
|
6848
|
+
Remove a URL redirection rule from a site.
|
|
6849
|
+
This is useful for cleaning up outdated or unnecessary redirects, ensuring that your site's routing behavior remains efficient and up-to-date.
|
|
6850
|
+
Required scope: `sites:write`
|
|
5778
6851
|
|
|
5779
6852
|
</dd>
|
|
5780
6853
|
</dl>
|
|
@@ -5790,7 +6863,7 @@ Required scope | `custom_code:read`
|
|
|
5790
6863
|
<dd>
|
|
5791
6864
|
|
|
5792
6865
|
```typescript
|
|
5793
|
-
await client.
|
|
6866
|
+
await client.sites.redirects.delete("580e63e98c9a982ac9b8b741", "66c4cb9a20cac35ed19500e6");
|
|
5794
6867
|
```
|
|
5795
6868
|
|
|
5796
6869
|
</dd>
|
|
@@ -5806,7 +6879,7 @@ await client.pages.scripts.getCustomCode("63c720f9347c2139b248e552");
|
|
|
5806
6879
|
<dl>
|
|
5807
6880
|
<dd>
|
|
5808
6881
|
|
|
5809
|
-
**
|
|
6882
|
+
**siteId:** `string` — Unique identifier for a Site
|
|
5810
6883
|
|
|
5811
6884
|
</dd>
|
|
5812
6885
|
</dl>
|
|
@@ -5814,7 +6887,15 @@ await client.pages.scripts.getCustomCode("63c720f9347c2139b248e552");
|
|
|
5814
6887
|
<dl>
|
|
5815
6888
|
<dd>
|
|
5816
6889
|
|
|
5817
|
-
**
|
|
6890
|
+
**redirectId:** `string` — Unique identifier site rediect
|
|
6891
|
+
|
|
6892
|
+
</dd>
|
|
6893
|
+
</dl>
|
|
6894
|
+
|
|
6895
|
+
<dl>
|
|
6896
|
+
<dd>
|
|
6897
|
+
|
|
6898
|
+
**requestOptions:** `Redirects.RequestOptions`
|
|
5818
6899
|
|
|
5819
6900
|
</dd>
|
|
5820
6901
|
</dl>
|
|
@@ -5825,7 +6906,7 @@ await client.pages.scripts.getCustomCode("63c720f9347c2139b248e552");
|
|
|
5825
6906
|
</dl>
|
|
5826
6907
|
</details>
|
|
5827
6908
|
|
|
5828
|
-
<details><summary><code>client.
|
|
6909
|
+
<details><summary><code>client.sites.redirects.<a href="/src/api/resources/sites/resources/redirects/client/Client.ts">update</a>(siteId, redirectId, { ...params }) -> Webflow.Redirect</code></summary>
|
|
5829
6910
|
<dl>
|
|
5830
6911
|
<dd>
|
|
5831
6912
|
|
|
@@ -5837,15 +6918,8 @@ await client.pages.scripts.getCustomCode("63c720f9347c2139b248e552");
|
|
|
5837
6918
|
<dl>
|
|
5838
6919
|
<dd>
|
|
5839
6920
|
|
|
5840
|
-
|
|
5841
|
-
|
|
5842
|
-
In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered
|
|
5843
|
-
to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate
|
|
5844
|
-
`custom_code` endpoints.
|
|
5845
|
-
|
|
5846
|
-
<blockquote class="callout callout_info" theme="📘">Access to this endpoint requires a bearer token from a <a href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data Client App</a>.</blockquote>
|
|
5847
|
-
|
|
5848
|
-
Required scope | `custom_code:write`
|
|
6921
|
+
Update a URL redirection rule from a site.
|
|
6922
|
+
Required scope: `sites:write`
|
|
5849
6923
|
|
|
5850
6924
|
</dd>
|
|
5851
6925
|
</dl>
|
|
@@ -5861,22 +6935,10 @@ Required scope | `custom_code:write`
|
|
|
5861
6935
|
<dd>
|
|
5862
6936
|
|
|
5863
6937
|
```typescript
|
|
5864
|
-
await client.
|
|
5865
|
-
|
|
5866
|
-
|
|
5867
|
-
|
|
5868
|
-
location: "header",
|
|
5869
|
-
version: "1.0.0",
|
|
5870
|
-
attributes: {
|
|
5871
|
-
"my-attribute": "some-value",
|
|
5872
|
-
},
|
|
5873
|
-
},
|
|
5874
|
-
{
|
|
5875
|
-
id: "alert",
|
|
5876
|
-
location: "header",
|
|
5877
|
-
version: "0.0.1",
|
|
5878
|
-
},
|
|
5879
|
-
],
|
|
6938
|
+
await client.sites.redirects.update("580e63e98c9a982ac9b8b741", "66c4cb9a20cac35ed19500e6", {
|
|
6939
|
+
id: "42e1a2b7aa1a13f768a0042a",
|
|
6940
|
+
fromUrl: "/mostly-harmless",
|
|
6941
|
+
toUrl: "/earth",
|
|
5880
6942
|
});
|
|
5881
6943
|
```
|
|
5882
6944
|
|
|
@@ -5893,7 +6955,7 @@ await client.pages.scripts.upsertCustomCode("63c720f9347c2139b248e552", {
|
|
|
5893
6955
|
<dl>
|
|
5894
6956
|
<dd>
|
|
5895
6957
|
|
|
5896
|
-
**
|
|
6958
|
+
**siteId:** `string` — Unique identifier for a Site
|
|
5897
6959
|
|
|
5898
6960
|
</dd>
|
|
5899
6961
|
</dl>
|
|
@@ -5901,7 +6963,7 @@ await client.pages.scripts.upsertCustomCode("63c720f9347c2139b248e552", {
|
|
|
5901
6963
|
<dl>
|
|
5902
6964
|
<dd>
|
|
5903
6965
|
|
|
5904
|
-
**
|
|
6966
|
+
**redirectId:** `string` — Unique identifier site rediect
|
|
5905
6967
|
|
|
5906
6968
|
</dd>
|
|
5907
6969
|
</dl>
|
|
@@ -5909,7 +6971,15 @@ await client.pages.scripts.upsertCustomCode("63c720f9347c2139b248e552", {
|
|
|
5909
6971
|
<dl>
|
|
5910
6972
|
<dd>
|
|
5911
6973
|
|
|
5912
|
-
**
|
|
6974
|
+
**request:** `Webflow.Redirect`
|
|
6975
|
+
|
|
6976
|
+
</dd>
|
|
6977
|
+
</dl>
|
|
6978
|
+
|
|
6979
|
+
<dl>
|
|
6980
|
+
<dd>
|
|
6981
|
+
|
|
6982
|
+
**requestOptions:** `Redirects.RequestOptions`
|
|
5913
6983
|
|
|
5914
6984
|
</dd>
|
|
5915
6985
|
</dl>
|
|
@@ -5920,7 +6990,9 @@ await client.pages.scripts.upsertCustomCode("63c720f9347c2139b248e552", {
|
|
|
5920
6990
|
</dl>
|
|
5921
6991
|
</details>
|
|
5922
6992
|
|
|
5923
|
-
|
|
6993
|
+
## Sites Plans
|
|
6994
|
+
|
|
6995
|
+
<details><summary><code>client.sites.plans.<a href="/src/api/resources/sites/resources/plans/client/Client.ts">getSitePlan</a>(siteId) -> Webflow.SitePlan</code></summary>
|
|
5924
6996
|
<dl>
|
|
5925
6997
|
<dd>
|
|
5926
6998
|
|
|
@@ -5932,15 +7004,9 @@ await client.pages.scripts.upsertCustomCode("63c720f9347c2139b248e552", {
|
|
|
5932
7004
|
<dl>
|
|
5933
7005
|
<dd>
|
|
5934
7006
|
|
|
5935
|
-
|
|
5936
|
-
|
|
5937
|
-
In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered
|
|
5938
|
-
to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate
|
|
5939
|
-
`custom_code` endpoints.
|
|
5940
|
-
|
|
5941
|
-
<blockquote class="callout callout_info" theme="📘">Access to this endpoint requires a bearer token from a <a href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data Client App</a>.</blockquote>
|
|
7007
|
+
Get site plan details for the specified Site.
|
|
5942
7008
|
|
|
5943
|
-
Required scope | `
|
|
7009
|
+
Required scope | `sites:read`
|
|
5944
7010
|
|
|
5945
7011
|
</dd>
|
|
5946
7012
|
</dl>
|
|
@@ -5956,7 +7022,7 @@ Required scope | `custom_code:write`
|
|
|
5956
7022
|
<dd>
|
|
5957
7023
|
|
|
5958
7024
|
```typescript
|
|
5959
|
-
await client.
|
|
7025
|
+
await client.sites.plans.getSitePlan("580e63e98c9a982ac9b8b741");
|
|
5960
7026
|
```
|
|
5961
7027
|
|
|
5962
7028
|
</dd>
|
|
@@ -5972,7 +7038,7 @@ await client.pages.scripts.deleteCustomCode("63c720f9347c2139b248e552");
|
|
|
5972
7038
|
<dl>
|
|
5973
7039
|
<dd>
|
|
5974
7040
|
|
|
5975
|
-
**
|
|
7041
|
+
**siteId:** `string` — Unique identifier for a Site
|
|
5976
7042
|
|
|
5977
7043
|
</dd>
|
|
5978
7044
|
</dl>
|
|
@@ -5980,7 +7046,7 @@ await client.pages.scripts.deleteCustomCode("63c720f9347c2139b248e552");
|
|
|
5980
7046
|
<dl>
|
|
5981
7047
|
<dd>
|
|
5982
7048
|
|
|
5983
|
-
**requestOptions:** `
|
|
7049
|
+
**requestOptions:** `Plans.RequestOptions`
|
|
5984
7050
|
|
|
5985
7051
|
</dd>
|
|
5986
7052
|
</dl>
|
|
@@ -6080,7 +7146,7 @@ await client.sites.activityLogs.list("580e63e98c9a982ac9b8b741");
|
|
|
6080
7146
|
|
|
6081
7147
|
Get all registered scripts that have been applied to a specific Site.
|
|
6082
7148
|
|
|
6083
|
-
<
|
|
7149
|
+
<Note>Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients).</Note>
|
|
6084
7150
|
|
|
6085
7151
|
Required scope | `custom_code:read`
|
|
6086
7152
|
|
|
@@ -6151,7 +7217,7 @@ In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts mu
|
|
|
6151
7217
|
to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate
|
|
6152
7218
|
`custom_code` endpoints.
|
|
6153
7219
|
|
|
6154
|
-
<
|
|
7220
|
+
<Note>Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients).</Note>
|
|
6155
7221
|
|
|
6156
7222
|
Required scope | `custom_code:write`
|
|
6157
7223
|
|
|
@@ -6242,7 +7308,7 @@ await client.sites.scripts.upsertCustomCode("580e63e98c9a982ac9b8b741", {
|
|
|
6242
7308
|
|
|
6243
7309
|
Delete the custom code block that an app created for a Site
|
|
6244
7310
|
|
|
6245
|
-
<
|
|
7311
|
+
<Note>Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients).</Note>
|
|
6246
7312
|
|
|
6247
7313
|
Required scope | `custom_code:write`
|
|
6248
7314
|
|
|
@@ -6309,7 +7375,7 @@ await client.sites.scripts.deleteCustomCode("580e63e98c9a982ac9b8b741");
|
|
|
6309
7375
|
|
|
6310
7376
|
Get all instances of Custom Code applied to a Site or Pages.
|
|
6311
7377
|
|
|
6312
|
-
<
|
|
7378
|
+
<Note>Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients).</Note>
|
|
6313
7379
|
|
|
6314
7380
|
Required scope | `custom_code:read`
|
|
6315
7381
|
|