webflow-api 2.3.1 → 2.3.5
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/Client.d.ts +4 -0
- package/api/errors/BadRequestError.d.ts +1 -1
- package/api/errors/BadRequestError.js +1 -1
- package/api/errors/ConflictError.d.ts +1 -1
- package/api/errors/ConflictError.js +1 -1
- package/api/errors/ForbiddenError.d.ts +1 -1
- package/api/errors/ForbiddenError.js +1 -1
- package/api/errors/InternalServerError.d.ts +1 -1
- package/api/errors/InternalServerError.js +1 -1
- package/api/errors/NotFoundError.d.ts +1 -1
- package/api/errors/NotFoundError.js +1 -1
- package/api/errors/TooManyRequestsError.d.ts +1 -1
- package/api/errors/TooManyRequestsError.js +1 -1
- package/api/errors/UnauthorizedError.d.ts +1 -1
- package/api/errors/UnauthorizedError.js +1 -1
- package/api/errors/index.d.ts +2 -2
- package/api/errors/index.js +2 -2
- package/api/resources/accessGroups/client/Client.d.ts +11 -2
- package/api/resources/accessGroups/client/Client.js +12 -6
- package/api/resources/accessGroups/client/requests/AccessGroupsListRequest.d.ts +1 -1
- package/api/resources/accessGroups/client/requests/index.d.ts +1 -1
- package/api/resources/assets/client/Client.d.ts +50 -13
- package/api/resources/assets/client/Client.js +72 -31
- package/api/resources/assets/client/requests/AssetsCreateFolderRequest.d.ts +1 -2
- package/api/resources/assets/client/requests/AssetsCreateRequest.d.ts +1 -2
- package/api/resources/assets/client/requests/index.d.ts +3 -3
- package/api/resources/collections/client/Client.d.ts +32 -6
- package/api/resources/collections/client/Client.js +45 -18
- package/api/resources/collections/client/requests/index.d.ts +1 -1
- package/api/resources/collections/resources/fields/client/Client.d.ts +18 -3
- package/api/resources/collections/resources/fields/client/Client.js +22 -9
- package/api/resources/collections/resources/fields/client/requests/FieldCreate.d.ts +1 -1
- package/api/resources/collections/resources/fields/client/requests/index.d.ts +2 -2
- package/api/resources/collections/resources/fields/types/FieldCreateType.d.ts +2 -2
- package/api/resources/collections/resources/fields/types/FieldCreateType.js +1 -1
- package/api/resources/collections/resources/items/client/Client.d.ts +108 -20
- package/api/resources/collections/resources/items/client/Client.js +312 -58
- package/api/resources/collections/resources/items/client/requests/BulkCollectionItem.d.ts +2 -8
- package/api/resources/collections/resources/items/client/requests/ItemsDeleteItemLiveRequest.d.ts +13 -0
- package/api/resources/collections/resources/items/client/requests/ItemsDeleteItemLiveRequest.js +5 -0
- package/api/resources/collections/resources/items/client/requests/ItemsDeleteItemRequest.d.ts +2 -2
- package/api/resources/collections/resources/items/client/requests/ItemsGetItemLiveRequest.d.ts +13 -0
- package/api/resources/collections/resources/items/client/requests/ItemsGetItemLiveRequest.js +5 -0
- package/api/resources/collections/resources/items/client/requests/ItemsGetItemRequest.d.ts +1 -1
- package/api/resources/collections/resources/items/client/requests/ItemsListItemsLiveRequest.d.ts +38 -0
- package/api/resources/collections/resources/items/client/requests/ItemsListItemsLiveRequest.js +5 -0
- package/api/resources/collections/resources/items/client/requests/ItemsListItemsRequest.d.ts +19 -2
- package/api/resources/collections/resources/items/client/requests/index.d.ts +8 -5
- package/api/resources/collections/resources/items/types/ItemsListItemsLiveRequestSortBy.d.ts +9 -0
- package/api/resources/collections/resources/items/types/ItemsListItemsLiveRequestSortBy.js +11 -0
- package/api/resources/collections/resources/items/types/ItemsListItemsLiveRequestSortOrder.d.ts +8 -0
- package/api/resources/collections/resources/items/types/ItemsListItemsLiveRequestSortOrder.js +10 -0
- package/api/resources/collections/resources/items/types/ItemsListItemsRequestSortBy.d.ts +9 -0
- package/api/resources/collections/resources/items/types/ItemsListItemsRequestSortBy.js +11 -0
- package/api/resources/collections/resources/items/types/ItemsListItemsRequestSortOrder.d.ts +8 -0
- package/api/resources/collections/resources/items/types/ItemsListItemsRequestSortOrder.js +10 -0
- package/api/resources/collections/resources/items/types/index.d.ts +4 -0
- package/api/resources/collections/resources/items/types/index.js +4 -0
- package/api/resources/ecommerce/client/Client.d.ts +10 -2
- package/api/resources/ecommerce/client/Client.js +11 -6
- package/api/resources/forms/client/Client.d.ts +32 -6
- package/api/resources/forms/client/Client.js +45 -18
- package/api/resources/forms/client/requests/index.d.ts +2 -2
- package/api/resources/inventory/client/Client.d.ts +19 -6
- package/api/resources/inventory/client/Client.js +23 -12
- package/api/resources/inventory/client/requests/InventoryUpdateRequest.d.ts +2 -4
- package/api/resources/inventory/client/requests/index.d.ts +1 -1
- package/api/resources/orders/client/Client.d.ts +44 -12
- package/api/resources/orders/client/Client.js +60 -26
- package/api/resources/orders/client/requests/OrdersListRequest.d.ts +2 -1
- package/api/resources/orders/client/requests/OrdersRefundRequest.d.ts +1 -1
- package/api/resources/orders/client/requests/OrdersUpdateRequest.d.ts +1 -6
- package/api/resources/orders/client/requests/index.d.ts +4 -4
- package/api/resources/orders/types/OrdersListRequestStatus.d.ts +12 -0
- package/api/resources/orders/types/OrdersListRequestStatus.js +14 -0
- package/api/resources/orders/types/index.d.ts +1 -0
- package/api/resources/orders/types/index.js +1 -0
- package/api/resources/pages/client/Client.d.ts +37 -12
- package/api/resources/pages/client/Client.js +57 -25
- package/api/resources/pages/client/requests/DomWrite.d.ts +1 -4
- package/api/resources/pages/client/requests/PagesGetContentRequest.d.ts +8 -0
- package/api/resources/pages/client/requests/UpdatePageSettingsRequest.d.ts +1 -2
- package/api/resources/pages/client/requests/index.d.ts +5 -5
- package/api/resources/pages/resources/scripts/client/Client.d.ts +24 -11
- package/api/resources/pages/resources/scripts/client/Client.js +31 -19
- package/api/resources/products/client/Client.d.ts +47 -89
- package/api/resources/products/client/Client.js +63 -103
- package/api/resources/products/client/requests/ProductSkuCreate.d.ts +2 -27
- package/api/resources/products/client/requests/ProductSkuUpdate.d.ts +2 -27
- package/api/resources/products/client/requests/ProductsCreateSkuRequest.d.ts +2 -17
- package/api/resources/products/client/requests/ProductsUpdateSkuRequest.d.ts +2 -17
- package/api/resources/products/client/requests/index.d.ts +5 -5
- package/api/resources/products/types/ProductsCreateSkuResponse.d.ts +1 -1
- package/api/resources/scripts/client/Client.d.ts +25 -7
- package/api/resources/scripts/client/Client.js +32 -15
- package/api/resources/scripts/client/requests/CustomCodeHostedRequest.d.ts +1 -1
- package/api/resources/scripts/client/requests/CustomCodeInlineRequest.d.ts +1 -1
- package/api/resources/scripts/client/requests/index.d.ts +2 -2
- package/api/resources/sites/client/Client.d.ts +25 -8
- package/api/resources/sites/client/Client.js +34 -17
- package/api/resources/sites/client/requests/SitesPublishRequest.d.ts +1 -4
- package/api/resources/sites/client/requests/index.d.ts +1 -1
- package/api/resources/sites/resources/activityLogs/client/Client.d.ts +11 -2
- package/api/resources/sites/resources/activityLogs/client/Client.js +12 -6
- package/api/resources/sites/resources/activityLogs/client/requests/index.d.ts +1 -1
- package/api/resources/sites/resources/scripts/client/Client.d.ts +31 -13
- package/api/resources/sites/resources/scripts/client/Client.js +41 -23
- package/api/resources/sites/resources/scripts/client/requests/index.d.ts +1 -1
- package/api/resources/token/client/Client.d.ts +14 -4
- package/api/resources/token/client/Client.js +16 -8
- package/api/resources/users/client/Client.d.ts +38 -8
- package/api/resources/users/client/Client.js +51 -20
- package/api/resources/users/client/requests/UsersInviteRequest.d.ts +1 -1
- package/api/resources/users/client/requests/UsersListRequest.d.ts +1 -1
- package/api/resources/users/client/requests/UsersUpdateRequest.d.ts +2 -2
- package/api/resources/users/client/requests/index.d.ts +3 -3
- package/api/resources/webhooks/client/Client.d.ts +27 -6
- package/api/resources/webhooks/client/Client.js +37 -16
- package/api/resources/webhooks/client/requests/WebhooksCreateRequest.d.ts +1 -1
- package/api/resources/webhooks/client/requests/index.d.ts +1 -1
- package/api/types/AccessGroupList.d.ts +1 -1
- package/api/types/Asset.d.ts +1 -1
- package/api/types/AssetFolderList.d.ts +1 -1
- package/api/types/AssetUpload.d.ts +1 -1
- package/api/types/Assets.d.ts +1 -1
- package/api/types/Authorization.d.ts +1 -1
- package/api/types/AuthorizationAuthorization.d.ts +1 -1
- package/api/types/BadRequestErrorBody.d.ts +5 -0
- package/api/types/BadRequestErrorBody.js +5 -0
- package/api/types/Collection.d.ts +2 -1
- package/api/types/CollectionItem.d.ts +1 -1
- package/api/types/CollectionItemList.d.ts +1 -1
- package/api/types/CollectionList.d.ts +1 -1
- package/api/types/ConflictErrorBody.d.ts +5 -0
- package/api/types/ConflictErrorBody.js +5 -0
- package/api/types/CustomCodeBlock.d.ts +1 -1
- package/api/types/CustomCodeHostedResponse.d.ts +1 -1
- package/api/types/CustomCodeInlineResponse.d.ts +1 -1
- package/api/types/Dom.d.ts +1 -1
- package/api/types/Domains.d.ts +1 -1
- package/api/types/DuplicateUserEmail.d.ts +2 -11
- package/api/types/Error_.d.ts +1 -1
- package/api/types/Field.d.ts +1 -1
- package/api/types/FieldType.d.ts +2 -2
- package/api/types/FieldType.js +1 -1
- package/api/types/ForbiddenErrorBody.d.ts +10 -0
- package/api/types/ForbiddenErrorBody.js +5 -0
- package/api/types/Form.d.ts +1 -1
- package/api/types/FormField.d.ts +1 -1
- package/api/types/FormFieldValue.d.ts +1 -1
- package/api/types/FormList.d.ts +1 -1
- package/api/types/FormSubmissionList.d.ts +1 -1
- package/api/types/InventoryItem.d.ts +1 -1
- package/api/types/ListCustomCodeBlocks.d.ts +1 -1
- package/api/types/Locales.d.ts +1 -1
- package/api/types/MissingScopes.d.ts +2 -11
- package/api/types/Node.d.ts +1 -1
- package/api/types/NotEnterprisePlanSite.d.ts +2 -11
- package/api/types/OauthScope.d.ts +9 -1
- package/api/types/OauthScope.js +2 -0
- package/api/types/Order.d.ts +1 -1
- package/api/types/OrderAddress.d.ts +1 -1
- package/api/types/OrderList.d.ts +1 -1
- package/api/types/OrderPurchasedItem.d.ts +1 -1
- package/api/types/OrderPurchasedItemVariantImage.d.ts +1 -1
- package/api/types/OrderPurchasedItemVariantImageFile.d.ts +1 -1
- package/api/types/OrderTotals.d.ts +1 -1
- package/api/types/OrderTotalsExtrasItem.d.ts +1 -1
- package/api/types/Page.d.ts +1 -1
- package/api/types/PageDetails.d.ts +41 -0
- package/api/types/PageDetails.js +5 -0
- package/api/types/PageDetailsOpenGraph.d.ts +16 -0
- package/api/types/PageDetailsOpenGraph.js +5 -0
- package/api/types/PageDetailsSeo.d.ts +12 -0
- package/api/types/PageDetailsSeo.js +5 -0
- package/api/types/PageList.d.ts +1 -1
- package/api/types/Product.d.ts +1 -1
- package/api/types/ProductAndSkUs.d.ts +1 -1
- package/api/types/ProductAndSkUsList.d.ts +1 -1
- package/api/types/ProductFieldData.d.ts +1 -1
- package/api/types/RegisteredScriptList.d.ts +1 -1
- package/api/types/ScriptApply.d.ts +1 -1
- package/api/types/ScriptApplyList.d.ts +1 -1
- package/api/types/Scripts.d.ts +1 -1
- package/api/types/Site.d.ts +1 -1
- package/api/types/SiteActivityLogItem.d.ts +1 -1
- package/api/types/SiteActivityLogResponse.d.ts +1 -1
- package/api/types/Sites.d.ts +1 -1
- package/api/types/Sku.d.ts +1 -1
- package/api/types/SkuFieldData.d.ts +1 -1
- package/api/types/SkuFieldDataEcSkuSubscriptionPlan.d.ts +1 -1
- package/api/types/SkuFieldDataEcSkuSubscriptionPlanPlansItem.d.ts +2 -1
- package/api/types/SkuPropertyList.d.ts +1 -1
- package/api/types/StripeCard.d.ts +1 -1
- package/api/types/User.d.ts +1 -1
- package/api/types/UserAccessGroupsItem.d.ts +1 -1
- package/api/types/UserData.d.ts +1 -1
- package/api/types/UserLimitReached.d.ts +2 -11
- package/api/types/UserList.d.ts +1 -1
- package/api/types/UsersNotEnabled.d.ts +2 -11
- package/api/types/Webhook.d.ts +1 -1
- package/api/types/WebhookList.d.ts +1 -1
- package/api/types/index.d.ts +6 -0
- package/api/types/index.js +6 -0
- package/core/fetcher/Fetcher.d.ts +2 -1
- package/core/fetcher/Fetcher.js +126 -19
- package/core/runtime/runtime.d.ts +1 -1
- package/core/runtime/runtime.js +11 -1
- package/core/schemas/builders/object/object.js +11 -15
- package/dist/Client.d.ts +4 -0
- package/dist/api/errors/BadRequestError.d.ts +1 -1
- package/dist/api/errors/BadRequestError.js +1 -1
- package/dist/api/errors/ConflictError.d.ts +1 -1
- package/dist/api/errors/ConflictError.js +1 -1
- package/dist/api/errors/ForbiddenError.d.ts +1 -1
- package/dist/api/errors/ForbiddenError.js +1 -1
- package/dist/api/errors/InternalServerError.d.ts +1 -1
- package/dist/api/errors/InternalServerError.js +1 -1
- package/dist/api/errors/NotFoundError.d.ts +1 -1
- package/dist/api/errors/NotFoundError.js +1 -1
- package/dist/api/errors/TooManyRequestsError.d.ts +1 -1
- package/dist/api/errors/TooManyRequestsError.js +1 -1
- package/dist/api/errors/UnauthorizedError.d.ts +1 -1
- package/dist/api/errors/UnauthorizedError.js +1 -1
- package/dist/api/errors/index.d.ts +2 -2
- package/dist/api/errors/index.js +2 -2
- package/dist/api/resources/accessGroups/client/Client.d.ts +11 -2
- package/dist/api/resources/accessGroups/client/Client.js +12 -6
- package/dist/api/resources/accessGroups/client/requests/AccessGroupsListRequest.d.ts +1 -1
- package/dist/api/resources/accessGroups/client/requests/index.d.ts +1 -1
- package/dist/api/resources/assets/client/Client.d.ts +50 -13
- package/dist/api/resources/assets/client/Client.js +72 -31
- package/dist/api/resources/assets/client/requests/AssetsCreateFolderRequest.d.ts +1 -2
- package/dist/api/resources/assets/client/requests/AssetsCreateRequest.d.ts +1 -2
- package/dist/api/resources/assets/client/requests/index.d.ts +3 -3
- package/dist/api/resources/collections/client/Client.d.ts +32 -6
- package/dist/api/resources/collections/client/Client.js +45 -18
- package/dist/api/resources/collections/client/requests/index.d.ts +1 -1
- package/dist/api/resources/collections/resources/fields/client/Client.d.ts +18 -3
- package/dist/api/resources/collections/resources/fields/client/Client.js +22 -9
- package/dist/api/resources/collections/resources/fields/client/requests/FieldCreate.d.ts +1 -1
- package/dist/api/resources/collections/resources/fields/client/requests/index.d.ts +2 -2
- package/dist/api/resources/collections/resources/fields/types/FieldCreateType.d.ts +2 -2
- package/dist/api/resources/collections/resources/fields/types/FieldCreateType.js +1 -1
- package/dist/api/resources/collections/resources/items/client/Client.d.ts +108 -20
- package/dist/api/resources/collections/resources/items/client/Client.js +312 -58
- package/dist/api/resources/collections/resources/items/client/requests/BulkCollectionItem.d.ts +2 -8
- package/dist/api/resources/collections/resources/items/client/requests/ItemsDeleteItemLiveRequest.d.ts +13 -0
- package/dist/api/resources/collections/resources/items/client/requests/ItemsDeleteItemLiveRequest.js +5 -0
- package/dist/api/resources/collections/resources/items/client/requests/ItemsDeleteItemRequest.d.ts +2 -2
- package/dist/api/resources/collections/resources/items/client/requests/ItemsGetItemLiveRequest.d.ts +13 -0
- package/dist/api/resources/collections/resources/items/client/requests/ItemsGetItemLiveRequest.js +5 -0
- package/dist/api/resources/collections/resources/items/client/requests/ItemsGetItemRequest.d.ts +1 -1
- package/dist/api/resources/collections/resources/items/client/requests/ItemsListItemsLiveRequest.d.ts +38 -0
- package/dist/api/resources/collections/resources/items/client/requests/ItemsListItemsLiveRequest.js +5 -0
- package/dist/api/resources/collections/resources/items/client/requests/ItemsListItemsRequest.d.ts +19 -2
- package/dist/api/resources/collections/resources/items/client/requests/index.d.ts +8 -5
- package/dist/api/resources/collections/resources/items/types/ItemsListItemsLiveRequestSortBy.d.ts +9 -0
- package/dist/api/resources/collections/resources/items/types/ItemsListItemsLiveRequestSortBy.js +11 -0
- package/dist/api/resources/collections/resources/items/types/ItemsListItemsLiveRequestSortOrder.d.ts +8 -0
- package/dist/api/resources/collections/resources/items/types/ItemsListItemsLiveRequestSortOrder.js +10 -0
- package/dist/api/resources/collections/resources/items/types/ItemsListItemsRequestSortBy.d.ts +9 -0
- package/dist/api/resources/collections/resources/items/types/ItemsListItemsRequestSortBy.js +11 -0
- package/dist/api/resources/collections/resources/items/types/ItemsListItemsRequestSortOrder.d.ts +8 -0
- package/dist/api/resources/collections/resources/items/types/ItemsListItemsRequestSortOrder.js +10 -0
- package/dist/api/resources/collections/resources/items/types/index.d.ts +4 -0
- package/dist/api/resources/collections/resources/items/types/index.js +4 -0
- package/dist/api/resources/ecommerce/client/Client.d.ts +10 -2
- package/dist/api/resources/ecommerce/client/Client.js +11 -6
- package/dist/api/resources/forms/client/Client.d.ts +32 -6
- package/dist/api/resources/forms/client/Client.js +45 -18
- package/dist/api/resources/forms/client/requests/index.d.ts +2 -2
- package/dist/api/resources/inventory/client/Client.d.ts +19 -6
- package/dist/api/resources/inventory/client/Client.js +23 -12
- package/dist/api/resources/inventory/client/requests/InventoryUpdateRequest.d.ts +2 -4
- package/dist/api/resources/inventory/client/requests/index.d.ts +1 -1
- package/dist/api/resources/orders/client/Client.d.ts +44 -12
- package/dist/api/resources/orders/client/Client.js +60 -26
- package/dist/api/resources/orders/client/requests/OrdersListRequest.d.ts +2 -1
- package/dist/api/resources/orders/client/requests/OrdersRefundRequest.d.ts +1 -1
- package/dist/api/resources/orders/client/requests/OrdersUpdateRequest.d.ts +1 -6
- package/dist/api/resources/orders/client/requests/index.d.ts +4 -4
- package/dist/api/resources/orders/types/OrdersListRequestStatus.d.ts +12 -0
- package/dist/api/resources/orders/types/OrdersListRequestStatus.js +14 -0
- package/dist/api/resources/orders/types/index.d.ts +1 -0
- package/dist/api/resources/orders/types/index.js +1 -0
- package/dist/api/resources/pages/client/Client.d.ts +37 -12
- package/dist/api/resources/pages/client/Client.js +57 -25
- package/dist/api/resources/pages/client/requests/DomWrite.d.ts +1 -4
- package/dist/api/resources/pages/client/requests/PagesGetContentRequest.d.ts +8 -0
- package/dist/api/resources/pages/client/requests/UpdatePageSettingsRequest.d.ts +1 -2
- package/dist/api/resources/pages/client/requests/index.d.ts +5 -5
- package/dist/api/resources/pages/resources/scripts/client/Client.d.ts +24 -11
- package/dist/api/resources/pages/resources/scripts/client/Client.js +31 -19
- package/dist/api/resources/products/client/Client.d.ts +47 -89
- package/dist/api/resources/products/client/Client.js +63 -103
- package/dist/api/resources/products/client/requests/ProductSkuCreate.d.ts +2 -27
- package/dist/api/resources/products/client/requests/ProductSkuUpdate.d.ts +2 -27
- package/dist/api/resources/products/client/requests/ProductsCreateSkuRequest.d.ts +2 -17
- package/dist/api/resources/products/client/requests/ProductsUpdateSkuRequest.d.ts +2 -17
- package/dist/api/resources/products/client/requests/index.d.ts +5 -5
- package/dist/api/resources/products/types/ProductsCreateSkuResponse.d.ts +1 -1
- package/dist/api/resources/scripts/client/Client.d.ts +25 -7
- package/dist/api/resources/scripts/client/Client.js +32 -15
- package/dist/api/resources/scripts/client/requests/CustomCodeHostedRequest.d.ts +1 -1
- package/dist/api/resources/scripts/client/requests/CustomCodeInlineRequest.d.ts +1 -1
- package/dist/api/resources/scripts/client/requests/index.d.ts +2 -2
- package/dist/api/resources/sites/client/Client.d.ts +25 -8
- package/dist/api/resources/sites/client/Client.js +34 -17
- package/dist/api/resources/sites/client/requests/SitesPublishRequest.d.ts +1 -4
- package/dist/api/resources/sites/client/requests/index.d.ts +1 -1
- package/dist/api/resources/sites/resources/activityLogs/client/Client.d.ts +11 -2
- package/dist/api/resources/sites/resources/activityLogs/client/Client.js +12 -6
- package/dist/api/resources/sites/resources/activityLogs/client/requests/index.d.ts +1 -1
- package/dist/api/resources/sites/resources/scripts/client/Client.d.ts +31 -13
- package/dist/api/resources/sites/resources/scripts/client/Client.js +41 -23
- package/dist/api/resources/sites/resources/scripts/client/requests/index.d.ts +1 -1
- package/dist/api/resources/token/client/Client.d.ts +14 -4
- package/dist/api/resources/token/client/Client.js +16 -8
- package/dist/api/resources/users/client/Client.d.ts +38 -8
- package/dist/api/resources/users/client/Client.js +51 -20
- package/dist/api/resources/users/client/requests/UsersInviteRequest.d.ts +1 -1
- package/dist/api/resources/users/client/requests/UsersListRequest.d.ts +1 -1
- package/dist/api/resources/users/client/requests/UsersUpdateRequest.d.ts +2 -2
- package/dist/api/resources/users/client/requests/index.d.ts +3 -3
- package/dist/api/resources/webhooks/client/Client.d.ts +27 -6
- package/dist/api/resources/webhooks/client/Client.js +37 -16
- package/dist/api/resources/webhooks/client/requests/WebhooksCreateRequest.d.ts +1 -1
- package/dist/api/resources/webhooks/client/requests/index.d.ts +1 -1
- package/dist/api/types/AccessGroupList.d.ts +1 -1
- package/dist/api/types/Asset.d.ts +1 -1
- package/dist/api/types/AssetFolderList.d.ts +1 -1
- package/dist/api/types/AssetUpload.d.ts +1 -1
- package/dist/api/types/Assets.d.ts +1 -1
- package/dist/api/types/Authorization.d.ts +1 -1
- package/dist/api/types/AuthorizationAuthorization.d.ts +1 -1
- package/dist/api/types/BadRequestErrorBody.d.ts +5 -0
- package/dist/api/types/BadRequestErrorBody.js +5 -0
- package/dist/api/types/Collection.d.ts +2 -1
- package/dist/api/types/CollectionItem.d.ts +1 -1
- package/dist/api/types/CollectionItemList.d.ts +1 -1
- package/dist/api/types/CollectionList.d.ts +1 -1
- package/dist/api/types/ConflictErrorBody.d.ts +5 -0
- package/dist/api/types/ConflictErrorBody.js +5 -0
- package/dist/api/types/CustomCodeBlock.d.ts +1 -1
- package/dist/api/types/CustomCodeHostedResponse.d.ts +1 -1
- package/dist/api/types/CustomCodeInlineResponse.d.ts +1 -1
- package/dist/api/types/Dom.d.ts +1 -1
- package/dist/api/types/Domains.d.ts +1 -1
- package/dist/api/types/DuplicateUserEmail.d.ts +2 -11
- package/dist/api/types/Error_.d.ts +1 -1
- package/dist/api/types/Field.d.ts +1 -1
- package/dist/api/types/FieldType.d.ts +2 -2
- package/dist/api/types/FieldType.js +1 -1
- package/dist/api/types/ForbiddenErrorBody.d.ts +10 -0
- package/dist/api/types/ForbiddenErrorBody.js +5 -0
- package/dist/api/types/Form.d.ts +1 -1
- package/dist/api/types/FormField.d.ts +1 -1
- package/dist/api/types/FormFieldValue.d.ts +1 -1
- package/dist/api/types/FormList.d.ts +1 -1
- package/dist/api/types/FormSubmissionList.d.ts +1 -1
- package/dist/api/types/InventoryItem.d.ts +1 -1
- package/dist/api/types/ListCustomCodeBlocks.d.ts +1 -1
- package/dist/api/types/Locales.d.ts +1 -1
- package/dist/api/types/MissingScopes.d.ts +2 -11
- package/dist/api/types/Node.d.ts +1 -1
- package/dist/api/types/NotEnterprisePlanSite.d.ts +2 -11
- package/dist/api/types/OauthScope.d.ts +9 -1
- package/dist/api/types/OauthScope.js +2 -0
- package/dist/api/types/Order.d.ts +1 -1
- package/dist/api/types/OrderAddress.d.ts +1 -1
- package/dist/api/types/OrderList.d.ts +1 -1
- package/dist/api/types/OrderPurchasedItem.d.ts +1 -1
- package/dist/api/types/OrderPurchasedItemVariantImage.d.ts +1 -1
- package/dist/api/types/OrderPurchasedItemVariantImageFile.d.ts +1 -1
- package/dist/api/types/OrderTotals.d.ts +1 -1
- package/dist/api/types/OrderTotalsExtrasItem.d.ts +1 -1
- package/dist/api/types/Page.d.ts +1 -1
- package/dist/api/types/PageDetails.d.ts +41 -0
- package/dist/api/types/PageDetails.js +5 -0
- package/dist/api/types/PageDetailsOpenGraph.d.ts +16 -0
- package/dist/api/types/PageDetailsOpenGraph.js +5 -0
- package/dist/api/types/PageDetailsSeo.d.ts +12 -0
- package/dist/api/types/PageDetailsSeo.js +5 -0
- package/dist/api/types/PageList.d.ts +1 -1
- package/dist/api/types/Product.d.ts +1 -1
- package/dist/api/types/ProductAndSkUs.d.ts +1 -1
- package/dist/api/types/ProductAndSkUsList.d.ts +1 -1
- package/dist/api/types/ProductFieldData.d.ts +1 -1
- package/dist/api/types/RegisteredScriptList.d.ts +1 -1
- package/dist/api/types/ScriptApply.d.ts +1 -1
- package/dist/api/types/ScriptApplyList.d.ts +1 -1
- package/dist/api/types/Scripts.d.ts +1 -1
- package/dist/api/types/Site.d.ts +1 -1
- package/dist/api/types/SiteActivityLogItem.d.ts +1 -1
- package/dist/api/types/SiteActivityLogResponse.d.ts +1 -1
- package/dist/api/types/Sites.d.ts +1 -1
- package/dist/api/types/Sku.d.ts +1 -1
- package/dist/api/types/SkuFieldData.d.ts +1 -1
- package/dist/api/types/SkuFieldDataEcSkuSubscriptionPlan.d.ts +1 -1
- package/dist/api/types/SkuFieldDataEcSkuSubscriptionPlanPlansItem.d.ts +2 -1
- package/dist/api/types/SkuPropertyList.d.ts +1 -1
- package/dist/api/types/StripeCard.d.ts +1 -1
- package/dist/api/types/User.d.ts +1 -1
- package/dist/api/types/UserAccessGroupsItem.d.ts +1 -1
- package/dist/api/types/UserData.d.ts +1 -1
- package/dist/api/types/UserLimitReached.d.ts +2 -11
- package/dist/api/types/UserList.d.ts +1 -1
- package/dist/api/types/UsersNotEnabled.d.ts +2 -11
- package/dist/api/types/Webhook.d.ts +1 -1
- package/dist/api/types/WebhookList.d.ts +1 -1
- package/dist/api/types/index.d.ts +6 -0
- package/dist/api/types/index.js +6 -0
- package/dist/core/fetcher/Fetcher.d.ts +2 -1
- package/dist/core/fetcher/Fetcher.js +126 -19
- package/dist/core/runtime/runtime.d.ts +1 -1
- package/dist/core/runtime/runtime.js +11 -1
- package/dist/core/schemas/builders/object/object.js +11 -15
- package/dist/serialization/resources/accessGroups/types/AccessGroupsListRequestSort.d.ts +2 -2
- package/dist/serialization/resources/assets/client/requests/AssetsCreateFolderRequest.d.ts +2 -2
- package/dist/serialization/resources/assets/client/requests/AssetsCreateRequest.d.ts +2 -2
- package/dist/serialization/resources/assets/client/requests/AssetsUpdateRequest.d.ts +2 -2
- package/dist/serialization/resources/collections/client/requests/CollectionsCreateRequest.d.ts +2 -2
- package/dist/serialization/resources/collections/resources/fields/client/requests/FieldCreate.d.ts +4 -3
- package/dist/serialization/resources/collections/resources/fields/client/requests/FieldCreate.js +2 -10
- package/dist/serialization/resources/collections/resources/fields/client/requests/FieldUpdate.d.ts +2 -2
- package/dist/serialization/resources/collections/resources/fields/types/FieldCreateType.d.ts +3 -3
- package/dist/serialization/resources/collections/resources/fields/types/FieldCreateType.js +1 -1
- package/dist/serialization/resources/collections/resources/items/client/requests/BulkCollectionItem.d.ts +4 -3
- package/dist/serialization/resources/collections/resources/items/client/requests/BulkCollectionItem.js +2 -12
- package/dist/serialization/resources/collections/resources/items/client/requests/ItemsPublishItemRequest.d.ts +2 -2
- package/dist/serialization/resources/collections/resources/items/types/BulkCollectionItemFieldData.d.ts +2 -2
- package/dist/serialization/resources/collections/resources/items/types/ItemsListItemsLiveRequestSortBy.d.ts +10 -0
- package/dist/serialization/resources/collections/resources/items/types/ItemsListItemsLiveRequestSortBy.js +31 -0
- package/dist/serialization/resources/collections/resources/items/types/ItemsListItemsLiveRequestSortOrder.d.ts +10 -0
- package/dist/serialization/resources/collections/resources/items/types/ItemsListItemsLiveRequestSortOrder.js +31 -0
- package/dist/serialization/resources/collections/resources/items/types/ItemsListItemsRequestSortBy.d.ts +10 -0
- package/dist/serialization/resources/collections/resources/items/types/ItemsListItemsRequestSortBy.js +31 -0
- package/dist/serialization/resources/collections/resources/items/types/ItemsListItemsRequestSortOrder.d.ts +10 -0
- package/dist/serialization/resources/collections/resources/items/types/ItemsListItemsRequestSortOrder.js +31 -0
- package/dist/serialization/resources/collections/resources/items/types/index.d.ts +4 -0
- package/dist/serialization/resources/collections/resources/items/types/index.js +4 -0
- package/dist/serialization/resources/forms/client/requests/FormsUpdateSubmissionRequest.d.ts +2 -2
- package/dist/serialization/resources/inventory/client/requests/InventoryUpdateRequest.d.ts +4 -3
- package/dist/serialization/resources/inventory/client/requests/InventoryUpdateRequest.js +2 -10
- package/dist/serialization/resources/inventory/types/InventoryUpdateRequestInventoryType.d.ts +2 -2
- package/dist/serialization/resources/orders/client/requests/OrdersRefundRequest.d.ts +4 -3
- package/dist/serialization/resources/orders/client/requests/OrdersRefundRequest.js +2 -10
- package/dist/serialization/resources/orders/client/requests/OrdersUpdateFulfillRequest.d.ts +2 -2
- package/dist/serialization/resources/orders/client/requests/OrdersUpdateRequest.d.ts +2 -2
- package/dist/serialization/resources/orders/types/OrdersListRequestStatus.d.ts +10 -0
- package/dist/serialization/resources/orders/types/OrdersListRequestStatus.js +31 -0
- package/dist/serialization/resources/orders/types/OrdersRefundRequestReason.d.ts +2 -2
- package/dist/serialization/resources/orders/types/index.d.ts +1 -0
- package/dist/serialization/resources/orders/types/index.js +1 -0
- package/dist/serialization/resources/pages/client/requests/DomWrite.d.ts +4 -3
- package/dist/serialization/resources/pages/client/requests/DomWrite.js +2 -10
- package/dist/serialization/resources/pages/types/DomWriteNodesItem.d.ts +2 -2
- package/dist/serialization/resources/pages/types/UpdateStaticContentResponse.d.ts +2 -2
- package/dist/serialization/resources/products/client/requests/ProductSkuCreate.d.ts +8 -5
- package/dist/serialization/resources/products/client/requests/ProductSkuCreate.js +6 -12
- package/dist/serialization/resources/products/client/requests/ProductSkuUpdate.d.ts +8 -5
- package/dist/serialization/resources/products/client/requests/ProductSkuUpdate.js +6 -12
- package/dist/serialization/resources/products/client/requests/ProductsCreateSkuRequest.d.ts +6 -4
- package/dist/serialization/resources/products/client/requests/ProductsCreateSkuRequest.js +4 -11
- package/dist/serialization/resources/products/client/requests/ProductsUpdateSkuRequest.d.ts +6 -4
- package/dist/serialization/resources/products/client/requests/ProductsUpdateSkuRequest.js +4 -11
- package/dist/serialization/resources/products/types/ProductsCreateSkuResponse.d.ts +4 -3
- package/dist/serialization/resources/products/types/ProductsCreateSkuResponse.js +2 -10
- package/dist/serialization/resources/scripts/client/requests/CustomCodeHostedRequest.d.ts +2 -2
- package/dist/serialization/resources/scripts/client/requests/CustomCodeInlineRequest.d.ts +2 -2
- package/dist/serialization/resources/sites/client/requests/SitesPublishRequest.d.ts +2 -2
- package/dist/serialization/resources/users/client/requests/UsersInviteRequest.d.ts +2 -2
- package/dist/serialization/resources/users/client/requests/UsersUpdateRequest.d.ts +4 -3
- package/dist/serialization/resources/users/client/requests/UsersUpdateRequest.js +2 -10
- package/dist/serialization/resources/users/types/UsersListRequestSort.d.ts +2 -2
- package/dist/serialization/resources/users/types/UsersUpdateRequestData.d.ts +2 -2
- package/dist/serialization/resources/webhooks/client/requests/WebhooksCreateRequest.d.ts +4 -3
- package/dist/serialization/resources/webhooks/client/requests/WebhooksCreateRequest.js +2 -10
- package/dist/serialization/types/AccessGroup.d.ts +2 -2
- package/dist/serialization/types/AccessGroupList.d.ts +4 -3
- package/dist/serialization/types/AccessGroupList.js +2 -12
- package/dist/serialization/types/Application.d.ts +2 -2
- package/dist/serialization/types/Asset.d.ts +4 -3
- package/dist/serialization/types/Asset.js +2 -12
- package/dist/serialization/types/AssetFolder.d.ts +2 -2
- package/dist/serialization/types/AssetFolderList.d.ts +6 -4
- package/dist/serialization/types/AssetFolderList.js +4 -13
- package/dist/serialization/types/AssetUpload.d.ts +4 -3
- package/dist/serialization/types/AssetUpload.js +2 -12
- package/dist/serialization/types/AssetUploadUploadDetails.d.ts +2 -2
- package/dist/serialization/types/AssetVariant.d.ts +2 -2
- package/dist/serialization/types/Assets.d.ts +4 -3
- package/dist/serialization/types/Assets.js +2 -12
- package/dist/serialization/types/Authorization.d.ts +6 -4
- package/dist/serialization/types/Authorization.js +4 -13
- package/dist/serialization/types/AuthorizationAuthorization.d.ts +4 -3
- package/dist/serialization/types/AuthorizationAuthorization.js +2 -12
- package/dist/serialization/types/AuthorizationAuthorizationAuthorizedTo.d.ts +2 -2
- package/dist/serialization/types/AuthorizedUser.d.ts +2 -2
- package/dist/serialization/types/BadRequestErrorBody.d.ts +12 -0
- package/dist/serialization/types/BadRequestErrorBody.js +33 -0
- package/dist/serialization/types/Collection.d.ts +4 -3
- package/dist/serialization/types/Collection.js +2 -1
- package/dist/serialization/types/CollectionItem.d.ts +4 -3
- package/dist/serialization/types/CollectionItem.js +2 -10
- package/dist/serialization/types/CollectionItemFieldData.d.ts +2 -2
- package/dist/serialization/types/CollectionItemList.d.ts +6 -4
- package/dist/serialization/types/CollectionItemList.js +4 -13
- package/dist/serialization/types/CollectionItemListPagination.d.ts +2 -2
- package/dist/serialization/types/CollectionList.d.ts +4 -3
- package/dist/serialization/types/CollectionList.js +2 -12
- package/dist/serialization/types/CollectionListArrayItem.d.ts +2 -2
- package/dist/serialization/types/ConflictErrorBody.d.ts +12 -0
- package/dist/serialization/types/ConflictErrorBody.js +33 -0
- package/dist/serialization/types/CustomCodeBlock.d.ts +6 -4
- package/dist/serialization/types/CustomCodeBlock.js +4 -11
- package/dist/serialization/types/CustomCodeBlockType.d.ts +2 -2
- package/dist/serialization/types/CustomCodeHostedResponse.d.ts +2 -2
- package/dist/serialization/types/CustomCodeInlineResponse.d.ts +2 -2
- package/dist/serialization/types/Dom.d.ts +6 -4
- package/dist/serialization/types/Dom.js +4 -11
- package/dist/serialization/types/Domain.d.ts +2 -2
- package/dist/serialization/types/Domains.d.ts +4 -3
- package/dist/serialization/types/Domains.js +2 -12
- package/dist/serialization/types/DuplicateUserEmail.d.ts +4 -8
- package/dist/serialization/types/DuplicateUserEmail.js +2 -41
- package/dist/serialization/types/EcommerceSettings.d.ts +2 -2
- package/dist/serialization/types/ErrorDetailsItem.d.ts +2 -2
- package/dist/serialization/types/Error_.d.ts +4 -3
- package/dist/serialization/types/Error_.js +2 -12
- package/dist/serialization/types/Field.d.ts +4 -3
- package/dist/serialization/types/Field.js +2 -10
- package/dist/serialization/types/FieldType.d.ts +3 -3
- package/dist/serialization/types/FieldType.js +1 -1
- package/dist/serialization/types/ForbiddenErrorBody.d.ts +16 -0
- package/dist/serialization/types/ForbiddenErrorBody.js +37 -0
- package/dist/serialization/types/Form.d.ts +6 -4
- package/dist/serialization/types/Form.js +4 -11
- package/dist/serialization/types/FormField.d.ts +4 -3
- package/dist/serialization/types/FormField.js +2 -10
- package/dist/serialization/types/FormFieldValue.d.ts +4 -3
- package/dist/serialization/types/FormFieldValue.js +2 -10
- package/dist/serialization/types/FormFieldValueType.d.ts +2 -2
- package/dist/serialization/types/FormList.d.ts +6 -4
- package/dist/serialization/types/FormList.js +4 -11
- package/dist/serialization/types/FormResponseSettings.d.ts +2 -2
- package/dist/serialization/types/FormSubmission.d.ts +2 -2
- package/dist/serialization/types/FormSubmissionList.d.ts +6 -4
- package/dist/serialization/types/FormSubmissionList.js +4 -13
- package/dist/serialization/types/ImageNode.d.ts +2 -2
- package/dist/serialization/types/InvalidDomain.d.ts +2 -2
- package/dist/serialization/types/InventoryItem.d.ts +4 -3
- package/dist/serialization/types/InventoryItem.js +2 -10
- package/dist/serialization/types/InventoryItemInventoryType.d.ts +2 -2
- package/dist/serialization/types/ListCustomCodeBlocks.d.ts +6 -4
- package/dist/serialization/types/ListCustomCodeBlocks.js +4 -13
- package/dist/serialization/types/Locale.d.ts +2 -2
- package/dist/serialization/types/Locales.d.ts +5 -4
- package/dist/serialization/types/Locales.js +3 -13
- package/dist/serialization/types/MissingScopes.d.ts +4 -9
- package/dist/serialization/types/MissingScopes.js +2 -42
- package/dist/serialization/types/NoDomains.d.ts +2 -2
- package/dist/serialization/types/Node.d.ts +8 -5
- package/dist/serialization/types/Node.js +6 -12
- package/dist/serialization/types/NodeType.d.ts +2 -2
- package/dist/serialization/types/NotEnterprisePlanSite.d.ts +4 -9
- package/dist/serialization/types/NotEnterprisePlanSite.js +2 -42
- package/dist/serialization/types/OauthScope.d.ts +3 -3
- package/dist/serialization/types/OauthScope.js +2 -0
- package/dist/serialization/types/Order.d.ts +30 -18
- package/dist/serialization/types/Order.js +28 -31
- package/dist/serialization/types/OrderAddress.d.ts +6 -4
- package/dist/serialization/types/OrderAddress.js +4 -11
- package/dist/serialization/types/OrderAddressJapanType.d.ts +2 -2
- package/dist/serialization/types/OrderAddressType.d.ts +2 -2
- package/dist/serialization/types/OrderCustomerInfo.d.ts +2 -2
- package/dist/serialization/types/OrderDisputeLastStatus.d.ts +2 -2
- package/dist/serialization/types/OrderDownloadFilesItem.d.ts +2 -2
- package/dist/serialization/types/OrderList.d.ts +6 -4
- package/dist/serialization/types/OrderList.js +4 -13
- package/dist/serialization/types/OrderMetadata.d.ts +2 -2
- package/dist/serialization/types/OrderPrice.d.ts +2 -2
- package/dist/serialization/types/OrderPurchasedItem.d.ts +7 -5
- package/dist/serialization/types/OrderPurchasedItem.js +5 -14
- package/dist/serialization/types/OrderPurchasedItemVariantImage.d.ts +4 -3
- package/dist/serialization/types/OrderPurchasedItemVariantImage.js +2 -10
- package/dist/serialization/types/OrderPurchasedItemVariantImageFile.d.ts +4 -3
- package/dist/serialization/types/OrderPurchasedItemVariantImageFile.js +2 -12
- package/dist/serialization/types/OrderPurchasedItemVariantImageFileVariantsItem.d.ts +2 -2
- package/dist/serialization/types/OrderStatus.d.ts +2 -2
- package/dist/serialization/types/OrderTotals.d.ts +7 -5
- package/dist/serialization/types/OrderTotals.js +5 -14
- package/dist/serialization/types/OrderTotalsExtrasItem.d.ts +6 -4
- package/dist/serialization/types/OrderTotalsExtrasItem.js +4 -11
- package/dist/serialization/types/OrderTotalsExtrasItemType.d.ts +2 -2
- package/dist/serialization/types/Page.d.ts +6 -4
- package/dist/serialization/types/Page.js +4 -11
- package/dist/serialization/types/PageDetails.d.ts +29 -0
- package/dist/serialization/types/PageDetails.js +50 -0
- package/dist/serialization/types/PageDetailsOpenGraph.d.ts +15 -0
- package/dist/serialization/types/PageDetailsOpenGraph.js +36 -0
- package/dist/serialization/types/PageDetailsSeo.d.ts +13 -0
- package/dist/serialization/types/PageDetailsSeo.js +34 -0
- package/dist/serialization/types/PageList.d.ts +6 -4
- package/dist/serialization/types/PageList.js +4 -11
- package/dist/serialization/types/PageOpenGraph.d.ts +2 -2
- package/dist/serialization/types/PageSeo.d.ts +2 -2
- package/dist/serialization/types/Pagination.d.ts +2 -2
- package/dist/serialization/types/PaypalDetails.d.ts +2 -2
- package/dist/serialization/types/Product.d.ts +4 -3
- package/dist/serialization/types/Product.js +2 -10
- package/dist/serialization/types/ProductAndSkUs.d.ts +6 -4
- package/dist/serialization/types/ProductAndSkUs.js +4 -11
- package/dist/serialization/types/ProductAndSkUsList.d.ts +6 -4
- package/dist/serialization/types/ProductAndSkUsList.js +4 -13
- package/dist/serialization/types/ProductFieldData.d.ts +8 -5
- package/dist/serialization/types/ProductFieldData.js +6 -14
- package/dist/serialization/types/ProductFieldDataEcProductType.d.ts +2 -2
- package/dist/serialization/types/ProductFieldDataTaxCategory.d.ts +2 -2
- package/dist/serialization/types/PublishStatus.d.ts +2 -2
- package/dist/serialization/types/RegisteredScriptList.d.ts +4 -3
- package/dist/serialization/types/RegisteredScriptList.js +2 -12
- package/dist/serialization/types/ScriptApply.d.ts +4 -3
- package/dist/serialization/types/ScriptApply.js +2 -10
- package/dist/serialization/types/ScriptApplyList.d.ts +4 -3
- package/dist/serialization/types/ScriptApplyList.js +2 -12
- package/dist/serialization/types/ScriptApplyLocation.d.ts +2 -2
- package/dist/serialization/types/Scripts.d.ts +4 -3
- package/dist/serialization/types/Scripts.js +2 -10
- package/dist/serialization/types/Site.d.ts +6 -4
- package/dist/serialization/types/Site.js +4 -13
- package/dist/serialization/types/SiteActivityLogItem.d.ts +6 -4
- package/dist/serialization/types/SiteActivityLogItem.js +4 -13
- package/dist/serialization/types/SiteActivityLogItemResourceOperation.d.ts +2 -2
- package/dist/serialization/types/SiteActivityLogItemUser.d.ts +2 -2
- package/dist/serialization/types/SiteActivityLogResponse.d.ts +6 -4
- package/dist/serialization/types/SiteActivityLogResponse.js +4 -13
- package/dist/serialization/types/Sites.d.ts +4 -3
- package/dist/serialization/types/Sites.js +2 -10
- package/dist/serialization/types/Sku.d.ts +4 -3
- package/dist/serialization/types/Sku.js +2 -10
- package/dist/serialization/types/SkuFieldData.d.ts +12 -7
- package/dist/serialization/types/SkuFieldData.js +10 -14
- package/dist/serialization/types/SkuFieldDataCompareAtPrice.d.ts +2 -2
- package/dist/serialization/types/SkuFieldDataEcSkuBillingMethod.d.ts +2 -2
- package/dist/serialization/types/SkuFieldDataEcSkuSubscriptionPlan.d.ts +6 -4
- package/dist/serialization/types/SkuFieldDataEcSkuSubscriptionPlan.js +4 -15
- package/dist/serialization/types/SkuFieldDataEcSkuSubscriptionPlanInterval.d.ts +2 -2
- package/dist/serialization/types/SkuFieldDataEcSkuSubscriptionPlanPlansItem.d.ts +4 -3
- package/dist/serialization/types/SkuFieldDataEcSkuSubscriptionPlanPlansItem.js +2 -12
- package/dist/serialization/types/SkuFieldDataEcSkuSubscriptionPlanPlansItemStatus.d.ts +2 -2
- package/dist/serialization/types/SkuFieldDataPrice.d.ts +2 -2
- package/dist/serialization/types/SkuPropertyList.d.ts +4 -3
- package/dist/serialization/types/SkuPropertyList.js +2 -10
- package/dist/serialization/types/SkuPropertyListEnumItem.d.ts +2 -2
- package/dist/serialization/types/SkuValueList.d.ts +2 -2
- package/dist/serialization/types/StripeCard.d.ts +6 -4
- package/dist/serialization/types/StripeCard.js +4 -11
- package/dist/serialization/types/StripeCardBrand.d.ts +2 -2
- package/dist/serialization/types/StripeCardExpires.d.ts +2 -2
- package/dist/serialization/types/StripeDetails.d.ts +2 -2
- package/dist/serialization/types/TextNode.d.ts +2 -2
- package/dist/serialization/types/TriggerType.d.ts +2 -2
- package/dist/serialization/types/User.d.ts +8 -5
- package/dist/serialization/types/User.js +6 -14
- package/dist/serialization/types/UserAccessGroupsItem.d.ts +4 -3
- package/dist/serialization/types/UserAccessGroupsItem.js +2 -10
- package/dist/serialization/types/UserAccessGroupsItemType.d.ts +2 -2
- package/dist/serialization/types/UserData.d.ts +4 -3
- package/dist/serialization/types/UserData.js +2 -10
- package/dist/serialization/types/UserDataData.d.ts +2 -2
- package/dist/serialization/types/UserLimitReached.d.ts +4 -8
- package/dist/serialization/types/UserLimitReached.js +2 -41
- package/dist/serialization/types/UserList.d.ts +4 -3
- package/dist/serialization/types/UserList.js +2 -10
- package/dist/serialization/types/UserStatus.d.ts +2 -2
- package/dist/serialization/types/UsersNotEnabled.d.ts +4 -8
- package/dist/serialization/types/UsersNotEnabled.js +2 -41
- package/dist/serialization/types/Webhook.d.ts +4 -3
- package/dist/serialization/types/Webhook.js +2 -10
- package/dist/serialization/types/WebhookList.d.ts +6 -4
- package/dist/serialization/types/WebhookList.js +4 -13
- package/dist/serialization/types/index.d.ts +6 -0
- package/dist/serialization/types/index.js +6 -0
- package/jest.config.js +2 -2
- package/package.json +13 -6
- package/serialization/resources/accessGroups/types/AccessGroupsListRequestSort.d.ts +2 -2
- package/serialization/resources/assets/client/requests/AssetsCreateFolderRequest.d.ts +2 -2
- package/serialization/resources/assets/client/requests/AssetsCreateRequest.d.ts +2 -2
- package/serialization/resources/assets/client/requests/AssetsUpdateRequest.d.ts +2 -2
- package/serialization/resources/collections/client/requests/CollectionsCreateRequest.d.ts +2 -2
- package/serialization/resources/collections/resources/fields/client/requests/FieldCreate.d.ts +4 -3
- package/serialization/resources/collections/resources/fields/client/requests/FieldCreate.js +2 -10
- package/serialization/resources/collections/resources/fields/client/requests/FieldUpdate.d.ts +2 -2
- package/serialization/resources/collections/resources/fields/types/FieldCreateType.d.ts +3 -3
- package/serialization/resources/collections/resources/fields/types/FieldCreateType.js +1 -1
- package/serialization/resources/collections/resources/items/client/requests/BulkCollectionItem.d.ts +4 -3
- package/serialization/resources/collections/resources/items/client/requests/BulkCollectionItem.js +2 -12
- package/serialization/resources/collections/resources/items/client/requests/ItemsPublishItemRequest.d.ts +2 -2
- package/serialization/resources/collections/resources/items/types/BulkCollectionItemFieldData.d.ts +2 -2
- package/serialization/resources/collections/resources/items/types/ItemsListItemsLiveRequestSortBy.d.ts +10 -0
- package/serialization/resources/collections/resources/items/types/ItemsListItemsLiveRequestSortBy.js +31 -0
- package/serialization/resources/collections/resources/items/types/ItemsListItemsLiveRequestSortOrder.d.ts +10 -0
- package/serialization/resources/collections/resources/items/types/ItemsListItemsLiveRequestSortOrder.js +31 -0
- package/serialization/resources/collections/resources/items/types/ItemsListItemsRequestSortBy.d.ts +10 -0
- package/serialization/resources/collections/resources/items/types/ItemsListItemsRequestSortBy.js +31 -0
- package/serialization/resources/collections/resources/items/types/ItemsListItemsRequestSortOrder.d.ts +10 -0
- package/serialization/resources/collections/resources/items/types/ItemsListItemsRequestSortOrder.js +31 -0
- package/serialization/resources/collections/resources/items/types/index.d.ts +4 -0
- package/serialization/resources/collections/resources/items/types/index.js +4 -0
- package/serialization/resources/forms/client/requests/FormsUpdateSubmissionRequest.d.ts +2 -2
- package/serialization/resources/inventory/client/requests/InventoryUpdateRequest.d.ts +4 -3
- package/serialization/resources/inventory/client/requests/InventoryUpdateRequest.js +2 -10
- package/serialization/resources/inventory/types/InventoryUpdateRequestInventoryType.d.ts +2 -2
- package/serialization/resources/orders/client/requests/OrdersRefundRequest.d.ts +4 -3
- package/serialization/resources/orders/client/requests/OrdersRefundRequest.js +2 -10
- package/serialization/resources/orders/client/requests/OrdersUpdateFulfillRequest.d.ts +2 -2
- package/serialization/resources/orders/client/requests/OrdersUpdateRequest.d.ts +2 -2
- package/serialization/resources/orders/types/OrdersListRequestStatus.d.ts +10 -0
- package/serialization/resources/orders/types/OrdersListRequestStatus.js +31 -0
- package/serialization/resources/orders/types/OrdersRefundRequestReason.d.ts +2 -2
- package/serialization/resources/orders/types/index.d.ts +1 -0
- package/serialization/resources/orders/types/index.js +1 -0
- package/serialization/resources/pages/client/requests/DomWrite.d.ts +4 -3
- package/serialization/resources/pages/client/requests/DomWrite.js +2 -10
- package/serialization/resources/pages/types/DomWriteNodesItem.d.ts +2 -2
- package/serialization/resources/pages/types/UpdateStaticContentResponse.d.ts +2 -2
- package/serialization/resources/products/client/requests/ProductSkuCreate.d.ts +8 -5
- package/serialization/resources/products/client/requests/ProductSkuCreate.js +6 -12
- package/serialization/resources/products/client/requests/ProductSkuUpdate.d.ts +8 -5
- package/serialization/resources/products/client/requests/ProductSkuUpdate.js +6 -12
- package/serialization/resources/products/client/requests/ProductsCreateSkuRequest.d.ts +6 -4
- package/serialization/resources/products/client/requests/ProductsCreateSkuRequest.js +4 -11
- package/serialization/resources/products/client/requests/ProductsUpdateSkuRequest.d.ts +6 -4
- package/serialization/resources/products/client/requests/ProductsUpdateSkuRequest.js +4 -11
- package/serialization/resources/products/types/ProductsCreateSkuResponse.d.ts +4 -3
- package/serialization/resources/products/types/ProductsCreateSkuResponse.js +2 -10
- package/serialization/resources/scripts/client/requests/CustomCodeHostedRequest.d.ts +2 -2
- package/serialization/resources/scripts/client/requests/CustomCodeInlineRequest.d.ts +2 -2
- package/serialization/resources/sites/client/requests/SitesPublishRequest.d.ts +2 -2
- package/serialization/resources/users/client/requests/UsersInviteRequest.d.ts +2 -2
- package/serialization/resources/users/client/requests/UsersUpdateRequest.d.ts +4 -3
- package/serialization/resources/users/client/requests/UsersUpdateRequest.js +2 -10
- package/serialization/resources/users/types/UsersListRequestSort.d.ts +2 -2
- package/serialization/resources/users/types/UsersUpdateRequestData.d.ts +2 -2
- package/serialization/resources/webhooks/client/requests/WebhooksCreateRequest.d.ts +4 -3
- package/serialization/resources/webhooks/client/requests/WebhooksCreateRequest.js +2 -10
- package/serialization/types/AccessGroup.d.ts +2 -2
- package/serialization/types/AccessGroupList.d.ts +4 -3
- package/serialization/types/AccessGroupList.js +2 -12
- package/serialization/types/Application.d.ts +2 -2
- package/serialization/types/Asset.d.ts +4 -3
- package/serialization/types/Asset.js +2 -12
- package/serialization/types/AssetFolder.d.ts +2 -2
- package/serialization/types/AssetFolderList.d.ts +6 -4
- package/serialization/types/AssetFolderList.js +4 -13
- package/serialization/types/AssetUpload.d.ts +4 -3
- package/serialization/types/AssetUpload.js +2 -12
- package/serialization/types/AssetUploadUploadDetails.d.ts +2 -2
- package/serialization/types/AssetVariant.d.ts +2 -2
- package/serialization/types/Assets.d.ts +4 -3
- package/serialization/types/Assets.js +2 -12
- package/serialization/types/Authorization.d.ts +6 -4
- package/serialization/types/Authorization.js +4 -13
- package/serialization/types/AuthorizationAuthorization.d.ts +4 -3
- package/serialization/types/AuthorizationAuthorization.js +2 -12
- package/serialization/types/AuthorizationAuthorizationAuthorizedTo.d.ts +2 -2
- package/serialization/types/AuthorizedUser.d.ts +2 -2
- package/serialization/types/BadRequestErrorBody.d.ts +12 -0
- package/serialization/types/BadRequestErrorBody.js +33 -0
- package/serialization/types/Collection.d.ts +4 -3
- package/serialization/types/Collection.js +2 -1
- package/serialization/types/CollectionItem.d.ts +4 -3
- package/serialization/types/CollectionItem.js +2 -10
- package/serialization/types/CollectionItemFieldData.d.ts +2 -2
- package/serialization/types/CollectionItemList.d.ts +6 -4
- package/serialization/types/CollectionItemList.js +4 -13
- package/serialization/types/CollectionItemListPagination.d.ts +2 -2
- package/serialization/types/CollectionList.d.ts +4 -3
- package/serialization/types/CollectionList.js +2 -12
- package/serialization/types/CollectionListArrayItem.d.ts +2 -2
- package/serialization/types/ConflictErrorBody.d.ts +12 -0
- package/serialization/types/ConflictErrorBody.js +33 -0
- package/serialization/types/CustomCodeBlock.d.ts +6 -4
- package/serialization/types/CustomCodeBlock.js +4 -11
- package/serialization/types/CustomCodeBlockType.d.ts +2 -2
- package/serialization/types/CustomCodeHostedResponse.d.ts +2 -2
- package/serialization/types/CustomCodeInlineResponse.d.ts +2 -2
- package/serialization/types/Dom.d.ts +6 -4
- package/serialization/types/Dom.js +4 -11
- package/serialization/types/Domain.d.ts +2 -2
- package/serialization/types/Domains.d.ts +4 -3
- package/serialization/types/Domains.js +2 -12
- package/serialization/types/DuplicateUserEmail.d.ts +4 -8
- package/serialization/types/DuplicateUserEmail.js +2 -41
- package/serialization/types/EcommerceSettings.d.ts +2 -2
- package/serialization/types/ErrorDetailsItem.d.ts +2 -2
- package/serialization/types/Error_.d.ts +4 -3
- package/serialization/types/Error_.js +2 -12
- package/serialization/types/Field.d.ts +4 -3
- package/serialization/types/Field.js +2 -10
- package/serialization/types/FieldType.d.ts +3 -3
- package/serialization/types/FieldType.js +1 -1
- package/serialization/types/ForbiddenErrorBody.d.ts +16 -0
- package/serialization/types/ForbiddenErrorBody.js +37 -0
- package/serialization/types/Form.d.ts +6 -4
- package/serialization/types/Form.js +4 -11
- package/serialization/types/FormField.d.ts +4 -3
- package/serialization/types/FormField.js +2 -10
- package/serialization/types/FormFieldValue.d.ts +4 -3
- package/serialization/types/FormFieldValue.js +2 -10
- package/serialization/types/FormFieldValueType.d.ts +2 -2
- package/serialization/types/FormList.d.ts +6 -4
- package/serialization/types/FormList.js +4 -11
- package/serialization/types/FormResponseSettings.d.ts +2 -2
- package/serialization/types/FormSubmission.d.ts +2 -2
- package/serialization/types/FormSubmissionList.d.ts +6 -4
- package/serialization/types/FormSubmissionList.js +4 -13
- package/serialization/types/ImageNode.d.ts +2 -2
- package/serialization/types/InvalidDomain.d.ts +2 -2
- package/serialization/types/InventoryItem.d.ts +4 -3
- package/serialization/types/InventoryItem.js +2 -10
- package/serialization/types/InventoryItemInventoryType.d.ts +2 -2
- package/serialization/types/ListCustomCodeBlocks.d.ts +6 -4
- package/serialization/types/ListCustomCodeBlocks.js +4 -13
- package/serialization/types/Locale.d.ts +2 -2
- package/serialization/types/Locales.d.ts +5 -4
- package/serialization/types/Locales.js +3 -13
- package/serialization/types/MissingScopes.d.ts +4 -9
- package/serialization/types/MissingScopes.js +2 -42
- package/serialization/types/NoDomains.d.ts +2 -2
- package/serialization/types/Node.d.ts +8 -5
- package/serialization/types/Node.js +6 -12
- package/serialization/types/NodeType.d.ts +2 -2
- package/serialization/types/NotEnterprisePlanSite.d.ts +4 -9
- package/serialization/types/NotEnterprisePlanSite.js +2 -42
- package/serialization/types/OauthScope.d.ts +3 -3
- package/serialization/types/OauthScope.js +2 -0
- package/serialization/types/Order.d.ts +30 -18
- package/serialization/types/Order.js +28 -31
- package/serialization/types/OrderAddress.d.ts +6 -4
- package/serialization/types/OrderAddress.js +4 -11
- package/serialization/types/OrderAddressJapanType.d.ts +2 -2
- package/serialization/types/OrderAddressType.d.ts +2 -2
- package/serialization/types/OrderCustomerInfo.d.ts +2 -2
- package/serialization/types/OrderDisputeLastStatus.d.ts +2 -2
- package/serialization/types/OrderDownloadFilesItem.d.ts +2 -2
- package/serialization/types/OrderList.d.ts +6 -4
- package/serialization/types/OrderList.js +4 -13
- package/serialization/types/OrderMetadata.d.ts +2 -2
- package/serialization/types/OrderPrice.d.ts +2 -2
- package/serialization/types/OrderPurchasedItem.d.ts +7 -5
- package/serialization/types/OrderPurchasedItem.js +5 -14
- package/serialization/types/OrderPurchasedItemVariantImage.d.ts +4 -3
- package/serialization/types/OrderPurchasedItemVariantImage.js +2 -10
- package/serialization/types/OrderPurchasedItemVariantImageFile.d.ts +4 -3
- package/serialization/types/OrderPurchasedItemVariantImageFile.js +2 -12
- package/serialization/types/OrderPurchasedItemVariantImageFileVariantsItem.d.ts +2 -2
- package/serialization/types/OrderStatus.d.ts +2 -2
- package/serialization/types/OrderTotals.d.ts +7 -5
- package/serialization/types/OrderTotals.js +5 -14
- package/serialization/types/OrderTotalsExtrasItem.d.ts +6 -4
- package/serialization/types/OrderTotalsExtrasItem.js +4 -11
- package/serialization/types/OrderTotalsExtrasItemType.d.ts +2 -2
- package/serialization/types/Page.d.ts +6 -4
- package/serialization/types/Page.js +4 -11
- package/serialization/types/PageDetails.d.ts +29 -0
- package/serialization/types/PageDetails.js +50 -0
- package/serialization/types/PageDetailsOpenGraph.d.ts +15 -0
- package/serialization/types/PageDetailsOpenGraph.js +36 -0
- package/serialization/types/PageDetailsSeo.d.ts +13 -0
- package/serialization/types/PageDetailsSeo.js +34 -0
- package/serialization/types/PageList.d.ts +6 -4
- package/serialization/types/PageList.js +4 -11
- package/serialization/types/PageOpenGraph.d.ts +2 -2
- package/serialization/types/PageSeo.d.ts +2 -2
- package/serialization/types/Pagination.d.ts +2 -2
- package/serialization/types/PaypalDetails.d.ts +2 -2
- package/serialization/types/Product.d.ts +4 -3
- package/serialization/types/Product.js +2 -10
- package/serialization/types/ProductAndSkUs.d.ts +6 -4
- package/serialization/types/ProductAndSkUs.js +4 -11
- package/serialization/types/ProductAndSkUsList.d.ts +6 -4
- package/serialization/types/ProductAndSkUsList.js +4 -13
- package/serialization/types/ProductFieldData.d.ts +8 -5
- package/serialization/types/ProductFieldData.js +6 -14
- package/serialization/types/ProductFieldDataEcProductType.d.ts +2 -2
- package/serialization/types/ProductFieldDataTaxCategory.d.ts +2 -2
- package/serialization/types/PublishStatus.d.ts +2 -2
- package/serialization/types/RegisteredScriptList.d.ts +4 -3
- package/serialization/types/RegisteredScriptList.js +2 -12
- package/serialization/types/ScriptApply.d.ts +4 -3
- package/serialization/types/ScriptApply.js +2 -10
- package/serialization/types/ScriptApplyList.d.ts +4 -3
- package/serialization/types/ScriptApplyList.js +2 -12
- package/serialization/types/ScriptApplyLocation.d.ts +2 -2
- package/serialization/types/Scripts.d.ts +4 -3
- package/serialization/types/Scripts.js +2 -10
- package/serialization/types/Site.d.ts +6 -4
- package/serialization/types/Site.js +4 -13
- package/serialization/types/SiteActivityLogItem.d.ts +6 -4
- package/serialization/types/SiteActivityLogItem.js +4 -13
- package/serialization/types/SiteActivityLogItemResourceOperation.d.ts +2 -2
- package/serialization/types/SiteActivityLogItemUser.d.ts +2 -2
- package/serialization/types/SiteActivityLogResponse.d.ts +6 -4
- package/serialization/types/SiteActivityLogResponse.js +4 -13
- package/serialization/types/Sites.d.ts +4 -3
- package/serialization/types/Sites.js +2 -10
- package/serialization/types/Sku.d.ts +4 -3
- package/serialization/types/Sku.js +2 -10
- package/serialization/types/SkuFieldData.d.ts +12 -7
- package/serialization/types/SkuFieldData.js +10 -14
- package/serialization/types/SkuFieldDataCompareAtPrice.d.ts +2 -2
- package/serialization/types/SkuFieldDataEcSkuBillingMethod.d.ts +2 -2
- package/serialization/types/SkuFieldDataEcSkuSubscriptionPlan.d.ts +6 -4
- package/serialization/types/SkuFieldDataEcSkuSubscriptionPlan.js +4 -15
- package/serialization/types/SkuFieldDataEcSkuSubscriptionPlanInterval.d.ts +2 -2
- package/serialization/types/SkuFieldDataEcSkuSubscriptionPlanPlansItem.d.ts +4 -3
- package/serialization/types/SkuFieldDataEcSkuSubscriptionPlanPlansItem.js +2 -12
- package/serialization/types/SkuFieldDataEcSkuSubscriptionPlanPlansItemStatus.d.ts +2 -2
- package/serialization/types/SkuFieldDataPrice.d.ts +2 -2
- package/serialization/types/SkuPropertyList.d.ts +4 -3
- package/serialization/types/SkuPropertyList.js +2 -10
- package/serialization/types/SkuPropertyListEnumItem.d.ts +2 -2
- package/serialization/types/SkuValueList.d.ts +2 -2
- package/serialization/types/StripeCard.d.ts +6 -4
- package/serialization/types/StripeCard.js +4 -11
- package/serialization/types/StripeCardBrand.d.ts +2 -2
- package/serialization/types/StripeCardExpires.d.ts +2 -2
- package/serialization/types/StripeDetails.d.ts +2 -2
- package/serialization/types/TextNode.d.ts +2 -2
- package/serialization/types/TriggerType.d.ts +2 -2
- package/serialization/types/User.d.ts +8 -5
- package/serialization/types/User.js +6 -14
- package/serialization/types/UserAccessGroupsItem.d.ts +4 -3
- package/serialization/types/UserAccessGroupsItem.js +2 -10
- package/serialization/types/UserAccessGroupsItemType.d.ts +2 -2
- package/serialization/types/UserData.d.ts +4 -3
- package/serialization/types/UserData.js +2 -10
- package/serialization/types/UserDataData.d.ts +2 -2
- package/serialization/types/UserLimitReached.d.ts +4 -8
- package/serialization/types/UserLimitReached.js +2 -41
- package/serialization/types/UserList.d.ts +4 -3
- package/serialization/types/UserList.js +2 -10
- package/serialization/types/UserStatus.d.ts +2 -2
- package/serialization/types/UsersNotEnabled.d.ts +4 -8
- package/serialization/types/UsersNotEnabled.js +2 -41
- package/serialization/types/Webhook.d.ts +4 -3
- package/serialization/types/Webhook.js +2 -10
- package/serialization/types/WebhookList.d.ts +6 -4
- package/serialization/types/WebhookList.js +4 -13
- package/serialization/types/index.d.ts +6 -0
- package/serialization/types/index.js +6 -0
- package/tests/client.test.ts +0 -11
|
@@ -3,15 +3,19 @@
|
|
|
3
3
|
*/
|
|
4
4
|
import * as environments from "../../../../environments";
|
|
5
5
|
import * as core from "../../../../core";
|
|
6
|
-
import * as Webflow from "
|
|
6
|
+
import * as Webflow from "../../../index";
|
|
7
7
|
export declare namespace Users {
|
|
8
8
|
interface Options {
|
|
9
9
|
environment?: core.Supplier<environments.WebflowEnvironment | string>;
|
|
10
10
|
accessToken: core.Supplier<core.BearerToken>;
|
|
11
11
|
}
|
|
12
12
|
interface RequestOptions {
|
|
13
|
+
/** The maximum time to wait for a response in seconds. */
|
|
13
14
|
timeoutInSeconds?: number;
|
|
15
|
+
/** The number of times to retry the request. Defaults to 2. */
|
|
14
16
|
maxRetries?: number;
|
|
17
|
+
/** A hook to abort the request. */
|
|
18
|
+
abortSignal?: AbortSignal;
|
|
15
19
|
}
|
|
16
20
|
}
|
|
17
21
|
export declare class Users {
|
|
@@ -19,6 +23,11 @@ export declare class Users {
|
|
|
19
23
|
constructor(_options: Users.Options);
|
|
20
24
|
/**
|
|
21
25
|
* Get a list of users for a site <br><br> Required scope | `users:read`
|
|
26
|
+
*
|
|
27
|
+
* @param {string} siteId - Unique identifier for a Site
|
|
28
|
+
* @param {Webflow.UsersListRequest} request
|
|
29
|
+
* @param {Users.RequestOptions} requestOptions - Request-specific configuration.
|
|
30
|
+
*
|
|
22
31
|
* @throws {@link Webflow.BadRequestError}
|
|
23
32
|
* @throws {@link Webflow.UnauthorizedError}
|
|
24
33
|
* @throws {@link Webflow.ForbiddenError}
|
|
@@ -27,11 +36,16 @@ export declare class Users {
|
|
|
27
36
|
* @throws {@link Webflow.InternalServerError}
|
|
28
37
|
*
|
|
29
38
|
* @example
|
|
30
|
-
* await
|
|
39
|
+
* await client.users.list("site_id")
|
|
31
40
|
*/
|
|
32
41
|
list(siteId: string, request?: Webflow.UsersListRequest, requestOptions?: Users.RequestOptions): Promise<Webflow.UserList>;
|
|
33
42
|
/**
|
|
34
43
|
* Get a User by ID <br><br> Required scope | `users:read`
|
|
44
|
+
*
|
|
45
|
+
* @param {string} siteId - Unique identifier for a Site
|
|
46
|
+
* @param {string} userId - Unique identifier for a User
|
|
47
|
+
* @param {Users.RequestOptions} requestOptions - Request-specific configuration.
|
|
48
|
+
*
|
|
35
49
|
* @throws {@link Webflow.BadRequestError}
|
|
36
50
|
* @throws {@link Webflow.UnauthorizedError}
|
|
37
51
|
* @throws {@link Webflow.ForbiddenError}
|
|
@@ -40,11 +54,16 @@ export declare class Users {
|
|
|
40
54
|
* @throws {@link Webflow.InternalServerError}
|
|
41
55
|
*
|
|
42
56
|
* @example
|
|
43
|
-
* await
|
|
57
|
+
* await client.users.get("site_id", "user_id")
|
|
44
58
|
*/
|
|
45
59
|
get(siteId: string, userId: string, requestOptions?: Users.RequestOptions): Promise<Webflow.User>;
|
|
46
60
|
/**
|
|
47
61
|
* Delete a User by ID <br><br> Required scope | `users:write`
|
|
62
|
+
*
|
|
63
|
+
* @param {string} siteId - Unique identifier for a Site
|
|
64
|
+
* @param {string} userId - Unique identifier for a User
|
|
65
|
+
* @param {Users.RequestOptions} requestOptions - Request-specific configuration.
|
|
66
|
+
*
|
|
48
67
|
* @throws {@link Webflow.BadRequestError}
|
|
49
68
|
* @throws {@link Webflow.UnauthorizedError}
|
|
50
69
|
* @throws {@link Webflow.ForbiddenError}
|
|
@@ -53,13 +72,19 @@ export declare class Users {
|
|
|
53
72
|
* @throws {@link Webflow.InternalServerError}
|
|
54
73
|
*
|
|
55
74
|
* @example
|
|
56
|
-
* await
|
|
75
|
+
* await client.users.delete("site_id", "user_id")
|
|
57
76
|
*/
|
|
58
77
|
delete(siteId: string, userId: string, requestOptions?: Users.RequestOptions): Promise<void>;
|
|
59
78
|
/**
|
|
60
79
|
* Update a User by ID <br><br> Required scope | `users:write`
|
|
61
80
|
*
|
|
62
81
|
* <aside class="notice">The <code>email</code> and <code>password</code> fields cannot be updated using this endpoint</aside>
|
|
82
|
+
*
|
|
83
|
+
* @param {string} siteId - Unique identifier for a Site
|
|
84
|
+
* @param {string} userId - Unique identifier for a User
|
|
85
|
+
* @param {Webflow.UsersUpdateRequest} request
|
|
86
|
+
* @param {Users.RequestOptions} requestOptions - Request-specific configuration.
|
|
87
|
+
*
|
|
63
88
|
* @throws {@link Webflow.BadRequestError}
|
|
64
89
|
* @throws {@link Webflow.UnauthorizedError}
|
|
65
90
|
* @throws {@link Webflow.ForbiddenError}
|
|
@@ -68,18 +93,23 @@ export declare class Users {
|
|
|
68
93
|
* @throws {@link Webflow.InternalServerError}
|
|
69
94
|
*
|
|
70
95
|
* @example
|
|
71
|
-
* await
|
|
96
|
+
* await client.users.update("site_id", "user_id", {
|
|
72
97
|
* data: {
|
|
73
98
|
* name: "Some One",
|
|
74
99
|
* acceptPrivacy: false,
|
|
75
100
|
* acceptCommunications: false
|
|
76
101
|
* },
|
|
77
|
-
* accessGroups: ["webflowers", "platinum", "free-tier"
|
|
102
|
+
* accessGroups: ["webflowers", "platinum", "free-tier"]
|
|
78
103
|
* })
|
|
79
104
|
*/
|
|
80
105
|
update(siteId: string, userId: string, request?: Webflow.UsersUpdateRequest, requestOptions?: Users.RequestOptions): Promise<Webflow.User>;
|
|
81
106
|
/**
|
|
82
107
|
* Create and invite a user with an email address. The user will be sent and invite via email, which they will need to accept in order to join paid Access Groups. <br><br> Required scope | `users:write`
|
|
108
|
+
*
|
|
109
|
+
* @param {string} siteId - Unique identifier for a Site
|
|
110
|
+
* @param {Webflow.UsersInviteRequest} request
|
|
111
|
+
* @param {Users.RequestOptions} requestOptions - Request-specific configuration.
|
|
112
|
+
*
|
|
83
113
|
* @throws {@link Webflow.BadRequestError}
|
|
84
114
|
* @throws {@link Webflow.UnauthorizedError}
|
|
85
115
|
* @throws {@link Webflow.ForbiddenError}
|
|
@@ -89,9 +119,9 @@ export declare class Users {
|
|
|
89
119
|
* @throws {@link Webflow.InternalServerError}
|
|
90
120
|
*
|
|
91
121
|
* @example
|
|
92
|
-
* await
|
|
122
|
+
* await client.users.invite("site_id", {
|
|
93
123
|
* email: "some.one@home.com",
|
|
94
|
-
* accessGroups: ["webflowers"
|
|
124
|
+
* accessGroups: ["webflowers"]
|
|
95
125
|
* })
|
|
96
126
|
*/
|
|
97
127
|
invite(siteId: string, request: Webflow.UsersInviteRequest, requestOptions?: Users.RequestOptions): Promise<Webflow.User>;
|
|
@@ -41,16 +41,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
41
41
|
exports.Users = void 0;
|
|
42
42
|
const environments = __importStar(require("../../../../environments"));
|
|
43
43
|
const core = __importStar(require("../../../../core"));
|
|
44
|
-
const Webflow = __importStar(require("
|
|
44
|
+
const Webflow = __importStar(require("../../../index"));
|
|
45
45
|
const url_join_1 = __importDefault(require("url-join"));
|
|
46
|
-
const serializers = __importStar(require("../../../../serialization"));
|
|
47
|
-
const errors = __importStar(require("../../../../errors"));
|
|
46
|
+
const serializers = __importStar(require("../../../../serialization/index"));
|
|
47
|
+
const errors = __importStar(require("../../../../errors/index"));
|
|
48
48
|
class Users {
|
|
49
49
|
constructor(_options) {
|
|
50
50
|
this._options = _options;
|
|
51
51
|
}
|
|
52
52
|
/**
|
|
53
53
|
* Get a list of users for a site <br><br> Required scope | `users:read`
|
|
54
|
+
*
|
|
55
|
+
* @param {string} siteId - Unique identifier for a Site
|
|
56
|
+
* @param {Webflow.UsersListRequest} request
|
|
57
|
+
* @param {Users.RequestOptions} requestOptions - Request-specific configuration.
|
|
58
|
+
*
|
|
54
59
|
* @throws {@link Webflow.BadRequestError}
|
|
55
60
|
* @throws {@link Webflow.UnauthorizedError}
|
|
56
61
|
* @throws {@link Webflow.ForbiddenError}
|
|
@@ -59,7 +64,7 @@ class Users {
|
|
|
59
64
|
* @throws {@link Webflow.InternalServerError}
|
|
60
65
|
*
|
|
61
66
|
* @example
|
|
62
|
-
* await
|
|
67
|
+
* await client.users.list("site_id")
|
|
63
68
|
*/
|
|
64
69
|
list(siteId, request = {}, requestOptions) {
|
|
65
70
|
var _a;
|
|
@@ -76,13 +81,13 @@ class Users {
|
|
|
76
81
|
_queryParams["sort"] = sort;
|
|
77
82
|
}
|
|
78
83
|
const _response = yield core.fetcher({
|
|
79
|
-
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${siteId}/users`),
|
|
84
|
+
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}/users`),
|
|
80
85
|
method: "GET",
|
|
81
86
|
headers: {
|
|
82
87
|
Authorization: yield this._getAuthorizationHeader(),
|
|
83
88
|
"X-Fern-Language": "JavaScript",
|
|
84
89
|
"X-Fern-SDK-Name": "webflow-api",
|
|
85
|
-
"X-Fern-SDK-Version": "2.3.
|
|
90
|
+
"X-Fern-SDK-Version": "2.3.5",
|
|
86
91
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
87
92
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
88
93
|
},
|
|
@@ -90,6 +95,7 @@ class Users {
|
|
|
90
95
|
queryParameters: _queryParams,
|
|
91
96
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
92
97
|
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
98
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
93
99
|
});
|
|
94
100
|
if (_response.ok) {
|
|
95
101
|
return yield serializers.UserList.parseOrThrow(_response.body, {
|
|
@@ -138,6 +144,11 @@ class Users {
|
|
|
138
144
|
}
|
|
139
145
|
/**
|
|
140
146
|
* Get a User by ID <br><br> Required scope | `users:read`
|
|
147
|
+
*
|
|
148
|
+
* @param {string} siteId - Unique identifier for a Site
|
|
149
|
+
* @param {string} userId - Unique identifier for a User
|
|
150
|
+
* @param {Users.RequestOptions} requestOptions - Request-specific configuration.
|
|
151
|
+
*
|
|
141
152
|
* @throws {@link Webflow.BadRequestError}
|
|
142
153
|
* @throws {@link Webflow.UnauthorizedError}
|
|
143
154
|
* @throws {@link Webflow.ForbiddenError}
|
|
@@ -146,25 +157,26 @@ class Users {
|
|
|
146
157
|
* @throws {@link Webflow.InternalServerError}
|
|
147
158
|
*
|
|
148
159
|
* @example
|
|
149
|
-
* await
|
|
160
|
+
* await client.users.get("site_id", "user_id")
|
|
150
161
|
*/
|
|
151
162
|
get(siteId, userId, requestOptions) {
|
|
152
163
|
var _a;
|
|
153
164
|
return __awaiter(this, void 0, void 0, function* () {
|
|
154
165
|
const _response = yield core.fetcher({
|
|
155
|
-
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${siteId}/users/${userId}`),
|
|
166
|
+
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}/users/${encodeURIComponent(userId)}`),
|
|
156
167
|
method: "GET",
|
|
157
168
|
headers: {
|
|
158
169
|
Authorization: yield this._getAuthorizationHeader(),
|
|
159
170
|
"X-Fern-Language": "JavaScript",
|
|
160
171
|
"X-Fern-SDK-Name": "webflow-api",
|
|
161
|
-
"X-Fern-SDK-Version": "2.3.
|
|
172
|
+
"X-Fern-SDK-Version": "2.3.5",
|
|
162
173
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
163
174
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
164
175
|
},
|
|
165
176
|
contentType: "application/json",
|
|
166
177
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
167
178
|
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
179
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
168
180
|
});
|
|
169
181
|
if (_response.ok) {
|
|
170
182
|
return yield serializers.User.parseOrThrow(_response.body, {
|
|
@@ -213,6 +225,11 @@ class Users {
|
|
|
213
225
|
}
|
|
214
226
|
/**
|
|
215
227
|
* Delete a User by ID <br><br> Required scope | `users:write`
|
|
228
|
+
*
|
|
229
|
+
* @param {string} siteId - Unique identifier for a Site
|
|
230
|
+
* @param {string} userId - Unique identifier for a User
|
|
231
|
+
* @param {Users.RequestOptions} requestOptions - Request-specific configuration.
|
|
232
|
+
*
|
|
216
233
|
* @throws {@link Webflow.BadRequestError}
|
|
217
234
|
* @throws {@link Webflow.UnauthorizedError}
|
|
218
235
|
* @throws {@link Webflow.ForbiddenError}
|
|
@@ -221,25 +238,26 @@ class Users {
|
|
|
221
238
|
* @throws {@link Webflow.InternalServerError}
|
|
222
239
|
*
|
|
223
240
|
* @example
|
|
224
|
-
* await
|
|
241
|
+
* await client.users.delete("site_id", "user_id")
|
|
225
242
|
*/
|
|
226
243
|
delete(siteId, userId, requestOptions) {
|
|
227
244
|
var _a;
|
|
228
245
|
return __awaiter(this, void 0, void 0, function* () {
|
|
229
246
|
const _response = yield core.fetcher({
|
|
230
|
-
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${siteId}/users/${userId}`),
|
|
247
|
+
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}/users/${encodeURIComponent(userId)}`),
|
|
231
248
|
method: "DELETE",
|
|
232
249
|
headers: {
|
|
233
250
|
Authorization: yield this._getAuthorizationHeader(),
|
|
234
251
|
"X-Fern-Language": "JavaScript",
|
|
235
252
|
"X-Fern-SDK-Name": "webflow-api",
|
|
236
|
-
"X-Fern-SDK-Version": "2.3.
|
|
253
|
+
"X-Fern-SDK-Version": "2.3.5",
|
|
237
254
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
238
255
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
239
256
|
},
|
|
240
257
|
contentType: "application/json",
|
|
241
258
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
242
259
|
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
260
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
243
261
|
});
|
|
244
262
|
if (_response.ok) {
|
|
245
263
|
return;
|
|
@@ -284,6 +302,12 @@ class Users {
|
|
|
284
302
|
* Update a User by ID <br><br> Required scope | `users:write`
|
|
285
303
|
*
|
|
286
304
|
* <aside class="notice">The <code>email</code> and <code>password</code> fields cannot be updated using this endpoint</aside>
|
|
305
|
+
*
|
|
306
|
+
* @param {string} siteId - Unique identifier for a Site
|
|
307
|
+
* @param {string} userId - Unique identifier for a User
|
|
308
|
+
* @param {Webflow.UsersUpdateRequest} request
|
|
309
|
+
* @param {Users.RequestOptions} requestOptions - Request-specific configuration.
|
|
310
|
+
*
|
|
287
311
|
* @throws {@link Webflow.BadRequestError}
|
|
288
312
|
* @throws {@link Webflow.UnauthorizedError}
|
|
289
313
|
* @throws {@link Webflow.ForbiddenError}
|
|
@@ -292,26 +316,26 @@ class Users {
|
|
|
292
316
|
* @throws {@link Webflow.InternalServerError}
|
|
293
317
|
*
|
|
294
318
|
* @example
|
|
295
|
-
* await
|
|
319
|
+
* await client.users.update("site_id", "user_id", {
|
|
296
320
|
* data: {
|
|
297
321
|
* name: "Some One",
|
|
298
322
|
* acceptPrivacy: false,
|
|
299
323
|
* acceptCommunications: false
|
|
300
324
|
* },
|
|
301
|
-
* accessGroups: ["webflowers", "platinum", "free-tier"
|
|
325
|
+
* accessGroups: ["webflowers", "platinum", "free-tier"]
|
|
302
326
|
* })
|
|
303
327
|
*/
|
|
304
328
|
update(siteId, userId, request = {}, requestOptions) {
|
|
305
329
|
var _a;
|
|
306
330
|
return __awaiter(this, void 0, void 0, function* () {
|
|
307
331
|
const _response = yield core.fetcher({
|
|
308
|
-
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${siteId}/users/${userId}`),
|
|
332
|
+
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}/users/${encodeURIComponent(userId)}`),
|
|
309
333
|
method: "PATCH",
|
|
310
334
|
headers: {
|
|
311
335
|
Authorization: yield this._getAuthorizationHeader(),
|
|
312
336
|
"X-Fern-Language": "JavaScript",
|
|
313
337
|
"X-Fern-SDK-Name": "webflow-api",
|
|
314
|
-
"X-Fern-SDK-Version": "2.3.
|
|
338
|
+
"X-Fern-SDK-Version": "2.3.5",
|
|
315
339
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
316
340
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
317
341
|
},
|
|
@@ -319,6 +343,7 @@ class Users {
|
|
|
319
343
|
body: yield serializers.UsersUpdateRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
|
|
320
344
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
321
345
|
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
346
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
322
347
|
});
|
|
323
348
|
if (_response.ok) {
|
|
324
349
|
return yield serializers.User.parseOrThrow(_response.body, {
|
|
@@ -367,6 +392,11 @@ class Users {
|
|
|
367
392
|
}
|
|
368
393
|
/**
|
|
369
394
|
* Create and invite a user with an email address. The user will be sent and invite via email, which they will need to accept in order to join paid Access Groups. <br><br> Required scope | `users:write`
|
|
395
|
+
*
|
|
396
|
+
* @param {string} siteId - Unique identifier for a Site
|
|
397
|
+
* @param {Webflow.UsersInviteRequest} request
|
|
398
|
+
* @param {Users.RequestOptions} requestOptions - Request-specific configuration.
|
|
399
|
+
*
|
|
370
400
|
* @throws {@link Webflow.BadRequestError}
|
|
371
401
|
* @throws {@link Webflow.UnauthorizedError}
|
|
372
402
|
* @throws {@link Webflow.ForbiddenError}
|
|
@@ -376,22 +406,22 @@ class Users {
|
|
|
376
406
|
* @throws {@link Webflow.InternalServerError}
|
|
377
407
|
*
|
|
378
408
|
* @example
|
|
379
|
-
* await
|
|
409
|
+
* await client.users.invite("site_id", {
|
|
380
410
|
* email: "some.one@home.com",
|
|
381
|
-
* accessGroups: ["webflowers"
|
|
411
|
+
* accessGroups: ["webflowers"]
|
|
382
412
|
* })
|
|
383
413
|
*/
|
|
384
414
|
invite(siteId, request, requestOptions) {
|
|
385
415
|
var _a;
|
|
386
416
|
return __awaiter(this, void 0, void 0, function* () {
|
|
387
417
|
const _response = yield core.fetcher({
|
|
388
|
-
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${siteId}/users/invite`),
|
|
418
|
+
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}/users/invite`),
|
|
389
419
|
method: "POST",
|
|
390
420
|
headers: {
|
|
391
421
|
Authorization: yield this._getAuthorizationHeader(),
|
|
392
422
|
"X-Fern-Language": "JavaScript",
|
|
393
423
|
"X-Fern-SDK-Name": "webflow-api",
|
|
394
|
-
"X-Fern-SDK-Version": "2.3.
|
|
424
|
+
"X-Fern-SDK-Version": "2.3.5",
|
|
395
425
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
396
426
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
397
427
|
},
|
|
@@ -399,6 +429,7 @@ class Users {
|
|
|
399
429
|
body: yield serializers.UsersInviteRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
|
|
400
430
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
401
431
|
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
432
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
402
433
|
});
|
|
403
434
|
if (_response.ok) {
|
|
404
435
|
return yield serializers.User.parseOrThrow(_response.body, {
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
|
-
import * as Webflow from "
|
|
4
|
+
import * as Webflow from "../../../../index";
|
|
5
5
|
/**
|
|
6
6
|
* @example
|
|
7
7
|
* {
|
|
@@ -10,7 +10,7 @@ import * as Webflow from "../../../..";
|
|
|
10
10
|
* acceptPrivacy: false,
|
|
11
11
|
* acceptCommunications: false
|
|
12
12
|
* },
|
|
13
|
-
* accessGroups: ["webflowers", "platinum", "free-tier"
|
|
13
|
+
* accessGroups: ["webflowers", "platinum", "free-tier"]
|
|
14
14
|
* }
|
|
15
15
|
*/
|
|
16
16
|
export interface UsersUpdateRequest {
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
export { UsersListRequest } from "./UsersListRequest";
|
|
2
|
-
export { UsersUpdateRequest } from "./UsersUpdateRequest";
|
|
3
|
-
export { UsersInviteRequest } from "./UsersInviteRequest";
|
|
1
|
+
export { type UsersListRequest } from "./UsersListRequest";
|
|
2
|
+
export { type UsersUpdateRequest } from "./UsersUpdateRequest";
|
|
3
|
+
export { type UsersInviteRequest } from "./UsersInviteRequest";
|
|
@@ -3,15 +3,19 @@
|
|
|
3
3
|
*/
|
|
4
4
|
import * as environments from "../../../../environments";
|
|
5
5
|
import * as core from "../../../../core";
|
|
6
|
-
import * as Webflow from "
|
|
6
|
+
import * as Webflow from "../../../index";
|
|
7
7
|
export declare namespace Webhooks {
|
|
8
8
|
interface Options {
|
|
9
9
|
environment?: core.Supplier<environments.WebflowEnvironment | string>;
|
|
10
10
|
accessToken: core.Supplier<core.BearerToken>;
|
|
11
11
|
}
|
|
12
12
|
interface RequestOptions {
|
|
13
|
+
/** The maximum time to wait for a response in seconds. */
|
|
13
14
|
timeoutInSeconds?: number;
|
|
15
|
+
/** The number of times to retry the request. Defaults to 2. */
|
|
14
16
|
maxRetries?: number;
|
|
17
|
+
/** A hook to abort the request. */
|
|
18
|
+
abortSignal?: AbortSignal;
|
|
15
19
|
}
|
|
16
20
|
}
|
|
17
21
|
export declare class Webhooks {
|
|
@@ -19,6 +23,10 @@ export declare class Webhooks {
|
|
|
19
23
|
constructor(_options: Webhooks.Options);
|
|
20
24
|
/**
|
|
21
25
|
* List all App-created Webhooks registered for a given site </br></br> Required scope | `sites:read`
|
|
26
|
+
*
|
|
27
|
+
* @param {string} siteId - Unique identifier for a Site
|
|
28
|
+
* @param {Webhooks.RequestOptions} requestOptions - Request-specific configuration.
|
|
29
|
+
*
|
|
22
30
|
* @throws {@link Webflow.BadRequestError}
|
|
23
31
|
* @throws {@link Webflow.UnauthorizedError}
|
|
24
32
|
* @throws {@link Webflow.NotFoundError}
|
|
@@ -26,11 +34,16 @@ export declare class Webhooks {
|
|
|
26
34
|
* @throws {@link Webflow.InternalServerError}
|
|
27
35
|
*
|
|
28
36
|
* @example
|
|
29
|
-
* await
|
|
37
|
+
* await client.webhooks.list("site_id")
|
|
30
38
|
*/
|
|
31
39
|
list(siteId: string, requestOptions?: Webhooks.RequestOptions): Promise<Webflow.WebhookList>;
|
|
32
40
|
/**
|
|
33
|
-
* Create a new Webhook, to be notified when Webflow resources change. Limit of 75 registrations per `triggerType`, per site.
|
|
41
|
+
* Create a new Webhook, to be notified when Webflow resources change. Limit of 75 registrations per `triggerType`, per site. <blockquote class="callout callout_info" theme="📘">Access to this endpoint requires a bearer token from a <a href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data Client App</a>.</blockquote> Required scope | `sites:write`
|
|
42
|
+
*
|
|
43
|
+
* @param {string} siteId - Unique identifier for a Site
|
|
44
|
+
* @param {Webflow.WebhooksCreateRequest} request
|
|
45
|
+
* @param {Webhooks.RequestOptions} requestOptions - Request-specific configuration.
|
|
46
|
+
*
|
|
34
47
|
* @throws {@link Webflow.BadRequestError}
|
|
35
48
|
* @throws {@link Webflow.UnauthorizedError}
|
|
36
49
|
* @throws {@link Webflow.NotFoundError}
|
|
@@ -38,7 +51,7 @@ export declare class Webhooks {
|
|
|
38
51
|
* @throws {@link Webflow.InternalServerError}
|
|
39
52
|
*
|
|
40
53
|
* @example
|
|
41
|
-
* await
|
|
54
|
+
* await client.webhooks.create("site_id", {
|
|
42
55
|
* triggerType: Webflow.TriggerType.FormSubmission,
|
|
43
56
|
* url: "https://api.mydomain.com/webhook"
|
|
44
57
|
* })
|
|
@@ -46,6 +59,10 @@ export declare class Webhooks {
|
|
|
46
59
|
create(siteId: string, request: Webflow.WebhooksCreateRequest, requestOptions?: Webhooks.RequestOptions): Promise<Webflow.Webhook>;
|
|
47
60
|
/**
|
|
48
61
|
* Get a specific Webhook instance
|
|
62
|
+
*
|
|
63
|
+
* @param {string} webhookId - Unique identifier for a Webhook
|
|
64
|
+
* @param {Webhooks.RequestOptions} requestOptions - Request-specific configuration.
|
|
65
|
+
*
|
|
49
66
|
* @throws {@link Webflow.BadRequestError}
|
|
50
67
|
* @throws {@link Webflow.UnauthorizedError}
|
|
51
68
|
* @throws {@link Webflow.NotFoundError}
|
|
@@ -53,11 +70,15 @@ export declare class Webhooks {
|
|
|
53
70
|
* @throws {@link Webflow.InternalServerError}
|
|
54
71
|
*
|
|
55
72
|
* @example
|
|
56
|
-
* await
|
|
73
|
+
* await client.webhooks.get("webhook_id")
|
|
57
74
|
*/
|
|
58
75
|
get(webhookId: string, requestOptions?: Webhooks.RequestOptions): Promise<Webflow.Webhook>;
|
|
59
76
|
/**
|
|
60
77
|
* Remove a Webhook
|
|
78
|
+
*
|
|
79
|
+
* @param {string} webhookId - Unique identifier for a Webhook
|
|
80
|
+
* @param {Webhooks.RequestOptions} requestOptions - Request-specific configuration.
|
|
81
|
+
*
|
|
61
82
|
* @throws {@link Webflow.BadRequestError}
|
|
62
83
|
* @throws {@link Webflow.UnauthorizedError}
|
|
63
84
|
* @throws {@link Webflow.NotFoundError}
|
|
@@ -65,7 +86,7 @@ export declare class Webhooks {
|
|
|
65
86
|
* @throws {@link Webflow.InternalServerError}
|
|
66
87
|
*
|
|
67
88
|
* @example
|
|
68
|
-
* await
|
|
89
|
+
* await client.webhooks.delete("webhook_id")
|
|
69
90
|
*/
|
|
70
91
|
delete(webhookId: string, requestOptions?: Webhooks.RequestOptions): Promise<void>;
|
|
71
92
|
protected _getAuthorizationHeader(): Promise<string>;
|