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
|
@@ -19,11 +19,24 @@ errors:
|
|
|
19
19
|
message: >-
|
|
20
20
|
OAuthForbidden: You are missing the following scopes -
|
|
21
21
|
components:write
|
|
22
|
+
- value:
|
|
23
|
+
key: value
|
|
22
24
|
- value:
|
|
23
25
|
code: forbidden
|
|
24
26
|
message: User is not authorized to perform this action
|
|
27
|
+
BadRequestError:
|
|
28
|
+
status-code: 400
|
|
29
|
+
type: unknown
|
|
30
|
+
docs: Request body was incorrectly formatted.
|
|
31
|
+
examples:
|
|
32
|
+
- value:
|
|
33
|
+
code: bad_request
|
|
34
|
+
message: 'Bad Request: Request is malformed'
|
|
25
35
|
- value:
|
|
26
36
|
key: value
|
|
37
|
+
- value:
|
|
38
|
+
code: validation_error
|
|
39
|
+
message: 'Validation Error: Provided ID is invalid'
|
|
27
40
|
NotFoundError:
|
|
28
41
|
status-code: 404
|
|
29
42
|
type: Error
|
|
@@ -43,19 +56,6 @@ errors:
|
|
|
43
56
|
- value:
|
|
44
57
|
code: too_many_requests
|
|
45
58
|
message: Too many requests
|
|
46
|
-
BadRequestError:
|
|
47
|
-
status-code: 400
|
|
48
|
-
type: unknown
|
|
49
|
-
docs: Request body was incorrectly formatted.
|
|
50
|
-
examples:
|
|
51
|
-
- value:
|
|
52
|
-
code: bad_request
|
|
53
|
-
message: 'Bad Request: Request is malformed'
|
|
54
|
-
- value:
|
|
55
|
-
key: value
|
|
56
|
-
- value:
|
|
57
|
-
code: validation_error
|
|
58
|
-
message: 'Validation Error: Provided ID is invalid'
|
|
59
59
|
InternalServerError:
|
|
60
60
|
status-code: 500
|
|
61
61
|
type: Error
|
|
@@ -71,6 +71,9 @@ errors:
|
|
|
71
71
|
examples:
|
|
72
72
|
- value:
|
|
73
73
|
message: '''Site is published to multiple domains at different times'
|
|
74
|
+
- value:
|
|
75
|
+
code: custom_code_max_registered_scripts
|
|
76
|
+
message: The maximum number of registered scripts has been reached.
|
|
74
77
|
- value:
|
|
75
78
|
code: forms_require_republish
|
|
76
79
|
message: To access this feature, the site needs to be republished.
|
|
@@ -80,27 +83,27 @@ errors:
|
|
|
80
83
|
code: ecommerce_not_enabled
|
|
81
84
|
message: Ecommerce is not yet initialized
|
|
82
85
|
types:
|
|
83
|
-
BadRequestErrorBody:
|
|
84
|
-
discriminated: false
|
|
85
|
-
union:
|
|
86
|
-
- InvalidDomain
|
|
87
|
-
- NoDomains
|
|
88
|
-
source:
|
|
89
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
90
86
|
ForbiddenErrorBody:
|
|
91
87
|
discriminated: false
|
|
92
88
|
union:
|
|
93
89
|
- InvalidScopes
|
|
94
90
|
- UsersNotEnabled
|
|
95
91
|
source:
|
|
96
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
92
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
93
|
+
BadRequestErrorBody:
|
|
94
|
+
discriminated: false
|
|
95
|
+
union:
|
|
96
|
+
- InvalidDomain
|
|
97
|
+
- NoDomains
|
|
98
|
+
source:
|
|
99
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
97
100
|
ConflictErrorBody:
|
|
98
101
|
discriminated: false
|
|
99
102
|
union:
|
|
100
103
|
- DuplicateUserEmail
|
|
101
104
|
- UserLimitReached
|
|
102
105
|
source:
|
|
103
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
106
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
104
107
|
AuthorizedUser:
|
|
105
108
|
properties:
|
|
106
109
|
id:
|
|
@@ -118,7 +121,7 @@ types:
|
|
|
118
121
|
type: optional<string>
|
|
119
122
|
docs: The user's last name
|
|
120
123
|
source:
|
|
121
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
124
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
122
125
|
ErrorCode:
|
|
123
126
|
enum:
|
|
124
127
|
- bad_request
|
|
@@ -151,16 +154,9 @@ types:
|
|
|
151
154
|
- users_not_enabled
|
|
152
155
|
- validation_error
|
|
153
156
|
docs: Error code
|
|
154
|
-
source:
|
|
155
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
156
|
-
ErrorDetailsItem:
|
|
157
|
-
discriminated: false
|
|
158
|
-
union:
|
|
159
|
-
- string
|
|
160
|
-
- map<string, unknown>
|
|
161
|
-
source:
|
|
162
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
163
157
|
inline: true
|
|
158
|
+
source:
|
|
159
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
164
160
|
Error:
|
|
165
161
|
properties:
|
|
166
162
|
code:
|
|
@@ -173,10 +169,10 @@ types:
|
|
|
173
169
|
type: optional<string>
|
|
174
170
|
docs: Link to more information
|
|
175
171
|
details:
|
|
176
|
-
type: optional<list<
|
|
172
|
+
type: optional<list<unknown>>
|
|
177
173
|
docs: Array of errors
|
|
178
174
|
source:
|
|
179
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
175
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
180
176
|
Application: unknown
|
|
181
177
|
AuthorizationAuthorizationAuthorizedTo:
|
|
182
178
|
properties:
|
|
@@ -190,7 +186,7 @@ types:
|
|
|
190
186
|
type: optional<list<unknown>>
|
|
191
187
|
docs: Array of Users this app is authorized to
|
|
192
188
|
source:
|
|
193
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
189
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
194
190
|
inline: true
|
|
195
191
|
AuthorizationAuthorization:
|
|
196
192
|
docs: The Authorization object
|
|
@@ -215,7 +211,7 @@ types:
|
|
|
215
211
|
docs: Comma separted list of OAuth scopes corresponding to the Authorization
|
|
216
212
|
authorizedTo: optional<AuthorizationAuthorizationAuthorizedTo>
|
|
217
213
|
source:
|
|
218
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
214
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
219
215
|
inline: true
|
|
220
216
|
Authorization:
|
|
221
217
|
properties:
|
|
@@ -224,7 +220,7 @@ types:
|
|
|
224
220
|
docs: The Authorization object
|
|
225
221
|
application: optional<Application>
|
|
226
222
|
source:
|
|
227
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
223
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
228
224
|
Domain:
|
|
229
225
|
properties:
|
|
230
226
|
id:
|
|
@@ -233,8 +229,11 @@ types:
|
|
|
233
229
|
url:
|
|
234
230
|
type: optional<string>
|
|
235
231
|
docs: The registered Domain name
|
|
232
|
+
lastPublished:
|
|
233
|
+
type: optional<datetime>
|
|
234
|
+
docs: The date the custom domain was last published to
|
|
236
235
|
source:
|
|
237
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
236
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
238
237
|
Locale:
|
|
239
238
|
properties:
|
|
240
239
|
id:
|
|
@@ -264,7 +263,7 @@ types:
|
|
|
264
263
|
A tag or code representing the locale, often following a standard
|
|
265
264
|
format like 'en-US'.
|
|
266
265
|
source:
|
|
267
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
266
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
268
267
|
Locales:
|
|
269
268
|
properties:
|
|
270
269
|
primary:
|
|
@@ -274,15 +273,16 @@ types:
|
|
|
274
273
|
type: optional<list<Locale>>
|
|
275
274
|
docs: A list of secondary locales available for the site or application.
|
|
276
275
|
source:
|
|
277
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
276
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
278
277
|
SiteDataCollectionType:
|
|
279
278
|
enum:
|
|
280
279
|
- always
|
|
281
280
|
- optOut
|
|
282
281
|
- disabled
|
|
283
282
|
docs: The type of data collection enabled for the site.
|
|
283
|
+
inline: true
|
|
284
284
|
source:
|
|
285
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
285
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
286
286
|
Site:
|
|
287
287
|
properties:
|
|
288
288
|
id:
|
|
@@ -326,19 +326,120 @@ types:
|
|
|
326
326
|
type: optional<SiteDataCollectionType>
|
|
327
327
|
docs: The type of data collection enabled for the site.
|
|
328
328
|
source:
|
|
329
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
329
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
330
|
+
InvalidScopes: unknown
|
|
331
|
+
NotEnterprisePlanWorkspace: unknown
|
|
330
332
|
Sites:
|
|
331
333
|
properties:
|
|
332
334
|
sites: optional<list<Site>>
|
|
333
335
|
source:
|
|
334
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
336
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
337
|
+
NotEnterprisePlanSite: unknown
|
|
335
338
|
Domains:
|
|
336
339
|
properties:
|
|
337
340
|
customDomains: optional<list<Domain>>
|
|
338
341
|
source:
|
|
339
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
342
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
340
343
|
InvalidDomain: unknown
|
|
341
344
|
NoDomains: unknown
|
|
345
|
+
Redirect:
|
|
346
|
+
docs: A single redirection rule, specifying a source URL and a destination URL.
|
|
347
|
+
properties:
|
|
348
|
+
id:
|
|
349
|
+
type: optional<string>
|
|
350
|
+
docs: The ID of the specific redirect rule
|
|
351
|
+
fromUrl:
|
|
352
|
+
type: optional<string>
|
|
353
|
+
docs: The source URL path that will be redirected.
|
|
354
|
+
toUrl:
|
|
355
|
+
type: optional<string>
|
|
356
|
+
docs: The target URL path where the user or client will be redirected.
|
|
357
|
+
source:
|
|
358
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
359
|
+
Pagination:
|
|
360
|
+
docs: Pagination object
|
|
361
|
+
properties:
|
|
362
|
+
limit:
|
|
363
|
+
type: optional<double>
|
|
364
|
+
docs: The limit used for pagination
|
|
365
|
+
offset:
|
|
366
|
+
type: optional<double>
|
|
367
|
+
docs: The offset used for pagination
|
|
368
|
+
total:
|
|
369
|
+
type: optional<double>
|
|
370
|
+
docs: The total number of records
|
|
371
|
+
source:
|
|
372
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
373
|
+
Redirects:
|
|
374
|
+
docs: Site redirects response
|
|
375
|
+
properties:
|
|
376
|
+
redirects:
|
|
377
|
+
type: optional<list<Redirect>>
|
|
378
|
+
docs: List of redirects for a given site
|
|
379
|
+
pagination: optional<Pagination>
|
|
380
|
+
source:
|
|
381
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
382
|
+
SitePlanId:
|
|
383
|
+
enum:
|
|
384
|
+
- value: hosting-basic-v3
|
|
385
|
+
name: HostingBasicV3
|
|
386
|
+
- value: hosting-cms-v3
|
|
387
|
+
name: HostingCmsV3
|
|
388
|
+
- value: hosting-business-v3
|
|
389
|
+
name: HostingBusinessV3
|
|
390
|
+
- value: hosting-ecommerce-standard-v2
|
|
391
|
+
name: HostingEcommerceStandardV2
|
|
392
|
+
- value: hosting-ecommerce-plus-v2
|
|
393
|
+
name: HostingEcommercePlusV2
|
|
394
|
+
- value: hosting-ecommerce-advanced-v2
|
|
395
|
+
name: HostingEcommerceAdvancedV2
|
|
396
|
+
- value: hosting-basic-v4
|
|
397
|
+
name: HostingBasicV4
|
|
398
|
+
- value: hosting-cms-v4
|
|
399
|
+
name: HostingCmsV4
|
|
400
|
+
- value: hosting-business-v4
|
|
401
|
+
name: HostingBusinessV4
|
|
402
|
+
- value: hosting-ecommerce-standard-v3
|
|
403
|
+
name: HostingEcommerceStandardV3
|
|
404
|
+
- value: hosting-ecommerce-plus-v3
|
|
405
|
+
name: HostingEcommercePlusV3
|
|
406
|
+
- value: hosting-ecommerce-advanced-v3
|
|
407
|
+
name: HostingEcommerceAdvancedV3
|
|
408
|
+
docs: ID of the hosting plan.
|
|
409
|
+
inline: true
|
|
410
|
+
source:
|
|
411
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
412
|
+
SitePlanName:
|
|
413
|
+
enum:
|
|
414
|
+
- value: Basic Hosting
|
|
415
|
+
name: BasicHosting
|
|
416
|
+
- value: CMS Hosting
|
|
417
|
+
name: CmsHosting
|
|
418
|
+
- value: Business Hosting
|
|
419
|
+
name: BusinessHosting
|
|
420
|
+
- value: ECommerce Standard Hosting
|
|
421
|
+
name: ECommerceStandardHosting
|
|
422
|
+
- value: ECommerce Plus Hosting
|
|
423
|
+
name: ECommercePlusHosting
|
|
424
|
+
- value: ECommerce Advanced Hosting
|
|
425
|
+
name: ECommerceAdvancedHosting
|
|
426
|
+
docs: Name of the hosting plan.
|
|
427
|
+
inline: true
|
|
428
|
+
source:
|
|
429
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
430
|
+
SitePlan:
|
|
431
|
+
properties:
|
|
432
|
+
id:
|
|
433
|
+
type: optional<SitePlanId>
|
|
434
|
+
docs: ID of the hosting plan.
|
|
435
|
+
name:
|
|
436
|
+
type: optional<SitePlanName>
|
|
437
|
+
docs: Name of the hosting plan.
|
|
438
|
+
pricingInfo:
|
|
439
|
+
type: optional<string>
|
|
440
|
+
docs: URL for more information about Webflow hosting plan pricing.
|
|
441
|
+
source:
|
|
442
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
342
443
|
SiteActivityLogItemEvent:
|
|
343
444
|
enum:
|
|
344
445
|
- styles_modified
|
|
@@ -383,8 +484,9 @@ types:
|
|
|
383
484
|
- branch_review_created
|
|
384
485
|
- branch_review_approved
|
|
385
486
|
- branch_review_canceled
|
|
487
|
+
inline: true
|
|
386
488
|
source:
|
|
387
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
489
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
388
490
|
SiteActivityLogItemResourceOperation:
|
|
389
491
|
enum:
|
|
390
492
|
- CREATED
|
|
@@ -396,14 +498,15 @@ types:
|
|
|
396
498
|
- GROUP_CREATED
|
|
397
499
|
- GROUP_DELETED
|
|
398
500
|
- REORDERED
|
|
501
|
+
inline: true
|
|
399
502
|
source:
|
|
400
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
503
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
401
504
|
SiteActivityLogItemUser:
|
|
402
505
|
properties:
|
|
403
506
|
id: optional<string>
|
|
404
507
|
displayName: optional<string>
|
|
405
508
|
source:
|
|
406
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
509
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
407
510
|
inline: true
|
|
408
511
|
SiteActivityLogItem:
|
|
409
512
|
properties:
|
|
@@ -419,29 +522,13 @@ types:
|
|
|
419
522
|
previousValue: optional<string>
|
|
420
523
|
payload: optional<map<string, unknown>>
|
|
421
524
|
source:
|
|
422
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
423
|
-
Pagination:
|
|
424
|
-
docs: Pagination object
|
|
425
|
-
properties:
|
|
426
|
-
limit:
|
|
427
|
-
type: optional<double>
|
|
428
|
-
docs: The limit used for pagination
|
|
429
|
-
offset:
|
|
430
|
-
type: optional<double>
|
|
431
|
-
docs: The offset used for pagination
|
|
432
|
-
total:
|
|
433
|
-
type: optional<double>
|
|
434
|
-
docs: The total number of records
|
|
435
|
-
source:
|
|
436
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
525
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
437
526
|
SiteActivityLogResponse:
|
|
438
527
|
properties:
|
|
439
528
|
items: optional<list<SiteActivityLogItem>>
|
|
440
529
|
pagination: optional<Pagination>
|
|
441
530
|
source:
|
|
442
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
443
|
-
InvalidScopes: unknown
|
|
444
|
-
NotEnterprisePlanSite: unknown
|
|
531
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
445
532
|
CollectionListArrayItem:
|
|
446
533
|
docs: A collection object
|
|
447
534
|
properties:
|
|
@@ -466,32 +553,33 @@ types:
|
|
|
466
553
|
type: optional<datetime>
|
|
467
554
|
docs: The date the collection was last updated
|
|
468
555
|
source:
|
|
469
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
556
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
470
557
|
CollectionList:
|
|
471
558
|
properties:
|
|
472
559
|
collections:
|
|
473
560
|
type: optional<list<CollectionListArrayItem>>
|
|
474
561
|
docs: An array of Collections
|
|
475
562
|
source:
|
|
476
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
563
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
477
564
|
FieldType:
|
|
478
565
|
enum:
|
|
479
|
-
-
|
|
480
|
-
-
|
|
566
|
+
- Color
|
|
567
|
+
- DateTime
|
|
568
|
+
- Email
|
|
569
|
+
- ExtFileRef
|
|
481
570
|
- Image
|
|
482
|
-
- MultiImage
|
|
483
|
-
- Video
|
|
484
571
|
- Link
|
|
485
|
-
-
|
|
486
|
-
- Phone
|
|
572
|
+
- MultiImage
|
|
487
573
|
- Number
|
|
488
|
-
-
|
|
574
|
+
- Phone
|
|
575
|
+
- PlainText
|
|
576
|
+
- RichText
|
|
489
577
|
- Switch
|
|
490
|
-
-
|
|
491
|
-
- ExtFileRef
|
|
578
|
+
- Video
|
|
492
579
|
docs: Choose these appropriate field type for your collection data
|
|
580
|
+
inline: true
|
|
493
581
|
source:
|
|
494
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
582
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
495
583
|
Field:
|
|
496
584
|
docs: The details of a field in a collection
|
|
497
585
|
properties:
|
|
@@ -519,7 +607,7 @@ types:
|
|
|
519
607
|
type: optional<string>
|
|
520
608
|
docs: Additional text to help anyone filling out this field
|
|
521
609
|
source:
|
|
522
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
610
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
523
611
|
Collection:
|
|
524
612
|
docs: A collection object
|
|
525
613
|
properties:
|
|
@@ -547,7 +635,7 @@ types:
|
|
|
547
635
|
docs: The list of fields in the Collection
|
|
548
636
|
type: list<Field>
|
|
549
637
|
source:
|
|
550
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
638
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
551
639
|
CollectionItemFieldData:
|
|
552
640
|
properties:
|
|
553
641
|
name:
|
|
@@ -560,14 +648,23 @@ types:
|
|
|
560
648
|
will break all links referencing the old slug.
|
|
561
649
|
extra-properties: true
|
|
562
650
|
source:
|
|
563
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
651
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
564
652
|
inline: true
|
|
565
653
|
CollectionItem:
|
|
566
654
|
docs: >
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
655
|
+
A Collection Item represents a single entry in your collection. Each item
|
|
656
|
+
includes:
|
|
657
|
+
|
|
658
|
+
|
|
659
|
+
- **System metadata** - Automatically managed fields like IDs and
|
|
660
|
+
timestamp <br/>
|
|
661
|
+
|
|
662
|
+
- **Status flags** - Controls for managing content state: `isDraft`,
|
|
663
|
+
`isArchived `<br/>
|
|
664
|
+
|
|
665
|
+
- **Content fields** - Stored in `fieldData`. Each item needs a `name` and
|
|
666
|
+
`slug`, and may include additional fields matching your collection's
|
|
667
|
+
schema definition.
|
|
571
668
|
properties:
|
|
572
669
|
id:
|
|
573
670
|
type: optional<string>
|
|
@@ -594,7 +691,7 @@ types:
|
|
|
594
691
|
default: false
|
|
595
692
|
fieldData: CollectionItemFieldData
|
|
596
693
|
source:
|
|
597
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
694
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
598
695
|
CollectionItemListPagination:
|
|
599
696
|
properties:
|
|
600
697
|
limit:
|
|
@@ -609,7 +706,7 @@ types:
|
|
|
609
706
|
type: optional<double>
|
|
610
707
|
docs: Total number of items in the collection
|
|
611
708
|
source:
|
|
612
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
709
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
613
710
|
inline: true
|
|
614
711
|
CollectionItemList:
|
|
615
712
|
docs: Results from collection items list
|
|
@@ -619,7 +716,7 @@ types:
|
|
|
619
716
|
docs: List of Items within the collection
|
|
620
717
|
pagination: optional<CollectionItemListPagination>
|
|
621
718
|
source:
|
|
622
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
719
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
623
720
|
CollectionItemPostSingleFieldData:
|
|
624
721
|
properties:
|
|
625
722
|
name:
|
|
@@ -632,14 +729,23 @@ types:
|
|
|
632
729
|
will break all links referencing the old slug.
|
|
633
730
|
extra-properties: true
|
|
634
731
|
source:
|
|
635
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
732
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
636
733
|
inline: true
|
|
637
734
|
CollectionItemPostSingle:
|
|
638
735
|
docs: >
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
736
|
+
A Collection Item represents a single entry in your collection. Each item
|
|
737
|
+
includes:
|
|
738
|
+
|
|
739
|
+
|
|
740
|
+
- **System metadata** - Automatically managed fields like IDs and
|
|
741
|
+
timestamp <br/>
|
|
742
|
+
|
|
743
|
+
- **Status flags** - Controls for managing content state: `isDraft`,
|
|
744
|
+
`isArchived `<br/>
|
|
745
|
+
|
|
746
|
+
- **Content fields** - Stored in `fieldData`. Each item needs a `name` and
|
|
747
|
+
`slug`, and may include additional fields matching your collection's
|
|
748
|
+
schema definition.
|
|
643
749
|
properties:
|
|
644
750
|
id:
|
|
645
751
|
type: optional<string>
|
|
@@ -658,15 +764,15 @@ types:
|
|
|
658
764
|
docs: The date the item was created
|
|
659
765
|
isArchived:
|
|
660
766
|
type: optional<boolean>
|
|
661
|
-
docs: Boolean determining if the Item is
|
|
767
|
+
docs: Boolean determining if the Item is in an archived state.
|
|
662
768
|
default: false
|
|
663
769
|
isDraft:
|
|
664
770
|
type: optional<boolean>
|
|
665
|
-
docs: Boolean determining if the Item is
|
|
771
|
+
docs: Boolean determining if the Item is in a draft state.
|
|
666
772
|
default: false
|
|
667
773
|
fieldData: CollectionItemPostSingleFieldData
|
|
668
774
|
source:
|
|
669
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
775
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
670
776
|
CollectionItemWithIdInputFieldData:
|
|
671
777
|
properties:
|
|
672
778
|
name:
|
|
@@ -679,7 +785,7 @@ types:
|
|
|
679
785
|
will break all links referencing the old slug.
|
|
680
786
|
extra-properties: true
|
|
681
787
|
source:
|
|
682
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
788
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
683
789
|
inline: true
|
|
684
790
|
CollectionItemWithIdInput:
|
|
685
791
|
docs: >
|
|
@@ -706,14 +812,12 @@ types:
|
|
|
706
812
|
isArchived:
|
|
707
813
|
type: optional<boolean>
|
|
708
814
|
docs: Boolean determining if the Item is set to archived
|
|
709
|
-
default: false
|
|
710
815
|
isDraft:
|
|
711
816
|
type: optional<boolean>
|
|
712
817
|
docs: Boolean determining if the Item is set to draft
|
|
713
|
-
default: false
|
|
714
818
|
fieldData: optional<CollectionItemWithIdInputFieldData>
|
|
715
819
|
source:
|
|
716
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
820
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
717
821
|
CollectionItemListNoPagination:
|
|
718
822
|
docs: Results from collection items list
|
|
719
823
|
properties:
|
|
@@ -721,7 +825,7 @@ types:
|
|
|
721
825
|
type: optional<list<CollectionItem>>
|
|
722
826
|
docs: List of Items within the collection
|
|
723
827
|
source:
|
|
724
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
828
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
725
829
|
BulkCollectionItemFieldData:
|
|
726
830
|
properties:
|
|
727
831
|
name:
|
|
@@ -734,7 +838,7 @@ types:
|
|
|
734
838
|
will break all links referencing the old slug.
|
|
735
839
|
extra-properties: true
|
|
736
840
|
source:
|
|
737
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
841
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
738
842
|
inline: true
|
|
739
843
|
BulkCollectionItem:
|
|
740
844
|
docs: >
|
|
@@ -768,7 +872,7 @@ types:
|
|
|
768
872
|
default: false
|
|
769
873
|
fieldData: optional<BulkCollectionItemFieldData>
|
|
770
874
|
source:
|
|
771
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
875
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
772
876
|
CollectionItemPatchSingleFieldData:
|
|
773
877
|
properties:
|
|
774
878
|
name:
|
|
@@ -781,7 +885,7 @@ types:
|
|
|
781
885
|
will break all links referencing the old slug.
|
|
782
886
|
extra-properties: true
|
|
783
887
|
source:
|
|
784
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
888
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
785
889
|
inline: true
|
|
786
890
|
CollectionItemPatchSingle:
|
|
787
891
|
docs: >
|
|
@@ -808,14 +912,12 @@ types:
|
|
|
808
912
|
isArchived:
|
|
809
913
|
type: optional<boolean>
|
|
810
914
|
docs: Boolean determining if the Item is set to archived
|
|
811
|
-
default: false
|
|
812
915
|
isDraft:
|
|
813
916
|
type: optional<boolean>
|
|
814
917
|
docs: Boolean determining if the Item is set to draft
|
|
815
|
-
default: false
|
|
816
918
|
fieldData: optional<CollectionItemPatchSingleFieldData>
|
|
817
919
|
source:
|
|
818
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
920
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
819
921
|
PageSeo:
|
|
820
922
|
docs: SEO-related fields for the Page
|
|
821
923
|
properties:
|
|
@@ -826,7 +928,7 @@ types:
|
|
|
826
928
|
type: optional<string>
|
|
827
929
|
docs: The Page description shown in search engine results
|
|
828
930
|
source:
|
|
829
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
931
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
830
932
|
inline: true
|
|
831
933
|
PageOpenGraph:
|
|
832
934
|
docs: Open Graph fields for the Page
|
|
@@ -848,7 +950,7 @@ types:
|
|
|
848
950
|
description
|
|
849
951
|
default: true
|
|
850
952
|
source:
|
|
851
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
953
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
852
954
|
inline: true
|
|
853
955
|
Page:
|
|
854
956
|
docs: The Page object
|
|
@@ -918,25 +1020,47 @@ types:
|
|
|
918
1020
|
type: optional<string>
|
|
919
1021
|
docs: Relative path of the published page URL
|
|
920
1022
|
source:
|
|
921
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1023
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
922
1024
|
PageList:
|
|
923
1025
|
docs: The Page object
|
|
924
1026
|
properties:
|
|
925
1027
|
pages: optional<list<Page>>
|
|
926
1028
|
pagination: optional<Pagination>
|
|
927
1029
|
source:
|
|
928
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1030
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1031
|
+
TextNodeText:
|
|
1032
|
+
properties:
|
|
1033
|
+
html:
|
|
1034
|
+
type: optional<string>
|
|
1035
|
+
docs: The HTML content of the text node.
|
|
1036
|
+
text:
|
|
1037
|
+
type: optional<string>
|
|
1038
|
+
docs: The raw text content of the text node.
|
|
1039
|
+
source:
|
|
1040
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1041
|
+
inline: true
|
|
929
1042
|
TextNode:
|
|
930
1043
|
docs: >
|
|
931
|
-
Represents
|
|
932
|
-
|
|
933
|
-
|
|
934
|
-
|
|
1044
|
+
Represents text content within the DOM. It contains both the raw text and
|
|
1045
|
+
its HTML representation. Additional attributes can be associated with the
|
|
1046
|
+
text for styling or other purposes.
|
|
1047
|
+
properties:
|
|
1048
|
+
id:
|
|
1049
|
+
type: optional<string>
|
|
1050
|
+
docs: Node UUID
|
|
1051
|
+
text: optional<TextNodeText>
|
|
1052
|
+
attributes:
|
|
1053
|
+
type: optional<map<string, string>>
|
|
1054
|
+
docs: The custom attributes of the node
|
|
1055
|
+
source:
|
|
1056
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1057
|
+
ImageNodeImage:
|
|
935
1058
|
properties:
|
|
936
|
-
|
|
937
|
-
|
|
1059
|
+
alt: optional<string>
|
|
1060
|
+
assetId: optional<string>
|
|
938
1061
|
source:
|
|
939
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1062
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1063
|
+
inline: true
|
|
940
1064
|
ImageNode:
|
|
941
1065
|
docs: >
|
|
942
1066
|
Represents an image within the DOM. It contains details about the image,
|
|
@@ -944,41 +1068,97 @@ types:
|
|
|
944
1068
|
identifier for fetching the actual image resource. Additional attributes
|
|
945
1069
|
can be associated with the image for styling or other purposes.
|
|
946
1070
|
properties:
|
|
947
|
-
|
|
948
|
-
|
|
1071
|
+
id:
|
|
1072
|
+
type: optional<string>
|
|
1073
|
+
docs: Node UUID
|
|
1074
|
+
image: optional<ImageNodeImage>
|
|
1075
|
+
attributes:
|
|
1076
|
+
type: optional<map<string, string>>
|
|
1077
|
+
docs: The custom attributes of the node
|
|
1078
|
+
source:
|
|
1079
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1080
|
+
Text:
|
|
1081
|
+
properties:
|
|
1082
|
+
html:
|
|
1083
|
+
type: optional<string>
|
|
1084
|
+
docs: The HTML content of the text node.
|
|
1085
|
+
text:
|
|
1086
|
+
type: optional<string>
|
|
1087
|
+
docs: The raw text content of the text node.
|
|
949
1088
|
source:
|
|
950
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
951
|
-
|
|
1089
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1090
|
+
ComponentPropertyType:
|
|
952
1091
|
enum:
|
|
953
|
-
-
|
|
954
|
-
|
|
1092
|
+
- value: Plain Text
|
|
1093
|
+
name: PlainText
|
|
1094
|
+
- value: Rich Text
|
|
1095
|
+
name: RichText
|
|
1096
|
+
- value: Alt Text
|
|
1097
|
+
name: AltText
|
|
1098
|
+
docs: The type of the property.
|
|
1099
|
+
inline: true
|
|
955
1100
|
source:
|
|
956
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
957
|
-
|
|
1101
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1102
|
+
ComponentProperty:
|
|
958
1103
|
docs: >
|
|
959
|
-
|
|
960
|
-
|
|
961
|
-
|
|
1104
|
+
Represents a property of a component instance in the DOM. A property
|
|
1105
|
+
contains a list of both the raw text and the HTML representation, allowing
|
|
1106
|
+
for flexibility in rendering and processing. Additional attributes can be
|
|
1107
|
+
associated with the text for styling or other purposes.
|
|
1108
|
+
properties:
|
|
1109
|
+
propertyId:
|
|
1110
|
+
type: optional<string>
|
|
1111
|
+
docs: The ID of the property.
|
|
1112
|
+
type:
|
|
1113
|
+
type: optional<ComponentPropertyType>
|
|
1114
|
+
docs: The type of the property.
|
|
1115
|
+
label:
|
|
1116
|
+
type: optional<string>
|
|
1117
|
+
docs: The label of the property in the UI.
|
|
1118
|
+
text:
|
|
1119
|
+
type: optional<Text>
|
|
1120
|
+
docs: >-
|
|
1121
|
+
Represents text content within the DOM. It contains both the raw text
|
|
1122
|
+
and its HTML representation.
|
|
1123
|
+
source:
|
|
1124
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1125
|
+
ComponentNode:
|
|
1126
|
+
docs: >
|
|
1127
|
+
Represents a component instance within the DOM. It contains details about
|
|
1128
|
+
the component instance, such as its type and properties.
|
|
962
1129
|
properties:
|
|
963
1130
|
id:
|
|
964
1131
|
type: optional<string>
|
|
965
1132
|
docs: Node UUID
|
|
966
|
-
|
|
967
|
-
|
|
968
|
-
|
|
969
|
-
|
|
970
|
-
type: optional<
|
|
971
|
-
docs:
|
|
1133
|
+
componentId:
|
|
1134
|
+
type: optional<string>
|
|
1135
|
+
docs: Component ID
|
|
1136
|
+
propertyOverrides:
|
|
1137
|
+
type: optional<list<ComponentProperty>>
|
|
1138
|
+
docs: List of component properties with overrides for a component instance.
|
|
1139
|
+
source:
|
|
1140
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1141
|
+
Node:
|
|
1142
|
+
discriminant: type
|
|
1143
|
+
base-properties: {}
|
|
1144
|
+
docs: >
|
|
1145
|
+
A generic representation of a content element within the Document Object
|
|
1146
|
+
Model (DOM). Each node has a unique identifier and a specific type that
|
|
1147
|
+
determines its content structure and attributes.
|
|
1148
|
+
union:
|
|
1149
|
+
text: TextNode
|
|
1150
|
+
image: ImageNode
|
|
1151
|
+
component-instance: ComponentNode
|
|
972
1152
|
source:
|
|
973
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1153
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
974
1154
|
Dom:
|
|
975
1155
|
docs: >
|
|
976
1156
|
The DOM (Document Object Model) schema represents the content structure of
|
|
977
|
-
a web page. It captures various content nodes
|
|
978
|
-
|
|
979
|
-
|
|
980
|
-
pagination details for scenarios where the content nodes are too
|
|
981
|
-
be fetched in a single request.
|
|
1157
|
+
a web page or component. It captures various content nodes along with
|
|
1158
|
+
their associated attributes. Each node has a unique identifier and can be
|
|
1159
|
+
of different types like text, image or component-instance. The schema also
|
|
1160
|
+
provides pagination details for scenarios where the content nodes are too
|
|
1161
|
+
many to be fetched in a single request.
|
|
982
1162
|
properties:
|
|
983
1163
|
pageId:
|
|
984
1164
|
type: optional<string>
|
|
@@ -986,7 +1166,114 @@ types:
|
|
|
986
1166
|
nodes: optional<list<Node>>
|
|
987
1167
|
pagination: optional<Pagination>
|
|
988
1168
|
source:
|
|
989
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1169
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1170
|
+
TextNodeWrite:
|
|
1171
|
+
docs: Update a text node
|
|
1172
|
+
properties:
|
|
1173
|
+
nodeId:
|
|
1174
|
+
type: string
|
|
1175
|
+
docs: Node UUID
|
|
1176
|
+
text:
|
|
1177
|
+
type: string
|
|
1178
|
+
docs: >-
|
|
1179
|
+
HTML content of the node, including the HTML tag. The HTML tags must
|
|
1180
|
+
be the same as what's returned from the Get Content endpoint.
|
|
1181
|
+
source:
|
|
1182
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1183
|
+
ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem:
|
|
1184
|
+
properties:
|
|
1185
|
+
propertyId:
|
|
1186
|
+
type: string
|
|
1187
|
+
docs: The ID of the property.
|
|
1188
|
+
text:
|
|
1189
|
+
type: string
|
|
1190
|
+
docs: >
|
|
1191
|
+
The new string or HTML value used to override the component instance
|
|
1192
|
+
property value.
|
|
1193
|
+
|
|
1194
|
+
The provided value must be compatible with the type of the component
|
|
1195
|
+
instance property.
|
|
1196
|
+
|
|
1197
|
+
For example, attempting to override a single-line plain-text property
|
|
1198
|
+
with a multi-line
|
|
1199
|
+
|
|
1200
|
+
value will result in an error.
|
|
1201
|
+
source:
|
|
1202
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1203
|
+
inline: true
|
|
1204
|
+
ComponentInstanceNodePropertyOverridesWrite:
|
|
1205
|
+
docs: Update text property overrides of a component instance
|
|
1206
|
+
properties:
|
|
1207
|
+
nodeId:
|
|
1208
|
+
type: string
|
|
1209
|
+
docs: Node UUID
|
|
1210
|
+
propertyOverrides:
|
|
1211
|
+
docs: >-
|
|
1212
|
+
A list of component instance properties to override within the
|
|
1213
|
+
specified secondary locale.
|
|
1214
|
+
type: list<ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem>
|
|
1215
|
+
source:
|
|
1216
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1217
|
+
Component:
|
|
1218
|
+
docs: The Component object
|
|
1219
|
+
properties:
|
|
1220
|
+
id:
|
|
1221
|
+
type: string
|
|
1222
|
+
docs: Unique identifier for the Component
|
|
1223
|
+
name:
|
|
1224
|
+
type: optional<string>
|
|
1225
|
+
docs: Component Name
|
|
1226
|
+
group:
|
|
1227
|
+
type: optional<string>
|
|
1228
|
+
docs: The group that the component belongs to
|
|
1229
|
+
description:
|
|
1230
|
+
type: optional<string>
|
|
1231
|
+
docs: Component Description
|
|
1232
|
+
readonly:
|
|
1233
|
+
type: optional<boolean>
|
|
1234
|
+
docs: >-
|
|
1235
|
+
Indicates whether the component is read-only. Components that cannot
|
|
1236
|
+
be updated within this Site are set to readonly. Workspace Libraries
|
|
1237
|
+
are a good example.
|
|
1238
|
+
source:
|
|
1239
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1240
|
+
ComponentList:
|
|
1241
|
+
docs: List of Components on a site.
|
|
1242
|
+
properties:
|
|
1243
|
+
components: optional<list<Component>>
|
|
1244
|
+
pagination: optional<Pagination>
|
|
1245
|
+
source:
|
|
1246
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1247
|
+
ComponentDom:
|
|
1248
|
+
docs: >
|
|
1249
|
+
The Component DOM schema represents the content structure of a component.
|
|
1250
|
+
Similar to Page DOM, it captures various content nodes and their
|
|
1251
|
+
associated attributes, but specifically for a component's structure. Each
|
|
1252
|
+
node has a unique identifier and can contain text, images, or nested
|
|
1253
|
+
component instances.
|
|
1254
|
+
properties:
|
|
1255
|
+
componentId:
|
|
1256
|
+
type: optional<string>
|
|
1257
|
+
docs: Component ID
|
|
1258
|
+
nodes: optional<list<Node>>
|
|
1259
|
+
pagination: optional<Pagination>
|
|
1260
|
+
source:
|
|
1261
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1262
|
+
ComponentProperties:
|
|
1263
|
+
docs: >
|
|
1264
|
+
The Component Properties schema represents a list of properties that store
|
|
1265
|
+
text content. Each property has a unique identifier and can be of
|
|
1266
|
+
different types like plain text or rich text. The schema also provides
|
|
1267
|
+
pagination details for scenarios where there more properties than the
|
|
1268
|
+
limit.
|
|
1269
|
+
properties:
|
|
1270
|
+
componentId:
|
|
1271
|
+
type: optional<string>
|
|
1272
|
+
docs: Component ID
|
|
1273
|
+
properties: optional<list<ComponentProperty>>
|
|
1274
|
+
pagination: optional<Pagination>
|
|
1275
|
+
source:
|
|
1276
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
990
1277
|
ScriptApplyLocation:
|
|
991
1278
|
enum:
|
|
992
1279
|
- header
|
|
@@ -995,8 +1282,9 @@ types:
|
|
|
995
1282
|
Location of the script, either in the header or footer of the published
|
|
996
1283
|
site
|
|
997
1284
|
default: header
|
|
1285
|
+
inline: true
|
|
998
1286
|
source:
|
|
999
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1287
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1000
1288
|
ScriptApply:
|
|
1001
1289
|
properties:
|
|
1002
1290
|
id:
|
|
@@ -1017,7 +1305,7 @@ types:
|
|
|
1017
1305
|
Developer-specified key/value pairs to be applied as attributes to the
|
|
1018
1306
|
script
|
|
1019
1307
|
source:
|
|
1020
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1308
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1021
1309
|
ScriptApplyList:
|
|
1022
1310
|
properties:
|
|
1023
1311
|
scripts:
|
|
@@ -1030,7 +1318,7 @@ types:
|
|
|
1030
1318
|
type: optional<string>
|
|
1031
1319
|
docs: Date when the Site's scripts were created
|
|
1032
1320
|
source:
|
|
1033
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1321
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1034
1322
|
CustomCodeHostedResponse:
|
|
1035
1323
|
docs: Registered custom code for application
|
|
1036
1324
|
properties:
|
|
@@ -1066,13 +1354,13 @@ types:
|
|
|
1066
1354
|
type: optional<string>
|
|
1067
1355
|
docs: A Semantic Version (SemVer) string, denoting the version of the script
|
|
1068
1356
|
source:
|
|
1069
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1357
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1070
1358
|
RegisteredScriptList:
|
|
1071
1359
|
docs: A list of scripts registered to the site
|
|
1072
1360
|
properties:
|
|
1073
1361
|
registeredScripts: optional<list<CustomCodeHostedResponse>>
|
|
1074
1362
|
source:
|
|
1075
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1363
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1076
1364
|
CustomCodeInlineResponse:
|
|
1077
1365
|
docs: Registered custom code for application
|
|
1078
1366
|
properties:
|
|
@@ -1108,7 +1396,7 @@ types:
|
|
|
1108
1396
|
type: optional<string>
|
|
1109
1397
|
docs: A Semantic Version (SemVer) string, denoting the version of the script
|
|
1110
1398
|
source:
|
|
1111
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1399
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1112
1400
|
Scripts:
|
|
1113
1401
|
docs: A list of scripts applied to a Site or a Page
|
|
1114
1402
|
type: list<ScriptApply>
|
|
@@ -1117,8 +1405,9 @@ types:
|
|
|
1117
1405
|
- page
|
|
1118
1406
|
- site
|
|
1119
1407
|
docs: Whether the Custom Code script is applied at the Site-level or Page-level
|
|
1408
|
+
inline: true
|
|
1120
1409
|
source:
|
|
1121
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1410
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1122
1411
|
CustomCodeBlock:
|
|
1123
1412
|
docs: A specific instance of Custom Code applied to a Site or Page
|
|
1124
1413
|
properties:
|
|
@@ -1141,14 +1430,14 @@ types:
|
|
|
1141
1430
|
type: optional<datetime>
|
|
1142
1431
|
docs: The date the Block was most recently updated
|
|
1143
1432
|
source:
|
|
1144
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1433
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1145
1434
|
ListCustomCodeBlocks:
|
|
1146
1435
|
docs: Custom Code Blocks corresponding to where scripts were applied
|
|
1147
1436
|
properties:
|
|
1148
1437
|
blocks: optional<list<CustomCodeBlock>>
|
|
1149
1438
|
pagination: optional<Pagination>
|
|
1150
1439
|
source:
|
|
1151
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1440
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1152
1441
|
AssetVariant:
|
|
1153
1442
|
properties:
|
|
1154
1443
|
hostedUrl:
|
|
@@ -1178,7 +1467,7 @@ types:
|
|
|
1178
1467
|
type: optional<string>
|
|
1179
1468
|
docs: Any associated validation errors
|
|
1180
1469
|
source:
|
|
1181
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1470
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1182
1471
|
Asset:
|
|
1183
1472
|
properties:
|
|
1184
1473
|
id:
|
|
@@ -1215,13 +1504,13 @@ types:
|
|
|
1215
1504
|
type: optional<string>
|
|
1216
1505
|
docs: The visual description of the asset
|
|
1217
1506
|
source:
|
|
1218
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1507
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1219
1508
|
Assets:
|
|
1220
1509
|
docs: A list of assets
|
|
1221
1510
|
properties:
|
|
1222
1511
|
assets: optional<list<Asset>>
|
|
1223
1512
|
source:
|
|
1224
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1513
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1225
1514
|
AssetUploadUploadDetails:
|
|
1226
1515
|
docs: Metadata for uploading the asset binary
|
|
1227
1516
|
properties:
|
|
@@ -1237,7 +1526,7 @@ types:
|
|
|
1237
1526
|
content-type: optional<string>
|
|
1238
1527
|
Cache-Control: optional<string>
|
|
1239
1528
|
source:
|
|
1240
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1529
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1241
1530
|
inline: true
|
|
1242
1531
|
AssetUpload:
|
|
1243
1532
|
properties:
|
|
@@ -1275,7 +1564,7 @@ types:
|
|
|
1275
1564
|
type: optional<datetime>
|
|
1276
1565
|
docs: Date the asset metadata was last updated
|
|
1277
1566
|
source:
|
|
1278
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1567
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1279
1568
|
AssetFolder:
|
|
1280
1569
|
docs: Asset Folder details
|
|
1281
1570
|
properties:
|
|
@@ -1301,7 +1590,7 @@ types:
|
|
|
1301
1590
|
type: optional<datetime>
|
|
1302
1591
|
docs: Date that the Asset Folder was last updated on
|
|
1303
1592
|
source:
|
|
1304
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1593
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1305
1594
|
AssetFolderList:
|
|
1306
1595
|
docs: The Asset Folders object
|
|
1307
1596
|
properties:
|
|
@@ -1310,7 +1599,7 @@ types:
|
|
|
1310
1599
|
docs: A list of Asset folders
|
|
1311
1600
|
pagination: optional<Pagination>
|
|
1312
1601
|
source:
|
|
1313
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1602
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1314
1603
|
TriggerType:
|
|
1315
1604
|
enum:
|
|
1316
1605
|
- form_submission
|
|
@@ -1370,7 +1659,7 @@ types:
|
|
|
1370
1659
|
* `collection_item_unpublished` - Sends the
|
|
1371
1660
|
[collection_item_unpublished](#collection_item_unpublished) event
|
|
1372
1661
|
source:
|
|
1373
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1662
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1374
1663
|
WebhookFilter:
|
|
1375
1664
|
docs: >-
|
|
1376
1665
|
Only supported for the `form_submission` trigger type. Filter for the form
|
|
@@ -1380,7 +1669,7 @@ types:
|
|
|
1380
1669
|
type: optional<string>
|
|
1381
1670
|
docs: The name of the form you'd like to recieve notifications for.
|
|
1382
1671
|
source:
|
|
1383
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1672
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1384
1673
|
inline: true
|
|
1385
1674
|
Webhook:
|
|
1386
1675
|
properties:
|
|
@@ -1409,13 +1698,13 @@ types:
|
|
|
1409
1698
|
type: optional<datetime>
|
|
1410
1699
|
docs: Date the Webhook registration was created
|
|
1411
1700
|
source:
|
|
1412
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1701
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1413
1702
|
WebhookList:
|
|
1414
1703
|
properties:
|
|
1415
1704
|
pagination: optional<Pagination>
|
|
1416
1705
|
webhooks: optional<list<Webhook>>
|
|
1417
1706
|
source:
|
|
1418
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1707
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1419
1708
|
FormFieldValueType:
|
|
1420
1709
|
enum:
|
|
1421
1710
|
- Plain
|
|
@@ -1424,8 +1713,9 @@ types:
|
|
|
1424
1713
|
- Phone
|
|
1425
1714
|
- Number
|
|
1426
1715
|
docs: The field type
|
|
1716
|
+
inline: true
|
|
1427
1717
|
source:
|
|
1428
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1718
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1429
1719
|
FormFieldValue:
|
|
1430
1720
|
docs: An object containing field info for a specific fieldID.
|
|
1431
1721
|
properties:
|
|
@@ -1442,7 +1732,8 @@ types:
|
|
|
1442
1732
|
type: optional<boolean>
|
|
1443
1733
|
docs: Whether the field is visible to the user
|
|
1444
1734
|
source:
|
|
1445
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1735
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1736
|
+
inline: true
|
|
1446
1737
|
FormField:
|
|
1447
1738
|
type: map<string, FormFieldValue>
|
|
1448
1739
|
docs: A collection of form fields with additional properties.
|
|
@@ -1462,7 +1753,7 @@ types:
|
|
|
1462
1753
|
type: optional<boolean>
|
|
1463
1754
|
docs: Whether to send an email confirmation to the user
|
|
1464
1755
|
source:
|
|
1465
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1756
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1466
1757
|
inline: true
|
|
1467
1758
|
Form:
|
|
1468
1759
|
docs: A Webflow form
|
|
@@ -1504,13 +1795,13 @@ types:
|
|
|
1504
1795
|
type: optional<string>
|
|
1505
1796
|
docs: The unique ID of the Workspace the Site belongs to
|
|
1506
1797
|
source:
|
|
1507
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1798
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1508
1799
|
FormList:
|
|
1509
1800
|
properties:
|
|
1510
1801
|
forms: optional<list<Form>>
|
|
1511
1802
|
pagination: optional<Pagination>
|
|
1512
1803
|
source:
|
|
1513
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1804
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1514
1805
|
FormSubmission:
|
|
1515
1806
|
properties:
|
|
1516
1807
|
id:
|
|
@@ -1532,13 +1823,13 @@ types:
|
|
|
1532
1823
|
type: optional<map<string, unknown>>
|
|
1533
1824
|
docs: The data submitted in the Form
|
|
1534
1825
|
source:
|
|
1535
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1826
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1536
1827
|
FormSubmissionList:
|
|
1537
1828
|
properties:
|
|
1538
1829
|
formSubmissions: optional<list<FormSubmission>>
|
|
1539
1830
|
pagination: optional<Pagination>
|
|
1540
1831
|
source:
|
|
1541
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1832
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1542
1833
|
UserDataData:
|
|
1543
1834
|
properties:
|
|
1544
1835
|
name:
|
|
@@ -1561,22 +1852,23 @@ types:
|
|
|
1561
1852
|
type: optional<string>
|
|
1562
1853
|
docs: Custom user attributes
|
|
1563
1854
|
source:
|
|
1564
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1855
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1565
1856
|
inline: true
|
|
1566
1857
|
UserData:
|
|
1567
1858
|
docs: An object containing the User's basic info and custom fields
|
|
1568
1859
|
properties:
|
|
1569
1860
|
data: optional<UserDataData>
|
|
1570
1861
|
source:
|
|
1571
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1862
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1572
1863
|
UserStatus:
|
|
1573
1864
|
enum:
|
|
1574
1865
|
- invited
|
|
1575
1866
|
- verified
|
|
1576
1867
|
- unverified
|
|
1577
1868
|
docs: The status of the user
|
|
1869
|
+
inline: true
|
|
1578
1870
|
source:
|
|
1579
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1871
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1580
1872
|
UserAccessGroupsItemType:
|
|
1581
1873
|
enum:
|
|
1582
1874
|
- admin
|
|
@@ -1585,8 +1877,9 @@ types:
|
|
|
1585
1877
|
The type of access group based on how it was assigned to the user.
|
|
1586
1878
|
* `admin` - Assigned to the user via API or in the designer
|
|
1587
1879
|
* `ecommerce` - Assigned to the user via an ecommerce purchase
|
|
1880
|
+
inline: true
|
|
1588
1881
|
source:
|
|
1589
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1882
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1590
1883
|
UserAccessGroupsItem:
|
|
1591
1884
|
docs: Access group slugs and types
|
|
1592
1885
|
properties:
|
|
@@ -1600,7 +1893,7 @@ types:
|
|
|
1600
1893
|
* `admin` - Assigned to the user via API or in the designer
|
|
1601
1894
|
* `ecommerce` - Assigned to the user via an ecommerce purchase
|
|
1602
1895
|
source:
|
|
1603
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1896
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1604
1897
|
inline: true
|
|
1605
1898
|
User:
|
|
1606
1899
|
docs: >
|
|
@@ -1635,7 +1928,7 @@ types:
|
|
|
1635
1928
|
docs: Access groups the user belongs to
|
|
1636
1929
|
data: optional<UserData>
|
|
1637
1930
|
source:
|
|
1638
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1931
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1639
1932
|
UserList:
|
|
1640
1933
|
docs: The list users results
|
|
1641
1934
|
properties:
|
|
@@ -1657,7 +1950,7 @@ types:
|
|
|
1657
1950
|
type: optional<list<User>>
|
|
1658
1951
|
docs: List of Users for a Site
|
|
1659
1952
|
source:
|
|
1660
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1953
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1661
1954
|
UsersNotEnabled: unknown
|
|
1662
1955
|
DuplicateUserEmail: unknown
|
|
1663
1956
|
UserLimitReached: unknown
|
|
@@ -1683,7 +1976,7 @@ types:
|
|
|
1683
1976
|
type: optional<datetime>
|
|
1684
1977
|
docs: The date the Access Group was created
|
|
1685
1978
|
source:
|
|
1686
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1979
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1687
1980
|
AccessGroupList:
|
|
1688
1981
|
docs: The list access groups results
|
|
1689
1982
|
properties:
|
|
@@ -1705,7 +1998,7 @@ types:
|
|
|
1705
1998
|
type: optional<list<AccessGroup>>
|
|
1706
1999
|
docs: List of Site Access Groups
|
|
1707
2000
|
source:
|
|
1708
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2001
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1709
2002
|
SkuPropertyListEnumItem:
|
|
1710
2003
|
docs: Enumerated Product variants/Options for the SKU
|
|
1711
2004
|
properties:
|
|
@@ -1719,7 +2012,7 @@ types:
|
|
|
1719
2012
|
type: string
|
|
1720
2013
|
docs: Slug for the Product variant/Option in the Site URL structure
|
|
1721
2014
|
source:
|
|
1722
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2015
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1723
2016
|
inline: true
|
|
1724
2017
|
SkuPropertyList:
|
|
1725
2018
|
docs: A variant/option type for a SKU
|
|
@@ -1736,7 +2029,7 @@ types:
|
|
|
1736
2029
|
collection
|
|
1737
2030
|
type: list<SkuPropertyListEnumItem>
|
|
1738
2031
|
source:
|
|
1739
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2032
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1740
2033
|
ProductFieldDataTaxCategory:
|
|
1741
2034
|
enum:
|
|
1742
2035
|
- value: standard-taxable
|
|
@@ -1797,8 +2090,9 @@ types:
|
|
|
1797
2090
|
- value: service-training
|
|
1798
2091
|
name: ServiceTraining
|
|
1799
2092
|
docs: Product tax class
|
|
2093
|
+
inline: true
|
|
1800
2094
|
source:
|
|
1801
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2095
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1802
2096
|
ProductFieldDataEcProductType:
|
|
1803
2097
|
enum:
|
|
1804
2098
|
- ff42fee0113744f693a764e3431a9cc2
|
|
@@ -1810,8 +2104,9 @@ types:
|
|
|
1810
2104
|
href="https://university.webflow.com/lesson/add-and-manage-products-and-categories?topics=ecommerce#how-to-understand-product-types">Product
|
|
1811
2105
|
types.</a> Enums reflect the following values in order: Physical, Digital,
|
|
1812
2106
|
Service, Advanced"
|
|
2107
|
+
inline: true
|
|
1813
2108
|
source:
|
|
1814
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2109
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1815
2110
|
ProductFieldData:
|
|
1816
2111
|
docs: >-
|
|
1817
2112
|
Contains content-specific details for a product, covering both standard
|
|
@@ -1850,7 +2145,7 @@ types:
|
|
|
1850
2145
|
types.</a> Enums reflect the following values in order: Physical,
|
|
1851
2146
|
Digital, Service, Advanced"
|
|
1852
2147
|
source:
|
|
1853
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2148
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1854
2149
|
Product:
|
|
1855
2150
|
docs: The Product object
|
|
1856
2151
|
properties:
|
|
@@ -1879,7 +2174,7 @@ types:
|
|
|
1879
2174
|
default: false
|
|
1880
2175
|
fieldData: optional<ProductFieldData>
|
|
1881
2176
|
source:
|
|
1882
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2177
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1883
2178
|
SkuValueList:
|
|
1884
2179
|
type: map<string, string>
|
|
1885
2180
|
docs: >
|
|
@@ -1895,7 +2190,7 @@ types:
|
|
|
1895
2190
|
type: optional<string>
|
|
1896
2191
|
docs: Currency of Item
|
|
1897
2192
|
source:
|
|
1898
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2193
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1899
2194
|
inline: true
|
|
1900
2195
|
SkuFieldDataCompareAtPrice:
|
|
1901
2196
|
docs: comparison price of SKU
|
|
@@ -1907,15 +2202,16 @@ types:
|
|
|
1907
2202
|
type: optional<string>
|
|
1908
2203
|
docs: Currency of Item
|
|
1909
2204
|
source:
|
|
1910
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2205
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1911
2206
|
inline: true
|
|
1912
2207
|
SkuFieldDataEcSkuBillingMethod:
|
|
1913
2208
|
enum:
|
|
1914
2209
|
- value: one-time
|
|
1915
2210
|
name: OneTime
|
|
1916
2211
|
- subscription
|
|
2212
|
+
inline: true
|
|
1917
2213
|
source:
|
|
1918
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2214
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1919
2215
|
SkuFieldDataEcSkuSubscriptionPlanInterval:
|
|
1920
2216
|
enum:
|
|
1921
2217
|
- day
|
|
@@ -1923,16 +2219,18 @@ types:
|
|
|
1923
2219
|
- month
|
|
1924
2220
|
- year
|
|
1925
2221
|
docs: Interval of subscription renewal
|
|
2222
|
+
inline: true
|
|
1926
2223
|
source:
|
|
1927
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2224
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1928
2225
|
SkuFieldDataEcSkuSubscriptionPlanPlansItemStatus:
|
|
1929
2226
|
enum:
|
|
1930
2227
|
- active
|
|
1931
2228
|
- inactive
|
|
1932
2229
|
- canceled
|
|
1933
2230
|
docs: The status of the plan
|
|
2231
|
+
inline: true
|
|
1934
2232
|
source:
|
|
1935
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2233
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1936
2234
|
SkuFieldDataEcSkuSubscriptionPlanPlansItem:
|
|
1937
2235
|
properties:
|
|
1938
2236
|
platform:
|
|
@@ -1945,7 +2243,7 @@ types:
|
|
|
1945
2243
|
type: optional<SkuFieldDataEcSkuSubscriptionPlanPlansItemStatus>
|
|
1946
2244
|
docs: The status of the plan
|
|
1947
2245
|
source:
|
|
1948
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2246
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1949
2247
|
inline: true
|
|
1950
2248
|
SkuFieldDataEcSkuSubscriptionPlan:
|
|
1951
2249
|
properties:
|
|
@@ -1960,7 +2258,7 @@ types:
|
|
|
1960
2258
|
docs: Number of days of a trial
|
|
1961
2259
|
plans: optional<list<SkuFieldDataEcSkuSubscriptionPlanPlansItem>>
|
|
1962
2260
|
source:
|
|
1963
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2261
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1964
2262
|
inline: true
|
|
1965
2263
|
SkuFieldData:
|
|
1966
2264
|
docs: Standard and Custom fields for a SKU
|
|
@@ -1990,7 +2288,7 @@ types:
|
|
|
1990
2288
|
type: optional<double>
|
|
1991
2289
|
docs: Quantity of SKU that will be tracked as items are ordered.
|
|
1992
2290
|
source:
|
|
1993
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2291
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1994
2292
|
Sku:
|
|
1995
2293
|
docs: The SKU object
|
|
1996
2294
|
properties:
|
|
@@ -2011,7 +2309,7 @@ types:
|
|
|
2011
2309
|
docs: The date the Product was created
|
|
2012
2310
|
fieldData: optional<SkuFieldData>
|
|
2013
2311
|
source:
|
|
2014
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2312
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2015
2313
|
ProductAndSkUs:
|
|
2016
2314
|
docs: A product and its SKUs.
|
|
2017
2315
|
properties:
|
|
@@ -2020,7 +2318,7 @@ types:
|
|
|
2020
2318
|
type: optional<list<Sku>>
|
|
2021
2319
|
docs: A list of SKU Objects
|
|
2022
2320
|
source:
|
|
2023
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2321
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2024
2322
|
ProductAndSkUsList:
|
|
2025
2323
|
docs: Results from product list
|
|
2026
2324
|
properties:
|
|
@@ -2031,7 +2329,7 @@ types:
|
|
|
2031
2329
|
keys for each Item
|
|
2032
2330
|
pagination: optional<Pagination>
|
|
2033
2331
|
source:
|
|
2034
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2332
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2035
2333
|
PublishStatus:
|
|
2036
2334
|
enum:
|
|
2037
2335
|
- staging
|
|
@@ -2039,7 +2337,7 @@ types:
|
|
|
2039
2337
|
docs: Indicate whether your Product should be set as "staging" or "live"
|
|
2040
2338
|
default: staging
|
|
2041
2339
|
source:
|
|
2042
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2340
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2043
2341
|
OrderPrice:
|
|
2044
2342
|
properties:
|
|
2045
2343
|
unit:
|
|
@@ -2052,14 +2350,15 @@ types:
|
|
|
2052
2350
|
type: optional<string>
|
|
2053
2351
|
docs: The user-facing string representation of the amount
|
|
2054
2352
|
source:
|
|
2055
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2353
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2056
2354
|
OrderAddressType:
|
|
2057
2355
|
enum:
|
|
2058
2356
|
- shipping
|
|
2059
2357
|
- billing
|
|
2060
2358
|
docs: The type of the order address (billing or shipping)
|
|
2359
|
+
inline: true
|
|
2061
2360
|
source:
|
|
2062
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2361
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2063
2362
|
OrderAddressJapanType:
|
|
2064
2363
|
enum:
|
|
2065
2364
|
- kana
|
|
@@ -2067,8 +2366,9 @@ types:
|
|
|
2067
2366
|
docs: >-
|
|
2068
2367
|
Represents a Japan-only address format. This field will only appear on
|
|
2069
2368
|
orders placed from Japan.
|
|
2369
|
+
inline: true
|
|
2070
2370
|
source:
|
|
2071
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2371
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2072
2372
|
OrderAddress:
|
|
2073
2373
|
docs: A customer address
|
|
2074
2374
|
properties:
|
|
@@ -2102,7 +2402,7 @@ types:
|
|
|
2102
2402
|
type: optional<string>
|
|
2103
2403
|
docs: The postal code of the address
|
|
2104
2404
|
source:
|
|
2105
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2405
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2106
2406
|
OrderPurchasedItemVariantImageFileVariantsItem:
|
|
2107
2407
|
properties:
|
|
2108
2408
|
url:
|
|
@@ -2121,7 +2421,7 @@ types:
|
|
|
2121
2421
|
type: optional<integer>
|
|
2122
2422
|
docs: The image height in pixels
|
|
2123
2423
|
source:
|
|
2124
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2424
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2125
2425
|
inline: true
|
|
2126
2426
|
OrderPurchasedItemVariantImageFile:
|
|
2127
2427
|
properties:
|
|
@@ -2147,7 +2447,7 @@ types:
|
|
|
2147
2447
|
type: optional<list<OrderPurchasedItemVariantImageFileVariantsItem>>
|
|
2148
2448
|
docs: Variants of the supplied image
|
|
2149
2449
|
source:
|
|
2150
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2450
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2151
2451
|
inline: true
|
|
2152
2452
|
OrderPurchasedItemVariantImage:
|
|
2153
2453
|
properties:
|
|
@@ -2158,7 +2458,7 @@ types:
|
|
|
2158
2458
|
format: uri
|
|
2159
2459
|
file: optional<OrderPurchasedItemVariantImageFile>
|
|
2160
2460
|
source:
|
|
2161
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2461
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2162
2462
|
inline: true
|
|
2163
2463
|
OrderPurchasedItem:
|
|
2164
2464
|
docs: An Item that was purchased
|
|
@@ -2207,7 +2507,7 @@ types:
|
|
|
2207
2507
|
type: optional<double>
|
|
2208
2508
|
docs: The physical length of the variant if provided, or null
|
|
2209
2509
|
source:
|
|
2210
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2510
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2211
2511
|
StripeDetails:
|
|
2212
2512
|
docs: >-
|
|
2213
2513
|
An object with various Stripe IDs, useful for linking into the stripe
|
|
@@ -2238,7 +2538,7 @@ types:
|
|
|
2238
2538
|
type: optional<string>
|
|
2239
2539
|
docs: Stripe-generated refund reason, or null
|
|
2240
2540
|
source:
|
|
2241
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2541
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2242
2542
|
StripeCardBrand:
|
|
2243
2543
|
enum:
|
|
2244
2544
|
- Visa
|
|
@@ -2251,8 +2551,9 @@ types:
|
|
|
2251
2551
|
name: DinersClub
|
|
2252
2552
|
- Unknown
|
|
2253
2553
|
docs: The card's brand (ie. credit card network)
|
|
2554
|
+
inline: true
|
|
2254
2555
|
source:
|
|
2255
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2556
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2256
2557
|
StripeCardExpires:
|
|
2257
2558
|
docs: The card's expiration date.
|
|
2258
2559
|
properties:
|
|
@@ -2263,7 +2564,7 @@ types:
|
|
|
2263
2564
|
type: optional<double>
|
|
2264
2565
|
docs: Month that the card expires
|
|
2265
2566
|
source:
|
|
2266
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2567
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2267
2568
|
inline: true
|
|
2268
2569
|
StripeCard:
|
|
2269
2570
|
docs: >
|
|
@@ -2283,7 +2584,7 @@ types:
|
|
|
2283
2584
|
type: optional<StripeCardExpires>
|
|
2284
2585
|
docs: The card's expiration date.
|
|
2285
2586
|
source:
|
|
2286
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2587
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2287
2588
|
PaypalDetails:
|
|
2288
2589
|
properties:
|
|
2289
2590
|
orderId:
|
|
@@ -2305,7 +2606,7 @@ types:
|
|
|
2305
2606
|
type: optional<string>
|
|
2306
2607
|
docs: PayPal dispute identifier
|
|
2307
2608
|
source:
|
|
2308
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2609
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2309
2610
|
OrderStatus:
|
|
2310
2611
|
enum:
|
|
2311
2612
|
- pending
|
|
@@ -2317,8 +2618,9 @@ types:
|
|
|
2317
2618
|
- refunded
|
|
2318
2619
|
docs: |
|
|
2319
2620
|
The status of the Order
|
|
2621
|
+
inline: true
|
|
2320
2622
|
source:
|
|
2321
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2623
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2322
2624
|
OrderDisputeLastStatus:
|
|
2323
2625
|
enum:
|
|
2324
2626
|
- warning_needs_response
|
|
@@ -2332,8 +2634,9 @@ types:
|
|
|
2332
2634
|
docs: >
|
|
2333
2635
|
If an order was disputed by the customer, then this key will be set with
|
|
2334
2636
|
the [dispute's status](https://stripe.com/docs/api#dispute_object-status).
|
|
2637
|
+
inline: true
|
|
2335
2638
|
source:
|
|
2336
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2639
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2337
2640
|
OrderCustomerInfo:
|
|
2338
2641
|
docs: An object with the keys `fullName` and `email`.
|
|
2339
2642
|
properties:
|
|
@@ -2346,13 +2649,13 @@ types:
|
|
|
2346
2649
|
validation:
|
|
2347
2650
|
format: email
|
|
2348
2651
|
source:
|
|
2349
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2652
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2350
2653
|
inline: true
|
|
2351
2654
|
OrderMetadata:
|
|
2352
2655
|
properties:
|
|
2353
2656
|
isBuyNow: optional<boolean>
|
|
2354
2657
|
source:
|
|
2355
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2658
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2356
2659
|
inline: true
|
|
2357
2660
|
OrderTotalsExtrasItemType:
|
|
2358
2661
|
enum:
|
|
@@ -2362,8 +2665,9 @@ types:
|
|
|
2362
2665
|
- shipping
|
|
2363
2666
|
- tax
|
|
2364
2667
|
docs: The type of extra item this is.
|
|
2668
|
+
inline: true
|
|
2365
2669
|
source:
|
|
2366
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2670
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2367
2671
|
OrderTotalsExtrasItem:
|
|
2368
2672
|
docs: Extra order items, includes discounts, shipping, and taxes.
|
|
2369
2673
|
properties:
|
|
@@ -2380,7 +2684,7 @@ types:
|
|
|
2380
2684
|
type: optional<OrderPrice>
|
|
2381
2685
|
docs: The price for the item
|
|
2382
2686
|
source:
|
|
2383
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2687
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2384
2688
|
inline: true
|
|
2385
2689
|
OrderTotals:
|
|
2386
2690
|
docs: An object describing various pricing totals
|
|
@@ -2395,7 +2699,7 @@ types:
|
|
|
2395
2699
|
type: optional<OrderPrice>
|
|
2396
2700
|
docs: The total price
|
|
2397
2701
|
source:
|
|
2398
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2702
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2399
2703
|
inline: true
|
|
2400
2704
|
OrderDownloadFilesItem:
|
|
2401
2705
|
properties:
|
|
@@ -2411,7 +2715,7 @@ types:
|
|
|
2411
2715
|
validation:
|
|
2412
2716
|
format: uri
|
|
2413
2717
|
source:
|
|
2414
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2718
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2415
2719
|
inline: true
|
|
2416
2720
|
Order:
|
|
2417
2721
|
properties:
|
|
@@ -2540,7 +2844,7 @@ types:
|
|
|
2540
2844
|
type: optional<list<OrderDownloadFilesItem>>
|
|
2541
2845
|
docs: An array of downloadable file objects.
|
|
2542
2846
|
source:
|
|
2543
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2847
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2544
2848
|
OrderList:
|
|
2545
2849
|
docs: Results from order list
|
|
2546
2850
|
properties:
|
|
@@ -2549,14 +2853,15 @@ types:
|
|
|
2549
2853
|
docs: List of orders
|
|
2550
2854
|
pagination: optional<Pagination>
|
|
2551
2855
|
source:
|
|
2552
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2856
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2553
2857
|
InventoryItemInventoryType:
|
|
2554
2858
|
enum:
|
|
2555
2859
|
- infinite
|
|
2556
2860
|
- finite
|
|
2557
2861
|
docs: infinite or finite
|
|
2862
|
+
inline: true
|
|
2558
2863
|
source:
|
|
2559
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2864
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2560
2865
|
InventoryItem:
|
|
2561
2866
|
docs: The availabile inventory for an item
|
|
2562
2867
|
properties:
|
|
@@ -2572,7 +2877,7 @@ types:
|
|
|
2572
2877
|
type: optional<InventoryItemInventoryType>
|
|
2573
2878
|
docs: infinite or finite
|
|
2574
2879
|
source:
|
|
2575
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2880
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2576
2881
|
EcommerceSettings:
|
|
2577
2882
|
docs: Ecommerce settings for a Webflow Site
|
|
2578
2883
|
properties:
|
|
@@ -2586,4 +2891,4 @@ types:
|
|
|
2586
2891
|
type: optional<string>
|
|
2587
2892
|
docs: The three-letter ISO currency code for the Site
|
|
2588
2893
|
source:
|
|
2589
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2894
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|