From dd2fed0f531a2352b4106717532ad28d33e5b1e9 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Fri, 21 Feb 2025 01:51:50 +0000 Subject: [PATCH] [nightly] generate types against bigcommerce/docs@6643e17 --- src/generated/category-trees_catalog.v3.ts | 10 ++++++---- src/generated/checkouts.v3.ts | 6 ++++++ src/generated/orders.v2.oas2.ts | 4 ++-- src/generated/pricing.sf.ts | 4 ++++ src/generated/products_catalog.v3.ts | 14 ++++++++++---- src/generated/segments.v3.ts | 4 ++++ 6 files changed, 32 insertions(+), 10 deletions(-) diff --git a/src/generated/category-trees_catalog.v3.ts b/src/generated/category-trees_catalog.v3.ts index 54003b9..401ab3b 100644 --- a/src/generated/category-trees_catalog.v3.ts +++ b/src/generated/category-trees_catalog.v3.ts @@ -29,7 +29,7 @@ export interface paths { * - 16,000 categories per store limit. * - 1,000 categories per product limit. * - 50 characters category name length. - * - 8 levels of category depth limit. + * - 8 levels of child categories depth limit. * - 65,535 characters category description length limit. * * Creating a category requires: @@ -63,7 +63,8 @@ export interface paths { * This single endpoint updates and creates category trees. If a tree object contains an ID, it is processed as an update operation using that ID. If you do not provide an ID, a new tree is created. The category tree `name` field is required to create trees, but is not required on the update. * * **Usage Notes** - * * `channel_id` is required to create a category tree. You can assign one `channel_id` to one category tree. + * * Channel ID in the `channels` field is required to create a category tree. You can only assign a category tree to one channel. + * * The `channels` field must be absent when updating a category tree. This field is currently unsupported during a category tree update. */ put: operations["upsertCategoryTrees"]; /** @@ -590,7 +591,7 @@ export interface operations { * - 16,000 categories per store limit. * - 1,000 categories per product limit. * - 50 characters category name length. - * - 8 levels of category depth limit. + * - 8 levels of child categories depth limit. * - 65,535 characters category description length limit. * * Creating a category requires: @@ -707,7 +708,8 @@ export interface operations { * This single endpoint updates and creates category trees. If a tree object contains an ID, it is processed as an update operation using that ID. If you do not provide an ID, a new tree is created. The category tree `name` field is required to create trees, but is not required on the update. * * **Usage Notes** - * * `channel_id` is required to create a category tree. You can assign one `channel_id` to one category tree. + * * Channel ID in the `channels` field is required to create a category tree. You can only assign a category tree to one channel. + * * The `channels` field must be absent when updating a category tree. This field is currently unsupported during a category tree update. */ upsertCategoryTrees: { parameters: { diff --git a/src/generated/checkouts.v3.ts b/src/generated/checkouts.v3.ts index 567688b..1d5d428 100644 --- a/src/generated/checkouts.v3.ts +++ b/src/generated/checkouts.v3.ts @@ -1025,6 +1025,8 @@ export interface components { order_confirmation_use_custom_checkout_script?: boolean; custom_order_confirmation_script_url?: string; custom_checkout_supports_uco_settings?: boolean; + custom_checkout_sri_hash?: string; + custom_order_confirmation_sri_hash?: string; }; /** Checkouts settings request */ CheckoutsSettingsRequest: { @@ -1036,6 +1038,10 @@ export interface components { custom_order_confirmation_script_url?: string; /** @description Boolean value that specifies whether this checkout supports Optimized One-Page Checkout settings. */ custom_checkout_supports_uco_settings?: boolean; + /** @description The Subresource Integrity (SRI) hash for the custom checkout script URL. */ + custom_checkout_sri_hash?: string; + /** @description The Subresource Integrity (SRI) hash for the custom order confirmation script URL. */ + custom_order_confirmation_sri_hash?: string; }; /** Pickup Option */ PickupOption: { diff --git a/src/generated/orders.v2.oas2.ts b/src/generated/orders.v2.oas2.ts index 245b2cf..a11ddf6 100644 --- a/src/generated/orders.v2.oas2.ts +++ b/src/generated/orders.v2.oas2.ts @@ -1445,7 +1445,7 @@ export interface components { */ base_wrapping_cost?: string; /** - * @description Shows where the order originated. The channel_id will default to 1. + * @description Shows where the order originated. The channel_id defaults to 1. The value must match the ID of a valid and enabled channel. If the ID refers to a non-existing or disconnected channel, the POST and PUT `/v2/orders` endpoints return a validation error. * @example 1 */ channel_id?: number; @@ -2088,7 +2088,7 @@ export interface components { base_wrapping_cost?: string; billing_address?: components["schemas"]["billingAddress_Put"]; /** - * @description Shows where the order originated. The channel_id will default to 1. + * @description Shows where the order originated. The channel_id defaults to 1. The value must match the ID of a valid and enabled channel. If the ID refers to a non-existing or disconnected channel, the POST and PUT `/v2/orders` endpoints return a validation error. * @example 1 */ channel_id?: number; diff --git a/src/generated/pricing.sf.ts b/src/generated/pricing.sf.ts index f57d4c9..f76bec2 100644 --- a/src/generated/pricing.sf.ts +++ b/src/generated/pricing.sf.ts @@ -11,6 +11,8 @@ export interface paths { * Get Prices (Batch) * @description Calculate batch pricing for products for a specific channel, currency, and customer group. * + * The rounded prices in this endpoint's response will align with the currency's decimal precision as defined in the [currency](https://support.bigcommerce.com/s/article/Managing-Currencies?language=en_US#add) settings page. + * * **Limits** * * Limit of 50 concurrent requests. */ @@ -427,6 +429,8 @@ export interface operations { * Get Prices (Batch) * @description Calculate batch pricing for products for a specific channel, currency, and customer group. * + * The rounded prices in this endpoint's response will align with the currency's decimal precision as defined in the [currency](https://support.bigcommerce.com/s/article/Managing-Currencies?language=en_US#add) settings page. + * * **Limits** * * Limit of 50 concurrent requests. */ diff --git a/src/generated/products_catalog.v3.ts b/src/generated/products_catalog.v3.ts index daf823f..6067480 100644 --- a/src/generated/products_catalog.v3.ts +++ b/src/generated/products_catalog.v3.ts @@ -1126,6 +1126,7 @@ export interface components { /** @description Length of the video. This will be filled in according to data on a host site. */ length?: string; }; + IncludeParamBase: ("bulk_pricing_rules" | "reviews" | "modifiers" | "options" | "parent_relations" | "custom_fields" | "channels" | "videos")[]; /** * product_Put * @description The model for a PUT to update a product. @@ -3314,8 +3315,13 @@ export interface components { CategoriesInParam?: number[]; /** @description Pass a comma-separated list to filter by one or more channel IDs. */ ChannelIdInParam?: number[]; - /** @description A comma-separated list of sub-resources to return with a product object. When you specify `options` or `modifiers`, results are limited to 10 per page. */ - IncludeParam?: ("bulk_pricing_rules" | "reviews" | "modifiers" | "options" | "parent_relations" | "custom_fields" | "channels")[]; + /** + * @description A comma-separated list of sub-resources to return with a product object. + * When you specify `options` or `modifiers`, results are limited to 10 per page. + */ + IncludeParamGetProducts?: components["schemas"]["IncludeParamBase"]; + /** @description A comma-separated list of sub-resources to return with a product object. */ + IncludeParamGetProduct?: components["schemas"]["IncludeParamBase"]; IdMinParam?: number; IdMaxParam?: number; IdGreaterParam?: number; @@ -3429,7 +3435,7 @@ export interface operations { "id:in"?: components["parameters"]["IdInParam"]; "channel_id:in"?: components["parameters"]["ChannelIdInParam"]; "id:not_in"?: components["parameters"]["IdNotInParam"]; - include?: components["parameters"]["IncludeParam"]; + include?: components["parameters"]["IncludeParamGetProducts"]; include_fields?: components["parameters"]["IncludeFieldsParam"]; exclude_fields?: components["parameters"]["ExcludeFieldsParam"]; page?: components["parameters"]["PageParam"]; @@ -3842,7 +3848,7 @@ export interface operations { getProduct: { parameters: { query?: { - include?: components["parameters"]["IncludeParam"]; + include?: components["parameters"]["IncludeParamGetProduct"]; include_fields?: components["parameters"]["IncludeFieldsParam"]; exclude_fields?: components["parameters"]["ExcludeFieldsParam"]; }; diff --git a/src/generated/segments.v3.ts b/src/generated/segments.v3.ts index 70f9448..d4dcb5c 100644 --- a/src/generated/segments.v3.ts +++ b/src/generated/segments.v3.ts @@ -43,6 +43,8 @@ export interface paths { /** * Get All Shopper Profiles in a Segment * @description Returns a list of *Shopper Profiles* that are associated with a given *Segment*. + * + * **NOTE**: The `modify` Customers OAuth scope is a requirement for this endpoint. */ get: operations["GetSegmentProfiles"]; /** @@ -453,6 +455,8 @@ export interface operations { /** * Get All Shopper Profiles in a Segment * @description Returns a list of *Shopper Profiles* that are associated with a given *Segment*. + * + * **NOTE**: The `modify` Customers OAuth scope is a requirement for this endpoint. */ GetSegmentProfiles: { parameters: {