webflow-api 2.4.2 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.mock/definition/__package__.yml +2495 -0
- package/.mock/definition/accessGroups.yml +80 -0
- package/.mock/definition/api.yml +13 -0
- package/.mock/definition/assets.yml +414 -0
- package/.mock/definition/collections/fields.yml +187 -0
- package/.mock/definition/collections/items.yml +1511 -0
- package/.mock/definition/collections.yml +185 -0
- package/.mock/definition/ecommerce.yml +42 -0
- package/.mock/definition/forms.yml +301 -0
- package/.mock/definition/inventory.yml +120 -0
- package/.mock/definition/orders.yml +1569 -0
- package/.mock/definition/pages/scripts.yml +169 -0
- package/.mock/definition/pages.yml +443 -0
- package/.mock/definition/products.yml +500 -0
- package/.mock/definition/scripts.yml +257 -0
- package/.mock/definition/sites/activityLogs.yml +65 -0
- package/.mock/definition/sites/scripts.yml +228 -0
- package/.mock/definition/sites.yml +299 -0
- package/.mock/definition/token.yml +71 -0
- package/.mock/definition/users.yml +392 -0
- package/.mock/definition/webhooks.yml +189 -0
- package/.mock/fern.config.json +4 -0
- package/Client.d.ts +2 -0
- package/MIGRATION.md +37 -0
- package/README.md +23 -30
- package/api/errors/InternalServerError.d.ts +2 -1
- package/api/errors/NotFoundError.d.ts +2 -1
- package/api/errors/TooManyRequestsError.d.ts +1 -1
- package/api/errors/UnauthorizedError.d.ts +2 -1
- package/api/resources/accessGroups/client/Client.d.ts +5 -1
- package/api/resources/accessGroups/client/Client.js +27 -15
- package/api/resources/assets/client/Client.d.ts +31 -11
- package/api/resources/assets/client/Client.js +236 -126
- package/api/resources/assets/client/requests/AssetsCreateRequest.d.ts +2 -2
- package/api/resources/assets/client/requests/AssetsUpdateRequest.d.ts +5 -5
- package/api/resources/collections/client/Client.d.ts +15 -22
- package/api/resources/collections/client/Client.js +109 -137
- package/api/resources/collections/resources/fields/client/Client.d.ts +34 -2
- package/api/resources/collections/resources/fields/client/Client.js +163 -32
- package/api/resources/collections/resources/items/client/Client.d.ts +302 -30
- package/api/resources/collections/resources/items/client/Client.js +959 -221
- package/api/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.d.ts +61 -0
- package/api/resources/collections/resources/items/client/requests/ItemsDeleteItemsLiveRequest.d.ts +11 -0
- package/api/resources/collections/resources/items/client/requests/ItemsDeleteItemsRequest.d.ts +11 -0
- package/api/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.d.ts +128 -0
- package/api/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.d.ts +128 -0
- package/api/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.js +5 -0
- package/api/resources/collections/resources/items/client/requests/index.d.ts +5 -0
- package/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +5 -0
- package/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.js +5 -0
- package/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts +14 -0
- package/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.js +5 -0
- package/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataName.d.ts +14 -0
- package/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataName.js +5 -0
- package/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.d.ts +5 -0
- package/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.js +5 -0
- package/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.d.ts +8 -0
- package/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.js +5 -0
- package/api/resources/collections/resources/items/types/ItemsCreateItemRequest.d.ts +5 -0
- package/api/resources/collections/resources/items/types/ItemsCreateItemRequest.js +5 -0
- package/api/resources/collections/resources/items/types/ItemsCreateItemRequestItems.d.ts +8 -0
- package/api/resources/collections/resources/items/types/ItemsCreateItemRequestItems.js +5 -0
- package/api/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.d.ts +9 -0
- package/api/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.js +5 -0
- package/api/resources/collections/resources/items/types/ItemsDeleteItemsRequestItemsItem.d.ts +9 -0
- package/api/resources/collections/resources/items/types/ItemsDeleteItemsRequestItemsItem.js +5 -0
- package/api/resources/collections/resources/items/types/index.d.ts +9 -0
- package/api/resources/collections/resources/items/types/index.js +9 -0
- package/api/resources/ecommerce/client/Client.d.ts +2 -0
- package/api/resources/ecommerce/client/Client.js +24 -14
- package/api/resources/forms/client/Client.d.ts +17 -5
- package/api/resources/forms/client/Client.js +140 -76
- package/api/resources/inventory/client/Client.d.ts +8 -1
- package/api/resources/inventory/client/Client.js +59 -30
- package/api/resources/orders/client/Client.d.ts +7 -2
- package/api/resources/orders/client/Client.js +164 -89
- package/api/resources/pages/client/Client.d.ts +25 -14
- package/api/resources/pages/client/Client.js +169 -100
- package/api/resources/pages/client/requests/DomWrite.d.ts +6 -6
- package/api/resources/pages/client/requests/PagesGetContentRequest.d.ts +2 -2
- package/api/resources/pages/client/requests/PagesGetMetadataRequest.d.ts +2 -2
- package/api/resources/pages/client/requests/PagesListRequest.d.ts +2 -2
- package/api/resources/pages/client/requests/UpdatePageSettingsRequest.d.ts +3 -4
- package/api/resources/pages/resources/scripts/client/Client.d.ts +29 -3
- package/api/resources/pages/resources/scripts/client/Client.js +104 -46
- package/api/resources/products/client/Client.d.ts +26 -10
- package/api/resources/products/client/Client.js +188 -98
- package/api/resources/scripts/client/Client.d.ts +31 -3
- package/api/resources/scripts/client/Client.js +111 -47
- package/api/resources/sites/client/Client.d.ts +16 -4
- package/api/resources/sites/client/Client.js +101 -59
- package/api/resources/sites/client/requests/SitesPublishRequest.d.ts +1 -1
- package/api/resources/sites/resources/activityLogs/client/Client.d.ts +2 -0
- package/api/resources/sites/resources/activityLogs/client/Client.js +17 -13
- package/api/resources/sites/resources/scripts/client/Client.d.ts +26 -4
- package/api/resources/sites/resources/scripts/client/Client.js +125 -61
- package/api/resources/token/client/Client.d.ts +7 -2
- package/api/resources/token/client/Client.js +23 -24
- package/api/resources/users/client/Client.d.ts +21 -6
- package/api/resources/users/client/Client.js +149 -78
- package/api/resources/webhooks/client/Client.d.ts +15 -2
- package/api/resources/webhooks/client/Client.js +114 -59
- package/api/types/AssetFolder.d.ts +1 -1
- package/api/types/AuthorizationAuthorization.d.ts +1 -1
- package/api/types/AuthorizedUser.d.ts +1 -1
- package/api/types/BulkCollectionItemFieldData.d.ts +1 -1
- package/api/types/CollectionItem.d.ts +1 -1
- package/api/types/CollectionItemFieldData.d.ts +1 -1
- package/api/types/CollectionItemListNoPagination.d.ts +11 -0
- package/api/types/CollectionItemListNoPagination.js +5 -0
- package/api/types/CollectionItemWithIdInput.d.ts +24 -0
- package/api/types/CollectionItemWithIdInput.js +5 -0
- package/api/types/CollectionItemWithIdInputFieldData.d.ts +11 -0
- package/api/types/CollectionItemWithIdInputFieldData.js +5 -0
- package/api/types/ConflictErrorBody.d.ts +1 -10
- package/api/types/CustomCodeBlock.d.ts +2 -2
- package/api/types/DuplicateUserEmail.d.ts +1 -11
- package/api/types/ErrorCode.d.ts +38 -0
- package/api/types/ErrorCode.js +37 -0
- package/api/types/Error_.d.ts +1 -1
- package/api/types/ForbiddenErrorBody.d.ts +2 -7
- package/api/types/Form.d.ts +8 -8
- package/api/types/FormSubmission.d.ts +3 -3
- package/api/types/InvalidScopes.d.ts +4 -0
- package/api/types/InvalidScopes.js +5 -0
- package/api/types/NotEnterprisePlanSite.d.ts +1 -11
- package/api/types/Order.d.ts +5 -1
- package/api/types/Page.d.ts +2 -0
- package/api/types/Site.d.ts +4 -0
- package/api/types/SiteActivityLogItem.d.ts +1 -1
- package/api/types/SiteActivityLogItemEvent.d.ts +48 -0
- package/api/types/SiteActivityLogItemEvent.js +50 -0
- package/api/types/SiteActivityLogItemResourceOperation.d.ts +5 -1
- package/api/types/SiteActivityLogItemResourceOperation.js +4 -0
- package/api/types/SiteDataCollectionType.d.ts +12 -0
- package/api/types/SiteDataCollectionType.js +11 -0
- package/api/types/UserLimitReached.d.ts +1 -11
- package/api/types/UsersNotEnabled.d.ts +1 -11
- package/api/types/index.d.ts +10 -6
- package/api/types/index.js +10 -6
- package/core/fetcher/Fetcher.d.ts +1 -1
- package/core/fetcher/getResponseBody.js +3 -0
- package/core/fetcher/requestWithRetries.js +13 -4
- package/core/schemas/builders/object/object.js +28 -0
- package/core/schemas/builders/object/types.d.ts +5 -0
- package/dist/Client.d.ts +2 -0
- package/dist/api/errors/InternalServerError.d.ts +2 -1
- package/dist/api/errors/NotFoundError.d.ts +2 -1
- package/dist/api/errors/TooManyRequestsError.d.ts +1 -1
- package/dist/api/errors/UnauthorizedError.d.ts +2 -1
- package/dist/api/resources/accessGroups/client/Client.d.ts +5 -1
- package/dist/api/resources/accessGroups/client/Client.js +27 -15
- package/dist/api/resources/assets/client/Client.d.ts +31 -11
- package/dist/api/resources/assets/client/Client.js +236 -126
- package/dist/api/resources/assets/client/requests/AssetsCreateRequest.d.ts +2 -2
- package/dist/api/resources/assets/client/requests/AssetsUpdateRequest.d.ts +5 -5
- package/dist/api/resources/collections/client/Client.d.ts +15 -22
- package/dist/api/resources/collections/client/Client.js +109 -137
- package/dist/api/resources/collections/resources/fields/client/Client.d.ts +34 -2
- package/dist/api/resources/collections/resources/fields/client/Client.js +163 -32
- package/dist/api/resources/collections/resources/items/client/Client.d.ts +302 -30
- package/dist/api/resources/collections/resources/items/client/Client.js +959 -221
- package/dist/api/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.d.ts +61 -0
- package/dist/api/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.js +5 -0
- package/dist/api/resources/collections/resources/items/client/requests/ItemsDeleteItemsLiveRequest.d.ts +11 -0
- package/dist/api/resources/collections/resources/items/client/requests/ItemsDeleteItemsLiveRequest.js +5 -0
- package/dist/api/resources/collections/resources/items/client/requests/ItemsDeleteItemsRequest.d.ts +11 -0
- package/dist/api/resources/collections/resources/items/client/requests/ItemsDeleteItemsRequest.js +5 -0
- package/dist/api/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.d.ts +128 -0
- package/dist/api/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.js +5 -0
- package/dist/api/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.d.ts +128 -0
- package/dist/api/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.js +5 -0
- package/dist/api/resources/collections/resources/items/client/requests/index.d.ts +5 -0
- package/dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +5 -0
- package/dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.js +5 -0
- package/dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts +14 -0
- package/dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.js +5 -0
- package/dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataName.d.ts +14 -0
- package/dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataName.js +5 -0
- package/dist/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.d.ts +5 -0
- package/dist/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.js +5 -0
- package/dist/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.d.ts +8 -0
- package/dist/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.js +5 -0
- package/dist/api/resources/collections/resources/items/types/ItemsCreateItemRequest.d.ts +5 -0
- package/dist/api/resources/collections/resources/items/types/ItemsCreateItemRequest.js +5 -0
- package/dist/api/resources/collections/resources/items/types/ItemsCreateItemRequestItems.d.ts +8 -0
- package/dist/api/resources/collections/resources/items/types/ItemsCreateItemRequestItems.js +5 -0
- package/dist/api/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.d.ts +9 -0
- package/dist/api/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.js +5 -0
- package/dist/api/resources/collections/resources/items/types/ItemsDeleteItemsRequestItemsItem.d.ts +9 -0
- package/dist/api/resources/collections/resources/items/types/ItemsDeleteItemsRequestItemsItem.js +5 -0
- package/dist/api/resources/collections/resources/items/types/index.d.ts +9 -0
- package/dist/api/resources/collections/resources/items/types/index.js +9 -0
- package/dist/api/resources/ecommerce/client/Client.d.ts +2 -0
- package/dist/api/resources/ecommerce/client/Client.js +24 -14
- package/dist/api/resources/forms/client/Client.d.ts +17 -5
- package/dist/api/resources/forms/client/Client.js +140 -76
- package/dist/api/resources/inventory/client/Client.d.ts +8 -1
- package/dist/api/resources/inventory/client/Client.js +59 -30
- package/dist/api/resources/orders/client/Client.d.ts +7 -2
- package/dist/api/resources/orders/client/Client.js +164 -89
- package/dist/api/resources/pages/client/Client.d.ts +25 -14
- package/dist/api/resources/pages/client/Client.js +169 -100
- package/dist/api/resources/pages/client/requests/DomWrite.d.ts +6 -6
- package/dist/api/resources/pages/client/requests/PagesGetContentRequest.d.ts +2 -2
- package/dist/api/resources/pages/client/requests/PagesGetMetadataRequest.d.ts +2 -2
- package/dist/api/resources/pages/client/requests/PagesListRequest.d.ts +2 -2
- package/dist/api/resources/pages/client/requests/UpdatePageSettingsRequest.d.ts +3 -4
- package/dist/api/resources/pages/resources/scripts/client/Client.d.ts +29 -3
- package/dist/api/resources/pages/resources/scripts/client/Client.js +104 -46
- package/dist/api/resources/products/client/Client.d.ts +26 -10
- package/dist/api/resources/products/client/Client.js +188 -98
- package/dist/api/resources/scripts/client/Client.d.ts +31 -3
- package/dist/api/resources/scripts/client/Client.js +111 -47
- package/dist/api/resources/sites/client/Client.d.ts +16 -4
- package/dist/api/resources/sites/client/Client.js +101 -59
- package/dist/api/resources/sites/client/requests/SitesPublishRequest.d.ts +1 -1
- package/dist/api/resources/sites/resources/activityLogs/client/Client.d.ts +2 -0
- package/dist/api/resources/sites/resources/activityLogs/client/Client.js +17 -13
- package/dist/api/resources/sites/resources/scripts/client/Client.d.ts +26 -4
- package/dist/api/resources/sites/resources/scripts/client/Client.js +125 -61
- package/dist/api/resources/token/client/Client.d.ts +7 -2
- package/dist/api/resources/token/client/Client.js +23 -24
- package/dist/api/resources/users/client/Client.d.ts +21 -6
- package/dist/api/resources/users/client/Client.js +149 -78
- package/dist/api/resources/webhooks/client/Client.d.ts +15 -2
- package/dist/api/resources/webhooks/client/Client.js +114 -59
- package/dist/api/types/AssetFolder.d.ts +1 -1
- package/dist/api/types/AuthorizationAuthorization.d.ts +1 -1
- package/dist/api/types/AuthorizedUser.d.ts +1 -1
- package/dist/api/types/BulkCollectionItemFieldData.d.ts +1 -1
- package/dist/api/types/CollectionItem.d.ts +1 -1
- package/dist/api/types/CollectionItemFieldData.d.ts +1 -1
- package/dist/api/types/CollectionItemListNoPagination.d.ts +11 -0
- package/dist/api/types/CollectionItemListNoPagination.js +5 -0
- package/dist/api/types/CollectionItemWithIdInput.d.ts +24 -0
- package/dist/api/types/CollectionItemWithIdInput.js +5 -0
- package/dist/api/types/CollectionItemWithIdInputFieldData.d.ts +11 -0
- package/dist/api/types/CollectionItemWithIdInputFieldData.js +5 -0
- package/dist/api/types/ConflictErrorBody.d.ts +1 -10
- package/dist/api/types/CustomCodeBlock.d.ts +2 -2
- package/dist/api/types/DuplicateUserEmail.d.ts +1 -11
- package/dist/api/types/ErrorCode.d.ts +38 -0
- package/dist/api/types/ErrorCode.js +37 -0
- package/dist/api/types/Error_.d.ts +1 -1
- package/dist/api/types/ForbiddenErrorBody.d.ts +2 -7
- package/dist/api/types/Form.d.ts +8 -8
- package/dist/api/types/FormSubmission.d.ts +3 -3
- package/dist/api/types/InvalidScopes.d.ts +4 -0
- package/dist/api/types/InvalidScopes.js +5 -0
- package/dist/api/types/NotEnterprisePlanSite.d.ts +1 -11
- package/dist/api/types/Order.d.ts +5 -1
- package/dist/api/types/Page.d.ts +2 -0
- package/dist/api/types/Site.d.ts +4 -0
- package/dist/api/types/SiteActivityLogItem.d.ts +1 -1
- package/dist/api/types/SiteActivityLogItemEvent.d.ts +48 -0
- package/dist/api/types/SiteActivityLogItemEvent.js +50 -0
- package/dist/api/types/SiteActivityLogItemResourceOperation.d.ts +5 -1
- package/dist/api/types/SiteActivityLogItemResourceOperation.js +4 -0
- package/dist/api/types/SiteDataCollectionType.d.ts +12 -0
- package/dist/api/types/SiteDataCollectionType.js +11 -0
- package/dist/api/types/UserLimitReached.d.ts +1 -11
- package/dist/api/types/UsersNotEnabled.d.ts +1 -11
- package/dist/api/types/index.d.ts +10 -6
- package/dist/api/types/index.js +10 -6
- package/dist/core/fetcher/Fetcher.d.ts +1 -1
- package/dist/core/fetcher/getResponseBody.js +3 -0
- package/dist/core/fetcher/requestWithRetries.js +13 -4
- package/dist/core/schemas/builders/object/object.js +28 -0
- package/dist/core/schemas/builders/object/types.d.ts +5 -0
- package/dist/errors/WebflowTimeoutError.d.ts +1 -1
- package/dist/errors/WebflowTimeoutError.js +2 -2
- package/dist/serialization/resources/assets/client/requests/AssetsUpdateRequest.d.ts +2 -1
- package/dist/serialization/resources/assets/client/requests/AssetsUpdateRequest.js +2 -1
- package/dist/serialization/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.d.ts +16 -0
- package/dist/serialization/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.js +37 -0
- package/dist/serialization/resources/collections/resources/items/client/requests/ItemsDeleteItemsLiveRequest.d.ts +13 -0
- package/dist/serialization/resources/collections/resources/items/client/requests/ItemsDeleteItemsLiveRequest.js +34 -0
- package/dist/serialization/resources/collections/resources/items/client/requests/ItemsDeleteItemsRequest.d.ts +13 -0
- package/dist/serialization/resources/collections/resources/items/client/requests/ItemsDeleteItemsRequest.js +34 -0
- package/dist/serialization/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.d.ts +13 -0
- package/dist/serialization/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.js +34 -0
- package/dist/serialization/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.d.ts +13 -0
- package/dist/serialization/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.js +34 -0
- package/dist/serialization/resources/collections/resources/items/client/requests/index.d.ts +5 -0
- package/dist/serialization/resources/collections/resources/items/client/requests/index.js +11 -1
- package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +12 -0
- package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.js +36 -0
- package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts +14 -0
- package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.js +36 -0
- package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataName.d.ts +14 -0
- package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataName.js +36 -0
- package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.d.ts +12 -0
- package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.js +33 -0
- package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.d.ts +13 -0
- package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.js +34 -0
- package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemRequest.d.ts +12 -0
- package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemRequest.js +33 -0
- package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemRequestItems.d.ts +13 -0
- package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemRequestItems.js +34 -0
- package/dist/serialization/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.d.ts +13 -0
- package/dist/serialization/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.js +34 -0
- package/dist/serialization/resources/collections/resources/items/types/ItemsDeleteItemsRequestItemsItem.d.ts +13 -0
- package/dist/serialization/resources/collections/resources/items/types/ItemsDeleteItemsRequestItemsItem.js +34 -0
- package/dist/serialization/resources/collections/resources/items/types/index.d.ts +9 -0
- package/dist/serialization/resources/collections/resources/items/types/index.js +9 -0
- package/dist/serialization/resources/pages/client/requests/DomWrite.d.ts +1 -1
- package/dist/serialization/types/BulkCollectionItemFieldData.js +4 -2
- package/dist/serialization/types/CollectionItem.d.ts +1 -1
- package/dist/serialization/types/CollectionItem.js +1 -1
- package/dist/serialization/types/CollectionItemFieldData.js +4 -2
- package/dist/serialization/types/CollectionItemListNoPagination.d.ts +13 -0
- package/dist/serialization/types/{TooManyRequestsErrorBody.js → CollectionItemListNoPagination.js} +4 -6
- package/dist/serialization/types/CollectionItemWithIdInput.d.ts +20 -0
- package/dist/serialization/types/CollectionItemWithIdInput.js +41 -0
- package/dist/serialization/types/CollectionItemWithIdInputFieldData.d.ts +14 -0
- package/dist/serialization/types/{MissingScopes.js → CollectionItemWithIdInputFieldData.js} +7 -8
- package/dist/serialization/types/ConflictErrorBody.d.ts +4 -8
- package/dist/serialization/types/ConflictErrorBody.js +3 -7
- package/dist/serialization/types/DuplicateUserEmail.d.ts +2 -8
- package/dist/serialization/types/DuplicateUserEmail.js +1 -7
- package/dist/serialization/types/ErrorCode.d.ts +10 -0
- package/dist/serialization/types/ErrorCode.js +61 -0
- package/dist/serialization/types/Error_.d.ts +2 -1
- package/dist/serialization/types/Error_.js +2 -1
- package/dist/serialization/types/ForbiddenErrorBody.d.ts +4 -8
- package/dist/serialization/types/ForbiddenErrorBody.js +3 -7
- package/dist/serialization/types/Form.d.ts +1 -1
- package/dist/serialization/types/Form.js +1 -1
- package/dist/serialization/types/InvalidScopes.d.ts +10 -0
- package/{serialization/types/MissingScopes.js → dist/serialization/types/InvalidScopes.js} +2 -8
- package/dist/serialization/types/NotEnterprisePlanSite.d.ts +2 -8
- package/dist/serialization/types/NotEnterprisePlanSite.js +1 -7
- package/dist/serialization/types/Page.d.ts +1 -0
- package/dist/serialization/types/Page.js +1 -0
- package/dist/serialization/types/Site.d.ts +3 -0
- package/dist/serialization/types/Site.js +3 -0
- package/dist/serialization/types/SiteActivityLogItem.d.ts +2 -1
- package/dist/serialization/types/SiteActivityLogItem.js +2 -1
- package/dist/serialization/types/SiteActivityLogItemEvent.d.ts +10 -0
- package/dist/serialization/types/SiteActivityLogItemEvent.js +74 -0
- package/dist/serialization/types/SiteActivityLogItemResourceOperation.d.ts +1 -1
- package/dist/serialization/types/SiteActivityLogItemResourceOperation.js +11 -1
- package/dist/serialization/types/SiteDataCollectionType.d.ts +10 -0
- package/dist/serialization/types/SiteDataCollectionType.js +31 -0
- package/dist/serialization/types/UserLimitReached.d.ts +2 -8
- package/dist/serialization/types/UserLimitReached.js +1 -7
- package/dist/serialization/types/UsersNotEnabled.d.ts +2 -8
- package/dist/serialization/types/UsersNotEnabled.js +1 -7
- package/dist/serialization/types/index.d.ts +10 -5
- package/dist/serialization/types/index.js +10 -5
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/dist/wrapper/WebflowClient.d.ts +1 -4
- package/dist/wrapper/WebflowClient.js +4 -8
- package/errors/WebflowTimeoutError.d.ts +1 -1
- package/errors/WebflowTimeoutError.js +2 -2
- package/package.json +1 -2
- package/reference.md +821 -230
- package/serialization/resources/assets/client/requests/AssetsUpdateRequest.d.ts +2 -1
- package/serialization/resources/assets/client/requests/AssetsUpdateRequest.js +2 -1
- package/serialization/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.d.ts +16 -0
- package/serialization/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.js +37 -0
- package/serialization/resources/collections/resources/items/client/requests/ItemsDeleteItemsLiveRequest.d.ts +13 -0
- package/serialization/resources/collections/resources/items/client/requests/ItemsDeleteItemsLiveRequest.js +34 -0
- package/serialization/resources/collections/resources/items/client/requests/ItemsDeleteItemsRequest.d.ts +13 -0
- package/serialization/resources/collections/resources/items/client/requests/ItemsDeleteItemsRequest.js +34 -0
- package/serialization/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.d.ts +13 -0
- package/serialization/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.js +34 -0
- package/serialization/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.d.ts +13 -0
- package/serialization/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.js +34 -0
- package/serialization/resources/collections/resources/items/client/requests/index.d.ts +5 -0
- package/serialization/resources/collections/resources/items/client/requests/index.js +11 -1
- package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +12 -0
- package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.js +36 -0
- package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts +14 -0
- package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.js +36 -0
- package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataName.d.ts +14 -0
- package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataName.js +36 -0
- package/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.d.ts +12 -0
- package/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.js +33 -0
- package/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.d.ts +13 -0
- package/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.js +34 -0
- package/serialization/resources/collections/resources/items/types/ItemsCreateItemRequest.d.ts +12 -0
- package/serialization/resources/collections/resources/items/types/ItemsCreateItemRequest.js +33 -0
- package/serialization/resources/collections/resources/items/types/ItemsCreateItemRequestItems.d.ts +13 -0
- package/serialization/resources/collections/resources/items/types/ItemsCreateItemRequestItems.js +34 -0
- package/serialization/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.d.ts +13 -0
- package/serialization/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.js +34 -0
- package/serialization/resources/collections/resources/items/types/ItemsDeleteItemsRequestItemsItem.d.ts +13 -0
- package/serialization/resources/collections/resources/items/types/ItemsDeleteItemsRequestItemsItem.js +34 -0
- package/serialization/resources/collections/resources/items/types/index.d.ts +9 -0
- package/serialization/resources/collections/resources/items/types/index.js +9 -0
- package/serialization/resources/pages/client/requests/DomWrite.d.ts +1 -1
- package/serialization/types/BulkCollectionItemFieldData.js +4 -2
- package/serialization/types/CollectionItem.d.ts +1 -1
- package/serialization/types/CollectionItem.js +1 -1
- package/serialization/types/CollectionItemFieldData.js +4 -2
- package/serialization/types/CollectionItemListNoPagination.d.ts +13 -0
- package/serialization/types/{TooManyRequestsErrorBody.js → CollectionItemListNoPagination.js} +4 -6
- package/serialization/types/CollectionItemWithIdInput.d.ts +20 -0
- package/serialization/types/CollectionItemWithIdInput.js +41 -0
- package/serialization/types/CollectionItemWithIdInputFieldData.d.ts +14 -0
- package/serialization/types/CollectionItemWithIdInputFieldData.js +36 -0
- package/serialization/types/ConflictErrorBody.d.ts +4 -8
- package/serialization/types/ConflictErrorBody.js +3 -7
- package/serialization/types/DuplicateUserEmail.d.ts +2 -8
- package/serialization/types/DuplicateUserEmail.js +1 -7
- package/serialization/types/ErrorCode.d.ts +10 -0
- package/serialization/types/ErrorCode.js +61 -0
- package/serialization/types/Error_.d.ts +2 -1
- package/serialization/types/Error_.js +2 -1
- package/serialization/types/ForbiddenErrorBody.d.ts +4 -8
- package/serialization/types/ForbiddenErrorBody.js +3 -7
- package/serialization/types/Form.d.ts +1 -1
- package/serialization/types/Form.js +1 -1
- package/serialization/types/InvalidScopes.d.ts +10 -0
- package/serialization/types/InvalidScopes.js +31 -0
- package/serialization/types/NotEnterprisePlanSite.d.ts +2 -8
- package/serialization/types/NotEnterprisePlanSite.js +1 -7
- package/serialization/types/Page.d.ts +1 -0
- package/serialization/types/Page.js +1 -0
- package/serialization/types/Site.d.ts +3 -0
- package/serialization/types/Site.js +3 -0
- package/serialization/types/SiteActivityLogItem.d.ts +2 -1
- package/serialization/types/SiteActivityLogItem.js +2 -1
- package/serialization/types/SiteActivityLogItemEvent.d.ts +10 -0
- package/serialization/types/SiteActivityLogItemEvent.js +74 -0
- package/serialization/types/SiteActivityLogItemResourceOperation.d.ts +1 -1
- package/serialization/types/SiteActivityLogItemResourceOperation.js +11 -1
- package/serialization/types/SiteDataCollectionType.d.ts +10 -0
- package/serialization/types/SiteDataCollectionType.js +31 -0
- package/serialization/types/UserLimitReached.d.ts +2 -8
- package/serialization/types/UserLimitReached.js +1 -7
- package/serialization/types/UsersNotEnabled.d.ts +2 -8
- package/serialization/types/UsersNotEnabled.js +1 -7
- package/serialization/types/index.d.ts +10 -5
- package/serialization/types/index.js +10 -5
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/wrapper/WebflowClient.d.ts +1 -4
- package/wrapper/WebflowClient.js +4 -8
- package/api/types/MissingScopes.d.ts +0 -14
- package/api/types/TooManyRequestsErrorBody.d.ts +0 -9
- package/dist/api/types/MissingScopes.d.ts +0 -14
- package/dist/api/types/TooManyRequestsErrorBody.d.ts +0 -9
- package/dist/serialization/types/MissingScopes.d.ts +0 -16
- package/dist/serialization/types/TooManyRequestsErrorBody.d.ts +0 -15
- package/dist/wrapper/CollectionsClient.d.ts +0 -8
- package/dist/wrapper/CollectionsClient.js +0 -18
- package/dist/wrapper/ItemsClient.d.ts +0 -78
- package/dist/wrapper/ItemsClient.js +0 -351
- package/serialization/types/MissingScopes.d.ts +0 -16
- package/serialization/types/TooManyRequestsErrorBody.d.ts +0 -15
- package/wrapper/CollectionsClient.d.ts +0 -8
- package/wrapper/CollectionsClient.js +0 -18
- package/wrapper/ItemsClient.d.ts +0 -78
- package/wrapper/ItemsClient.js +0 -351
- /package/api/{types/MissingScopes.js → resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.js} +0 -0
- /package/api/{types/TooManyRequestsErrorBody.js → resources/collections/resources/items/client/requests/ItemsDeleteItemsLiveRequest.js} +0 -0
- /package/{dist/api/types/MissingScopes.js → api/resources/collections/resources/items/client/requests/ItemsDeleteItemsRequest.js} +0 -0
- /package/{dist/api/types/TooManyRequestsErrorBody.js → api/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.js} +0 -0
|
@@ -86,15 +86,7 @@ class Orders {
|
|
|
86
86
|
const _response = yield core.fetcher({
|
|
87
87
|
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)}/orders`),
|
|
88
88
|
method: "GET",
|
|
89
|
-
headers: {
|
|
90
|
-
Authorization: yield this._getAuthorizationHeader(),
|
|
91
|
-
"X-Fern-Language": "JavaScript",
|
|
92
|
-
"X-Fern-SDK-Name": "webflow-api",
|
|
93
|
-
"X-Fern-SDK-Version": "2.4.2",
|
|
94
|
-
"User-Agent": "webflow-api/2.4.2",
|
|
95
|
-
"X-Fern-Runtime": core.RUNTIME.type,
|
|
96
|
-
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
97
|
-
},
|
|
89
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.0", "User-Agent": "webflow-api/3.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
98
90
|
contentType: "application/json",
|
|
99
91
|
queryParameters: _queryParams,
|
|
100
92
|
requestType: "json",
|
|
@@ -116,15 +108,27 @@ class Orders {
|
|
|
116
108
|
case 400:
|
|
117
109
|
throw new Webflow.BadRequestError(_response.error.body);
|
|
118
110
|
case 401:
|
|
119
|
-
throw new Webflow.UnauthorizedError(_response.error.body
|
|
111
|
+
throw new Webflow.UnauthorizedError(serializers.Error_.parseOrThrow(_response.error.body, {
|
|
112
|
+
unrecognizedObjectKeys: "passthrough",
|
|
113
|
+
allowUnrecognizedUnionMembers: true,
|
|
114
|
+
allowUnrecognizedEnumValues: true,
|
|
115
|
+
skipValidation: true,
|
|
116
|
+
breadcrumbsPrefix: ["response"],
|
|
117
|
+
}));
|
|
120
118
|
case 403:
|
|
121
119
|
throw new Webflow.ForbiddenError(_response.error.body);
|
|
122
120
|
case 404:
|
|
123
|
-
throw new Webflow.NotFoundError(_response.error.body
|
|
121
|
+
throw new Webflow.NotFoundError(serializers.Error_.parseOrThrow(_response.error.body, {
|
|
122
|
+
unrecognizedObjectKeys: "passthrough",
|
|
123
|
+
allowUnrecognizedUnionMembers: true,
|
|
124
|
+
allowUnrecognizedEnumValues: true,
|
|
125
|
+
skipValidation: true,
|
|
126
|
+
breadcrumbsPrefix: ["response"],
|
|
127
|
+
}));
|
|
124
128
|
case 409:
|
|
125
129
|
throw new Webflow.ConflictError(_response.error.body);
|
|
126
130
|
case 429:
|
|
127
|
-
throw new Webflow.TooManyRequestsError(serializers.
|
|
131
|
+
throw new Webflow.TooManyRequestsError(serializers.Error_.parseOrThrow(_response.error.body, {
|
|
128
132
|
unrecognizedObjectKeys: "passthrough",
|
|
129
133
|
allowUnrecognizedUnionMembers: true,
|
|
130
134
|
allowUnrecognizedEnumValues: true,
|
|
@@ -132,7 +136,13 @@ class Orders {
|
|
|
132
136
|
breadcrumbsPrefix: ["response"],
|
|
133
137
|
}));
|
|
134
138
|
case 500:
|
|
135
|
-
throw new Webflow.InternalServerError(_response.error.body
|
|
139
|
+
throw new Webflow.InternalServerError(serializers.Error_.parseOrThrow(_response.error.body, {
|
|
140
|
+
unrecognizedObjectKeys: "passthrough",
|
|
141
|
+
allowUnrecognizedUnionMembers: true,
|
|
142
|
+
allowUnrecognizedEnumValues: true,
|
|
143
|
+
skipValidation: true,
|
|
144
|
+
breadcrumbsPrefix: ["response"],
|
|
145
|
+
}));
|
|
136
146
|
default:
|
|
137
147
|
throw new errors.WebflowError({
|
|
138
148
|
statusCode: _response.error.statusCode,
|
|
@@ -147,7 +157,7 @@ class Orders {
|
|
|
147
157
|
body: _response.error.rawBody,
|
|
148
158
|
});
|
|
149
159
|
case "timeout":
|
|
150
|
-
throw new errors.WebflowTimeoutError();
|
|
160
|
+
throw new errors.WebflowTimeoutError("Timeout exceeded when calling GET /sites/{site_id}/orders.");
|
|
151
161
|
case "unknown":
|
|
152
162
|
throw new errors.WebflowError({
|
|
153
163
|
message: _response.error.errorMessage,
|
|
@@ -156,7 +166,8 @@ class Orders {
|
|
|
156
166
|
});
|
|
157
167
|
}
|
|
158
168
|
/**
|
|
159
|
-
* Retrieve a single product by its
|
|
169
|
+
* Retrieve a single product by its ID. All of its SKUs will also be
|
|
170
|
+
* retrieved.
|
|
160
171
|
*
|
|
161
172
|
* Required scope | `ecommerce:read`
|
|
162
173
|
*
|
|
@@ -181,15 +192,7 @@ class Orders {
|
|
|
181
192
|
const _response = yield core.fetcher({
|
|
182
193
|
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)}/orders/${encodeURIComponent(orderId)}`),
|
|
183
194
|
method: "GET",
|
|
184
|
-
headers: {
|
|
185
|
-
Authorization: yield this._getAuthorizationHeader(),
|
|
186
|
-
"X-Fern-Language": "JavaScript",
|
|
187
|
-
"X-Fern-SDK-Name": "webflow-api",
|
|
188
|
-
"X-Fern-SDK-Version": "2.4.2",
|
|
189
|
-
"User-Agent": "webflow-api/2.4.2",
|
|
190
|
-
"X-Fern-Runtime": core.RUNTIME.type,
|
|
191
|
-
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
192
|
-
},
|
|
195
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.0", "User-Agent": "webflow-api/3.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
193
196
|
contentType: "application/json",
|
|
194
197
|
requestType: "json",
|
|
195
198
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -210,15 +213,27 @@ class Orders {
|
|
|
210
213
|
case 400:
|
|
211
214
|
throw new Webflow.BadRequestError(_response.error.body);
|
|
212
215
|
case 401:
|
|
213
|
-
throw new Webflow.UnauthorizedError(_response.error.body
|
|
216
|
+
throw new Webflow.UnauthorizedError(serializers.Error_.parseOrThrow(_response.error.body, {
|
|
217
|
+
unrecognizedObjectKeys: "passthrough",
|
|
218
|
+
allowUnrecognizedUnionMembers: true,
|
|
219
|
+
allowUnrecognizedEnumValues: true,
|
|
220
|
+
skipValidation: true,
|
|
221
|
+
breadcrumbsPrefix: ["response"],
|
|
222
|
+
}));
|
|
214
223
|
case 403:
|
|
215
224
|
throw new Webflow.ForbiddenError(_response.error.body);
|
|
216
225
|
case 404:
|
|
217
|
-
throw new Webflow.NotFoundError(_response.error.body
|
|
226
|
+
throw new Webflow.NotFoundError(serializers.Error_.parseOrThrow(_response.error.body, {
|
|
227
|
+
unrecognizedObjectKeys: "passthrough",
|
|
228
|
+
allowUnrecognizedUnionMembers: true,
|
|
229
|
+
allowUnrecognizedEnumValues: true,
|
|
230
|
+
skipValidation: true,
|
|
231
|
+
breadcrumbsPrefix: ["response"],
|
|
232
|
+
}));
|
|
218
233
|
case 409:
|
|
219
234
|
throw new Webflow.ConflictError(_response.error.body);
|
|
220
235
|
case 429:
|
|
221
|
-
throw new Webflow.TooManyRequestsError(serializers.
|
|
236
|
+
throw new Webflow.TooManyRequestsError(serializers.Error_.parseOrThrow(_response.error.body, {
|
|
222
237
|
unrecognizedObjectKeys: "passthrough",
|
|
223
238
|
allowUnrecognizedUnionMembers: true,
|
|
224
239
|
allowUnrecognizedEnumValues: true,
|
|
@@ -226,7 +241,13 @@ class Orders {
|
|
|
226
241
|
breadcrumbsPrefix: ["response"],
|
|
227
242
|
}));
|
|
228
243
|
case 500:
|
|
229
|
-
throw new Webflow.InternalServerError(_response.error.body
|
|
244
|
+
throw new Webflow.InternalServerError(serializers.Error_.parseOrThrow(_response.error.body, {
|
|
245
|
+
unrecognizedObjectKeys: "passthrough",
|
|
246
|
+
allowUnrecognizedUnionMembers: true,
|
|
247
|
+
allowUnrecognizedEnumValues: true,
|
|
248
|
+
skipValidation: true,
|
|
249
|
+
breadcrumbsPrefix: ["response"],
|
|
250
|
+
}));
|
|
230
251
|
default:
|
|
231
252
|
throw new errors.WebflowError({
|
|
232
253
|
statusCode: _response.error.statusCode,
|
|
@@ -241,7 +262,7 @@ class Orders {
|
|
|
241
262
|
body: _response.error.rawBody,
|
|
242
263
|
});
|
|
243
264
|
case "timeout":
|
|
244
|
-
throw new errors.WebflowTimeoutError();
|
|
265
|
+
throw new errors.WebflowTimeoutError("Timeout exceeded when calling GET /sites/{site_id}/orders/{order_id}.");
|
|
245
266
|
case "unknown":
|
|
246
267
|
throw new errors.WebflowError({
|
|
247
268
|
message: _response.error.errorMessage,
|
|
@@ -250,7 +271,9 @@ class Orders {
|
|
|
250
271
|
});
|
|
251
272
|
}
|
|
252
273
|
/**
|
|
253
|
-
* This API lets you update the fields, `comment`, `shippingProvider`,
|
|
274
|
+
* This API lets you update the fields, `comment`, `shippingProvider`,
|
|
275
|
+
* and/or `shippingTracking` for a given order. All three fields can be
|
|
276
|
+
* updated simultaneously or independently.
|
|
254
277
|
*
|
|
255
278
|
* Required scope | `ecommerce:write`
|
|
256
279
|
*
|
|
@@ -276,18 +299,14 @@ class Orders {
|
|
|
276
299
|
const _response = yield core.fetcher({
|
|
277
300
|
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)}/orders/${encodeURIComponent(orderId)}`),
|
|
278
301
|
method: "PATCH",
|
|
279
|
-
headers: {
|
|
280
|
-
Authorization: yield this._getAuthorizationHeader(),
|
|
281
|
-
"X-Fern-Language": "JavaScript",
|
|
282
|
-
"X-Fern-SDK-Name": "webflow-api",
|
|
283
|
-
"X-Fern-SDK-Version": "2.4.2",
|
|
284
|
-
"User-Agent": "webflow-api/2.4.2",
|
|
285
|
-
"X-Fern-Runtime": core.RUNTIME.type,
|
|
286
|
-
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
287
|
-
},
|
|
302
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.0", "User-Agent": "webflow-api/3.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
288
303
|
contentType: "application/json",
|
|
289
304
|
requestType: "json",
|
|
290
|
-
body: serializers.OrdersUpdateRequest.jsonOrThrow(request, {
|
|
305
|
+
body: serializers.OrdersUpdateRequest.jsonOrThrow(request, {
|
|
306
|
+
unrecognizedObjectKeys: "passthrough",
|
|
307
|
+
allowUnrecognizedUnionMembers: true,
|
|
308
|
+
allowUnrecognizedEnumValues: true,
|
|
309
|
+
}),
|
|
291
310
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
292
311
|
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
293
312
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -306,15 +325,27 @@ class Orders {
|
|
|
306
325
|
case 400:
|
|
307
326
|
throw new Webflow.BadRequestError(_response.error.body);
|
|
308
327
|
case 401:
|
|
309
|
-
throw new Webflow.UnauthorizedError(_response.error.body
|
|
328
|
+
throw new Webflow.UnauthorizedError(serializers.Error_.parseOrThrow(_response.error.body, {
|
|
329
|
+
unrecognizedObjectKeys: "passthrough",
|
|
330
|
+
allowUnrecognizedUnionMembers: true,
|
|
331
|
+
allowUnrecognizedEnumValues: true,
|
|
332
|
+
skipValidation: true,
|
|
333
|
+
breadcrumbsPrefix: ["response"],
|
|
334
|
+
}));
|
|
310
335
|
case 403:
|
|
311
336
|
throw new Webflow.ForbiddenError(_response.error.body);
|
|
312
337
|
case 404:
|
|
313
|
-
throw new Webflow.NotFoundError(_response.error.body
|
|
338
|
+
throw new Webflow.NotFoundError(serializers.Error_.parseOrThrow(_response.error.body, {
|
|
339
|
+
unrecognizedObjectKeys: "passthrough",
|
|
340
|
+
allowUnrecognizedUnionMembers: true,
|
|
341
|
+
allowUnrecognizedEnumValues: true,
|
|
342
|
+
skipValidation: true,
|
|
343
|
+
breadcrumbsPrefix: ["response"],
|
|
344
|
+
}));
|
|
314
345
|
case 409:
|
|
315
346
|
throw new Webflow.ConflictError(_response.error.body);
|
|
316
347
|
case 429:
|
|
317
|
-
throw new Webflow.TooManyRequestsError(serializers.
|
|
348
|
+
throw new Webflow.TooManyRequestsError(serializers.Error_.parseOrThrow(_response.error.body, {
|
|
318
349
|
unrecognizedObjectKeys: "passthrough",
|
|
319
350
|
allowUnrecognizedUnionMembers: true,
|
|
320
351
|
allowUnrecognizedEnumValues: true,
|
|
@@ -322,7 +353,13 @@ class Orders {
|
|
|
322
353
|
breadcrumbsPrefix: ["response"],
|
|
323
354
|
}));
|
|
324
355
|
case 500:
|
|
325
|
-
throw new Webflow.InternalServerError(_response.error.body
|
|
356
|
+
throw new Webflow.InternalServerError(serializers.Error_.parseOrThrow(_response.error.body, {
|
|
357
|
+
unrecognizedObjectKeys: "passthrough",
|
|
358
|
+
allowUnrecognizedUnionMembers: true,
|
|
359
|
+
allowUnrecognizedEnumValues: true,
|
|
360
|
+
skipValidation: true,
|
|
361
|
+
breadcrumbsPrefix: ["response"],
|
|
362
|
+
}));
|
|
326
363
|
default:
|
|
327
364
|
throw new errors.WebflowError({
|
|
328
365
|
statusCode: _response.error.statusCode,
|
|
@@ -337,7 +374,7 @@ class Orders {
|
|
|
337
374
|
body: _response.error.rawBody,
|
|
338
375
|
});
|
|
339
376
|
case "timeout":
|
|
340
|
-
throw new errors.WebflowTimeoutError();
|
|
377
|
+
throw new errors.WebflowTimeoutError("Timeout exceeded when calling PATCH /sites/{site_id}/orders/{order_id}.");
|
|
341
378
|
case "unknown":
|
|
342
379
|
throw new errors.WebflowError({
|
|
343
380
|
message: _response.error.errorMessage,
|
|
@@ -372,18 +409,14 @@ class Orders {
|
|
|
372
409
|
const _response = yield core.fetcher({
|
|
373
410
|
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)}/orders/${encodeURIComponent(orderId)}/fulfill`),
|
|
374
411
|
method: "POST",
|
|
375
|
-
headers: {
|
|
376
|
-
Authorization: yield this._getAuthorizationHeader(),
|
|
377
|
-
"X-Fern-Language": "JavaScript",
|
|
378
|
-
"X-Fern-SDK-Name": "webflow-api",
|
|
379
|
-
"X-Fern-SDK-Version": "2.4.2",
|
|
380
|
-
"User-Agent": "webflow-api/2.4.2",
|
|
381
|
-
"X-Fern-Runtime": core.RUNTIME.type,
|
|
382
|
-
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
383
|
-
},
|
|
412
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.0", "User-Agent": "webflow-api/3.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
384
413
|
contentType: "application/json",
|
|
385
414
|
requestType: "json",
|
|
386
|
-
body: serializers.OrdersUpdateFulfillRequest.jsonOrThrow(request, {
|
|
415
|
+
body: serializers.OrdersUpdateFulfillRequest.jsonOrThrow(request, {
|
|
416
|
+
unrecognizedObjectKeys: "passthrough",
|
|
417
|
+
allowUnrecognizedUnionMembers: true,
|
|
418
|
+
allowUnrecognizedEnumValues: true,
|
|
419
|
+
}),
|
|
387
420
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
388
421
|
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
389
422
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -402,15 +435,27 @@ class Orders {
|
|
|
402
435
|
case 400:
|
|
403
436
|
throw new Webflow.BadRequestError(_response.error.body);
|
|
404
437
|
case 401:
|
|
405
|
-
throw new Webflow.UnauthorizedError(_response.error.body
|
|
438
|
+
throw new Webflow.UnauthorizedError(serializers.Error_.parseOrThrow(_response.error.body, {
|
|
439
|
+
unrecognizedObjectKeys: "passthrough",
|
|
440
|
+
allowUnrecognizedUnionMembers: true,
|
|
441
|
+
allowUnrecognizedEnumValues: true,
|
|
442
|
+
skipValidation: true,
|
|
443
|
+
breadcrumbsPrefix: ["response"],
|
|
444
|
+
}));
|
|
406
445
|
case 403:
|
|
407
446
|
throw new Webflow.ForbiddenError(_response.error.body);
|
|
408
447
|
case 404:
|
|
409
|
-
throw new Webflow.NotFoundError(_response.error.body
|
|
448
|
+
throw new Webflow.NotFoundError(serializers.Error_.parseOrThrow(_response.error.body, {
|
|
449
|
+
unrecognizedObjectKeys: "passthrough",
|
|
450
|
+
allowUnrecognizedUnionMembers: true,
|
|
451
|
+
allowUnrecognizedEnumValues: true,
|
|
452
|
+
skipValidation: true,
|
|
453
|
+
breadcrumbsPrefix: ["response"],
|
|
454
|
+
}));
|
|
410
455
|
case 409:
|
|
411
456
|
throw new Webflow.ConflictError(_response.error.body);
|
|
412
457
|
case 429:
|
|
413
|
-
throw new Webflow.TooManyRequestsError(serializers.
|
|
458
|
+
throw new Webflow.TooManyRequestsError(serializers.Error_.parseOrThrow(_response.error.body, {
|
|
414
459
|
unrecognizedObjectKeys: "passthrough",
|
|
415
460
|
allowUnrecognizedUnionMembers: true,
|
|
416
461
|
allowUnrecognizedEnumValues: true,
|
|
@@ -418,7 +463,13 @@ class Orders {
|
|
|
418
463
|
breadcrumbsPrefix: ["response"],
|
|
419
464
|
}));
|
|
420
465
|
case 500:
|
|
421
|
-
throw new Webflow.InternalServerError(_response.error.body
|
|
466
|
+
throw new Webflow.InternalServerError(serializers.Error_.parseOrThrow(_response.error.body, {
|
|
467
|
+
unrecognizedObjectKeys: "passthrough",
|
|
468
|
+
allowUnrecognizedUnionMembers: true,
|
|
469
|
+
allowUnrecognizedEnumValues: true,
|
|
470
|
+
skipValidation: true,
|
|
471
|
+
breadcrumbsPrefix: ["response"],
|
|
472
|
+
}));
|
|
422
473
|
default:
|
|
423
474
|
throw new errors.WebflowError({
|
|
424
475
|
statusCode: _response.error.statusCode,
|
|
@@ -433,7 +484,7 @@ class Orders {
|
|
|
433
484
|
body: _response.error.rawBody,
|
|
434
485
|
});
|
|
435
486
|
case "timeout":
|
|
436
|
-
throw new errors.WebflowTimeoutError();
|
|
487
|
+
throw new errors.WebflowTimeoutError("Timeout exceeded when calling POST /sites/{site_id}/orders/{order_id}/fulfill.");
|
|
437
488
|
case "unknown":
|
|
438
489
|
throw new errors.WebflowError({
|
|
439
490
|
message: _response.error.errorMessage,
|
|
@@ -467,15 +518,7 @@ class Orders {
|
|
|
467
518
|
const _response = yield core.fetcher({
|
|
468
519
|
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)}/orders/${encodeURIComponent(orderId)}/unfulfill`),
|
|
469
520
|
method: "POST",
|
|
470
|
-
headers: {
|
|
471
|
-
Authorization: yield this._getAuthorizationHeader(),
|
|
472
|
-
"X-Fern-Language": "JavaScript",
|
|
473
|
-
"X-Fern-SDK-Name": "webflow-api",
|
|
474
|
-
"X-Fern-SDK-Version": "2.4.2",
|
|
475
|
-
"User-Agent": "webflow-api/2.4.2",
|
|
476
|
-
"X-Fern-Runtime": core.RUNTIME.type,
|
|
477
|
-
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
478
|
-
},
|
|
521
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.0", "User-Agent": "webflow-api/3.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
479
522
|
contentType: "application/json",
|
|
480
523
|
requestType: "json",
|
|
481
524
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -496,15 +539,27 @@ class Orders {
|
|
|
496
539
|
case 400:
|
|
497
540
|
throw new Webflow.BadRequestError(_response.error.body);
|
|
498
541
|
case 401:
|
|
499
|
-
throw new Webflow.UnauthorizedError(_response.error.body
|
|
542
|
+
throw new Webflow.UnauthorizedError(serializers.Error_.parseOrThrow(_response.error.body, {
|
|
543
|
+
unrecognizedObjectKeys: "passthrough",
|
|
544
|
+
allowUnrecognizedUnionMembers: true,
|
|
545
|
+
allowUnrecognizedEnumValues: true,
|
|
546
|
+
skipValidation: true,
|
|
547
|
+
breadcrumbsPrefix: ["response"],
|
|
548
|
+
}));
|
|
500
549
|
case 403:
|
|
501
550
|
throw new Webflow.ForbiddenError(_response.error.body);
|
|
502
551
|
case 404:
|
|
503
|
-
throw new Webflow.NotFoundError(_response.error.body
|
|
552
|
+
throw new Webflow.NotFoundError(serializers.Error_.parseOrThrow(_response.error.body, {
|
|
553
|
+
unrecognizedObjectKeys: "passthrough",
|
|
554
|
+
allowUnrecognizedUnionMembers: true,
|
|
555
|
+
allowUnrecognizedEnumValues: true,
|
|
556
|
+
skipValidation: true,
|
|
557
|
+
breadcrumbsPrefix: ["response"],
|
|
558
|
+
}));
|
|
504
559
|
case 409:
|
|
505
560
|
throw new Webflow.ConflictError(_response.error.body);
|
|
506
561
|
case 429:
|
|
507
|
-
throw new Webflow.TooManyRequestsError(serializers.
|
|
562
|
+
throw new Webflow.TooManyRequestsError(serializers.Error_.parseOrThrow(_response.error.body, {
|
|
508
563
|
unrecognizedObjectKeys: "passthrough",
|
|
509
564
|
allowUnrecognizedUnionMembers: true,
|
|
510
565
|
allowUnrecognizedEnumValues: true,
|
|
@@ -512,7 +567,13 @@ class Orders {
|
|
|
512
567
|
breadcrumbsPrefix: ["response"],
|
|
513
568
|
}));
|
|
514
569
|
case 500:
|
|
515
|
-
throw new Webflow.InternalServerError(_response.error.body
|
|
570
|
+
throw new Webflow.InternalServerError(serializers.Error_.parseOrThrow(_response.error.body, {
|
|
571
|
+
unrecognizedObjectKeys: "passthrough",
|
|
572
|
+
allowUnrecognizedUnionMembers: true,
|
|
573
|
+
allowUnrecognizedEnumValues: true,
|
|
574
|
+
skipValidation: true,
|
|
575
|
+
breadcrumbsPrefix: ["response"],
|
|
576
|
+
}));
|
|
516
577
|
default:
|
|
517
578
|
throw new errors.WebflowError({
|
|
518
579
|
statusCode: _response.error.statusCode,
|
|
@@ -527,7 +588,7 @@ class Orders {
|
|
|
527
588
|
body: _response.error.rawBody,
|
|
528
589
|
});
|
|
529
590
|
case "timeout":
|
|
530
|
-
throw new errors.WebflowTimeoutError();
|
|
591
|
+
throw new errors.WebflowTimeoutError("Timeout exceeded when calling POST /sites/{site_id}/orders/{order_id}/unfulfill.");
|
|
531
592
|
case "unknown":
|
|
532
593
|
throw new errors.WebflowError({
|
|
533
594
|
message: _response.error.errorMessage,
|
|
@@ -563,18 +624,14 @@ class Orders {
|
|
|
563
624
|
const _response = yield core.fetcher({
|
|
564
625
|
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)}/orders/${encodeURIComponent(orderId)}/refund`),
|
|
565
626
|
method: "POST",
|
|
566
|
-
headers: {
|
|
567
|
-
Authorization: yield this._getAuthorizationHeader(),
|
|
568
|
-
"X-Fern-Language": "JavaScript",
|
|
569
|
-
"X-Fern-SDK-Name": "webflow-api",
|
|
570
|
-
"X-Fern-SDK-Version": "2.4.2",
|
|
571
|
-
"User-Agent": "webflow-api/2.4.2",
|
|
572
|
-
"X-Fern-Runtime": core.RUNTIME.type,
|
|
573
|
-
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
574
|
-
},
|
|
627
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.0", "User-Agent": "webflow-api/3.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
575
628
|
contentType: "application/json",
|
|
576
629
|
requestType: "json",
|
|
577
|
-
body: serializers.OrdersRefundRequest.jsonOrThrow(request, {
|
|
630
|
+
body: serializers.OrdersRefundRequest.jsonOrThrow(request, {
|
|
631
|
+
unrecognizedObjectKeys: "passthrough",
|
|
632
|
+
allowUnrecognizedUnionMembers: true,
|
|
633
|
+
allowUnrecognizedEnumValues: true,
|
|
634
|
+
}),
|
|
578
635
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
579
636
|
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
580
637
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -593,15 +650,27 @@ class Orders {
|
|
|
593
650
|
case 400:
|
|
594
651
|
throw new Webflow.BadRequestError(_response.error.body);
|
|
595
652
|
case 401:
|
|
596
|
-
throw new Webflow.UnauthorizedError(_response.error.body
|
|
653
|
+
throw new Webflow.UnauthorizedError(serializers.Error_.parseOrThrow(_response.error.body, {
|
|
654
|
+
unrecognizedObjectKeys: "passthrough",
|
|
655
|
+
allowUnrecognizedUnionMembers: true,
|
|
656
|
+
allowUnrecognizedEnumValues: true,
|
|
657
|
+
skipValidation: true,
|
|
658
|
+
breadcrumbsPrefix: ["response"],
|
|
659
|
+
}));
|
|
597
660
|
case 403:
|
|
598
661
|
throw new Webflow.ForbiddenError(_response.error.body);
|
|
599
662
|
case 404:
|
|
600
|
-
throw new Webflow.NotFoundError(_response.error.body
|
|
663
|
+
throw new Webflow.NotFoundError(serializers.Error_.parseOrThrow(_response.error.body, {
|
|
664
|
+
unrecognizedObjectKeys: "passthrough",
|
|
665
|
+
allowUnrecognizedUnionMembers: true,
|
|
666
|
+
allowUnrecognizedEnumValues: true,
|
|
667
|
+
skipValidation: true,
|
|
668
|
+
breadcrumbsPrefix: ["response"],
|
|
669
|
+
}));
|
|
601
670
|
case 409:
|
|
602
671
|
throw new Webflow.ConflictError(_response.error.body);
|
|
603
672
|
case 429:
|
|
604
|
-
throw new Webflow.TooManyRequestsError(serializers.
|
|
673
|
+
throw new Webflow.TooManyRequestsError(serializers.Error_.parseOrThrow(_response.error.body, {
|
|
605
674
|
unrecognizedObjectKeys: "passthrough",
|
|
606
675
|
allowUnrecognizedUnionMembers: true,
|
|
607
676
|
allowUnrecognizedEnumValues: true,
|
|
@@ -609,7 +678,13 @@ class Orders {
|
|
|
609
678
|
breadcrumbsPrefix: ["response"],
|
|
610
679
|
}));
|
|
611
680
|
case 500:
|
|
612
|
-
throw new Webflow.InternalServerError(_response.error.body
|
|
681
|
+
throw new Webflow.InternalServerError(serializers.Error_.parseOrThrow(_response.error.body, {
|
|
682
|
+
unrecognizedObjectKeys: "passthrough",
|
|
683
|
+
allowUnrecognizedUnionMembers: true,
|
|
684
|
+
allowUnrecognizedEnumValues: true,
|
|
685
|
+
skipValidation: true,
|
|
686
|
+
breadcrumbsPrefix: ["response"],
|
|
687
|
+
}));
|
|
613
688
|
default:
|
|
614
689
|
throw new errors.WebflowError({
|
|
615
690
|
statusCode: _response.error.statusCode,
|
|
@@ -624,7 +699,7 @@ class Orders {
|
|
|
624
699
|
body: _response.error.rawBody,
|
|
625
700
|
});
|
|
626
701
|
case "timeout":
|
|
627
|
-
throw new errors.WebflowTimeoutError();
|
|
702
|
+
throw new errors.WebflowTimeoutError("Timeout exceeded when calling POST /sites/{site_id}/orders/{order_id}/refund.");
|
|
628
703
|
case "unknown":
|
|
629
704
|
throw new errors.WebflowError({
|
|
630
705
|
message: _response.error.errorMessage,
|
|
@@ -17,13 +17,17 @@ export declare namespace Pages {
|
|
|
17
17
|
maxRetries?: number;
|
|
18
18
|
/** A hook to abort the request. */
|
|
19
19
|
abortSignal?: AbortSignal;
|
|
20
|
+
/** Additional headers to include in the request. */
|
|
21
|
+
headers?: Record<string, string>;
|
|
20
22
|
}
|
|
21
23
|
}
|
|
22
24
|
export declare class Pages {
|
|
23
25
|
protected readonly _options: Pages.Options;
|
|
24
26
|
constructor(_options: Pages.Options);
|
|
25
27
|
/**
|
|
26
|
-
* List of all pages for a site
|
|
28
|
+
* List of all pages for a site.
|
|
29
|
+
*
|
|
30
|
+
* Required scope | `pages:read`
|
|
27
31
|
*
|
|
28
32
|
* @param {string} siteId - Unique identifier for a Site
|
|
29
33
|
* @param {Webflow.PagesListRequest} request
|
|
@@ -37,12 +41,14 @@ export declare class Pages {
|
|
|
37
41
|
*
|
|
38
42
|
* @example
|
|
39
43
|
* await client.pages.list("580e63e98c9a982ac9b8b741", {
|
|
40
|
-
*
|
|
44
|
+
* localeId: "65427cf400e02b306eaa04a0"
|
|
41
45
|
* })
|
|
42
46
|
*/
|
|
43
47
|
list(siteId: string, request?: Webflow.PagesListRequest, requestOptions?: Pages.RequestOptions): Promise<Webflow.PageList>;
|
|
44
48
|
/**
|
|
45
|
-
* Get metadata information for a single page
|
|
49
|
+
* Get metadata information for a single page.
|
|
50
|
+
*
|
|
51
|
+
* Required scope | `pages:read`
|
|
46
52
|
*
|
|
47
53
|
* @param {string} pageId - Unique identifier for a Page
|
|
48
54
|
* @param {Webflow.PagesGetMetadataRequest} request
|
|
@@ -56,12 +62,14 @@ export declare class Pages {
|
|
|
56
62
|
*
|
|
57
63
|
* @example
|
|
58
64
|
* await client.pages.getMetadata("63c720f9347c2139b248e552", {
|
|
59
|
-
*
|
|
65
|
+
* localeId: "65427cf400e02b306eaa04a0"
|
|
60
66
|
* })
|
|
61
67
|
*/
|
|
62
68
|
getMetadata(pageId: string, request?: Webflow.PagesGetMetadataRequest, requestOptions?: Pages.RequestOptions): Promise<Webflow.Page>;
|
|
63
69
|
/**
|
|
64
|
-
* Update Page-level metadata, including SEO and Open Graph fields.
|
|
70
|
+
* Update Page-level metadata, including SEO and Open Graph fields.
|
|
71
|
+
*
|
|
72
|
+
* Required scope | `pages:write`
|
|
65
73
|
*
|
|
66
74
|
* @param {string} pageId - Unique identifier for a Page
|
|
67
75
|
* @param {Webflow.UpdatePageSettingsRequest} request
|
|
@@ -75,19 +83,18 @@ export declare class Pages {
|
|
|
75
83
|
*
|
|
76
84
|
* @example
|
|
77
85
|
* await client.pages.updatePageSettings("63c720f9347c2139b248e552", {
|
|
78
|
-
*
|
|
86
|
+
* localeId: "65427cf400e02b306eaa04a0",
|
|
79
87
|
* body: {
|
|
80
88
|
* id: "6596da6045e56dee495bcbba",
|
|
81
89
|
* siteId: "6258612d1ee792848f805dcf",
|
|
82
90
|
* title: "Guide to the Galaxy",
|
|
83
91
|
* slug: "guide-to-the-galaxy",
|
|
84
|
-
* parentId: "6419db964a9c435aa3af6251",
|
|
85
|
-
* collectionId: "6390c49774a71f12831a08e3",
|
|
86
92
|
* createdOn: "2024-03-11T10:42:00Z",
|
|
87
93
|
* lastUpdated: "2024-03-11T10:42:42Z",
|
|
88
94
|
* archived: false,
|
|
89
95
|
* draft: false,
|
|
90
96
|
* canBranch: true,
|
|
97
|
+
* isBranch: false,
|
|
91
98
|
* seo: {
|
|
92
99
|
* title: "The Ultimate Hitchhiker's Guide to the Galaxy",
|
|
93
100
|
* description: "Everything you need to know about the galaxy, from avoiding Vogon poetry to the importance of towels."
|
|
@@ -105,7 +112,11 @@ export declare class Pages {
|
|
|
105
112
|
*/
|
|
106
113
|
updatePageSettings(pageId: string, request: Webflow.UpdatePageSettingsRequest, requestOptions?: Pages.RequestOptions): Promise<Webflow.Page>;
|
|
107
114
|
/**
|
|
108
|
-
* Get static content from a static page.
|
|
115
|
+
* Get static content from a static page.
|
|
116
|
+
*
|
|
117
|
+
* If you do not provide a Locale ID in your request, the response will return any content that can be localized from the Primary locale.
|
|
118
|
+
*
|
|
119
|
+
* Required scope | `pages:read`
|
|
109
120
|
*
|
|
110
121
|
* @param {string} pageId - Unique identifier for a Page
|
|
111
122
|
* @param {Webflow.PagesGetContentRequest} request
|
|
@@ -120,7 +131,7 @@ export declare class Pages {
|
|
|
120
131
|
*
|
|
121
132
|
* @example
|
|
122
133
|
* await client.pages.getContent("63c720f9347c2139b248e552", {
|
|
123
|
-
*
|
|
134
|
+
* localeId: "65427cf400e02b306eaa04a0"
|
|
124
135
|
* })
|
|
125
136
|
*/
|
|
126
137
|
getContent(pageId: string, request?: Webflow.PagesGetContentRequest, requestOptions?: Pages.RequestOptions): Promise<Webflow.Dom>;
|
|
@@ -144,16 +155,16 @@ export declare class Pages {
|
|
|
144
155
|
*
|
|
145
156
|
* @example
|
|
146
157
|
* await client.pages.updateStaticContent("63c720f9347c2139b248e552", {
|
|
147
|
-
*
|
|
158
|
+
* localeId: "65427cf400e02b306eaa04a0",
|
|
148
159
|
* nodes: [{
|
|
149
160
|
* nodeId: "a245c12d-995b-55ee-5ec7-aa36a6cad623",
|
|
150
|
-
* text: "<h1>The Hitchhiker
|
|
161
|
+
* text: "<h1>The Hitchhiker\u2019s Guide to the Galaxy</h1>"
|
|
151
162
|
* }, {
|
|
152
163
|
* nodeId: "a245c12d-995b-55ee-5ec7-aa36a6cad627",
|
|
153
|
-
* text: "<div><h3>Don
|
|
164
|
+
* text: "<div><h3>Don\u2019t Panic!</h3><p>Always know where your towel is.</p></div>"
|
|
154
165
|
* }, {
|
|
155
166
|
* nodeId: "a245c12d-995b-55ee-5ec7-aa36a6cad629",
|
|
156
|
-
* text: "<img alt
|
|
167
|
+
* text: "<img alt=\"Marvin, the Paranoid Android\" src=\"path/to/image/with/assetId/659595234426a9fcbad57043\"/>"
|
|
157
168
|
* }]
|
|
158
169
|
* })
|
|
159
170
|
*/
|