webflow-api 3.3.0-beta → 3.3.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/BaseClient.d.ts +1 -1
- package/Client.d.ts +1 -7
- package/Client.js +31 -41
- package/LICENSE +18 -18
- package/README.md +55 -28
- package/api/resources/assets/client/Client.d.ts +4 -4
- package/api/resources/assets/client/Client.js +7 -8
- package/api/resources/assets/client/requests/AssetsListRequest.d.ts +2 -2
- package/api/resources/collections/client/Client.d.ts +2 -2
- package/api/resources/collections/client/Client.js +3 -6
- package/api/resources/collections/resources/fields/client/Client.d.ts +2 -2
- package/api/resources/collections/resources/fields/client/Client.js +4 -6
- package/api/resources/collections/resources/items/client/Client.d.ts +6 -6
- package/api/resources/collections/resources/items/client/Client.js +24 -12
- 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/CreateBulkCollectionItemRequestBodyFieldData.d.ts +1 -1
- package/{dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts → api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataOneItem.d.ts} +1 -1
- package/api/resources/collections/resources/items/types/index.d.ts +1 -1
- package/api/resources/collections/resources/items/types/index.js +1 -1
- package/api/resources/components/client/Client.d.ts +8 -8
- package/api/resources/components/client/Client.js +10 -12
- package/api/resources/components/client/requests/ComponentsGetContentRequest.d.ts +2 -2
- package/api/resources/components/client/requests/ComponentsGetPropertiesRequest.d.ts +2 -2
- package/api/resources/components/client/requests/ComponentsListRequest.d.ts +2 -2
- package/api/resources/ecommerce/client/Client.d.ts +2 -2
- package/api/resources/ecommerce/client/Client.js +2 -6
- package/api/resources/forms/client/Client.d.ts +6 -6
- package/api/resources/forms/client/Client.js +7 -10
- package/api/resources/forms/client/requests/FormsListRequest.d.ts +2 -2
- package/api/resources/forms/client/requests/FormsListSubmissionsRequest.d.ts +2 -2
- package/api/resources/index.d.ts +0 -6
- package/api/resources/index.js +1 -7
- package/api/resources/inventory/client/Client.d.ts +2 -2
- package/api/resources/inventory/client/Client.js +3 -6
- package/api/resources/orders/client/Client.d.ts +4 -4
- package/api/resources/orders/client/Client.js +8 -8
- package/api/resources/orders/client/requests/OrdersListRequest.d.ts +2 -2
- package/api/resources/pages/client/Client.d.ts +6 -6
- package/api/resources/pages/client/Client.js +8 -10
- package/api/resources/pages/client/requests/PagesGetContentRequest.d.ts +2 -2
- package/api/resources/pages/client/requests/PagesListRequest.d.ts +2 -2
- package/api/resources/pages/resources/scripts/client/Client.d.ts +2 -2
- package/api/resources/pages/resources/scripts/client/Client.js +3 -6
- package/api/resources/products/client/Client.d.ts +4 -4
- package/api/resources/products/client/Client.js +8 -8
- package/api/resources/products/client/requests/ProductsListRequest.d.ts +2 -2
- package/api/resources/scripts/client/Client.d.ts +2 -2
- package/api/resources/scripts/client/Client.js +4 -6
- package/api/resources/sites/client/Client.d.ts +2 -2
- package/api/resources/sites/client/Client.js +5 -6
- package/api/resources/sites/resources/activityLogs/client/Client.d.ts +4 -4
- package/api/resources/sites/resources/activityLogs/client/Client.js +4 -8
- package/api/resources/sites/resources/activityLogs/client/requests/ActivityLogsListRequest.d.ts +2 -2
- package/api/resources/sites/resources/comments/client/Client.d.ts +8 -8
- package/api/resources/sites/resources/comments/client/Client.js +14 -12
- package/api/resources/sites/resources/comments/client/requests/CommentsGetCommentThreadRequest.d.ts +2 -2
- package/api/resources/sites/resources/comments/client/requests/CommentsListCommentRepliesRequest.d.ts +2 -2
- package/api/resources/sites/resources/comments/client/requests/CommentsListCommentThreadsRequest.d.ts +2 -2
- package/api/resources/sites/resources/forms/client/Client.d.ts +6 -6
- package/api/resources/sites/resources/forms/client/Client.js +7 -10
- package/api/resources/sites/resources/forms/client/requests/FormsListSubmissionsBySiteRequest.d.ts +2 -2
- package/api/resources/sites/resources/forms/client/requests/FormsListSubmissionsRequest.d.ts +2 -2
- package/api/resources/sites/resources/plans/client/Client.d.ts +2 -2
- package/api/resources/sites/resources/plans/client/Client.js +2 -6
- package/api/resources/sites/resources/redirects/client/Client.d.ts +4 -4
- package/api/resources/sites/resources/redirects/client/Client.js +6 -8
- package/api/resources/sites/resources/robotsTxt/client/Client.d.ts +2 -2
- package/api/resources/sites/resources/robotsTxt/client/Client.js +5 -6
- package/api/resources/sites/resources/scripts/client/Client.d.ts +4 -4
- package/api/resources/sites/resources/scripts/client/Client.js +5 -8
- package/api/resources/sites/resources/scripts/client/requests/ScriptsListCustomCodeBlocksRequest.d.ts +2 -2
- package/api/resources/sites/resources/wellKnown/client/Client.d.ts +2 -2
- package/api/resources/sites/resources/wellKnown/client/Client.js +4 -6
- package/api/resources/token/client/Client.d.ts +2 -2
- package/api/resources/token/client/Client.js +2 -6
- package/api/resources/webhooks/client/Client.d.ts +2 -2
- package/api/resources/webhooks/client/Client.js +3 -6
- package/api/resources/workspaces/client/Client.d.ts +1 -1
- package/api/resources/workspaces/client/Client.js +1 -1
- package/api/resources/workspaces/resources/auditLogs/client/Client.d.ts +4 -4
- package/api/resources/workspaces/resources/auditLogs/client/Client.js +6 -8
- package/api/resources/workspaces/resources/auditLogs/client/requests/AuditLogsGetWorkspaceAuditLogsRequest.d.ts +2 -2
- package/api/resources/workspaces/resources/auditLogs/types/AuditLogsGetWorkspaceAuditLogsRequestEventType.d.ts +1 -0
- package/api/resources/workspaces/resources/auditLogs/types/AuditLogsGetWorkspaceAuditLogsRequestEventType.js +1 -0
- package/api/types/AssetVariant.d.ts +6 -6
- package/api/types/ComponentDom.d.ts +1 -1
- package/api/types/ForbiddenErrorBody.d.ts +1 -1
- package/api/types/ProductFieldData.d.ts +1 -1
- package/api/types/SettingChange.d.ts +7 -0
- package/api/types/SettingChangeAuditLogItem.d.ts +5 -0
- package/api/types/TriggerType.d.ts +0 -3
- package/api/types/TriggerType.js +0 -3
- package/api/types/WorkspaceAuditLogItem.d.ts +4 -1
- package/api/types/WorkspaceAuditLogItemPayloadSettingChangeMethod.d.ts +5 -0
- package/api/types/WorkspaceAuditLogItemPayloadSettingChangeMethod.js +8 -0
- package/api/types/index.d.ts +3 -13
- package/api/types/index.js +3 -13
- package/dist/BaseClient.d.ts +1 -1
- package/dist/Client.d.ts +1 -7
- package/dist/Client.js +31 -41
- package/dist/api/resources/assets/client/Client.d.ts +4 -4
- package/dist/api/resources/assets/client/Client.js +7 -8
- package/dist/api/resources/assets/client/requests/AssetsListRequest.d.ts +2 -2
- package/dist/api/resources/collections/client/Client.d.ts +2 -2
- package/dist/api/resources/collections/client/Client.js +3 -6
- package/dist/api/resources/collections/resources/fields/client/Client.d.ts +2 -2
- package/dist/api/resources/collections/resources/fields/client/Client.js +4 -6
- package/dist/api/resources/collections/resources/items/client/Client.d.ts +6 -6
- package/dist/api/resources/collections/resources/items/client/Client.js +24 -12
- 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/CreateBulkCollectionItemRequestBodyFieldData.d.ts +1 -1
- package/{api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts → dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataOneItem.d.ts} +1 -1
- package/dist/api/resources/collections/resources/items/types/index.d.ts +1 -1
- package/dist/api/resources/collections/resources/items/types/index.js +1 -1
- package/dist/api/resources/components/client/Client.d.ts +8 -8
- package/dist/api/resources/components/client/Client.js +10 -12
- package/dist/api/resources/components/client/requests/ComponentsGetContentRequest.d.ts +2 -2
- package/dist/api/resources/components/client/requests/ComponentsGetPropertiesRequest.d.ts +2 -2
- package/dist/api/resources/components/client/requests/ComponentsListRequest.d.ts +2 -2
- package/dist/api/resources/ecommerce/client/Client.d.ts +2 -2
- package/dist/api/resources/ecommerce/client/Client.js +2 -6
- package/dist/api/resources/forms/client/Client.d.ts +6 -6
- package/dist/api/resources/forms/client/Client.js +7 -10
- package/dist/api/resources/forms/client/requests/FormsListRequest.d.ts +2 -2
- package/dist/api/resources/forms/client/requests/FormsListSubmissionsRequest.d.ts +2 -2
- package/dist/api/resources/index.d.ts +0 -6
- package/dist/api/resources/index.js +1 -7
- package/dist/api/resources/inventory/client/Client.d.ts +2 -2
- package/dist/api/resources/inventory/client/Client.js +3 -6
- package/dist/api/resources/orders/client/Client.d.ts +4 -4
- package/dist/api/resources/orders/client/Client.js +8 -8
- package/dist/api/resources/orders/client/requests/OrdersListRequest.d.ts +2 -2
- package/dist/api/resources/pages/client/Client.d.ts +6 -6
- package/dist/api/resources/pages/client/Client.js +8 -10
- package/dist/api/resources/pages/client/requests/PagesGetContentRequest.d.ts +2 -2
- package/dist/api/resources/pages/client/requests/PagesListRequest.d.ts +2 -2
- package/dist/api/resources/pages/resources/scripts/client/Client.d.ts +2 -2
- package/dist/api/resources/pages/resources/scripts/client/Client.js +3 -6
- package/dist/api/resources/products/client/Client.d.ts +4 -4
- package/dist/api/resources/products/client/Client.js +8 -8
- package/dist/api/resources/products/client/requests/ProductsListRequest.d.ts +2 -2
- package/dist/api/resources/scripts/client/Client.d.ts +2 -2
- package/dist/api/resources/scripts/client/Client.js +4 -6
- package/dist/api/resources/sites/client/Client.d.ts +2 -2
- package/dist/api/resources/sites/client/Client.js +5 -6
- package/dist/api/resources/sites/resources/activityLogs/client/Client.d.ts +4 -4
- package/dist/api/resources/sites/resources/activityLogs/client/Client.js +4 -8
- package/dist/api/resources/sites/resources/activityLogs/client/requests/ActivityLogsListRequest.d.ts +2 -2
- package/dist/api/resources/sites/resources/comments/client/Client.d.ts +8 -8
- package/dist/api/resources/sites/resources/comments/client/Client.js +14 -12
- package/dist/api/resources/sites/resources/comments/client/requests/CommentsGetCommentThreadRequest.d.ts +2 -2
- package/dist/api/resources/sites/resources/comments/client/requests/CommentsListCommentRepliesRequest.d.ts +2 -2
- package/dist/api/resources/sites/resources/comments/client/requests/CommentsListCommentThreadsRequest.d.ts +2 -2
- package/dist/api/resources/sites/resources/forms/client/Client.d.ts +6 -6
- package/dist/api/resources/sites/resources/forms/client/Client.js +7 -10
- package/dist/api/resources/sites/resources/forms/client/requests/FormsListSubmissionsBySiteRequest.d.ts +2 -2
- package/dist/api/resources/sites/resources/forms/client/requests/FormsListSubmissionsRequest.d.ts +2 -2
- package/dist/api/resources/sites/resources/plans/client/Client.d.ts +2 -2
- package/dist/api/resources/sites/resources/plans/client/Client.js +2 -6
- package/dist/api/resources/sites/resources/redirects/client/Client.d.ts +4 -4
- package/dist/api/resources/sites/resources/redirects/client/Client.js +6 -8
- package/dist/api/resources/sites/resources/robotsTxt/client/Client.d.ts +2 -2
- package/dist/api/resources/sites/resources/robotsTxt/client/Client.js +5 -6
- package/dist/api/resources/sites/resources/scripts/client/Client.d.ts +4 -4
- package/dist/api/resources/sites/resources/scripts/client/Client.js +5 -8
- package/dist/api/resources/sites/resources/scripts/client/requests/ScriptsListCustomCodeBlocksRequest.d.ts +2 -2
- package/dist/api/resources/sites/resources/wellKnown/client/Client.d.ts +2 -2
- package/dist/api/resources/sites/resources/wellKnown/client/Client.js +4 -6
- package/dist/api/resources/token/client/Client.d.ts +2 -2
- package/dist/api/resources/token/client/Client.js +2 -6
- package/dist/api/resources/webhooks/client/Client.d.ts +2 -2
- package/dist/api/resources/webhooks/client/Client.js +3 -6
- package/dist/api/resources/workspaces/client/Client.d.ts +1 -1
- package/dist/api/resources/workspaces/client/Client.js +1 -1
- package/dist/api/resources/workspaces/resources/auditLogs/client/Client.d.ts +4 -4
- package/dist/api/resources/workspaces/resources/auditLogs/client/Client.js +6 -8
- package/dist/api/resources/workspaces/resources/auditLogs/client/requests/AuditLogsGetWorkspaceAuditLogsRequest.d.ts +2 -2
- package/dist/api/resources/workspaces/resources/auditLogs/types/AuditLogsGetWorkspaceAuditLogsRequestEventType.d.ts +1 -0
- package/dist/api/resources/workspaces/resources/auditLogs/types/AuditLogsGetWorkspaceAuditLogsRequestEventType.js +1 -0
- package/dist/api/types/AssetVariant.d.ts +6 -6
- package/dist/api/types/ComponentDom.d.ts +1 -1
- package/dist/api/types/ForbiddenErrorBody.d.ts +1 -1
- package/dist/api/types/ProductFieldData.d.ts +1 -1
- package/dist/api/types/SettingChange.d.ts +7 -0
- package/dist/api/types/SettingChangeAuditLogItem.d.ts +5 -0
- package/dist/api/types/TriggerType.d.ts +0 -3
- package/dist/api/types/TriggerType.js +0 -3
- package/dist/api/types/WorkspaceAuditLogItem.d.ts +4 -1
- package/dist/api/types/WorkspaceAuditLogItemPayloadSettingChangeMethod.d.ts +5 -0
- package/dist/api/types/WorkspaceAuditLogItemPayloadSettingChangeMethod.js +8 -0
- package/dist/api/types/index.d.ts +3 -13
- package/dist/api/types/index.js +3 -13
- package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +2 -2
- package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.js +2 -2
- package/{serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts → dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataOneItem.d.ts} +2 -2
- package/{serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.js → dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataOneItem.js} +2 -2
- package/dist/serialization/resources/collections/resources/items/types/index.d.ts +1 -1
- package/dist/serialization/resources/collections/resources/items/types/index.js +1 -1
- package/dist/serialization/resources/index.d.ts +0 -5
- package/dist/serialization/resources/index.js +1 -6
- package/dist/serialization/resources/workspaces/resources/auditLogs/types/AuditLogsGetWorkspaceAuditLogsRequestEventType.d.ts +1 -1
- package/dist/serialization/resources/workspaces/resources/auditLogs/types/AuditLogsGetWorkspaceAuditLogsRequestEventType.js +1 -0
- package/dist/serialization/types/AssetVariant.d.ts +6 -6
- package/dist/serialization/types/AssetVariant.js +6 -6
- package/dist/serialization/types/ForbiddenErrorBody.d.ts +2 -2
- package/dist/serialization/types/ForbiddenErrorBody.js +2 -2
- package/dist/serialization/types/SettingChange.d.ts +13 -0
- package/dist/serialization/types/{AccessGroup.js → SettingChange.js} +7 -7
- package/dist/serialization/types/SettingChangeAuditLogItem.d.ts +11 -0
- package/dist/serialization/types/{UserAccessGroupsItem.js → SettingChangeAuditLogItem.js} +5 -5
- package/dist/serialization/types/TriggerType.d.ts +1 -1
- package/dist/serialization/types/TriggerType.js +0 -3
- package/dist/serialization/types/WorkspaceAuditLogItem.d.ts +5 -1
- package/dist/serialization/types/WorkspaceAuditLogItem.js +2 -0
- package/dist/serialization/types/WorkspaceAuditLogItemPayloadSettingChangeMethod.d.ts +7 -0
- package/dist/serialization/types/{UserStatus.js → WorkspaceAuditLogItemPayloadSettingChangeMethod.js} +2 -2
- package/dist/serialization/types/index.d.ts +3 -13
- package/dist/serialization/types/index.js +3 -13
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/dist/wrapper/AssetsUtilitiesClient.d.ts +1 -1
- package/dist/wrapper/FormsClient.js +5 -5
- package/dist/wrapper/ItemsClient.js +20 -20
- package/dist/wrapper/PagesClient.js +5 -5
- package/dist/wrapper/WebflowClient.js +1 -1
- package/jest.config.mjs +1 -1
- package/package.json +2 -1
- package/reference.md +68 -544
- package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +2 -2
- package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.js +2 -2
- package/{dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts → serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataOneItem.d.ts} +2 -2
- package/{dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.js → serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataOneItem.js} +2 -2
- package/serialization/resources/collections/resources/items/types/index.d.ts +1 -1
- package/serialization/resources/collections/resources/items/types/index.js +1 -1
- package/serialization/resources/index.d.ts +0 -5
- package/serialization/resources/index.js +1 -6
- package/serialization/resources/workspaces/resources/auditLogs/types/AuditLogsGetWorkspaceAuditLogsRequestEventType.d.ts +1 -1
- package/serialization/resources/workspaces/resources/auditLogs/types/AuditLogsGetWorkspaceAuditLogsRequestEventType.js +1 -0
- package/serialization/types/AssetVariant.d.ts +6 -6
- package/serialization/types/AssetVariant.js +6 -6
- package/serialization/types/ForbiddenErrorBody.d.ts +2 -2
- package/serialization/types/ForbiddenErrorBody.js +2 -2
- package/serialization/types/SettingChange.d.ts +13 -0
- package/{dist/serialization/types/AccessGroupList.js → serialization/types/SettingChange.js} +7 -8
- package/serialization/types/SettingChangeAuditLogItem.d.ts +11 -0
- package/serialization/types/{UserAccessGroupsItem.js → SettingChangeAuditLogItem.js} +5 -5
- package/serialization/types/TriggerType.d.ts +1 -1
- package/serialization/types/TriggerType.js +0 -3
- package/serialization/types/WorkspaceAuditLogItem.d.ts +5 -1
- package/serialization/types/WorkspaceAuditLogItem.js +2 -0
- package/serialization/types/WorkspaceAuditLogItemPayloadSettingChangeMethod.d.ts +7 -0
- package/{dist/serialization/types/UserLimitReached.js → serialization/types/WorkspaceAuditLogItemPayloadSettingChangeMethod.js} +2 -2
- package/serialization/types/index.d.ts +3 -13
- package/serialization/types/index.js +3 -13
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/wrapper/AssetsUtilitiesClient.d.ts +1 -1
- package/wrapper/FormsClient.js +5 -5
- package/wrapper/ItemsClient.js +20 -20
- package/wrapper/PagesClient.js +5 -5
- package/wrapper/WebflowClient.js +1 -1
- package/.mock/definition/__package__.yml +0 -4471
- package/.mock/definition/accessGroups.yml +0 -87
- package/.mock/definition/api.yml +0 -18
- package/.mock/definition/assets.yml +0 -487
- package/.mock/definition/collections/fields.yml +0 -212
- package/.mock/definition/collections/items.yml +0 -2145
- package/.mock/definition/collections.yml +0 -350
- package/.mock/definition/comments.yml +0 -41
- package/.mock/definition/components.yml +0 -548
- package/.mock/definition/ecommerce.yml +0 -45
- package/.mock/definition/forms.yml +0 -399
- package/.mock/definition/inventory.yml +0 -152
- package/.mock/definition/items.yml +0 -112
- package/.mock/definition/orders.yml +0 -1971
- package/.mock/definition/pages/scripts.yml +0 -155
- package/.mock/definition/pages.yml +0 -611
- package/.mock/definition/products.yml +0 -642
- package/.mock/definition/scripts.yml +0 -236
- package/.mock/definition/sites/activityLogs.yml +0 -77
- package/.mock/definition/sites/comments.yml +0 -352
- package/.mock/definition/sites/forms.yml +0 -316
- package/.mock/definition/sites/plans.yml +0 -48
- package/.mock/definition/sites/redirects.yml +0 -221
- package/.mock/definition/sites/robotsTxt.yml +0 -229
- package/.mock/definition/sites/scripts.yml +0 -243
- package/.mock/definition/sites/wellKnown.yml +0 -130
- package/.mock/definition/sites.yml +0 -558
- package/.mock/definition/token.yml +0 -75
- package/.mock/definition/users.yml +0 -594
- package/.mock/definition/webhooks.yml +0 -188
- package/.mock/definition/workspaces/auditLogs.yml +0 -125
- package/.mock/fern.config.json +0 -4
- package/api/resources/accessGroups/client/Client.d.ts +0 -39
- package/api/resources/accessGroups/client/Client.js +0 -197
- package/api/resources/accessGroups/client/index.d.ts +0 -1
- package/api/resources/accessGroups/client/index.js +0 -17
- package/api/resources/accessGroups/client/requests/AccessGroupsListRequest.d.ts +0 -20
- package/api/resources/accessGroups/client/requests/index.d.ts +0 -1
- package/api/resources/accessGroups/client/requests/index.js +0 -2
- package/api/resources/accessGroups/index.d.ts +0 -2
- package/api/resources/accessGroups/index.js +0 -18
- package/api/resources/accessGroups/types/AccessGroupsListRequestSort.d.ts +0 -9
- package/api/resources/accessGroups/types/AccessGroupsListRequestSort.js +0 -12
- package/api/resources/accessGroups/types/index.d.ts +0 -1
- package/api/resources/accessGroups/types/index.js +0 -17
- package/api/resources/users/client/Client.d.ts +0 -145
- package/api/resources/users/client/Client.js +0 -670
- package/api/resources/users/client/index.d.ts +0 -1
- package/api/resources/users/client/index.js +0 -17
- package/api/resources/users/client/requests/UsersInviteRequest.d.ts +0 -13
- package/api/resources/users/client/requests/UsersListRequest.d.ts +0 -23
- package/api/resources/users/client/requests/index.d.ts +0 -2
- package/api/resources/users/client/requests/index.js +0 -2
- package/api/resources/users/index.d.ts +0 -2
- package/api/resources/users/index.js +0 -18
- package/api/resources/users/types/UserAccountAddedPayload.d.ts +0 -5
- package/api/resources/users/types/UserAccountAddedPayloadPayload.d.ts +0 -20
- package/api/resources/users/types/UserAccountAddedPayloadPayloadData.d.ts +0 -9
- package/api/resources/users/types/UserAccountAddedPayloadPayloadData.js +0 -3
- package/api/resources/users/types/UserAccountDeletedPayload.d.ts +0 -5
- package/api/resources/users/types/UserAccountDeletedPayload.js +0 -3
- package/api/resources/users/types/UserAccountDeletedPayloadPayload.d.ts +0 -20
- package/api/resources/users/types/UserAccountDeletedPayloadPayload.js +0 -3
- package/api/resources/users/types/UserAccountDeletedPayloadPayloadData.d.ts +0 -9
- package/api/resources/users/types/UserAccountDeletedPayloadPayloadData.js +0 -3
- package/api/resources/users/types/UserAccountUpdatedPayload.d.ts +0 -5
- package/api/resources/users/types/UserAccountUpdatedPayload.js +0 -3
- package/api/resources/users/types/UserAccountUpdatedPayloadPayload.d.ts +0 -20
- package/api/resources/users/types/UserAccountUpdatedPayloadPayload.js +0 -3
- package/api/resources/users/types/UserAccountUpdatedPayloadPayloadData.d.ts +0 -9
- package/api/resources/users/types/UserAccountUpdatedPayloadPayloadData.js +0 -3
- package/api/resources/users/types/UsersListRequestSort.d.ts +0 -33
- package/api/resources/users/types/UsersListRequestSort.js +0 -36
- package/api/resources/users/types/index.d.ts +0 -10
- package/api/resources/users/types/index.js +0 -26
- package/api/types/AccessGroup.d.ts +0 -12
- package/api/types/AccessGroup.js +0 -3
- package/api/types/AccessGroupList.d.ts +0 -16
- package/api/types/AccessGroupList.js +0 -3
- package/api/types/ConflictErrorBody.d.ts +0 -2
- package/api/types/ConflictErrorBody.js +0 -3
- package/api/types/DuplicateUserEmail.d.ts +0 -1
- package/api/types/DuplicateUserEmail.js +0 -3
- package/api/types/User.d.ts +0 -22
- package/api/types/User.js +0 -3
- package/api/types/UserAccessGroupsItem.d.ts +0 -14
- package/api/types/UserAccessGroupsItem.js +0 -3
- package/api/types/UserAccessGroupsItemType.d.ts +0 -10
- package/api/types/UserAccessGroupsItemType.js +0 -13
- package/api/types/UserData.d.ts +0 -7
- package/api/types/UserData.js +0 -3
- package/api/types/UserDataData.d.ts +0 -12
- package/api/types/UserDataData.js +0 -3
- package/api/types/UserLimitReached.d.ts +0 -1
- package/api/types/UserLimitReached.js +0 -3
- package/api/types/UserList.d.ts +0 -16
- package/api/types/UserList.js +0 -3
- package/api/types/UserStatus.d.ts +0 -7
- package/api/types/UserStatus.js +0 -10
- package/api/types/UsersNotEnabled.d.ts +0 -1
- package/api/types/UsersNotEnabled.js +0 -3
- package/dist/api/resources/accessGroups/client/Client.d.ts +0 -39
- package/dist/api/resources/accessGroups/client/Client.js +0 -197
- package/dist/api/resources/accessGroups/client/index.d.ts +0 -1
- package/dist/api/resources/accessGroups/client/index.js +0 -17
- package/dist/api/resources/accessGroups/client/requests/AccessGroupsListRequest.d.ts +0 -20
- package/dist/api/resources/accessGroups/client/requests/AccessGroupsListRequest.js +0 -3
- package/dist/api/resources/accessGroups/client/requests/index.d.ts +0 -1
- package/dist/api/resources/accessGroups/client/requests/index.js +0 -2
- package/dist/api/resources/accessGroups/index.d.ts +0 -2
- package/dist/api/resources/accessGroups/index.js +0 -18
- package/dist/api/resources/accessGroups/types/AccessGroupsListRequestSort.d.ts +0 -9
- package/dist/api/resources/accessGroups/types/AccessGroupsListRequestSort.js +0 -12
- package/dist/api/resources/accessGroups/types/index.d.ts +0 -1
- package/dist/api/resources/accessGroups/types/index.js +0 -17
- package/dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.js +0 -3
- package/dist/api/resources/users/client/Client.d.ts +0 -145
- package/dist/api/resources/users/client/Client.js +0 -670
- package/dist/api/resources/users/client/index.d.ts +0 -1
- package/dist/api/resources/users/client/index.js +0 -17
- package/dist/api/resources/users/client/requests/UsersInviteRequest.d.ts +0 -13
- package/dist/api/resources/users/client/requests/UsersInviteRequest.js +0 -3
- package/dist/api/resources/users/client/requests/UsersListRequest.d.ts +0 -23
- package/dist/api/resources/users/client/requests/UsersListRequest.js +0 -3
- package/dist/api/resources/users/client/requests/index.d.ts +0 -2
- package/dist/api/resources/users/client/requests/index.js +0 -2
- package/dist/api/resources/users/index.d.ts +0 -2
- package/dist/api/resources/users/index.js +0 -18
- package/dist/api/resources/users/types/UserAccountAddedPayload.d.ts +0 -5
- package/dist/api/resources/users/types/UserAccountAddedPayload.js +0 -3
- package/dist/api/resources/users/types/UserAccountAddedPayloadPayload.d.ts +0 -20
- package/dist/api/resources/users/types/UserAccountAddedPayloadPayload.js +0 -3
- package/dist/api/resources/users/types/UserAccountAddedPayloadPayloadData.d.ts +0 -9
- package/dist/api/resources/users/types/UserAccountAddedPayloadPayloadData.js +0 -3
- package/dist/api/resources/users/types/UserAccountDeletedPayload.d.ts +0 -5
- package/dist/api/resources/users/types/UserAccountDeletedPayload.js +0 -3
- package/dist/api/resources/users/types/UserAccountDeletedPayloadPayload.d.ts +0 -20
- package/dist/api/resources/users/types/UserAccountDeletedPayloadPayload.js +0 -3
- package/dist/api/resources/users/types/UserAccountDeletedPayloadPayloadData.d.ts +0 -9
- package/dist/api/resources/users/types/UserAccountDeletedPayloadPayloadData.js +0 -3
- package/dist/api/resources/users/types/UserAccountUpdatedPayload.d.ts +0 -5
- package/dist/api/resources/users/types/UserAccountUpdatedPayload.js +0 -3
- package/dist/api/resources/users/types/UserAccountUpdatedPayloadPayload.d.ts +0 -20
- package/dist/api/resources/users/types/UserAccountUpdatedPayloadPayload.js +0 -3
- package/dist/api/resources/users/types/UserAccountUpdatedPayloadPayloadData.d.ts +0 -9
- package/dist/api/resources/users/types/UserAccountUpdatedPayloadPayloadData.js +0 -3
- package/dist/api/resources/users/types/UsersListRequestSort.d.ts +0 -33
- package/dist/api/resources/users/types/UsersListRequestSort.js +0 -36
- package/dist/api/resources/users/types/index.d.ts +0 -10
- package/dist/api/resources/users/types/index.js +0 -26
- package/dist/api/types/AccessGroup.d.ts +0 -12
- package/dist/api/types/AccessGroup.js +0 -3
- package/dist/api/types/AccessGroupList.d.ts +0 -16
- package/dist/api/types/AccessGroupList.js +0 -3
- package/dist/api/types/ConflictErrorBody.d.ts +0 -2
- package/dist/api/types/ConflictErrorBody.js +0 -3
- package/dist/api/types/DuplicateUserEmail.d.ts +0 -1
- package/dist/api/types/DuplicateUserEmail.js +0 -3
- package/dist/api/types/User.d.ts +0 -22
- package/dist/api/types/User.js +0 -3
- package/dist/api/types/UserAccessGroupsItem.d.ts +0 -14
- package/dist/api/types/UserAccessGroupsItem.js +0 -3
- package/dist/api/types/UserAccessGroupsItemType.d.ts +0 -10
- package/dist/api/types/UserAccessGroupsItemType.js +0 -13
- package/dist/api/types/UserData.d.ts +0 -7
- package/dist/api/types/UserData.js +0 -3
- package/dist/api/types/UserDataData.d.ts +0 -12
- package/dist/api/types/UserDataData.js +0 -3
- package/dist/api/types/UserLimitReached.d.ts +0 -1
- package/dist/api/types/UserLimitReached.js +0 -3
- package/dist/api/types/UserList.d.ts +0 -16
- package/dist/api/types/UserList.js +0 -3
- package/dist/api/types/UserStatus.d.ts +0 -7
- package/dist/api/types/UserStatus.js +0 -10
- package/dist/api/types/UsersNotEnabled.d.ts +0 -1
- package/dist/api/types/UsersNotEnabled.js +0 -3
- package/dist/serialization/resources/accessGroups/index.d.ts +0 -1
- package/dist/serialization/resources/accessGroups/index.js +0 -17
- package/dist/serialization/resources/accessGroups/types/AccessGroupsListRequestSort.d.ts +0 -7
- package/dist/serialization/resources/accessGroups/types/AccessGroupsListRequestSort.js +0 -39
- package/dist/serialization/resources/accessGroups/types/index.d.ts +0 -1
- package/dist/serialization/resources/accessGroups/types/index.js +0 -17
- package/dist/serialization/resources/users/client/index.d.ts +0 -1
- package/dist/serialization/resources/users/client/index.js +0 -17
- package/dist/serialization/resources/users/client/requests/UsersInviteRequest.d.ts +0 -10
- package/dist/serialization/resources/users/client/requests/UsersInviteRequest.js +0 -42
- package/dist/serialization/resources/users/client/requests/index.d.ts +0 -1
- package/dist/serialization/resources/users/client/requests/index.js +0 -5
- package/dist/serialization/resources/users/index.d.ts +0 -2
- package/dist/serialization/resources/users/index.js +0 -18
- package/dist/serialization/resources/users/types/UserAccountAddedPayload.d.ts +0 -11
- package/dist/serialization/resources/users/types/UserAccountAddedPayload.js +0 -43
- package/dist/serialization/resources/users/types/UserAccountAddedPayloadPayload.d.ts +0 -20
- package/dist/serialization/resources/users/types/UserAccountAddedPayloadPayload.js +0 -52
- package/dist/serialization/resources/users/types/UserAccountAddedPayloadPayloadData.d.ts +0 -12
- package/dist/serialization/resources/users/types/UserAccountAddedPayloadPayloadData.js +0 -44
- package/dist/serialization/resources/users/types/UserAccountDeletedPayload.d.ts +0 -11
- package/dist/serialization/resources/users/types/UserAccountDeletedPayload.js +0 -43
- package/dist/serialization/resources/users/types/UserAccountDeletedPayloadPayload.d.ts +0 -20
- package/dist/serialization/resources/users/types/UserAccountDeletedPayloadPayload.js +0 -52
- package/dist/serialization/resources/users/types/UserAccountDeletedPayloadPayloadData.d.ts +0 -12
- package/dist/serialization/resources/users/types/UserAccountDeletedPayloadPayloadData.js +0 -44
- package/dist/serialization/resources/users/types/UserAccountUpdatedPayload.d.ts +0 -11
- package/dist/serialization/resources/users/types/UserAccountUpdatedPayload.js +0 -43
- package/dist/serialization/resources/users/types/UserAccountUpdatedPayloadPayload.d.ts +0 -20
- package/dist/serialization/resources/users/types/UserAccountUpdatedPayloadPayload.js +0 -52
- package/dist/serialization/resources/users/types/UserAccountUpdatedPayloadPayloadData.d.ts +0 -12
- package/dist/serialization/resources/users/types/UserAccountUpdatedPayloadPayloadData.js +0 -44
- package/dist/serialization/resources/users/types/UsersListRequestSort.d.ts +0 -7
- package/dist/serialization/resources/users/types/UsersListRequestSort.js +0 -50
- package/dist/serialization/resources/users/types/index.d.ts +0 -10
- package/dist/serialization/resources/users/types/index.js +0 -26
- package/dist/serialization/types/AccessGroup.d.ts +0 -13
- package/dist/serialization/types/AccessGroupList.d.ts +0 -14
- package/dist/serialization/types/ConflictErrorBody.d.ts +0 -9
- package/dist/serialization/types/ConflictErrorBody.js +0 -41
- package/dist/serialization/types/DuplicateUserEmail.d.ts +0 -7
- package/dist/serialization/types/DuplicateUserEmail.js +0 -39
- package/dist/serialization/types/User.d.ts +0 -20
- package/dist/serialization/types/User.js +0 -52
- package/dist/serialization/types/UserAccessGroupsItem.d.ts +0 -11
- package/dist/serialization/types/UserAccessGroupsItemType.d.ts +0 -7
- package/dist/serialization/types/UserAccessGroupsItemType.js +0 -39
- package/dist/serialization/types/UserData.d.ts +0 -10
- package/dist/serialization/types/UserData.js +0 -42
- package/dist/serialization/types/UserDataData.d.ts +0 -13
- package/dist/serialization/types/UserDataData.js +0 -45
- package/dist/serialization/types/UserLimitReached.d.ts +0 -7
- package/dist/serialization/types/UserList.d.ts +0 -14
- package/dist/serialization/types/UserList.js +0 -46
- package/dist/serialization/types/UserStatus.d.ts +0 -7
- package/dist/serialization/types/UsersNotEnabled.d.ts +0 -7
- package/dist/serialization/types/UsersNotEnabled.js +0 -39
- package/serialization/resources/accessGroups/index.d.ts +0 -1
- package/serialization/resources/accessGroups/index.js +0 -17
- package/serialization/resources/accessGroups/types/AccessGroupsListRequestSort.d.ts +0 -7
- package/serialization/resources/accessGroups/types/AccessGroupsListRequestSort.js +0 -39
- package/serialization/resources/accessGroups/types/index.d.ts +0 -1
- package/serialization/resources/accessGroups/types/index.js +0 -17
- package/serialization/resources/users/client/index.d.ts +0 -1
- package/serialization/resources/users/client/index.js +0 -17
- package/serialization/resources/users/client/requests/UsersInviteRequest.d.ts +0 -10
- package/serialization/resources/users/client/requests/UsersInviteRequest.js +0 -42
- package/serialization/resources/users/client/requests/index.d.ts +0 -1
- package/serialization/resources/users/client/requests/index.js +0 -5
- package/serialization/resources/users/index.d.ts +0 -2
- package/serialization/resources/users/index.js +0 -18
- package/serialization/resources/users/types/UserAccountAddedPayload.d.ts +0 -11
- package/serialization/resources/users/types/UserAccountAddedPayload.js +0 -43
- package/serialization/resources/users/types/UserAccountAddedPayloadPayload.d.ts +0 -20
- package/serialization/resources/users/types/UserAccountAddedPayloadPayload.js +0 -52
- package/serialization/resources/users/types/UserAccountAddedPayloadPayloadData.d.ts +0 -12
- package/serialization/resources/users/types/UserAccountAddedPayloadPayloadData.js +0 -44
- package/serialization/resources/users/types/UserAccountDeletedPayload.d.ts +0 -11
- package/serialization/resources/users/types/UserAccountDeletedPayload.js +0 -43
- package/serialization/resources/users/types/UserAccountDeletedPayloadPayload.d.ts +0 -20
- package/serialization/resources/users/types/UserAccountDeletedPayloadPayload.js +0 -52
- package/serialization/resources/users/types/UserAccountDeletedPayloadPayloadData.d.ts +0 -12
- package/serialization/resources/users/types/UserAccountDeletedPayloadPayloadData.js +0 -44
- package/serialization/resources/users/types/UserAccountUpdatedPayload.d.ts +0 -11
- package/serialization/resources/users/types/UserAccountUpdatedPayload.js +0 -43
- package/serialization/resources/users/types/UserAccountUpdatedPayloadPayload.d.ts +0 -20
- package/serialization/resources/users/types/UserAccountUpdatedPayloadPayload.js +0 -52
- package/serialization/resources/users/types/UserAccountUpdatedPayloadPayloadData.d.ts +0 -12
- package/serialization/resources/users/types/UserAccountUpdatedPayloadPayloadData.js +0 -44
- package/serialization/resources/users/types/UsersListRequestSort.d.ts +0 -7
- package/serialization/resources/users/types/UsersListRequestSort.js +0 -50
- package/serialization/resources/users/types/index.d.ts +0 -10
- package/serialization/resources/users/types/index.js +0 -26
- package/serialization/types/AccessGroup.d.ts +0 -13
- package/serialization/types/AccessGroup.js +0 -45
- package/serialization/types/AccessGroupList.d.ts +0 -14
- package/serialization/types/AccessGroupList.js +0 -46
- package/serialization/types/ConflictErrorBody.d.ts +0 -9
- package/serialization/types/ConflictErrorBody.js +0 -41
- package/serialization/types/DuplicateUserEmail.d.ts +0 -7
- package/serialization/types/DuplicateUserEmail.js +0 -39
- package/serialization/types/User.d.ts +0 -20
- package/serialization/types/User.js +0 -52
- package/serialization/types/UserAccessGroupsItem.d.ts +0 -11
- package/serialization/types/UserAccessGroupsItemType.d.ts +0 -7
- package/serialization/types/UserAccessGroupsItemType.js +0 -39
- package/serialization/types/UserData.d.ts +0 -10
- package/serialization/types/UserData.js +0 -42
- package/serialization/types/UserDataData.d.ts +0 -13
- package/serialization/types/UserDataData.js +0 -45
- package/serialization/types/UserLimitReached.d.ts +0 -7
- package/serialization/types/UserLimitReached.js +0 -39
- package/serialization/types/UserList.d.ts +0 -14
- package/serialization/types/UserList.js +0 -46
- package/serialization/types/UserStatus.d.ts +0 -7
- package/serialization/types/UserStatus.js +0 -39
- package/serialization/types/UsersNotEnabled.d.ts +0 -7
- package/serialization/types/UsersNotEnabled.js +0 -39
- /package/api/resources/{accessGroups/client/requests/AccessGroupsListRequest.js → collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataOneItem.js} +0 -0
- /package/api/{resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.js → types/SettingChange.js} +0 -0
- /package/api/{resources/users/client/requests/UsersInviteRequest.js → types/SettingChangeAuditLogItem.js} +0 -0
- /package/{api/resources/users/client/requests/UsersListRequest.js → dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataOneItem.js} +0 -0
- /package/{api/resources/users/types/UserAccountAddedPayload.js → dist/api/types/SettingChange.js} +0 -0
- /package/{api/resources/users/types/UserAccountAddedPayloadPayload.js → dist/api/types/SettingChangeAuditLogItem.js} +0 -0
|
@@ -1,4471 +0,0 @@
|
|
|
1
|
-
errors:
|
|
2
|
-
UnauthorizedError:
|
|
3
|
-
status-code: 401
|
|
4
|
-
type: Error
|
|
5
|
-
docs: >-
|
|
6
|
-
Provided access token is invalid or does not have access to requested
|
|
7
|
-
resource
|
|
8
|
-
examples:
|
|
9
|
-
- value:
|
|
10
|
-
code: not_authorized
|
|
11
|
-
message: Request not authorized
|
|
12
|
-
ForbiddenError:
|
|
13
|
-
status-code: 403
|
|
14
|
-
type: unknown
|
|
15
|
-
docs: Provided access token is valid, but is missing the required scopes.
|
|
16
|
-
examples:
|
|
17
|
-
- value:
|
|
18
|
-
code: missing_scopes
|
|
19
|
-
message: >-
|
|
20
|
-
OAuthForbidden: You are missing the following scopes -
|
|
21
|
-
components:write
|
|
22
|
-
- value:
|
|
23
|
-
key: value
|
|
24
|
-
- value:
|
|
25
|
-
code: forbidden
|
|
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'
|
|
35
|
-
- value:
|
|
36
|
-
key: value
|
|
37
|
-
- value:
|
|
38
|
-
code: validation_error
|
|
39
|
-
message: 'Validation Error: Provided ID is invalid'
|
|
40
|
-
NotFoundError:
|
|
41
|
-
status-code: 404
|
|
42
|
-
type: Error
|
|
43
|
-
docs: Requested resource not found
|
|
44
|
-
examples:
|
|
45
|
-
- value:
|
|
46
|
-
code: resource_not_found
|
|
47
|
-
message: 'Requested resource not found: The site cannot be found'
|
|
48
|
-
TooManyRequestsError:
|
|
49
|
-
status-code: 429
|
|
50
|
-
type: Error
|
|
51
|
-
docs: >-
|
|
52
|
-
The rate limit of the provided access_token has been reached. Please have
|
|
53
|
-
your application respect the X-RateLimit-Remaining header we include on
|
|
54
|
-
API responses.
|
|
55
|
-
examples:
|
|
56
|
-
- value:
|
|
57
|
-
code: too_many_requests
|
|
58
|
-
message: Too many requests
|
|
59
|
-
InternalServerError:
|
|
60
|
-
status-code: 500
|
|
61
|
-
type: Error
|
|
62
|
-
docs: We had a problem with our server. Try again later.
|
|
63
|
-
examples:
|
|
64
|
-
- value:
|
|
65
|
-
code: internal_error
|
|
66
|
-
message: An Internal Error occurred
|
|
67
|
-
ConflictError:
|
|
68
|
-
status-code: 409
|
|
69
|
-
type: unknown
|
|
70
|
-
docs: Collection already exists
|
|
71
|
-
examples:
|
|
72
|
-
- value:
|
|
73
|
-
code: duplicate_collection
|
|
74
|
-
message: Collection already exists
|
|
75
|
-
- value:
|
|
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.
|
|
85
|
-
- value:
|
|
86
|
-
code: forms_require_republish
|
|
87
|
-
message: To access this feature, the site needs to be republished.
|
|
88
|
-
- value:
|
|
89
|
-
key: value
|
|
90
|
-
- value:
|
|
91
|
-
code: ecommerce_not_enabled
|
|
92
|
-
message: Ecommerce is not yet initialized
|
|
93
|
-
types:
|
|
94
|
-
ForbiddenErrorBody:
|
|
95
|
-
discriminated: false
|
|
96
|
-
union:
|
|
97
|
-
- InvalidScopes
|
|
98
|
-
- UsersNotEnabled
|
|
99
|
-
source:
|
|
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
|
|
108
|
-
ItemsListItemsRequestLastPublished:
|
|
109
|
-
properties:
|
|
110
|
-
lte:
|
|
111
|
-
type: optional<datetime>
|
|
112
|
-
docs: Filter items last published before this date
|
|
113
|
-
gte:
|
|
114
|
-
type: optional<datetime>
|
|
115
|
-
docs: Filter items last published after this date
|
|
116
|
-
source:
|
|
117
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
118
|
-
ItemsListItemsLiveRequestLastPublished:
|
|
119
|
-
properties:
|
|
120
|
-
lte:
|
|
121
|
-
type: optional<datetime>
|
|
122
|
-
docs: Filter items last published before this date
|
|
123
|
-
gte:
|
|
124
|
-
type: optional<datetime>
|
|
125
|
-
docs: Filter items last published after this date
|
|
126
|
-
source:
|
|
127
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
128
|
-
ConflictErrorBody:
|
|
129
|
-
discriminated: false
|
|
130
|
-
union:
|
|
131
|
-
- DuplicateUserEmail
|
|
132
|
-
- UserLimitReached
|
|
133
|
-
source:
|
|
134
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
135
|
-
AuthorizedUser:
|
|
136
|
-
properties:
|
|
137
|
-
id:
|
|
138
|
-
type: optional<string>
|
|
139
|
-
docs: The unique ID of the user
|
|
140
|
-
email:
|
|
141
|
-
type: optional<string>
|
|
142
|
-
docs: The user's email address
|
|
143
|
-
validation:
|
|
144
|
-
format: email
|
|
145
|
-
firstName:
|
|
146
|
-
type: optional<string>
|
|
147
|
-
docs: The user's first name
|
|
148
|
-
lastName:
|
|
149
|
-
type: optional<string>
|
|
150
|
-
docs: The user's last name
|
|
151
|
-
source:
|
|
152
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
153
|
-
ErrorCode:
|
|
154
|
-
enum:
|
|
155
|
-
- bad_request
|
|
156
|
-
- collection_not_found
|
|
157
|
-
- conflict
|
|
158
|
-
- duplicate_collection
|
|
159
|
-
- duplicate_user_email
|
|
160
|
-
- ecommerce_not_enabled
|
|
161
|
-
- forbidden
|
|
162
|
-
- forms_require_republish
|
|
163
|
-
- incompatible_webhook_filter
|
|
164
|
-
- internal_error
|
|
165
|
-
- invalid_auth_version
|
|
166
|
-
- invalid_credentials
|
|
167
|
-
- invalid_domain
|
|
168
|
-
- invalid_user_email
|
|
169
|
-
- item_not_found
|
|
170
|
-
- missing_scopes
|
|
171
|
-
- no_domains
|
|
172
|
-
- not_authorized
|
|
173
|
-
- not_enterprise_plan_site
|
|
174
|
-
- not_enterprise_plan_workspace
|
|
175
|
-
- order_not_found
|
|
176
|
-
- resource_not_found
|
|
177
|
-
- too_many_requests
|
|
178
|
-
- unsupported_version
|
|
179
|
-
- unsupported_webhook_trigger_type
|
|
180
|
-
- user_limit_reached
|
|
181
|
-
- user_not_found
|
|
182
|
-
- users_not_enabled
|
|
183
|
-
- validation_error
|
|
184
|
-
docs: Error code
|
|
185
|
-
inline: true
|
|
186
|
-
source:
|
|
187
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
188
|
-
Error:
|
|
189
|
-
properties:
|
|
190
|
-
code:
|
|
191
|
-
type: optional<ErrorCode>
|
|
192
|
-
docs: Error code
|
|
193
|
-
message:
|
|
194
|
-
type: optional<string>
|
|
195
|
-
docs: Error message
|
|
196
|
-
externalReference:
|
|
197
|
-
type: optional<string>
|
|
198
|
-
docs: Link to more information
|
|
199
|
-
details:
|
|
200
|
-
type: optional<list<unknown>>
|
|
201
|
-
docs: Array of errors
|
|
202
|
-
source:
|
|
203
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
204
|
-
Application:
|
|
205
|
-
properties:
|
|
206
|
-
id:
|
|
207
|
-
type: optional<string>
|
|
208
|
-
docs: Unique identifier for the Application
|
|
209
|
-
description:
|
|
210
|
-
type: optional<string>
|
|
211
|
-
docs: Application description provided by the developer
|
|
212
|
-
homepage:
|
|
213
|
-
type: optional<string>
|
|
214
|
-
docs: Application homepage URL provided by the developer
|
|
215
|
-
validation:
|
|
216
|
-
format: uri
|
|
217
|
-
displayName:
|
|
218
|
-
type: optional<string>
|
|
219
|
-
docs: Application name provided by the developer
|
|
220
|
-
source:
|
|
221
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
222
|
-
AuthorizationAuthorizationAuthorizedTo:
|
|
223
|
-
properties:
|
|
224
|
-
siteIds:
|
|
225
|
-
type: optional<list<unknown>>
|
|
226
|
-
docs: Array of Sites this app is authorized to
|
|
227
|
-
workspaceIds:
|
|
228
|
-
type: optional<list<unknown>>
|
|
229
|
-
docs: Array of Workspaces this app is authorized to
|
|
230
|
-
userIds:
|
|
231
|
-
type: optional<list<unknown>>
|
|
232
|
-
docs: Array of Users this app is authorized to
|
|
233
|
-
source:
|
|
234
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
235
|
-
inline: true
|
|
236
|
-
AuthorizationAuthorization:
|
|
237
|
-
docs: The Authorization object
|
|
238
|
-
properties:
|
|
239
|
-
id:
|
|
240
|
-
type: optional<string>
|
|
241
|
-
docs: The unique ID of the Authorization instance
|
|
242
|
-
createdOn:
|
|
243
|
-
type: optional<datetime>
|
|
244
|
-
docs: The date the Authorization was created
|
|
245
|
-
lastUsed:
|
|
246
|
-
type: optional<datetime>
|
|
247
|
-
docs: The date the Authorization was last used
|
|
248
|
-
grantType:
|
|
249
|
-
type: optional<string>
|
|
250
|
-
docs: The grant type of the Authorization
|
|
251
|
-
rateLimit:
|
|
252
|
-
type: optional<integer>
|
|
253
|
-
docs: The default rate limit for the Authorization (requests/min)
|
|
254
|
-
scope:
|
|
255
|
-
type: optional<string>
|
|
256
|
-
docs: Comma separted list of OAuth scopes corresponding to the Authorization
|
|
257
|
-
authorizedTo: optional<AuthorizationAuthorizationAuthorizedTo>
|
|
258
|
-
source:
|
|
259
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
260
|
-
inline: true
|
|
261
|
-
Authorization:
|
|
262
|
-
properties:
|
|
263
|
-
authorization:
|
|
264
|
-
type: optional<AuthorizationAuthorization>
|
|
265
|
-
docs: The Authorization object
|
|
266
|
-
application: optional<Application>
|
|
267
|
-
source:
|
|
268
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
269
|
-
Domain:
|
|
270
|
-
properties:
|
|
271
|
-
id:
|
|
272
|
-
type: string
|
|
273
|
-
docs: Unique identifier for the Domain
|
|
274
|
-
url:
|
|
275
|
-
type: optional<string>
|
|
276
|
-
docs: The registered Domain name
|
|
277
|
-
lastPublished:
|
|
278
|
-
type: optional<datetime>
|
|
279
|
-
docs: The date the custom domain was last published to
|
|
280
|
-
access: read-only
|
|
281
|
-
source:
|
|
282
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
283
|
-
Locale:
|
|
284
|
-
properties:
|
|
285
|
-
id:
|
|
286
|
-
type: optional<string>
|
|
287
|
-
docs: The unique identifier for the locale.
|
|
288
|
-
cmsLocaleId:
|
|
289
|
-
type: optional<string>
|
|
290
|
-
docs: A CMS-specific identifier for the locale.
|
|
291
|
-
enabled:
|
|
292
|
-
type: optional<boolean>
|
|
293
|
-
docs: Indicates if the locale is enabled.
|
|
294
|
-
displayName:
|
|
295
|
-
type: optional<string>
|
|
296
|
-
docs: The display name of the locale, typically in English.
|
|
297
|
-
displayImageId:
|
|
298
|
-
type: optional<string>
|
|
299
|
-
docs: An optional ID for an image associated with the locale, nullable.
|
|
300
|
-
redirect:
|
|
301
|
-
type: optional<boolean>
|
|
302
|
-
docs: Determines if requests should redirect to the locale's subdirectory.
|
|
303
|
-
subdirectory:
|
|
304
|
-
type: optional<string>
|
|
305
|
-
docs: The subdirectory path for the locale, used in URLs.
|
|
306
|
-
tag:
|
|
307
|
-
type: optional<string>
|
|
308
|
-
docs: >-
|
|
309
|
-
A tag or code representing the locale, often following a standard
|
|
310
|
-
format like 'en-US'.
|
|
311
|
-
source:
|
|
312
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
313
|
-
Locales:
|
|
314
|
-
properties:
|
|
315
|
-
primary:
|
|
316
|
-
type: optional<Locale>
|
|
317
|
-
docs: The primary locale for the site or application.
|
|
318
|
-
secondary:
|
|
319
|
-
type: optional<list<Locale>>
|
|
320
|
-
docs: A list of secondary locales available for the site or application.
|
|
321
|
-
source:
|
|
322
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
323
|
-
SiteDataCollectionType:
|
|
324
|
-
enum:
|
|
325
|
-
- always
|
|
326
|
-
- optOut
|
|
327
|
-
- disabled
|
|
328
|
-
docs: The type of data collection enabled for the site.
|
|
329
|
-
inline: true
|
|
330
|
-
source:
|
|
331
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
332
|
-
Site:
|
|
333
|
-
properties:
|
|
334
|
-
id:
|
|
335
|
-
type: string
|
|
336
|
-
docs: Unique identifier for the Site
|
|
337
|
-
workspaceId:
|
|
338
|
-
type: optional<string>
|
|
339
|
-
docs: Unique identifier for the Workspace
|
|
340
|
-
createdOn:
|
|
341
|
-
type: optional<datetime>
|
|
342
|
-
docs: Date the Site was created
|
|
343
|
-
displayName:
|
|
344
|
-
type: optional<string>
|
|
345
|
-
docs: Name given to Site
|
|
346
|
-
shortName:
|
|
347
|
-
type: optional<string>
|
|
348
|
-
docs: Slugified version of name
|
|
349
|
-
lastPublished:
|
|
350
|
-
type: optional<datetime>
|
|
351
|
-
docs: Date the Site was last published
|
|
352
|
-
lastUpdated:
|
|
353
|
-
type: optional<datetime>
|
|
354
|
-
docs: Date the Site was last updated
|
|
355
|
-
previewUrl:
|
|
356
|
-
type: optional<string>
|
|
357
|
-
docs: URL of a generated image for the given Site
|
|
358
|
-
validation:
|
|
359
|
-
format: uri
|
|
360
|
-
timeZone:
|
|
361
|
-
type: optional<string>
|
|
362
|
-
docs: Site timezone set under Site Settings
|
|
363
|
-
parentFolderId:
|
|
364
|
-
type: optional<string>
|
|
365
|
-
docs: The ID of the parent folder the Site exists in
|
|
366
|
-
customDomains: optional<list<Domain>>
|
|
367
|
-
locales: optional<Locales>
|
|
368
|
-
dataCollectionEnabled:
|
|
369
|
-
type: optional<boolean>
|
|
370
|
-
docs: Indicates if data collection is enabled for the site.
|
|
371
|
-
dataCollectionType:
|
|
372
|
-
type: optional<SiteDataCollectionType>
|
|
373
|
-
docs: The type of data collection enabled for the site.
|
|
374
|
-
source:
|
|
375
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
376
|
-
InvalidScopes: unknown
|
|
377
|
-
NotEnterprisePlanWorkspace: unknown
|
|
378
|
-
WorkspaceAuditLogItemPayloadUserAccessMethod:
|
|
379
|
-
enum:
|
|
380
|
-
- dashboard
|
|
381
|
-
- sso
|
|
382
|
-
- api
|
|
383
|
-
- google
|
|
384
|
-
inline: true
|
|
385
|
-
source:
|
|
386
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
387
|
-
User access:
|
|
388
|
-
properties:
|
|
389
|
-
method: optional<WorkspaceAuditLogItemPayloadUserAccessMethod>
|
|
390
|
-
location:
|
|
391
|
-
type: optional<string>
|
|
392
|
-
docs: The geolocation based on the logged IP address
|
|
393
|
-
ipAddress:
|
|
394
|
-
type: optional<string>
|
|
395
|
-
docs: The captured IP address of the user
|
|
396
|
-
source:
|
|
397
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
398
|
-
UserAccessAuditLogItemEventSubType:
|
|
399
|
-
enum:
|
|
400
|
-
- login
|
|
401
|
-
- logout
|
|
402
|
-
inline: true
|
|
403
|
-
source:
|
|
404
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
405
|
-
UserAccessAuditLogItem:
|
|
406
|
-
properties:
|
|
407
|
-
eventSubType: optional<UserAccessAuditLogItemEventSubType>
|
|
408
|
-
payload: optional<User access>
|
|
409
|
-
source:
|
|
410
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
411
|
-
Custom role:
|
|
412
|
-
properties:
|
|
413
|
-
roleName:
|
|
414
|
-
type: optional<string>
|
|
415
|
-
docs: The name of the custom role
|
|
416
|
-
previousRoleName:
|
|
417
|
-
type: optional<string>
|
|
418
|
-
docs: The previous name of the custom role
|
|
419
|
-
source:
|
|
420
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
421
|
-
CustomRoleAuditLogItemEventSubType:
|
|
422
|
-
enum:
|
|
423
|
-
- role_created
|
|
424
|
-
- role_updated
|
|
425
|
-
- role_deleted
|
|
426
|
-
inline: true
|
|
427
|
-
source:
|
|
428
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
429
|
-
CustomRoleAuditLogItem:
|
|
430
|
-
properties:
|
|
431
|
-
eventSubType: optional<CustomRoleAuditLogItemEventSubType>
|
|
432
|
-
payload: optional<Custom role>
|
|
433
|
-
source:
|
|
434
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
435
|
-
WorkspaceAuditLogItemPayloadWorkspaceMembershipTargetUser:
|
|
436
|
-
properties:
|
|
437
|
-
id: optional<string>
|
|
438
|
-
email: optional<string>
|
|
439
|
-
source:
|
|
440
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
441
|
-
inline: true
|
|
442
|
-
WorkspaceAuditLogItemPayloadWorkspaceMembershipMethod:
|
|
443
|
-
enum:
|
|
444
|
-
- sso
|
|
445
|
-
- dashboard
|
|
446
|
-
- admin
|
|
447
|
-
- access_request
|
|
448
|
-
inline: true
|
|
449
|
-
source:
|
|
450
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
451
|
-
WorkspaceAuditLogItemPayloadWorkspaceMembershipUserType:
|
|
452
|
-
enum:
|
|
453
|
-
- member
|
|
454
|
-
- guest
|
|
455
|
-
- reviewer
|
|
456
|
-
- client
|
|
457
|
-
inline: true
|
|
458
|
-
source:
|
|
459
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
460
|
-
Workspace membership:
|
|
461
|
-
properties:
|
|
462
|
-
targetUser: optional<WorkspaceAuditLogItemPayloadWorkspaceMembershipTargetUser>
|
|
463
|
-
method: optional<WorkspaceAuditLogItemPayloadWorkspaceMembershipMethod>
|
|
464
|
-
userType: optional<WorkspaceAuditLogItemPayloadWorkspaceMembershipUserType>
|
|
465
|
-
roleName:
|
|
466
|
-
type: optional<string>
|
|
467
|
-
docs: The name of the role that was assigned to the user
|
|
468
|
-
previousRoleName:
|
|
469
|
-
type: optional<string>
|
|
470
|
-
docs: The previous role that the user had
|
|
471
|
-
source:
|
|
472
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
473
|
-
WorkspaceMembershipAuditLogItemEventSubType:
|
|
474
|
-
enum:
|
|
475
|
-
- user_added
|
|
476
|
-
- user_removed
|
|
477
|
-
- user_role_updated
|
|
478
|
-
inline: true
|
|
479
|
-
source:
|
|
480
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
481
|
-
WorkspaceMembershipAuditLogItem:
|
|
482
|
-
properties:
|
|
483
|
-
eventSubType: optional<WorkspaceMembershipAuditLogItemEventSubType>
|
|
484
|
-
payload: optional<Workspace membership>
|
|
485
|
-
source:
|
|
486
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
487
|
-
WorkspaceAuditLogItemPayloadSiteMembershipSite:
|
|
488
|
-
properties:
|
|
489
|
-
id: optional<string>
|
|
490
|
-
slug: optional<string>
|
|
491
|
-
source:
|
|
492
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
493
|
-
inline: true
|
|
494
|
-
WorkspaceAuditLogItemPayloadSiteMembershipTargetUser:
|
|
495
|
-
properties:
|
|
496
|
-
id: optional<string>
|
|
497
|
-
email: optional<string>
|
|
498
|
-
source:
|
|
499
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
500
|
-
inline: true
|
|
501
|
-
WorkspaceAuditLogItemPayloadSiteMembershipMethod:
|
|
502
|
-
enum:
|
|
503
|
-
- sso
|
|
504
|
-
- invite
|
|
505
|
-
- scim
|
|
506
|
-
- dashboard
|
|
507
|
-
- admin
|
|
508
|
-
- access_request
|
|
509
|
-
inline: true
|
|
510
|
-
source:
|
|
511
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
512
|
-
WorkspaceAuditLogItemPayloadSiteMembershipUserType:
|
|
513
|
-
enum:
|
|
514
|
-
- member
|
|
515
|
-
- guest
|
|
516
|
-
- reviewer
|
|
517
|
-
- client
|
|
518
|
-
inline: true
|
|
519
|
-
source:
|
|
520
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
521
|
-
WorkspaceAuditLogItemPayloadSiteMembershipGranularAccess:
|
|
522
|
-
properties:
|
|
523
|
-
id: optional<string>
|
|
524
|
-
name: optional<string>
|
|
525
|
-
type: optional<literal<"cms">>
|
|
526
|
-
restricted: optional<boolean>
|
|
527
|
-
source:
|
|
528
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
529
|
-
inline: true
|
|
530
|
-
Site membership:
|
|
531
|
-
properties:
|
|
532
|
-
site: optional<WorkspaceAuditLogItemPayloadSiteMembershipSite>
|
|
533
|
-
targetUser: optional<WorkspaceAuditLogItemPayloadSiteMembershipTargetUser>
|
|
534
|
-
method: optional<WorkspaceAuditLogItemPayloadSiteMembershipMethod>
|
|
535
|
-
userType: optional<WorkspaceAuditLogItemPayloadSiteMembershipUserType>
|
|
536
|
-
roleName:
|
|
537
|
-
type: optional<string>
|
|
538
|
-
docs: The name of the role that was assigned to the user
|
|
539
|
-
previousRoleName:
|
|
540
|
-
type: optional<string>
|
|
541
|
-
docs: The previous role that the user had
|
|
542
|
-
granularAccess: optional<WorkspaceAuditLogItemPayloadSiteMembershipGranularAccess>
|
|
543
|
-
source:
|
|
544
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
545
|
-
SiteMembershipAuditLogItemEventSubType:
|
|
546
|
-
enum:
|
|
547
|
-
- user_added
|
|
548
|
-
- user_removed
|
|
549
|
-
- user_role_updated
|
|
550
|
-
- user_granular_access_updated
|
|
551
|
-
inline: true
|
|
552
|
-
source:
|
|
553
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
554
|
-
SiteMembershipAuditLogItem:
|
|
555
|
-
properties:
|
|
556
|
-
eventSubType: optional<SiteMembershipAuditLogItemEventSubType>
|
|
557
|
-
payload: optional<Site membership>
|
|
558
|
-
source:
|
|
559
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
560
|
-
WorkspaceAuditLogItemPayloadWorkspaceInvitationTargetUser:
|
|
561
|
-
properties:
|
|
562
|
-
id: optional<string>
|
|
563
|
-
email: optional<string>
|
|
564
|
-
source:
|
|
565
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
566
|
-
inline: true
|
|
567
|
-
WorkspaceAuditLogItemPayloadWorkspaceInvitationMethod:
|
|
568
|
-
enum:
|
|
569
|
-
- sso
|
|
570
|
-
- dashboard
|
|
571
|
-
- admin
|
|
572
|
-
inline: true
|
|
573
|
-
source:
|
|
574
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
575
|
-
WorkspaceAuditLogItemPayloadWorkspaceInvitationUserType:
|
|
576
|
-
enum:
|
|
577
|
-
- member
|
|
578
|
-
- guest
|
|
579
|
-
- reviewer
|
|
580
|
-
- client
|
|
581
|
-
inline: true
|
|
582
|
-
source:
|
|
583
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
584
|
-
WorkspaceAuditLogItemPayloadWorkspaceInvitationTargetUsersItem:
|
|
585
|
-
properties:
|
|
586
|
-
id: optional<string>
|
|
587
|
-
email: optional<string>
|
|
588
|
-
source:
|
|
589
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
590
|
-
inline: true
|
|
591
|
-
Workspace invitation:
|
|
592
|
-
properties:
|
|
593
|
-
targetUser: optional<WorkspaceAuditLogItemPayloadWorkspaceInvitationTargetUser>
|
|
594
|
-
method: optional<WorkspaceAuditLogItemPayloadWorkspaceInvitationMethod>
|
|
595
|
-
userType: optional<WorkspaceAuditLogItemPayloadWorkspaceInvitationUserType>
|
|
596
|
-
roleName:
|
|
597
|
-
type: optional<string>
|
|
598
|
-
docs: The name of the role that was assigned to the user
|
|
599
|
-
previousRoleName:
|
|
600
|
-
type: optional<string>
|
|
601
|
-
docs: The previous role that the user had
|
|
602
|
-
targetUsers: >-
|
|
603
|
-
optional<list<WorkspaceAuditLogItemPayloadWorkspaceInvitationTargetUsersItem>>
|
|
604
|
-
source:
|
|
605
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
606
|
-
WorkspaceInvitationAuditLogItemEventSubType:
|
|
607
|
-
enum:
|
|
608
|
-
- invite_sent
|
|
609
|
-
- invite_accepted
|
|
610
|
-
- invite_updated
|
|
611
|
-
- invite_canceled
|
|
612
|
-
- invite_declined
|
|
613
|
-
- access_request_accepted
|
|
614
|
-
inline: true
|
|
615
|
-
source:
|
|
616
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
617
|
-
WorkspaceInvitationAuditLogItem:
|
|
618
|
-
properties:
|
|
619
|
-
eventSubType: optional<WorkspaceInvitationAuditLogItemEventSubType>
|
|
620
|
-
payload: optional<Workspace invitation>
|
|
621
|
-
source:
|
|
622
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
623
|
-
WorkspaceAuditLogItemActor:
|
|
624
|
-
properties:
|
|
625
|
-
id: optional<string>
|
|
626
|
-
email: optional<string>
|
|
627
|
-
source:
|
|
628
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
629
|
-
inline: true
|
|
630
|
-
WorkspaceAuditLogItemWorkspace:
|
|
631
|
-
properties:
|
|
632
|
-
id: optional<string>
|
|
633
|
-
slug: optional<string>
|
|
634
|
-
source:
|
|
635
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
636
|
-
inline: true
|
|
637
|
-
WorkspaceAuditLogItem:
|
|
638
|
-
discriminant: eventType
|
|
639
|
-
base-properties:
|
|
640
|
-
timestamp: optional<datetime>
|
|
641
|
-
actor: optional<WorkspaceAuditLogItemActor>
|
|
642
|
-
workspace: optional<WorkspaceAuditLogItemWorkspace>
|
|
643
|
-
union:
|
|
644
|
-
user_access:
|
|
645
|
-
type: UserAccessAuditLogItem
|
|
646
|
-
custom_role:
|
|
647
|
-
type: CustomRoleAuditLogItem
|
|
648
|
-
workspace_membership:
|
|
649
|
-
type: WorkspaceMembershipAuditLogItem
|
|
650
|
-
site_membership:
|
|
651
|
-
type: SiteMembershipAuditLogItem
|
|
652
|
-
workspace_invitation:
|
|
653
|
-
type: WorkspaceInvitationAuditLogItem
|
|
654
|
-
source:
|
|
655
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
656
|
-
Pagination:
|
|
657
|
-
docs: Pagination object
|
|
658
|
-
properties:
|
|
659
|
-
limit:
|
|
660
|
-
type: optional<double>
|
|
661
|
-
docs: The limit used for pagination
|
|
662
|
-
access: read-only
|
|
663
|
-
offset:
|
|
664
|
-
type: optional<double>
|
|
665
|
-
docs: The offset used for pagination
|
|
666
|
-
access: read-only
|
|
667
|
-
total:
|
|
668
|
-
type: optional<double>
|
|
669
|
-
docs: The total number of records
|
|
670
|
-
access: read-only
|
|
671
|
-
source:
|
|
672
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
673
|
-
WorkspaceAuditLogResponse:
|
|
674
|
-
properties:
|
|
675
|
-
items: optional<list<WorkspaceAuditLogItem>>
|
|
676
|
-
pagination: optional<Pagination>
|
|
677
|
-
source:
|
|
678
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
679
|
-
Sites:
|
|
680
|
-
properties:
|
|
681
|
-
sites: optional<list<Site>>
|
|
682
|
-
source:
|
|
683
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
684
|
-
NotEnterprisePlanSite: unknown
|
|
685
|
-
Domains:
|
|
686
|
-
properties:
|
|
687
|
-
customDomains: optional<list<Domain>>
|
|
688
|
-
source:
|
|
689
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
690
|
-
InvalidDomain: unknown
|
|
691
|
-
NoDomains: unknown
|
|
692
|
-
Redirect:
|
|
693
|
-
docs: A single redirection rule, specifying a source URL and a destination URL.
|
|
694
|
-
properties:
|
|
695
|
-
id:
|
|
696
|
-
type: optional<string>
|
|
697
|
-
docs: The ID of the specific redirect rule
|
|
698
|
-
access: read-only
|
|
699
|
-
fromUrl:
|
|
700
|
-
type: optional<string>
|
|
701
|
-
docs: The source URL path that will be redirected.
|
|
702
|
-
toUrl:
|
|
703
|
-
type: optional<string>
|
|
704
|
-
docs: The target URL path where the user or client will be redirected.
|
|
705
|
-
source:
|
|
706
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
707
|
-
Redirects:
|
|
708
|
-
docs: Site redirects response
|
|
709
|
-
properties:
|
|
710
|
-
redirects:
|
|
711
|
-
type: optional<list<Redirect>>
|
|
712
|
-
docs: List of redirects for a given site
|
|
713
|
-
pagination: optional<Pagination>
|
|
714
|
-
source:
|
|
715
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
716
|
-
SitePlanId:
|
|
717
|
-
enum:
|
|
718
|
-
- value: hosting-basic-v3
|
|
719
|
-
name: HostingBasicV3
|
|
720
|
-
- value: hosting-cms-v3
|
|
721
|
-
name: HostingCmsV3
|
|
722
|
-
- value: hosting-business-v3
|
|
723
|
-
name: HostingBusinessV3
|
|
724
|
-
- value: hosting-ecommerce-standard-v2
|
|
725
|
-
name: HostingEcommerceStandardV2
|
|
726
|
-
- value: hosting-ecommerce-plus-v2
|
|
727
|
-
name: HostingEcommercePlusV2
|
|
728
|
-
- value: hosting-ecommerce-advanced-v2
|
|
729
|
-
name: HostingEcommerceAdvancedV2
|
|
730
|
-
- value: hosting-basic-v4
|
|
731
|
-
name: HostingBasicV4
|
|
732
|
-
- value: hosting-cms-v4
|
|
733
|
-
name: HostingCmsV4
|
|
734
|
-
- value: hosting-business-v4
|
|
735
|
-
name: HostingBusinessV4
|
|
736
|
-
- value: hosting-ecommerce-standard-v3
|
|
737
|
-
name: HostingEcommerceStandardV3
|
|
738
|
-
- value: hosting-ecommerce-plus-v3
|
|
739
|
-
name: HostingEcommercePlusV3
|
|
740
|
-
- value: hosting-ecommerce-advanced-v3
|
|
741
|
-
name: HostingEcommerceAdvancedV3
|
|
742
|
-
docs: ID of the hosting plan.
|
|
743
|
-
inline: true
|
|
744
|
-
source:
|
|
745
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
746
|
-
SitePlanName:
|
|
747
|
-
enum:
|
|
748
|
-
- value: Basic Hosting
|
|
749
|
-
name: BasicHosting
|
|
750
|
-
- value: CMS Hosting
|
|
751
|
-
name: CmsHosting
|
|
752
|
-
- value: Business Hosting
|
|
753
|
-
name: BusinessHosting
|
|
754
|
-
- value: ECommerce Standard Hosting
|
|
755
|
-
name: ECommerceStandardHosting
|
|
756
|
-
- value: ECommerce Plus Hosting
|
|
757
|
-
name: ECommercePlusHosting
|
|
758
|
-
- value: ECommerce Advanced Hosting
|
|
759
|
-
name: ECommerceAdvancedHosting
|
|
760
|
-
docs: Name of the hosting plan.
|
|
761
|
-
inline: true
|
|
762
|
-
source:
|
|
763
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
764
|
-
SitePlan:
|
|
765
|
-
properties:
|
|
766
|
-
id:
|
|
767
|
-
type: optional<SitePlanId>
|
|
768
|
-
docs: ID of the hosting plan.
|
|
769
|
-
name:
|
|
770
|
-
type: optional<SitePlanName>
|
|
771
|
-
docs: Name of the hosting plan.
|
|
772
|
-
pricingInfo:
|
|
773
|
-
type: optional<string>
|
|
774
|
-
docs: URL for more information about Webflow hosting plan pricing.
|
|
775
|
-
source:
|
|
776
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
777
|
-
RobotsRulesItem:
|
|
778
|
-
properties:
|
|
779
|
-
userAgent:
|
|
780
|
-
type: string
|
|
781
|
-
docs: The user agent the rules apply to.
|
|
782
|
-
allows:
|
|
783
|
-
type: optional<list<string>>
|
|
784
|
-
docs: List of paths allowed for this user agent.
|
|
785
|
-
disallows:
|
|
786
|
-
type: optional<list<string>>
|
|
787
|
-
docs: List of paths disallowed for this user agent.
|
|
788
|
-
source:
|
|
789
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
790
|
-
inline: true
|
|
791
|
-
Robots:
|
|
792
|
-
docs: The robots.txt file for a given site
|
|
793
|
-
properties:
|
|
794
|
-
rules:
|
|
795
|
-
type: optional<list<RobotsRulesItem>>
|
|
796
|
-
docs: List of rules for user agents.
|
|
797
|
-
sitemap:
|
|
798
|
-
type: optional<string>
|
|
799
|
-
docs: URL to the sitemap.
|
|
800
|
-
source:
|
|
801
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
802
|
-
SiteActivityLogItemEvent:
|
|
803
|
-
enum:
|
|
804
|
-
- styles_modified
|
|
805
|
-
- site_published
|
|
806
|
-
- ix2_modified_on_page
|
|
807
|
-
- page_dom_modified
|
|
808
|
-
- cms_item
|
|
809
|
-
- backup_created
|
|
810
|
-
- page_custom_code_modified
|
|
811
|
-
- symbols_modified
|
|
812
|
-
- variable_modified
|
|
813
|
-
- variables_modified
|
|
814
|
-
- cms_collection
|
|
815
|
-
- page_settings_modified
|
|
816
|
-
- page_settings_custom_code_modified
|
|
817
|
-
- ix2_modified_on_component
|
|
818
|
-
- ix2_modified_on_class
|
|
819
|
-
- site_custom_code_modified
|
|
820
|
-
- page_duplicated
|
|
821
|
-
- secondary_locale_page_content_modified
|
|
822
|
-
- page_renamed
|
|
823
|
-
- page_created
|
|
824
|
-
- page_deleted
|
|
825
|
-
- site_unpublished
|
|
826
|
-
- backup_restored
|
|
827
|
-
- locale_added
|
|
828
|
-
- branch_created
|
|
829
|
-
- locale_display_name_updated
|
|
830
|
-
- locale_subdirectory_updated
|
|
831
|
-
- branch_merged
|
|
832
|
-
- locale_tag_updated
|
|
833
|
-
- branch_deleted
|
|
834
|
-
- locale_enabled
|
|
835
|
-
- locale_removed
|
|
836
|
-
- locale_disabled
|
|
837
|
-
- library_shared
|
|
838
|
-
- library_unshared
|
|
839
|
-
- library_installed
|
|
840
|
-
- library_uninstalled
|
|
841
|
-
- library_update_shared
|
|
842
|
-
- library_update_accepted
|
|
843
|
-
- branch_review_created
|
|
844
|
-
- branch_review_approved
|
|
845
|
-
- branch_review_canceled
|
|
846
|
-
inline: true
|
|
847
|
-
source:
|
|
848
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
849
|
-
SiteActivityLogItemResourceOperation:
|
|
850
|
-
enum:
|
|
851
|
-
- CREATED
|
|
852
|
-
- MODIFIED
|
|
853
|
-
- PUBLISHED
|
|
854
|
-
- UNPUBLISHED
|
|
855
|
-
- DELETED
|
|
856
|
-
- GROUP_REORDERED
|
|
857
|
-
- GROUP_CREATED
|
|
858
|
-
- GROUP_DELETED
|
|
859
|
-
- REORDERED
|
|
860
|
-
inline: true
|
|
861
|
-
source:
|
|
862
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
863
|
-
SiteActivityLogItemUser:
|
|
864
|
-
properties:
|
|
865
|
-
id: optional<string>
|
|
866
|
-
displayName: optional<string>
|
|
867
|
-
source:
|
|
868
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
869
|
-
inline: true
|
|
870
|
-
SiteActivityLogItem:
|
|
871
|
-
properties:
|
|
872
|
-
id: optional<string>
|
|
873
|
-
createdOn: optional<datetime>
|
|
874
|
-
lastUpdated: optional<datetime>
|
|
875
|
-
event: optional<SiteActivityLogItemEvent>
|
|
876
|
-
resourceOperation: optional<SiteActivityLogItemResourceOperation>
|
|
877
|
-
user: optional<SiteActivityLogItemUser>
|
|
878
|
-
resourceId: optional<string>
|
|
879
|
-
resourceName: optional<string>
|
|
880
|
-
newValue: optional<string>
|
|
881
|
-
previousValue: optional<string>
|
|
882
|
-
payload: optional<map<string, unknown>>
|
|
883
|
-
source:
|
|
884
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
885
|
-
SiteActivityLogResponse:
|
|
886
|
-
properties:
|
|
887
|
-
items: optional<list<SiteActivityLogItem>>
|
|
888
|
-
pagination: optional<Pagination>
|
|
889
|
-
source:
|
|
890
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
891
|
-
CollectionListArrayItem:
|
|
892
|
-
docs: A collection object
|
|
893
|
-
properties:
|
|
894
|
-
id:
|
|
895
|
-
type: string
|
|
896
|
-
docs: Unique identifier for a Collection
|
|
897
|
-
displayName:
|
|
898
|
-
type: optional<string>
|
|
899
|
-
docs: Name given to the Collection
|
|
900
|
-
singularName:
|
|
901
|
-
type: optional<string>
|
|
902
|
-
docs: >-
|
|
903
|
-
The name of one Item in Collection (e.g. ”Blog Post” if the Collection
|
|
904
|
-
is called “Blog Posts”)
|
|
905
|
-
slug:
|
|
906
|
-
type: optional<string>
|
|
907
|
-
docs: Slug of Collection in Site URL structure
|
|
908
|
-
createdOn:
|
|
909
|
-
type: optional<datetime>
|
|
910
|
-
docs: The date the collection was created
|
|
911
|
-
access: read-only
|
|
912
|
-
lastUpdated:
|
|
913
|
-
type: optional<datetime>
|
|
914
|
-
docs: The date the collection was last updated
|
|
915
|
-
access: read-only
|
|
916
|
-
source:
|
|
917
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
918
|
-
CollectionList:
|
|
919
|
-
properties:
|
|
920
|
-
collections:
|
|
921
|
-
type: optional<list<CollectionListArrayItem>>
|
|
922
|
-
docs: An array of Collections
|
|
923
|
-
source:
|
|
924
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
925
|
-
StaticFieldType:
|
|
926
|
-
enum:
|
|
927
|
-
- Color
|
|
928
|
-
- DateTime
|
|
929
|
-
- Email
|
|
930
|
-
- File
|
|
931
|
-
- Image
|
|
932
|
-
- Link
|
|
933
|
-
- MultiImage
|
|
934
|
-
- Number
|
|
935
|
-
- Phone
|
|
936
|
-
- PlainText
|
|
937
|
-
- RichText
|
|
938
|
-
- Switch
|
|
939
|
-
- VideoLink
|
|
940
|
-
docs: Choose these appropriate field type for your collection data
|
|
941
|
-
inline: true
|
|
942
|
-
source:
|
|
943
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
944
|
-
Static Field:
|
|
945
|
-
properties:
|
|
946
|
-
id:
|
|
947
|
-
type: optional<string>
|
|
948
|
-
docs: Unique identifier for a Field
|
|
949
|
-
access: read-only
|
|
950
|
-
isEditable:
|
|
951
|
-
type: optional<boolean>
|
|
952
|
-
docs: Define whether the field is editable
|
|
953
|
-
access: read-only
|
|
954
|
-
isRequired:
|
|
955
|
-
type: optional<boolean>
|
|
956
|
-
docs: define whether a field is required in a collection
|
|
957
|
-
type:
|
|
958
|
-
type: StaticFieldType
|
|
959
|
-
docs: Choose these appropriate field type for your collection data
|
|
960
|
-
displayName:
|
|
961
|
-
type: string
|
|
962
|
-
docs: The name of a field
|
|
963
|
-
helpText:
|
|
964
|
-
type: optional<string>
|
|
965
|
-
docs: Additional text to help anyone filling out this field
|
|
966
|
-
source:
|
|
967
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
968
|
-
MetadataOptionsItem:
|
|
969
|
-
docs: A single option value for the Option field.
|
|
970
|
-
properties:
|
|
971
|
-
name:
|
|
972
|
-
type: string
|
|
973
|
-
docs: The name of the option
|
|
974
|
-
id:
|
|
975
|
-
type: optional<string>
|
|
976
|
-
docs: The unique identifier of the option
|
|
977
|
-
access: read-only
|
|
978
|
-
source:
|
|
979
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
980
|
-
inline: true
|
|
981
|
-
Metadata:
|
|
982
|
-
docs: The metadata for the Option field.
|
|
983
|
-
properties:
|
|
984
|
-
options:
|
|
985
|
-
docs: The option values for the Option field.
|
|
986
|
-
type: list<MetadataOptionsItem>
|
|
987
|
-
source:
|
|
988
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
989
|
-
Option Field:
|
|
990
|
-
properties:
|
|
991
|
-
id:
|
|
992
|
-
type: optional<string>
|
|
993
|
-
docs: Unique identifier for a Field
|
|
994
|
-
access: read-only
|
|
995
|
-
isEditable:
|
|
996
|
-
type: optional<boolean>
|
|
997
|
-
docs: Define whether the field is editable
|
|
998
|
-
access: read-only
|
|
999
|
-
isRequired:
|
|
1000
|
-
type: optional<boolean>
|
|
1001
|
-
docs: define whether a field is required in a collection
|
|
1002
|
-
type:
|
|
1003
|
-
type: literal<"Option">
|
|
1004
|
-
docs: >-
|
|
1005
|
-
The [Option field
|
|
1006
|
-
type](/data/reference/field-types-item-values#option)
|
|
1007
|
-
displayName:
|
|
1008
|
-
type: string
|
|
1009
|
-
docs: The name of a field
|
|
1010
|
-
helpText:
|
|
1011
|
-
type: optional<string>
|
|
1012
|
-
docs: Additional text to help anyone filling out this field
|
|
1013
|
-
metadata: Metadata
|
|
1014
|
-
source:
|
|
1015
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1016
|
-
ReferenceFieldType:
|
|
1017
|
-
enum:
|
|
1018
|
-
- MultiReference
|
|
1019
|
-
- Reference
|
|
1020
|
-
docs: Choose these appropriate field type for your collection data
|
|
1021
|
-
inline: true
|
|
1022
|
-
source:
|
|
1023
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1024
|
-
ReferenceFieldMetadata:
|
|
1025
|
-
docs: >-
|
|
1026
|
-
The collectionId for the referenced collection. Only applicable for
|
|
1027
|
-
Reference and MultiReference fields.
|
|
1028
|
-
properties:
|
|
1029
|
-
collectionId:
|
|
1030
|
-
type: string
|
|
1031
|
-
docs: The unique identifier of the collection
|
|
1032
|
-
source:
|
|
1033
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1034
|
-
inline: true
|
|
1035
|
-
Reference Field:
|
|
1036
|
-
properties:
|
|
1037
|
-
id:
|
|
1038
|
-
type: optional<string>
|
|
1039
|
-
docs: Unique identifier for a Field
|
|
1040
|
-
access: read-only
|
|
1041
|
-
isEditable:
|
|
1042
|
-
type: optional<boolean>
|
|
1043
|
-
docs: Define whether the field is editable
|
|
1044
|
-
access: read-only
|
|
1045
|
-
isRequired:
|
|
1046
|
-
type: optional<boolean>
|
|
1047
|
-
docs: define whether a field is required in a collection
|
|
1048
|
-
type:
|
|
1049
|
-
type: ReferenceFieldType
|
|
1050
|
-
docs: Choose these appropriate field type for your collection data
|
|
1051
|
-
displayName:
|
|
1052
|
-
type: string
|
|
1053
|
-
docs: The name of a field
|
|
1054
|
-
helpText:
|
|
1055
|
-
type: optional<string>
|
|
1056
|
-
docs: Additional text to help anyone filling out this field
|
|
1057
|
-
metadata:
|
|
1058
|
-
type: ReferenceFieldMetadata
|
|
1059
|
-
docs: >-
|
|
1060
|
-
The collectionId for the referenced collection. Only applicable for
|
|
1061
|
-
Reference and MultiReference fields.
|
|
1062
|
-
source:
|
|
1063
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1064
|
-
FieldCreate:
|
|
1065
|
-
discriminated: false
|
|
1066
|
-
docs: Details about the field of a collection
|
|
1067
|
-
union:
|
|
1068
|
-
- type: Static Field
|
|
1069
|
-
- type: Option Field
|
|
1070
|
-
- type: Reference Field
|
|
1071
|
-
source:
|
|
1072
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1073
|
-
FieldType:
|
|
1074
|
-
enum:
|
|
1075
|
-
- Color
|
|
1076
|
-
- DateTime
|
|
1077
|
-
- Email
|
|
1078
|
-
- ExtFileRef
|
|
1079
|
-
- File
|
|
1080
|
-
- Image
|
|
1081
|
-
- Link
|
|
1082
|
-
- MultiImage
|
|
1083
|
-
- MultiReference
|
|
1084
|
-
- Number
|
|
1085
|
-
- Option
|
|
1086
|
-
- Phone
|
|
1087
|
-
- PlainText
|
|
1088
|
-
- Reference
|
|
1089
|
-
- RichText
|
|
1090
|
-
- Switch
|
|
1091
|
-
- VideoLink
|
|
1092
|
-
docs: Choose these appropriate field type for your collection data
|
|
1093
|
-
inline: true
|
|
1094
|
-
source:
|
|
1095
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1096
|
-
FieldValidationsAdditionalPropertiesAdditionalProperties:
|
|
1097
|
-
properties:
|
|
1098
|
-
additionalProperties: unknown
|
|
1099
|
-
source:
|
|
1100
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1101
|
-
inline: true
|
|
1102
|
-
FieldValidationsAdditionalProperties:
|
|
1103
|
-
discriminated: false
|
|
1104
|
-
union:
|
|
1105
|
-
- string
|
|
1106
|
-
- double
|
|
1107
|
-
- boolean
|
|
1108
|
-
- integer
|
|
1109
|
-
- FieldValidationsAdditionalPropertiesAdditionalProperties
|
|
1110
|
-
source:
|
|
1111
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1112
|
-
inline: true
|
|
1113
|
-
FieldValidations:
|
|
1114
|
-
docs: The validations for the field
|
|
1115
|
-
properties:
|
|
1116
|
-
additionalProperties: optional<FieldValidationsAdditionalProperties>
|
|
1117
|
-
source:
|
|
1118
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1119
|
-
inline: true
|
|
1120
|
-
Field:
|
|
1121
|
-
docs: The details of a field in a collection
|
|
1122
|
-
properties:
|
|
1123
|
-
id:
|
|
1124
|
-
type: string
|
|
1125
|
-
docs: Unique identifier for a Field
|
|
1126
|
-
isRequired:
|
|
1127
|
-
type: boolean
|
|
1128
|
-
docs: define whether a field is required in a collection
|
|
1129
|
-
isEditable:
|
|
1130
|
-
type: optional<boolean>
|
|
1131
|
-
docs: Define whether the field is editable
|
|
1132
|
-
access: read-only
|
|
1133
|
-
type:
|
|
1134
|
-
type: FieldType
|
|
1135
|
-
docs: Choose these appropriate field type for your collection data
|
|
1136
|
-
slug:
|
|
1137
|
-
type: optional<string>
|
|
1138
|
-
docs: >-
|
|
1139
|
-
Slug of Field in Site URL structure. Slugs should be all lowercase
|
|
1140
|
-
with no spaces. Any spaces will be converted to "-."
|
|
1141
|
-
displayName:
|
|
1142
|
-
type: string
|
|
1143
|
-
docs: The name of a field
|
|
1144
|
-
helpText:
|
|
1145
|
-
type: optional<string>
|
|
1146
|
-
docs: Additional text to help anyone filling out this field
|
|
1147
|
-
validations:
|
|
1148
|
-
type: optional<FieldValidations>
|
|
1149
|
-
docs: The validations for the field
|
|
1150
|
-
access: read-only
|
|
1151
|
-
source:
|
|
1152
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1153
|
-
Collection:
|
|
1154
|
-
docs: A collection object
|
|
1155
|
-
properties:
|
|
1156
|
-
id:
|
|
1157
|
-
type: string
|
|
1158
|
-
docs: Unique identifier for a Collection
|
|
1159
|
-
displayName:
|
|
1160
|
-
type: string
|
|
1161
|
-
docs: Name given to the Collection
|
|
1162
|
-
singularName:
|
|
1163
|
-
type: string
|
|
1164
|
-
docs: >-
|
|
1165
|
-
The name of one Item in Collection (e.g. ”Blog Post” if the Collection
|
|
1166
|
-
is called “Blog Posts”)
|
|
1167
|
-
slug:
|
|
1168
|
-
type: optional<string>
|
|
1169
|
-
docs: Slug of Collection in Site URL structure
|
|
1170
|
-
createdOn:
|
|
1171
|
-
type: optional<datetime>
|
|
1172
|
-
docs: The date the collection was created
|
|
1173
|
-
access: read-only
|
|
1174
|
-
lastUpdated:
|
|
1175
|
-
type: optional<datetime>
|
|
1176
|
-
docs: The date the collection was last updated
|
|
1177
|
-
access: read-only
|
|
1178
|
-
fields:
|
|
1179
|
-
docs: The list of fields in the Collection
|
|
1180
|
-
type: list<Field>
|
|
1181
|
-
source:
|
|
1182
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1183
|
-
CollectionItemFieldData:
|
|
1184
|
-
properties:
|
|
1185
|
-
name:
|
|
1186
|
-
type: string
|
|
1187
|
-
docs: Name of the Item
|
|
1188
|
-
slug:
|
|
1189
|
-
type: string
|
|
1190
|
-
docs: >-
|
|
1191
|
-
URL structure of the Item in your site. Note: Updates to an item slug
|
|
1192
|
-
will break all links referencing the old slug.
|
|
1193
|
-
extra-properties: true
|
|
1194
|
-
source:
|
|
1195
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1196
|
-
inline: true
|
|
1197
|
-
CollectionItem:
|
|
1198
|
-
docs: >
|
|
1199
|
-
A Collection Item represents a single entry in your collection. Each item
|
|
1200
|
-
includes:
|
|
1201
|
-
|
|
1202
|
-
|
|
1203
|
-
- **System metadata** - Automatically managed fields like IDs and
|
|
1204
|
-
timestamp <br/>
|
|
1205
|
-
|
|
1206
|
-
- **Status flags** - Controls for managing content state: `isDraft`,
|
|
1207
|
-
`isArchived `<br/>
|
|
1208
|
-
|
|
1209
|
-
- **Content fields** - Stored in `fieldData`. Each item needs a `name` and
|
|
1210
|
-
`slug`, and may include additional fields matching your collection's
|
|
1211
|
-
schema definition.
|
|
1212
|
-
properties:
|
|
1213
|
-
id:
|
|
1214
|
-
type: optional<string>
|
|
1215
|
-
docs: Unique identifier for the Item
|
|
1216
|
-
access: read-only
|
|
1217
|
-
cmsLocaleId:
|
|
1218
|
-
type: optional<string>
|
|
1219
|
-
docs: Identifier for the locale of the CMS item
|
|
1220
|
-
lastPublished:
|
|
1221
|
-
type: optional<string>
|
|
1222
|
-
docs: The date the item was last published
|
|
1223
|
-
access: read-only
|
|
1224
|
-
lastUpdated:
|
|
1225
|
-
type: optional<string>
|
|
1226
|
-
docs: The date the item was last updated
|
|
1227
|
-
access: read-only
|
|
1228
|
-
createdOn:
|
|
1229
|
-
type: optional<string>
|
|
1230
|
-
docs: The date the item was created
|
|
1231
|
-
access: read-only
|
|
1232
|
-
isArchived:
|
|
1233
|
-
type: optional<boolean>
|
|
1234
|
-
docs: Boolean determining if the Item is set to archived
|
|
1235
|
-
default: false
|
|
1236
|
-
isDraft:
|
|
1237
|
-
type: optional<boolean>
|
|
1238
|
-
docs: Boolean determining if the Item is set to draft
|
|
1239
|
-
default: false
|
|
1240
|
-
fieldData: CollectionItemFieldData
|
|
1241
|
-
source:
|
|
1242
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1243
|
-
CollectionItemListPagination:
|
|
1244
|
-
properties:
|
|
1245
|
-
limit:
|
|
1246
|
-
type: optional<double>
|
|
1247
|
-
docs: The limit specified in the request
|
|
1248
|
-
default: 100
|
|
1249
|
-
offset:
|
|
1250
|
-
type: optional<double>
|
|
1251
|
-
docs: The offset specified for pagination
|
|
1252
|
-
default: 0
|
|
1253
|
-
total:
|
|
1254
|
-
type: optional<double>
|
|
1255
|
-
docs: Total number of items in the collection
|
|
1256
|
-
source:
|
|
1257
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1258
|
-
inline: true
|
|
1259
|
-
CollectionItemList:
|
|
1260
|
-
docs: Results from collection items list
|
|
1261
|
-
properties:
|
|
1262
|
-
items:
|
|
1263
|
-
type: optional<list<CollectionItem>>
|
|
1264
|
-
docs: List of Items within the collection
|
|
1265
|
-
pagination: optional<CollectionItemListPagination>
|
|
1266
|
-
source:
|
|
1267
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1268
|
-
CollectionItemPostSingleFieldData:
|
|
1269
|
-
properties:
|
|
1270
|
-
name:
|
|
1271
|
-
type: string
|
|
1272
|
-
docs: Name of the Item
|
|
1273
|
-
slug:
|
|
1274
|
-
type: string
|
|
1275
|
-
docs: >-
|
|
1276
|
-
URL structure of the Item in your site. Note: Updates to an item slug
|
|
1277
|
-
will break all links referencing the old slug.
|
|
1278
|
-
extra-properties: true
|
|
1279
|
-
source:
|
|
1280
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1281
|
-
inline: true
|
|
1282
|
-
CollectionItemPostSingle:
|
|
1283
|
-
docs: >
|
|
1284
|
-
A Collection Item represents a single entry in your collection. Each item
|
|
1285
|
-
includes:
|
|
1286
|
-
|
|
1287
|
-
|
|
1288
|
-
- **System metadata** - Automatically managed fields like IDs and
|
|
1289
|
-
timestamp <br/>
|
|
1290
|
-
|
|
1291
|
-
- **Status flags** - Controls for managing content state: `isDraft`,
|
|
1292
|
-
`isArchived `<br/>
|
|
1293
|
-
|
|
1294
|
-
- **Content fields** - Stored in `fieldData`. Each item needs a `name` and
|
|
1295
|
-
`slug`, and may include additional fields matching your collection's
|
|
1296
|
-
schema definition.
|
|
1297
|
-
properties:
|
|
1298
|
-
id:
|
|
1299
|
-
type: optional<string>
|
|
1300
|
-
docs: Unique identifier for the Item
|
|
1301
|
-
access: read-only
|
|
1302
|
-
cmsLocaleId:
|
|
1303
|
-
type: optional<string>
|
|
1304
|
-
docs: Identifier for the locale of the CMS item
|
|
1305
|
-
lastPublished:
|
|
1306
|
-
type: optional<string>
|
|
1307
|
-
docs: The date the item was last published
|
|
1308
|
-
access: read-only
|
|
1309
|
-
lastUpdated:
|
|
1310
|
-
type: optional<string>
|
|
1311
|
-
docs: The date the item was last updated
|
|
1312
|
-
access: read-only
|
|
1313
|
-
createdOn:
|
|
1314
|
-
type: optional<string>
|
|
1315
|
-
docs: The date the item was created
|
|
1316
|
-
access: read-only
|
|
1317
|
-
isArchived:
|
|
1318
|
-
type: optional<boolean>
|
|
1319
|
-
docs: Boolean determining if the Item is in an archived state.
|
|
1320
|
-
default: false
|
|
1321
|
-
isDraft:
|
|
1322
|
-
type: optional<boolean>
|
|
1323
|
-
docs: Boolean determining if the Item is in a draft state.
|
|
1324
|
-
default: true
|
|
1325
|
-
fieldData: CollectionItemPostSingleFieldData
|
|
1326
|
-
source:
|
|
1327
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1328
|
-
CollectionItemWithIdInputFieldData:
|
|
1329
|
-
properties:
|
|
1330
|
-
name:
|
|
1331
|
-
type: optional<string>
|
|
1332
|
-
docs: Name of the Item
|
|
1333
|
-
slug:
|
|
1334
|
-
type: optional<string>
|
|
1335
|
-
docs: >-
|
|
1336
|
-
URL structure of the Item in your site. Note: Updates to an item slug
|
|
1337
|
-
will break all links referencing the old slug.
|
|
1338
|
-
extra-properties: true
|
|
1339
|
-
source:
|
|
1340
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1341
|
-
inline: true
|
|
1342
|
-
CollectionItemWithIdInput:
|
|
1343
|
-
docs: >
|
|
1344
|
-
The fields that define the schema for a given Item are based on the
|
|
1345
|
-
Collection that Item belongs to. Beyond the user defined fields, there are
|
|
1346
|
-
a handful of additional fields that are automatically created for all
|
|
1347
|
-
items
|
|
1348
|
-
properties:
|
|
1349
|
-
id:
|
|
1350
|
-
type: string
|
|
1351
|
-
docs: Unique identifier for the Item
|
|
1352
|
-
cmsLocaleId:
|
|
1353
|
-
type: optional<string>
|
|
1354
|
-
docs: Identifier for the locale of the CMS item
|
|
1355
|
-
lastPublished:
|
|
1356
|
-
type: optional<string>
|
|
1357
|
-
docs: The date the item was last published
|
|
1358
|
-
access: read-only
|
|
1359
|
-
lastUpdated:
|
|
1360
|
-
type: optional<string>
|
|
1361
|
-
docs: The date the item was last updated
|
|
1362
|
-
access: read-only
|
|
1363
|
-
createdOn:
|
|
1364
|
-
type: optional<string>
|
|
1365
|
-
docs: The date the item was created
|
|
1366
|
-
access: read-only
|
|
1367
|
-
isArchived:
|
|
1368
|
-
type: optional<boolean>
|
|
1369
|
-
docs: Boolean determining if the Item is set to archived
|
|
1370
|
-
isDraft:
|
|
1371
|
-
type: optional<boolean>
|
|
1372
|
-
docs: Boolean determining if the Item is set to draft
|
|
1373
|
-
fieldData: optional<CollectionItemWithIdInputFieldData>
|
|
1374
|
-
source:
|
|
1375
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1376
|
-
CollectionItemListNoPagination:
|
|
1377
|
-
docs: Results from collection items list
|
|
1378
|
-
properties:
|
|
1379
|
-
items:
|
|
1380
|
-
type: optional<list<CollectionItem>>
|
|
1381
|
-
docs: List of Items within the collection
|
|
1382
|
-
source:
|
|
1383
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1384
|
-
Conflict: unknown
|
|
1385
|
-
BulkCollectionItemFieldData:
|
|
1386
|
-
properties:
|
|
1387
|
-
name:
|
|
1388
|
-
type: optional<string>
|
|
1389
|
-
docs: Name of the Item
|
|
1390
|
-
slug:
|
|
1391
|
-
type: optional<string>
|
|
1392
|
-
docs: >-
|
|
1393
|
-
URL structure of the Item in your site. Note: Updates to an item slug
|
|
1394
|
-
will break all links referencing the old slug.
|
|
1395
|
-
extra-properties: true
|
|
1396
|
-
source:
|
|
1397
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1398
|
-
inline: true
|
|
1399
|
-
BulkCollectionItem:
|
|
1400
|
-
docs: >
|
|
1401
|
-
The fields that define the schema for a given Item are based on the
|
|
1402
|
-
Collection that Item belongs to. Beyond the user defined fields, there are
|
|
1403
|
-
a handful of additional fields that are automatically created for all
|
|
1404
|
-
items
|
|
1405
|
-
properties:
|
|
1406
|
-
id:
|
|
1407
|
-
type: optional<string>
|
|
1408
|
-
docs: Unique identifier for the Item
|
|
1409
|
-
cmsLocaleIds:
|
|
1410
|
-
type: optional<list<string>>
|
|
1411
|
-
docs: Array of identifiers for the locales where the item will be created
|
|
1412
|
-
lastPublished:
|
|
1413
|
-
type: optional<string>
|
|
1414
|
-
docs: The date the item was last published
|
|
1415
|
-
access: read-only
|
|
1416
|
-
lastUpdated:
|
|
1417
|
-
type: optional<string>
|
|
1418
|
-
docs: The date the item was last updated
|
|
1419
|
-
access: read-only
|
|
1420
|
-
createdOn:
|
|
1421
|
-
type: optional<string>
|
|
1422
|
-
docs: The date the item was created
|
|
1423
|
-
access: read-only
|
|
1424
|
-
isArchived:
|
|
1425
|
-
type: optional<boolean>
|
|
1426
|
-
docs: Boolean determining if the Item is set to archived
|
|
1427
|
-
default: false
|
|
1428
|
-
isDraft:
|
|
1429
|
-
type: optional<boolean>
|
|
1430
|
-
docs: Boolean determining if the Item is set to draft
|
|
1431
|
-
default: false
|
|
1432
|
-
fieldData: optional<BulkCollectionItemFieldData>
|
|
1433
|
-
source:
|
|
1434
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1435
|
-
CollectionItemPatchSingleFieldData:
|
|
1436
|
-
properties:
|
|
1437
|
-
name:
|
|
1438
|
-
type: optional<string>
|
|
1439
|
-
docs: Name of the Item
|
|
1440
|
-
slug:
|
|
1441
|
-
type: optional<string>
|
|
1442
|
-
docs: >-
|
|
1443
|
-
URL structure of the Item in your site. Note: Updates to an item slug
|
|
1444
|
-
will break all links referencing the old slug.
|
|
1445
|
-
extra-properties: true
|
|
1446
|
-
source:
|
|
1447
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1448
|
-
inline: true
|
|
1449
|
-
CollectionItemPatchSingle:
|
|
1450
|
-
docs: >
|
|
1451
|
-
The fields that define the schema for a given Item are based on the
|
|
1452
|
-
Collection that Item belongs to. Beyond the user defined fields, there are
|
|
1453
|
-
a handful of additional fields that are automatically created for all
|
|
1454
|
-
items
|
|
1455
|
-
properties:
|
|
1456
|
-
id:
|
|
1457
|
-
type: optional<string>
|
|
1458
|
-
docs: Unique identifier for the Item
|
|
1459
|
-
access: read-only
|
|
1460
|
-
cmsLocaleId:
|
|
1461
|
-
type: optional<string>
|
|
1462
|
-
docs: Identifier for the locale of the CMS item
|
|
1463
|
-
lastPublished:
|
|
1464
|
-
type: optional<string>
|
|
1465
|
-
docs: The date the item was last published
|
|
1466
|
-
access: read-only
|
|
1467
|
-
lastUpdated:
|
|
1468
|
-
type: optional<string>
|
|
1469
|
-
docs: The date the item was last updated
|
|
1470
|
-
access: read-only
|
|
1471
|
-
createdOn:
|
|
1472
|
-
type: optional<string>
|
|
1473
|
-
docs: The date the item was created
|
|
1474
|
-
access: read-only
|
|
1475
|
-
isArchived:
|
|
1476
|
-
type: optional<boolean>
|
|
1477
|
-
docs: Boolean determining if the Item is set to archived
|
|
1478
|
-
isDraft:
|
|
1479
|
-
type: optional<boolean>
|
|
1480
|
-
docs: Boolean determining if the Item is set to draft
|
|
1481
|
-
fieldData: optional<CollectionItemPatchSingleFieldData>
|
|
1482
|
-
source:
|
|
1483
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1484
|
-
CommentThreadAuthor:
|
|
1485
|
-
properties:
|
|
1486
|
-
userId:
|
|
1487
|
-
type: string
|
|
1488
|
-
docs: The unique identifier of the author
|
|
1489
|
-
email:
|
|
1490
|
-
type: string
|
|
1491
|
-
docs: Email of the author
|
|
1492
|
-
name:
|
|
1493
|
-
type: string
|
|
1494
|
-
docs: Name of the author
|
|
1495
|
-
source:
|
|
1496
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1497
|
-
inline: true
|
|
1498
|
-
CommentThreadMentionedUsersItem:
|
|
1499
|
-
properties:
|
|
1500
|
-
userId:
|
|
1501
|
-
type: string
|
|
1502
|
-
docs: The unique identifier of the mentioned user
|
|
1503
|
-
email:
|
|
1504
|
-
type: string
|
|
1505
|
-
docs: Email of the user
|
|
1506
|
-
name:
|
|
1507
|
-
type: string
|
|
1508
|
-
docs: Name of the User
|
|
1509
|
-
source:
|
|
1510
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1511
|
-
inline: true
|
|
1512
|
-
CommentThread:
|
|
1513
|
-
docs: >
|
|
1514
|
-
A comment thread represents a conversation between users on a specific
|
|
1515
|
-
page. Each comment thread has a unique identifier and can contain multiple
|
|
1516
|
-
comments. Retrieve comment replies using the replies API endpoint.
|
|
1517
|
-
properties:
|
|
1518
|
-
id:
|
|
1519
|
-
type: string
|
|
1520
|
-
docs: Unique identifier for the comment thread
|
|
1521
|
-
siteId:
|
|
1522
|
-
type: string
|
|
1523
|
-
docs: The site unique identifier
|
|
1524
|
-
pageId:
|
|
1525
|
-
type: string
|
|
1526
|
-
docs: The page unique identifier
|
|
1527
|
-
localeId:
|
|
1528
|
-
type: optional<string>
|
|
1529
|
-
docs: The locale unique identifier
|
|
1530
|
-
access: read-only
|
|
1531
|
-
itemId:
|
|
1532
|
-
type: optional<string>
|
|
1533
|
-
docs: The item unique identifier
|
|
1534
|
-
access: read-only
|
|
1535
|
-
breakpoint:
|
|
1536
|
-
type: string
|
|
1537
|
-
docs: The breakpoint the comment was left on
|
|
1538
|
-
url:
|
|
1539
|
-
type: string
|
|
1540
|
-
docs: The URL of the page the comment was left on
|
|
1541
|
-
content:
|
|
1542
|
-
type: string
|
|
1543
|
-
docs: The content of the comment reply
|
|
1544
|
-
isResolved:
|
|
1545
|
-
type: boolean
|
|
1546
|
-
docs: Boolean determining if the comment thread is resolved
|
|
1547
|
-
default: false
|
|
1548
|
-
author: CommentThreadAuthor
|
|
1549
|
-
mentionedUsers:
|
|
1550
|
-
docs: >-
|
|
1551
|
-
List of mentioned users. This is an empty array until email
|
|
1552
|
-
notifications are sent, which can take up to 5 minutes after the
|
|
1553
|
-
comment is created.
|
|
1554
|
-
type: list<CommentThreadMentionedUsersItem>
|
|
1555
|
-
createdOn:
|
|
1556
|
-
type: string
|
|
1557
|
-
docs: The date the item was created
|
|
1558
|
-
lastUpdated:
|
|
1559
|
-
type: string
|
|
1560
|
-
docs: The date the item was last updated
|
|
1561
|
-
source:
|
|
1562
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1563
|
-
CommentThreadListPagination:
|
|
1564
|
-
properties:
|
|
1565
|
-
limit:
|
|
1566
|
-
type: double
|
|
1567
|
-
docs: The limit specified in the request (default 100)
|
|
1568
|
-
default: 100
|
|
1569
|
-
offset:
|
|
1570
|
-
type: double
|
|
1571
|
-
docs: The offset specified for pagination
|
|
1572
|
-
default: 0
|
|
1573
|
-
total:
|
|
1574
|
-
type: double
|
|
1575
|
-
docs: Total number of comment threads
|
|
1576
|
-
source:
|
|
1577
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1578
|
-
inline: true
|
|
1579
|
-
CommentThreadList:
|
|
1580
|
-
docs: >
|
|
1581
|
-
A list of comment threads on the site. Contains the content of the first
|
|
1582
|
-
reply.
|
|
1583
|
-
properties:
|
|
1584
|
-
comments: list<CommentThread>
|
|
1585
|
-
pagination: CommentThreadListPagination
|
|
1586
|
-
source:
|
|
1587
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1588
|
-
CommentReplyAuthor:
|
|
1589
|
-
properties:
|
|
1590
|
-
id:
|
|
1591
|
-
type: string
|
|
1592
|
-
docs: The unique identifier of the author
|
|
1593
|
-
email:
|
|
1594
|
-
type: string
|
|
1595
|
-
docs: Email of the author
|
|
1596
|
-
name:
|
|
1597
|
-
type: string
|
|
1598
|
-
docs: Name of the author
|
|
1599
|
-
source:
|
|
1600
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1601
|
-
inline: true
|
|
1602
|
-
CommentReplyMentionedUsersItem:
|
|
1603
|
-
properties:
|
|
1604
|
-
id:
|
|
1605
|
-
type: string
|
|
1606
|
-
docs: The unique identifier of the mentioned user
|
|
1607
|
-
email:
|
|
1608
|
-
type: string
|
|
1609
|
-
docs: Email of the user
|
|
1610
|
-
name:
|
|
1611
|
-
type: string
|
|
1612
|
-
docs: Name of the User
|
|
1613
|
-
source:
|
|
1614
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1615
|
-
inline: true
|
|
1616
|
-
CommentReply:
|
|
1617
|
-
docs: >
|
|
1618
|
-
A comment thread represents a conversation between users on a specific
|
|
1619
|
-
page. Each comment thread has a unique identifier and can contain multiple
|
|
1620
|
-
comments.
|
|
1621
|
-
properties:
|
|
1622
|
-
id:
|
|
1623
|
-
type: string
|
|
1624
|
-
docs: Unique identifier for the comment thread
|
|
1625
|
-
commentId:
|
|
1626
|
-
type: string
|
|
1627
|
-
docs: The comment reply unique identifier
|
|
1628
|
-
siteId:
|
|
1629
|
-
type: string
|
|
1630
|
-
docs: The site unique identifier
|
|
1631
|
-
pageId:
|
|
1632
|
-
type: string
|
|
1633
|
-
docs: The page unique identifier
|
|
1634
|
-
localeId:
|
|
1635
|
-
type: optional<string>
|
|
1636
|
-
docs: The locale unique identifier
|
|
1637
|
-
access: read-only
|
|
1638
|
-
breakpoint:
|
|
1639
|
-
type: string
|
|
1640
|
-
docs: The breakpoint the comment was left on
|
|
1641
|
-
content:
|
|
1642
|
-
type: string
|
|
1643
|
-
docs: The content of the comment reply
|
|
1644
|
-
isResolved:
|
|
1645
|
-
type: boolean
|
|
1646
|
-
docs: Boolean determining if the comment thread is resolved
|
|
1647
|
-
default: false
|
|
1648
|
-
author: CommentReplyAuthor
|
|
1649
|
-
mentionedUsers:
|
|
1650
|
-
type: optional<list<CommentReplyMentionedUsersItem>>
|
|
1651
|
-
docs: >-
|
|
1652
|
-
List of mentioned users is an empty array until email notifications
|
|
1653
|
-
are sent.
|
|
1654
|
-
lastUpdated:
|
|
1655
|
-
type: optional<string>
|
|
1656
|
-
docs: The date the item was last updated
|
|
1657
|
-
access: read-only
|
|
1658
|
-
createdOn:
|
|
1659
|
-
type: optional<string>
|
|
1660
|
-
docs: The date the item was created
|
|
1661
|
-
access: read-only
|
|
1662
|
-
source:
|
|
1663
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1664
|
-
CommentReplyListPagination:
|
|
1665
|
-
properties:
|
|
1666
|
-
limit:
|
|
1667
|
-
type: double
|
|
1668
|
-
docs: The limit specified in the request (default 100)
|
|
1669
|
-
default: 100
|
|
1670
|
-
offset:
|
|
1671
|
-
type: double
|
|
1672
|
-
docs: The offset specified for pagination
|
|
1673
|
-
default: 0
|
|
1674
|
-
total:
|
|
1675
|
-
type: double
|
|
1676
|
-
docs: Total number of comment replies
|
|
1677
|
-
source:
|
|
1678
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1679
|
-
inline: true
|
|
1680
|
-
CommentReplyList:
|
|
1681
|
-
docs: |
|
|
1682
|
-
A list of comment replies.
|
|
1683
|
-
properties:
|
|
1684
|
-
comments: list<CommentReply>
|
|
1685
|
-
pagination: CommentReplyListPagination
|
|
1686
|
-
source:
|
|
1687
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1688
|
-
PageSeo:
|
|
1689
|
-
docs: SEO-related fields for the Page
|
|
1690
|
-
properties:
|
|
1691
|
-
title:
|
|
1692
|
-
type: optional<string>
|
|
1693
|
-
docs: The Page title shown in search engine results
|
|
1694
|
-
description:
|
|
1695
|
-
type: optional<string>
|
|
1696
|
-
docs: The Page description shown in search engine results
|
|
1697
|
-
source:
|
|
1698
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1699
|
-
inline: true
|
|
1700
|
-
PageOpenGraph:
|
|
1701
|
-
docs: Open Graph fields for the Page
|
|
1702
|
-
properties:
|
|
1703
|
-
title:
|
|
1704
|
-
type: optional<string>
|
|
1705
|
-
docs: The title supplied to Open Graph annotations
|
|
1706
|
-
titleCopied:
|
|
1707
|
-
type: optional<boolean>
|
|
1708
|
-
docs: Indicates the Open Graph title was copied from the SEO title
|
|
1709
|
-
default: true
|
|
1710
|
-
access: read-only
|
|
1711
|
-
description:
|
|
1712
|
-
type: optional<string>
|
|
1713
|
-
docs: The description supplied to Open Graph annotations
|
|
1714
|
-
descriptionCopied:
|
|
1715
|
-
type: optional<boolean>
|
|
1716
|
-
docs: >-
|
|
1717
|
-
Indicates the Open Graph description was copied from the SEO
|
|
1718
|
-
description
|
|
1719
|
-
default: true
|
|
1720
|
-
access: read-only
|
|
1721
|
-
source:
|
|
1722
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1723
|
-
inline: true
|
|
1724
|
-
Page:
|
|
1725
|
-
docs: The Page object
|
|
1726
|
-
properties:
|
|
1727
|
-
id:
|
|
1728
|
-
type: string
|
|
1729
|
-
docs: Unique identifier for the Page
|
|
1730
|
-
siteId:
|
|
1731
|
-
type: optional<string>
|
|
1732
|
-
docs: Unique identifier for the Site
|
|
1733
|
-
access: read-only
|
|
1734
|
-
title:
|
|
1735
|
-
type: optional<string>
|
|
1736
|
-
docs: Title of the Page
|
|
1737
|
-
slug:
|
|
1738
|
-
type: optional<string>
|
|
1739
|
-
docs: slug of the Page (derived from title)
|
|
1740
|
-
parentId:
|
|
1741
|
-
type: optional<string>
|
|
1742
|
-
docs: Identifier of the parent folder
|
|
1743
|
-
access: read-only
|
|
1744
|
-
collectionId:
|
|
1745
|
-
type: optional<string>
|
|
1746
|
-
docs: >-
|
|
1747
|
-
Unique identifier for a linked Collection, value will be null if the
|
|
1748
|
-
Page is not part of a Collection.
|
|
1749
|
-
access: read-only
|
|
1750
|
-
createdOn:
|
|
1751
|
-
type: optional<datetime>
|
|
1752
|
-
docs: The date the Page was created
|
|
1753
|
-
access: read-only
|
|
1754
|
-
lastUpdated:
|
|
1755
|
-
type: optional<datetime>
|
|
1756
|
-
docs: The date the Page was most recently updated
|
|
1757
|
-
access: read-only
|
|
1758
|
-
archived:
|
|
1759
|
-
type: optional<boolean>
|
|
1760
|
-
docs: Whether the Page has been archived
|
|
1761
|
-
default: false
|
|
1762
|
-
access: read-only
|
|
1763
|
-
draft:
|
|
1764
|
-
type: optional<boolean>
|
|
1765
|
-
docs: Whether the Page is a draft
|
|
1766
|
-
default: false
|
|
1767
|
-
access: read-only
|
|
1768
|
-
canBranch:
|
|
1769
|
-
type: optional<boolean>
|
|
1770
|
-
docs: >-
|
|
1771
|
-
Indicates whether the Page supports [Page
|
|
1772
|
-
Branching](https://university.webflow.com/lesson/page-branching).
|
|
1773
|
-
Pages that are already branches cannot be branched again.
|
|
1774
|
-
default: false
|
|
1775
|
-
access: read-only
|
|
1776
|
-
isBranch:
|
|
1777
|
-
type: optional<boolean>
|
|
1778
|
-
docs: >-
|
|
1779
|
-
Indicates whether the Page is a Branch of another Page [Page
|
|
1780
|
-
Branching](https://university.webflow.com/lesson/page-branching)
|
|
1781
|
-
default: false
|
|
1782
|
-
access: read-only
|
|
1783
|
-
branchId:
|
|
1784
|
-
type: optional<string>
|
|
1785
|
-
docs: If the Page is a Branch of another Page, this is the ID of the Branch
|
|
1786
|
-
seo:
|
|
1787
|
-
type: optional<PageSeo>
|
|
1788
|
-
docs: SEO-related fields for the Page
|
|
1789
|
-
openGraph:
|
|
1790
|
-
type: optional<PageOpenGraph>
|
|
1791
|
-
docs: Open Graph fields for the Page
|
|
1792
|
-
localeId:
|
|
1793
|
-
type: optional<string>
|
|
1794
|
-
docs: Unique ID of the page locale
|
|
1795
|
-
access: read-only
|
|
1796
|
-
publishedPath:
|
|
1797
|
-
type: optional<string>
|
|
1798
|
-
docs: Relative path of the published page URL
|
|
1799
|
-
access: read-only
|
|
1800
|
-
source:
|
|
1801
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1802
|
-
PageList:
|
|
1803
|
-
docs: The Page object
|
|
1804
|
-
properties:
|
|
1805
|
-
pages: optional<list<Page>>
|
|
1806
|
-
pagination: optional<Pagination>
|
|
1807
|
-
source:
|
|
1808
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1809
|
-
TextNodeText:
|
|
1810
|
-
docs: The text content of the node
|
|
1811
|
-
properties:
|
|
1812
|
-
html:
|
|
1813
|
-
type: optional<string>
|
|
1814
|
-
docs: The HTML content of the text node.
|
|
1815
|
-
text:
|
|
1816
|
-
type: optional<string>
|
|
1817
|
-
docs: The raw text content of the text node.
|
|
1818
|
-
source:
|
|
1819
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1820
|
-
inline: true
|
|
1821
|
-
TextNode:
|
|
1822
|
-
docs: >
|
|
1823
|
-
Represents text content within the DOM. It contains both the raw text and
|
|
1824
|
-
its HTML representation. Additional attributes can be associated with the
|
|
1825
|
-
text for styling or other purposes.
|
|
1826
|
-
properties:
|
|
1827
|
-
id:
|
|
1828
|
-
type: string
|
|
1829
|
-
docs: Node UUID
|
|
1830
|
-
text:
|
|
1831
|
-
type: TextNodeText
|
|
1832
|
-
docs: The text content of the node
|
|
1833
|
-
attributes:
|
|
1834
|
-
type: optional<map<string, string>>
|
|
1835
|
-
docs: The custom attributes of the node
|
|
1836
|
-
source:
|
|
1837
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1838
|
-
ImageNodeImage:
|
|
1839
|
-
docs: The image details of the node
|
|
1840
|
-
properties:
|
|
1841
|
-
alt: optional<string>
|
|
1842
|
-
assetId: optional<string>
|
|
1843
|
-
source:
|
|
1844
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1845
|
-
inline: true
|
|
1846
|
-
ImageNode:
|
|
1847
|
-
docs: >
|
|
1848
|
-
Represents an image within the DOM. It contains details about the image,
|
|
1849
|
-
such as its alternative text (alt) for accessibility and an asset
|
|
1850
|
-
identifier for fetching the actual image resource. Additional attributes
|
|
1851
|
-
can be associated with the image for styling or other purposes.
|
|
1852
|
-
properties:
|
|
1853
|
-
id:
|
|
1854
|
-
type: string
|
|
1855
|
-
docs: Node UUID
|
|
1856
|
-
image:
|
|
1857
|
-
type: ImageNodeImage
|
|
1858
|
-
docs: The image details of the node
|
|
1859
|
-
attributes:
|
|
1860
|
-
type: optional<map<string, string>>
|
|
1861
|
-
docs: The custom attributes of the node
|
|
1862
|
-
source:
|
|
1863
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1864
|
-
Text:
|
|
1865
|
-
docs: The text content of the node
|
|
1866
|
-
properties:
|
|
1867
|
-
html:
|
|
1868
|
-
type: optional<string>
|
|
1869
|
-
docs: The HTML content of the text node.
|
|
1870
|
-
text:
|
|
1871
|
-
type: optional<string>
|
|
1872
|
-
docs: The raw text content of the text node.
|
|
1873
|
-
source:
|
|
1874
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1875
|
-
ComponentPropertyType:
|
|
1876
|
-
enum:
|
|
1877
|
-
- value: Plain Text
|
|
1878
|
-
name: PlainText
|
|
1879
|
-
- value: Rich Text
|
|
1880
|
-
name: RichText
|
|
1881
|
-
- value: Alt Text
|
|
1882
|
-
name: AltText
|
|
1883
|
-
docs: The type of the property.
|
|
1884
|
-
inline: true
|
|
1885
|
-
source:
|
|
1886
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1887
|
-
ComponentProperty:
|
|
1888
|
-
docs: >
|
|
1889
|
-
Represents a property of a component instance in the DOM. A property
|
|
1890
|
-
contains a list of both the raw text and the HTML representation, allowing
|
|
1891
|
-
for flexibility in rendering and processing. Additional attributes can be
|
|
1892
|
-
associated with the text for styling or other purposes.
|
|
1893
|
-
properties:
|
|
1894
|
-
propertyId:
|
|
1895
|
-
type: optional<string>
|
|
1896
|
-
docs: The ID of the property.
|
|
1897
|
-
type:
|
|
1898
|
-
type: optional<ComponentPropertyType>
|
|
1899
|
-
docs: The type of the property.
|
|
1900
|
-
label:
|
|
1901
|
-
type: optional<string>
|
|
1902
|
-
docs: The label of the property in the UI.
|
|
1903
|
-
text:
|
|
1904
|
-
type: optional<Text>
|
|
1905
|
-
docs: >-
|
|
1906
|
-
Represents text content within the DOM. It contains both the raw text
|
|
1907
|
-
and its HTML representation.
|
|
1908
|
-
source:
|
|
1909
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1910
|
-
ComponentNode:
|
|
1911
|
-
docs: >
|
|
1912
|
-
Represents a component instance within the DOM. It contains details about
|
|
1913
|
-
the component instance, such as its type and properties.
|
|
1914
|
-
properties:
|
|
1915
|
-
id:
|
|
1916
|
-
type: string
|
|
1917
|
-
docs: The unique identifier of the component instance node
|
|
1918
|
-
componentId:
|
|
1919
|
-
type: string
|
|
1920
|
-
docs: The unique identifier of the component
|
|
1921
|
-
propertyOverrides:
|
|
1922
|
-
docs: List of component properties with overrides for a component instance.
|
|
1923
|
-
type: list<ComponentProperty>
|
|
1924
|
-
source:
|
|
1925
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1926
|
-
TextInputNode:
|
|
1927
|
-
docs: >
|
|
1928
|
-
Represents text input and textarea elements within the DOM. It contains
|
|
1929
|
-
the placeholder text in the input. Additional attributes can be associated
|
|
1930
|
-
with the text for styling or other purposes.
|
|
1931
|
-
properties:
|
|
1932
|
-
id:
|
|
1933
|
-
type: string
|
|
1934
|
-
docs: Node UUID
|
|
1935
|
-
placeholder:
|
|
1936
|
-
type: string
|
|
1937
|
-
docs: The placeholder text of the input node
|
|
1938
|
-
attributes:
|
|
1939
|
-
type: optional<map<string, string>>
|
|
1940
|
-
docs: The custom attributes of the node
|
|
1941
|
-
source:
|
|
1942
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1943
|
-
SelectNodeChoicesItem:
|
|
1944
|
-
properties:
|
|
1945
|
-
value:
|
|
1946
|
-
type: string
|
|
1947
|
-
docs: The value of the choice when selected.
|
|
1948
|
-
text:
|
|
1949
|
-
type: string
|
|
1950
|
-
docs: The text to display for the choice.
|
|
1951
|
-
source:
|
|
1952
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1953
|
-
inline: true
|
|
1954
|
-
SelectNode:
|
|
1955
|
-
docs: >
|
|
1956
|
-
Represents select elements within the DOM. It contains the list of choices
|
|
1957
|
-
in the select. Additional attributes can be associated with the text for
|
|
1958
|
-
styling or other purposes.
|
|
1959
|
-
properties:
|
|
1960
|
-
id:
|
|
1961
|
-
type: string
|
|
1962
|
-
docs: Node UUID
|
|
1963
|
-
choices:
|
|
1964
|
-
docs: The list of choices in this select node.
|
|
1965
|
-
type: list<SelectNodeChoicesItem>
|
|
1966
|
-
attributes:
|
|
1967
|
-
type: optional<map<string, string>>
|
|
1968
|
-
docs: The custom attributes of the node
|
|
1969
|
-
source:
|
|
1970
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1971
|
-
SubmitButtonNode:
|
|
1972
|
-
docs: >
|
|
1973
|
-
Represents submit button elements within the DOM. It contains the text and
|
|
1974
|
-
waiting text of the button. Additional attributes can be associated with
|
|
1975
|
-
the text for styling or other purposes.
|
|
1976
|
-
properties:
|
|
1977
|
-
id:
|
|
1978
|
-
type: string
|
|
1979
|
-
docs: Node UUID
|
|
1980
|
-
value:
|
|
1981
|
-
type: string
|
|
1982
|
-
docs: The text content of the submit button.
|
|
1983
|
-
waitingText:
|
|
1984
|
-
type: string
|
|
1985
|
-
docs: The text to show while the form is submitting.
|
|
1986
|
-
attributes:
|
|
1987
|
-
type: optional<map<string, string>>
|
|
1988
|
-
docs: The custom attributes of the node
|
|
1989
|
-
source:
|
|
1990
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
1991
|
-
SearchButtonNode:
|
|
1992
|
-
docs: >
|
|
1993
|
-
Represents search button elements within the DOM. It contains the text of
|
|
1994
|
-
the button. Additional attributes can be associated with the text for
|
|
1995
|
-
styling or other purposes.
|
|
1996
|
-
properties:
|
|
1997
|
-
id:
|
|
1998
|
-
type: string
|
|
1999
|
-
docs: Node UUID
|
|
2000
|
-
value:
|
|
2001
|
-
type: string
|
|
2002
|
-
docs: The text content of the search button.
|
|
2003
|
-
attributes:
|
|
2004
|
-
type: optional<map<string, string>>
|
|
2005
|
-
docs: The custom attributes of the node
|
|
2006
|
-
source:
|
|
2007
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2008
|
-
Node:
|
|
2009
|
-
discriminant: type
|
|
2010
|
-
base-properties: {}
|
|
2011
|
-
docs: >
|
|
2012
|
-
A generic representation of a content element within the Document Object
|
|
2013
|
-
Model (DOM). Each node has a unique identifier and a specific type that
|
|
2014
|
-
determines its content structure and attributes.
|
|
2015
|
-
union:
|
|
2016
|
-
text:
|
|
2017
|
-
type: TextNode
|
|
2018
|
-
image:
|
|
2019
|
-
type: ImageNode
|
|
2020
|
-
component-instance:
|
|
2021
|
-
type: ComponentNode
|
|
2022
|
-
text-input:
|
|
2023
|
-
type: TextInputNode
|
|
2024
|
-
select:
|
|
2025
|
-
type: SelectNode
|
|
2026
|
-
submit-button:
|
|
2027
|
-
type: SubmitButtonNode
|
|
2028
|
-
search-button:
|
|
2029
|
-
type: SearchButtonNode
|
|
2030
|
-
source:
|
|
2031
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2032
|
-
Dom:
|
|
2033
|
-
docs: >
|
|
2034
|
-
The DOM (Document Object Model) schema represents the content structure of
|
|
2035
|
-
a web page or component. It captures various content nodes along with
|
|
2036
|
-
their associated attributes. Each node has a unique identifier and can be
|
|
2037
|
-
of different types like text, image or component-instance. The schema also
|
|
2038
|
-
provides pagination details for scenarios where the content nodes are too
|
|
2039
|
-
many to be fetched in a single request.
|
|
2040
|
-
properties:
|
|
2041
|
-
pageId:
|
|
2042
|
-
type: optional<string>
|
|
2043
|
-
docs: Page ID
|
|
2044
|
-
branchId:
|
|
2045
|
-
type: optional<string>
|
|
2046
|
-
docs: >-
|
|
2047
|
-
The unique identifier of a [specific page
|
|
2048
|
-
branch.](https://help.webflow.com/hc/en-us/articles/33961355506195-Page-branching)
|
|
2049
|
-
nodes: optional<list<Node>>
|
|
2050
|
-
pagination: optional<Pagination>
|
|
2051
|
-
lastUpdated:
|
|
2052
|
-
type: optional<datetime>
|
|
2053
|
-
docs: The date the page dom was most recently updated
|
|
2054
|
-
access: read-only
|
|
2055
|
-
source:
|
|
2056
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2057
|
-
TextNodeWrite:
|
|
2058
|
-
docs: Update a text node
|
|
2059
|
-
properties:
|
|
2060
|
-
nodeId:
|
|
2061
|
-
type: string
|
|
2062
|
-
docs: Node UUID
|
|
2063
|
-
text:
|
|
2064
|
-
type: string
|
|
2065
|
-
docs: >-
|
|
2066
|
-
HTML content of the node, including the HTML tag. The HTML tags must
|
|
2067
|
-
be the same as what's returned from the Get Content endpoint.
|
|
2068
|
-
source:
|
|
2069
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2070
|
-
ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem:
|
|
2071
|
-
properties:
|
|
2072
|
-
propertyId:
|
|
2073
|
-
type: string
|
|
2074
|
-
docs: The ID of the property.
|
|
2075
|
-
text:
|
|
2076
|
-
type: string
|
|
2077
|
-
docs: >
|
|
2078
|
-
The new string or HTML value used to override the component instance
|
|
2079
|
-
property value.
|
|
2080
|
-
|
|
2081
|
-
The provided value must be compatible with the type of the component
|
|
2082
|
-
instance property.
|
|
2083
|
-
|
|
2084
|
-
For example, attempting to override a single-line plain-text property
|
|
2085
|
-
with a multi-line
|
|
2086
|
-
|
|
2087
|
-
value will result in an error.
|
|
2088
|
-
source:
|
|
2089
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2090
|
-
inline: true
|
|
2091
|
-
ComponentInstanceNodePropertyOverridesWrite:
|
|
2092
|
-
docs: Update text property overrides of a component instance
|
|
2093
|
-
properties:
|
|
2094
|
-
nodeId:
|
|
2095
|
-
type: string
|
|
2096
|
-
docs: Node UUID
|
|
2097
|
-
propertyOverrides:
|
|
2098
|
-
docs: >-
|
|
2099
|
-
A list of component instance properties to override within the
|
|
2100
|
-
specified secondary locale.
|
|
2101
|
-
type: list<ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem>
|
|
2102
|
-
source:
|
|
2103
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2104
|
-
SelectNodeWriteChoicesItem:
|
|
2105
|
-
properties:
|
|
2106
|
-
value:
|
|
2107
|
-
type: string
|
|
2108
|
-
docs: The value of the choice when selected.
|
|
2109
|
-
text:
|
|
2110
|
-
type: string
|
|
2111
|
-
docs: The text to display for the choice.
|
|
2112
|
-
source:
|
|
2113
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2114
|
-
inline: true
|
|
2115
|
-
Select:
|
|
2116
|
-
docs: Update choices on a select node
|
|
2117
|
-
properties:
|
|
2118
|
-
nodeId:
|
|
2119
|
-
type: string
|
|
2120
|
-
docs: Node UUID
|
|
2121
|
-
choices:
|
|
2122
|
-
docs: The list of choices to set on the select node.
|
|
2123
|
-
type: list<SelectNodeWriteChoicesItem>
|
|
2124
|
-
source:
|
|
2125
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2126
|
-
TextInputNodeWrite:
|
|
2127
|
-
docs: Update placeholder text on a text input node
|
|
2128
|
-
properties:
|
|
2129
|
-
nodeId:
|
|
2130
|
-
type: string
|
|
2131
|
-
docs: Node UUID
|
|
2132
|
-
placeholder:
|
|
2133
|
-
type: string
|
|
2134
|
-
docs: The placeholder text of the input node
|
|
2135
|
-
source:
|
|
2136
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2137
|
-
SubmitButtonNodeWrite:
|
|
2138
|
-
docs: Update a submit button node
|
|
2139
|
-
properties:
|
|
2140
|
-
nodeId:
|
|
2141
|
-
type: string
|
|
2142
|
-
docs: Node UUID
|
|
2143
|
-
value:
|
|
2144
|
-
type: optional<string>
|
|
2145
|
-
docs: The text content of the submit button.
|
|
2146
|
-
waitingText:
|
|
2147
|
-
type: optional<string>
|
|
2148
|
-
docs: The text to show while the form is submitting.
|
|
2149
|
-
source:
|
|
2150
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2151
|
-
SearchButtonNodeWrite:
|
|
2152
|
-
docs: Update a search button node
|
|
2153
|
-
properties:
|
|
2154
|
-
nodeId:
|
|
2155
|
-
type: string
|
|
2156
|
-
docs: Node UUID
|
|
2157
|
-
value:
|
|
2158
|
-
type: string
|
|
2159
|
-
docs: The text content of the search button.
|
|
2160
|
-
source:
|
|
2161
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2162
|
-
Component:
|
|
2163
|
-
docs: The Component object
|
|
2164
|
-
properties:
|
|
2165
|
-
id:
|
|
2166
|
-
type: string
|
|
2167
|
-
docs: Unique identifier for the Component
|
|
2168
|
-
name:
|
|
2169
|
-
type: optional<string>
|
|
2170
|
-
docs: Component Name
|
|
2171
|
-
access: read-only
|
|
2172
|
-
group:
|
|
2173
|
-
type: optional<string>
|
|
2174
|
-
docs: The group that the component belongs to
|
|
2175
|
-
access: read-only
|
|
2176
|
-
description:
|
|
2177
|
-
type: optional<string>
|
|
2178
|
-
docs: Component Description
|
|
2179
|
-
access: read-only
|
|
2180
|
-
readonly:
|
|
2181
|
-
type: optional<boolean>
|
|
2182
|
-
docs: >-
|
|
2183
|
-
Indicates whether the component is read-only. Components that cannot
|
|
2184
|
-
be updated within this Site are set to readonly. Workspace Libraries
|
|
2185
|
-
are a good example.
|
|
2186
|
-
access: read-only
|
|
2187
|
-
source:
|
|
2188
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2189
|
-
ComponentList:
|
|
2190
|
-
docs: List of Components on a site.
|
|
2191
|
-
properties:
|
|
2192
|
-
components: optional<list<Component>>
|
|
2193
|
-
pagination: optional<Pagination>
|
|
2194
|
-
source:
|
|
2195
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2196
|
-
ComponentDom:
|
|
2197
|
-
docs: >
|
|
2198
|
-
The Component DOM schema represents the content structure of a component.
|
|
2199
|
-
Similar to Page DOM, it captures various content nodes and their
|
|
2200
|
-
associated attributes, but specifically for a component's structure. Each
|
|
2201
|
-
node has a unique identifier and can contain text, images, select or text
|
|
2202
|
-
inputs, submit buttons, or nested component instances.
|
|
2203
|
-
properties:
|
|
2204
|
-
componentId:
|
|
2205
|
-
type: optional<string>
|
|
2206
|
-
docs: Component ID
|
|
2207
|
-
nodes: optional<list<Node>>
|
|
2208
|
-
pagination: optional<Pagination>
|
|
2209
|
-
source:
|
|
2210
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2211
|
-
ComponentProperties:
|
|
2212
|
-
docs: >
|
|
2213
|
-
The Component Properties schema represents a list of properties that store
|
|
2214
|
-
text content. Each property has a unique identifier and can be of
|
|
2215
|
-
different types like plain text or rich text. The schema also provides
|
|
2216
|
-
pagination details for scenarios where there more properties than the
|
|
2217
|
-
limit.
|
|
2218
|
-
properties:
|
|
2219
|
-
componentId:
|
|
2220
|
-
type: optional<string>
|
|
2221
|
-
docs: Component ID
|
|
2222
|
-
access: read-only
|
|
2223
|
-
properties: optional<list<ComponentProperty>>
|
|
2224
|
-
pagination: optional<Pagination>
|
|
2225
|
-
source:
|
|
2226
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2227
|
-
ScriptApplyLocation:
|
|
2228
|
-
enum:
|
|
2229
|
-
- header
|
|
2230
|
-
- footer
|
|
2231
|
-
docs: >-
|
|
2232
|
-
Location of the script, either in the header or footer of the published
|
|
2233
|
-
site
|
|
2234
|
-
default: header
|
|
2235
|
-
inline: true
|
|
2236
|
-
source:
|
|
2237
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2238
|
-
ScriptApply:
|
|
2239
|
-
properties:
|
|
2240
|
-
id:
|
|
2241
|
-
type: string
|
|
2242
|
-
docs: ID of the registered custom code script
|
|
2243
|
-
location:
|
|
2244
|
-
type: ScriptApplyLocation
|
|
2245
|
-
docs: >-
|
|
2246
|
-
Location of the script, either in the header or footer of the
|
|
2247
|
-
published site
|
|
2248
|
-
default: header
|
|
2249
|
-
version:
|
|
2250
|
-
type: string
|
|
2251
|
-
docs: Semantic Version String for the registered script *e.g. 0.0.1*
|
|
2252
|
-
attributes:
|
|
2253
|
-
type: optional<map<string, unknown>>
|
|
2254
|
-
docs: >-
|
|
2255
|
-
Developer-specified key/value pairs to be applied as attributes to the
|
|
2256
|
-
script
|
|
2257
|
-
source:
|
|
2258
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2259
|
-
ScriptApplyList:
|
|
2260
|
-
properties:
|
|
2261
|
-
scripts:
|
|
2262
|
-
type: optional<list<ScriptApply>>
|
|
2263
|
-
docs: A list of scripts applied to a Site or a Page
|
|
2264
|
-
lastUpdated:
|
|
2265
|
-
type: optional<string>
|
|
2266
|
-
docs: Date when the Site's scripts were last updated
|
|
2267
|
-
access: read-only
|
|
2268
|
-
createdOn:
|
|
2269
|
-
type: optional<string>
|
|
2270
|
-
docs: Date when the Site's scripts were created
|
|
2271
|
-
access: read-only
|
|
2272
|
-
source:
|
|
2273
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2274
|
-
CustomCodeHostedResponse:
|
|
2275
|
-
docs: Registered custom code for application
|
|
2276
|
-
properties:
|
|
2277
|
-
id:
|
|
2278
|
-
type: optional<string>
|
|
2279
|
-
docs: Human readable id, derived from the user-specified display name
|
|
2280
|
-
access: read-only
|
|
2281
|
-
canCopy:
|
|
2282
|
-
type: optional<boolean>
|
|
2283
|
-
docs: >-
|
|
2284
|
-
Define whether the script can be copied on site duplication and
|
|
2285
|
-
transfer
|
|
2286
|
-
default: false
|
|
2287
|
-
displayName:
|
|
2288
|
-
type: optional<string>
|
|
2289
|
-
docs: >-
|
|
2290
|
-
User-facing name for the script. Must be between 1 and 50 alphanumeric
|
|
2291
|
-
characters
|
|
2292
|
-
hostedLocation:
|
|
2293
|
-
type: optional<string>
|
|
2294
|
-
docs: URI for an externally hosted script location
|
|
2295
|
-
integrityHash:
|
|
2296
|
-
type: optional<string>
|
|
2297
|
-
docs: >-
|
|
2298
|
-
Sub-Resource Integrity Hash. Only required for externally hosted
|
|
2299
|
-
scripts (passed via hostedLocation)
|
|
2300
|
-
createdOn:
|
|
2301
|
-
type: optional<string>
|
|
2302
|
-
docs: Timestamp when the script version was created
|
|
2303
|
-
access: read-only
|
|
2304
|
-
lastUpdated:
|
|
2305
|
-
type: optional<string>
|
|
2306
|
-
docs: Timestamp when the script version was last updated
|
|
2307
|
-
access: read-only
|
|
2308
|
-
version:
|
|
2309
|
-
type: optional<string>
|
|
2310
|
-
docs: A Semantic Version (SemVer) string, denoting the version of the script
|
|
2311
|
-
source:
|
|
2312
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2313
|
-
RegisteredScriptList:
|
|
2314
|
-
docs: A list of scripts registered to the site
|
|
2315
|
-
properties:
|
|
2316
|
-
registeredScripts: optional<list<CustomCodeHostedResponse>>
|
|
2317
|
-
pagination: optional<Pagination>
|
|
2318
|
-
source:
|
|
2319
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2320
|
-
CustomCodeInlineResponse:
|
|
2321
|
-
docs: Registered custom code for application
|
|
2322
|
-
properties:
|
|
2323
|
-
id:
|
|
2324
|
-
type: optional<string>
|
|
2325
|
-
docs: Human readable id, derived from the user-specified display name
|
|
2326
|
-
access: read-only
|
|
2327
|
-
canCopy:
|
|
2328
|
-
type: optional<boolean>
|
|
2329
|
-
docs: >-
|
|
2330
|
-
Define whether the script can be copied on site duplication and
|
|
2331
|
-
transfer
|
|
2332
|
-
default: false
|
|
2333
|
-
displayName:
|
|
2334
|
-
type: optional<string>
|
|
2335
|
-
docs: >-
|
|
2336
|
-
User-facing name for the script. Must be between 1 and 50 alphanumeric
|
|
2337
|
-
characters
|
|
2338
|
-
hostedLocation:
|
|
2339
|
-
type: optional<string>
|
|
2340
|
-
docs: URI for an externally hosted script location
|
|
2341
|
-
integrityHash:
|
|
2342
|
-
type: optional<string>
|
|
2343
|
-
docs: >-
|
|
2344
|
-
Sub-Resource Integrity Hash. Only required for externally hosted
|
|
2345
|
-
scripts (passed via hostedLocation)
|
|
2346
|
-
createdOn:
|
|
2347
|
-
type: optional<string>
|
|
2348
|
-
docs: Timestamp when the script version was created
|
|
2349
|
-
access: read-only
|
|
2350
|
-
lastUpdated:
|
|
2351
|
-
type: optional<string>
|
|
2352
|
-
docs: Timestamp when the script version was last updated
|
|
2353
|
-
access: read-only
|
|
2354
|
-
version:
|
|
2355
|
-
type: optional<string>
|
|
2356
|
-
docs: A Semantic Version (SemVer) string, denoting the version of the script
|
|
2357
|
-
source:
|
|
2358
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2359
|
-
Scripts:
|
|
2360
|
-
docs: A list of scripts applied to a Site or a Page
|
|
2361
|
-
type: list<ScriptApply>
|
|
2362
|
-
CustomCodeBlockType:
|
|
2363
|
-
enum:
|
|
2364
|
-
- page
|
|
2365
|
-
- site
|
|
2366
|
-
docs: Whether the Custom Code script is applied at the Site-level or Page-level
|
|
2367
|
-
inline: true
|
|
2368
|
-
source:
|
|
2369
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2370
|
-
CustomCodeBlock:
|
|
2371
|
-
docs: A specific instance of Custom Code applied to a Site or Page
|
|
2372
|
-
properties:
|
|
2373
|
-
siteId:
|
|
2374
|
-
type: optional<string>
|
|
2375
|
-
docs: The Site ID where the custom code was applied
|
|
2376
|
-
pageId:
|
|
2377
|
-
type: optional<string>
|
|
2378
|
-
docs: The Page ID (if applied at Page-level)
|
|
2379
|
-
type:
|
|
2380
|
-
type: optional<CustomCodeBlockType>
|
|
2381
|
-
docs: >-
|
|
2382
|
-
Whether the Custom Code script is applied at the Site-level or
|
|
2383
|
-
Page-level
|
|
2384
|
-
scripts: optional<Scripts>
|
|
2385
|
-
createdOn:
|
|
2386
|
-
type: optional<datetime>
|
|
2387
|
-
docs: The date the Block was created
|
|
2388
|
-
access: read-only
|
|
2389
|
-
lastUpdated:
|
|
2390
|
-
type: optional<datetime>
|
|
2391
|
-
docs: The date the Block was most recently updated
|
|
2392
|
-
access: read-only
|
|
2393
|
-
source:
|
|
2394
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2395
|
-
ListCustomCodeBlocks:
|
|
2396
|
-
docs: Custom Code Blocks corresponding to where scripts were applied
|
|
2397
|
-
properties:
|
|
2398
|
-
blocks: optional<list<CustomCodeBlock>>
|
|
2399
|
-
pagination: optional<Pagination>
|
|
2400
|
-
source:
|
|
2401
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2402
|
-
AssetVariant:
|
|
2403
|
-
docs: Asset variant details
|
|
2404
|
-
properties:
|
|
2405
|
-
hostedUrl:
|
|
2406
|
-
type: string
|
|
2407
|
-
docs: URL of where the asset variant is hosted
|
|
2408
|
-
validation:
|
|
2409
|
-
format: uri
|
|
2410
|
-
originalFileName:
|
|
2411
|
-
type: string
|
|
2412
|
-
docs: Original file name of the variant
|
|
2413
|
-
displayName:
|
|
2414
|
-
type: string
|
|
2415
|
-
docs: Display name of the variant
|
|
2416
|
-
format:
|
|
2417
|
-
type: string
|
|
2418
|
-
docs: format of the variant
|
|
2419
|
-
width:
|
|
2420
|
-
type: integer
|
|
2421
|
-
docs: Width in pixels
|
|
2422
|
-
height:
|
|
2423
|
-
type: optional<integer>
|
|
2424
|
-
docs: Height in pixels
|
|
2425
|
-
quality:
|
|
2426
|
-
type: integer
|
|
2427
|
-
docs: Value between 0 and 100 representing the image quality
|
|
2428
|
-
error:
|
|
2429
|
-
type: optional<string>
|
|
2430
|
-
docs: Any associated validation errors
|
|
2431
|
-
source:
|
|
2432
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2433
|
-
Asset:
|
|
2434
|
-
docs: Asset details
|
|
2435
|
-
properties:
|
|
2436
|
-
id:
|
|
2437
|
-
type: optional<string>
|
|
2438
|
-
docs: Unique identifier for this asset
|
|
2439
|
-
access: read-only
|
|
2440
|
-
contentType:
|
|
2441
|
-
type: optional<string>
|
|
2442
|
-
docs: File format type
|
|
2443
|
-
access: read-only
|
|
2444
|
-
size:
|
|
2445
|
-
type: optional<integer>
|
|
2446
|
-
docs: size in bytes
|
|
2447
|
-
access: read-only
|
|
2448
|
-
siteId:
|
|
2449
|
-
type: optional<string>
|
|
2450
|
-
docs: Unique identifier for the site that hosts this asset
|
|
2451
|
-
access: read-only
|
|
2452
|
-
hostedUrl:
|
|
2453
|
-
type: optional<string>
|
|
2454
|
-
docs: Link to the asset
|
|
2455
|
-
validation:
|
|
2456
|
-
format: uri
|
|
2457
|
-
access: read-only
|
|
2458
|
-
originalFileName:
|
|
2459
|
-
type: optional<string>
|
|
2460
|
-
docs: Original file name at the time of upload
|
|
2461
|
-
access: read-only
|
|
2462
|
-
displayName:
|
|
2463
|
-
type: string
|
|
2464
|
-
docs: Display name of the asset
|
|
2465
|
-
lastUpdated:
|
|
2466
|
-
type: optional<datetime>
|
|
2467
|
-
docs: Date the asset metadata was last updated
|
|
2468
|
-
access: read-only
|
|
2469
|
-
createdOn:
|
|
2470
|
-
type: optional<datetime>
|
|
2471
|
-
docs: Date the asset metadata was created
|
|
2472
|
-
access: read-only
|
|
2473
|
-
variants:
|
|
2474
|
-
docs: >-
|
|
2475
|
-
A list of [asset
|
|
2476
|
-
variants](https://help.webflow.com/hc/en-us/articles/33961378697107-Responsive-images)
|
|
2477
|
-
created by Webflow to serve your site responsively.
|
|
2478
|
-
type: list<AssetVariant>
|
|
2479
|
-
altText:
|
|
2480
|
-
type: optional<string>
|
|
2481
|
-
docs: The visual description of the asset
|
|
2482
|
-
source:
|
|
2483
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2484
|
-
Assets:
|
|
2485
|
-
docs: A list of assets
|
|
2486
|
-
properties:
|
|
2487
|
-
assets: optional<list<Asset>>
|
|
2488
|
-
pagination: optional<Pagination>
|
|
2489
|
-
source:
|
|
2490
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2491
|
-
AssetUploadUploadDetails:
|
|
2492
|
-
docs: Metadata for uploading the asset binary
|
|
2493
|
-
properties:
|
|
2494
|
-
acl: optional<string>
|
|
2495
|
-
bucket: optional<string>
|
|
2496
|
-
X-Amz-Algorithm: optional<string>
|
|
2497
|
-
X-Amz-Credential: optional<string>
|
|
2498
|
-
X-Amz-Date: optional<string>
|
|
2499
|
-
key: optional<string>
|
|
2500
|
-
Policy: optional<string>
|
|
2501
|
-
X-Amz-Signature: optional<string>
|
|
2502
|
-
success_action_status: optional<string>
|
|
2503
|
-
content-type: optional<string>
|
|
2504
|
-
Cache-Control: optional<string>
|
|
2505
|
-
source:
|
|
2506
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2507
|
-
inline: true
|
|
2508
|
-
AssetUpload:
|
|
2509
|
-
properties:
|
|
2510
|
-
uploadDetails:
|
|
2511
|
-
type: optional<AssetUploadUploadDetails>
|
|
2512
|
-
docs: Metadata for uploading the asset binary
|
|
2513
|
-
contentType: optional<string>
|
|
2514
|
-
id: optional<string>
|
|
2515
|
-
parentFolder:
|
|
2516
|
-
type: optional<string>
|
|
2517
|
-
docs: Parent folder for the asset
|
|
2518
|
-
uploadUrl:
|
|
2519
|
-
type: optional<string>
|
|
2520
|
-
validation:
|
|
2521
|
-
format: uri
|
|
2522
|
-
assetUrl:
|
|
2523
|
-
type: optional<string>
|
|
2524
|
-
docs: S3 link to the asset
|
|
2525
|
-
validation:
|
|
2526
|
-
format: uri
|
|
2527
|
-
hostedUrl:
|
|
2528
|
-
type: optional<string>
|
|
2529
|
-
docs: Represents the link to the asset
|
|
2530
|
-
validation:
|
|
2531
|
-
format: uri
|
|
2532
|
-
originalFileName:
|
|
2533
|
-
type: optional<string>
|
|
2534
|
-
docs: >-
|
|
2535
|
-
Original file name when uploaded. If not specified at time of upload,
|
|
2536
|
-
it may be extracted from the raw file name
|
|
2537
|
-
createdOn:
|
|
2538
|
-
type: optional<datetime>
|
|
2539
|
-
docs: Date the asset metadata was created
|
|
2540
|
-
lastUpdated:
|
|
2541
|
-
type: optional<datetime>
|
|
2542
|
-
docs: Date the asset metadata was last updated
|
|
2543
|
-
source:
|
|
2544
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2545
|
-
AssetFolder:
|
|
2546
|
-
docs: Asset Folder details
|
|
2547
|
-
properties:
|
|
2548
|
-
id:
|
|
2549
|
-
type: optional<string>
|
|
2550
|
-
docs: Unique identifier for the Asset Folder
|
|
2551
|
-
displayName:
|
|
2552
|
-
type: optional<string>
|
|
2553
|
-
docs: User visible name for the Asset Folder
|
|
2554
|
-
parentFolder:
|
|
2555
|
-
type: optional<string>
|
|
2556
|
-
docs: Pointer to parent Asset Folder (or null if root)
|
|
2557
|
-
assets:
|
|
2558
|
-
type: optional<list<string>>
|
|
2559
|
-
docs: Array of Asset instances in the folder
|
|
2560
|
-
siteId:
|
|
2561
|
-
type: optional<string>
|
|
2562
|
-
docs: The unique ID of the site the Asset Folder belongs to
|
|
2563
|
-
createdOn:
|
|
2564
|
-
type: optional<datetime>
|
|
2565
|
-
docs: Date that the Asset Folder was created on
|
|
2566
|
-
lastUpdated:
|
|
2567
|
-
type: optional<datetime>
|
|
2568
|
-
docs: Date that the Asset Folder was last updated on
|
|
2569
|
-
source:
|
|
2570
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2571
|
-
AssetFolderList:
|
|
2572
|
-
docs: The Asset Folders object
|
|
2573
|
-
properties:
|
|
2574
|
-
assetFolders:
|
|
2575
|
-
type: optional<list<AssetFolder>>
|
|
2576
|
-
docs: A list of Asset folders
|
|
2577
|
-
pagination: optional<Pagination>
|
|
2578
|
-
source:
|
|
2579
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2580
|
-
TriggerType:
|
|
2581
|
-
enum:
|
|
2582
|
-
- form_submission
|
|
2583
|
-
- site_publish
|
|
2584
|
-
- page_created
|
|
2585
|
-
- page_metadata_updated
|
|
2586
|
-
- page_deleted
|
|
2587
|
-
- ecomm_new_order
|
|
2588
|
-
- ecomm_order_changed
|
|
2589
|
-
- ecomm_inventory_changed
|
|
2590
|
-
- user_account_added
|
|
2591
|
-
- user_account_updated
|
|
2592
|
-
- user_account_deleted
|
|
2593
|
-
- collection_item_created
|
|
2594
|
-
- collection_item_changed
|
|
2595
|
-
- collection_item_deleted
|
|
2596
|
-
- collection_item_published
|
|
2597
|
-
- collection_item_unpublished
|
|
2598
|
-
- comment_created
|
|
2599
|
-
docs: >
|
|
2600
|
-
The type of event that triggered the request. See the the documentation
|
|
2601
|
-
for details on [supported events](/data/reference/all-events).
|
|
2602
|
-
source:
|
|
2603
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2604
|
-
WebhookFilter:
|
|
2605
|
-
docs: >-
|
|
2606
|
-
Only supported for the `form_submission` trigger type. Filter for the form
|
|
2607
|
-
you want Webhooks to be sent for.
|
|
2608
|
-
properties:
|
|
2609
|
-
name:
|
|
2610
|
-
type: optional<string>
|
|
2611
|
-
docs: The name of the form you'd like to recieve notifications for.
|
|
2612
|
-
source:
|
|
2613
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2614
|
-
inline: true
|
|
2615
|
-
Webhook:
|
|
2616
|
-
properties:
|
|
2617
|
-
id:
|
|
2618
|
-
type: optional<string>
|
|
2619
|
-
docs: Unique identifier for the Webhook registration
|
|
2620
|
-
access: read-only
|
|
2621
|
-
triggerType: optional<TriggerType>
|
|
2622
|
-
url:
|
|
2623
|
-
type: optional<string>
|
|
2624
|
-
docs: URL to send the Webhook payload to
|
|
2625
|
-
workspaceId:
|
|
2626
|
-
type: optional<string>
|
|
2627
|
-
docs: Unique identifier for the Workspace the Webhook is registered in
|
|
2628
|
-
access: read-only
|
|
2629
|
-
siteId:
|
|
2630
|
-
type: optional<string>
|
|
2631
|
-
docs: Unique identifier for the Site the Webhook is registered in
|
|
2632
|
-
access: read-only
|
|
2633
|
-
filter:
|
|
2634
|
-
type: optional<WebhookFilter>
|
|
2635
|
-
docs: >-
|
|
2636
|
-
Only supported for the `form_submission` trigger type. Filter for the
|
|
2637
|
-
form you want Webhooks to be sent for.
|
|
2638
|
-
lastTriggered:
|
|
2639
|
-
type: optional<datetime>
|
|
2640
|
-
docs: Date the Webhook instance was last triggered
|
|
2641
|
-
access: read-only
|
|
2642
|
-
createdOn:
|
|
2643
|
-
type: optional<datetime>
|
|
2644
|
-
docs: Date the Webhook registration was created
|
|
2645
|
-
access: read-only
|
|
2646
|
-
source:
|
|
2647
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2648
|
-
WebhookList:
|
|
2649
|
-
properties:
|
|
2650
|
-
webhooks: optional<list<Webhook>>
|
|
2651
|
-
pagination: optional<Pagination>
|
|
2652
|
-
source:
|
|
2653
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2654
|
-
FormFieldValueType:
|
|
2655
|
-
enum:
|
|
2656
|
-
- Plain
|
|
2657
|
-
- Email
|
|
2658
|
-
- Password
|
|
2659
|
-
- Phone
|
|
2660
|
-
- Number
|
|
2661
|
-
docs: The field type
|
|
2662
|
-
inline: true
|
|
2663
|
-
source:
|
|
2664
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2665
|
-
FormFieldValue:
|
|
2666
|
-
docs: An object containing field info for a specific fieldID.
|
|
2667
|
-
properties:
|
|
2668
|
-
displayName:
|
|
2669
|
-
type: optional<string>
|
|
2670
|
-
docs: The field name displayed on the site
|
|
2671
|
-
type:
|
|
2672
|
-
type: optional<FormFieldValueType>
|
|
2673
|
-
docs: The field type
|
|
2674
|
-
placeholder:
|
|
2675
|
-
type: optional<string>
|
|
2676
|
-
docs: The placeholder text for the field
|
|
2677
|
-
userVisible:
|
|
2678
|
-
type: optional<boolean>
|
|
2679
|
-
docs: Whether the field is visible to the user
|
|
2680
|
-
source:
|
|
2681
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2682
|
-
inline: true
|
|
2683
|
-
FormField:
|
|
2684
|
-
type: map<string, FormFieldValue>
|
|
2685
|
-
docs: A collection of form fields with additional properties.
|
|
2686
|
-
FormResponseSettings:
|
|
2687
|
-
docs: Settings for form responses
|
|
2688
|
-
properties:
|
|
2689
|
-
redirectUrl:
|
|
2690
|
-
type: optional<string>
|
|
2691
|
-
docs: The url or path to redirect the user to after form submission
|
|
2692
|
-
redirectMethod:
|
|
2693
|
-
type: optional<string>
|
|
2694
|
-
docs: The HTTP request method to use for the redirectUrl (eg. POST or GET)
|
|
2695
|
-
redirectAction:
|
|
2696
|
-
type: optional<string>
|
|
2697
|
-
docs: The action to take after form submission
|
|
2698
|
-
sendEmailConfirmation:
|
|
2699
|
-
type: optional<boolean>
|
|
2700
|
-
docs: Whether to send an email confirmation to the user
|
|
2701
|
-
source:
|
|
2702
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2703
|
-
inline: true
|
|
2704
|
-
Form:
|
|
2705
|
-
docs: A Webflow form
|
|
2706
|
-
properties:
|
|
2707
|
-
displayName:
|
|
2708
|
-
type: optional<string>
|
|
2709
|
-
docs: The Form name displayed on the site
|
|
2710
|
-
createdOn:
|
|
2711
|
-
type: optional<datetime>
|
|
2712
|
-
docs: Date that the Form was created on
|
|
2713
|
-
lastUpdated:
|
|
2714
|
-
type: optional<datetime>
|
|
2715
|
-
docs: Date that the Form was last updated on
|
|
2716
|
-
fields:
|
|
2717
|
-
type: optional<FormField>
|
|
2718
|
-
docs: A collection of form field objects
|
|
2719
|
-
responseSettings:
|
|
2720
|
-
type: optional<FormResponseSettings>
|
|
2721
|
-
docs: Settings for form responses
|
|
2722
|
-
id:
|
|
2723
|
-
type: optional<string>
|
|
2724
|
-
docs: The unique ID for the Form
|
|
2725
|
-
siteId:
|
|
2726
|
-
type: optional<string>
|
|
2727
|
-
docs: The unique ID of the Site the Form belongs to
|
|
2728
|
-
siteDomainId:
|
|
2729
|
-
type: optional<string>
|
|
2730
|
-
docs: The unique ID corresponding to the site's Domain name
|
|
2731
|
-
pageId:
|
|
2732
|
-
type: optional<string>
|
|
2733
|
-
docs: The unique ID for the Page on which the Form is placed
|
|
2734
|
-
pageName:
|
|
2735
|
-
type: optional<string>
|
|
2736
|
-
docs: The user-visible name of the Page where the Form is placed
|
|
2737
|
-
formElementId:
|
|
2738
|
-
type: optional<string>
|
|
2739
|
-
docs: The unique ID of the Form element
|
|
2740
|
-
workspaceId:
|
|
2741
|
-
type: optional<string>
|
|
2742
|
-
docs: The unique ID of the Workspace the Site belongs to
|
|
2743
|
-
source:
|
|
2744
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2745
|
-
FormList:
|
|
2746
|
-
properties:
|
|
2747
|
-
forms: optional<list<Form>>
|
|
2748
|
-
pagination: optional<Pagination>
|
|
2749
|
-
source:
|
|
2750
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2751
|
-
FormSubmission:
|
|
2752
|
-
properties:
|
|
2753
|
-
id:
|
|
2754
|
-
type: optional<string>
|
|
2755
|
-
docs: The unique ID of the Form submission
|
|
2756
|
-
displayName:
|
|
2757
|
-
type: optional<string>
|
|
2758
|
-
docs: The Form name displayed on the site
|
|
2759
|
-
siteId:
|
|
2760
|
-
type: optional<string>
|
|
2761
|
-
docs: The unique ID of the Site the Form belongs to
|
|
2762
|
-
workspaceId:
|
|
2763
|
-
type: optional<string>
|
|
2764
|
-
docs: The unique ID of the Workspace the Site belongs to
|
|
2765
|
-
dateSubmitted:
|
|
2766
|
-
type: optional<datetime>
|
|
2767
|
-
docs: Date that the Form was submitted on
|
|
2768
|
-
formResponse:
|
|
2769
|
-
type: optional<map<string, unknown>>
|
|
2770
|
-
docs: The data submitted in the Form
|
|
2771
|
-
source:
|
|
2772
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2773
|
-
FormSubmissionList:
|
|
2774
|
-
properties:
|
|
2775
|
-
formSubmissions: optional<list<FormSubmission>>
|
|
2776
|
-
pagination: optional<Pagination>
|
|
2777
|
-
source:
|
|
2778
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2779
|
-
UserStatus:
|
|
2780
|
-
enum:
|
|
2781
|
-
- invited
|
|
2782
|
-
- verified
|
|
2783
|
-
- unverified
|
|
2784
|
-
docs: The status of the user
|
|
2785
|
-
source:
|
|
2786
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2787
|
-
UserAccessGroupsItemType:
|
|
2788
|
-
enum:
|
|
2789
|
-
- admin
|
|
2790
|
-
- ecommerce
|
|
2791
|
-
docs: |
|
|
2792
|
-
The type of access group based on how it was assigned to the user.
|
|
2793
|
-
* `admin` - Assigned to the user via API or in the designer
|
|
2794
|
-
* `ecommerce` - Assigned to the user via an ecommerce purchase
|
|
2795
|
-
inline: true
|
|
2796
|
-
source:
|
|
2797
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2798
|
-
UserAccessGroupsItem:
|
|
2799
|
-
docs: Access group slugs and types
|
|
2800
|
-
properties:
|
|
2801
|
-
slug:
|
|
2802
|
-
type: optional<string>
|
|
2803
|
-
docs: Access group identifier for APIs
|
|
2804
|
-
type:
|
|
2805
|
-
type: optional<UserAccessGroupsItemType>
|
|
2806
|
-
docs: |
|
|
2807
|
-
The type of access group based on how it was assigned to the user.
|
|
2808
|
-
* `admin` - Assigned to the user via API or in the designer
|
|
2809
|
-
* `ecommerce` - Assigned to the user via an ecommerce purchase
|
|
2810
|
-
source:
|
|
2811
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2812
|
-
UserDataData:
|
|
2813
|
-
properties:
|
|
2814
|
-
name:
|
|
2815
|
-
type: optional<string>
|
|
2816
|
-
docs: |
|
|
2817
|
-
The name of the user
|
|
2818
|
-
email:
|
|
2819
|
-
type: optional<string>
|
|
2820
|
-
docs: |
|
|
2821
|
-
The email address of the user
|
|
2822
|
-
accept-privacy:
|
|
2823
|
-
type: optional<boolean>
|
|
2824
|
-
docs: |
|
|
2825
|
-
Boolean indicating if the user has accepted the privacy policy
|
|
2826
|
-
accept-communications:
|
|
2827
|
-
type: optional<boolean>
|
|
2828
|
-
docs: |
|
|
2829
|
-
Boolean indicating if the user has accepted to receive communications
|
|
2830
|
-
additionalProperties:
|
|
2831
|
-
type: optional<string>
|
|
2832
|
-
docs: Custom user attributes
|
|
2833
|
-
source:
|
|
2834
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2835
|
-
inline: true
|
|
2836
|
-
UserData:
|
|
2837
|
-
docs: An object containing the User's basic info and custom fields
|
|
2838
|
-
properties:
|
|
2839
|
-
data: optional<UserDataData>
|
|
2840
|
-
source:
|
|
2841
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2842
|
-
User:
|
|
2843
|
-
docs: >
|
|
2844
|
-
The fields that define the schema for a given Item are based on the
|
|
2845
|
-
Collection that Item belongs to. Beyond the user defined fields, there are
|
|
2846
|
-
a handful of additional fields that are automatically created for all
|
|
2847
|
-
items
|
|
2848
|
-
properties:
|
|
2849
|
-
id:
|
|
2850
|
-
type: optional<string>
|
|
2851
|
-
docs: Unique identifier for the User
|
|
2852
|
-
access: read-only
|
|
2853
|
-
isEmailVerified:
|
|
2854
|
-
type: optional<boolean>
|
|
2855
|
-
docs: Shows whether the user has verified their email address
|
|
2856
|
-
access: read-only
|
|
2857
|
-
lastUpdated:
|
|
2858
|
-
type: optional<datetime>
|
|
2859
|
-
docs: The timestamp the user was updated
|
|
2860
|
-
access: read-only
|
|
2861
|
-
invitedOn:
|
|
2862
|
-
type: optional<datetime>
|
|
2863
|
-
docs: The timestamp the user was invited
|
|
2864
|
-
access: read-only
|
|
2865
|
-
createdOn:
|
|
2866
|
-
type: optional<datetime>
|
|
2867
|
-
docs: The timestamp the user was created
|
|
2868
|
-
access: read-only
|
|
2869
|
-
lastLogin:
|
|
2870
|
-
type: optional<datetime>
|
|
2871
|
-
docs: The timestamp the user was logged in
|
|
2872
|
-
access: read-only
|
|
2873
|
-
status: optional<UserStatus>
|
|
2874
|
-
accessGroups:
|
|
2875
|
-
type: optional<list<UserAccessGroupsItem>>
|
|
2876
|
-
docs: Access groups the user belongs to
|
|
2877
|
-
data: optional<UserData>
|
|
2878
|
-
source:
|
|
2879
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2880
|
-
UserList:
|
|
2881
|
-
docs: The list users results
|
|
2882
|
-
properties:
|
|
2883
|
-
count:
|
|
2884
|
-
type: optional<double>
|
|
2885
|
-
docs: Number of users returned
|
|
2886
|
-
limit:
|
|
2887
|
-
type: optional<double>
|
|
2888
|
-
docs: The limit specified in the request
|
|
2889
|
-
default: 10
|
|
2890
|
-
offset:
|
|
2891
|
-
type: optional<double>
|
|
2892
|
-
docs: The offset specified for pagination
|
|
2893
|
-
default: 0
|
|
2894
|
-
total:
|
|
2895
|
-
type: optional<double>
|
|
2896
|
-
docs: Total number of users in the collection
|
|
2897
|
-
users:
|
|
2898
|
-
type: optional<list<User>>
|
|
2899
|
-
docs: List of Users for a Site
|
|
2900
|
-
source:
|
|
2901
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2902
|
-
UsersNotEnabled: unknown
|
|
2903
|
-
DuplicateUserEmail: unknown
|
|
2904
|
-
UserLimitReached: unknown
|
|
2905
|
-
AccessGroup:
|
|
2906
|
-
properties:
|
|
2907
|
-
id:
|
|
2908
|
-
type: optional<string>
|
|
2909
|
-
docs: Unique identifier for the Access Group
|
|
2910
|
-
name:
|
|
2911
|
-
type: optional<string>
|
|
2912
|
-
docs: Name of the the Access Group
|
|
2913
|
-
shortId:
|
|
2914
|
-
type: optional<string>
|
|
2915
|
-
docs: >-
|
|
2916
|
-
Shortened unique identifier based on name, optimized for its use in
|
|
2917
|
-
the user’s JWT
|
|
2918
|
-
slug:
|
|
2919
|
-
type: optional<string>
|
|
2920
|
-
docs: >-
|
|
2921
|
-
Shortened unique identifier based on name, optimized for human
|
|
2922
|
-
readability and public API use
|
|
2923
|
-
createdOn:
|
|
2924
|
-
type: optional<datetime>
|
|
2925
|
-
docs: The date the Access Group was created
|
|
2926
|
-
source:
|
|
2927
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2928
|
-
AccessGroupList:
|
|
2929
|
-
docs: The list access groups results
|
|
2930
|
-
properties:
|
|
2931
|
-
count:
|
|
2932
|
-
type: optional<double>
|
|
2933
|
-
docs: Number of access groups returned
|
|
2934
|
-
limit:
|
|
2935
|
-
type: optional<double>
|
|
2936
|
-
docs: The limit specified in the request
|
|
2937
|
-
default: 10
|
|
2938
|
-
offset:
|
|
2939
|
-
type: optional<double>
|
|
2940
|
-
docs: The offset specified for pagination
|
|
2941
|
-
default: 0
|
|
2942
|
-
total:
|
|
2943
|
-
type: optional<double>
|
|
2944
|
-
docs: Total number of access groups in the collection
|
|
2945
|
-
accessGroups:
|
|
2946
|
-
type: optional<list<AccessGroup>>
|
|
2947
|
-
docs: List of Site Access Groups
|
|
2948
|
-
source:
|
|
2949
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2950
|
-
SkuPropertyListEnumItem:
|
|
2951
|
-
docs: Enumerated Product variants/Options for the SKU
|
|
2952
|
-
properties:
|
|
2953
|
-
id:
|
|
2954
|
-
type: string
|
|
2955
|
-
docs: Unique identifier for a Product variant/Option
|
|
2956
|
-
name:
|
|
2957
|
-
type: string
|
|
2958
|
-
docs: Name of the Product variant/Option
|
|
2959
|
-
slug:
|
|
2960
|
-
type: string
|
|
2961
|
-
docs: Slug for the Product variant/Option in the Site URL structure
|
|
2962
|
-
source:
|
|
2963
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2964
|
-
inline: true
|
|
2965
|
-
SkuPropertyList:
|
|
2966
|
-
docs: A variant/option type for a SKU
|
|
2967
|
-
properties:
|
|
2968
|
-
id:
|
|
2969
|
-
type: string
|
|
2970
|
-
docs: Unique identifier for a collection of Product Variants
|
|
2971
|
-
name:
|
|
2972
|
-
type: string
|
|
2973
|
-
docs: Name of the collection of Product Variants
|
|
2974
|
-
enum:
|
|
2975
|
-
docs: >-
|
|
2976
|
-
The individual Product variants that are contained within the
|
|
2977
|
-
collection
|
|
2978
|
-
type: list<SkuPropertyListEnumItem>
|
|
2979
|
-
source:
|
|
2980
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
2981
|
-
ProductFieldDataTaxCategory:
|
|
2982
|
-
enum:
|
|
2983
|
-
- value: standard-taxable
|
|
2984
|
-
name: StandardTaxable
|
|
2985
|
-
- value: standard-exempt
|
|
2986
|
-
name: StandardExempt
|
|
2987
|
-
- value: books-religious
|
|
2988
|
-
name: BooksReligious
|
|
2989
|
-
- value: books-textbook
|
|
2990
|
-
name: BooksTextbook
|
|
2991
|
-
- clothing
|
|
2992
|
-
- value: clothing-swimwear
|
|
2993
|
-
name: ClothingSwimwear
|
|
2994
|
-
- value: digital-goods
|
|
2995
|
-
name: DigitalGoods
|
|
2996
|
-
- value: digital-service
|
|
2997
|
-
name: DigitalService
|
|
2998
|
-
- value: drugs-non-prescription
|
|
2999
|
-
name: DrugsNonPrescription
|
|
3000
|
-
- value: drugs-prescription
|
|
3001
|
-
name: DrugsPrescription
|
|
3002
|
-
- value: food-bottled-water
|
|
3003
|
-
name: FoodBottledWater
|
|
3004
|
-
- value: food-candy
|
|
3005
|
-
name: FoodCandy
|
|
3006
|
-
- value: food-groceries
|
|
3007
|
-
name: FoodGroceries
|
|
3008
|
-
- value: food-prepared
|
|
3009
|
-
name: FoodPrepared
|
|
3010
|
-
- value: food-soda
|
|
3011
|
-
name: FoodSoda
|
|
3012
|
-
- value: food-supplements
|
|
3013
|
-
name: FoodSupplements
|
|
3014
|
-
- value: magazine-individual
|
|
3015
|
-
name: MagazineIndividual
|
|
3016
|
-
- value: magazine-subscription
|
|
3017
|
-
name: MagazineSubscription
|
|
3018
|
-
- value: service-admission
|
|
3019
|
-
name: ServiceAdmission
|
|
3020
|
-
- value: service-advertising
|
|
3021
|
-
name: ServiceAdvertising
|
|
3022
|
-
- value: service-dry-cleaning
|
|
3023
|
-
name: ServiceDryCleaning
|
|
3024
|
-
- value: service-hairdressing
|
|
3025
|
-
name: ServiceHairdressing
|
|
3026
|
-
- value: service-installation
|
|
3027
|
-
name: ServiceInstallation
|
|
3028
|
-
- value: service-miscellaneous
|
|
3029
|
-
name: ServiceMiscellaneous
|
|
3030
|
-
- value: service-parking
|
|
3031
|
-
name: ServiceParking
|
|
3032
|
-
- value: service-printing
|
|
3033
|
-
name: ServicePrinting
|
|
3034
|
-
- value: service-professional
|
|
3035
|
-
name: ServiceProfessional
|
|
3036
|
-
- value: service-repair
|
|
3037
|
-
name: ServiceRepair
|
|
3038
|
-
- value: service-training
|
|
3039
|
-
name: ServiceTraining
|
|
3040
|
-
docs: Product tax class
|
|
3041
|
-
inline: true
|
|
3042
|
-
source:
|
|
3043
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3044
|
-
ProductFieldDataEcProductType:
|
|
3045
|
-
enum:
|
|
3046
|
-
- ff42fee0113744f693a764e3431a9cc2
|
|
3047
|
-
- f22027db68002190aef89a4a2b7ac8a1
|
|
3048
|
-
- c599e43b1a1c34d5a323aedf75d3adf6
|
|
3049
|
-
- b6ccc1830db4b1babeb06a9ac5f6dd76
|
|
3050
|
-
docs: >-
|
|
3051
|
-
<a
|
|
3052
|
-
href="https://university.webflow.com/lesson/add-and-manage-products-and-categories?topics=ecommerce#how-to-understand-product-types">Product
|
|
3053
|
-
types.</a> Enums reflect the following values in order: Physical, Digital,
|
|
3054
|
-
Service, Advanced"
|
|
3055
|
-
inline: true
|
|
3056
|
-
source:
|
|
3057
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3058
|
-
ProductFieldData:
|
|
3059
|
-
docs: >-
|
|
3060
|
-
Contains content-specific details for a product, covering both standard
|
|
3061
|
-
(e.g., title, description) and custom fields tailored to the product
|
|
3062
|
-
setup.
|
|
3063
|
-
properties:
|
|
3064
|
-
name:
|
|
3065
|
-
type: optional<string>
|
|
3066
|
-
docs: Name of the Product
|
|
3067
|
-
slug:
|
|
3068
|
-
type: optional<string>
|
|
3069
|
-
docs: URL structure of the Product in your site.
|
|
3070
|
-
description:
|
|
3071
|
-
type: optional<string>
|
|
3072
|
-
docs: A description of your product
|
|
3073
|
-
shippable:
|
|
3074
|
-
type: optional<boolean>
|
|
3075
|
-
docs: Boolean determining if the Product is shippable
|
|
3076
|
-
sku-properties:
|
|
3077
|
-
type: optional<list<SkuPropertyList>>
|
|
3078
|
-
docs: Variant types to include in SKUs
|
|
3079
|
-
category:
|
|
3080
|
-
type: optional<list<string>>
|
|
3081
|
-
docs: The category your product belongs to.
|
|
3082
|
-
tax-category:
|
|
3083
|
-
type: optional<ProductFieldDataTaxCategory>
|
|
3084
|
-
docs: Product tax class
|
|
3085
|
-
default-sku:
|
|
3086
|
-
type: optional<string>
|
|
3087
|
-
docs: The default SKU associated with this product.
|
|
3088
|
-
ec-product-type:
|
|
3089
|
-
type: optional<ProductFieldDataEcProductType>
|
|
3090
|
-
docs: >-
|
|
3091
|
-
<a
|
|
3092
|
-
href="https://university.webflow.com/lesson/add-and-manage-products-and-categories?topics=ecommerce#how-to-understand-product-types">Product
|
|
3093
|
-
types.</a> Enums reflect the following values in order: Physical,
|
|
3094
|
-
Digital, Service, Advanced"
|
|
3095
|
-
source:
|
|
3096
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3097
|
-
Product:
|
|
3098
|
-
docs: The Product object
|
|
3099
|
-
properties:
|
|
3100
|
-
id:
|
|
3101
|
-
type: optional<string>
|
|
3102
|
-
docs: Unique identifier for the Product
|
|
3103
|
-
access: read-only
|
|
3104
|
-
cmsLocaleId:
|
|
3105
|
-
type: optional<string>
|
|
3106
|
-
docs: Identifier for the locale of the CMS item
|
|
3107
|
-
access: read-only
|
|
3108
|
-
lastPublished:
|
|
3109
|
-
type: optional<datetime>
|
|
3110
|
-
docs: The date the Product was last published
|
|
3111
|
-
access: read-only
|
|
3112
|
-
lastUpdated:
|
|
3113
|
-
type: optional<datetime>
|
|
3114
|
-
docs: The date the Product was last updated
|
|
3115
|
-
access: read-only
|
|
3116
|
-
createdOn:
|
|
3117
|
-
type: optional<datetime>
|
|
3118
|
-
docs: The date the Product was created
|
|
3119
|
-
access: read-only
|
|
3120
|
-
isArchived:
|
|
3121
|
-
type: optional<boolean>
|
|
3122
|
-
docs: Boolean determining if the Product is set to archived
|
|
3123
|
-
default: false
|
|
3124
|
-
isDraft:
|
|
3125
|
-
type: optional<boolean>
|
|
3126
|
-
docs: Boolean determining if the Product is set to draft
|
|
3127
|
-
default: false
|
|
3128
|
-
fieldData: optional<ProductFieldData>
|
|
3129
|
-
source:
|
|
3130
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3131
|
-
SkuValueList:
|
|
3132
|
-
type: map<string, string>
|
|
3133
|
-
docs: >
|
|
3134
|
-
A mapping between SKU properties and their values, represented as
|
|
3135
|
-
key-value pairs. Each key represents a SKU Property ID (e.g. "color") and
|
|
3136
|
-
maps to its corresponding SKU Value ID (e.g. "blue"). This structure
|
|
3137
|
-
defines the specific variant combination for a SKU.
|
|
3138
|
-
SkuFieldDataPrice:
|
|
3139
|
-
docs: price of SKU
|
|
3140
|
-
properties:
|
|
3141
|
-
value:
|
|
3142
|
-
type: optional<double>
|
|
3143
|
-
docs: Price of SKU
|
|
3144
|
-
unit:
|
|
3145
|
-
type: optional<string>
|
|
3146
|
-
docs: Currency of Item
|
|
3147
|
-
currency:
|
|
3148
|
-
type: optional<string>
|
|
3149
|
-
docs: Currency of Item (alternative representation)
|
|
3150
|
-
source:
|
|
3151
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3152
|
-
inline: true
|
|
3153
|
-
SkuFieldDataCompareAtPrice:
|
|
3154
|
-
docs: comparison price of SKU
|
|
3155
|
-
properties:
|
|
3156
|
-
value:
|
|
3157
|
-
type: optional<double>
|
|
3158
|
-
docs: Price of SKU
|
|
3159
|
-
unit:
|
|
3160
|
-
type: optional<string>
|
|
3161
|
-
docs: Currency of Item
|
|
3162
|
-
source:
|
|
3163
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3164
|
-
inline: true
|
|
3165
|
-
SkuFieldDataEcSkuBillingMethod:
|
|
3166
|
-
enum:
|
|
3167
|
-
- value: one-time
|
|
3168
|
-
name: OneTime
|
|
3169
|
-
- subscription
|
|
3170
|
-
docs: >-
|
|
3171
|
-
[Billing
|
|
3172
|
-
method](https://help.webflow.com/hc/en-us/articles/33961432087955-Add-and-manage-products-and-categories#billing-methods)for
|
|
3173
|
-
the SKU
|
|
3174
|
-
inline: true
|
|
3175
|
-
source:
|
|
3176
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3177
|
-
SkuFieldDataEcSkuSubscriptionPlanInterval:
|
|
3178
|
-
enum:
|
|
3179
|
-
- day
|
|
3180
|
-
- week
|
|
3181
|
-
- month
|
|
3182
|
-
- year
|
|
3183
|
-
docs: Interval of subscription renewal
|
|
3184
|
-
inline: true
|
|
3185
|
-
source:
|
|
3186
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3187
|
-
SkuFieldDataEcSkuSubscriptionPlanPlansItemStatus:
|
|
3188
|
-
enum:
|
|
3189
|
-
- active
|
|
3190
|
-
- inactive
|
|
3191
|
-
- canceled
|
|
3192
|
-
docs: The status of the plan
|
|
3193
|
-
inline: true
|
|
3194
|
-
source:
|
|
3195
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3196
|
-
SkuFieldDataEcSkuSubscriptionPlanPlansItem:
|
|
3197
|
-
properties:
|
|
3198
|
-
platform:
|
|
3199
|
-
type: optional<literal<"stripe">>
|
|
3200
|
-
docs: The platform of the subscription plan
|
|
3201
|
-
id:
|
|
3202
|
-
type: optional<string>
|
|
3203
|
-
docs: The unique identifier of the plan
|
|
3204
|
-
status:
|
|
3205
|
-
type: optional<SkuFieldDataEcSkuSubscriptionPlanPlansItemStatus>
|
|
3206
|
-
docs: The status of the plan
|
|
3207
|
-
source:
|
|
3208
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3209
|
-
inline: true
|
|
3210
|
-
SkuFieldDataEcSkuSubscriptionPlan:
|
|
3211
|
-
docs: >-
|
|
3212
|
-
[Subscription
|
|
3213
|
-
plan](https://help.webflow.com/hc/en-us/articles/33961432087955-Add-and-manage-products-and-categories#subscription)
|
|
3214
|
-
for the SKU
|
|
3215
|
-
properties:
|
|
3216
|
-
interval:
|
|
3217
|
-
type: optional<SkuFieldDataEcSkuSubscriptionPlanInterval>
|
|
3218
|
-
docs: Interval of subscription renewal
|
|
3219
|
-
frequency:
|
|
3220
|
-
type: optional<double>
|
|
3221
|
-
docs: Frequncy of billing within interval
|
|
3222
|
-
trial:
|
|
3223
|
-
type: optional<double>
|
|
3224
|
-
docs: Number of days of a trial
|
|
3225
|
-
plans:
|
|
3226
|
-
type: optional<list<SkuFieldDataEcSkuSubscriptionPlanPlansItem>>
|
|
3227
|
-
access: read-only
|
|
3228
|
-
source:
|
|
3229
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3230
|
-
inline: true
|
|
3231
|
-
SkuFieldData:
|
|
3232
|
-
docs: Standard and Custom fields for a SKU
|
|
3233
|
-
properties:
|
|
3234
|
-
sku-values: optional<SkuValueList>
|
|
3235
|
-
name:
|
|
3236
|
-
type: string
|
|
3237
|
-
docs: Name of the Product
|
|
3238
|
-
slug:
|
|
3239
|
-
type: string
|
|
3240
|
-
docs: URL structure of the Product in your site.
|
|
3241
|
-
price:
|
|
3242
|
-
type: SkuFieldDataPrice
|
|
3243
|
-
docs: price of SKU
|
|
3244
|
-
compare-at-price:
|
|
3245
|
-
type: optional<SkuFieldDataCompareAtPrice>
|
|
3246
|
-
docs: comparison price of SKU
|
|
3247
|
-
ec-sku-billing-method:
|
|
3248
|
-
type: optional<SkuFieldDataEcSkuBillingMethod>
|
|
3249
|
-
docs: >-
|
|
3250
|
-
[Billing
|
|
3251
|
-
method](https://help.webflow.com/hc/en-us/articles/33961432087955-Add-and-manage-products-and-categories#billing-methods)for
|
|
3252
|
-
the SKU
|
|
3253
|
-
ec-sku-subscription-plan:
|
|
3254
|
-
type: optional<SkuFieldDataEcSkuSubscriptionPlan>
|
|
3255
|
-
docs: >-
|
|
3256
|
-
[Subscription
|
|
3257
|
-
plan](https://help.webflow.com/hc/en-us/articles/33961432087955-Add-and-manage-products-and-categories#subscription)
|
|
3258
|
-
for the SKU
|
|
3259
|
-
main-image:
|
|
3260
|
-
type: optional<string>
|
|
3261
|
-
docs: The URL for the main image of the SKU
|
|
3262
|
-
sku:
|
|
3263
|
-
type: optional<string>
|
|
3264
|
-
docs: A unique identifier for the SKU
|
|
3265
|
-
sku-properties:
|
|
3266
|
-
type: optional<list<SkuPropertyList>>
|
|
3267
|
-
docs: The properties of the SKU
|
|
3268
|
-
source:
|
|
3269
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3270
|
-
Sku:
|
|
3271
|
-
docs: The SKU object
|
|
3272
|
-
properties:
|
|
3273
|
-
id:
|
|
3274
|
-
type: optional<string>
|
|
3275
|
-
docs: Unique identifier for the Product
|
|
3276
|
-
access: read-only
|
|
3277
|
-
cmsLocaleId:
|
|
3278
|
-
type: optional<string>
|
|
3279
|
-
docs: Identifier for the locale of the CMS item
|
|
3280
|
-
access: read-only
|
|
3281
|
-
lastPublished:
|
|
3282
|
-
type: optional<datetime>
|
|
3283
|
-
docs: The date the Product was last published
|
|
3284
|
-
access: read-only
|
|
3285
|
-
lastUpdated:
|
|
3286
|
-
type: optional<datetime>
|
|
3287
|
-
docs: The date the Product was last updated
|
|
3288
|
-
access: read-only
|
|
3289
|
-
createdOn:
|
|
3290
|
-
type: optional<datetime>
|
|
3291
|
-
docs: The date the Product was created
|
|
3292
|
-
access: read-only
|
|
3293
|
-
fieldData: optional<SkuFieldData>
|
|
3294
|
-
source:
|
|
3295
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3296
|
-
ProductAndSkUs:
|
|
3297
|
-
docs: A product and its SKUs.
|
|
3298
|
-
properties:
|
|
3299
|
-
product: optional<Product>
|
|
3300
|
-
skus:
|
|
3301
|
-
type: optional<list<Sku>>
|
|
3302
|
-
docs: A list of SKU Objects
|
|
3303
|
-
source:
|
|
3304
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3305
|
-
ProductAndSkUsList:
|
|
3306
|
-
docs: Results from product list
|
|
3307
|
-
properties:
|
|
3308
|
-
items:
|
|
3309
|
-
type: optional<list<ProductAndSkUs>>
|
|
3310
|
-
docs: >-
|
|
3311
|
-
List of Item objects within the Collection. Contains product and skus
|
|
3312
|
-
keys for each Item
|
|
3313
|
-
pagination: optional<Pagination>
|
|
3314
|
-
source:
|
|
3315
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3316
|
-
PublishStatus:
|
|
3317
|
-
enum:
|
|
3318
|
-
- staging
|
|
3319
|
-
- live
|
|
3320
|
-
docs: Indicate whether your Product should be set as "staging" or "live"
|
|
3321
|
-
default: staging
|
|
3322
|
-
source:
|
|
3323
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3324
|
-
OrderPrice:
|
|
3325
|
-
properties:
|
|
3326
|
-
unit:
|
|
3327
|
-
type: optional<string>
|
|
3328
|
-
docs: The three-letter ISO currency code
|
|
3329
|
-
value:
|
|
3330
|
-
type: optional<string>
|
|
3331
|
-
docs: The numeric value in the base unit of the currency
|
|
3332
|
-
string:
|
|
3333
|
-
type: optional<string>
|
|
3334
|
-
docs: The user-facing string representation of the amount
|
|
3335
|
-
source:
|
|
3336
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3337
|
-
OrderAddressType:
|
|
3338
|
-
enum:
|
|
3339
|
-
- shipping
|
|
3340
|
-
- billing
|
|
3341
|
-
docs: The type of the order address (billing or shipping)
|
|
3342
|
-
inline: true
|
|
3343
|
-
source:
|
|
3344
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3345
|
-
OrderAddressJapanType:
|
|
3346
|
-
enum:
|
|
3347
|
-
- kana
|
|
3348
|
-
- kanji
|
|
3349
|
-
docs: >-
|
|
3350
|
-
Represents a Japan-only address format. This field will only appear on
|
|
3351
|
-
orders placed from Japan.
|
|
3352
|
-
inline: true
|
|
3353
|
-
source:
|
|
3354
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3355
|
-
OrderAddress:
|
|
3356
|
-
docs: A customer address
|
|
3357
|
-
properties:
|
|
3358
|
-
type:
|
|
3359
|
-
type: optional<OrderAddressType>
|
|
3360
|
-
docs: The type of the order address (billing or shipping)
|
|
3361
|
-
japanType:
|
|
3362
|
-
type: optional<OrderAddressJapanType>
|
|
3363
|
-
docs: >-
|
|
3364
|
-
Represents a Japan-only address format. This field will only appear on
|
|
3365
|
-
orders placed from Japan.
|
|
3366
|
-
addressee:
|
|
3367
|
-
type: optional<string>
|
|
3368
|
-
docs: Display name on the address
|
|
3369
|
-
line1:
|
|
3370
|
-
type: optional<string>
|
|
3371
|
-
docs: The first line of the address
|
|
3372
|
-
line2:
|
|
3373
|
-
type: optional<string>
|
|
3374
|
-
docs: The second line of the address
|
|
3375
|
-
city:
|
|
3376
|
-
type: optional<string>
|
|
3377
|
-
docs: The city of the address.
|
|
3378
|
-
state:
|
|
3379
|
-
type: optional<string>
|
|
3380
|
-
docs: The state or province of the address
|
|
3381
|
-
country:
|
|
3382
|
-
type: optional<string>
|
|
3383
|
-
docs: The country of the address
|
|
3384
|
-
postalCode:
|
|
3385
|
-
type: optional<string>
|
|
3386
|
-
docs: The postal code of the address
|
|
3387
|
-
source:
|
|
3388
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3389
|
-
OrderPurchasedItemVariantImageFileVariantsItem:
|
|
3390
|
-
properties:
|
|
3391
|
-
url:
|
|
3392
|
-
type: optional<string>
|
|
3393
|
-
docs: The hosted location for the Variant's image
|
|
3394
|
-
validation:
|
|
3395
|
-
format: uri
|
|
3396
|
-
originalFileName: optional<string>
|
|
3397
|
-
size:
|
|
3398
|
-
type: optional<double>
|
|
3399
|
-
docs: The image size in bytes
|
|
3400
|
-
width:
|
|
3401
|
-
type: optional<integer>
|
|
3402
|
-
docs: The image width in pixels
|
|
3403
|
-
height:
|
|
3404
|
-
type: optional<integer>
|
|
3405
|
-
docs: The image height in pixels
|
|
3406
|
-
source:
|
|
3407
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3408
|
-
inline: true
|
|
3409
|
-
OrderPurchasedItemVariantImageFile:
|
|
3410
|
-
properties:
|
|
3411
|
-
size:
|
|
3412
|
-
type: optional<double>
|
|
3413
|
-
docs: The image size in bytes
|
|
3414
|
-
originalFileName:
|
|
3415
|
-
type: optional<string>
|
|
3416
|
-
docs: the original name of the image
|
|
3417
|
-
createdOn:
|
|
3418
|
-
type: optional<datetime>
|
|
3419
|
-
docs: The creation timestamp of the image
|
|
3420
|
-
contentType:
|
|
3421
|
-
type: optional<string>
|
|
3422
|
-
docs: The MIME type of the image
|
|
3423
|
-
width:
|
|
3424
|
-
type: optional<integer>
|
|
3425
|
-
docs: The image width in pixels
|
|
3426
|
-
height:
|
|
3427
|
-
type: optional<integer>
|
|
3428
|
-
docs: The image height in pixels
|
|
3429
|
-
variants:
|
|
3430
|
-
type: optional<list<OrderPurchasedItemVariantImageFileVariantsItem>>
|
|
3431
|
-
docs: Variants of the supplied image
|
|
3432
|
-
source:
|
|
3433
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3434
|
-
inline: true
|
|
3435
|
-
OrderPurchasedItemVariantImage:
|
|
3436
|
-
properties:
|
|
3437
|
-
url:
|
|
3438
|
-
type: optional<string>
|
|
3439
|
-
docs: The hosted location for the Variant's image
|
|
3440
|
-
validation:
|
|
3441
|
-
format: uri
|
|
3442
|
-
file: optional<OrderPurchasedItemVariantImageFile>
|
|
3443
|
-
source:
|
|
3444
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3445
|
-
inline: true
|
|
3446
|
-
OrderPurchasedItem:
|
|
3447
|
-
docs: An Item that was purchased
|
|
3448
|
-
properties:
|
|
3449
|
-
count:
|
|
3450
|
-
type: optional<double>
|
|
3451
|
-
docs: Number of Item purchased.
|
|
3452
|
-
rowTotal:
|
|
3453
|
-
type: optional<OrderPrice>
|
|
3454
|
-
docs: The total for the row
|
|
3455
|
-
productId:
|
|
3456
|
-
type: optional<string>
|
|
3457
|
-
docs: The unique identifier for the Product
|
|
3458
|
-
access: read-only
|
|
3459
|
-
productName:
|
|
3460
|
-
type: optional<string>
|
|
3461
|
-
docs: User-facing name of the Product
|
|
3462
|
-
productSlug:
|
|
3463
|
-
type: optional<string>
|
|
3464
|
-
docs: Slug for the Product
|
|
3465
|
-
variantId:
|
|
3466
|
-
type: optional<string>
|
|
3467
|
-
docs: Identifier for the Product Variant (SKU)
|
|
3468
|
-
variantName:
|
|
3469
|
-
type: optional<string>
|
|
3470
|
-
docs: User-facing name of the Product Variant (SKU)
|
|
3471
|
-
variantSlug:
|
|
3472
|
-
type: optional<string>
|
|
3473
|
-
docs: Slug for the Product Variant (SKU)
|
|
3474
|
-
variantSKU:
|
|
3475
|
-
type: optional<string>
|
|
3476
|
-
docs: The user-defined custom SKU of the Product Variant (SKU)
|
|
3477
|
-
variantImage: optional<OrderPurchasedItemVariantImage>
|
|
3478
|
-
variantPrice:
|
|
3479
|
-
type: optional<OrderPrice>
|
|
3480
|
-
docs: The price corresponding to the variant
|
|
3481
|
-
weight:
|
|
3482
|
-
type: optional<double>
|
|
3483
|
-
docs: The physical weight of the variant if provided, or null
|
|
3484
|
-
width:
|
|
3485
|
-
type: optional<double>
|
|
3486
|
-
docs: The physical width of the variant if provided, or null
|
|
3487
|
-
height:
|
|
3488
|
-
type: optional<double>
|
|
3489
|
-
docs: The physical height of the variant if provided, or null
|
|
3490
|
-
length:
|
|
3491
|
-
type: optional<double>
|
|
3492
|
-
docs: The physical length of the variant if provided, or null
|
|
3493
|
-
source:
|
|
3494
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3495
|
-
StripeDetails:
|
|
3496
|
-
docs: >-
|
|
3497
|
-
An object with various Stripe IDs, useful for linking into the stripe
|
|
3498
|
-
dashboard.
|
|
3499
|
-
properties:
|
|
3500
|
-
subscriptionId:
|
|
3501
|
-
type: optional<string>
|
|
3502
|
-
docs: Stripe-generated identifier for the Subscription
|
|
3503
|
-
paymentMethod:
|
|
3504
|
-
type: optional<string>
|
|
3505
|
-
docs: Stripe-generated identifier for the PaymentMethod used
|
|
3506
|
-
paymentIntentId:
|
|
3507
|
-
type: optional<string>
|
|
3508
|
-
docs: Stripe-generated identifier for the PaymentIntent, or null
|
|
3509
|
-
customerId:
|
|
3510
|
-
type: optional<string>
|
|
3511
|
-
docs: Stripe-generated customer identifier, or null
|
|
3512
|
-
chargeId:
|
|
3513
|
-
type: optional<string>
|
|
3514
|
-
docs: Stripe-generated charge identifier, or null
|
|
3515
|
-
disputeId:
|
|
3516
|
-
type: optional<string>
|
|
3517
|
-
docs: Stripe-generated dispute identifier, or null
|
|
3518
|
-
refundId:
|
|
3519
|
-
type: optional<string>
|
|
3520
|
-
docs: Stripe-generated refund identifier, or null
|
|
3521
|
-
refundReason:
|
|
3522
|
-
type: optional<string>
|
|
3523
|
-
docs: Stripe-generated refund reason, or null
|
|
3524
|
-
source:
|
|
3525
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3526
|
-
StripeCardBrand:
|
|
3527
|
-
enum:
|
|
3528
|
-
- Visa
|
|
3529
|
-
- value: American Express
|
|
3530
|
-
name: AmericanExpress
|
|
3531
|
-
- MasterCard
|
|
3532
|
-
- Discover
|
|
3533
|
-
- JCB
|
|
3534
|
-
- value: Diners Club
|
|
3535
|
-
name: DinersClub
|
|
3536
|
-
- Unknown
|
|
3537
|
-
docs: The card's brand (ie. credit card network)
|
|
3538
|
-
inline: true
|
|
3539
|
-
source:
|
|
3540
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3541
|
-
StripeCardExpires:
|
|
3542
|
-
docs: The card's expiration date.
|
|
3543
|
-
properties:
|
|
3544
|
-
year:
|
|
3545
|
-
type: optional<double>
|
|
3546
|
-
docs: Year that the card expires
|
|
3547
|
-
month:
|
|
3548
|
-
type: optional<double>
|
|
3549
|
-
docs: Month that the card expires
|
|
3550
|
-
source:
|
|
3551
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3552
|
-
inline: true
|
|
3553
|
-
StripeCard:
|
|
3554
|
-
docs: >
|
|
3555
|
-
Details on the card used to fulfill this order, if this order was
|
|
3556
|
-
finalized with Stripe.
|
|
3557
|
-
properties:
|
|
3558
|
-
last4:
|
|
3559
|
-
type: optional<string>
|
|
3560
|
-
docs: The last 4 digits on the card as a string
|
|
3561
|
-
brand:
|
|
3562
|
-
type: optional<StripeCardBrand>
|
|
3563
|
-
docs: The card's brand (ie. credit card network)
|
|
3564
|
-
ownerName:
|
|
3565
|
-
type: optional<string>
|
|
3566
|
-
docs: The name on the card.
|
|
3567
|
-
expires:
|
|
3568
|
-
type: optional<StripeCardExpires>
|
|
3569
|
-
docs: The card's expiration date.
|
|
3570
|
-
source:
|
|
3571
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3572
|
-
PaypalDetails:
|
|
3573
|
-
properties:
|
|
3574
|
-
orderId:
|
|
3575
|
-
type: optional<string>
|
|
3576
|
-
docs: PayPal order identifier
|
|
3577
|
-
payerId:
|
|
3578
|
-
type: optional<string>
|
|
3579
|
-
docs: PayPal payer identifier
|
|
3580
|
-
captureId:
|
|
3581
|
-
type: optional<string>
|
|
3582
|
-
docs: PayPal capture identifier
|
|
3583
|
-
refundId:
|
|
3584
|
-
type: optional<string>
|
|
3585
|
-
docs: PayPal refund identifier
|
|
3586
|
-
refundReason:
|
|
3587
|
-
type: optional<string>
|
|
3588
|
-
docs: PayPal-issued reason for the refund
|
|
3589
|
-
disputeId:
|
|
3590
|
-
type: optional<string>
|
|
3591
|
-
docs: PayPal dispute identifier
|
|
3592
|
-
source:
|
|
3593
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3594
|
-
OrderStatus:
|
|
3595
|
-
enum:
|
|
3596
|
-
- pending
|
|
3597
|
-
- unfulfilled
|
|
3598
|
-
- fulfilled
|
|
3599
|
-
- disputed
|
|
3600
|
-
- value: dispute-lost
|
|
3601
|
-
name: DisputeLost
|
|
3602
|
-
- refunded
|
|
3603
|
-
docs: |
|
|
3604
|
-
The status of the Order
|
|
3605
|
-
inline: true
|
|
3606
|
-
source:
|
|
3607
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3608
|
-
OrderDisputeLastStatus:
|
|
3609
|
-
enum:
|
|
3610
|
-
- warning_needs_response
|
|
3611
|
-
- warning_under_review
|
|
3612
|
-
- warning_closed
|
|
3613
|
-
- needs_response
|
|
3614
|
-
- under_review
|
|
3615
|
-
- charge_refunded
|
|
3616
|
-
- won
|
|
3617
|
-
- lost
|
|
3618
|
-
docs: >
|
|
3619
|
-
If an order was disputed by the customer, then this key will be set with
|
|
3620
|
-
the [dispute's status](https://stripe.com/docs/api#dispute_object-status).
|
|
3621
|
-
inline: true
|
|
3622
|
-
source:
|
|
3623
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3624
|
-
OrderShippingAddressType:
|
|
3625
|
-
enum:
|
|
3626
|
-
- shipping
|
|
3627
|
-
- billing
|
|
3628
|
-
docs: The type of the order address (billing or shipping)
|
|
3629
|
-
inline: true
|
|
3630
|
-
source:
|
|
3631
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3632
|
-
OrderShippingAddressJapanType:
|
|
3633
|
-
enum:
|
|
3634
|
-
- kana
|
|
3635
|
-
- kanji
|
|
3636
|
-
docs: >-
|
|
3637
|
-
Represents a Japan-only address format. This field will only appear on
|
|
3638
|
-
orders placed from Japan.
|
|
3639
|
-
inline: true
|
|
3640
|
-
source:
|
|
3641
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3642
|
-
OrderShippingAddress:
|
|
3643
|
-
docs: The shipping address
|
|
3644
|
-
properties:
|
|
3645
|
-
type:
|
|
3646
|
-
type: optional<OrderShippingAddressType>
|
|
3647
|
-
docs: The type of the order address (billing or shipping)
|
|
3648
|
-
japanType:
|
|
3649
|
-
type: optional<OrderShippingAddressJapanType>
|
|
3650
|
-
docs: >-
|
|
3651
|
-
Represents a Japan-only address format. This field will only appear on
|
|
3652
|
-
orders placed from Japan.
|
|
3653
|
-
addressee:
|
|
3654
|
-
type: optional<string>
|
|
3655
|
-
docs: Display name on the address
|
|
3656
|
-
line1:
|
|
3657
|
-
type: optional<string>
|
|
3658
|
-
docs: The first line of the address
|
|
3659
|
-
line2:
|
|
3660
|
-
type: optional<string>
|
|
3661
|
-
docs: The second line of the address
|
|
3662
|
-
city:
|
|
3663
|
-
type: optional<string>
|
|
3664
|
-
docs: The city of the address.
|
|
3665
|
-
state:
|
|
3666
|
-
type: optional<string>
|
|
3667
|
-
docs: The state or province of the address
|
|
3668
|
-
country:
|
|
3669
|
-
type: optional<string>
|
|
3670
|
-
docs: The country of the address
|
|
3671
|
-
postalCode:
|
|
3672
|
-
type: optional<string>
|
|
3673
|
-
docs: The postal code of the address
|
|
3674
|
-
source:
|
|
3675
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3676
|
-
inline: true
|
|
3677
|
-
OrderBillingAddressType:
|
|
3678
|
-
enum:
|
|
3679
|
-
- shipping
|
|
3680
|
-
- billing
|
|
3681
|
-
docs: The type of the order address (billing or shipping)
|
|
3682
|
-
inline: true
|
|
3683
|
-
source:
|
|
3684
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3685
|
-
OrderBillingAddressJapanType:
|
|
3686
|
-
enum:
|
|
3687
|
-
- kana
|
|
3688
|
-
- kanji
|
|
3689
|
-
docs: >-
|
|
3690
|
-
Represents a Japan-only address format. This field will only appear on
|
|
3691
|
-
orders placed from Japan.
|
|
3692
|
-
inline: true
|
|
3693
|
-
source:
|
|
3694
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3695
|
-
OrderBillingAddress:
|
|
3696
|
-
docs: The billing address
|
|
3697
|
-
properties:
|
|
3698
|
-
type:
|
|
3699
|
-
type: optional<OrderBillingAddressType>
|
|
3700
|
-
docs: The type of the order address (billing or shipping)
|
|
3701
|
-
japanType:
|
|
3702
|
-
type: optional<OrderBillingAddressJapanType>
|
|
3703
|
-
docs: >-
|
|
3704
|
-
Represents a Japan-only address format. This field will only appear on
|
|
3705
|
-
orders placed from Japan.
|
|
3706
|
-
addressee:
|
|
3707
|
-
type: optional<string>
|
|
3708
|
-
docs: Display name on the address
|
|
3709
|
-
line1:
|
|
3710
|
-
type: optional<string>
|
|
3711
|
-
docs: The first line of the address
|
|
3712
|
-
line2:
|
|
3713
|
-
type: optional<string>
|
|
3714
|
-
docs: The second line of the address
|
|
3715
|
-
city:
|
|
3716
|
-
type: optional<string>
|
|
3717
|
-
docs: The city of the address.
|
|
3718
|
-
state:
|
|
3719
|
-
type: optional<string>
|
|
3720
|
-
docs: The state or province of the address
|
|
3721
|
-
country:
|
|
3722
|
-
type: optional<string>
|
|
3723
|
-
docs: The country of the address
|
|
3724
|
-
postalCode:
|
|
3725
|
-
type: optional<string>
|
|
3726
|
-
docs: The postal code of the address
|
|
3727
|
-
source:
|
|
3728
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3729
|
-
inline: true
|
|
3730
|
-
OrderCustomerInfo:
|
|
3731
|
-
docs: An object with the keys `fullName` and `email`.
|
|
3732
|
-
properties:
|
|
3733
|
-
fullName:
|
|
3734
|
-
type: optional<string>
|
|
3735
|
-
docs: The full name of the Customer
|
|
3736
|
-
email:
|
|
3737
|
-
type: optional<string>
|
|
3738
|
-
docs: The Customer's email address
|
|
3739
|
-
validation:
|
|
3740
|
-
format: email
|
|
3741
|
-
source:
|
|
3742
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3743
|
-
inline: true
|
|
3744
|
-
OrderMetadata:
|
|
3745
|
-
properties:
|
|
3746
|
-
isBuyNow: optional<boolean>
|
|
3747
|
-
source:
|
|
3748
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3749
|
-
inline: true
|
|
3750
|
-
OrderTotalsExtrasItemType:
|
|
3751
|
-
enum:
|
|
3752
|
-
- discount
|
|
3753
|
-
- value: discount-shipping
|
|
3754
|
-
name: DiscountShipping
|
|
3755
|
-
- shipping
|
|
3756
|
-
- tax
|
|
3757
|
-
docs: The type of extra item this is.
|
|
3758
|
-
inline: true
|
|
3759
|
-
source:
|
|
3760
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3761
|
-
OrderTotalsExtrasItem:
|
|
3762
|
-
docs: Extra order items, includes discounts, shipping, and taxes.
|
|
3763
|
-
properties:
|
|
3764
|
-
type:
|
|
3765
|
-
type: optional<OrderTotalsExtrasItemType>
|
|
3766
|
-
docs: The type of extra item this is.
|
|
3767
|
-
name:
|
|
3768
|
-
type: optional<string>
|
|
3769
|
-
docs: A human-readable (but English) name for this extra charge.
|
|
3770
|
-
description:
|
|
3771
|
-
type: optional<string>
|
|
3772
|
-
docs: A human-readable (but English) description of this extra charge.
|
|
3773
|
-
price:
|
|
3774
|
-
type: optional<OrderPrice>
|
|
3775
|
-
docs: The price for the item
|
|
3776
|
-
source:
|
|
3777
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3778
|
-
inline: true
|
|
3779
|
-
OrderTotals:
|
|
3780
|
-
docs: An object describing various pricing totals
|
|
3781
|
-
properties:
|
|
3782
|
-
subtotal:
|
|
3783
|
-
type: optional<OrderPrice>
|
|
3784
|
-
docs: The subtotal price
|
|
3785
|
-
extras:
|
|
3786
|
-
type: optional<list<OrderTotalsExtrasItem>>
|
|
3787
|
-
docs: An array of extra items, includes discounts, shipping, and taxes.
|
|
3788
|
-
total:
|
|
3789
|
-
type: optional<OrderPrice>
|
|
3790
|
-
docs: The total price
|
|
3791
|
-
source:
|
|
3792
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3793
|
-
inline: true
|
|
3794
|
-
OrderDownloadFilesItem:
|
|
3795
|
-
properties:
|
|
3796
|
-
id:
|
|
3797
|
-
type: optional<string>
|
|
3798
|
-
docs: The unique identifier for the downloadable file
|
|
3799
|
-
name:
|
|
3800
|
-
type: optional<string>
|
|
3801
|
-
docs: The user-facing name for the downloadable file
|
|
3802
|
-
url:
|
|
3803
|
-
type: optional<string>
|
|
3804
|
-
docs: The hosted location for the downloadable file
|
|
3805
|
-
validation:
|
|
3806
|
-
format: uri
|
|
3807
|
-
source:
|
|
3808
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3809
|
-
inline: true
|
|
3810
|
-
Order:
|
|
3811
|
-
properties:
|
|
3812
|
-
orderId:
|
|
3813
|
-
type: optional<string>
|
|
3814
|
-
docs: |
|
|
3815
|
-
The order ID. Will usually be 6 hex characters, but can also be 9
|
|
3816
|
-
hex characters if the site has a very large number of Orders.
|
|
3817
|
-
Randomly assigned.
|
|
3818
|
-
access: read-only
|
|
3819
|
-
status:
|
|
3820
|
-
type: optional<OrderStatus>
|
|
3821
|
-
docs: |
|
|
3822
|
-
The status of the Order
|
|
3823
|
-
comment:
|
|
3824
|
-
type: optional<string>
|
|
3825
|
-
docs: >-
|
|
3826
|
-
A comment string for this Order, which is editable by API user (not
|
|
3827
|
-
used by Webflow).
|
|
3828
|
-
orderComment:
|
|
3829
|
-
type: optional<string>
|
|
3830
|
-
docs: A comment that the customer left when making their Order
|
|
3831
|
-
acceptedOn:
|
|
3832
|
-
type: optional<datetime>
|
|
3833
|
-
docs: The ISO8601 timestamp that an Order was placed.
|
|
3834
|
-
fulfilledOn:
|
|
3835
|
-
type: optional<datetime>
|
|
3836
|
-
docs: >
|
|
3837
|
-
When an Order is marked as 'fulfilled', this field represents the
|
|
3838
|
-
timestamp of the fulfillment in ISO8601 format. Otherwise, it is null.
|
|
3839
|
-
refundedOn:
|
|
3840
|
-
type: optional<datetime>
|
|
3841
|
-
docs: >-
|
|
3842
|
-
When an Order is marked as 'refunded', this field represents the
|
|
3843
|
-
timestamp of the fulfillment in ISO8601 format. Otherwise, it is null.
|
|
3844
|
-
disputedOn:
|
|
3845
|
-
type: optional<datetime>
|
|
3846
|
-
docs: >
|
|
3847
|
-
When an Order is marked as 'disputed', this field represents the
|
|
3848
|
-
timestamp of the fulfillment in ISO8601 format. Otherwise, it is null.
|
|
3849
|
-
disputeUpdatedOn:
|
|
3850
|
-
type: optional<datetime>
|
|
3851
|
-
docs: >
|
|
3852
|
-
If an Order has been disputed by the customer, this key will be set to
|
|
3853
|
-
the ISO8601 timestamp of the last update received. If the Order is not
|
|
3854
|
-
disputed, the key will be null.
|
|
3855
|
-
disputeLastStatus:
|
|
3856
|
-
type: optional<OrderDisputeLastStatus>
|
|
3857
|
-
docs: >
|
|
3858
|
-
If an order was disputed by the customer, then this key will be set
|
|
3859
|
-
with the [dispute's
|
|
3860
|
-
status](https://stripe.com/docs/api#dispute_object-status).
|
|
3861
|
-
customerPaid:
|
|
3862
|
-
type: optional<OrderPrice>
|
|
3863
|
-
docs: The total paid by the customer
|
|
3864
|
-
netAmount:
|
|
3865
|
-
type: optional<OrderPrice>
|
|
3866
|
-
docs: The net amount after application fees
|
|
3867
|
-
applicationFee:
|
|
3868
|
-
type: optional<OrderPrice>
|
|
3869
|
-
docs: The application fee assessed by the platform
|
|
3870
|
-
allAddresses:
|
|
3871
|
-
type: optional<list<OrderAddress>>
|
|
3872
|
-
docs: All addresses provided by the customer during the ordering flow.
|
|
3873
|
-
shippingAddress:
|
|
3874
|
-
type: optional<OrderShippingAddress>
|
|
3875
|
-
docs: The shipping address
|
|
3876
|
-
billingAddress:
|
|
3877
|
-
type: optional<OrderBillingAddress>
|
|
3878
|
-
docs: The billing address
|
|
3879
|
-
shippingProvider:
|
|
3880
|
-
type: optional<string>
|
|
3881
|
-
docs: >
|
|
3882
|
-
A string editable by the API user to note the shipping provider used
|
|
3883
|
-
(not used by Webflow).
|
|
3884
|
-
shippingTracking:
|
|
3885
|
-
type: optional<string>
|
|
3886
|
-
docs: >
|
|
3887
|
-
A string editable by the API user to note the shipping tracking number
|
|
3888
|
-
for the order (not used by Webflow).
|
|
3889
|
-
shippingTrackingURL:
|
|
3890
|
-
type: optional<string>
|
|
3891
|
-
validation:
|
|
3892
|
-
format: uri
|
|
3893
|
-
customerInfo:
|
|
3894
|
-
type: optional<OrderCustomerInfo>
|
|
3895
|
-
docs: An object with the keys `fullName` and `email`.
|
|
3896
|
-
purchasedItems:
|
|
3897
|
-
type: optional<list<OrderPurchasedItem>>
|
|
3898
|
-
docs: An array of all things that the Customer purchased.
|
|
3899
|
-
purchasedItemsCount:
|
|
3900
|
-
type: optional<double>
|
|
3901
|
-
docs: The sum of all 'count' fields in 'purchasedItems'.
|
|
3902
|
-
stripeDetails: optional<StripeDetails>
|
|
3903
|
-
stripeCard: optional<StripeCard>
|
|
3904
|
-
paypalDetails: optional<PaypalDetails>
|
|
3905
|
-
customData:
|
|
3906
|
-
type: optional<list<map<string, unknown>>>
|
|
3907
|
-
docs: >
|
|
3908
|
-
An array of additional inputs for custom order data gathering. Each
|
|
3909
|
-
object in the array represents an input with a name, and a textInput,
|
|
3910
|
-
textArea, or checkbox value.
|
|
3911
|
-
metadata: optional<OrderMetadata>
|
|
3912
|
-
isCustomerDeleted:
|
|
3913
|
-
type: optional<boolean>
|
|
3914
|
-
docs: >
|
|
3915
|
-
A boolean indicating whether the customer has been deleted from the
|
|
3916
|
-
site.
|
|
3917
|
-
isShippingRequired:
|
|
3918
|
-
type: optional<boolean>
|
|
3919
|
-
docs: >
|
|
3920
|
-
A boolean indicating whether the order contains one or more purchased
|
|
3921
|
-
items that require shipping.
|
|
3922
|
-
hasDownloads:
|
|
3923
|
-
type: optional<boolean>
|
|
3924
|
-
docs: >
|
|
3925
|
-
A boolean indicating whether the order contains one or more purchased
|
|
3926
|
-
items that are downloadable.
|
|
3927
|
-
paymentProcessor:
|
|
3928
|
-
type: optional<string>
|
|
3929
|
-
docs: |
|
|
3930
|
-
A string indicating the payment processor used for this order.
|
|
3931
|
-
totals:
|
|
3932
|
-
type: optional<OrderTotals>
|
|
3933
|
-
docs: An object describing various pricing totals
|
|
3934
|
-
downloadFiles:
|
|
3935
|
-
type: optional<list<OrderDownloadFilesItem>>
|
|
3936
|
-
docs: An array of downloadable file objects.
|
|
3937
|
-
source:
|
|
3938
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3939
|
-
OrderList:
|
|
3940
|
-
docs: Results from order list
|
|
3941
|
-
properties:
|
|
3942
|
-
orders:
|
|
3943
|
-
type: optional<list<Order>>
|
|
3944
|
-
docs: List of orders
|
|
3945
|
-
pagination: optional<Pagination>
|
|
3946
|
-
source:
|
|
3947
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3948
|
-
InventoryItemInventoryType:
|
|
3949
|
-
enum:
|
|
3950
|
-
- infinite
|
|
3951
|
-
- finite
|
|
3952
|
-
docs: infinite or finite
|
|
3953
|
-
inline: true
|
|
3954
|
-
source:
|
|
3955
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3956
|
-
InventoryItem:
|
|
3957
|
-
docs: The availabile inventory for an item
|
|
3958
|
-
properties:
|
|
3959
|
-
id:
|
|
3960
|
-
type: optional<string>
|
|
3961
|
-
docs: Unique identifier for a SKU item
|
|
3962
|
-
access: read-only
|
|
3963
|
-
quantity:
|
|
3964
|
-
type: optional<double>
|
|
3965
|
-
docs: >-
|
|
3966
|
-
Total quantity of items remaining in inventory (if inventoryType is
|
|
3967
|
-
finite)
|
|
3968
|
-
inventoryType:
|
|
3969
|
-
type: optional<InventoryItemInventoryType>
|
|
3970
|
-
docs: infinite or finite
|
|
3971
|
-
source:
|
|
3972
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3973
|
-
EcommerceSettings:
|
|
3974
|
-
docs: Ecommerce settings for a Webflow Site
|
|
3975
|
-
properties:
|
|
3976
|
-
siteId:
|
|
3977
|
-
type: optional<string>
|
|
3978
|
-
docs: The identifier of the Site
|
|
3979
|
-
access: read-only
|
|
3980
|
-
createdOn:
|
|
3981
|
-
type: optional<datetime>
|
|
3982
|
-
docs: Date that the Site was created on
|
|
3983
|
-
access: read-only
|
|
3984
|
-
defaultCurrency:
|
|
3985
|
-
type: optional<string>
|
|
3986
|
-
docs: The three-letter ISO currency code for the Site
|
|
3987
|
-
source:
|
|
3988
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
3989
|
-
FormSubmissionTriggerPayloadSchemaItemFieldType:
|
|
3990
|
-
enum:
|
|
3991
|
-
- FormTextInput
|
|
3992
|
-
- FormTextarea
|
|
3993
|
-
- FormCheckboxInput
|
|
3994
|
-
- FormRadioInput
|
|
3995
|
-
- FormFileUploadInput
|
|
3996
|
-
docs: Form field type
|
|
3997
|
-
inline: true
|
|
3998
|
-
source:
|
|
3999
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
4000
|
-
FormSubmissionTriggerPayloadSchemaItem:
|
|
4001
|
-
properties:
|
|
4002
|
-
fieldName:
|
|
4003
|
-
type: optional<string>
|
|
4004
|
-
docs: Form field name
|
|
4005
|
-
fieldType:
|
|
4006
|
-
type: optional<FormSubmissionTriggerPayloadSchemaItemFieldType>
|
|
4007
|
-
docs: Form field type
|
|
4008
|
-
fieldElementId:
|
|
4009
|
-
type: optional<string>
|
|
4010
|
-
docs: Element ID of the Form Field
|
|
4011
|
-
source:
|
|
4012
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
4013
|
-
inline: true
|
|
4014
|
-
FormSubmissionTriggerPayload:
|
|
4015
|
-
docs: The payload of data sent from Webflow
|
|
4016
|
-
properties:
|
|
4017
|
-
name:
|
|
4018
|
-
type: optional<string>
|
|
4019
|
-
docs: The name of the form
|
|
4020
|
-
siteId:
|
|
4021
|
-
type: optional<string>
|
|
4022
|
-
docs: The ID of the site that the form was submitted from
|
|
4023
|
-
data:
|
|
4024
|
-
type: optional<map<string, unknown>>
|
|
4025
|
-
docs: The data submitted in the form
|
|
4026
|
-
schema:
|
|
4027
|
-
type: optional<list<FormSubmissionTriggerPayloadSchemaItem>>
|
|
4028
|
-
docs: A list of fields from the submitted form
|
|
4029
|
-
submittedAt:
|
|
4030
|
-
type: optional<string>
|
|
4031
|
-
docs: The timestamp the form was submitted
|
|
4032
|
-
id:
|
|
4033
|
-
type: optional<string>
|
|
4034
|
-
docs: the ID of the event
|
|
4035
|
-
formId:
|
|
4036
|
-
type: optional<string>
|
|
4037
|
-
docs: The ID of the form submission
|
|
4038
|
-
formElementId:
|
|
4039
|
-
type: optional<string>
|
|
4040
|
-
docs: The uniqueID of the Form element
|
|
4041
|
-
source:
|
|
4042
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
4043
|
-
inline: true
|
|
4044
|
-
FormSubmissionTrigger:
|
|
4045
|
-
docs: The Webhook payload for when a form is submitted
|
|
4046
|
-
properties:
|
|
4047
|
-
triggerType:
|
|
4048
|
-
type: optional<string>
|
|
4049
|
-
docs: The type of event that triggered the request
|
|
4050
|
-
payload:
|
|
4051
|
-
type: optional<FormSubmissionTriggerPayload>
|
|
4052
|
-
docs: The payload of data sent from Webflow
|
|
4053
|
-
source:
|
|
4054
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
4055
|
-
SitePublishPayload:
|
|
4056
|
-
docs: The payload of data sent from Webflow
|
|
4057
|
-
properties:
|
|
4058
|
-
siteId:
|
|
4059
|
-
type: optional<string>
|
|
4060
|
-
docs: The ID of the site that was published
|
|
4061
|
-
publishedOn:
|
|
4062
|
-
type: optional<datetime>
|
|
4063
|
-
docs: The timestamp of the publish event
|
|
4064
|
-
domains:
|
|
4065
|
-
type: optional<list<string>>
|
|
4066
|
-
docs: The domains that were published
|
|
4067
|
-
publishedBy:
|
|
4068
|
-
type: optional<map<string, unknown>>
|
|
4069
|
-
docs: The name andID of the user who published the site
|
|
4070
|
-
source:
|
|
4071
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
4072
|
-
inline: true
|
|
4073
|
-
SitePublish:
|
|
4074
|
-
docs: The Webhook payload for when a Site is published
|
|
4075
|
-
properties:
|
|
4076
|
-
triggerType:
|
|
4077
|
-
type: optional<string>
|
|
4078
|
-
docs: The type of event that triggered the request
|
|
4079
|
-
payload:
|
|
4080
|
-
type: optional<SitePublishPayload>
|
|
4081
|
-
docs: The payload of data sent from Webflow
|
|
4082
|
-
source:
|
|
4083
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
4084
|
-
NewOrder:
|
|
4085
|
-
docs: The Webhook payload for when a new order is created
|
|
4086
|
-
properties:
|
|
4087
|
-
triggerType:
|
|
4088
|
-
type: optional<string>
|
|
4089
|
-
docs: The type of event that triggered the request
|
|
4090
|
-
payload: optional<Order>
|
|
4091
|
-
source:
|
|
4092
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
4093
|
-
UpdatedOrder:
|
|
4094
|
-
docs: The Webhook payload for when an order is updated
|
|
4095
|
-
properties:
|
|
4096
|
-
triggerType:
|
|
4097
|
-
type: optional<string>
|
|
4098
|
-
docs: The type of event that triggered the request
|
|
4099
|
-
payload: optional<Order>
|
|
4100
|
-
source:
|
|
4101
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
4102
|
-
SingleLocaleCreatedPayloadFieldData:
|
|
4103
|
-
properties:
|
|
4104
|
-
name: string
|
|
4105
|
-
slug: string
|
|
4106
|
-
extra-properties: true
|
|
4107
|
-
source:
|
|
4108
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
4109
|
-
inline: true
|
|
4110
|
-
SingleLocaleCreatedPayload:
|
|
4111
|
-
properties:
|
|
4112
|
-
id:
|
|
4113
|
-
type: string
|
|
4114
|
-
docs: Unique identifier for the Item
|
|
4115
|
-
validation:
|
|
4116
|
-
format: uuid
|
|
4117
|
-
workspaceId:
|
|
4118
|
-
type: string
|
|
4119
|
-
docs: Unique identifier of the workspace
|
|
4120
|
-
validation:
|
|
4121
|
-
format: uuid
|
|
4122
|
-
siteId:
|
|
4123
|
-
type: string
|
|
4124
|
-
docs: Unique identifier of the site
|
|
4125
|
-
validation:
|
|
4126
|
-
format: uuid
|
|
4127
|
-
collectionId:
|
|
4128
|
-
type: string
|
|
4129
|
-
docs: Unique identifier of the collection
|
|
4130
|
-
validation:
|
|
4131
|
-
format: uuid
|
|
4132
|
-
cmsLocaleId:
|
|
4133
|
-
type: optional<string>
|
|
4134
|
-
docs: Unique identifier of the CMS locale for this item
|
|
4135
|
-
validation:
|
|
4136
|
-
format: uuid
|
|
4137
|
-
lastPublished: optional<datetime>
|
|
4138
|
-
lastUpdated: optional<datetime>
|
|
4139
|
-
createdOn: optional<datetime>
|
|
4140
|
-
isArchived: optional<boolean>
|
|
4141
|
-
isDraft: optional<boolean>
|
|
4142
|
-
fieldData: SingleLocaleCreatedPayloadFieldData
|
|
4143
|
-
source:
|
|
4144
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
4145
|
-
CollectionItemCreated:
|
|
4146
|
-
docs: The Webhook payload for when a Collection Item is created
|
|
4147
|
-
properties:
|
|
4148
|
-
triggerType:
|
|
4149
|
-
type: literal<"collection_item_created">
|
|
4150
|
-
docs: The type of event that triggered the request
|
|
4151
|
-
payload:
|
|
4152
|
-
type: SingleLocaleCreatedPayload
|
|
4153
|
-
source:
|
|
4154
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
4155
|
-
CollectionItemChanged:
|
|
4156
|
-
docs: The Webhook payload for when a Collection Item is changed
|
|
4157
|
-
properties:
|
|
4158
|
-
triggerType:
|
|
4159
|
-
type: literal<"collection_item_changed">
|
|
4160
|
-
docs: The type of event that triggered the request
|
|
4161
|
-
payload:
|
|
4162
|
-
type: SingleLocaleCreatedPayload
|
|
4163
|
-
source:
|
|
4164
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
4165
|
-
CollectionItemRemovedPayloadFieldData:
|
|
4166
|
-
properties:
|
|
4167
|
-
name: string
|
|
4168
|
-
slug: string
|
|
4169
|
-
extra-properties: true
|
|
4170
|
-
source:
|
|
4171
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
4172
|
-
inline: true
|
|
4173
|
-
CollectionItemRemovedPayload:
|
|
4174
|
-
docs: The payload of data sent from Webflow
|
|
4175
|
-
properties:
|
|
4176
|
-
id:
|
|
4177
|
-
type: optional<string>
|
|
4178
|
-
docs: The ID of the collection item that was deleted
|
|
4179
|
-
siteId:
|
|
4180
|
-
type: optional<string>
|
|
4181
|
-
docs: The ID of the site
|
|
4182
|
-
workspaceId:
|
|
4183
|
-
type: optional<string>
|
|
4184
|
-
docs: The ID of the workspace
|
|
4185
|
-
collectionId:
|
|
4186
|
-
type: optional<string>
|
|
4187
|
-
docs: The ID of the collection
|
|
4188
|
-
cmsLocaleId:
|
|
4189
|
-
type: optional<string>
|
|
4190
|
-
docs: Unique identifier of the CMS locale for this item
|
|
4191
|
-
validation:
|
|
4192
|
-
format: uuid
|
|
4193
|
-
lastPublished: optional<datetime>
|
|
4194
|
-
lastUpdated: optional<datetime>
|
|
4195
|
-
createdOn: optional<datetime>
|
|
4196
|
-
isArchived: optional<boolean>
|
|
4197
|
-
isDraft: optional<boolean>
|
|
4198
|
-
fieldData: optional<CollectionItemRemovedPayloadFieldData>
|
|
4199
|
-
source:
|
|
4200
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
4201
|
-
inline: true
|
|
4202
|
-
CollectionItemRemoved:
|
|
4203
|
-
properties:
|
|
4204
|
-
triggerType:
|
|
4205
|
-
type: optional<string>
|
|
4206
|
-
docs: The type of event that triggered the request
|
|
4207
|
-
payload:
|
|
4208
|
-
type: optional<CollectionItemRemovedPayload>
|
|
4209
|
-
docs: The payload of data sent from Webflow
|
|
4210
|
-
source:
|
|
4211
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
4212
|
-
PayloadFieldData:
|
|
4213
|
-
properties:
|
|
4214
|
-
name: string
|
|
4215
|
-
slug: string
|
|
4216
|
-
extra-properties: true
|
|
4217
|
-
source:
|
|
4218
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
4219
|
-
inline: true
|
|
4220
|
-
Payload:
|
|
4221
|
-
docs: The payload of data sent from Webflow
|
|
4222
|
-
properties:
|
|
4223
|
-
id:
|
|
4224
|
-
type: optional<string>
|
|
4225
|
-
docs: The ID of the collection item that was unpublished
|
|
4226
|
-
siteId:
|
|
4227
|
-
type: optional<string>
|
|
4228
|
-
docs: The ID of the site
|
|
4229
|
-
workspaceId:
|
|
4230
|
-
type: optional<string>
|
|
4231
|
-
docs: The ID of the workspace
|
|
4232
|
-
collectionId:
|
|
4233
|
-
type: optional<string>
|
|
4234
|
-
docs: The ID of the collection
|
|
4235
|
-
cmsLocaleId:
|
|
4236
|
-
type: optional<string>
|
|
4237
|
-
docs: Unique identifier of the CMS locale for this item
|
|
4238
|
-
validation:
|
|
4239
|
-
format: uuid
|
|
4240
|
-
lastPublished: optional<datetime>
|
|
4241
|
-
lastUpdated: optional<datetime>
|
|
4242
|
-
createdOn: optional<datetime>
|
|
4243
|
-
isArchived: optional<boolean>
|
|
4244
|
-
isDraft: optional<boolean>
|
|
4245
|
-
fieldData: optional<PayloadFieldData>
|
|
4246
|
-
source:
|
|
4247
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
4248
|
-
CollectionItemPublished:
|
|
4249
|
-
properties:
|
|
4250
|
-
triggerType:
|
|
4251
|
-
type: optional<string>
|
|
4252
|
-
docs: The type of event that triggered the request
|
|
4253
|
-
payload: optional<Payload>
|
|
4254
|
-
source:
|
|
4255
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
4256
|
-
CollectionItemUnpublishedPayloadFieldData:
|
|
4257
|
-
properties:
|
|
4258
|
-
name: string
|
|
4259
|
-
slug: string
|
|
4260
|
-
extra-properties: true
|
|
4261
|
-
source:
|
|
4262
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
4263
|
-
inline: true
|
|
4264
|
-
CollectionItemUnpublishedPayload:
|
|
4265
|
-
docs: The payload of data sent from Webflow
|
|
4266
|
-
properties:
|
|
4267
|
-
id:
|
|
4268
|
-
type: optional<string>
|
|
4269
|
-
docs: The ID of the collection item that was unpublished
|
|
4270
|
-
siteId:
|
|
4271
|
-
type: optional<string>
|
|
4272
|
-
docs: The ID of the site
|
|
4273
|
-
workspaceId:
|
|
4274
|
-
type: optional<string>
|
|
4275
|
-
docs: The ID of the workspace
|
|
4276
|
-
collectionId:
|
|
4277
|
-
type: optional<string>
|
|
4278
|
-
docs: The ID of the collection
|
|
4279
|
-
cmsLocaleId:
|
|
4280
|
-
type: optional<string>
|
|
4281
|
-
docs: Unique identifier of the CMS locale for this item
|
|
4282
|
-
validation:
|
|
4283
|
-
format: uuid
|
|
4284
|
-
lastPublished: optional<datetime>
|
|
4285
|
-
lastUpdated: optional<datetime>
|
|
4286
|
-
createdOn: optional<datetime>
|
|
4287
|
-
isArchived: optional<boolean>
|
|
4288
|
-
isDraft: optional<boolean>
|
|
4289
|
-
fieldData: optional<CollectionItemUnpublishedPayloadFieldData>
|
|
4290
|
-
source:
|
|
4291
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
4292
|
-
inline: true
|
|
4293
|
-
CollectionItemUnpublished:
|
|
4294
|
-
properties:
|
|
4295
|
-
triggerType:
|
|
4296
|
-
type: optional<string>
|
|
4297
|
-
docs: The type of event that triggered the request
|
|
4298
|
-
payload:
|
|
4299
|
-
type: optional<CollectionItemUnpublishedPayload>
|
|
4300
|
-
docs: The payload of data sent from Webflow
|
|
4301
|
-
source:
|
|
4302
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
4303
|
-
PageCreatedWebhookPayload:
|
|
4304
|
-
docs: The payload of data sent from Webflow
|
|
4305
|
-
properties:
|
|
4306
|
-
siteId: optional<string>
|
|
4307
|
-
pageId: optional<string>
|
|
4308
|
-
pageTitle: optional<string>
|
|
4309
|
-
createdOn: optional<datetime>
|
|
4310
|
-
publishedPath: optional<string>
|
|
4311
|
-
source:
|
|
4312
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
4313
|
-
inline: true
|
|
4314
|
-
PageCreatedWebhook:
|
|
4315
|
-
docs: The Webhook payload for when a Page is created
|
|
4316
|
-
properties:
|
|
4317
|
-
triggerType:
|
|
4318
|
-
type: optional<string>
|
|
4319
|
-
docs: The type of event that triggered the request
|
|
4320
|
-
payload:
|
|
4321
|
-
type: optional<PageCreatedWebhookPayload>
|
|
4322
|
-
docs: The payload of data sent from Webflow
|
|
4323
|
-
source:
|
|
4324
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
4325
|
-
PageMetadataUpdatedWebhookPayload:
|
|
4326
|
-
docs: The payload of data sent from Webflow
|
|
4327
|
-
properties:
|
|
4328
|
-
siteId: optional<string>
|
|
4329
|
-
pageId: optional<string>
|
|
4330
|
-
pageTitle: optional<string>
|
|
4331
|
-
lastUpdated: optional<datetime>
|
|
4332
|
-
publishedPath: optional<string>
|
|
4333
|
-
source:
|
|
4334
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
4335
|
-
inline: true
|
|
4336
|
-
PageMetadataUpdatedWebhook:
|
|
4337
|
-
docs: The Webhook payload for when a Page's metadata is updated
|
|
4338
|
-
properties:
|
|
4339
|
-
triggerType:
|
|
4340
|
-
type: optional<string>
|
|
4341
|
-
docs: The type of event that triggered the request
|
|
4342
|
-
payload:
|
|
4343
|
-
type: optional<PageMetadataUpdatedWebhookPayload>
|
|
4344
|
-
docs: The payload of data sent from Webflow
|
|
4345
|
-
source:
|
|
4346
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
4347
|
-
PageDeletedWebhookPayload:
|
|
4348
|
-
docs: The payload of data sent from Webflow
|
|
4349
|
-
properties:
|
|
4350
|
-
siteId: optional<string>
|
|
4351
|
-
pageId: optional<string>
|
|
4352
|
-
pageTitle: optional<string>
|
|
4353
|
-
deletedOn: optional<datetime>
|
|
4354
|
-
publishedPath: optional<string>
|
|
4355
|
-
source:
|
|
4356
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
4357
|
-
inline: true
|
|
4358
|
-
PageDeletedWebhook:
|
|
4359
|
-
docs: The Webhook payload for when a Page is deleted
|
|
4360
|
-
properties:
|
|
4361
|
-
triggerType:
|
|
4362
|
-
type: optional<string>
|
|
4363
|
-
docs: The type of event that triggered the request
|
|
4364
|
-
payload:
|
|
4365
|
-
type: optional<PageDeletedWebhookPayload>
|
|
4366
|
-
docs: The payload of data sent from Webflow
|
|
4367
|
-
source:
|
|
4368
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
4369
|
-
CommentPayloadAuthor:
|
|
4370
|
-
properties:
|
|
4371
|
-
userId:
|
|
4372
|
-
type: string
|
|
4373
|
-
docs: The unique identifier of the author
|
|
4374
|
-
email:
|
|
4375
|
-
type: string
|
|
4376
|
-
docs: Email of the author
|
|
4377
|
-
name:
|
|
4378
|
-
type: string
|
|
4379
|
-
docs: Name of the author
|
|
4380
|
-
source:
|
|
4381
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
4382
|
-
inline: true
|
|
4383
|
-
CommentPayloadMentionedUsersItem:
|
|
4384
|
-
properties:
|
|
4385
|
-
userId:
|
|
4386
|
-
type: string
|
|
4387
|
-
docs: The unique identifier of the mentioned user
|
|
4388
|
-
email:
|
|
4389
|
-
type: string
|
|
4390
|
-
docs: Email of the user
|
|
4391
|
-
name:
|
|
4392
|
-
type: string
|
|
4393
|
-
docs: Name of the User
|
|
4394
|
-
source:
|
|
4395
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
4396
|
-
inline: true
|
|
4397
|
-
CommentPayload:
|
|
4398
|
-
docs: >
|
|
4399
|
-
The comment webhook payload contains data for the thread and for replies.
|
|
4400
|
-
Check the type to determine if the payload is for a thread or a reply.
|
|
4401
|
-
The webhook payload may be delayed by up to 5 minutes.
|
|
4402
|
-
properties:
|
|
4403
|
-
threadId:
|
|
4404
|
-
type: optional<string>
|
|
4405
|
-
docs: Unique identifier for the comment thread
|
|
4406
|
-
access: read-only
|
|
4407
|
-
commentId:
|
|
4408
|
-
type: optional<string>
|
|
4409
|
-
docs: Unique identifier for the comment reply
|
|
4410
|
-
access: read-only
|
|
4411
|
-
type:
|
|
4412
|
-
type: optional<string>
|
|
4413
|
-
docs: The type of comment payload
|
|
4414
|
-
access: read-only
|
|
4415
|
-
siteId:
|
|
4416
|
-
type: optional<string>
|
|
4417
|
-
docs: The site unique identifier
|
|
4418
|
-
access: read-only
|
|
4419
|
-
pageId:
|
|
4420
|
-
type: optional<string>
|
|
4421
|
-
docs: The page unique identifier
|
|
4422
|
-
access: read-only
|
|
4423
|
-
localeId:
|
|
4424
|
-
type: optional<string>
|
|
4425
|
-
docs: The locale unique identifier
|
|
4426
|
-
access: read-only
|
|
4427
|
-
itemId:
|
|
4428
|
-
type: optional<string>
|
|
4429
|
-
docs: The item unique identifier
|
|
4430
|
-
access: read-only
|
|
4431
|
-
breakpoint:
|
|
4432
|
-
type: optional<string>
|
|
4433
|
-
docs: The breakpoint the comment was left on
|
|
4434
|
-
access: read-only
|
|
4435
|
-
url:
|
|
4436
|
-
type: optional<string>
|
|
4437
|
-
docs: The URL of the page the comment was left on
|
|
4438
|
-
access: read-only
|
|
4439
|
-
content:
|
|
4440
|
-
type: string
|
|
4441
|
-
docs: The content of the comment reply
|
|
4442
|
-
isResolved:
|
|
4443
|
-
type: boolean
|
|
4444
|
-
docs: Boolean determining if the comment thread is resolved
|
|
4445
|
-
default: false
|
|
4446
|
-
author: CommentPayloadAuthor
|
|
4447
|
-
mentionedUsers:
|
|
4448
|
-
docs: >-
|
|
4449
|
-
List of mentioned users. This is an empty array until email
|
|
4450
|
-
notifications are sent, which can take up to 5 minutes after the
|
|
4451
|
-
comment is created.
|
|
4452
|
-
type: list<CommentPayloadMentionedUsersItem>
|
|
4453
|
-
createdOn:
|
|
4454
|
-
type: optional<string>
|
|
4455
|
-
docs: The date the item was created
|
|
4456
|
-
access: read-only
|
|
4457
|
-
lastUpdated:
|
|
4458
|
-
type: optional<string>
|
|
4459
|
-
docs: The date the item was last updated
|
|
4460
|
-
access: read-only
|
|
4461
|
-
source:
|
|
4462
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|
|
4463
|
-
Comment:
|
|
4464
|
-
docs: The Webhook payload for when a comment thread or reply is made on a Site
|
|
4465
|
-
properties:
|
|
4466
|
-
triggerType:
|
|
4467
|
-
type: optional<string>
|
|
4468
|
-
docs: The type of event that triggered the request
|
|
4469
|
-
payload: optional<CommentPayload>
|
|
4470
|
-
source:
|
|
4471
|
-
openapi: ../../../openapi/referenced-specs/v2.yml
|