webflow-api 3.0.1 → 3.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.mock/definition/__package__.yml +876 -287
- package/.mock/definition/accessGroups.yml +4 -3
- package/.mock/definition/assets.yml +96 -56
- package/.mock/definition/collections/fields.yml +67 -48
- package/.mock/definition/collections/items.yml +226 -65
- package/.mock/definition/collections.yml +48 -12
- package/.mock/definition/components.yml +479 -0
- package/.mock/definition/ecommerce.yml +3 -2
- package/.mock/definition/forms.yml +121 -8
- package/.mock/definition/inventory.yml +8 -4
- package/.mock/definition/orders.yml +17 -77
- package/.mock/definition/pages/scripts.yml +17 -50
- package/.mock/definition/pages.yml +87 -65
- package/.mock/definition/products.yml +18 -9
- package/.mock/definition/scripts.yml +22 -57
- package/.mock/definition/sites/activityLogs.yml +12 -9
- package/.mock/definition/sites/plans.yml +46 -0
- package/.mock/definition/sites/redirects.yml +213 -0
- package/.mock/definition/sites/robotsTxt.yml +202 -0
- package/.mock/definition/sites/scripts.yml +28 -41
- package/.mock/definition/sites.yml +201 -8
- package/.mock/definition/token.yml +7 -4
- package/.mock/definition/users.yml +12 -8
- package/.mock/definition/webhooks.yml +16 -17
- 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 +15 -7
- package/api/resources/assets/client/Client.js +23 -15
- package/api/resources/collections/client/Client.d.ts +24 -1
- package/api/resources/collections/client/Client.js +30 -5
- package/api/resources/collections/client/requests/CollectionsCreateRequest.d.ts +23 -1
- package/api/resources/collections/resources/fields/client/Client.d.ts +34 -4
- package/api/resources/collections/resources/fields/client/Client.js +40 -8
- package/api/resources/collections/resources/fields/client/requests/index.d.ts +0 -1
- package/api/resources/collections/resources/fields/index.d.ts +0 -1
- package/api/resources/collections/resources/fields/index.js +0 -1
- package/api/resources/collections/resources/index.d.ts +1 -2
- package/api/resources/collections/resources/index.js +2 -3
- package/api/resources/collections/resources/items/client/Client.d.ts +26 -16
- package/api/resources/collections/resources/items/client/Client.js +48 -32
- package/api/resources/collections/resources/items/client/requests/ItemsListItemsLiveRequest.d.ts +2 -2
- package/api/resources/collections/resources/items/client/requests/ItemsListItemsRequest.d.ts +2 -2
- package/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.d.ts +1 -1
- package/api/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.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 +175 -0
- package/api/resources/components/client/Client.js +669 -0
- package/api/resources/components/client/index.d.ts +1 -0
- package/api/resources/{collections/resources/fields/types → components/client}/index.js +1 -1
- 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/ComponentPropertiesWritePropertiesItem.d.ts +16 -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 +54 -0
- package/api/resources/forms/client/Client.js +229 -5
- package/api/resources/forms/client/requests/FormsListSubmissionsBySiteRequest.d.ts +23 -0
- package/api/resources/forms/client/requests/FormsListSubmissionsBySiteRequest.js +5 -0
- package/api/resources/forms/client/requests/index.d.ts +1 -0
- 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 +31 -10
- package/api/resources/pages/client/Client.js +37 -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 +8 -19
- package/api/resources/pages/resources/scripts/client/Client.js +13 -22
- 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 +12 -20
- package/api/resources/scripts/client/Client.js +15 -23
- package/api/resources/sites/client/Client.d.ts +79 -0
- package/api/resources/sites/client/Client.js +341 -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 +5 -1
- package/api/resources/sites/resources/activityLogs/client/Client.js +6 -2
- package/api/resources/sites/resources/index.d.ts +3 -0
- package/api/resources/sites/resources/index.js +4 -1
- package/api/resources/sites/resources/plans/client/Client.d.ts +47 -0
- package/api/resources/sites/resources/plans/client/Client.js +157 -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/{dist/serialization/resources/collections/resources/fields/types → api/resources/sites/resources/plans}/index.js +1 -1
- package/api/resources/sites/resources/redirects/client/Client.d.ts +125 -0
- package/api/resources/sites/resources/redirects/client/Client.js +482 -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/{dist/api/resources/collections/resources/fields/types → api/resources/sites/resources/redirects}/index.js +1 -1
- package/api/resources/sites/resources/robotsTxt/client/Client.d.ts +124 -0
- package/api/resources/sites/resources/robotsTxt/client/Client.js +486 -0
- package/api/resources/sites/resources/robotsTxt/client/index.d.ts +1 -0
- package/api/resources/sites/resources/robotsTxt/client/index.js +2 -0
- package/api/resources/sites/resources/robotsTxt/index.d.ts +1 -0
- package/{serialization/resources/collections/resources/fields/types → api/resources/sites/resources/robotsTxt}/index.js +1 -1
- package/api/resources/sites/resources/scripts/client/Client.d.ts +15 -13
- package/api/resources/sites/resources/scripts/client/Client.js +19 -17
- 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/users/client/requests/UsersInviteRequest.d.ts +1 -4
- package/api/resources/users/client/requests/UsersUpdateRequest.d.ts +1 -4
- package/api/resources/webhooks/client/Client.d.ts +4 -1
- package/api/resources/webhooks/client/Client.js +8 -5
- package/api/types/Asset.d.ts +4 -0
- package/api/types/AssetVariant.d.ts +3 -0
- package/api/types/Assets.d.ts +1 -0
- 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/{dist/api/types/ErrorDetailsItem.d.ts → api/types/Conflict.d.ts} +1 -1
- package/api/types/Conflict.js +5 -0
- package/api/types/Dom.d.ts +3 -1
- package/api/types/Domain.d.ts +2 -0
- package/api/types/Error_.d.ts +1 -1
- package/api/types/FieldCreate.d.ts +8 -0
- package/api/types/FieldCreate.js +5 -0
- package/api/types/FieldType.d.ts +12 -10
- package/api/types/FieldType.js +11 -9
- package/api/types/ImageNode.d.ts +7 -2
- package/api/types/ImageNodeImage.d.ts +10 -0
- package/api/types/ImageNodeImage.js +5 -0
- package/api/types/Metadata.d.ts +11 -0
- package/api/types/Metadata.js +5 -0
- package/api/types/MetadataOptionsItem.d.ts +12 -0
- package/api/types/MetadataOptionsItem.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/OAuthScope.d.ts +8 -0
- package/api/types/OAuthScope.js +2 -0
- package/api/types/OptionField.d.ts +19 -0
- package/api/types/OptionField.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/ReferenceField.d.ts +20 -0
- package/api/types/ReferenceField.js +5 -0
- package/api/types/ReferenceFieldMetadata.d.ts +10 -0
- package/api/types/ReferenceFieldMetadata.js +5 -0
- package/api/types/ReferenceFieldType.d.ts +11 -0
- package/api/types/{NodeType.js → ReferenceFieldType.js} +4 -4
- package/api/types/Robots.d.ts +13 -0
- package/api/types/Robots.js +5 -0
- package/api/types/RobotsRulesItem.d.ts +11 -0
- package/api/types/RobotsRulesItem.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/SkuFieldData.d.ts +2 -0
- package/api/types/SkuFieldDataEcSkuBillingMethod.d.ts +3 -0
- package/api/types/SkuFieldDataEcSkuSubscriptionPlan.d.ts +3 -0
- package/api/{resources/collections/resources/fields/client/requests/FieldCreate.d.ts → types/StaticField.d.ts} +7 -12
- package/api/types/StaticField.js +5 -0
- package/api/{resources/collections/resources/fields/types/FieldCreateType.d.ts → types/StaticFieldType.d.ts} +11 -11
- package/{dist/api/resources/collections/resources/fields/types/FieldCreateType.js → api/types/StaticFieldType.js} +11 -11
- package/api/types/Text.d.ts +12 -0
- package/api/types/Text.js +5 -0
- package/api/types/TextNode.d.ts +8 -3
- package/api/types/TextNodeText.d.ts +12 -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 +1 -15
- package/api/types/UserAccessGroupsItem.d.ts +2 -3
- package/api/types/UserAccessGroupsItemType.d.ts +2 -3
- package/api/types/WebhookList.d.ts +1 -1
- package/api/types/index.d.ts +35 -6
- package/api/types/index.js +35 -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 +15 -7
- package/dist/api/resources/assets/client/Client.js +23 -15
- package/dist/api/resources/collections/client/Client.d.ts +24 -1
- package/dist/api/resources/collections/client/Client.js +30 -5
- package/dist/api/resources/collections/client/requests/CollectionsCreateRequest.d.ts +23 -1
- package/dist/api/resources/collections/resources/fields/client/Client.d.ts +34 -4
- package/dist/api/resources/collections/resources/fields/client/Client.js +40 -8
- package/dist/api/resources/collections/resources/fields/client/requests/index.d.ts +0 -1
- package/dist/api/resources/collections/resources/fields/index.d.ts +0 -1
- package/dist/api/resources/collections/resources/fields/index.js +0 -1
- package/dist/api/resources/collections/resources/index.d.ts +1 -2
- package/dist/api/resources/collections/resources/index.js +2 -3
- package/dist/api/resources/collections/resources/items/client/Client.d.ts +26 -16
- package/dist/api/resources/collections/resources/items/client/Client.js +48 -32
- package/dist/api/resources/collections/resources/items/client/requests/ItemsListItemsLiveRequest.d.ts +2 -2
- package/dist/api/resources/collections/resources/items/client/requests/ItemsListItemsRequest.d.ts +2 -2
- package/dist/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.d.ts +1 -1
- package/dist/api/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.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 +175 -0
- package/dist/api/resources/components/client/Client.js +669 -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 +54 -0
- package/dist/api/resources/forms/client/Client.js +229 -5
- package/dist/api/resources/forms/client/requests/FormsListSubmissionsBySiteRequest.d.ts +23 -0
- package/dist/api/resources/forms/client/requests/FormsListSubmissionsBySiteRequest.js +5 -0
- package/dist/api/resources/forms/client/requests/index.d.ts +1 -0
- 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 +31 -10
- package/dist/api/resources/pages/client/Client.js +37 -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 +8 -19
- package/dist/api/resources/pages/resources/scripts/client/Client.js +13 -22
- 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 +12 -20
- package/dist/api/resources/scripts/client/Client.js +15 -23
- package/dist/api/resources/sites/client/Client.d.ts +79 -0
- package/dist/api/resources/sites/client/Client.js +341 -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 +5 -1
- package/dist/api/resources/sites/resources/activityLogs/client/Client.js +6 -2
- package/dist/api/resources/sites/resources/index.d.ts +3 -0
- package/dist/api/resources/sites/resources/index.js +4 -1
- package/dist/api/resources/sites/resources/plans/client/Client.d.ts +47 -0
- package/dist/api/resources/sites/resources/plans/client/Client.js +157 -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 +125 -0
- package/dist/api/resources/sites/resources/redirects/client/Client.js +482 -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/robotsTxt/client/Client.d.ts +124 -0
- package/dist/api/resources/sites/resources/robotsTxt/client/Client.js +486 -0
- package/dist/api/resources/sites/resources/robotsTxt/client/index.d.ts +1 -0
- package/dist/api/resources/sites/resources/robotsTxt/client/index.js +2 -0
- package/dist/api/resources/sites/resources/robotsTxt/index.d.ts +1 -0
- package/dist/api/resources/sites/resources/robotsTxt/index.js +17 -0
- package/dist/api/resources/sites/resources/scripts/client/Client.d.ts +15 -13
- package/dist/api/resources/sites/resources/scripts/client/Client.js +19 -17
- 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/users/client/requests/UsersInviteRequest.d.ts +1 -4
- package/dist/api/resources/users/client/requests/UsersUpdateRequest.d.ts +1 -4
- 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/Asset.d.ts +4 -0
- package/dist/api/types/AssetVariant.d.ts +3 -0
- package/dist/api/types/Assets.d.ts +1 -0
- 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/Conflict.d.ts +4 -0
- package/dist/api/types/Conflict.js +5 -0
- package/dist/api/types/Dom.d.ts +3 -1
- package/dist/api/types/Domain.d.ts +2 -0
- package/dist/api/types/Error_.d.ts +1 -1
- package/dist/api/types/FieldCreate.d.ts +8 -0
- package/dist/api/types/FieldCreate.js +5 -0
- package/dist/api/types/FieldType.d.ts +12 -10
- package/dist/api/types/FieldType.js +11 -9
- package/dist/api/types/ImageNode.d.ts +7 -2
- package/dist/api/types/ImageNodeImage.d.ts +10 -0
- package/dist/api/types/ImageNodeImage.js +5 -0
- package/dist/api/types/Metadata.d.ts +11 -0
- package/dist/api/types/Metadata.js +5 -0
- package/dist/api/types/MetadataOptionsItem.d.ts +12 -0
- package/dist/api/types/MetadataOptionsItem.js +5 -0
- package/dist/api/types/Node.d.ts +11 -8
- package/dist/api/types/NotEnterprisePlanWorkspace.d.ts +4 -0
- package/dist/api/types/NotEnterprisePlanWorkspace.js +5 -0
- package/dist/api/types/OAuthScope.d.ts +8 -0
- package/dist/api/types/OAuthScope.js +2 -0
- package/dist/api/types/OptionField.d.ts +19 -0
- package/dist/api/types/OptionField.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/ReferenceField.d.ts +20 -0
- package/dist/api/types/ReferenceField.js +5 -0
- package/dist/api/types/ReferenceFieldMetadata.d.ts +10 -0
- package/dist/api/types/ReferenceFieldMetadata.js +5 -0
- package/dist/api/types/ReferenceFieldType.d.ts +11 -0
- package/dist/api/types/{NodeType.js → ReferenceFieldType.js} +4 -4
- package/dist/api/types/Robots.d.ts +13 -0
- package/dist/api/types/Robots.js +5 -0
- package/dist/api/types/RobotsRulesItem.d.ts +11 -0
- package/dist/api/types/RobotsRulesItem.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/SkuFieldData.d.ts +2 -0
- package/dist/api/types/SkuFieldDataEcSkuBillingMethod.d.ts +3 -0
- package/dist/api/types/SkuFieldDataEcSkuSubscriptionPlan.d.ts +3 -0
- package/dist/api/{resources/collections/resources/fields/client/requests/FieldCreate.d.ts → types/StaticField.d.ts} +7 -12
- package/dist/api/types/StaticField.js +5 -0
- package/dist/api/{resources/collections/resources/fields/types/FieldCreateType.d.ts → types/StaticFieldType.d.ts} +11 -11
- package/{api/resources/collections/resources/fields/types/FieldCreateType.js → dist/api/types/StaticFieldType.js} +11 -11
- package/dist/api/types/Text.d.ts +12 -0
- package/dist/api/types/Text.js +5 -0
- package/dist/api/types/TextNode.d.ts +8 -3
- package/dist/api/types/TextNodeText.d.ts +12 -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 +1 -15
- package/dist/api/types/UserAccessGroupsItem.d.ts +2 -3
- package/dist/api/types/UserAccessGroupsItemType.d.ts +2 -3
- package/dist/api/types/WebhookList.d.ts +1 -1
- package/dist/api/types/index.d.ts +35 -6
- package/dist/api/types/index.js +35 -6
- package/dist/serialization/resources/collections/client/requests/CollectionsCreateRequest.d.ts +2 -0
- package/dist/serialization/resources/collections/client/requests/CollectionsCreateRequest.js +2 -0
- package/dist/serialization/resources/collections/resources/fields/client/requests/index.d.ts +0 -1
- package/dist/serialization/resources/collections/resources/fields/client/requests/index.js +1 -3
- package/dist/serialization/resources/collections/resources/fields/index.d.ts +0 -1
- package/dist/serialization/resources/collections/resources/fields/index.js +0 -1
- package/dist/serialization/resources/collections/resources/index.d.ts +1 -2
- package/dist/serialization/resources/collections/resources/index.js +2 -3
- 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/ItemsDeleteItemsLiveRequestItemsItem.d.ts +1 -1
- package/dist/serialization/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.js +1 -1
- 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/dist/serialization/resources/{pages/client/requests/DomWrite.js → 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/Assets.d.ts +2 -0
- package/dist/serialization/types/Assets.js +2 -0
- 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/{NodeType.d.ts → Conflict.d.ts} +3 -3
- package/dist/serialization/types/{NodeType.js → Conflict.js} +2 -2
- package/dist/serialization/types/Dom.d.ts +1 -0
- package/dist/serialization/types/Dom.js +1 -0
- 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/FieldCreate.d.ts +13 -0
- package/dist/serialization/types/FieldCreate.js +34 -0
- package/dist/serialization/types/FieldType.d.ts +1 -1
- package/dist/serialization/types/FieldType.js +11 -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/Metadata.d.ts +13 -0
- package/dist/serialization/types/Metadata.js +34 -0
- package/dist/serialization/types/MetadataOptionsItem.d.ts +13 -0
- package/dist/serialization/types/MetadataOptionsItem.js +34 -0
- 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/NotEnterprisePlanWorkspace.js +31 -0
- package/dist/serialization/types/OptionField.d.ts +19 -0
- package/dist/serialization/types/OptionField.js +40 -0
- 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/ReferenceField.d.ts +20 -0
- package/dist/serialization/types/ReferenceField.js +41 -0
- package/dist/serialization/types/ReferenceFieldMetadata.d.ts +12 -0
- package/dist/serialization/types/ReferenceFieldMetadata.js +33 -0
- package/dist/serialization/types/ReferenceFieldType.d.ts +10 -0
- package/dist/serialization/types/ReferenceFieldType.js +31 -0
- package/dist/serialization/types/Robots.d.ts +14 -0
- package/dist/serialization/types/Robots.js +35 -0
- package/dist/serialization/types/RobotsRulesItem.d.ts +14 -0
- package/dist/serialization/types/RobotsRulesItem.js +35 -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/StaticField.d.ts +18 -0
- package/{serialization/resources/collections/resources/fields/client/requests/FieldCreate.js → dist/serialization/types/StaticField.js} +7 -5
- package/dist/serialization/types/StaticFieldType.d.ts +10 -0
- package/{serialization/resources/collections/resources/fields/types/FieldCreateType.js → dist/serialization/types/StaticFieldType.js} +12 -12
- 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/WebhookList.d.ts +2 -2
- package/dist/serialization/types/WebhookList.js +2 -2
- package/dist/serialization/types/index.d.ts +35 -6
- package/dist/serialization/types/index.js +35 -6
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/dist/wrapper/WebflowClient.d.ts +3 -0
- package/dist/wrapper/WebflowClient.js +5 -0
- package/dist/wrapper/WebhooksClient.d.ts +39 -0
- package/dist/wrapper/WebhooksClient.js +66 -0
- package/package.json +5 -3
- package/reference.md +2407 -847
- package/serialization/resources/collections/client/requests/CollectionsCreateRequest.d.ts +2 -0
- package/serialization/resources/collections/client/requests/CollectionsCreateRequest.js +2 -0
- package/serialization/resources/collections/resources/fields/client/requests/index.d.ts +0 -1
- package/serialization/resources/collections/resources/fields/client/requests/index.js +1 -3
- package/serialization/resources/collections/resources/fields/index.d.ts +0 -1
- package/serialization/resources/collections/resources/fields/index.js +0 -1
- package/serialization/resources/collections/resources/index.d.ts +1 -2
- package/serialization/resources/collections/resources/index.js +2 -3
- 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/ItemsDeleteItemsLiveRequestItemsItem.d.ts +1 -1
- package/serialization/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.js +1 -1
- 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/serialization/resources/{pages/client/requests/DomWrite.js → 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/Assets.d.ts +2 -0
- package/serialization/types/Assets.js +2 -0
- 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/{NodeType.d.ts → Conflict.d.ts} +3 -3
- package/serialization/types/{NodeType.js → Conflict.js} +2 -2
- package/serialization/types/Dom.d.ts +1 -0
- package/serialization/types/Dom.js +1 -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/FieldCreate.d.ts +13 -0
- package/serialization/types/FieldCreate.js +34 -0
- package/serialization/types/FieldType.d.ts +1 -1
- package/serialization/types/FieldType.js +11 -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/Metadata.d.ts +13 -0
- package/serialization/types/Metadata.js +34 -0
- package/serialization/types/MetadataOptionsItem.d.ts +13 -0
- package/serialization/types/MetadataOptionsItem.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/NotEnterprisePlanWorkspace.js +31 -0
- package/serialization/types/OptionField.d.ts +19 -0
- package/serialization/types/OptionField.js +40 -0
- 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/ReferenceField.d.ts +20 -0
- package/serialization/types/ReferenceField.js +41 -0
- package/serialization/types/ReferenceFieldMetadata.d.ts +12 -0
- package/serialization/types/ReferenceFieldMetadata.js +33 -0
- package/serialization/types/ReferenceFieldType.d.ts +10 -0
- package/serialization/types/ReferenceFieldType.js +31 -0
- package/serialization/types/Robots.d.ts +14 -0
- package/serialization/types/Robots.js +35 -0
- package/serialization/types/RobotsRulesItem.d.ts +14 -0
- package/serialization/types/RobotsRulesItem.js +35 -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/StaticField.d.ts +18 -0
- package/{dist/serialization/resources/collections/resources/fields/client/requests/FieldCreate.js → serialization/types/StaticField.js} +7 -5
- package/serialization/types/StaticFieldType.d.ts +10 -0
- package/{dist/serialization/resources/collections/resources/fields/types/FieldCreateType.js → serialization/types/StaticFieldType.js} +12 -12
- 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/WebhookList.d.ts +2 -2
- package/serialization/types/WebhookList.js +2 -2
- package/serialization/types/index.d.ts +35 -6
- package/serialization/types/index.js +35 -6
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/wrapper/WebflowClient.d.ts +3 -0
- package/wrapper/WebflowClient.js +5 -0
- package/wrapper/WebhooksClient.d.ts +39 -0
- package/wrapper/WebhooksClient.js +66 -0
- package/api/resources/collections/resources/fields/types/index.d.ts +0 -1
- package/api/resources/pages/client/requests/DomWrite.d.ts +0 -27
- package/api/types/NodeType.d.ts +0 -8
- package/dist/api/resources/collections/resources/fields/types/index.d.ts +0 -1
- package/dist/api/resources/pages/client/requests/DomWrite.d.ts +0 -27
- package/dist/api/types/NodeType.d.ts +0 -8
- package/dist/serialization/resources/collections/resources/fields/client/requests/FieldCreate.d.ts +0 -16
- package/dist/serialization/resources/collections/resources/fields/types/FieldCreateType.d.ts +0 -10
- package/dist/serialization/resources/collections/resources/fields/types/index.d.ts +0 -1
- 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/serialization/resources/collections/resources/fields/client/requests/FieldCreate.d.ts +0 -16
- package/serialization/resources/collections/resources/fields/types/FieldCreateType.d.ts +0 -10
- package/serialization/resources/collections/resources/fields/types/index.d.ts +0 -1
- 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/api/resources/collections/resources/{fields/client/requests/FieldCreate.js → items/types/MultipleLiveItems.js} +0 -0
- /package/api/resources/{pages/client/requests/DomWrite.js → components/client/requests/ComponentDomWrite.js} +0 -0
- /package/api/resources/{pages/types/DomWriteNodesItem.js → components/client/requests/ComponentPropertiesWrite.js} +0 -0
- /package/api/{types/ErrorDetailsItem.js → resources/components/client/requests/ComponentsGetContentRequest.js} +0 -0
- /package/{dist/api/resources/collections/resources/fields/client/requests/FieldCreate.js → api/resources/components/client/requests/ComponentsGetPropertiesRequest.js} +0 -0
- /package/{dist/api/resources/pages/client/requests/DomWrite.js → api/resources/components/client/requests/ComponentsListRequest.js} +0 -0
- /package/{dist/api/resources/pages/types/DomWriteNodesItem.js → api/resources/components/types/ComponentDomWriteNodesItem.js} +0 -0
- /package/{dist/api/types/ErrorDetailsItem.js → api/resources/components/types/ComponentPropertiesWritePropertiesItem.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
|
|
@@ -67,10 +67,21 @@ errors:
|
|
|
67
67
|
ConflictError:
|
|
68
68
|
status-code: 409
|
|
69
69
|
type: unknown
|
|
70
|
-
docs:
|
|
70
|
+
docs: Collection already exists
|
|
71
71
|
examples:
|
|
72
|
+
- value:
|
|
73
|
+
code: duplicate_collection
|
|
74
|
+
message: Collection already exists
|
|
72
75
|
- value:
|
|
73
76
|
message: '''Site is published to multiple domains at different times'
|
|
77
|
+
- value:
|
|
78
|
+
code: conflict
|
|
79
|
+
message: >-
|
|
80
|
+
Conflict: Conflict with server data: Live PATCH updates can't be
|
|
81
|
+
applied to items that have never been published
|
|
82
|
+
- value:
|
|
83
|
+
code: custom_code_max_registered_scripts
|
|
84
|
+
message: The maximum number of registered scripts has been reached.
|
|
74
85
|
- value:
|
|
75
86
|
code: forms_require_republish
|
|
76
87
|
message: To access this feature, the site needs to be republished.
|
|
@@ -80,27 +91,27 @@ errors:
|
|
|
80
91
|
code: ecommerce_not_enabled
|
|
81
92
|
message: Ecommerce is not yet initialized
|
|
82
93
|
types:
|
|
83
|
-
BadRequestErrorBody:
|
|
84
|
-
discriminated: false
|
|
85
|
-
union:
|
|
86
|
-
- InvalidDomain
|
|
87
|
-
- NoDomains
|
|
88
|
-
source:
|
|
89
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
90
94
|
ForbiddenErrorBody:
|
|
91
95
|
discriminated: false
|
|
92
96
|
union:
|
|
93
97
|
- InvalidScopes
|
|
94
98
|
- UsersNotEnabled
|
|
95
99
|
source:
|
|
96
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
100
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
101
|
+
BadRequestErrorBody:
|
|
102
|
+
discriminated: false
|
|
103
|
+
union:
|
|
104
|
+
- InvalidDomain
|
|
105
|
+
- NoDomains
|
|
106
|
+
source:
|
|
107
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
97
108
|
ConflictErrorBody:
|
|
98
109
|
discriminated: false
|
|
99
110
|
union:
|
|
100
111
|
- DuplicateUserEmail
|
|
101
112
|
- UserLimitReached
|
|
102
113
|
source:
|
|
103
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
114
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
104
115
|
AuthorizedUser:
|
|
105
116
|
properties:
|
|
106
117
|
id:
|
|
@@ -118,7 +129,7 @@ types:
|
|
|
118
129
|
type: optional<string>
|
|
119
130
|
docs: The user's last name
|
|
120
131
|
source:
|
|
121
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
132
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
122
133
|
ErrorCode:
|
|
123
134
|
enum:
|
|
124
135
|
- bad_request
|
|
@@ -151,16 +162,9 @@ types:
|
|
|
151
162
|
- users_not_enabled
|
|
152
163
|
- validation_error
|
|
153
164
|
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
165
|
inline: true
|
|
166
|
+
source:
|
|
167
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
164
168
|
Error:
|
|
165
169
|
properties:
|
|
166
170
|
code:
|
|
@@ -173,10 +177,10 @@ types:
|
|
|
173
177
|
type: optional<string>
|
|
174
178
|
docs: Link to more information
|
|
175
179
|
details:
|
|
176
|
-
type: optional<list<
|
|
180
|
+
type: optional<list<unknown>>
|
|
177
181
|
docs: Array of errors
|
|
178
182
|
source:
|
|
179
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
183
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
180
184
|
Application: unknown
|
|
181
185
|
AuthorizationAuthorizationAuthorizedTo:
|
|
182
186
|
properties:
|
|
@@ -190,7 +194,7 @@ types:
|
|
|
190
194
|
type: optional<list<unknown>>
|
|
191
195
|
docs: Array of Users this app is authorized to
|
|
192
196
|
source:
|
|
193
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
197
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
194
198
|
inline: true
|
|
195
199
|
AuthorizationAuthorization:
|
|
196
200
|
docs: The Authorization object
|
|
@@ -215,7 +219,7 @@ types:
|
|
|
215
219
|
docs: Comma separted list of OAuth scopes corresponding to the Authorization
|
|
216
220
|
authorizedTo: optional<AuthorizationAuthorizationAuthorizedTo>
|
|
217
221
|
source:
|
|
218
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
222
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
219
223
|
inline: true
|
|
220
224
|
Authorization:
|
|
221
225
|
properties:
|
|
@@ -224,17 +228,22 @@ types:
|
|
|
224
228
|
docs: The Authorization object
|
|
225
229
|
application: optional<Application>
|
|
226
230
|
source:
|
|
227
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
231
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
228
232
|
Domain:
|
|
229
233
|
properties:
|
|
230
234
|
id:
|
|
231
235
|
type: string
|
|
232
236
|
docs: Unique identifier for the Domain
|
|
237
|
+
access: read-only
|
|
233
238
|
url:
|
|
234
239
|
type: optional<string>
|
|
235
240
|
docs: The registered Domain name
|
|
241
|
+
lastPublished:
|
|
242
|
+
type: optional<datetime>
|
|
243
|
+
docs: The date the custom domain was last published to
|
|
244
|
+
access: read-only
|
|
236
245
|
source:
|
|
237
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
246
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
238
247
|
Locale:
|
|
239
248
|
properties:
|
|
240
249
|
id:
|
|
@@ -264,7 +273,7 @@ types:
|
|
|
264
273
|
A tag or code representing the locale, often following a standard
|
|
265
274
|
format like 'en-US'.
|
|
266
275
|
source:
|
|
267
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
276
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
268
277
|
Locales:
|
|
269
278
|
properties:
|
|
270
279
|
primary:
|
|
@@ -274,15 +283,16 @@ types:
|
|
|
274
283
|
type: optional<list<Locale>>
|
|
275
284
|
docs: A list of secondary locales available for the site or application.
|
|
276
285
|
source:
|
|
277
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
286
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
278
287
|
SiteDataCollectionType:
|
|
279
288
|
enum:
|
|
280
289
|
- always
|
|
281
290
|
- optOut
|
|
282
291
|
- disabled
|
|
283
292
|
docs: The type of data collection enabled for the site.
|
|
293
|
+
inline: true
|
|
284
294
|
source:
|
|
285
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
295
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
286
296
|
Site:
|
|
287
297
|
properties:
|
|
288
298
|
id:
|
|
@@ -326,19 +336,146 @@ types:
|
|
|
326
336
|
type: optional<SiteDataCollectionType>
|
|
327
337
|
docs: The type of data collection enabled for the site.
|
|
328
338
|
source:
|
|
329
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
339
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
340
|
+
InvalidScopes: unknown
|
|
341
|
+
NotEnterprisePlanWorkspace: unknown
|
|
330
342
|
Sites:
|
|
331
343
|
properties:
|
|
332
344
|
sites: optional<list<Site>>
|
|
333
345
|
source:
|
|
334
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
346
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
347
|
+
NotEnterprisePlanSite: unknown
|
|
335
348
|
Domains:
|
|
336
349
|
properties:
|
|
337
350
|
customDomains: optional<list<Domain>>
|
|
338
351
|
source:
|
|
339
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
352
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
340
353
|
InvalidDomain: unknown
|
|
341
354
|
NoDomains: unknown
|
|
355
|
+
Redirect:
|
|
356
|
+
docs: A single redirection rule, specifying a source URL and a destination URL.
|
|
357
|
+
properties:
|
|
358
|
+
id:
|
|
359
|
+
type: optional<string>
|
|
360
|
+
docs: The ID of the specific redirect rule
|
|
361
|
+
access: read-only
|
|
362
|
+
fromUrl:
|
|
363
|
+
type: optional<string>
|
|
364
|
+
docs: The source URL path that will be redirected.
|
|
365
|
+
toUrl:
|
|
366
|
+
type: optional<string>
|
|
367
|
+
docs: The target URL path where the user or client will be redirected.
|
|
368
|
+
source:
|
|
369
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
370
|
+
Pagination:
|
|
371
|
+
docs: Pagination object
|
|
372
|
+
properties:
|
|
373
|
+
limit:
|
|
374
|
+
type: double
|
|
375
|
+
docs: The limit used for pagination
|
|
376
|
+
offset:
|
|
377
|
+
type: double
|
|
378
|
+
docs: The offset used for pagination
|
|
379
|
+
total:
|
|
380
|
+
type: double
|
|
381
|
+
docs: The total number of records
|
|
382
|
+
source:
|
|
383
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
384
|
+
Redirects:
|
|
385
|
+
docs: Site redirects response
|
|
386
|
+
properties:
|
|
387
|
+
redirects:
|
|
388
|
+
type: optional<list<Redirect>>
|
|
389
|
+
docs: List of redirects for a given site
|
|
390
|
+
pagination: optional<Pagination>
|
|
391
|
+
source:
|
|
392
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
393
|
+
SitePlanId:
|
|
394
|
+
enum:
|
|
395
|
+
- value: hosting-basic-v3
|
|
396
|
+
name: HostingBasicV3
|
|
397
|
+
- value: hosting-cms-v3
|
|
398
|
+
name: HostingCmsV3
|
|
399
|
+
- value: hosting-business-v3
|
|
400
|
+
name: HostingBusinessV3
|
|
401
|
+
- value: hosting-ecommerce-standard-v2
|
|
402
|
+
name: HostingEcommerceStandardV2
|
|
403
|
+
- value: hosting-ecommerce-plus-v2
|
|
404
|
+
name: HostingEcommercePlusV2
|
|
405
|
+
- value: hosting-ecommerce-advanced-v2
|
|
406
|
+
name: HostingEcommerceAdvancedV2
|
|
407
|
+
- value: hosting-basic-v4
|
|
408
|
+
name: HostingBasicV4
|
|
409
|
+
- value: hosting-cms-v4
|
|
410
|
+
name: HostingCmsV4
|
|
411
|
+
- value: hosting-business-v4
|
|
412
|
+
name: HostingBusinessV4
|
|
413
|
+
- value: hosting-ecommerce-standard-v3
|
|
414
|
+
name: HostingEcommerceStandardV3
|
|
415
|
+
- value: hosting-ecommerce-plus-v3
|
|
416
|
+
name: HostingEcommercePlusV3
|
|
417
|
+
- value: hosting-ecommerce-advanced-v3
|
|
418
|
+
name: HostingEcommerceAdvancedV3
|
|
419
|
+
docs: ID of the hosting plan.
|
|
420
|
+
inline: true
|
|
421
|
+
source:
|
|
422
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
423
|
+
SitePlanName:
|
|
424
|
+
enum:
|
|
425
|
+
- value: Basic Hosting
|
|
426
|
+
name: BasicHosting
|
|
427
|
+
- value: CMS Hosting
|
|
428
|
+
name: CmsHosting
|
|
429
|
+
- value: Business Hosting
|
|
430
|
+
name: BusinessHosting
|
|
431
|
+
- value: ECommerce Standard Hosting
|
|
432
|
+
name: ECommerceStandardHosting
|
|
433
|
+
- value: ECommerce Plus Hosting
|
|
434
|
+
name: ECommercePlusHosting
|
|
435
|
+
- value: ECommerce Advanced Hosting
|
|
436
|
+
name: ECommerceAdvancedHosting
|
|
437
|
+
docs: Name of the hosting plan.
|
|
438
|
+
inline: true
|
|
439
|
+
source:
|
|
440
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
441
|
+
SitePlan:
|
|
442
|
+
properties:
|
|
443
|
+
id:
|
|
444
|
+
type: optional<SitePlanId>
|
|
445
|
+
docs: ID of the hosting plan.
|
|
446
|
+
name:
|
|
447
|
+
type: optional<SitePlanName>
|
|
448
|
+
docs: Name of the hosting plan.
|
|
449
|
+
pricingInfo:
|
|
450
|
+
type: optional<string>
|
|
451
|
+
docs: URL for more information about Webflow hosting plan pricing.
|
|
452
|
+
source:
|
|
453
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
454
|
+
RobotsRulesItem:
|
|
455
|
+
properties:
|
|
456
|
+
userAgent:
|
|
457
|
+
type: string
|
|
458
|
+
docs: The user agent the rules apply to.
|
|
459
|
+
allows:
|
|
460
|
+
type: optional<list<string>>
|
|
461
|
+
docs: List of paths allowed for this user agent.
|
|
462
|
+
disallows:
|
|
463
|
+
type: optional<list<string>>
|
|
464
|
+
docs: List of paths disallowed for this user agent.
|
|
465
|
+
source:
|
|
466
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
467
|
+
inline: true
|
|
468
|
+
Robots:
|
|
469
|
+
docs: The robots.txt file for a given site
|
|
470
|
+
properties:
|
|
471
|
+
rules:
|
|
472
|
+
type: optional<list<RobotsRulesItem>>
|
|
473
|
+
docs: List of rules for user agents.
|
|
474
|
+
sitemap:
|
|
475
|
+
type: optional<string>
|
|
476
|
+
docs: URL to the sitemap.
|
|
477
|
+
source:
|
|
478
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
342
479
|
SiteActivityLogItemEvent:
|
|
343
480
|
enum:
|
|
344
481
|
- styles_modified
|
|
@@ -383,8 +520,9 @@ types:
|
|
|
383
520
|
- branch_review_created
|
|
384
521
|
- branch_review_approved
|
|
385
522
|
- branch_review_canceled
|
|
523
|
+
inline: true
|
|
386
524
|
source:
|
|
387
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
525
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
388
526
|
SiteActivityLogItemResourceOperation:
|
|
389
527
|
enum:
|
|
390
528
|
- CREATED
|
|
@@ -396,14 +534,15 @@ types:
|
|
|
396
534
|
- GROUP_CREATED
|
|
397
535
|
- GROUP_DELETED
|
|
398
536
|
- REORDERED
|
|
537
|
+
inline: true
|
|
399
538
|
source:
|
|
400
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
539
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
401
540
|
SiteActivityLogItemUser:
|
|
402
541
|
properties:
|
|
403
542
|
id: optional<string>
|
|
404
543
|
displayName: optional<string>
|
|
405
544
|
source:
|
|
406
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
545
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
407
546
|
inline: true
|
|
408
547
|
SiteActivityLogItem:
|
|
409
548
|
properties:
|
|
@@ -419,35 +558,20 @@ types:
|
|
|
419
558
|
previousValue: optional<string>
|
|
420
559
|
payload: optional<map<string, unknown>>
|
|
421
560
|
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
|
|
561
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
437
562
|
SiteActivityLogResponse:
|
|
438
563
|
properties:
|
|
439
564
|
items: optional<list<SiteActivityLogItem>>
|
|
440
565
|
pagination: optional<Pagination>
|
|
441
566
|
source:
|
|
442
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
443
|
-
InvalidScopes: unknown
|
|
444
|
-
NotEnterprisePlanSite: unknown
|
|
567
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
445
568
|
CollectionListArrayItem:
|
|
446
569
|
docs: A collection object
|
|
447
570
|
properties:
|
|
448
571
|
id:
|
|
449
572
|
type: string
|
|
450
573
|
docs: Unique identifier for a Collection
|
|
574
|
+
access: read-only
|
|
451
575
|
displayName:
|
|
452
576
|
type: optional<string>
|
|
453
577
|
docs: Name given to the Collection
|
|
@@ -462,48 +586,203 @@ types:
|
|
|
462
586
|
createdOn:
|
|
463
587
|
type: optional<datetime>
|
|
464
588
|
docs: The date the collection was created
|
|
589
|
+
access: read-only
|
|
465
590
|
lastUpdated:
|
|
466
591
|
type: optional<datetime>
|
|
467
592
|
docs: The date the collection was last updated
|
|
593
|
+
access: read-only
|
|
468
594
|
source:
|
|
469
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
595
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
470
596
|
CollectionList:
|
|
471
597
|
properties:
|
|
472
598
|
collections:
|
|
473
599
|
type: optional<list<CollectionListArrayItem>>
|
|
474
600
|
docs: An array of Collections
|
|
475
601
|
source:
|
|
476
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
477
|
-
|
|
602
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
603
|
+
StaticFieldType:
|
|
478
604
|
enum:
|
|
479
|
-
-
|
|
480
|
-
-
|
|
605
|
+
- Color
|
|
606
|
+
- DateTime
|
|
607
|
+
- Email
|
|
608
|
+
- File
|
|
481
609
|
- Image
|
|
482
|
-
- MultiImage
|
|
483
|
-
- Video
|
|
484
610
|
- Link
|
|
485
|
-
-
|
|
486
|
-
- Phone
|
|
611
|
+
- MultiImage
|
|
487
612
|
- Number
|
|
488
|
-
-
|
|
613
|
+
- Phone
|
|
614
|
+
- PlainText
|
|
615
|
+
- RichText
|
|
489
616
|
- Switch
|
|
617
|
+
- Video
|
|
618
|
+
docs: Choose these appropriate field type for your collection data
|
|
619
|
+
inline: true
|
|
620
|
+
source:
|
|
621
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
622
|
+
Static Field:
|
|
623
|
+
properties:
|
|
624
|
+
id:
|
|
625
|
+
type: optional<string>
|
|
626
|
+
docs: Unique identifier for a Field
|
|
627
|
+
access: read-only
|
|
628
|
+
isEditable:
|
|
629
|
+
type: optional<boolean>
|
|
630
|
+
docs: Define whether the field is editable
|
|
631
|
+
access: read-only
|
|
632
|
+
isRequired:
|
|
633
|
+
type: optional<boolean>
|
|
634
|
+
docs: define whether a field is required in a collection
|
|
635
|
+
type:
|
|
636
|
+
type: StaticFieldType
|
|
637
|
+
docs: Choose these appropriate field type for your collection data
|
|
638
|
+
displayName:
|
|
639
|
+
type: string
|
|
640
|
+
docs: The name of a field
|
|
641
|
+
helpText:
|
|
642
|
+
type: optional<string>
|
|
643
|
+
docs: Additional text to help anyone filling out this field
|
|
644
|
+
source:
|
|
645
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
646
|
+
MetadataOptionsItem:
|
|
647
|
+
docs: A single option value for the Option field.
|
|
648
|
+
properties:
|
|
649
|
+
name:
|
|
650
|
+
type: string
|
|
651
|
+
docs: The name of the option
|
|
652
|
+
id:
|
|
653
|
+
type: optional<string>
|
|
654
|
+
docs: The unique identifier of the option
|
|
655
|
+
access: read-only
|
|
656
|
+
source:
|
|
657
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
658
|
+
inline: true
|
|
659
|
+
Metadata:
|
|
660
|
+
docs: The metadata for the Option field.
|
|
661
|
+
properties:
|
|
662
|
+
options:
|
|
663
|
+
docs: The option values for the Option field.
|
|
664
|
+
type: list<MetadataOptionsItem>
|
|
665
|
+
source:
|
|
666
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
667
|
+
Option Field:
|
|
668
|
+
properties:
|
|
669
|
+
id:
|
|
670
|
+
type: optional<string>
|
|
671
|
+
docs: Unique identifier for a Field
|
|
672
|
+
access: read-only
|
|
673
|
+
isEditable:
|
|
674
|
+
type: optional<boolean>
|
|
675
|
+
docs: Define whether the field is editable
|
|
676
|
+
access: read-only
|
|
677
|
+
isRequired:
|
|
678
|
+
type: optional<boolean>
|
|
679
|
+
docs: define whether a field is required in a collection
|
|
680
|
+
type:
|
|
681
|
+
type: literal<"Option">
|
|
682
|
+
docs: >-
|
|
683
|
+
The [Option field
|
|
684
|
+
type](/data/reference/field-types-item-values#option)
|
|
685
|
+
displayName:
|
|
686
|
+
type: string
|
|
687
|
+
docs: The name of a field
|
|
688
|
+
helpText:
|
|
689
|
+
type: optional<string>
|
|
690
|
+
docs: Additional text to help anyone filling out this field
|
|
691
|
+
metadata: Metadata
|
|
692
|
+
source:
|
|
693
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
694
|
+
ReferenceFieldType:
|
|
695
|
+
enum:
|
|
696
|
+
- MultiReference
|
|
697
|
+
- Reference
|
|
698
|
+
docs: Choose these appropriate field type for your collection data
|
|
699
|
+
inline: true
|
|
700
|
+
source:
|
|
701
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
702
|
+
ReferenceFieldMetadata:
|
|
703
|
+
docs: >-
|
|
704
|
+
The collectionId for the referenced collection. Only applicable for
|
|
705
|
+
Reference and MultiReference fields.
|
|
706
|
+
properties:
|
|
707
|
+
collectionId:
|
|
708
|
+
type: string
|
|
709
|
+
docs: The unique identifier of the collection
|
|
710
|
+
source:
|
|
711
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
712
|
+
inline: true
|
|
713
|
+
Reference Field:
|
|
714
|
+
properties:
|
|
715
|
+
id:
|
|
716
|
+
type: optional<string>
|
|
717
|
+
docs: Unique identifier for a Field
|
|
718
|
+
access: read-only
|
|
719
|
+
isEditable:
|
|
720
|
+
type: optional<boolean>
|
|
721
|
+
docs: Define whether the field is editable
|
|
722
|
+
access: read-only
|
|
723
|
+
isRequired:
|
|
724
|
+
type: optional<boolean>
|
|
725
|
+
docs: define whether a field is required in a collection
|
|
726
|
+
type:
|
|
727
|
+
type: ReferenceFieldType
|
|
728
|
+
docs: Choose these appropriate field type for your collection data
|
|
729
|
+
displayName:
|
|
730
|
+
type: string
|
|
731
|
+
docs: The name of a field
|
|
732
|
+
helpText:
|
|
733
|
+
type: optional<string>
|
|
734
|
+
docs: Additional text to help anyone filling out this field
|
|
735
|
+
metadata:
|
|
736
|
+
type: ReferenceFieldMetadata
|
|
737
|
+
docs: >-
|
|
738
|
+
The collectionId for the referenced collection. Only applicable for
|
|
739
|
+
Reference and MultiReference fields.
|
|
740
|
+
source:
|
|
741
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
742
|
+
FieldCreate:
|
|
743
|
+
discriminated: false
|
|
744
|
+
docs: Details about the field of a collection
|
|
745
|
+
union:
|
|
746
|
+
- Static Field
|
|
747
|
+
- Option Field
|
|
748
|
+
- Reference Field
|
|
749
|
+
source:
|
|
750
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
751
|
+
FieldType:
|
|
752
|
+
enum:
|
|
490
753
|
- Color
|
|
754
|
+
- DateTime
|
|
755
|
+
- Email
|
|
491
756
|
- ExtFileRef
|
|
757
|
+
- Image
|
|
758
|
+
- Link
|
|
759
|
+
- MultiImage
|
|
760
|
+
- MultiReference
|
|
761
|
+
- Number
|
|
762
|
+
- Phone
|
|
763
|
+
- PlainText
|
|
764
|
+
- Reference
|
|
765
|
+
- RichText
|
|
766
|
+
- Switch
|
|
767
|
+
- Video
|
|
492
768
|
docs: Choose these appropriate field type for your collection data
|
|
769
|
+
inline: true
|
|
493
770
|
source:
|
|
494
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
771
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
495
772
|
Field:
|
|
496
773
|
docs: The details of a field in a collection
|
|
497
774
|
properties:
|
|
498
775
|
id:
|
|
499
776
|
type: string
|
|
500
777
|
docs: Unique identifier for a Field
|
|
778
|
+
access: read-only
|
|
501
779
|
isRequired:
|
|
502
780
|
type: boolean
|
|
503
781
|
docs: define whether a field is required in a collection
|
|
504
782
|
isEditable:
|
|
505
783
|
type: optional<boolean>
|
|
506
784
|
docs: Define whether the field is editable
|
|
785
|
+
access: read-only
|
|
507
786
|
type:
|
|
508
787
|
type: FieldType
|
|
509
788
|
docs: Choose these appropriate field type for your collection data
|
|
@@ -519,18 +798,19 @@ types:
|
|
|
519
798
|
type: optional<string>
|
|
520
799
|
docs: Additional text to help anyone filling out this field
|
|
521
800
|
source:
|
|
522
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
801
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
523
802
|
Collection:
|
|
524
803
|
docs: A collection object
|
|
525
804
|
properties:
|
|
526
805
|
id:
|
|
527
806
|
type: string
|
|
528
807
|
docs: Unique identifier for a Collection
|
|
808
|
+
access: read-only
|
|
529
809
|
displayName:
|
|
530
|
-
type:
|
|
810
|
+
type: string
|
|
531
811
|
docs: Name given to the Collection
|
|
532
812
|
singularName:
|
|
533
|
-
type:
|
|
813
|
+
type: string
|
|
534
814
|
docs: >-
|
|
535
815
|
The name of one Item in Collection (e.g. ”Blog Post” if the Collection
|
|
536
816
|
is called “Blog Posts”)
|
|
@@ -540,14 +820,16 @@ types:
|
|
|
540
820
|
createdOn:
|
|
541
821
|
type: optional<datetime>
|
|
542
822
|
docs: The date the collection was created
|
|
823
|
+
access: read-only
|
|
543
824
|
lastUpdated:
|
|
544
825
|
type: optional<datetime>
|
|
545
826
|
docs: The date the collection was last updated
|
|
827
|
+
access: read-only
|
|
546
828
|
fields:
|
|
547
829
|
docs: The list of fields in the Collection
|
|
548
830
|
type: list<Field>
|
|
549
831
|
source:
|
|
550
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
832
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
551
833
|
CollectionItemFieldData:
|
|
552
834
|
properties:
|
|
553
835
|
name:
|
|
@@ -560,30 +842,43 @@ types:
|
|
|
560
842
|
will break all links referencing the old slug.
|
|
561
843
|
extra-properties: true
|
|
562
844
|
source:
|
|
563
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
845
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
564
846
|
inline: true
|
|
565
847
|
CollectionItem:
|
|
566
848
|
docs: >
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
849
|
+
A Collection Item represents a single entry in your collection. Each item
|
|
850
|
+
includes:
|
|
851
|
+
|
|
852
|
+
|
|
853
|
+
- **System metadata** - Automatically managed fields like IDs and
|
|
854
|
+
timestamp <br/>
|
|
855
|
+
|
|
856
|
+
- **Status flags** - Controls for managing content state: `isDraft`,
|
|
857
|
+
`isArchived `<br/>
|
|
858
|
+
|
|
859
|
+
- **Content fields** - Stored in `fieldData`. Each item needs a `name` and
|
|
860
|
+
`slug`, and may include additional fields matching your collection's
|
|
861
|
+
schema definition.
|
|
571
862
|
properties:
|
|
572
863
|
id:
|
|
573
864
|
type: optional<string>
|
|
574
865
|
docs: Unique identifier for the Item
|
|
866
|
+
access: read-only
|
|
575
867
|
cmsLocaleId:
|
|
576
868
|
type: optional<string>
|
|
577
869
|
docs: Identifier for the locale of the CMS item
|
|
578
870
|
lastPublished:
|
|
579
|
-
type:
|
|
871
|
+
type: string
|
|
580
872
|
docs: The date the item was last published
|
|
873
|
+
access: read-only
|
|
581
874
|
lastUpdated:
|
|
582
|
-
type:
|
|
875
|
+
type: string
|
|
583
876
|
docs: The date the item was last updated
|
|
877
|
+
access: read-only
|
|
584
878
|
createdOn:
|
|
585
|
-
type:
|
|
879
|
+
type: string
|
|
586
880
|
docs: The date the item was created
|
|
881
|
+
access: read-only
|
|
587
882
|
isArchived:
|
|
588
883
|
type: optional<boolean>
|
|
589
884
|
docs: Boolean determining if the Item is set to archived
|
|
@@ -594,7 +889,7 @@ types:
|
|
|
594
889
|
default: false
|
|
595
890
|
fieldData: CollectionItemFieldData
|
|
596
891
|
source:
|
|
597
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
892
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
598
893
|
CollectionItemListPagination:
|
|
599
894
|
properties:
|
|
600
895
|
limit:
|
|
@@ -609,7 +904,7 @@ types:
|
|
|
609
904
|
type: optional<double>
|
|
610
905
|
docs: Total number of items in the collection
|
|
611
906
|
source:
|
|
612
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
907
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
613
908
|
inline: true
|
|
614
909
|
CollectionItemList:
|
|
615
910
|
docs: Results from collection items list
|
|
@@ -619,7 +914,7 @@ types:
|
|
|
619
914
|
docs: List of Items within the collection
|
|
620
915
|
pagination: optional<CollectionItemListPagination>
|
|
621
916
|
source:
|
|
622
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
917
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
623
918
|
CollectionItemPostSingleFieldData:
|
|
624
919
|
properties:
|
|
625
920
|
name:
|
|
@@ -632,41 +927,54 @@ types:
|
|
|
632
927
|
will break all links referencing the old slug.
|
|
633
928
|
extra-properties: true
|
|
634
929
|
source:
|
|
635
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
930
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
636
931
|
inline: true
|
|
637
932
|
CollectionItemPostSingle:
|
|
638
933
|
docs: >
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
934
|
+
A Collection Item represents a single entry in your collection. Each item
|
|
935
|
+
includes:
|
|
936
|
+
|
|
937
|
+
|
|
938
|
+
- **System metadata** - Automatically managed fields like IDs and
|
|
939
|
+
timestamp <br/>
|
|
940
|
+
|
|
941
|
+
- **Status flags** - Controls for managing content state: `isDraft`,
|
|
942
|
+
`isArchived `<br/>
|
|
943
|
+
|
|
944
|
+
- **Content fields** - Stored in `fieldData`. Each item needs a `name` and
|
|
945
|
+
`slug`, and may include additional fields matching your collection's
|
|
946
|
+
schema definition.
|
|
643
947
|
properties:
|
|
644
948
|
id:
|
|
645
949
|
type: optional<string>
|
|
646
950
|
docs: Unique identifier for the Item
|
|
951
|
+
access: read-only
|
|
647
952
|
cmsLocaleId:
|
|
648
953
|
type: optional<string>
|
|
649
954
|
docs: Identifier for the locale of the CMS item
|
|
650
955
|
lastPublished:
|
|
651
956
|
type: optional<string>
|
|
652
957
|
docs: The date the item was last published
|
|
958
|
+
access: read-only
|
|
653
959
|
lastUpdated:
|
|
654
960
|
type: optional<string>
|
|
655
961
|
docs: The date the item was last updated
|
|
962
|
+
access: read-only
|
|
656
963
|
createdOn:
|
|
657
964
|
type: optional<string>
|
|
658
965
|
docs: The date the item was created
|
|
966
|
+
access: read-only
|
|
659
967
|
isArchived:
|
|
660
968
|
type: optional<boolean>
|
|
661
|
-
docs: Boolean determining if the Item is
|
|
969
|
+
docs: Boolean determining if the Item is in an archived state.
|
|
662
970
|
default: false
|
|
663
971
|
isDraft:
|
|
664
972
|
type: optional<boolean>
|
|
665
|
-
docs: Boolean determining if the Item is
|
|
973
|
+
docs: Boolean determining if the Item is in a draft state.
|
|
666
974
|
default: false
|
|
667
975
|
fieldData: CollectionItemPostSingleFieldData
|
|
668
976
|
source:
|
|
669
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
977
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
670
978
|
CollectionItemWithIdInputFieldData:
|
|
671
979
|
properties:
|
|
672
980
|
name:
|
|
@@ -679,7 +987,7 @@ types:
|
|
|
679
987
|
will break all links referencing the old slug.
|
|
680
988
|
extra-properties: true
|
|
681
989
|
source:
|
|
682
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
990
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
683
991
|
inline: true
|
|
684
992
|
CollectionItemWithIdInput:
|
|
685
993
|
docs: >
|
|
@@ -697,23 +1005,24 @@ types:
|
|
|
697
1005
|
lastPublished:
|
|
698
1006
|
type: optional<string>
|
|
699
1007
|
docs: The date the item was last published
|
|
1008
|
+
access: read-only
|
|
700
1009
|
lastUpdated:
|
|
701
1010
|
type: optional<string>
|
|
702
1011
|
docs: The date the item was last updated
|
|
1012
|
+
access: read-only
|
|
703
1013
|
createdOn:
|
|
704
1014
|
type: optional<string>
|
|
705
1015
|
docs: The date the item was created
|
|
1016
|
+
access: read-only
|
|
706
1017
|
isArchived:
|
|
707
1018
|
type: optional<boolean>
|
|
708
1019
|
docs: Boolean determining if the Item is set to archived
|
|
709
|
-
default: false
|
|
710
1020
|
isDraft:
|
|
711
1021
|
type: optional<boolean>
|
|
712
1022
|
docs: Boolean determining if the Item is set to draft
|
|
713
|
-
default: false
|
|
714
1023
|
fieldData: optional<CollectionItemWithIdInputFieldData>
|
|
715
1024
|
source:
|
|
716
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1025
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
717
1026
|
CollectionItemListNoPagination:
|
|
718
1027
|
docs: Results from collection items list
|
|
719
1028
|
properties:
|
|
@@ -721,7 +1030,8 @@ types:
|
|
|
721
1030
|
type: optional<list<CollectionItem>>
|
|
722
1031
|
docs: List of Items within the collection
|
|
723
1032
|
source:
|
|
724
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1033
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1034
|
+
Conflict: unknown
|
|
725
1035
|
BulkCollectionItemFieldData:
|
|
726
1036
|
properties:
|
|
727
1037
|
name:
|
|
@@ -734,7 +1044,7 @@ types:
|
|
|
734
1044
|
will break all links referencing the old slug.
|
|
735
1045
|
extra-properties: true
|
|
736
1046
|
source:
|
|
737
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1047
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
738
1048
|
inline: true
|
|
739
1049
|
BulkCollectionItem:
|
|
740
1050
|
docs: >
|
|
@@ -746,18 +1056,22 @@ types:
|
|
|
746
1056
|
id:
|
|
747
1057
|
type: string
|
|
748
1058
|
docs: Unique identifier for the Item
|
|
1059
|
+
access: read-only
|
|
749
1060
|
cmsLocaleIds:
|
|
750
1061
|
type: optional<list<string>>
|
|
751
1062
|
docs: Array of identifiers for the locales where the item will be created
|
|
752
1063
|
lastPublished:
|
|
753
1064
|
type: optional<string>
|
|
754
1065
|
docs: The date the item was last published
|
|
1066
|
+
access: read-only
|
|
755
1067
|
lastUpdated:
|
|
756
1068
|
type: optional<string>
|
|
757
1069
|
docs: The date the item was last updated
|
|
1070
|
+
access: read-only
|
|
758
1071
|
createdOn:
|
|
759
1072
|
type: optional<string>
|
|
760
1073
|
docs: The date the item was created
|
|
1074
|
+
access: read-only
|
|
761
1075
|
isArchived:
|
|
762
1076
|
type: optional<boolean>
|
|
763
1077
|
docs: Boolean determining if the Item is set to archived
|
|
@@ -768,7 +1082,7 @@ types:
|
|
|
768
1082
|
default: false
|
|
769
1083
|
fieldData: optional<BulkCollectionItemFieldData>
|
|
770
1084
|
source:
|
|
771
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1085
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
772
1086
|
CollectionItemPatchSingleFieldData:
|
|
773
1087
|
properties:
|
|
774
1088
|
name:
|
|
@@ -781,7 +1095,7 @@ types:
|
|
|
781
1095
|
will break all links referencing the old slug.
|
|
782
1096
|
extra-properties: true
|
|
783
1097
|
source:
|
|
784
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1098
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
785
1099
|
inline: true
|
|
786
1100
|
CollectionItemPatchSingle:
|
|
787
1101
|
docs: >
|
|
@@ -793,29 +1107,31 @@ types:
|
|
|
793
1107
|
id:
|
|
794
1108
|
type: optional<string>
|
|
795
1109
|
docs: Unique identifier for the Item
|
|
1110
|
+
access: read-only
|
|
796
1111
|
cmsLocaleId:
|
|
797
1112
|
type: optional<string>
|
|
798
1113
|
docs: Identifier for the locale of the CMS item
|
|
799
1114
|
lastPublished:
|
|
800
1115
|
type: optional<string>
|
|
801
1116
|
docs: The date the item was last published
|
|
1117
|
+
access: read-only
|
|
802
1118
|
lastUpdated:
|
|
803
1119
|
type: optional<string>
|
|
804
1120
|
docs: The date the item was last updated
|
|
1121
|
+
access: read-only
|
|
805
1122
|
createdOn:
|
|
806
1123
|
type: optional<string>
|
|
807
1124
|
docs: The date the item was created
|
|
1125
|
+
access: read-only
|
|
808
1126
|
isArchived:
|
|
809
1127
|
type: optional<boolean>
|
|
810
1128
|
docs: Boolean determining if the Item is set to archived
|
|
811
|
-
default: false
|
|
812
1129
|
isDraft:
|
|
813
1130
|
type: optional<boolean>
|
|
814
1131
|
docs: Boolean determining if the Item is set to draft
|
|
815
|
-
default: false
|
|
816
1132
|
fieldData: optional<CollectionItemPatchSingleFieldData>
|
|
817
1133
|
source:
|
|
818
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1134
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
819
1135
|
PageSeo:
|
|
820
1136
|
docs: SEO-related fields for the Page
|
|
821
1137
|
properties:
|
|
@@ -826,7 +1142,7 @@ types:
|
|
|
826
1142
|
type: optional<string>
|
|
827
1143
|
docs: The Page description shown in search engine results
|
|
828
1144
|
source:
|
|
829
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1145
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
830
1146
|
inline: true
|
|
831
1147
|
PageOpenGraph:
|
|
832
1148
|
docs: Open Graph fields for the Page
|
|
@@ -838,6 +1154,7 @@ types:
|
|
|
838
1154
|
type: optional<boolean>
|
|
839
1155
|
docs: Indicates the Open Graph title was copied from the SEO title
|
|
840
1156
|
default: true
|
|
1157
|
+
access: read-only
|
|
841
1158
|
description:
|
|
842
1159
|
type: optional<string>
|
|
843
1160
|
docs: The description supplied to Open Graph annotations
|
|
@@ -847,8 +1164,9 @@ types:
|
|
|
847
1164
|
Indicates the Open Graph description was copied from the SEO
|
|
848
1165
|
description
|
|
849
1166
|
default: true
|
|
1167
|
+
access: read-only
|
|
850
1168
|
source:
|
|
851
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1169
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
852
1170
|
inline: true
|
|
853
1171
|
Page:
|
|
854
1172
|
docs: The Page object
|
|
@@ -856,9 +1174,11 @@ types:
|
|
|
856
1174
|
id:
|
|
857
1175
|
type: string
|
|
858
1176
|
docs: Unique identifier for the Page
|
|
1177
|
+
access: read-only
|
|
859
1178
|
siteId:
|
|
860
1179
|
type: optional<string>
|
|
861
1180
|
docs: Unique identifier for the Site
|
|
1181
|
+
access: read-only
|
|
862
1182
|
title:
|
|
863
1183
|
type: optional<string>
|
|
864
1184
|
docs: Title of the Page
|
|
@@ -868,43 +1188,52 @@ types:
|
|
|
868
1188
|
parentId:
|
|
869
1189
|
type: optional<string>
|
|
870
1190
|
docs: Identifier of the parent folder
|
|
1191
|
+
access: read-only
|
|
871
1192
|
collectionId:
|
|
872
1193
|
type: optional<string>
|
|
873
1194
|
docs: >-
|
|
874
1195
|
Unique identifier for a linked Collection, value will be null if the
|
|
875
1196
|
Page is not part of a Collection.
|
|
1197
|
+
access: read-only
|
|
876
1198
|
createdOn:
|
|
877
1199
|
type: optional<datetime>
|
|
878
1200
|
docs: The date the Page was created
|
|
1201
|
+
access: read-only
|
|
879
1202
|
lastUpdated:
|
|
880
1203
|
type: optional<datetime>
|
|
881
1204
|
docs: The date the Page was most recently updated
|
|
1205
|
+
access: read-only
|
|
882
1206
|
archived:
|
|
883
1207
|
type: optional<boolean>
|
|
884
1208
|
docs: Whether the Page has been archived
|
|
885
1209
|
default: false
|
|
1210
|
+
access: read-only
|
|
886
1211
|
draft:
|
|
887
1212
|
type: optional<boolean>
|
|
888
1213
|
docs: Whether the Page is a draft
|
|
889
1214
|
default: false
|
|
1215
|
+
access: read-only
|
|
890
1216
|
canBranch:
|
|
891
1217
|
type: optional<boolean>
|
|
892
1218
|
docs: >-
|
|
893
1219
|
Indicates whether the Page supports [Page
|
|
894
1220
|
Branching](https://university.webflow.com/lesson/page-branching)
|
|
895
1221
|
default: false
|
|
1222
|
+
access: read-only
|
|
896
1223
|
isBranch:
|
|
897
1224
|
type: optional<boolean>
|
|
898
1225
|
docs: >-
|
|
899
1226
|
Indicates whether the Page is a Branch of another Page [Page
|
|
900
1227
|
Branching](https://university.webflow.com/lesson/page-branching)
|
|
901
1228
|
default: false
|
|
1229
|
+
access: read-only
|
|
902
1230
|
isMembersOnly:
|
|
903
1231
|
type: optional<boolean>
|
|
904
1232
|
docs: >-
|
|
905
1233
|
Indicates whether the Page is restricted by [Memberships
|
|
906
1234
|
Controls](https://university.webflow.com/lesson/webflow-memberships-overview#how-to-manage-page-restrictions)
|
|
907
1235
|
default: false
|
|
1236
|
+
access: read-only
|
|
908
1237
|
seo:
|
|
909
1238
|
type: optional<PageSeo>
|
|
910
1239
|
docs: SEO-related fields for the Page
|
|
@@ -914,29 +1243,58 @@ types:
|
|
|
914
1243
|
localeId:
|
|
915
1244
|
type: optional<string>
|
|
916
1245
|
docs: Unique ID of the page locale
|
|
1246
|
+
access: read-only
|
|
917
1247
|
publishedPath:
|
|
918
1248
|
type: optional<string>
|
|
919
1249
|
docs: Relative path of the published page URL
|
|
1250
|
+
access: read-only
|
|
920
1251
|
source:
|
|
921
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1252
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
922
1253
|
PageList:
|
|
923
1254
|
docs: The Page object
|
|
924
1255
|
properties:
|
|
925
1256
|
pages: optional<list<Page>>
|
|
926
1257
|
pagination: optional<Pagination>
|
|
927
1258
|
source:
|
|
928
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1259
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1260
|
+
TextNodeText:
|
|
1261
|
+
docs: The text content of the node
|
|
1262
|
+
properties:
|
|
1263
|
+
html:
|
|
1264
|
+
type: optional<string>
|
|
1265
|
+
docs: The HTML content of the text node.
|
|
1266
|
+
text:
|
|
1267
|
+
type: optional<string>
|
|
1268
|
+
docs: The raw text content of the text node.
|
|
1269
|
+
source:
|
|
1270
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1271
|
+
inline: true
|
|
929
1272
|
TextNode:
|
|
930
1273
|
docs: >
|
|
931
|
-
Represents
|
|
932
|
-
|
|
933
|
-
|
|
934
|
-
styling or other purposes.
|
|
1274
|
+
Represents text content within the DOM. It contains both the raw text and
|
|
1275
|
+
its HTML representation. Additional attributes can be associated with the
|
|
1276
|
+
text for styling or other purposes.
|
|
935
1277
|
properties:
|
|
936
|
-
|
|
937
|
-
|
|
1278
|
+
id:
|
|
1279
|
+
type: string
|
|
1280
|
+
docs: Node UUID
|
|
1281
|
+
access: read-only
|
|
1282
|
+
text:
|
|
1283
|
+
type: TextNodeText
|
|
1284
|
+
docs: The text content of the node
|
|
1285
|
+
attributes:
|
|
1286
|
+
type: optional<map<string, string>>
|
|
1287
|
+
docs: The custom attributes of the node
|
|
1288
|
+
source:
|
|
1289
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1290
|
+
ImageNodeImage:
|
|
1291
|
+
docs: The image details of the node
|
|
1292
|
+
properties:
|
|
1293
|
+
alt: optional<string>
|
|
1294
|
+
assetId: optional<string>
|
|
938
1295
|
source:
|
|
939
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1296
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1297
|
+
inline: true
|
|
940
1298
|
ImageNode:
|
|
941
1299
|
docs: >
|
|
942
1300
|
Represents an image within the DOM. It contains details about the image,
|
|
@@ -944,49 +1302,227 @@ types:
|
|
|
944
1302
|
identifier for fetching the actual image resource. Additional attributes
|
|
945
1303
|
can be associated with the image for styling or other purposes.
|
|
946
1304
|
properties:
|
|
947
|
-
|
|
948
|
-
|
|
1305
|
+
id:
|
|
1306
|
+
type: string
|
|
1307
|
+
docs: Node UUID
|
|
1308
|
+
access: read-only
|
|
1309
|
+
image:
|
|
1310
|
+
type: ImageNodeImage
|
|
1311
|
+
docs: The image details of the node
|
|
1312
|
+
attributes:
|
|
1313
|
+
type: optional<map<string, string>>
|
|
1314
|
+
docs: The custom attributes of the node
|
|
1315
|
+
source:
|
|
1316
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1317
|
+
Text:
|
|
1318
|
+
docs: The text content of the node
|
|
1319
|
+
properties:
|
|
1320
|
+
html:
|
|
1321
|
+
type: optional<string>
|
|
1322
|
+
docs: The HTML content of the text node.
|
|
1323
|
+
text:
|
|
1324
|
+
type: optional<string>
|
|
1325
|
+
docs: The raw text content of the text node.
|
|
949
1326
|
source:
|
|
950
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
951
|
-
|
|
1327
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1328
|
+
ComponentPropertyType:
|
|
952
1329
|
enum:
|
|
953
|
-
-
|
|
954
|
-
|
|
1330
|
+
- value: Plain Text
|
|
1331
|
+
name: PlainText
|
|
1332
|
+
- value: Rich Text
|
|
1333
|
+
name: RichText
|
|
1334
|
+
- value: Alt Text
|
|
1335
|
+
name: AltText
|
|
1336
|
+
docs: The type of the property.
|
|
1337
|
+
inline: true
|
|
1338
|
+
source:
|
|
1339
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1340
|
+
ComponentProperty:
|
|
1341
|
+
docs: >
|
|
1342
|
+
Represents a property of a component instance in the DOM. A property
|
|
1343
|
+
contains a list of both the raw text and the HTML representation, allowing
|
|
1344
|
+
for flexibility in rendering and processing. Additional attributes can be
|
|
1345
|
+
associated with the text for styling or other purposes.
|
|
1346
|
+
properties:
|
|
1347
|
+
propertyId:
|
|
1348
|
+
type: optional<string>
|
|
1349
|
+
docs: The ID of the property.
|
|
1350
|
+
type:
|
|
1351
|
+
type: optional<ComponentPropertyType>
|
|
1352
|
+
docs: The type of the property.
|
|
1353
|
+
label:
|
|
1354
|
+
type: optional<string>
|
|
1355
|
+
docs: The label of the property in the UI.
|
|
1356
|
+
text:
|
|
1357
|
+
type: optional<Text>
|
|
1358
|
+
docs: >-
|
|
1359
|
+
Represents text content within the DOM. It contains both the raw text
|
|
1360
|
+
and its HTML representation.
|
|
955
1361
|
source:
|
|
956
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1362
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1363
|
+
ComponentNode:
|
|
1364
|
+
docs: >
|
|
1365
|
+
Represents a component instance within the DOM. It contains details about
|
|
1366
|
+
the component instance, such as its type and properties.
|
|
1367
|
+
properties:
|
|
1368
|
+
id:
|
|
1369
|
+
type: string
|
|
1370
|
+
docs: The unique identifier of the component instance node
|
|
1371
|
+
access: read-only
|
|
1372
|
+
componentId:
|
|
1373
|
+
type: string
|
|
1374
|
+
docs: The unique identifier of the component
|
|
1375
|
+
propertyOverrides:
|
|
1376
|
+
docs: List of component properties with overrides for a component instance.
|
|
1377
|
+
type: list<ComponentProperty>
|
|
1378
|
+
source:
|
|
1379
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
957
1380
|
Node:
|
|
1381
|
+
discriminant: type
|
|
1382
|
+
base-properties: {}
|
|
958
1383
|
docs: >
|
|
959
1384
|
A generic representation of a content element within the Document Object
|
|
960
1385
|
Model (DOM). Each node has a unique identifier and a specific type that
|
|
961
1386
|
determines its content structure and attributes.
|
|
962
|
-
|
|
963
|
-
|
|
964
|
-
|
|
965
|
-
|
|
966
|
-
type: optional<NodeType>
|
|
967
|
-
text: optional<TextNode>
|
|
968
|
-
image: optional<ImageNode>
|
|
969
|
-
attributes:
|
|
970
|
-
type: optional<map<string, string>>
|
|
971
|
-
docs: The custom attributes of the node
|
|
1387
|
+
union:
|
|
1388
|
+
text: TextNode
|
|
1389
|
+
image: ImageNode
|
|
1390
|
+
component-instance: ComponentNode
|
|
972
1391
|
source:
|
|
973
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1392
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
974
1393
|
Dom:
|
|
975
1394
|
docs: >
|
|
976
1395
|
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.
|
|
1396
|
+
a web page or component. It captures various content nodes along with
|
|
1397
|
+
their associated attributes. Each node has a unique identifier and can be
|
|
1398
|
+
of different types like text, image or component-instance. The schema also
|
|
1399
|
+
provides pagination details for scenarios where the content nodes are too
|
|
1400
|
+
many to be fetched in a single request.
|
|
982
1401
|
properties:
|
|
983
1402
|
pageId:
|
|
984
1403
|
type: optional<string>
|
|
985
1404
|
docs: Page ID
|
|
986
1405
|
nodes: optional<list<Node>>
|
|
987
1406
|
pagination: optional<Pagination>
|
|
1407
|
+
lastUpdated:
|
|
1408
|
+
type: optional<datetime>
|
|
1409
|
+
docs: The date the page dom was most recently updated
|
|
1410
|
+
access: read-only
|
|
988
1411
|
source:
|
|
989
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1412
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1413
|
+
TextNodeWrite:
|
|
1414
|
+
docs: Update a text node
|
|
1415
|
+
properties:
|
|
1416
|
+
nodeId:
|
|
1417
|
+
type: string
|
|
1418
|
+
docs: Node UUID
|
|
1419
|
+
text:
|
|
1420
|
+
type: string
|
|
1421
|
+
docs: >-
|
|
1422
|
+
HTML content of the node, including the HTML tag. The HTML tags must
|
|
1423
|
+
be the same as what's returned from the Get Content endpoint.
|
|
1424
|
+
source:
|
|
1425
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1426
|
+
ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem:
|
|
1427
|
+
properties:
|
|
1428
|
+
propertyId:
|
|
1429
|
+
type: string
|
|
1430
|
+
docs: The ID of the property.
|
|
1431
|
+
text:
|
|
1432
|
+
type: string
|
|
1433
|
+
docs: >
|
|
1434
|
+
The new string or HTML value used to override the component instance
|
|
1435
|
+
property value.
|
|
1436
|
+
|
|
1437
|
+
The provided value must be compatible with the type of the component
|
|
1438
|
+
instance property.
|
|
1439
|
+
|
|
1440
|
+
For example, attempting to override a single-line plain-text property
|
|
1441
|
+
with a multi-line
|
|
1442
|
+
|
|
1443
|
+
value will result in an error.
|
|
1444
|
+
source:
|
|
1445
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1446
|
+
inline: true
|
|
1447
|
+
ComponentInstanceNodePropertyOverridesWrite:
|
|
1448
|
+
docs: Update text property overrides of a component instance
|
|
1449
|
+
properties:
|
|
1450
|
+
nodeId:
|
|
1451
|
+
type: string
|
|
1452
|
+
docs: Node UUID
|
|
1453
|
+
propertyOverrides:
|
|
1454
|
+
docs: >-
|
|
1455
|
+
A list of component instance properties to override within the
|
|
1456
|
+
specified secondary locale.
|
|
1457
|
+
type: list<ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem>
|
|
1458
|
+
source:
|
|
1459
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1460
|
+
Component:
|
|
1461
|
+
docs: The Component object
|
|
1462
|
+
properties:
|
|
1463
|
+
id:
|
|
1464
|
+
type: string
|
|
1465
|
+
docs: Unique identifier for the Component
|
|
1466
|
+
access: read-only
|
|
1467
|
+
name:
|
|
1468
|
+
type: optional<string>
|
|
1469
|
+
docs: Component Name
|
|
1470
|
+
access: read-only
|
|
1471
|
+
group:
|
|
1472
|
+
type: optional<string>
|
|
1473
|
+
docs: The group that the component belongs to
|
|
1474
|
+
access: read-only
|
|
1475
|
+
description:
|
|
1476
|
+
type: optional<string>
|
|
1477
|
+
docs: Component Description
|
|
1478
|
+
access: read-only
|
|
1479
|
+
readonly:
|
|
1480
|
+
type: optional<boolean>
|
|
1481
|
+
docs: >-
|
|
1482
|
+
Indicates whether the component is read-only. Components that cannot
|
|
1483
|
+
be updated within this Site are set to readonly. Workspace Libraries
|
|
1484
|
+
are a good example.
|
|
1485
|
+
access: read-only
|
|
1486
|
+
source:
|
|
1487
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1488
|
+
ComponentList:
|
|
1489
|
+
docs: List of Components on a site.
|
|
1490
|
+
properties:
|
|
1491
|
+
components: optional<list<Component>>
|
|
1492
|
+
pagination: optional<Pagination>
|
|
1493
|
+
source:
|
|
1494
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1495
|
+
ComponentDom:
|
|
1496
|
+
docs: >
|
|
1497
|
+
The Component DOM schema represents the content structure of a component.
|
|
1498
|
+
Similar to Page DOM, it captures various content nodes and their
|
|
1499
|
+
associated attributes, but specifically for a component's structure. Each
|
|
1500
|
+
node has a unique identifier and can contain text, images, or nested
|
|
1501
|
+
component instances.
|
|
1502
|
+
properties:
|
|
1503
|
+
componentId:
|
|
1504
|
+
type: optional<string>
|
|
1505
|
+
docs: Component ID
|
|
1506
|
+
nodes: optional<list<Node>>
|
|
1507
|
+
pagination: optional<Pagination>
|
|
1508
|
+
source:
|
|
1509
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1510
|
+
ComponentProperties:
|
|
1511
|
+
docs: >
|
|
1512
|
+
The Component Properties schema represents a list of properties that store
|
|
1513
|
+
text content. Each property has a unique identifier and can be of
|
|
1514
|
+
different types like plain text or rich text. The schema also provides
|
|
1515
|
+
pagination details for scenarios where there more properties than the
|
|
1516
|
+
limit.
|
|
1517
|
+
properties:
|
|
1518
|
+
componentId:
|
|
1519
|
+
type: optional<string>
|
|
1520
|
+
docs: Component ID
|
|
1521
|
+
access: read-only
|
|
1522
|
+
properties: optional<list<ComponentProperty>>
|
|
1523
|
+
pagination: optional<Pagination>
|
|
1524
|
+
source:
|
|
1525
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
990
1526
|
ScriptApplyLocation:
|
|
991
1527
|
enum:
|
|
992
1528
|
- header
|
|
@@ -995,8 +1531,9 @@ types:
|
|
|
995
1531
|
Location of the script, either in the header or footer of the published
|
|
996
1532
|
site
|
|
997
1533
|
default: header
|
|
1534
|
+
inline: true
|
|
998
1535
|
source:
|
|
999
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1536
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1000
1537
|
ScriptApply:
|
|
1001
1538
|
properties:
|
|
1002
1539
|
id:
|
|
@@ -1017,7 +1554,7 @@ types:
|
|
|
1017
1554
|
Developer-specified key/value pairs to be applied as attributes to the
|
|
1018
1555
|
script
|
|
1019
1556
|
source:
|
|
1020
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1557
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1021
1558
|
ScriptApplyList:
|
|
1022
1559
|
properties:
|
|
1023
1560
|
scripts:
|
|
@@ -1026,17 +1563,20 @@ types:
|
|
|
1026
1563
|
lastUpdated:
|
|
1027
1564
|
type: optional<string>
|
|
1028
1565
|
docs: Date when the Site's scripts were last updated
|
|
1566
|
+
access: read-only
|
|
1029
1567
|
createdOn:
|
|
1030
1568
|
type: optional<string>
|
|
1031
1569
|
docs: Date when the Site's scripts were created
|
|
1570
|
+
access: read-only
|
|
1032
1571
|
source:
|
|
1033
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1572
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1034
1573
|
CustomCodeHostedResponse:
|
|
1035
1574
|
docs: Registered custom code for application
|
|
1036
1575
|
properties:
|
|
1037
1576
|
id:
|
|
1038
1577
|
type: optional<string>
|
|
1039
1578
|
docs: Human readable id, derived from the user-specified display name
|
|
1579
|
+
access: read-only
|
|
1040
1580
|
canCopy:
|
|
1041
1581
|
type: optional<boolean>
|
|
1042
1582
|
docs: >-
|
|
@@ -1059,26 +1599,29 @@ types:
|
|
|
1059
1599
|
createdOn:
|
|
1060
1600
|
type: optional<string>
|
|
1061
1601
|
docs: Timestamp when the script version was created
|
|
1602
|
+
access: read-only
|
|
1062
1603
|
lastUpdated:
|
|
1063
1604
|
type: optional<string>
|
|
1064
1605
|
docs: Timestamp when the script version was last updated
|
|
1606
|
+
access: read-only
|
|
1065
1607
|
version:
|
|
1066
1608
|
type: optional<string>
|
|
1067
1609
|
docs: A Semantic Version (SemVer) string, denoting the version of the script
|
|
1068
1610
|
source:
|
|
1069
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1611
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1070
1612
|
RegisteredScriptList:
|
|
1071
1613
|
docs: A list of scripts registered to the site
|
|
1072
1614
|
properties:
|
|
1073
1615
|
registeredScripts: optional<list<CustomCodeHostedResponse>>
|
|
1074
1616
|
source:
|
|
1075
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1617
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1076
1618
|
CustomCodeInlineResponse:
|
|
1077
1619
|
docs: Registered custom code for application
|
|
1078
1620
|
properties:
|
|
1079
1621
|
id:
|
|
1080
1622
|
type: optional<string>
|
|
1081
1623
|
docs: Human readable id, derived from the user-specified display name
|
|
1624
|
+
access: read-only
|
|
1082
1625
|
canCopy:
|
|
1083
1626
|
type: optional<boolean>
|
|
1084
1627
|
docs: >-
|
|
@@ -1101,14 +1644,16 @@ types:
|
|
|
1101
1644
|
createdOn:
|
|
1102
1645
|
type: optional<string>
|
|
1103
1646
|
docs: Timestamp when the script version was created
|
|
1647
|
+
access: read-only
|
|
1104
1648
|
lastUpdated:
|
|
1105
1649
|
type: optional<string>
|
|
1106
1650
|
docs: Timestamp when the script version was last updated
|
|
1651
|
+
access: read-only
|
|
1107
1652
|
version:
|
|
1108
1653
|
type: optional<string>
|
|
1109
1654
|
docs: A Semantic Version (SemVer) string, denoting the version of the script
|
|
1110
1655
|
source:
|
|
1111
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1656
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1112
1657
|
Scripts:
|
|
1113
1658
|
docs: A list of scripts applied to a Site or a Page
|
|
1114
1659
|
type: list<ScriptApply>
|
|
@@ -1117,8 +1662,9 @@ types:
|
|
|
1117
1662
|
- page
|
|
1118
1663
|
- site
|
|
1119
1664
|
docs: Whether the Custom Code script is applied at the Site-level or Page-level
|
|
1665
|
+
inline: true
|
|
1120
1666
|
source:
|
|
1121
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1667
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1122
1668
|
CustomCodeBlock:
|
|
1123
1669
|
docs: A specific instance of Custom Code applied to a Site or Page
|
|
1124
1670
|
properties:
|
|
@@ -1137,91 +1683,109 @@ types:
|
|
|
1137
1683
|
createdOn:
|
|
1138
1684
|
type: optional<datetime>
|
|
1139
1685
|
docs: The date the Block was created
|
|
1686
|
+
access: read-only
|
|
1140
1687
|
lastUpdated:
|
|
1141
1688
|
type: optional<datetime>
|
|
1142
1689
|
docs: The date the Block was most recently updated
|
|
1690
|
+
access: read-only
|
|
1143
1691
|
source:
|
|
1144
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1692
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1145
1693
|
ListCustomCodeBlocks:
|
|
1146
1694
|
docs: Custom Code Blocks corresponding to where scripts were applied
|
|
1147
1695
|
properties:
|
|
1148
1696
|
blocks: optional<list<CustomCodeBlock>>
|
|
1149
1697
|
pagination: optional<Pagination>
|
|
1150
1698
|
source:
|
|
1151
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1699
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1152
1700
|
AssetVariant:
|
|
1701
|
+
docs: Asset variant details
|
|
1153
1702
|
properties:
|
|
1154
1703
|
hostedUrl:
|
|
1155
|
-
type:
|
|
1704
|
+
type: string
|
|
1156
1705
|
docs: URL of where the asset variant is hosted
|
|
1157
1706
|
validation:
|
|
1158
1707
|
format: uri
|
|
1159
1708
|
originalFileName:
|
|
1160
|
-
type:
|
|
1709
|
+
type: string
|
|
1161
1710
|
docs: Original file name of the variant
|
|
1162
1711
|
displayName:
|
|
1163
|
-
type:
|
|
1712
|
+
type: string
|
|
1164
1713
|
docs: Display name of the variant
|
|
1165
1714
|
format:
|
|
1166
|
-
type:
|
|
1715
|
+
type: string
|
|
1167
1716
|
docs: format of the variant
|
|
1168
1717
|
width:
|
|
1169
|
-
type:
|
|
1718
|
+
type: integer
|
|
1170
1719
|
docs: Width in pixels
|
|
1171
1720
|
height:
|
|
1172
|
-
type:
|
|
1721
|
+
type: integer
|
|
1173
1722
|
docs: Height in pixels
|
|
1174
1723
|
quality:
|
|
1175
|
-
type:
|
|
1724
|
+
type: integer
|
|
1176
1725
|
docs: Value between 0 and 100 representing the image quality
|
|
1177
1726
|
error:
|
|
1178
1727
|
type: optional<string>
|
|
1179
1728
|
docs: Any associated validation errors
|
|
1180
1729
|
source:
|
|
1181
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1730
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1182
1731
|
Asset:
|
|
1732
|
+
docs: Asset details
|
|
1183
1733
|
properties:
|
|
1184
1734
|
id:
|
|
1185
|
-
type:
|
|
1735
|
+
type: string
|
|
1186
1736
|
docs: Unique identifier for this asset
|
|
1737
|
+
access: read-only
|
|
1187
1738
|
contentType:
|
|
1188
|
-
type:
|
|
1739
|
+
type: string
|
|
1189
1740
|
docs: File format type
|
|
1741
|
+
access: read-only
|
|
1190
1742
|
size:
|
|
1191
|
-
type:
|
|
1743
|
+
type: integer
|
|
1192
1744
|
docs: size in bytes
|
|
1745
|
+
access: read-only
|
|
1193
1746
|
siteId:
|
|
1194
|
-
type:
|
|
1747
|
+
type: string
|
|
1195
1748
|
docs: Unique identifier for the site that hosts this asset
|
|
1749
|
+
access: read-only
|
|
1196
1750
|
hostedUrl:
|
|
1197
|
-
type:
|
|
1751
|
+
type: string
|
|
1198
1752
|
docs: Link to the asset
|
|
1199
1753
|
validation:
|
|
1200
1754
|
format: uri
|
|
1755
|
+
access: read-only
|
|
1201
1756
|
originalFileName:
|
|
1202
|
-
type:
|
|
1757
|
+
type: string
|
|
1203
1758
|
docs: Original file name at the time of upload
|
|
1759
|
+
access: read-only
|
|
1204
1760
|
displayName:
|
|
1205
|
-
type:
|
|
1761
|
+
type: string
|
|
1206
1762
|
docs: Display name of the asset
|
|
1207
1763
|
lastUpdated:
|
|
1208
|
-
type:
|
|
1764
|
+
type: datetime
|
|
1209
1765
|
docs: Date the asset metadata was last updated
|
|
1766
|
+
access: read-only
|
|
1210
1767
|
createdOn:
|
|
1211
|
-
type:
|
|
1768
|
+
type: datetime
|
|
1212
1769
|
docs: Date the asset metadata was created
|
|
1213
|
-
|
|
1770
|
+
access: read-only
|
|
1771
|
+
variants:
|
|
1772
|
+
docs: >-
|
|
1773
|
+
A list of [asset
|
|
1774
|
+
variants](https://help.webflow.com/hc/en-us/articles/33961378697107-Responsive-images)
|
|
1775
|
+
created by Webflow to serve your site responsively.
|
|
1776
|
+
type: list<AssetVariant>
|
|
1214
1777
|
altText:
|
|
1215
1778
|
type: optional<string>
|
|
1216
1779
|
docs: The visual description of the asset
|
|
1217
1780
|
source:
|
|
1218
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1781
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1219
1782
|
Assets:
|
|
1220
1783
|
docs: A list of assets
|
|
1221
1784
|
properties:
|
|
1222
1785
|
assets: optional<list<Asset>>
|
|
1786
|
+
pagination: optional<Pagination>
|
|
1223
1787
|
source:
|
|
1224
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1788
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1225
1789
|
AssetUploadUploadDetails:
|
|
1226
1790
|
docs: Metadata for uploading the asset binary
|
|
1227
1791
|
properties:
|
|
@@ -1237,7 +1801,7 @@ types:
|
|
|
1237
1801
|
content-type: optional<string>
|
|
1238
1802
|
Cache-Control: optional<string>
|
|
1239
1803
|
source:
|
|
1240
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1804
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1241
1805
|
inline: true
|
|
1242
1806
|
AssetUpload:
|
|
1243
1807
|
properties:
|
|
@@ -1275,7 +1839,7 @@ types:
|
|
|
1275
1839
|
type: optional<datetime>
|
|
1276
1840
|
docs: Date the asset metadata was last updated
|
|
1277
1841
|
source:
|
|
1278
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1842
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1279
1843
|
AssetFolder:
|
|
1280
1844
|
docs: Asset Folder details
|
|
1281
1845
|
properties:
|
|
@@ -1301,7 +1865,7 @@ types:
|
|
|
1301
1865
|
type: optional<datetime>
|
|
1302
1866
|
docs: Date that the Asset Folder was last updated on
|
|
1303
1867
|
source:
|
|
1304
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1868
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1305
1869
|
AssetFolderList:
|
|
1306
1870
|
docs: The Asset Folders object
|
|
1307
1871
|
properties:
|
|
@@ -1310,7 +1874,7 @@ types:
|
|
|
1310
1874
|
docs: A list of Asset folders
|
|
1311
1875
|
pagination: optional<Pagination>
|
|
1312
1876
|
source:
|
|
1313
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1877
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1314
1878
|
TriggerType:
|
|
1315
1879
|
enum:
|
|
1316
1880
|
- form_submission
|
|
@@ -1329,48 +1893,10 @@ types:
|
|
|
1329
1893
|
- collection_item_deleted
|
|
1330
1894
|
- collection_item_unpublished
|
|
1331
1895
|
docs: >
|
|
1332
|
-
|
|
1333
|
-
|
|
1334
|
-
* `site_publish` - Sends a [site_publish](#site_publish) event
|
|
1335
|
-
|
|
1336
|
-
* `page_created` - Send the [page_created](#page_created) event
|
|
1337
|
-
|
|
1338
|
-
* `page_metadata_updated` - Sends the
|
|
1339
|
-
[page_metadata_updated](#page_metadata_updated) event
|
|
1340
|
-
|
|
1341
|
-
* `page_deleted` - Sends the [page_deleted](#page_deleted) event
|
|
1342
|
-
|
|
1343
|
-
* `ecomm_new_order` - Sends the new [ecomm_new_order](#ecomm_new_order)
|
|
1344
|
-
event
|
|
1345
|
-
|
|
1346
|
-
* `ecomm_order_changed` - Sends the
|
|
1347
|
-
[ecomm_order_changed](#ecomm_order_changed) event
|
|
1348
|
-
|
|
1349
|
-
* `ecomm_inventory_changed` - Sends the
|
|
1350
|
-
[ecomm_inventory_changed](#ecomm_inventory_changed) event
|
|
1351
|
-
|
|
1352
|
-
* `user_account_added` - Sends the
|
|
1353
|
-
[user_account_added](#user_account_added) event
|
|
1354
|
-
|
|
1355
|
-
* `user_account_updated` - Sends the
|
|
1356
|
-
[user_account_updated](#user_account_updated) event
|
|
1357
|
-
|
|
1358
|
-
* `user_account_deleted` - Sends the
|
|
1359
|
-
[user_account_deleted](#user_account_deleted) event
|
|
1360
|
-
|
|
1361
|
-
* `collection_item_created` - Sends the
|
|
1362
|
-
[collection_item_created](#collection_item_created) event
|
|
1363
|
-
|
|
1364
|
-
* `collection_item_changed` - Sends the
|
|
1365
|
-
[collection_item_changed](#collection_item_changed) event
|
|
1366
|
-
|
|
1367
|
-
* `collection_item_deleted` - Sends the
|
|
1368
|
-
[collection_item_deleted](#collection_item_deleted) event
|
|
1369
|
-
|
|
1370
|
-
* `collection_item_unpublished` - Sends the
|
|
1371
|
-
[collection_item_unpublished](#collection_item_unpublished) event
|
|
1896
|
+
The type of event that triggered the request. See the the documentation
|
|
1897
|
+
for details on [supported events](/data/reference/all-events).
|
|
1372
1898
|
source:
|
|
1373
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1899
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1374
1900
|
WebhookFilter:
|
|
1375
1901
|
docs: >-
|
|
1376
1902
|
Only supported for the `form_submission` trigger type. Filter for the form
|
|
@@ -1380,13 +1906,14 @@ types:
|
|
|
1380
1906
|
type: optional<string>
|
|
1381
1907
|
docs: The name of the form you'd like to recieve notifications for.
|
|
1382
1908
|
source:
|
|
1383
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1909
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1384
1910
|
inline: true
|
|
1385
1911
|
Webhook:
|
|
1386
1912
|
properties:
|
|
1387
1913
|
id:
|
|
1388
1914
|
type: optional<string>
|
|
1389
1915
|
docs: Unique identifier for the Webhook registration
|
|
1916
|
+
access: read-only
|
|
1390
1917
|
triggerType: optional<TriggerType>
|
|
1391
1918
|
url:
|
|
1392
1919
|
type: optional<string>
|
|
@@ -1394,9 +1921,11 @@ types:
|
|
|
1394
1921
|
workspaceId:
|
|
1395
1922
|
type: optional<string>
|
|
1396
1923
|
docs: Unique identifier for the Workspace the Webhook is registered in
|
|
1924
|
+
access: read-only
|
|
1397
1925
|
siteId:
|
|
1398
1926
|
type: optional<string>
|
|
1399
1927
|
docs: Unique identifier for the Site the Webhook is registered in
|
|
1928
|
+
access: read-only
|
|
1400
1929
|
filter:
|
|
1401
1930
|
type: optional<WebhookFilter>
|
|
1402
1931
|
docs: >-
|
|
@@ -1405,17 +1934,19 @@ types:
|
|
|
1405
1934
|
lastTriggered:
|
|
1406
1935
|
type: optional<datetime>
|
|
1407
1936
|
docs: Date the Webhook instance was last triggered
|
|
1937
|
+
access: read-only
|
|
1408
1938
|
createdOn:
|
|
1409
1939
|
type: optional<datetime>
|
|
1410
1940
|
docs: Date the Webhook registration was created
|
|
1941
|
+
access: read-only
|
|
1411
1942
|
source:
|
|
1412
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1943
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1413
1944
|
WebhookList:
|
|
1414
1945
|
properties:
|
|
1415
|
-
pagination: optional<Pagination>
|
|
1416
1946
|
webhooks: optional<list<Webhook>>
|
|
1947
|
+
pagination: optional<Pagination>
|
|
1417
1948
|
source:
|
|
1418
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1949
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1419
1950
|
FormFieldValueType:
|
|
1420
1951
|
enum:
|
|
1421
1952
|
- Plain
|
|
@@ -1424,8 +1955,9 @@ types:
|
|
|
1424
1955
|
- Phone
|
|
1425
1956
|
- Number
|
|
1426
1957
|
docs: The field type
|
|
1958
|
+
inline: true
|
|
1427
1959
|
source:
|
|
1428
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1960
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1429
1961
|
FormFieldValue:
|
|
1430
1962
|
docs: An object containing field info for a specific fieldID.
|
|
1431
1963
|
properties:
|
|
@@ -1442,7 +1974,8 @@ types:
|
|
|
1442
1974
|
type: optional<boolean>
|
|
1443
1975
|
docs: Whether the field is visible to the user
|
|
1444
1976
|
source:
|
|
1445
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1977
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1978
|
+
inline: true
|
|
1446
1979
|
FormField:
|
|
1447
1980
|
type: map<string, FormFieldValue>
|
|
1448
1981
|
docs: A collection of form fields with additional properties.
|
|
@@ -1462,7 +1995,7 @@ types:
|
|
|
1462
1995
|
type: optional<boolean>
|
|
1463
1996
|
docs: Whether to send an email confirmation to the user
|
|
1464
1997
|
source:
|
|
1465
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
1998
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1466
1999
|
inline: true
|
|
1467
2000
|
Form:
|
|
1468
2001
|
docs: A Webflow form
|
|
@@ -1504,13 +2037,13 @@ types:
|
|
|
1504
2037
|
type: optional<string>
|
|
1505
2038
|
docs: The unique ID of the Workspace the Site belongs to
|
|
1506
2039
|
source:
|
|
1507
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2040
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1508
2041
|
FormList:
|
|
1509
2042
|
properties:
|
|
1510
2043
|
forms: optional<list<Form>>
|
|
1511
2044
|
pagination: optional<Pagination>
|
|
1512
2045
|
source:
|
|
1513
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2046
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1514
2047
|
FormSubmission:
|
|
1515
2048
|
properties:
|
|
1516
2049
|
id:
|
|
@@ -1532,13 +2065,13 @@ types:
|
|
|
1532
2065
|
type: optional<map<string, unknown>>
|
|
1533
2066
|
docs: The data submitted in the Form
|
|
1534
2067
|
source:
|
|
1535
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2068
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1536
2069
|
FormSubmissionList:
|
|
1537
2070
|
properties:
|
|
1538
2071
|
formSubmissions: optional<list<FormSubmission>>
|
|
1539
2072
|
pagination: optional<Pagination>
|
|
1540
2073
|
source:
|
|
1541
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2074
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1542
2075
|
UserDataData:
|
|
1543
2076
|
properties:
|
|
1544
2077
|
name:
|
|
@@ -1561,22 +2094,23 @@ types:
|
|
|
1561
2094
|
type: optional<string>
|
|
1562
2095
|
docs: Custom user attributes
|
|
1563
2096
|
source:
|
|
1564
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2097
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1565
2098
|
inline: true
|
|
1566
2099
|
UserData:
|
|
1567
2100
|
docs: An object containing the User's basic info and custom fields
|
|
1568
2101
|
properties:
|
|
1569
2102
|
data: optional<UserDataData>
|
|
1570
2103
|
source:
|
|
1571
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2104
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1572
2105
|
UserStatus:
|
|
1573
2106
|
enum:
|
|
1574
2107
|
- invited
|
|
1575
2108
|
- verified
|
|
1576
2109
|
- unverified
|
|
1577
2110
|
docs: The status of the user
|
|
2111
|
+
inline: true
|
|
1578
2112
|
source:
|
|
1579
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2113
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1580
2114
|
UserAccessGroupsItemType:
|
|
1581
2115
|
enum:
|
|
1582
2116
|
- admin
|
|
@@ -1585,8 +2119,9 @@ types:
|
|
|
1585
2119
|
The type of access group based on how it was assigned to the user.
|
|
1586
2120
|
* `admin` - Assigned to the user via API or in the designer
|
|
1587
2121
|
* `ecommerce` - Assigned to the user via an ecommerce purchase
|
|
2122
|
+
inline: true
|
|
1588
2123
|
source:
|
|
1589
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2124
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1590
2125
|
UserAccessGroupsItem:
|
|
1591
2126
|
docs: Access group slugs and types
|
|
1592
2127
|
properties:
|
|
@@ -1600,7 +2135,7 @@ types:
|
|
|
1600
2135
|
* `admin` - Assigned to the user via API or in the designer
|
|
1601
2136
|
* `ecommerce` - Assigned to the user via an ecommerce purchase
|
|
1602
2137
|
source:
|
|
1603
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2138
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1604
2139
|
inline: true
|
|
1605
2140
|
User:
|
|
1606
2141
|
docs: >
|
|
@@ -1612,30 +2147,37 @@ types:
|
|
|
1612
2147
|
id:
|
|
1613
2148
|
type: optional<string>
|
|
1614
2149
|
docs: Unique identifier for the User
|
|
2150
|
+
access: read-only
|
|
1615
2151
|
isEmailVerified:
|
|
1616
2152
|
type: optional<boolean>
|
|
1617
2153
|
docs: Shows whether the user has verified their email address
|
|
2154
|
+
access: read-only
|
|
1618
2155
|
lastUpdated:
|
|
1619
2156
|
type: optional<datetime>
|
|
1620
2157
|
docs: The timestamp the user was updated
|
|
2158
|
+
access: read-only
|
|
1621
2159
|
invitedOn:
|
|
1622
2160
|
type: optional<datetime>
|
|
1623
2161
|
docs: The timestamp the user was invited
|
|
2162
|
+
access: read-only
|
|
1624
2163
|
createdOn:
|
|
1625
2164
|
type: optional<datetime>
|
|
1626
2165
|
docs: The timestamp the user was created
|
|
2166
|
+
access: read-only
|
|
1627
2167
|
lastLogin:
|
|
1628
2168
|
type: optional<datetime>
|
|
1629
2169
|
docs: The timestamp the user was logged in
|
|
2170
|
+
access: read-only
|
|
1630
2171
|
status:
|
|
1631
2172
|
type: optional<UserStatus>
|
|
1632
2173
|
docs: The status of the user
|
|
2174
|
+
access: read-only
|
|
1633
2175
|
accessGroups:
|
|
1634
2176
|
type: optional<list<UserAccessGroupsItem>>
|
|
1635
2177
|
docs: Access groups the user belongs to
|
|
1636
2178
|
data: optional<UserData>
|
|
1637
2179
|
source:
|
|
1638
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2180
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1639
2181
|
UserList:
|
|
1640
2182
|
docs: The list users results
|
|
1641
2183
|
properties:
|
|
@@ -1657,7 +2199,7 @@ types:
|
|
|
1657
2199
|
type: optional<list<User>>
|
|
1658
2200
|
docs: List of Users for a Site
|
|
1659
2201
|
source:
|
|
1660
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2202
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1661
2203
|
UsersNotEnabled: unknown
|
|
1662
2204
|
DuplicateUserEmail: unknown
|
|
1663
2205
|
UserLimitReached: unknown
|
|
@@ -1683,7 +2225,7 @@ types:
|
|
|
1683
2225
|
type: optional<datetime>
|
|
1684
2226
|
docs: The date the Access Group was created
|
|
1685
2227
|
source:
|
|
1686
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2228
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1687
2229
|
AccessGroupList:
|
|
1688
2230
|
docs: The list access groups results
|
|
1689
2231
|
properties:
|
|
@@ -1705,7 +2247,7 @@ types:
|
|
|
1705
2247
|
type: optional<list<AccessGroup>>
|
|
1706
2248
|
docs: List of Site Access Groups
|
|
1707
2249
|
source:
|
|
1708
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2250
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1709
2251
|
SkuPropertyListEnumItem:
|
|
1710
2252
|
docs: Enumerated Product variants/Options for the SKU
|
|
1711
2253
|
properties:
|
|
@@ -1719,7 +2261,7 @@ types:
|
|
|
1719
2261
|
type: string
|
|
1720
2262
|
docs: Slug for the Product variant/Option in the Site URL structure
|
|
1721
2263
|
source:
|
|
1722
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2264
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1723
2265
|
inline: true
|
|
1724
2266
|
SkuPropertyList:
|
|
1725
2267
|
docs: A variant/option type for a SKU
|
|
@@ -1736,7 +2278,7 @@ types:
|
|
|
1736
2278
|
collection
|
|
1737
2279
|
type: list<SkuPropertyListEnumItem>
|
|
1738
2280
|
source:
|
|
1739
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2281
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1740
2282
|
ProductFieldDataTaxCategory:
|
|
1741
2283
|
enum:
|
|
1742
2284
|
- value: standard-taxable
|
|
@@ -1797,8 +2339,9 @@ types:
|
|
|
1797
2339
|
- value: service-training
|
|
1798
2340
|
name: ServiceTraining
|
|
1799
2341
|
docs: Product tax class
|
|
2342
|
+
inline: true
|
|
1800
2343
|
source:
|
|
1801
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2344
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1802
2345
|
ProductFieldDataEcProductType:
|
|
1803
2346
|
enum:
|
|
1804
2347
|
- ff42fee0113744f693a764e3431a9cc2
|
|
@@ -1810,8 +2353,9 @@ types:
|
|
|
1810
2353
|
href="https://university.webflow.com/lesson/add-and-manage-products-and-categories?topics=ecommerce#how-to-understand-product-types">Product
|
|
1811
2354
|
types.</a> Enums reflect the following values in order: Physical, Digital,
|
|
1812
2355
|
Service, Advanced"
|
|
2356
|
+
inline: true
|
|
1813
2357
|
source:
|
|
1814
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2358
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1815
2359
|
ProductFieldData:
|
|
1816
2360
|
docs: >-
|
|
1817
2361
|
Contains content-specific details for a product, covering both standard
|
|
@@ -1850,25 +2394,30 @@ types:
|
|
|
1850
2394
|
types.</a> Enums reflect the following values in order: Physical,
|
|
1851
2395
|
Digital, Service, Advanced"
|
|
1852
2396
|
source:
|
|
1853
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2397
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1854
2398
|
Product:
|
|
1855
2399
|
docs: The Product object
|
|
1856
2400
|
properties:
|
|
1857
2401
|
id:
|
|
1858
2402
|
type: optional<string>
|
|
1859
2403
|
docs: Unique identifier for the Product
|
|
2404
|
+
access: read-only
|
|
1860
2405
|
cmsLocaleId:
|
|
1861
2406
|
type: optional<string>
|
|
1862
2407
|
docs: Identifier for the locale of the CMS item
|
|
2408
|
+
access: read-only
|
|
1863
2409
|
lastPublished:
|
|
1864
2410
|
type: optional<datetime>
|
|
1865
2411
|
docs: The date the Product was last published
|
|
2412
|
+
access: read-only
|
|
1866
2413
|
lastUpdated:
|
|
1867
2414
|
type: optional<datetime>
|
|
1868
2415
|
docs: The date the Product was last updated
|
|
2416
|
+
access: read-only
|
|
1869
2417
|
createdOn:
|
|
1870
2418
|
type: optional<datetime>
|
|
1871
2419
|
docs: The date the Product was created
|
|
2420
|
+
access: read-only
|
|
1872
2421
|
isArchived:
|
|
1873
2422
|
type: optional<boolean>
|
|
1874
2423
|
docs: Boolean determining if the Product is set to archived
|
|
@@ -1879,7 +2428,7 @@ types:
|
|
|
1879
2428
|
default: false
|
|
1880
2429
|
fieldData: optional<ProductFieldData>
|
|
1881
2430
|
source:
|
|
1882
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2431
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1883
2432
|
SkuValueList:
|
|
1884
2433
|
type: map<string, string>
|
|
1885
2434
|
docs: >
|
|
@@ -1895,7 +2444,7 @@ types:
|
|
|
1895
2444
|
type: optional<string>
|
|
1896
2445
|
docs: Currency of Item
|
|
1897
2446
|
source:
|
|
1898
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2447
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1899
2448
|
inline: true
|
|
1900
2449
|
SkuFieldDataCompareAtPrice:
|
|
1901
2450
|
docs: comparison price of SKU
|
|
@@ -1907,15 +2456,20 @@ types:
|
|
|
1907
2456
|
type: optional<string>
|
|
1908
2457
|
docs: Currency of Item
|
|
1909
2458
|
source:
|
|
1910
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2459
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1911
2460
|
inline: true
|
|
1912
2461
|
SkuFieldDataEcSkuBillingMethod:
|
|
1913
2462
|
enum:
|
|
1914
2463
|
- value: one-time
|
|
1915
2464
|
name: OneTime
|
|
1916
2465
|
- subscription
|
|
2466
|
+
docs: >-
|
|
2467
|
+
[Billing
|
|
2468
|
+
method](https://help.webflow.com/hc/en-us/articles/33961432087955-Add-and-manage-products-and-categories#billing-methods)for
|
|
2469
|
+
the SKU
|
|
2470
|
+
inline: true
|
|
1917
2471
|
source:
|
|
1918
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2472
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1919
2473
|
SkuFieldDataEcSkuSubscriptionPlanInterval:
|
|
1920
2474
|
enum:
|
|
1921
2475
|
- day
|
|
@@ -1923,16 +2477,18 @@ types:
|
|
|
1923
2477
|
- month
|
|
1924
2478
|
- year
|
|
1925
2479
|
docs: Interval of subscription renewal
|
|
2480
|
+
inline: true
|
|
1926
2481
|
source:
|
|
1927
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2482
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1928
2483
|
SkuFieldDataEcSkuSubscriptionPlanPlansItemStatus:
|
|
1929
2484
|
enum:
|
|
1930
2485
|
- active
|
|
1931
2486
|
- inactive
|
|
1932
2487
|
- canceled
|
|
1933
2488
|
docs: The status of the plan
|
|
2489
|
+
inline: true
|
|
1934
2490
|
source:
|
|
1935
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2491
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1936
2492
|
SkuFieldDataEcSkuSubscriptionPlanPlansItem:
|
|
1937
2493
|
properties:
|
|
1938
2494
|
platform:
|
|
@@ -1945,9 +2501,13 @@ types:
|
|
|
1945
2501
|
type: optional<SkuFieldDataEcSkuSubscriptionPlanPlansItemStatus>
|
|
1946
2502
|
docs: The status of the plan
|
|
1947
2503
|
source:
|
|
1948
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2504
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1949
2505
|
inline: true
|
|
1950
2506
|
SkuFieldDataEcSkuSubscriptionPlan:
|
|
2507
|
+
docs: >-
|
|
2508
|
+
[Subscription
|
|
2509
|
+
plan](https://help.webflow.com/hc/en-us/articles/33961432087955-Add-and-manage-products-and-categories#subscription)
|
|
2510
|
+
for the SKU
|
|
1951
2511
|
properties:
|
|
1952
2512
|
interval:
|
|
1953
2513
|
type: optional<SkuFieldDataEcSkuSubscriptionPlanInterval>
|
|
@@ -1958,9 +2518,11 @@ types:
|
|
|
1958
2518
|
trial:
|
|
1959
2519
|
type: optional<double>
|
|
1960
2520
|
docs: Number of days of a trial
|
|
1961
|
-
plans:
|
|
2521
|
+
plans:
|
|
2522
|
+
type: optional<list<SkuFieldDataEcSkuSubscriptionPlanPlansItem>>
|
|
2523
|
+
access: read-only
|
|
1962
2524
|
source:
|
|
1963
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2525
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1964
2526
|
inline: true
|
|
1965
2527
|
SkuFieldData:
|
|
1966
2528
|
docs: Standard and Custom fields for a SKU
|
|
@@ -1978,8 +2540,18 @@ types:
|
|
|
1978
2540
|
compare-at-price:
|
|
1979
2541
|
type: optional<SkuFieldDataCompareAtPrice>
|
|
1980
2542
|
docs: comparison price of SKU
|
|
1981
|
-
ec-sku-billing-method:
|
|
1982
|
-
|
|
2543
|
+
ec-sku-billing-method:
|
|
2544
|
+
type: optional<SkuFieldDataEcSkuBillingMethod>
|
|
2545
|
+
docs: >-
|
|
2546
|
+
[Billing
|
|
2547
|
+
method](https://help.webflow.com/hc/en-us/articles/33961432087955-Add-and-manage-products-and-categories#billing-methods)for
|
|
2548
|
+
the SKU
|
|
2549
|
+
ec-sku-subscription-plan:
|
|
2550
|
+
type: optional<SkuFieldDataEcSkuSubscriptionPlan>
|
|
2551
|
+
docs: >-
|
|
2552
|
+
[Subscription
|
|
2553
|
+
plan](https://help.webflow.com/hc/en-us/articles/33961432087955-Add-and-manage-products-and-categories#subscription)
|
|
2554
|
+
for the SKU
|
|
1983
2555
|
track-inventory:
|
|
1984
2556
|
type: optional<boolean>
|
|
1985
2557
|
docs: >-
|
|
@@ -1990,28 +2562,33 @@ types:
|
|
|
1990
2562
|
type: optional<double>
|
|
1991
2563
|
docs: Quantity of SKU that will be tracked as items are ordered.
|
|
1992
2564
|
source:
|
|
1993
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2565
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1994
2566
|
Sku:
|
|
1995
2567
|
docs: The SKU object
|
|
1996
2568
|
properties:
|
|
1997
2569
|
id:
|
|
1998
2570
|
type: optional<string>
|
|
1999
2571
|
docs: Unique identifier for the Product
|
|
2572
|
+
access: read-only
|
|
2000
2573
|
cmsLocaleId:
|
|
2001
2574
|
type: optional<string>
|
|
2002
2575
|
docs: Identifier for the locale of the CMS item
|
|
2576
|
+
access: read-only
|
|
2003
2577
|
lastPublished:
|
|
2004
2578
|
type: optional<datetime>
|
|
2005
2579
|
docs: The date the Product was last published
|
|
2580
|
+
access: read-only
|
|
2006
2581
|
lastUpdated:
|
|
2007
2582
|
type: optional<datetime>
|
|
2008
2583
|
docs: The date the Product was last updated
|
|
2584
|
+
access: read-only
|
|
2009
2585
|
createdOn:
|
|
2010
2586
|
type: optional<datetime>
|
|
2011
2587
|
docs: The date the Product was created
|
|
2588
|
+
access: read-only
|
|
2012
2589
|
fieldData: optional<SkuFieldData>
|
|
2013
2590
|
source:
|
|
2014
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2591
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2015
2592
|
ProductAndSkUs:
|
|
2016
2593
|
docs: A product and its SKUs.
|
|
2017
2594
|
properties:
|
|
@@ -2020,7 +2597,7 @@ types:
|
|
|
2020
2597
|
type: optional<list<Sku>>
|
|
2021
2598
|
docs: A list of SKU Objects
|
|
2022
2599
|
source:
|
|
2023
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2600
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2024
2601
|
ProductAndSkUsList:
|
|
2025
2602
|
docs: Results from product list
|
|
2026
2603
|
properties:
|
|
@@ -2031,7 +2608,7 @@ types:
|
|
|
2031
2608
|
keys for each Item
|
|
2032
2609
|
pagination: optional<Pagination>
|
|
2033
2610
|
source:
|
|
2034
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2611
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2035
2612
|
PublishStatus:
|
|
2036
2613
|
enum:
|
|
2037
2614
|
- staging
|
|
@@ -2039,7 +2616,7 @@ types:
|
|
|
2039
2616
|
docs: Indicate whether your Product should be set as "staging" or "live"
|
|
2040
2617
|
default: staging
|
|
2041
2618
|
source:
|
|
2042
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2619
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2043
2620
|
OrderPrice:
|
|
2044
2621
|
properties:
|
|
2045
2622
|
unit:
|
|
@@ -2052,14 +2629,15 @@ types:
|
|
|
2052
2629
|
type: optional<string>
|
|
2053
2630
|
docs: The user-facing string representation of the amount
|
|
2054
2631
|
source:
|
|
2055
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2632
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2056
2633
|
OrderAddressType:
|
|
2057
2634
|
enum:
|
|
2058
2635
|
- shipping
|
|
2059
2636
|
- billing
|
|
2060
2637
|
docs: The type of the order address (billing or shipping)
|
|
2638
|
+
inline: true
|
|
2061
2639
|
source:
|
|
2062
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2640
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2063
2641
|
OrderAddressJapanType:
|
|
2064
2642
|
enum:
|
|
2065
2643
|
- kana
|
|
@@ -2067,8 +2645,9 @@ types:
|
|
|
2067
2645
|
docs: >-
|
|
2068
2646
|
Represents a Japan-only address format. This field will only appear on
|
|
2069
2647
|
orders placed from Japan.
|
|
2648
|
+
inline: true
|
|
2070
2649
|
source:
|
|
2071
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2650
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2072
2651
|
OrderAddress:
|
|
2073
2652
|
docs: A customer address
|
|
2074
2653
|
properties:
|
|
@@ -2102,7 +2681,7 @@ types:
|
|
|
2102
2681
|
type: optional<string>
|
|
2103
2682
|
docs: The postal code of the address
|
|
2104
2683
|
source:
|
|
2105
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2684
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2106
2685
|
OrderPurchasedItemVariantImageFileVariantsItem:
|
|
2107
2686
|
properties:
|
|
2108
2687
|
url:
|
|
@@ -2121,7 +2700,7 @@ types:
|
|
|
2121
2700
|
type: optional<integer>
|
|
2122
2701
|
docs: The image height in pixels
|
|
2123
2702
|
source:
|
|
2124
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2703
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2125
2704
|
inline: true
|
|
2126
2705
|
OrderPurchasedItemVariantImageFile:
|
|
2127
2706
|
properties:
|
|
@@ -2147,7 +2726,7 @@ types:
|
|
|
2147
2726
|
type: optional<list<OrderPurchasedItemVariantImageFileVariantsItem>>
|
|
2148
2727
|
docs: Variants of the supplied image
|
|
2149
2728
|
source:
|
|
2150
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2729
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2151
2730
|
inline: true
|
|
2152
2731
|
OrderPurchasedItemVariantImage:
|
|
2153
2732
|
properties:
|
|
@@ -2158,7 +2737,7 @@ types:
|
|
|
2158
2737
|
format: uri
|
|
2159
2738
|
file: optional<OrderPurchasedItemVariantImageFile>
|
|
2160
2739
|
source:
|
|
2161
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2740
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2162
2741
|
inline: true
|
|
2163
2742
|
OrderPurchasedItem:
|
|
2164
2743
|
docs: An Item that was purchased
|
|
@@ -2172,6 +2751,7 @@ types:
|
|
|
2172
2751
|
productId:
|
|
2173
2752
|
type: optional<string>
|
|
2174
2753
|
docs: The unique identifier for the Product
|
|
2754
|
+
access: read-only
|
|
2175
2755
|
productName:
|
|
2176
2756
|
type: optional<string>
|
|
2177
2757
|
docs: User-facing name of the Product
|
|
@@ -2207,7 +2787,7 @@ types:
|
|
|
2207
2787
|
type: optional<double>
|
|
2208
2788
|
docs: The physical length of the variant if provided, or null
|
|
2209
2789
|
source:
|
|
2210
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2790
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2211
2791
|
StripeDetails:
|
|
2212
2792
|
docs: >-
|
|
2213
2793
|
An object with various Stripe IDs, useful for linking into the stripe
|
|
@@ -2238,7 +2818,7 @@ types:
|
|
|
2238
2818
|
type: optional<string>
|
|
2239
2819
|
docs: Stripe-generated refund reason, or null
|
|
2240
2820
|
source:
|
|
2241
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2821
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2242
2822
|
StripeCardBrand:
|
|
2243
2823
|
enum:
|
|
2244
2824
|
- Visa
|
|
@@ -2251,8 +2831,9 @@ types:
|
|
|
2251
2831
|
name: DinersClub
|
|
2252
2832
|
- Unknown
|
|
2253
2833
|
docs: The card's brand (ie. credit card network)
|
|
2834
|
+
inline: true
|
|
2254
2835
|
source:
|
|
2255
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2836
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2256
2837
|
StripeCardExpires:
|
|
2257
2838
|
docs: The card's expiration date.
|
|
2258
2839
|
properties:
|
|
@@ -2263,7 +2844,7 @@ types:
|
|
|
2263
2844
|
type: optional<double>
|
|
2264
2845
|
docs: Month that the card expires
|
|
2265
2846
|
source:
|
|
2266
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2847
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2267
2848
|
inline: true
|
|
2268
2849
|
StripeCard:
|
|
2269
2850
|
docs: >
|
|
@@ -2283,7 +2864,7 @@ types:
|
|
|
2283
2864
|
type: optional<StripeCardExpires>
|
|
2284
2865
|
docs: The card's expiration date.
|
|
2285
2866
|
source:
|
|
2286
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2867
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2287
2868
|
PaypalDetails:
|
|
2288
2869
|
properties:
|
|
2289
2870
|
orderId:
|
|
@@ -2305,7 +2886,7 @@ types:
|
|
|
2305
2886
|
type: optional<string>
|
|
2306
2887
|
docs: PayPal dispute identifier
|
|
2307
2888
|
source:
|
|
2308
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2889
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2309
2890
|
OrderStatus:
|
|
2310
2891
|
enum:
|
|
2311
2892
|
- pending
|
|
@@ -2317,8 +2898,9 @@ types:
|
|
|
2317
2898
|
- refunded
|
|
2318
2899
|
docs: |
|
|
2319
2900
|
The status of the Order
|
|
2901
|
+
inline: true
|
|
2320
2902
|
source:
|
|
2321
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2903
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2322
2904
|
OrderDisputeLastStatus:
|
|
2323
2905
|
enum:
|
|
2324
2906
|
- warning_needs_response
|
|
@@ -2332,8 +2914,9 @@ types:
|
|
|
2332
2914
|
docs: >
|
|
2333
2915
|
If an order was disputed by the customer, then this key will be set with
|
|
2334
2916
|
the [dispute's status](https://stripe.com/docs/api#dispute_object-status).
|
|
2917
|
+
inline: true
|
|
2335
2918
|
source:
|
|
2336
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2919
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2337
2920
|
OrderCustomerInfo:
|
|
2338
2921
|
docs: An object with the keys `fullName` and `email`.
|
|
2339
2922
|
properties:
|
|
@@ -2346,13 +2929,13 @@ types:
|
|
|
2346
2929
|
validation:
|
|
2347
2930
|
format: email
|
|
2348
2931
|
source:
|
|
2349
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2932
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2350
2933
|
inline: true
|
|
2351
2934
|
OrderMetadata:
|
|
2352
2935
|
properties:
|
|
2353
2936
|
isBuyNow: optional<boolean>
|
|
2354
2937
|
source:
|
|
2355
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2938
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2356
2939
|
inline: true
|
|
2357
2940
|
OrderTotalsExtrasItemType:
|
|
2358
2941
|
enum:
|
|
@@ -2362,8 +2945,9 @@ types:
|
|
|
2362
2945
|
- shipping
|
|
2363
2946
|
- tax
|
|
2364
2947
|
docs: The type of extra item this is.
|
|
2948
|
+
inline: true
|
|
2365
2949
|
source:
|
|
2366
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2950
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2367
2951
|
OrderTotalsExtrasItem:
|
|
2368
2952
|
docs: Extra order items, includes discounts, shipping, and taxes.
|
|
2369
2953
|
properties:
|
|
@@ -2380,7 +2964,7 @@ types:
|
|
|
2380
2964
|
type: optional<OrderPrice>
|
|
2381
2965
|
docs: The price for the item
|
|
2382
2966
|
source:
|
|
2383
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2967
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2384
2968
|
inline: true
|
|
2385
2969
|
OrderTotals:
|
|
2386
2970
|
docs: An object describing various pricing totals
|
|
@@ -2395,7 +2979,7 @@ types:
|
|
|
2395
2979
|
type: optional<OrderPrice>
|
|
2396
2980
|
docs: The total price
|
|
2397
2981
|
source:
|
|
2398
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2982
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2399
2983
|
inline: true
|
|
2400
2984
|
OrderDownloadFilesItem:
|
|
2401
2985
|
properties:
|
|
@@ -2411,7 +2995,7 @@ types:
|
|
|
2411
2995
|
validation:
|
|
2412
2996
|
format: uri
|
|
2413
2997
|
source:
|
|
2414
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
2998
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2415
2999
|
inline: true
|
|
2416
3000
|
Order:
|
|
2417
3001
|
properties:
|
|
@@ -2421,6 +3005,7 @@ types:
|
|
|
2421
3005
|
The order ID. Will usually be 6 hex characters, but can also be 9
|
|
2422
3006
|
hex characters if the site has a very large number of Orders.
|
|
2423
3007
|
Randomly assigned.
|
|
3008
|
+
access: read-only
|
|
2424
3009
|
status:
|
|
2425
3010
|
type: optional<OrderStatus>
|
|
2426
3011
|
docs: |
|
|
@@ -2540,7 +3125,7 @@ types:
|
|
|
2540
3125
|
type: optional<list<OrderDownloadFilesItem>>
|
|
2541
3126
|
docs: An array of downloadable file objects.
|
|
2542
3127
|
source:
|
|
2543
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
3128
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2544
3129
|
OrderList:
|
|
2545
3130
|
docs: Results from order list
|
|
2546
3131
|
properties:
|
|
@@ -2549,20 +3134,22 @@ types:
|
|
|
2549
3134
|
docs: List of orders
|
|
2550
3135
|
pagination: optional<Pagination>
|
|
2551
3136
|
source:
|
|
2552
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
3137
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2553
3138
|
InventoryItemInventoryType:
|
|
2554
3139
|
enum:
|
|
2555
3140
|
- infinite
|
|
2556
3141
|
- finite
|
|
2557
3142
|
docs: infinite or finite
|
|
3143
|
+
inline: true
|
|
2558
3144
|
source:
|
|
2559
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
3145
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2560
3146
|
InventoryItem:
|
|
2561
3147
|
docs: The availabile inventory for an item
|
|
2562
3148
|
properties:
|
|
2563
3149
|
id:
|
|
2564
3150
|
type: optional<string>
|
|
2565
3151
|
docs: Unique identifier for a SKU item
|
|
3152
|
+
access: read-only
|
|
2566
3153
|
quantity:
|
|
2567
3154
|
type: optional<double>
|
|
2568
3155
|
docs: >-
|
|
@@ -2572,18 +3159,20 @@ types:
|
|
|
2572
3159
|
type: optional<InventoryItemInventoryType>
|
|
2573
3160
|
docs: infinite or finite
|
|
2574
3161
|
source:
|
|
2575
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
3162
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2576
3163
|
EcommerceSettings:
|
|
2577
3164
|
docs: Ecommerce settings for a Webflow Site
|
|
2578
3165
|
properties:
|
|
2579
3166
|
siteId:
|
|
2580
3167
|
type: optional<string>
|
|
2581
3168
|
docs: The identifier of the Site
|
|
3169
|
+
access: read-only
|
|
2582
3170
|
createdOn:
|
|
2583
3171
|
type: optional<datetime>
|
|
2584
3172
|
docs: Date that the Site was created on
|
|
3173
|
+
access: read-only
|
|
2585
3174
|
defaultCurrency:
|
|
2586
3175
|
type: optional<string>
|
|
2587
3176
|
docs: The three-letter ISO currency code for the Site
|
|
2588
3177
|
source:
|
|
2589
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
3178
|
+
openapi: ../../../openapi/referenced-specs/v2.yml
|