diff --git a/docs/changelog/1.1.1.md b/docs/changelog/1.1.1.md new file mode 100644 index 0000000..1ddbbab --- /dev/null +++ b/docs/changelog/1.1.1.md @@ -0,0 +1,200 @@ +# Interface Change Summary: 1.1.1 + +## Modified files +### `carts.v3.ts` + +components.schemas.cart_PostCustomItem: +```diff ++ readonly image_url?: string; +``` + +### `catalog/product_variants_catalog.v3.ts` + +components.parameters: +```diff ++ readonly MetafieldResourceParam: string; +``` + +operations.getProductVariantMetafields.parameters.query: +```diff ++ readonly "resource_id:in"?: components["parameters"]["MetafieldResourceParam"]; +``` + +### `catalog/products_catalog.v3.ts` + +components.parameters: +```diff ++ readonly MetafieldResourceParam: string; ++ readonly CustomFieldsIncludeFieldsParam: readonly ("name" | "value")[]; ++ readonly CustomFieldsExcludeFieldsParam: readonly ("name" | "value")[]; +``` + +operations.getProductCustomFields.parameters.query: +```diff +- readonly include_fields?: components["parameters"]["IncludeFieldsParam"]; ++ readonly include_fields?: components["parameters"]["CustomFieldsIncludeFieldsParam"]; +- readonly exclude_fields?: components["parameters"]["ExcludeFieldsParam"]; ++ readonly exclude_fields?: components["parameters"]["CustomFieldsExcludeFieldsParam"]; +``` + +operations.getProductCustomField.parameters.query: +```diff +- readonly include_fields?: components["parameters"]["IncludeFieldsParam"]; ++ readonly include_fields?: components["parameters"]["CustomFieldsIncludeFieldsParam"]; +- readonly exclude_fields?: components["parameters"]["ExcludeFieldsParam"]; ++ readonly exclude_fields?: components["parameters"]["CustomFieldsExcludeFieldsParam"]; +``` + +operations.getProductMetafields.parameters.query: +```diff ++ readonly "resource_id:in"?: components["parameters"]["MetafieldResourceParam"]; +``` + +### `marketing.v2.ts` + +operations.getGiftCertificates.parameters.query: +```diff ++ readonly sort?: "id"; ++ readonly direction?: "asc" | "desc"; +``` + +### `orders.sf.ts` + +components.schemas.Order: +```diff ++ readonly comparisonShippingCost?: number; +``` + +components.schemas.ShippingConsignment: +```diff ++ readonly shippingCostBeforeDiscount?: number; ++ readonly comparisonShippingCost?: number; +``` + +### `orders.v2.oas2.ts` + +components.schemas.orderTaxes_Base: +```diff ++ readonly sales_tax_id?: string; +``` + +components.schemas.order_RespOnly: +```diff +- readonly consignments?: components["schemas"]["orderConsignments_Resource"]; ++ readonly consignments?: components["schemas"]["orderConsignments_Resource"] | components["schemas"]["orderConsignment_Get"]; +``` + +components.schemas.giftCertificateConsignment_Get: +```diff +- readonly line_items?: readonly components["schemas"]["products_Resource"][]; ++ readonly line_items?: readonly components["schemas"]["products_Resource"][] | readonly components["schemas"]["orderProducts"][]; +``` + +components.schemas.pickupConsignment_Get: +```diff +- readonly line_items?: readonly components["schemas"]["products_Resource"][]; ++ readonly line_items?: readonly components["schemas"]["products_Resource"][] | readonly components["schemas"]["orderProducts"][]; +``` + +components.schemas.shippingConsignment_Get: +```diff +- readonly line_items?: readonly components["schemas"]["products_Resource"][]; ++ readonly line_items?: readonly components["schemas"]["products_Resource"][] | readonly components["schemas"]["orderProducts"][]; +``` + +components.schemas.digitalConsignment_Get: +```diff +- readonly line_items?: readonly components["schemas"]["products_Resource"][]; ++ readonly line_items?: readonly components["schemas"]["products_Resource"][] | readonly components["schemas"]["orderProducts"][]; +``` + +### `orders.v3.ts` + +components.schemas.MerchantOverride: +```diff +- readonly total_amount: components["schemas"]["Amount"]; ++ readonly total_amount: number; +``` + +components.schemas.RefundQuote_ItemsRefund: +```diff +- readonly merchant_calculated_override?: components["schemas"]["MerchantOverride"]; +``` + +components.schemas.RefundQuote_TaxAdjustmentAmount: +```diff +- readonly merchant_calculated_override?: components["schemas"]["MerchantOverride"]; +``` + +### `promotions.v3.ts` + +components.schemas.PatchCouponPromotion: +```diff ++ readonly coupon_type?: "SINGLE" | "BULK"; +``` + +components.schemas.DraftCouponPromotion: +```diff ++ readonly coupon_type: "SINGLE" | "BULK"; +``` + +components.schemas.SavedCouponPromotion: +```diff ++ readonly coupon_type: "SINGLE" | "BULK"; +``` + +components.schemas: +```diff ++ readonly ErrorResponse405: { ++ readonly status?: string; ++ readonly title?: string; ++ readonly error?: string; ++ }; +``` + +operations.createPromotionCode.responses: +```diff +- readonly 200: components["responses"]["PromotionCodeResponse"]; ++ readonly 201: components["responses"]["PromotionCodeResponse"]; +``` + +operations.generatePromotionCodesBatch.responses: +```diff ++ readonly 405: { ++ headers: { ++ readonly [name: string]: unknown; ++ }; ++ content: { ++ readonly "application/json": components["schemas"]["ErrorResponse405"]; ++ }; ++ }; +``` + +### `store_logs.v3.ts` + +operations.getStoreSystemLogs.parameters.query: +```diff ++ readonly sort?: "date_created" | "type"; ++ readonly direction?: "asc" | "desc"; +``` + +### `storefront_tokens.v3.ts` + +components.schemas: +```diff +- } & (components["schemas"]["Channels"] | components["schemas"]["Channel"]); ++ } & components["schemas"]["Channels"] & components["schemas"]["Channel"]; +``` + +components.schemas.Channel: +```diff +- readonly channel_id: number; ++ readonly channel_id?: number; +``` + +components.schemas.Channels: +```diff +- readonly channel_ids: readonly number[]; ++ readonly channel_ids?: readonly number[]; +``` + diff --git a/package.json b/package.json index da241c4..c67c92d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@aligent/bigcommerce-api", - "version": "1.1.1", + "version": "1.1.2", "type": "module", "scripts": { "test": "tsd", diff --git a/src/internal/reference/generated/abandoned_carts.v3.ts b/src/internal/reference/generated/abandoned_carts.v3.ts index 5bb39c9..9362451 100644 --- a/src/internal/reference/generated/abandoned_carts.v3.ts +++ b/src/internal/reference/generated/abandoned_carts.v3.ts @@ -51,9 +51,11 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description Unique cart `UUID`. + /** + * @description Unique cart `UUID`. * - * Unique cart `UUID` token that is generated for abandoned cart emails. */ + * Unique cart `UUID` token that is generated for abandoned cart emails. + */ readonly token: string; }; readonly cookie?: never; @@ -83,11 +85,9 @@ export interface components { /** * Format: int32 * @description The HTTP status code - * */ readonly status?: number; - /** @description The error title describing the particular error - * */ + /** @description The error title describing the particular error */ readonly title?: string; readonly type?: string; }; @@ -202,8 +202,10 @@ export interface components { readonly "application/json": components["schemas"]["errorDetailed_Full"]; }; }; - /** @description Malformed request syntax. Typically need to fix the JSON - * Body to resend successfully. */ + /** + * @description Malformed request syntax. Typically need to fix the JSON + * Body to resend successfully. + */ readonly "400_BadRequest": { headers: { readonly [name: string]: unknown; @@ -433,9 +435,11 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description Unique cart `UUID`. + /** + * @description Unique cart `UUID`. * - * Unique cart `UUID` token that is generated for abandoned cart emails. */ + * Unique cart `UUID` token that is generated for abandoned cart emails. + */ readonly token: string; }; readonly cookie?: never; diff --git a/src/internal/reference/generated/carts.sf.ts b/src/internal/reference/generated/carts.sf.ts index fa7baf0..388e59e 100644 --- a/src/internal/reference/generated/carts.sf.ts +++ b/src/internal/reference/generated/carts.sf.ts @@ -7,13 +7,15 @@ export interface paths { readonly "/carts": { readonly parameters: { readonly query?: { - /** @description To return product options add one of the following include: + /** + * @description To return product options add one of the following include: * * `lineItems.physicalItems.options`: The Cart returns an abbreviated result. Use this to return physical items product options. Can also be used in a /POST to have the extended Cart object return. * * `lineItems.digitalItems.options`: The Cart returns an abbreviated result. Use this to return digital items product options. Can also be used in a /POST to have the extended Cart object return. * - * `lineItems.digitalItems.options,lineItems.physicalItems.options`: The Cart returns an abbreviated result. Use this to return digital and physical options. Can also be used in a /POST to have the extended Cart object return. */ + * `lineItems.digitalItems.options,lineItems.physicalItems.options`: The Cart returns an abbreviated result. Use this to return digital and physical options. Can also be used in a /POST to have the extended Cart object return. + */ readonly include?: components["parameters"]["Include"]; }; readonly header: { @@ -69,13 +71,15 @@ export interface paths { readonly "/carts/{cartId}/items": { readonly parameters: { readonly query?: { - /** @description To return product options add one of the following include: + /** + * @description To return product options add one of the following include: * * `lineItems.physicalItems.options`: The Cart returns an abbreviated result. Use this to return physical items product options. Can also be used in a /POST to have the extended Cart object return. * * `lineItems.digitalItems.options`: The Cart returns an abbreviated result. Use this to return digital items product options. Can also be used in a /POST to have the extended Cart object return. * - * `lineItems.digitalItems.options,lineItems.physicalItems.options`: The Cart returns an abbreviated result. Use this to return digital and physical options. Can also be used in a /POST to have the extended Cart object return. */ + * `lineItems.digitalItems.options,lineItems.physicalItems.options`: The Cart returns an abbreviated result. Use this to return digital and physical options. Can also be used in a /POST to have the extended Cart object return. + */ readonly include?: components["parameters"]["Include"]; }; readonly header: { @@ -104,13 +108,15 @@ export interface paths { readonly "/carts/{cartId}/items/{itemId}": { readonly parameters: { readonly query?: { - /** @description To return product options add one of the following include: + /** + * @description To return product options add one of the following include: * * `lineItems.physicalItems.options`: The Cart returns an abbreviated result. Use this to return physical items product options. Can also be used in a /POST to have the extended Cart object return. * * `lineItems.digitalItems.options`: The Cart returns an abbreviated result. Use this to return digital items product options. Can also be used in a /POST to have the extended Cart object return. * - * `lineItems.digitalItems.options,lineItems.physicalItems.options`: The Cart returns an abbreviated result. Use this to return digital and physical options. Can also be used in a /POST to have the extended Cart object return. */ + * `lineItems.digitalItems.options,lineItems.physicalItems.options`: The Cart returns an abbreviated result. Use this to return digital and physical options. Can also be used in a /POST to have the extended Cart object return. + */ readonly include?: components["parameters"]["Include"]; }; readonly header: { @@ -186,14 +192,16 @@ export interface components { readonly responseCartCoupons: readonly { /** @description The coupon code. */ readonly code: string; - /** @description |Type `int`|Type Name| + /** + * @description |Type `int`|Type Name| * |-|-| * |`0`|`per_item_discount`| * |`1`|`percentage_discount`| * |`2`|`per_total_discount`| * |`3`|`shipping_discount`| * |`4`|`free_shipping`| - * |`5`|`promotion`| */ + * |`5`|`promotion`| + */ readonly couponType?: number; /** * Format: float @@ -313,10 +321,12 @@ export interface components { * @example true */ readonly wrapTogether: boolean; - /** @description Details for the gift wrapping option selected. This can be specified for each line item or together based on wrapTogether value. + /** + * @description Details for the gift wrapping option selected. This can be specified for each line item or together based on wrapTogether value. * If wrapTogether is false, each element in the wrapDetails array determines each item's specific wrapping. * (e.g if this line item has 6 quantity, you can pass at maximum 6 elements for the array to spefified each one's wrapping) - * If wrapTogether is true, we will only use 1st element in the wrapDetails array to determine what to be wrapped */ + * If wrapTogether is true, we will only use 1st element in the wrapDetails array to determine what to be wrapped + */ readonly wrapDetails: readonly { /** * @description Identifier of the gift wrapping option selected. @@ -786,11 +796,13 @@ export interface components { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 409, * "title": "The request cannot be processed due to a possible conflict. Please review the changes and try again.", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -808,13 +820,15 @@ export interface components { readonly CartIdPath: string; /** @description The ID of the subject item. */ readonly ItemIdPath: string; - /** @description To return product options add one of the following include: + /** + * @description To return product options add one of the following include: * * `lineItems.physicalItems.options`: The Cart returns an abbreviated result. Use this to return physical items product options. Can also be used in a /POST to have the extended Cart object return. * * `lineItems.digitalItems.options`: The Cart returns an abbreviated result. Use this to return digital items product options. Can also be used in a /POST to have the extended Cart object return. * - * `lineItems.digitalItems.options,lineItems.physicalItems.options`: The Cart returns an abbreviated result. Use this to return digital and physical options. Can also be used in a /POST to have the extended Cart object return. */ + * `lineItems.digitalItems.options,lineItems.physicalItems.options`: The Cart returns an abbreviated result. Use this to return digital and physical options. Can also be used in a /POST to have the extended Cart object return. + */ readonly Include: readonly ("lineItems.physicalItems.options" | "lineItems.digitalItems.options")[]; }; requestBodies: never; @@ -826,13 +840,15 @@ export interface operations { readonly getCart: { readonly parameters: { readonly query?: { - /** @description To return product options add one of the following include: + /** + * @description To return product options add one of the following include: * * `lineItems.physicalItems.options`: The Cart returns an abbreviated result. Use this to return physical items product options. Can also be used in a /POST to have the extended Cart object return. * * `lineItems.digitalItems.options`: The Cart returns an abbreviated result. Use this to return digital items product options. Can also be used in a /POST to have the extended Cart object return. * - * `lineItems.digitalItems.options,lineItems.physicalItems.options`: The Cart returns an abbreviated result. Use this to return digital and physical options. Can also be used in a /POST to have the extended Cart object return. */ + * `lineItems.digitalItems.options,lineItems.physicalItems.options`: The Cart returns an abbreviated result. Use this to return digital and physical options. Can also be used in a /POST to have the extended Cart object return. + */ readonly include?: components["parameters"]["Include"]; }; readonly header?: { @@ -850,13 +866,15 @@ export interface operations { readonly createCart: { readonly parameters: { readonly query?: { - /** @description To return product options add one of the following include: + /** + * @description To return product options add one of the following include: * * `lineItems.physicalItems.options`: The Cart returns an abbreviated result. Use this to return physical items product options. Can also be used in a /POST to have the extended Cart object return. * * `lineItems.digitalItems.options`: The Cart returns an abbreviated result. Use this to return digital items product options. Can also be used in a /POST to have the extended Cart object return. * - * `lineItems.digitalItems.options,lineItems.physicalItems.options`: The Cart returns an abbreviated result. Use this to return digital and physical options. Can also be used in a /POST to have the extended Cart object return. */ + * `lineItems.digitalItems.options,lineItems.physicalItems.options`: The Cart returns an abbreviated result. Use this to return digital and physical options. Can also be used in a /POST to have the extended Cart object return. + */ readonly include?: components["parameters"]["Include"]; }; readonly header?: { @@ -904,13 +922,15 @@ export interface operations { readonly addCartLineItem: { readonly parameters: { readonly query?: { - /** @description To return product options add one of the following include: + /** + * @description To return product options add one of the following include: * * `lineItems.physicalItems.options`: The Cart returns an abbreviated result. Use this to return physical items product options. Can also be used in a /POST to have the extended Cart object return. * * `lineItems.digitalItems.options`: The Cart returns an abbreviated result. Use this to return digital items product options. Can also be used in a /POST to have the extended Cart object return. * - * `lineItems.digitalItems.options,lineItems.physicalItems.options`: The Cart returns an abbreviated result. Use this to return digital and physical options. Can also be used in a /POST to have the extended Cart object return. */ + * `lineItems.digitalItems.options,lineItems.physicalItems.options`: The Cart returns an abbreviated result. Use this to return digital and physical options. Can also be used in a /POST to have the extended Cart object return. + */ readonly include?: components["parameters"]["Include"]; }; readonly header?: { @@ -938,13 +958,15 @@ export interface operations { readonly updateCartLineItem: { readonly parameters: { readonly query?: { - /** @description To return product options add one of the following include: + /** + * @description To return product options add one of the following include: * * `lineItems.physicalItems.options`: The Cart returns an abbreviated result. Use this to return physical items product options. Can also be used in a /POST to have the extended Cart object return. * * `lineItems.digitalItems.options`: The Cart returns an abbreviated result. Use this to return digital items product options. Can also be used in a /POST to have the extended Cart object return. * - * `lineItems.digitalItems.options,lineItems.physicalItems.options`: The Cart returns an abbreviated result. Use this to return digital and physical options. Can also be used in a /POST to have the extended Cart object return. */ + * `lineItems.digitalItems.options,lineItems.physicalItems.options`: The Cart returns an abbreviated result. Use this to return digital and physical options. Can also be used in a /POST to have the extended Cart object return. + */ readonly include?: components["parameters"]["Include"]; }; readonly header?: { @@ -974,13 +996,15 @@ export interface operations { readonly deleteCartLineItem: { readonly parameters: { readonly query?: { - /** @description To return product options add one of the following include: + /** + * @description To return product options add one of the following include: * * `lineItems.physicalItems.options`: The Cart returns an abbreviated result. Use this to return physical items product options. Can also be used in a /POST to have the extended Cart object return. * * `lineItems.digitalItems.options`: The Cart returns an abbreviated result. Use this to return digital items product options. Can also be used in a /POST to have the extended Cart object return. * - * `lineItems.digitalItems.options,lineItems.physicalItems.options`: The Cart returns an abbreviated result. Use this to return digital and physical options. Can also be used in a /POST to have the extended Cart object return. */ + * `lineItems.digitalItems.options,lineItems.physicalItems.options`: The Cart returns an abbreviated result. Use this to return digital and physical options. Can also be used in a /POST to have the extended Cart object return. + */ readonly include?: components["parameters"]["Include"]; }; readonly header?: { @@ -1008,13 +1032,15 @@ export interface operations { readonly updateCartCurrency: { readonly parameters: { readonly query?: { - /** @description To return product options add one of the following include: + /** + * @description To return product options add one of the following include: * * `lineItems.physicalItems.options`: The Cart returns an abbreviated result. Use this to return physical items product options. Can also be used in a /POST to have the extended Cart object return. * * `lineItems.digitalItems.options`: The Cart returns an abbreviated result. Use this to return digital items product options. Can also be used in a /POST to have the extended Cart object return. * - * `lineItems.digitalItems.options,lineItems.physicalItems.options`: The Cart returns an abbreviated result. Use this to return digital and physical options. Can also be used in a /POST to have the extended Cart object return. */ + * `lineItems.digitalItems.options,lineItems.physicalItems.options`: The Cart returns an abbreviated result. Use this to return digital and physical options. Can also be used in a /POST to have the extended Cart object return. + */ readonly include?: components["parameters"]["Include"]; }; readonly header?: { diff --git a/src/internal/reference/generated/carts.v3.ts b/src/internal/reference/generated/carts.v3.ts index 5ac923c..287b52f 100644 --- a/src/internal/reference/generated/carts.v3.ts +++ b/src/internal/reference/generated/carts.v3.ts @@ -225,14 +225,16 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The channel ID of the settings overrides. + /** + * @description The channel ID of the settings overrides. * * ### OAuth scopes * * | UI Name | Permission | Parameter | * |:--------|:-----------|:----------| * |Information & Settings | modify | `store_v2_information`| - * |Information & Settings | read-only| `store_v2_information`| */ + * |Information & Settings | read-only| `store_v2_information`| + */ readonly channel_id: number; }; readonly cookie?: never; @@ -285,7 +287,6 @@ export interface paths { * @description Create a cart `Metafield`. * * If you create an order from a Cart, you can continue referencing the Cart Metafields even if you delete the original Cart. Use the `cart_id` field on the Order to construct the Cart Metafield endpoint. - * */ readonly post: operations["createCartMetafield"]; }; @@ -312,13 +313,11 @@ export interface paths { /** * Update a Cart Metafield * @description Update a `Metafield`, by `cart_id`. - * */ readonly put: operations["updateCartMetafield"]; /** * Delete a Metafield * @description Deletes a `Metafield`. - * */ readonly delete: operations["deleteCartMetafield"]; }; @@ -908,7 +907,6 @@ export interface components { * - type 2: per_total_discount * - type 3: shipping_discount * - type 4: free_shipping - * * @example 3 * @enum {integer} */ @@ -1183,7 +1181,8 @@ export interface components { * @example Percentage off */ readonly name?: string; - /** @description The discount type. + /** + * @description The discount type. * * - type 0: per_item_discount * - type 1: percentage_discount @@ -1195,7 +1194,8 @@ export interface components { * - 1 * - 2 * - 3 - * - 4 */ + * - 4 + */ readonly discountType?: number; /** * @description The amount of the discount based on the coupon. For example, 3 percent off will show a 3. @@ -1504,6 +1504,11 @@ export interface components { readonly name?: string; readonly quantity?: number; readonly list_price?: number; + /** + * Format: uri + * @description Image of the product or variant. + */ + readonly image_url?: string; }[]; /** @description Represents all settings related to the shopping cart functionality of a store. */ readonly CartSettings: { @@ -1692,21 +1697,18 @@ export interface components { * @description Error payload for the BigCommerce API. */ readonly NotFound: { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetafieldResponse: { readonly data?: components["schemas"]["Metafield"]; }; - /** @description Allows app partners to write custom data to various resources in the API. - * */ + /** @description Allows app partners to write custom data to various resources in the API. */ readonly Metafield: components["schemas"]["MetafieldBase"] & { /** @description The unique identifier for the metafield. */ readonly id?: string; @@ -1728,8 +1730,7 @@ export interface components { */ readonly owner_client_id?: string; }; - /** @description Common Metafield properties. - * */ + /** @description Common Metafield properties. */ readonly MetafieldBase: { /** * @description Determines the visibility and writeability of the field by other API consumers. @@ -1741,50 +1742,42 @@ export interface components { * | `write` | Open for reading and writing by other API consumers. | * | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | * | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | - * * @enum {string} */ readonly permission_set?: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; /** * @description Namespace for the metafield, for organizational purposes. - * * @example Sales Department */ readonly namespace?: string; /** * @description The name of the field, for example: `location_id`, `color`. - * * @example Staff Name */ readonly key?: string; /** * @description The value of the field, for example: `1`, `blue`. - * * @example Ronaldo */ readonly value?: string; /** * @description Description for the metafields. - * * @example order */ readonly description?: string; /** * @description The type of resource with which the metafield is associated. - * * @example cart * @enum {string} */ readonly resource_type?: "brand" | "product" | "variant" | "category" | "cart"; /** * @description The unique identifier for the resource with which the metafield is associated. - * * @example 0 */ readonly resource_id?: string; }; - /** @description Common Metafield properties. - * */ + /** @description Common Metafield properties. */ readonly MetafieldBase_Post: { /** * @description Determines the visibility and writeability of the field by other API consumers. @@ -1796,49 +1789,41 @@ export interface components { * | `write` | Open for reading and writing by other API consumers. | * | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | * | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | - * * @enum {string} */ readonly permission_set: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; /** * @description Namespace for the metafield, for organizational purposes. - * * @example Sales Department */ readonly namespace: string; /** * @description The name of the field, for example: `location_id`, `color`. - * * @example Staff Name */ readonly key: string; /** * @description The value of the field, for example: `1`, `blue`. - * * @example Ronaldo */ readonly value: string; /** * @description Description for the metafields. - * * @example Name of Staff Member */ readonly description?: string; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponse: { readonly data?: components["schemas"]["Metafield"]; readonly meta?: components["schemas"]["metaCollection_open"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponse_Batch: { readonly data?: readonly components["schemas"]["Metafield"][]; readonly meta?: components["schemas"]["CollectionMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponse_Batch_POST_PUT: { readonly data?: readonly components["schemas"]["Metafield"][]; /** @@ -1848,14 +1833,15 @@ export interface components { readonly errors?: readonly unknown[]; readonly meta?: components["schemas"]["WriteCollectionPartialSuccessMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionDeleteResponseSuccess: { - /** @example [ + /** + * @example [ * 123, * 124, * 125 - * ] */ + * ] + */ readonly data?: readonly number[]; /** * @description Empty for 200 responses. @@ -1864,41 +1850,37 @@ export interface components { readonly errors?: readonly unknown[]; readonly meta?: components["schemas"]["WriteCollectionSuccessMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponsePartialSuccess_POST_PUT: { readonly data?: readonly components["schemas"]["Metafield"][]; readonly errors?: readonly components["schemas"]["Error"][]; readonly meta?: components["schemas"]["WriteCollectionPartialSuccessMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponsePartialSuccess_DELETE: { - /** @example [ + /** + * @example [ * 123 - * ] */ + * ] + */ readonly data?: readonly number[]; readonly errors?: readonly components["schemas"]["Error"][]; readonly meta?: components["schemas"]["WriteCollectionPartialSuccessMeta"]; }; - /** @description Error response payload for the BigCommerce API. - * */ + /** @description Error response payload for the BigCommerce API. */ readonly Error: { /** * @description The HTTP status code for the error. - * * @example 422 */ readonly status?: number; /** * @description The error title. - * * @example Bulk operation has failed */ readonly title?: string; /** * @description The error type. - * * @example https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes */ readonly type?: string; @@ -1906,7 +1888,6 @@ export interface components { }; /** * @description Error detail response payload for the BigCommerce API. - * * @example { * "1": "Unauthorized to delete", * "2": "Metafield does not exist" @@ -1922,19 +1903,16 @@ export interface components { readonly WriteCollectionSuccessMeta: { /** * @description Total number of items in the result set. - * * @example 3 */ readonly total?: number; /** * @description Total number of items that were successfully deleted. - * * @example 3 */ readonly success?: number; /** * @description Total number of items that failed to be deleted. - * * @example 0 */ readonly failed?: number; @@ -1946,19 +1924,16 @@ export interface components { readonly WriteCollectionPartialSuccessMeta: { /** * @description Total number of items in the result set. - * * @example 3 */ readonly total?: number; /** * @description Total number of items that were successfully deleted. - * * @example 1 */ readonly success?: number; /** * @description Total number of items that failed to be deleted. - * * @example 2 */ readonly failed?: number; @@ -1975,48 +1950,39 @@ export interface components { readonly pagination?: { /** * @description Total number of items in the result set. - * * @example 36 */ readonly total?: number; /** * @description Total number of items in the collection response. - * * @example 36 */ readonly count?: number; /** * @description The amount of items returned in the collection per page, controlled by the limit parameter. - * * @example 50 */ readonly per_page?: number; /** * @description The page you are currently on within the collection. - * * @example 1 */ readonly current_page?: number; /** * @description The total number of pages in the collection. - * * @example 1 */ readonly total_pages?: number; - /** @description Pagination links for the previous and next parts of the whole collection. - * */ + /** @description Pagination links for the previous and next parts of the whole collection. */ readonly links?: { - /** @description Link to the previous page returned in the response. - * */ + /** @description Link to the previous page returned in the response. */ readonly previous?: string; /** * @description Link to the current page returned in the response. - * * @example ?page=1&limit=50 */ readonly current?: string; - /** @description Link to the next page returned in the response. - * */ + /** @description Link to the next page returned in the response. */ readonly next?: string; }; }; @@ -2047,11 +2013,13 @@ export interface components { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 409, * "title": "The request cannot be processed due to a possible conflict. Please review the changes and try again.", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes" - * } */ + * } + */ readonly "application/json": components["schemas"]["ErrorResponse"]; }; }; @@ -2091,16 +2059,16 @@ export interface components { readonly cartId: string; /** @description The ID of the `Cart` to which the transactions belong. */ readonly cart_id: string; - /** @description * `redirect_urls`: Create a direct link to a cart. This can be used for the /POST request for carts. + /** + * @description * `redirect_urls`: Create a direct link to a cart. This can be used for the /POST request for carts. * * `line_items.physical_items.options`: The cart returns an abbreviated result. Use this to return physical items product options. To return the extended cart object, use in a /POST request. * * `line_items.digital_items.options`: The cart returns an abbreviated result. Use this to return digital items product options. To return the extended cart object, use in a /POST request. - * * `promotions.banners`: Returns a list of eligible banners. */ + * * `promotions.banners`: Returns a list of eligible banners. + */ readonly line_items: readonly ("redirect_urls" | "line_items.physical_items.options" | "line_items.digital_items.options")[]; - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly PageParam: number; - /** @description The ID of the `Metafield`. - * */ + /** @description The ID of the `Metafield`. */ readonly MetafieldIdParam: number; /** @description Filter based on a metafieldʼs key. */ readonly MetafieldKeyParam: string; @@ -2110,23 +2078,17 @@ export interface components { readonly MetafieldNamespaceParam: string; /** @description Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter */ readonly MetafieldNamespaceInParam: readonly string[]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly LimitParam: number; - /** @description 'Query parameter that lets you filter by the minimum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.' - * */ + /** @description 'Query parameter that lets you filter by the minimum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.' */ readonly date_created_min: string; - /** @description 'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.' - * */ + /** @description 'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.' */ readonly date_created_max: string; - /** @description 'Query parameter that lets you filter by the maximum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.' - * */ + /** @description 'Query parameter that lets you filter by the maximum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.' */ readonly date_modified_max: string; - /** @description 'Query parameter that lets you filter by the minimum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.' - * */ + /** @description 'Query parameter that lets you filter by the minimum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.' */ readonly date_modified_min: string; - /** @description Sort direction. Acceptable values are: `asc`, `desc`. - * */ + /** @description Sort direction. Acceptable values are: `asc`, `desc`. */ readonly DirectionParam: "asc" | "desc"; /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */ readonly IncludeFieldsParamMetafields: readonly ("resource_id" | "key" | "value" | "namespace" | "permission_set" | "resource_type" | "description" | "owner_client_id" | "date_created" | "date_modified")[]; @@ -2140,10 +2102,12 @@ export interface operations { readonly createCart: { readonly parameters: { readonly query?: { - /** @description * `redirect_urls`: Create a direct link to a cart. This can be used for the /POST request for carts. + /** + * @description * `redirect_urls`: Create a direct link to a cart. This can be used for the /POST request for carts. * * `line_items.physical_items.options`: The cart returns an abbreviated result. Use this to return physical items product options. To return the extended cart object, use in a /POST request. * * `line_items.digital_items.options`: The cart returns an abbreviated result. Use this to return digital items product options. To return the extended cart object, use in a /POST request. - * * `promotions.banners`: Returns a list of eligible banners. */ + * * `promotions.banners`: Returns a list of eligible banners. + */ readonly include?: readonly ("redirect_urls" | "line_items.physical_items.options" | "line_items.digital_items.options" | "promotions.banners")[]; }; readonly header?: { @@ -2154,13 +2118,15 @@ export interface operations { readonly path?: never; readonly cookie?: never; }; - /** @description **Examples:** + /** + * @description **Examples:** * * 1. Creating a cart by adding a simple product (a product without option selections). * 2. Creating a cart with a variant. This works when a product can be specified purely by a variant, without any other required options. * 3. Creating a cart using a date option. The API supports timestamps, “option_value”: 1743570000, and dates as an object literal, “option_value”: {“day”:”01”, “month”:”02”, “year”:”2020”}. * 4. Creating a cart with a variant, a checkbox, and a picklist modifier added. - * 5. Creating a cart using a custom item. */ + * 5. Creating a cart using a custom item. + */ readonly requestBody: { readonly content: { readonly "application/json": components["schemas"]["CartCreatePostData"]; @@ -2173,10 +2139,12 @@ export interface operations { readonly addCartLineItems: { readonly parameters: { readonly query?: { - /** @description * `redirect_urls`: Create a direct link to a cart. This can be used for the /POST request for carts. + /** + * @description * `redirect_urls`: Create a direct link to a cart. This can be used for the /POST request for carts. * * `line_items.physical_items.options`: The cart returns an abbreviated result. Use this to return physical items product options. To return the extended cart object, use in a /POST request. * * `line_items.digital_items.options`: The cart returns an abbreviated result. Use this to return digital items product options. To return the extended cart object, use in a /POST request. - * * `promotions.banners`: Returns a list of eligible banners. */ + * * `promotions.banners`: Returns a list of eligible banners. + */ readonly include?: readonly ("redirect_urls" | "line_items.physical_items.options" | "line_items.digital_items.options" | "promotions.banners")[]; }; readonly header?: { @@ -2215,12 +2183,14 @@ export interface operations { }; readonly requestBody?: { readonly content: { - /** @example { + /** + * @example { * "query_params": { * "key_1": "value_1", * "key_2": "value_2" * } - * } */ + * } + */ readonly "application/json": components["schemas"]["Redirect_urls_Post"]; }; }; @@ -2231,10 +2201,12 @@ export interface operations { readonly updateCartLineItem: { readonly parameters: { readonly query?: { - /** @description * `redirect_urls`: Create a direct link to a cart. This can be used for the /POST request for carts. + /** + * @description * `redirect_urls`: Create a direct link to a cart. This can be used for the /POST request for carts. * * `line_items.physical_items.options`: The cart returns an abbreviated result. Use this to return physical items product options. To return the extended cart object, use in a /POST request. * * `line_items.digital_items.options`: The cart returns an abbreviated result. Use this to return digital items product options. To return the extended cart object, use in a /POST request. - * * `promotions.banners`: Returns a list of eligible banners. */ + * * `promotions.banners`: Returns a list of eligible banners. + */ readonly include?: readonly ("redirect_urls" | "line_items.physical_items.options" | "line_items.digital_items.options" | "promotions.banners")[]; }; readonly header?: { @@ -2262,10 +2234,12 @@ export interface operations { readonly deleteCartLineItem: { readonly parameters: { readonly query?: { - /** @description * `redirect_urls`: Create a direct link to a cart. This can be used for the /POST request for carts. + /** + * @description * `redirect_urls`: Create a direct link to a cart. This can be used for the /POST request for carts. * * `line_items.physical_items.options`: The cart returns an abbreviated result. Use this to return physical items product options. To return the extended cart object, use in a /POST request. * * `line_items.digital_items.options`: The cart returns an abbreviated result. Use this to return digital items product options. To return the extended cart object, use in a /POST request. - * * `promotions.banners`: Returns a list of eligible banners. */ + * * `promotions.banners`: Returns a list of eligible banners. + */ readonly include?: readonly ("redirect_urls" | "line_items.physical_items.options" | "line_items.digital_items.options" | "promotions.banners")[]; }; readonly header?: { @@ -2307,10 +2281,12 @@ export interface operations { readonly getCart: { readonly parameters: { readonly query?: { - /** @description * `redirect_urls`: Create a direct link to a cart. This can be used for the /POST request for carts. + /** + * @description * `redirect_urls`: Create a direct link to a cart. This can be used for the /POST request for carts. * * `line_items.physical_items.options`: The cart returns an abbreviated result. Use this to return physical items product options. To return the extended cart object, use in a /POST request. * * `line_items.digital_items.options`: The cart returns an abbreviated result. Use this to return digital items product options. To return the extended cart object, use in a /POST request. - * * `promotions.banners`: Returns a list of eligible banners. */ + * * `promotions.banners`: Returns a list of eligible banners. + */ readonly include?: readonly ("redirect_urls" | "line_items.physical_items.options" | "line_items.digital_items.options" | "promotions.banners")[]; }; readonly header?: { @@ -2338,10 +2314,12 @@ export interface operations { readonly updateCart: { readonly parameters: { readonly query?: { - /** @description * `redirect_urls`: Create a direct link to a cart. This can be used for the /POST request for carts. + /** + * @description * `redirect_urls`: Create a direct link to a cart. This can be used for the /POST request for carts. * * `line_items.physical_items.options`: The cart returns an abbreviated result. Use this to return physical items product options. To return the extended cart object, use in a /POST request. * * `line_items.digital_items.options`: The cart returns an abbreviated result. Use this to return digital items product options. To return the extended cart object, use in a /POST request. - * * `promotions.banners`: Returns a list of eligible banners. */ + * * `promotions.banners`: Returns a list of eligible banners. + */ readonly include?: readonly ("redirect_urls" | "line_items.physical_items.options" | "line_items.digital_items.options" | "promotions.banners")[]; }; readonly header?: { @@ -2357,10 +2335,12 @@ export interface operations { }; readonly requestBody: { readonly content: { - /** @example { + /** + * @example { * "customer_id": 5, * "version": 1 - * } */ + * } + */ readonly "application/json": components["schemas"]["CartUpdatePutRequestData"]; }; }; @@ -2456,12 +2436,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2498,14 +2480,16 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The channel ID of the settings overrides. + /** + * @description The channel ID of the settings overrides. * * ### OAuth scopes * * | UI Name | Permission | Parameter | * |:--------|:-----------|:----------| * |Information & Settings | modify | `store_v2_information`| - * |Information & Settings | read-only| `store_v2_information`| */ + * |Information & Settings | read-only| `store_v2_information`| + */ readonly channel_id: number; }; readonly cookie?: never; @@ -2541,14 +2525,16 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The channel ID of the settings overrides. + /** + * @description The channel ID of the settings overrides. * * ### OAuth scopes * * | UI Name | Permission | Parameter | * |:--------|:-----------|:----------| * |Information & Settings | modify | `store_v2_information`| - * |Information & Settings | read-only| `store_v2_information`| */ + * |Information & Settings | read-only| `store_v2_information`| + */ readonly channel_id: number; }; readonly cookie?: never; @@ -2574,12 +2560,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2611,18 +2599,15 @@ export interface operations { readonly getCartMetafields: { readonly parameters: { readonly query?: { - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; /** @description Filter based on a metafieldʼs key. */ readonly key?: components["parameters"]["MetafieldKeyParam"]; /** @description Filter based on a metafieldʼs namespaces. */ readonly namespace?: components["parameters"]["MetafieldNamespaceParam"]; - /** @description Sort direction. Acceptable values are: `asc`, `desc`. - * */ + /** @description Sort direction. Acceptable values are: `asc`, `desc`. */ readonly direction?: components["parameters"]["DirectionParam"]; }; readonly header?: { @@ -2637,8 +2622,7 @@ export interface operations { }; readonly requestBody?: never; readonly responses: { - /** @description An array of metafields and metadata. - * */ + /** @description An array of metafields and metadata. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -2665,25 +2649,27 @@ export interface operations { }; readonly requestBody: { readonly content: { - /** @example { + /** + * @example { * "permission_set": "app_only", * "namespace": "Sales Department", * "key": "Staff Name", * "value": "Sam", * "description": "Name of staff member" - * } */ + * } + */ readonly "application/json": components["schemas"]["MetafieldBase_Post"]; }; }; readonly responses: { - /** @description A `Metafield` object. - * */ + /** @description A `Metafield` object. */ readonly 200: { headers: { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": "24", * "key": "Staff Name", @@ -2697,7 +2683,8 @@ export interface operations { * "date_modified": "2023-11-15T15:16:35+00:00" * }, * "meta": {} - * } */ + * } + */ readonly "application/json": components["schemas"]["MetaFieldCollectionResponse"]; }; }; @@ -2707,12 +2694,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2721,8 +2710,7 @@ export interface operations { }; }; }; - /** @description The `Metafield` conflicts with another `Metafield`. This can result from duplicate unique key combinations of the appʼs client id, namespace, key, resource_type, and resource_id. - * */ + /** @description The `Metafield` conflicts with another `Metafield`. This can result from duplicate unique key combinations of the appʼs client id, namespace, key, resource_type, and resource_id. */ readonly 409: { headers: { readonly [name: string]: unknown; @@ -2745,18 +2733,15 @@ export interface operations { readonly getCartMetafield: { readonly parameters: { readonly query?: { - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; /** @description Filter based on a metafieldʼs key. */ readonly key?: components["parameters"]["MetafieldKeyParam"]; /** @description Filter based on a metafieldʼs namespaces. */ readonly namespace?: components["parameters"]["MetafieldNamespaceParam"]; - /** @description Sort direction. Acceptable values are: `asc`, `desc`. - * */ + /** @description Sort direction. Acceptable values are: `asc`, `desc`. */ readonly direction?: components["parameters"]["DirectionParam"]; }; readonly header?: { @@ -2773,8 +2758,7 @@ export interface operations { }; readonly requestBody?: never; readonly responses: { - /** @description A `Metafield` object. - * */ + /** @description A `Metafield` object. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -2783,8 +2767,7 @@ export interface operations { readonly "application/json": components["schemas"]["MetafieldResponse"]; }; }; - /** @description Not found (A metafield was not found with this query). - * */ + /** @description Not found (A metafield was not found with this query). */ readonly 404: { headers: { readonly [name: string]: unknown; @@ -2811,16 +2794,14 @@ export interface operations { }; readonly cookie?: never; }; - /** @description A `Metafield` object. - * */ + /** @description A `Metafield` object. */ readonly requestBody: { readonly content: { readonly "application/json": components["schemas"]["MetafieldBase_Post"]; }; }; readonly responses: { - /** @description A `Metafield` and metadata. - * */ + /** @description A `Metafield` and metadata. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -2835,12 +2816,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2849,8 +2832,7 @@ export interface operations { }; }; }; - /** @description Response object for metafields creation with partial success. - * */ + /** @description Response object for metafields creation with partial success. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -2878,16 +2860,14 @@ export interface operations { }; readonly requestBody?: never; readonly responses: { - /** @description An empty response. - * */ + /** @description An empty response. */ readonly 204: { headers: { readonly [name: string]: unknown; }; content?: never; }; - /** @description Not found (A metafield was not found with this query) - * */ + /** @description Not found (A metafield was not found with this query) */ readonly 404: { headers: { readonly [name: string]: unknown; @@ -2901,11 +2881,9 @@ export interface operations { readonly getCartsMetafields: { readonly parameters: { readonly query?: { - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; /** @description Filter based on a metafieldʼs key. */ readonly key?: components["parameters"]["MetafieldKeyParam"]; @@ -2915,22 +2893,17 @@ export interface operations { readonly namespace?: components["parameters"]["MetafieldNamespaceParam"]; /** @description Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter */ readonly "namespace:in"?: components["parameters"]["MetafieldNamespaceInParam"]; - /** @description Sort direction. Acceptable values are: `asc`, `desc`. - * */ + /** @description Sort direction. Acceptable values are: `asc`, `desc`. */ readonly direction?: components["parameters"]["DirectionParam"]; /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */ readonly include_fields?: components["parameters"]["IncludeFieldsParamMetafields"]; - /** @description 'Query parameter that lets you filter by the minimum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.' - * */ + /** @description 'Query parameter that lets you filter by the minimum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.' */ readonly "date_modified:min"?: components["parameters"]["date_modified_min"]; - /** @description 'Query parameter that lets you filter by the maximum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.' - * */ + /** @description 'Query parameter that lets you filter by the maximum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.' */ readonly "date_modified:max"?: components["parameters"]["date_modified_max"]; - /** @description 'Query parameter that lets you filter by the minimum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.' - * */ + /** @description 'Query parameter that lets you filter by the minimum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.' */ readonly "date_created:min"?: components["parameters"]["date_created_min"]; - /** @description 'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.' - * */ + /** @description 'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.' */ readonly "date_created:max"?: components["parameters"]["date_created_max"]; }; readonly header?: never; @@ -2939,8 +2912,7 @@ export interface operations { }; readonly requestBody?: never; readonly responses: { - /** @description List of `Metafield` objects. - * */ + /** @description List of `Metafield` objects. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -2963,7 +2935,6 @@ export interface operations { readonly "application/json": readonly (components["schemas"]["MetafieldBase_Post"] & { /** * @description The ID of metafield to update. - * * @example 42 */ readonly id: string; @@ -2971,8 +2942,7 @@ export interface operations { }; }; readonly responses: { - /** @description List of updated `Metafield` objects. - * */ + /** @description List of updated `Metafield` objects. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -2987,12 +2957,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -3001,8 +2973,7 @@ export interface operations { }; }; }; - /** @description Response object for metafields creation with partial success. - * */ + /** @description Response object for metafields creation with partial success. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -3025,7 +2996,6 @@ export interface operations { readonly "application/json": readonly (components["schemas"]["MetafieldBase_Post"] & { /** * @description The ID for the cart with which the metafield is associated. - * * @example 42 */ readonly resource_id: string; @@ -3033,8 +3003,7 @@ export interface operations { }; }; readonly responses: { - /** @description List of created `Metafield` objects. - * */ + /** @description List of created `Metafield` objects. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -3049,12 +3018,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -3063,8 +3034,7 @@ export interface operations { }; }; }; - /** @description Response object for metafields creation with partial success. - * */ + /** @description Response object for metafields creation with partial success. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -3089,8 +3059,7 @@ export interface operations { }; }; readonly responses: { - /** @description Response object for metafields deletion with success. - * */ + /** @description Response object for metafields deletion with success. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -3105,12 +3074,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -3119,8 +3090,7 @@ export interface operations { }; }; }; - /** @description Response object for metafields deletion with partial success. - * */ + /** @description Response object for metafields deletion with partial success. */ readonly 422: { headers: { readonly [name: string]: unknown; diff --git a/src/internal/reference/generated/catalog/brands_catalog.v3.ts b/src/internal/reference/generated/catalog/brands_catalog.v3.ts index 4fbe252..6d3c3b6 100644 --- a/src/internal/reference/generated/catalog/brands_catalog.v3.ts +++ b/src/internal/reference/generated/catalog/brands_catalog.v3.ts @@ -44,8 +44,7 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the brand to which the resource belongs. - * */ + /** @description The ID of the brand to which the resource belongs. */ readonly brand_id: components["parameters"]["BrandIdPath"]; }; readonly cookie?: never; @@ -76,8 +75,7 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the brand to which the resource belongs. - * */ + /** @description The ID of the brand to which the resource belongs. */ readonly brand_id: components["parameters"]["BrandIdPath"]; }; readonly cookie?: never; @@ -103,11 +101,9 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the brand to which the resource belongs. - * */ + /** @description The ID of the brand to which the resource belongs. */ readonly brand_id: components["parameters"]["BrandIdPath"]; - /** @description The ID of the `Metafield`. - * */ + /** @description The ID of the `Metafield`. */ readonly metafield_id: components["parameters"]["MetafieldIdPath"]; }; readonly cookie?: never; @@ -150,8 +146,7 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the brand to which the resource belongs. - * */ + /** @description The ID of the brand to which the resource belongs. */ readonly brand_id: components["parameters"]["BrandIdPath"]; }; readonly cookie?: never; @@ -225,13 +220,11 @@ export interface components { readonly name: string; /** * @description The title shown in the browser while viewing the brand. - * * @example Common Good */ readonly page_title?: string; /** * @description An array of meta keywords to include in the HTML. - * * @example [ * "modern", * "clean", @@ -241,19 +234,16 @@ export interface components { readonly meta_keywords?: readonly string[]; /** * @description A meta description to include. - * * @example Common Good is a modern brand. */ readonly meta_description?: string; /** * @description A comma-separated list of keywords that can be used to locate this brand. - * * @example kitchen, laundry, cart, storage */ readonly search_keywords?: string; /** * @description Image URL used for this category on the storefront. Images can be uploaded via form file post to `/brands/{brandId}/image`, or by providing a publicly accessible URL in this field. - * * @example https://cdn8.bigcommerce.com/s-12345/product_images/k/your-image-name.png */ readonly image_url?: string; @@ -266,19 +256,16 @@ export interface components { readonly metafield_Base: { /** * @description The name of the field, for example: `location_id`, `color`. Required for POST. - * * @example Location */ readonly key: string; /** * @description The value of the field, for example: `1`, `blue`. Required for POST. - * * @example 4HG */ readonly value: string; /** * @description Namespace for the metafield, for organizational purposes. This is set by the developer. Required for POST. - * * @example Warehouse Locations */ readonly namespace: string; @@ -297,7 +284,6 @@ export interface components { readonly permission_set: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; /** * @description Description for the metafields. - * * @example Location in the warehouse */ readonly description?: string; @@ -307,11 +293,9 @@ export interface components { * @description The custom URL for the product on the storefront. */ readonly customUrl_Full: { - /** @description Product URL on the storefront. - * */ + /** @description Product URL on the storefront. */ readonly url?: string; - /** @description Returns `true` if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides). - * */ + /** @description Returns `true` if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides). */ readonly is_customized?: boolean; }; /** @@ -328,48 +312,39 @@ export interface components { readonly pagination_Full: { /** * @description Total number of items in the result set. - * * @example 36 */ readonly total?: number; /** * @description Total number of items in the collection response. - * * @example 36 */ readonly count?: number; /** * @description The amount of items returned in the collection per page, controlled by the limit parameter. - * * @example 50 */ readonly per_page?: number; /** * @description The page you are currently on within the collection. - * * @example 1 */ readonly current_page?: number; /** * @description The total number of pages in the collection. - * * @example 1 */ readonly total_pages?: number; - /** @description Pagination links for the previous and next parts of the whole collection. - * */ + /** @description Pagination links for the previous and next parts of the whole collection. */ readonly links?: { - /** @description Link to the previous page returned in the response. - * */ + /** @description Link to the previous page returned in the response. */ readonly previous?: string; /** * @description Link to the current page returned in the response. - * * @example ?page=1&limit=50 */ readonly current?: string; - /** @description Link to the next page returned in the response. - * */ + /** @description Link to the next page returned in the response. */ readonly next?: string; }; }; @@ -383,14 +358,11 @@ export interface components { /** * error_Base * @description Error payload for the BigCommerce API. - * */ readonly error_Base: { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -404,28 +376,24 @@ export interface components { } & components["schemas"]["metafield_Base"] & { /** * @description The type of resource with which the metafield is associated. - * * @example product * @enum {string} */ readonly resource_type?: "category" | "brand" | "product" | "variant"; /** * @description The ID of the resource with which the metafield is associated. - * * @example 111 */ readonly resource_id?: number; /** * Format: date-time * @description Date and time of the metafieldʼs creation. - * * @example 2018-05-07T20:14:17+00:00 */ readonly date_created?: string; /** * Format: date-time * @description Date and time when the metafield was last updated. - * * @example 2018-05-07T20:14:17+00:00 */ readonly date_modified?: string; @@ -435,8 +403,7 @@ export interface components { */ readonly owner_client_id?: string; }; - /** @description Common Metafield properties. - * */ + /** @description Common Metafield properties. */ readonly Metafield: { /** * @description Determines the visibility and writeability of the field by other API consumers. @@ -447,44 +414,37 @@ export interface components { * | `write` | Open for reading and writing by other API consumers. | * | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | * | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | - * * @enum {string} */ readonly permission_set?: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; /** * @description Namespace for the metafield, for organizational purposes. - * * @example Sales Department */ readonly namespace?: string; /** * @description The name of the field, for example: `location_id`, `color`. - * * @example Staff Name */ readonly key?: string; /** * @description The value of the field, for example: `1`, `blue`. - * * @example Ronaldo */ readonly value?: string; /** * @description Description for the metafields. - * * @example order */ readonly description?: string; /** * @description The type of resource with which the metafield is associated. - * * @example cart * @enum {string} */ readonly resource_type?: "brand" | "product" | "variant" | "category" | "cart" | "channel" | "location" | "order" | "customer"; /** * @description The unique identifier for the resource with which the metafield is associated. - * * @example 424242 */ readonly resource_id?: number; @@ -508,14 +468,12 @@ export interface components { */ readonly owner_client_id?: string; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponse: { readonly data?: readonly components["schemas"]["Metafield"][]; readonly meta?: components["schemas"]["CollectionMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponse_POST_PUT: { readonly data?: readonly components["schemas"]["Metafield"][]; /** @@ -525,31 +483,32 @@ export interface components { readonly errors?: readonly unknown[]; readonly meta?: components["schemas"]["CollectionMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponsePartialSuccess_POST_PUT: { readonly data?: readonly components["schemas"]["Metafield"][]; readonly errors?: readonly components["schemas"]["Error"][]; readonly meta?: components["schemas"]["WriteCollectionPartialSuccessMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponsePartialSuccess_DELETE: { - /** @example [ + /** + * @example [ * 123 - * ] */ + * ] + */ readonly data?: readonly number[]; readonly errors?: readonly components["schemas"]["Error"][]; readonly meta?: components["schemas"]["WriteCollectionPartialSuccessMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionDeleteResponseSuccess: { - /** @example [ + /** + * @example [ * 123, * 124, * 125 - * ] */ + * ] + */ readonly data?: readonly number[]; /** * @description Empty for 200 responses. @@ -565,19 +524,16 @@ export interface components { readonly WriteCollectionPartialSuccessMeta: { /** * @description Total number of items in the result set. - * * @example 3 */ readonly total?: number; /** * @description Total number of items that were successfully deleted. - * * @example 1 */ readonly success?: number; /** * @description Total number of items that failed to be deleted. - * * @example 2 */ readonly failed?: number; @@ -589,47 +545,39 @@ export interface components { readonly WriteCollectionSuccessMeta: { /** * @description Total number of items in the result set. - * * @example 3 */ readonly total?: number; /** * @description Total number of items that were successfully deleted. - * * @example 3 */ readonly success?: number; /** * @description Total number of items that failed to be deleted. - * * @example 0 */ readonly failed?: number; }; /** * @description Total number of items in the result set. - * * @example 3 */ readonly Total: number; - /** @description Error response payload for the BigCommerce API. - * */ + /** @description Error response payload for the BigCommerce API. */ readonly Error: { /** * @description The HTTP status code for the error. - * * @example 422 */ readonly status?: number; /** * @description The error title. - * * @example Bulk operation has failed */ readonly title?: string; /** * @description The error type. - * * @example https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes */ readonly type?: string; @@ -637,7 +585,6 @@ export interface components { }; /** * @description Error detail response payload for the BigCommerce API. - * * @example { * "1": "Unauthorized to delete", * "2": "Metafield does not exist" @@ -658,56 +605,46 @@ export interface components { readonly pagination?: { /** * @description Total number of items in the result set. - * * @example 36 */ readonly total?: number; /** * @description Total number of items in the collection response. - * * @example 36 */ readonly count?: number; /** * @description The amount of items returned in the collection per page, controlled by the limit parameter. - * * @example 50 */ readonly per_page?: number; /** * @description The page you are currently on within the collection. - * * @example 1 */ readonly current_page?: number; /** * @description The total number of pages in the collection. - * * @example 1 */ readonly total_pages?: number; - /** @description Pagination links for the previous and next parts of the whole collection. - * */ + /** @description Pagination links for the previous and next parts of the whole collection. */ readonly links?: { - /** @description Link to the previous page returned in the response. - * */ + /** @description Link to the previous page returned in the response. */ readonly previous?: string; /** * @description Link to the current page returned in the response. - * * @example ?page=1&limit=50 */ readonly current?: string; - /** @description Link to the next page returned in the response. - * */ + /** @description Link to the next page returned in the response. */ readonly next?: string; }; }; } & { readonly [key: string]: unknown; }; - /** @description Common Metafield properties. - * */ + /** @description Common Metafield properties. */ readonly MetafieldBase_Post: { /** * @description Determines the visibility and writeability of the field by other API consumers. @@ -718,47 +655,39 @@ export interface components { * | `write` | Open for reading and writing by other API consumers. | * | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | * | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | - * * @enum {string} */ readonly permission_set: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; /** * @description Namespace for the metafield, for organizational purposes. - * * @example Sales Department */ readonly namespace: string; /** * @description The name of the field, for example: `location_id`, `color`. - * * @example Staff Name */ readonly key: string; /** * @description The value of the field, for example: `1`, `blue`. - * * @example Ronaldo */ readonly value: string; /** * @description Description for the metafields. - * * @example Name of Staff Member */ readonly description?: string; }; - /** @description The model for a POST to create metafield. - * */ + /** @description The model for a POST to create metafield. */ readonly MetafieldPost: components["schemas"]["MetafieldBase_Post"] & { /** * @description The ID for the resource with which the metafield is associated. - * * @example 42 */ readonly resource_id: number; }; - /** @description Common Metafield properties. - * */ + /** @description Common Metafield properties. */ readonly MetafieldBase_Put: { /** * @description Determines the visibility and writeability of the field by other API consumers. @@ -769,31 +698,26 @@ export interface components { * | `write` | Open for reading and writing by other API consumers. | * | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | * | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | - * * @enum {string} */ readonly permission_set?: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; /** * @description Namespace for the metafield, for organizational purposes. - * * @example Sales Department */ readonly namespace?: string; /** * @description The name of the field, for example: `location_id`, `color`. - * * @example Staff Name */ readonly key?: string; /** * @description The value of the field, for example: `1`, `blue`. - * * @example Ronaldo */ readonly value?: string; /** * @description Description for the metafields. - * * @example Name of Staff Member */ readonly description?: string; @@ -885,14 +809,11 @@ export interface components { }; }; parameters: { - /** @description Sort direction. Acceptable values are: `asc`, `desc`. - * */ + /** @description Sort direction. Acceptable values are: `asc`, `desc`. */ readonly DirectionQuery: "asc" | "desc"; - /** @description The ID of the brand to which the resource belongs. - * */ + /** @description The ID of the brand to which the resource belongs. */ readonly BrandIdPath: number; - /** @description The ID of the `Metafield`. - * */ + /** @description The ID of the `Metafield`. */ readonly MetafieldIdPath: number; /** @description Filter based on a metafieldʼs key. */ readonly MetafieldKeyParam: string; @@ -902,23 +823,17 @@ export interface components { readonly MetafieldNamespaceParam: string; /** @description Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. */ readonly MetafieldNamespaceInParam: readonly string[]; - /** @description 'Query parameter that lets you filter by the minimum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.' - * */ + /** @description 'Query parameter that lets you filter by the minimum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.' */ readonly date_created_min: string; - /** @description 'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.' - * */ + /** @description 'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.' */ readonly date_created_max: string; - /** @description 'Query parameter that lets you filter by the maximum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.' - * */ + /** @description 'Query parameter that lets you filter by the maximum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.' */ readonly date_modified_max: string; - /** @description 'Query parameter that lets you filter by the minimum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.' - * */ + /** @description 'Query parameter that lets you filter by the minimum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.' */ readonly date_modified_min: string; - /** @description Sort direction. Acceptable values are: `asc`, `desc`. - * */ + /** @description Sort direction. Acceptable values are: `asc`, `desc`. */ readonly DirectionParam: "asc" | "desc"; - /** @description Filter items by ID. - * */ + /** @description Filter items by ID. */ readonly IdQuery: number; readonly IdInQuery: readonly number[]; readonly IdNotInQuery: readonly number[]; @@ -926,16 +841,13 @@ export interface components { readonly IdMaxQuery: readonly number[]; readonly IdGreaterQuery: readonly number[]; readonly IdLessQuery: readonly number[]; - /** @description Filter items by name. - * */ + /** @description Filter items by name. */ readonly NameQuery: string; - /** @description Filter items by name. - * */ + /** @description Filter items by name. */ readonly NameRequired: string; /** @description Filter items by part of a name. For example, `name:like=new` returns brands with names that include `new`. */ readonly NameLikeQuery: string; - /** @description Filter items by page_title. - * */ + /** @description Filter items by page_title. */ readonly PageTitleQuery: string; /** @description Specifies the page number in a limited (paginated) list of products. */ readonly PageQuery: number; @@ -963,8 +875,7 @@ export interface operations { readonly getBrands: { readonly parameters: { readonly query?: { - /** @description Filter items by ID. - * */ + /** @description Filter items by ID. */ readonly id?: components["parameters"]["IdQuery"]; readonly "id:in"?: components["parameters"]["IdInQuery"]; readonly "id:not_in"?: components["parameters"]["IdNotInQuery"]; @@ -972,13 +883,11 @@ export interface operations { readonly "id:max"?: components["parameters"]["IdMaxQuery"]; readonly "id:greater"?: components["parameters"]["IdGreaterQuery"]; readonly "id:less"?: components["parameters"]["IdLessQuery"]; - /** @description Filter items by name. - * */ + /** @description Filter items by name. */ readonly name?: components["parameters"]["NameQuery"]; /** @description Filter items by part of a name. For example, `name:like=new` returns brands with names that include `new`. */ readonly "name:like"?: components["parameters"]["NameLikeQuery"]; - /** @description Filter items by page_title. - * */ + /** @description Filter items by page_title. */ readonly page_title?: components["parameters"]["PageTitleQuery"]; /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageQuery"]; @@ -990,8 +899,7 @@ export interface operations { readonly exclude_fields?: components["parameters"]["ExcludeFieldsQuery"]; /** @description Field name to sort by. */ readonly sort?: components["parameters"]["SortQuery"]; - /** @description Sort direction. Acceptable values are: `asc`, `desc`. - * */ + /** @description Sort direction. Acceptable values are: `asc`, `desc`. */ readonly direction?: components["parameters"]["DirectionQuery"]; }; readonly header?: { @@ -1008,7 +916,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": [ * { * "id": 35, @@ -1250,7 +1159,8 @@ export interface operations { * } * } * } - * } */ + * } + */ readonly "application/json": { readonly data?: readonly components["schemas"]["brand_Full"][]; readonly meta?: components["schemas"]["metaCollection_Full"]; @@ -1284,13 +1194,11 @@ export interface operations { readonly name: string; /** * @description The title shown in the browser while viewing the brand. - * * @example Common Good */ readonly page_title?: string; /** * @description An array of meta keywords to include in the HTML. - * * @example [ * "modern", * "clean", @@ -1300,19 +1208,16 @@ export interface operations { readonly meta_keywords?: readonly string[]; /** * @description A meta description to include. - * * @example Common Good is a modern brand. */ readonly meta_description?: string; /** * @description A comma-separated list of keywords that can be used to locate this brand. - * * @example kitchen, laundry, cart, storage */ readonly search_keywords?: string; /** * @description Image URL used for this category on the storefront. Images can be uploaded via form file post to `/brands/{brandId}/image`, or by providing a publicly accessible URL in this field. - * * @example https://cdn8.bigcommerce.com/s-12345/product_images/k/your-image-name.png */ readonly image_url?: string; @@ -1323,13 +1228,11 @@ export interface operations { readonly custom_url?: { /** * @description Brand URL on the storefront. - * * @example /shoes */ readonly url?: string; /** * @description Returns `true` if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides). - * * @example true */ readonly is_customized?: boolean; @@ -1343,7 +1246,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 50, * "name": "Common Good", @@ -1361,7 +1265,8 @@ export interface operations { * } * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { /** * Brand @@ -1378,13 +1283,11 @@ export interface operations { readonly name?: string; /** * @description The title shown in the browser while viewing the brand. - * * @example Common Good */ readonly page_title?: string; /** * @description An array of meta keywords to include in the HTML. - * * @example [ * "modern", * "clean", @@ -1394,19 +1297,16 @@ export interface operations { readonly meta_keywords?: readonly string[]; /** * @description A meta description to include. - * * @example Common Good is a modern brand. */ readonly meta_description?: string; /** * @description A comma-separated list of keywords that can be used to locate this brand. - * * @example kitchen, laundry, cart, storage */ readonly search_keywords?: string; /** * @description Image URL used for this category on the storefront. Images can be uploaded via form file post to `/brands/{brandId}/image`, or by providing a publicly accessible URL in this field. - * * @example https://cdn8.bigcommerce.com/s-12345/product_images/k/your-image-name.png */ readonly image_url?: string; @@ -1417,13 +1317,11 @@ export interface operations { readonly custom_url?: { /** * @description Brand URL on the storefront. - * * @example /shoes */ readonly url?: string; /** * @description Returns `true` if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides). - * * @example true */ readonly is_customized?: boolean; @@ -1448,11 +1346,9 @@ export interface operations { readonly errors?: { readonly [key: string]: unknown; }; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -1469,11 +1365,9 @@ export interface operations { readonly errors?: { readonly [key: string]: unknown; }; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -1484,11 +1378,9 @@ export interface operations { readonly deleteBrands: { readonly parameters: { readonly query: { - /** @description Filter items by name. - * */ + /** @description Filter items by name. */ readonly name: components["parameters"]["NameRequired"]; - /** @description Filter items by page_title. - * */ + /** @description Filter items by page_title. */ readonly page_title?: components["parameters"]["PageTitleQuery"]; }; readonly header?: { @@ -1524,8 +1416,7 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the brand to which the resource belongs. - * */ + /** @description The ID of the brand to which the resource belongs. */ readonly brand_id: components["parameters"]["BrandIdPath"]; }; readonly cookie?: never; @@ -1537,7 +1428,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 50, * "name": "Common Good", @@ -1555,7 +1447,8 @@ export interface operations { * } * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: components["schemas"]["brand_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; @@ -1565,16 +1458,14 @@ export interface operations { readonly 207: components["responses"]["MultiStatus"]; readonly 401: components["responses"]["UnauthorizedError"]; readonly 403: components["responses"]["Error"]; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -1597,8 +1488,7 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the brand to which the resource belongs. - * */ + /** @description The ID of the brand to which the resource belongs. */ readonly brand_id: components["parameters"]["BrandIdPath"]; }; readonly cookie?: never; @@ -1616,13 +1506,11 @@ export interface operations { readonly name: string; /** * @description The title shown in the browser while viewing the brand. - * * @example Common Good */ readonly page_title?: string; /** * @description An array of meta keywords to include in the HTML. - * * @example [ * "modern", * "clean", @@ -1632,19 +1520,16 @@ export interface operations { readonly meta_keywords?: readonly string[]; /** * @description A meta description to include. - * * @example Common Good is a modern brand. */ readonly meta_description?: string; /** * @description A comma-separated list of keywords that can be used to locate this brand. - * * @example kitchen, laundry, cart, storage */ readonly search_keywords?: string; /** * @description Image URL used for this category on the storefront. Images can be uploaded via form file post to `/brands/{brandId}/image`, or by providing a publicly accessible URL in this field. - * * @example https://cdn8.bigcommerce.com/s-12345/product_images/k/your-image-name.png */ readonly image_url?: string; @@ -1655,13 +1540,11 @@ export interface operations { readonly custom_url?: { /** * @description Brand URL on the storefront. - * * @example /shoes */ readonly url?: string; /** * @description Returns `true` if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides). - * * @example true */ readonly is_customized?: boolean; @@ -1675,7 +1558,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 50, * "name": "Common Good", @@ -1693,7 +1577,8 @@ export interface operations { * } * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { /** * Brand @@ -1710,13 +1595,11 @@ export interface operations { readonly name: string; /** * @description The title shown in the browser while viewing the brand. - * * @example Common Good */ readonly page_title?: string; /** * @description An array of meta keywords to include in the HTML. - * * @example [ * "modern", * "clean", @@ -1726,19 +1609,16 @@ export interface operations { readonly meta_keywords?: readonly string[]; /** * @description A meta description to include. - * * @example Common Good is a modern brand. */ readonly meta_description?: string; /** * @description A comma-separated list of keywords that can be used to locate this brand. - * * @example kitchen, laundry, cart, storage */ readonly search_keywords?: string; /** * @description Image URL used for this category on the storefront. Images can be uploaded via form file post to `/brands/{brandId}/image`, or by providing a publicly accessible URL in this field. - * * @example https://cdn8.bigcommerce.com/s-12345/product_images/k/your-image-name.png */ readonly image_url?: string; @@ -1749,13 +1629,11 @@ export interface operations { readonly custom_url?: { /** * @description Brand URL on the storefront. - * * @example /shoes */ readonly url?: string; /** * @description Returns `true` if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides). - * * @example true */ readonly is_customized?: boolean; @@ -1768,16 +1646,14 @@ export interface operations { readonly 207: components["responses"]["MultiStatus"]; readonly 401: components["responses"]["UnauthorizedError"]; readonly 403: components["responses"]["Error"]; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -1785,8 +1661,7 @@ export interface operations { }; }; }; - /** @description The `Brand` was in conflict with another product. This is the result of duplicate unique values, such as `name`. - * */ + /** @description The `Brand` was in conflict with another product. This is the result of duplicate unique values, such as `name`. */ readonly 409: { headers: { readonly [name: string]: unknown; @@ -1797,18 +1672,15 @@ export interface operations { readonly errors?: { readonly [key: string]: unknown; }; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; }; }; - /** @description The `Brand` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description The `Brand` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -1819,11 +1691,9 @@ export interface operations { readonly errors?: { readonly [key: string]: unknown; }; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -1839,8 +1709,7 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the brand to which the resource belongs. - * */ + /** @description The ID of the brand to which the resource belongs. */ readonly brand_id: components["parameters"]["BrandIdPath"]; }; readonly cookie?: never; @@ -1861,8 +1730,7 @@ export interface operations { readonly getBrandMetafields: { readonly parameters: { readonly query?: { - /** @description Filter items by ID. - * */ + /** @description Filter items by ID. */ readonly id?: components["parameters"]["IdQuery"]; readonly "id:in"?: components["parameters"]["IdInQuery"]; readonly "id:not_in"?: components["parameters"]["IdNotInQuery"]; @@ -1888,8 +1756,7 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the brand to which the resource belongs. - * */ + /** @description The ID of the brand to which the resource belongs. */ readonly brand_id: components["parameters"]["BrandIdPath"]; }; readonly cookie?: never; @@ -1901,7 +1768,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": [ * { * "id": 6, @@ -1942,7 +1810,8 @@ export interface operations { * } * } * } - * } */ + * } + */ readonly "application/json": { readonly data?: readonly components["schemas"]["metafield_Full"][]; readonly meta?: components["schemas"]["metaCollection_Full"]; @@ -1961,8 +1830,7 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the brand to which the resource belongs. - * */ + /** @description The ID of the brand to which the resource belongs. */ readonly brand_id: components["parameters"]["BrandIdPath"]; }; readonly cookie?: never; @@ -1994,12 +1862,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2008,8 +1878,7 @@ export interface operations { }; }; }; - /** @description The `Metafield` was in conflict with another `Metafield`. This can be the result of duplicate unique key combination of the appʼs client id, namespace, key, resource_type, and resource_id. - * */ + /** @description The `Metafield` was in conflict with another `Metafield`. This can be the result of duplicate unique key combination of the appʼs client id, namespace, key, resource_type, and resource_id. */ readonly 409: { headers: { readonly [name: string]: unknown; @@ -2021,18 +1890,15 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; }; }; - /** @description The `Metafield` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description The `Metafield` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -2044,11 +1910,9 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -2069,11 +1933,9 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the brand to which the resource belongs. - * */ + /** @description The ID of the brand to which the resource belongs. */ readonly brand_id: components["parameters"]["BrandIdPath"]; - /** @description The ID of the `Metafield`. - * */ + /** @description The ID of the `Metafield`. */ readonly metafield_id: components["parameters"]["MetafieldIdPath"]; }; readonly cookie?: never; @@ -2085,7 +1947,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 4, * "key": "location_id", @@ -2100,23 +1963,22 @@ export interface operations { * "owner_client_id": "e8o0nm9ujew7byzu6x5dwjqe2rya2fv" * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: components["schemas"]["metafield_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; }; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -2137,11 +1999,9 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the brand to which the resource belongs. - * */ + /** @description The ID of the brand to which the resource belongs. */ readonly brand_id: components["parameters"]["BrandIdPath"]; - /** @description The ID of the `Metafield`. - * */ + /** @description The ID of the `Metafield`. */ readonly metafield_id: components["parameters"]["MetafieldIdPath"]; }; readonly cookie?: never; @@ -2157,7 +2017,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 4, * "key": "location_id", @@ -2171,7 +2032,8 @@ export interface operations { * "date_modified": "2021-08-06T19:15:35+00:00" * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: components["schemas"]["metafield_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; @@ -2184,12 +2046,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2198,16 +2062,14 @@ export interface operations { }; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -2226,11 +2088,9 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the brand to which the resource belongs. - * */ + /** @description The ID of the brand to which the resource belongs. */ readonly brand_id: components["parameters"]["BrandIdPath"]; - /** @description The ID of the `Metafield`. - * */ + /** @description The ID of the `Metafield`. */ readonly metafield_id: components["parameters"]["MetafieldIdPath"]; }; readonly cookie?: never; @@ -2243,16 +2103,14 @@ export interface operations { }; content?: never; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -2271,8 +2129,7 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the brand to which the resource belongs. - * */ + /** @description The ID of the brand to which the resource belongs. */ readonly brand_id: components["parameters"]["BrandIdPath"]; }; readonly cookie?: never; @@ -2291,12 +2148,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "image_url": "https://cdn11.bigcommerce.com/s-{store_hash}/product_images/k/group_1545334669__76009.png" * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: { readonly image_url?: string; @@ -2321,8 +2180,7 @@ export interface operations { }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -2343,11 +2201,9 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -2363,8 +2219,7 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the brand to which the resource belongs. - * */ + /** @description The ID of the brand to which the resource belongs. */ readonly brand_id: components["parameters"]["BrandIdPath"]; }; readonly cookie?: never; @@ -2394,8 +2249,7 @@ export interface operations { readonly namespace?: components["parameters"]["MetafieldNamespaceParam"]; /** @description Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. */ readonly "namespace:in"?: components["parameters"]["MetafieldNamespaceInParam"]; - /** @description Sort direction. Acceptable values are: `asc`, `desc`. - * */ + /** @description Sort direction. Acceptable values are: `asc`, `desc`. */ readonly direction?: components["parameters"]["DirectionParam"]; /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */ readonly include_fields?: components["parameters"]["IncludeFieldsParamMetafields"]; @@ -2409,8 +2263,7 @@ export interface operations { }; readonly requestBody?: never; readonly responses: { - /** @description List of `Metafield` objects. - * */ + /** @description List of `Metafield` objects. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -2452,7 +2305,6 @@ export interface operations { readonly "application/json": readonly (components["schemas"]["MetafieldBase_Put"] & { /** * @description The ID of metafield to update. - * * @example 42 */ readonly id: number; @@ -2460,8 +2312,7 @@ export interface operations { }; }; readonly responses: { - /** @description List of updated `Metafield` objects. - * */ + /** @description List of updated `Metafield` objects. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -2476,12 +2327,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "errors": {} - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2524,7 +2377,6 @@ export interface operations { readonly "application/json": readonly (components["schemas"]["MetafieldBase_Post"] & { /** * @description The ID for the brand with which the metafield is associated. - * * @example 42 */ readonly resource_id: number; @@ -2532,8 +2384,7 @@ export interface operations { }; }; readonly responses: { - /** @description List of created `Metafield` objects. - * */ + /** @description List of created `Metafield` objects. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -2548,12 +2399,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2562,8 +2415,7 @@ export interface operations { }; }; }; - /** @description Response object for metafields creation with partial success. - * */ + /** @description Response object for metafields creation with partial success. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -2591,8 +2443,7 @@ export interface operations { }; }; readonly responses: { - /** @description Response object for metafields deletion with success. - * */ + /** @description Response object for metafields deletion with success. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -2607,12 +2458,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2621,8 +2474,7 @@ export interface operations { }; }; }; - /** @description Response object for metafields deletion with partial success. - * */ + /** @description Response object for metafields deletion with partial success. */ readonly 422: { headers: { readonly [name: string]: unknown; diff --git a/src/internal/reference/generated/catalog/categories_catalog.v3.ts b/src/internal/reference/generated/catalog/categories_catalog.v3.ts index e6c3af3..46199ad 100644 --- a/src/internal/reference/generated/catalog/categories_catalog.v3.ts +++ b/src/internal/reference/generated/catalog/categories_catalog.v3.ts @@ -75,8 +75,7 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Category` to which the resource belongs. - * */ + /** @description The ID of the `Category` to which the resource belongs. */ readonly category_id: components["parameters"]["CategoryIdParam"]; }; readonly cookie?: never; @@ -129,8 +128,7 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Category` to which the resource belongs. - * */ + /** @description The ID of the `Category` to which the resource belongs. */ readonly category_id: components["parameters"]["CategoryIdParam"]; }; readonly cookie?: never; @@ -165,11 +163,9 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Category` to which the resource belongs. - * */ + /** @description The ID of the `Category` to which the resource belongs. */ readonly category_id: components["parameters"]["CategoryIdParam"]; - /** @description The ID of the `Metafield`. - * */ + /** @description The ID of the `Metafield`. */ readonly metafield_id: components["parameters"]["MetafieldIdParam"]; }; readonly cookie?: never; @@ -211,8 +207,7 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Category` to which the resource belongs. - * */ + /** @description The ID of the `Category` to which the resource belongs. */ readonly category_id: components["parameters"]["CategoryIdParam"]; }; readonly cookie?: never; @@ -241,8 +236,7 @@ export interface paths { readonly "/catalog/categories/{category_id}/products/sort-order": { readonly parameters: { readonly query?: { - /** @description Specifies the page number in a limited (paginated) list of results. - * */ + /** @description Specifies the page number in a limited (paginated) list of results. */ readonly page?: components["parameters"]["PageParam"]; }; readonly header: { @@ -250,8 +244,7 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Category` to which the resource belongs. - * */ + /** @description The ID of the `Category` to which the resource belongs. */ readonly category_id: components["parameters"]["CategoryIdParam"]; }; readonly cookie?: never; @@ -261,16 +254,19 @@ export interface paths { * @description Returns a list of products and their sort order for a specific category. * * **Limits** - * * page=2&limit=250 will return page 2 of the results with 250 items per page. + * + * - page=2&limit=250 will return page 2 of the results with 250 items per page. * * **Usage Notes** + * + * * Product sort order only takes effect on the storefront when sorting by **Featured Items** in the category. See [Sort Order](https://support.bigcommerce.com/s/article/Sort-Order) for more information. * * Data pairs are displayed in ascending order based on products' `sort_order` values. * * `null` values are allowed for products without specified `sort_order` values. * * Products with `sort_order` value of `null` will be displayed after products with valid numerical values. * * The priorities for determining product sort order on a storefront are the following: - * - Priority 1: Manually specified sort order on Category Level (API). - * - Priority 2: Manually specified sort order on Product (Global) Level (UI/API). - * - Priority 3: Default sorting by Product ID (newly added products go first) (UI/API). + * * Priority 1: Manually specified sort order on Category Level (API). + * * Priority 2: Manually specified sort order on Product (Global) Level (UI/API). + * * Priority 3: Default sorting by Product ID (newly added products go first) (UI/API). */ readonly get: operations["getCategorySortOrders"]; /** @@ -319,8 +315,10 @@ export interface components { * @description Common Category object properties. */ readonly category_Full: { - /** @description Unique ID of the *Category*. Increments sequentially. - * Read-Only. */ + /** + * @description Unique ID of the *Category*. Increments sequentially. + * Read-Only. + */ readonly id?: number; /** * @description The unique numeric ID of the categoryʼs parent. This field controls where the category sits in the tree of categories that organize the catalog. @@ -336,55 +334,44 @@ export interface components { readonly name?: string; /** * @description The product description, which can include HTML formatting. - * * @example

We offer a wide variety of products perfect for relaxing

*/ readonly description?: string; /** * @description Number of views the category has on the storefront. - * * @example 1050 */ readonly views?: number; /** * @description Priority this category will be given when included in the menu and category pages. The lower the number, the closer to the top of the results the category will be. - * * @example 3 */ readonly sort_order?: number; /** * @description Custom title for the category page. If not defined, the category name will be used as the meta title. - * * @example Bath */ readonly page_title?: string; - /** @description A comma-separated list of keywords that can be used to locate the category when searching the store. - * */ + /** @description A comma-separated list of keywords that can be used to locate the category when searching the store. */ readonly search_keywords?: string; - /** @description Custom meta keywords for the category page. If not defined, the storeʼs default keywords will be used. Must post as an array like: ["awesome","sauce"]. - * */ + /** @description Custom meta keywords for the category page. If not defined, the storeʼs default keywords will be used. Must post as an array like: ["awesome","sauce"]. */ readonly meta_keywords?: readonly string[]; - /** @description Custom meta description for the category page. If not defined, the storeʼs default meta description will be used. - * */ + /** @description Custom meta description for the category page. If not defined, the storeʼs default meta description will be used. */ readonly meta_description?: string; /** * @description A valid layout file. Please refer to [the article on creating category files (Help Center)](https://support.bigcommerce.com/articles/Public/Creating-Custom-Template-Files/). This field is writable only for stores with a Blueprint theme applied. For stores with a Stencil theme applied, see [Custom Template Associations](/docs/rest-content/custom-template-associations). - * * @example category.html */ readonly layout_file?: string; - /** @description Flag to determine whether the product should be displayed to customers browsing the store. If `true`, the category will be displayed. If `false`, the category will be hidden from view. - * */ + /** @description Flag to determine whether the product should be displayed to customers browsing the store. If `true`, the category will be displayed. If `false`, the category will be hidden from view. */ readonly is_visible?: boolean; /** * @description Determines how the products are sorted on category page load. - * * @enum {string} */ readonly default_product_sort?: "use_store_settings" | "featured" | "newest" | "best_selling" | "alpha_asc" | "alpha_desc" | "avg_customer_review" | "price_asc" | "price_desc"; /** * @description Image URL used for this category on the storefront. Images can be uploaded using form file post to `/categories/{categoryId}/image`, or by providing a publicly accessible URL in this field. An image extension like .jpg or .png is required. - * * @example https://cdn8.bigcommerce.com/s-123456/product_images/d/fakeimage.png */ readonly image_url?: string; @@ -397,19 +384,16 @@ export interface components { readonly metafield_Base: { /** * @description The name of the field, for example: `location_id`, `color`. Required for POST. - * * @example Location */ readonly key: string; /** * @description The value of the field, for example: `1`, `blue`. Required for POST. - * * @example 4HG */ readonly value: string; /** * @description Namespace for the metafield, for organizational purposes. This is set by the developer. Required for POST. - * * @example Warehouse Locations */ readonly namespace: string; @@ -428,7 +412,6 @@ export interface components { readonly permission_set: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; /** * @description Description for the metafields. - * * @example Location in the warehouse */ readonly description?: string; @@ -438,11 +421,9 @@ export interface components { * @description The custom URL for the product on the storefront. */ readonly customUrl_Full: { - /** @description Product URL on the storefront. - * */ + /** @description Product URL on the storefront. */ readonly url?: string; - /** @description Returns `true` if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides). - * */ + /** @description Returns `true` if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides). */ readonly is_customized?: boolean; }; /** @@ -459,48 +440,39 @@ export interface components { readonly pagination_Full: { /** * @description Total number of items in the result set. - * * @example 36 */ readonly total?: number; /** * @description Total number of items in the collection response. - * * @example 36 */ readonly count?: number; /** * @description The amount of items returned in the collection per page, controlled by the limit parameter. - * * @example 50 */ readonly per_page?: number; /** * @description The page you are currently on within the collection. - * * @example 1 */ readonly current_page?: number; /** * @description The total number of pages in the collection. - * * @example 1 */ readonly total_pages?: number; - /** @description Pagination links for the previous and next parts of the whole collection. - * */ + /** @description Pagination links for the previous and next parts of the whole collection. */ readonly links?: { - /** @description Link to the previous page returned in the response. - * */ + /** @description Link to the previous page returned in the response. */ readonly previous?: string; /** * @description Link to the current page returned in the response. - * * @example ?page=1&limit=50 */ readonly current?: string; - /** @description Link to the next page returned in the response. - * */ + /** @description Link to the next page returned in the response. */ readonly next?: string; }; }; @@ -514,14 +486,11 @@ export interface components { /** * error_Base * @description Error payload for the BigCommerce API. - * */ readonly error_Base: { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; @@ -536,43 +505,39 @@ export interface components { } & components["schemas"]["metafield_Base"] & { /** * @description The type of resource with which the metafield is associated. - * * @example product * @enum {string} */ readonly resource_type?: "category" | "brand" | "product" | "variant"; /** * @description The ID of the resource with which the metafield is associated. - * * @example 111 */ readonly resource_id?: number; /** * Format: date-time * @description Date and time of the metafieldʼs creation. Read-Only. - * * @example 2018-05-07T20:14:17+00:00 */ readonly date_created?: string; /** * Format: date-time * @description Date and time when the metafield was last updated. Read-Only. - * * @example 2018-05-07T20:14:17+00:00 */ readonly date_modified?: string; }; - /** - * productSortOrder - * @description The relative priority of the product among other products inside the category. - */ + /** productSortOrder */ readonly productSortOrder: { /** * @description The ID of the associated product. * @example 99 */ readonly product_id: number; - /** @example 4 */ + /** + * @description The relative priority of the product among other products inside the category. + * @example 4 + */ readonly sort_order: number; }; /** Category */ @@ -587,7 +552,6 @@ export interface components { readonly default_product_sort: { /** * @description Determines how the products are sorted on category page load. - * * @enum {string} */ readonly default_product_sort?: "use_store_settings" | "featured" | "newest" | "best_selling" | "alpha_asc" | "alpha_desc" | "avg_customer_review" | "price_asc" | "price_desc"; @@ -605,7 +569,6 @@ export interface components { readonly description: { /** * @description The product description, which can include HTML formatting. - * * @example

We offer a wide variety of products perfect for relaxing

*/ readonly description?: string; @@ -614,7 +577,6 @@ export interface components { readonly views: { /** * @description Number of views the category has on the storefront. - * * @example 1050 */ readonly views?: number; @@ -623,7 +585,6 @@ export interface components { readonly sort_order: { /** * @description Priority this category will be given when included in the menu and category pages. The lower the number, the closer to the top of the results the category will be. - * * @example 3 */ readonly sort_order?: number; @@ -632,57 +593,52 @@ export interface components { readonly page_title: { /** * @description Custom title for the category page. If not defined, the category name will be used as the meta title. - * * @example Bath */ readonly page_title?: string; }; /** search_keywords */ readonly search_keywords: { - /** @description A comma-separated list of keywords that can be used to locate the category when searching the store. - * */ + /** @description A comma-separated list of keywords that can be used to locate the category when searching the store. */ readonly search_keywords?: string; }; /** meta_keywords */ readonly meta_keywords: { - /** @description Custom meta keywords for the category page. If not defined, the storeʼs default keywords will be used. Must post as an array like: ["awesome","sauce"]. - * */ + /** @description Custom meta keywords for the category page. If not defined, the storeʼs default keywords will be used. Must post as an array like: ["awesome","sauce"]. */ readonly meta_keywords?: readonly string[]; }; /** layout_file */ readonly layout_file: { /** * @description A valid layout file. Please refer to [the article on creating category files (Help Center)](https://support.bigcommerce.com/articles/Public/Creating-Custom-Template-Files/). This field is writable only for stores with a Blueprint theme applied. For stores with a Stencil theme applied, see [Custom Template Associations](/docs/rest-content/custom-template-associations). - * * @example category.html */ readonly layout_file?: string; }; /** is_visible */ readonly is_visible: { - /** @description Flag to determine whether the product should be displayed to customers browsing the store. If `true`, the category will be displayed. If `false`, the category will be hidden from view. - * */ + /** @description Flag to determine whether the product should be displayed to customers browsing the store. If `true`, the category will be displayed. If `false`, the category will be hidden from view. */ readonly is_visible?: boolean; }; /** image_url */ readonly image_url: { /** * @description Image URL used for this category on the storefront. Images can be uploaded using form file post to `/categories/{categoryId}/image`, or by providing a publicly accessible URL in this field. An image extension like .jpg or .png is required. - * * @example https://cdn8.bigcommerce.com/s-123456/product_images/d/fakeimage.png */ readonly image_url?: string; }; /** meta_description */ readonly meta_description: { - /** @description Custom meta description for the category page. If not defined, the storeʼs default meta description will be used. - * */ + /** @description Custom meta description for the category page. If not defined, the storeʼs default meta description will be used. */ readonly meta_description?: string; }; /** id */ readonly id: { - /** @description Unique ID of the *Category*. Increments sequentially. - * Read-Only. */ + /** + * @description Unique ID of the *Category*. Increments sequentially. + * Read-Only. + */ readonly id?: number; }; /** parent_id */ @@ -694,8 +650,7 @@ export interface components { */ readonly parent_id?: number; }; - /** @description Common Metafield properties. - * */ + /** @description Common Metafield properties. */ readonly Metafield: { /** * @description Determines the visibility and writeability of the field by other API consumers. @@ -706,44 +661,37 @@ export interface components { * | `write` | Open for reading and writing by other API consumers. | * | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | * | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | - * * @enum {string} */ readonly permission_set?: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; /** * @description Namespace for the metafield, for organizational purposes. - * * @example Sales Department */ readonly namespace?: string; /** * @description The name of the field, for example: `location_id`, `color`. - * * @example Staff Name */ readonly key?: string; /** * @description The value of the field, for example: `1`, `blue`. - * * @example Ronaldo */ readonly value?: string; /** * @description Description for the metafields. - * * @example order */ readonly description?: string; /** * @description The type of resource with which the metafield is associated. - * * @example cart * @enum {string} */ readonly resource_type?: "brand" | "product" | "variant" | "category" | "cart" | "channel" | "location" | "order" | "customer"; /** * @description The unique identifier for the resource with which the metafield is associated. - * * @example 424242 */ readonly resource_id?: number; @@ -767,14 +715,12 @@ export interface components { */ readonly owner_client_id?: string; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponse: { readonly data?: readonly components["schemas"]["Metafield"][]; readonly meta?: components["schemas"]["CollectionMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponse_POST_PUT: { readonly data?: readonly components["schemas"]["Metafield"][]; /** @@ -784,31 +730,32 @@ export interface components { readonly errors?: readonly unknown[]; readonly meta?: components["schemas"]["CollectionMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponsePartialSuccess_POST_PUT: { readonly data?: readonly components["schemas"]["Metafield"][]; readonly errors?: readonly components["schemas"]["Error"][]; readonly meta?: components["schemas"]["WriteCollectionPartialSuccessMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponsePartialSuccess_DELETE: { - /** @example [ + /** + * @example [ * 123 - * ] */ + * ] + */ readonly data?: readonly number[]; readonly errors?: readonly components["schemas"]["Error"][]; readonly meta?: components["schemas"]["WriteCollectionPartialSuccessMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionDeleteResponseSuccess: { - /** @example [ + /** + * @example [ * 123, * 124, * 125 - * ] */ + * ] + */ readonly data?: readonly number[]; /** * @description Empty for 200 responses. @@ -824,19 +771,16 @@ export interface components { readonly WriteCollectionPartialSuccessMeta: { /** * @description Total number of items in the result set. - * * @example 3 */ readonly total?: number; /** * @description Total number of items that were successfully deleted. - * * @example 1 */ readonly success?: number; /** * @description Total number of items that failed to be deleted. - * * @example 2 */ readonly failed?: number; @@ -848,41 +792,34 @@ export interface components { readonly WriteCollectionSuccessMeta: { /** * @description Total number of items in the result set. - * * @example 3 */ readonly total?: number; /** * @description Total number of items that were successfully deleted. - * * @example 3 */ readonly success?: number; /** * @description Total number of items that failed to be deleted. - * * @example 0 */ readonly failed?: number; }; - /** @description Error response payload for the BigCommerce API. - * */ + /** @description Error response payload for the BigCommerce API. */ readonly Error: { /** * @description The HTTP status code for the error. - * * @example 422 */ readonly status?: number; /** * @description The error title. - * * @example Bulk operation has failed */ readonly title?: string; /** * @description The error type. - * * @example https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes */ readonly type?: string; @@ -890,7 +827,6 @@ export interface components { }; /** * @description Error detail response payload for the BigCommerce API. - * * @example { * "1": "Unauthorized to delete", * "2": "Metafield does not exist" @@ -911,56 +847,46 @@ export interface components { readonly pagination?: { /** * @description Total number of items in the result set. - * * @example 36 */ readonly total?: number; /** * @description Total number of items in the collection response. - * * @example 36 */ readonly count?: number; /** * @description The amount of items returned in the collection per page, controlled by the limit parameter. - * * @example 50 */ readonly per_page?: number; /** * @description The page you are currently on within the collection. - * * @example 1 */ readonly current_page?: number; /** * @description The total number of pages in the collection. - * * @example 1 */ readonly total_pages?: number; - /** @description Pagination links for the previous and next parts of the whole collection. - * */ + /** @description Pagination links for the previous and next parts of the whole collection. */ readonly links?: { - /** @description Link to the previous page returned in the response. - * */ + /** @description Link to the previous page returned in the response. */ readonly previous?: string; /** * @description Link to the current page returned in the response. - * * @example ?page=1&limit=50 */ readonly current?: string; - /** @description Link to the next page returned in the response. - * */ + /** @description Link to the next page returned in the response. */ readonly next?: string; }; }; } & { readonly [key: string]: unknown; }; - /** @description Common Metafield properties. - * */ + /** @description Common Metafield properties. */ readonly MetafieldBase_Post: { /** * @description Determines the visibility and writeability of the field by other API consumers. @@ -971,37 +897,31 @@ export interface components { * | `write` | Open for reading and writing by other API consumers. | * | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | * | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | - * * @enum {string} */ readonly permission_set: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; /** * @description Namespace for the metafield, for organizational purposes. - * * @example Sales Department */ readonly namespace: string; /** * @description The name of the field, for example: `location_id`, `color`. - * * @example Staff Name */ readonly key: string; /** * @description The value of the field, for example: `1`, `blue`. - * * @example Ronaldo */ readonly value: string; /** * @description Description for the metafields. - * * @example Name of Staff Member */ readonly description?: string; }; - /** @description Common Metafield properties. - * */ + /** @description Common Metafield properties. */ readonly MetafieldBase_Put: { /** * @description Determines the visibility and writeability of the field by other API consumers. @@ -1012,31 +932,26 @@ export interface components { * | `write` | Open for reading and writing by other API consumers. | * | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | * | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | - * * @enum {string} */ readonly permission_set?: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; /** * @description Namespace for the metafield, for organizational purposes. - * * @example Sales Department */ readonly namespace?: string; /** * @description The name of the field, for example: `location_id`, `color`. - * * @example Staff Name */ readonly key?: string; /** * @description The value of the field, for example: `1`, `blue`. - * * @example Ronaldo */ readonly value?: string; /** * @description Description for the metafields. - * * @example Name of Staff Member */ readonly description?: string; @@ -1081,29 +996,27 @@ export interface components { }; }; parameters: { - /** @description The ID of the `Category` to which the resource belongs. - * */ + /** @description The ID of the `Category` to which the resource belongs. */ readonly CategoryIdParam: number; - /** @description The ID of the `Metafield`. - * */ + /** @description The ID of the `Metafield`. */ readonly MetafieldIdParam: number; - /** @description Filter items by metafield ID. - * */ + /** @description Filter items by metafield ID. */ readonly IdMetafieldQueryParam: number; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept: string; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly ContentType: string; - /** @description Specifies the page number in a limited (paginated) list of results. - * */ + /** @description Specifies the page number in a limited (paginated) list of results. */ readonly PageParam: number; - /** @description Controls the sort order of the response, for example, `sort=name`. + /** + * @description Controls the sort order of the response, for example, `sort=name`. * * Allowed values: * - `name`: sort categories in alphabetical order by category name. * - `id`: sort in ascending order by category ID. * - `parent_id`: sort in ascending order by the ID of the parent category. - * - `sort_order`: sort in ascending order by sort order value. */ + * - `sort_order`: sort in ascending order by sort order value. + */ readonly SortParam: "name" | "id" | "parent_id" | "sort_order"; /** @description Filter based on a metafieldʼs key. */ readonly MetafieldKeyParam: string; @@ -1113,23 +1026,17 @@ export interface components { readonly MetafieldNamespaceParam: string; /** @description Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. */ readonly MetafieldNamespaceInParam: readonly string[]; - /** @description Controls the number of items per page in a limited (paginated) list of results. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of results. */ readonly LimitParam: number; - /** @description Sort direction. Acceptable values are: `asc`, `desc`. - * */ + /** @description Sort direction. Acceptable values are: `asc`, `desc`. */ readonly DirectionParam: "asc" | "desc"; - /** @description 'Query parameter that lets you filter by the minimum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.' - * */ + /** @description 'Query parameter that lets you filter by the minimum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.' */ readonly date_created_min: string; - /** @description 'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.' - * */ + /** @description 'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.' */ readonly date_created_max: string; - /** @description 'Query parameter that lets you filter by the maximum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.' - * */ + /** @description 'Query parameter that lets you filter by the maximum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.' */ readonly date_modified_max: string; - /** @description 'Query parameter that lets you filter by the minimum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.' - * */ + /** @description 'Query parameter that lets you filter by the minimum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.' */ readonly date_modified_min: string; /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */ readonly IncludeFieldsParam: readonly string[]; @@ -1141,15 +1048,13 @@ export interface components { readonly KeywordParam: string; /** @description Filter items based on whether the product is currently visible on the storefront. */ readonly IsVisibleParam: boolean; - /** @description Filter items by name. - * */ + /** @description Filter items by name. */ readonly NameParam: string; /** @description Filter items by substring in the name property. `name:like=stick` returns both `Stickers` and `Lipstick colors`. */ readonly NameLikeParam: string; /** @description Filter items by substring in the page title property. `page_title:like=oil` returns both `Soil and mulch` and `Oil pastels`. */ readonly PageTitleLikeParam: string; - /** @description Filter items by page_title. - * */ + /** @description Filter items by page_title. */ readonly PageTitleParam: string; readonly ParentIdInParam: readonly number[]; /** @description Filter items by parent_id. If the category is a child or sub-category it can be filtered with the parent_id. */ @@ -1158,8 +1063,7 @@ export interface components { readonly ParentIdMaxParam: number; readonly ParentIdGreaterParam: number; readonly ParentIdLessParam: number; - /** @description Filter items by category ID. - * */ + /** @description Filter items by category ID. */ readonly IdCategoryQueryParam: number; /** @description Explicitly include objects by passing a comma-separated list of IDs. */ readonly IdInParam: readonly number[]; @@ -1179,8 +1083,7 @@ export interface operations { readonly getCategories: { readonly parameters: { readonly query?: { - /** @description Filter items by category ID. - * */ + /** @description Filter items by category ID. */ readonly id?: components["parameters"]["IdCategoryQueryParam"]; /** @description Explicitly include objects by passing a comma-separated list of IDs. */ readonly "id:in"?: components["parameters"]["IdInParam"]; @@ -1190,8 +1093,7 @@ export interface operations { readonly "id:max"?: components["parameters"]["IdMaxParam"]; readonly "id:greater"?: components["parameters"]["IdGreaterParam"]; readonly "id:less"?: components["parameters"]["IdLessParam"]; - /** @description Filter items by name. - * */ + /** @description Filter items by name. */ readonly name?: components["parameters"]["NameParam"]; /** @description Filter items by substring in the name property. `name:like=stick` returns both `Stickers` and `Lipstick colors`. */ readonly "name:like"?: components["parameters"]["NameLikeParam"]; @@ -1202,8 +1104,7 @@ export interface operations { readonly "parent_id:max"?: components["parameters"]["ParentIdMaxParam"]; readonly "parent_id:greater"?: components["parameters"]["ParentIdGreaterParam"]; readonly "parent_id:less"?: components["parameters"]["ParentIdLessParam"]; - /** @description Filter items by page_title. - * */ + /** @description Filter items by page_title. */ readonly page_title?: components["parameters"]["PageTitleParam"]; /** @description Filter items by substring in the page title property. `page_title:like=oil` returns both `Soil and mulch` and `Oil pastels`. */ readonly "page_title:like"?: components["parameters"]["PageTitleLikeParam"]; @@ -1211,19 +1112,19 @@ export interface operations { readonly keyword?: components["parameters"]["KeywordParam"]; /** @description Filter items based on whether the product is currently visible on the storefront. */ readonly is_visible?: components["parameters"]["IsVisibleParam"]; - /** @description Controls the sort order of the response, for example, `sort=name`. + /** + * @description Controls the sort order of the response, for example, `sort=name`. * * Allowed values: * - `name`: sort categories in alphabetical order by category name. * - `id`: sort in ascending order by category ID. * - `parent_id`: sort in ascending order by the ID of the parent category. - * - `sort_order`: sort in ascending order by sort order value. */ + * - `sort_order`: sort in ascending order by sort order value. + */ readonly sort?: components["parameters"]["SortParam"]; - /** @description Specifies the page number in a limited (paginated) list of results. - * */ + /** @description Specifies the page number in a limited (paginated) list of results. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of results. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of results. */ readonly limit?: components["parameters"]["LimitParam"]; /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */ readonly include_fields?: components["parameters"]["IncludeFieldsParam"]; @@ -1244,7 +1145,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": [ * { * "id": 19, @@ -1391,7 +1293,8 @@ export interface operations { * } * } * } - * } */ + * } + */ readonly "application/json": { readonly data?: readonly components["schemas"]["Category"][]; readonly meta?: components["schemas"]["metaCollection_Full"]; @@ -1428,55 +1331,44 @@ export interface operations { readonly name: string; /** * @description The category description, which can include HTML formatting. - * * @example

We offer a wide variety of products perfect for relaxing

*/ readonly description?: string; /** * @description Number of views the category has on the storefront. - * * @example 1050 */ readonly views?: number; /** * @description Priority this category will be given when included in the menu and category pages. The lower the number, the closer to the top of the results the category will be. - * * @example 3 */ readonly sort_order?: number; /** * @description Custom title for the category page. If not defined, the category name will be used as the meta title. - * * @example Bath */ readonly page_title?: string; - /** @description A comma-separated list of keywords that can be used to locate the category when searching the store. - * */ + /** @description A comma-separated list of keywords that can be used to locate the category when searching the store. */ readonly search_keywords?: string; - /** @description Custom meta keywords for the category page. If not defined, the storeʼs default keywords will be used. Must post as an array like: ["awesome","sauce"]. - * */ + /** @description Custom meta keywords for the category page. If not defined, the storeʼs default keywords will be used. Must post as an array like: ["awesome","sauce"]. */ readonly meta_keywords?: readonly string[]; - /** @description Custom meta description for the category page. If not defined, the storeʼs default meta description will be used. - * */ + /** @description Custom meta description for the category page. If not defined, the storeʼs default meta description will be used. */ readonly meta_description?: string; /** * @description A valid layout file. Please refer to [the article on creating category files (Help Center)](https://support.bigcommerce.com/articles/Public/Creating-Custom-Template-Files/). This field is writable only for stores with a Blueprint theme applied. For stores with a Stencil theme applied, see [Custom Template Associations](/docs/rest-content/custom-template-associations). - * * @example category.html */ readonly layout_file?: string; - /** @description Flag to determine whether the category should be displayed to customers browsing the store. If `true`, the category will be displayed. If `false`, the category will be hidden from view. - * */ + /** @description Flag to determine whether the category should be displayed to customers browsing the store. If `true`, the category will be displayed. If `false`, the category will be hidden from view. */ readonly is_visible?: boolean; /** * @description Determines how the products are sorted on category page load. - * * @enum {string} */ readonly default_product_sort?: "use_store_settings" | "featured" | "newest" | "best_selling" | "alpha_asc" | "alpha_desc" | "avg_customer_review" | "price_asc" | "price_desc"; /** * @description Image URL used for this category on the storefront. Images can be uploaded using form file post to `/categories/{categoryId}/image`, or by providing a publicly accessible URL in this field. An image extension like .jpg or .png is required. - * * @example https://cdn8.bigcommerce.com/s-123456/product_images/d/fakeimage.png */ readonly image_url?: string; @@ -1487,12 +1379,10 @@ export interface operations { readonly custom_url?: { /** * @description Category URL on the storefront. - * * @example /shoes */ readonly url?: string; - /** @description Returns `true` if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides). - * */ + /** @description Returns `true` if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides). */ readonly is_customized?: boolean; }; }; @@ -1519,8 +1409,7 @@ export interface operations { readonly "application/json": components["schemas"]["error_Base"]; }; }; - /** @description The `Category` was in conflict with another category. This is the result of duplicate unique values, such as `name` or `custom_url`. - * */ + /** @description The `Category` was in conflict with another category. This is the result of duplicate unique values, such as `name` or `custom_url`. */ readonly 409: { headers: { readonly [name: string]: unknown; @@ -1532,18 +1421,15 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; }; }; - /** @description The `Category` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description The `Category` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -1555,11 +1441,9 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -1570,8 +1454,7 @@ export interface operations { readonly deleteCategories: { readonly parameters: { readonly query?: { - /** @description Filter items by category ID. - * */ + /** @description Filter items by category ID. */ readonly id?: components["parameters"]["IdCategoryQueryParam"]; /** @description Explicitly include objects by passing a comma-separated list of IDs. */ readonly "id:in"?: components["parameters"]["IdInParam"]; @@ -1581,13 +1464,11 @@ export interface operations { readonly "id:max"?: components["parameters"]["IdMaxParam"]; readonly "id:greater"?: components["parameters"]["IdGreaterParam"]; readonly "id:less"?: components["parameters"]["IdLessParam"]; - /** @description Filter items by name. - * */ + /** @description Filter items by name. */ readonly name?: components["parameters"]["NameParam"]; /** @description Filter items by parent_id. If the category is a child or sub-category it can be filtered with the parent_id. */ readonly parent_id?: components["parameters"]["ParentIdParam"]; - /** @description Filter items by page_title. - * */ + /** @description Filter items by page_title. */ readonly page_title?: components["parameters"]["PageTitleParam"]; /** @description Filter items by keywords found in the `name`, `description`, or `sku` fields, or in the brand name. */ readonly keyword?: components["parameters"]["KeywordParam"]; @@ -1633,8 +1514,7 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Category` to which the resource belongs. - * */ + /** @description The ID of the `Category` to which the resource belongs. */ readonly category_id: components["parameters"]["CategoryIdParam"]; }; readonly cookie?: never; @@ -1652,16 +1532,14 @@ export interface operations { }; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -1682,8 +1560,7 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Category` to which the resource belongs. - * */ + /** @description The ID of the `Category` to which the resource belongs. */ readonly category_id: components["parameters"]["CategoryIdParam"]; }; readonly cookie?: never; @@ -1691,8 +1568,10 @@ export interface operations { readonly requestBody: { readonly content: { readonly "application/json": { - /** @description Unique ID of the *Category*. Increments sequentially. - * Read-Only. */ + /** + * @description Unique ID of the *Category*. Increments sequentially. + * Read-Only. + */ readonly id?: number; /** * @description The unique numeric ID of the categoryʼs parent. This field controls where the category sits in the tree of categories that organize the catalog. @@ -1707,55 +1586,44 @@ export interface operations { readonly name: string; /** * @description The product description, which can include HTML formatting. - * * @example

We offer a wide variety of products perfect for relaxing

*/ readonly description?: string; /** * @description Number of views the category has on the storefront. - * * @example 1050 */ readonly views?: number; /** * @description Priority this category will be given when included in the menu and category pages. The lower the number, the closer to the top of the results the category will be. - * * @example 3 */ readonly sort_order?: number; /** * @description Custom title for the category page. If not defined, the category name will be used as the meta title. - * * @example Bath */ readonly page_title?: string; - /** @description A comma-separated list of keywords that can be used to locate the category when searching the store. - * */ + /** @description A comma-separated list of keywords that can be used to locate the category when searching the store. */ readonly search_keywords?: string; - /** @description Custom meta keywords for the category page. If not defined, the storeʼs default keywords will be used. Must post as an array like: ["awesome","sauce"]. - * */ + /** @description Custom meta keywords for the category page. If not defined, the storeʼs default keywords will be used. Must post as an array like: ["awesome","sauce"]. */ readonly meta_keywords?: readonly string[]; - /** @description Custom meta description for the category page. If not defined, the storeʼs default meta description will be used. - * */ + /** @description Custom meta description for the category page. If not defined, the storeʼs default meta description will be used. */ readonly meta_description?: string; /** * @description A valid layout file. Please refer to [the article on creating category files (Help Center)](https://support.bigcommerce.com/articles/Public/Creating-Custom-Template-Files/). This field is writable only for stores with a Blueprint theme applied. For stores with a Stencil theme applied, see [Custom Template Associations](/docs/rest-content/custom-template-associations). - * * @example category.html */ readonly layout_file?: string; - /** @description Flag to determine whether the product should be displayed to customers browsing the store. If `true`, the category will be displayed. If `false`, the category will be hidden from view. - * */ + /** @description Flag to determine whether the product should be displayed to customers browsing the store. If `true`, the category will be displayed. If `false`, the category will be hidden from view. */ readonly is_visible?: boolean; /** * @description Determines how the products are sorted on category page load. - * * @enum {string} */ readonly default_product_sort?: "use_store_settings" | "featured" | "newest" | "best_selling" | "alpha_asc" | "alpha_desc" | "avg_customer_review" | "price_asc" | "price_desc"; /** * @description Image URL used for this category on the storefront. Images can be uploaded using form file post to `/categories/{categoryId}/image`, or by providing a publicly accessible URL in this field. An image extension like .jpg or .png is required. - * * @example https://cdn8.bigcommerce.com/s-123456/product_images/d/fakeimage.png */ readonly image_url?: string; @@ -1766,12 +1634,10 @@ export interface operations { readonly custom_url?: { /** * @description Category URL on the storefront. - * * @example /shoes */ readonly url?: string; - /** @description Returns `true` if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides). - * */ + /** @description Returns `true` if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides). */ readonly is_customized?: boolean; }; }; @@ -1789,8 +1655,10 @@ export interface operations { * @description Common Category object properties. */ readonly data?: { - /** @description Unique ID of the *Category*. Increments sequentially. - * Read-Only. */ + /** + * @description Unique ID of the *Category*. Increments sequentially. + * Read-Only. + */ readonly id?: number; /** * @description The unique numeric ID of the categoryʼs parent. This field controls where the category sits in the tree of categories that organize the catalog. @@ -1806,55 +1674,44 @@ export interface operations { readonly name?: string; /** * @description The product description, which can include HTML formatting. - * * @example

We offer a wide variety of products perfect for relaxing

*/ readonly description?: string; /** * @description Number of views the category has on the storefront. - * * @example 1050 */ readonly views?: number; /** * @description Priority this category will be given when included in the menu and category pages. The lower the number, the closer to the top of the results the category will be. - * * @example 3 */ readonly sort_order?: number; /** * @description Custom title for the category page. If not defined, the category name will be used as the meta title. - * * @example Bath */ readonly page_title?: string; - /** @description A comma-separated list of keywords that can be used to locate the category when searching the store. - * */ + /** @description A comma-separated list of keywords that can be used to locate the category when searching the store. */ readonly search_keywords?: string; - /** @description Custom meta keywords for the category page. If not defined, the storeʼs default keywords will be used. Must post as an array like: ["awesome","sauce"]. - * */ + /** @description Custom meta keywords for the category page. If not defined, the storeʼs default keywords will be used. Must post as an array like: ["awesome","sauce"]. */ readonly meta_keywords?: readonly string[]; - /** @description Custom meta description for the category page. If not defined, the storeʼs default meta description will be used. - * */ + /** @description Custom meta description for the category page. If not defined, the storeʼs default meta description will be used. */ readonly meta_description?: string; /** * @description A valid layout file. Please refer to [the article on creating category files (Help Center)](https://support.bigcommerce.com/articles/Public/Creating-Custom-Template-Files/). This field is writable only for stores with a Blueprint theme applied. For stores with a Stencil theme applied, see [Custom Template Associations](/docs/rest-content/custom-template-associations). - * * @example category.html */ readonly layout_file?: string; - /** @description Flag to determine whether the product should be displayed to customers browsing the store. If `true`, the category will be displayed. If `false`, the category will be hidden from view. - * */ + /** @description Flag to determine whether the product should be displayed to customers browsing the store. If `true`, the category will be displayed. If `false`, the category will be hidden from view. */ readonly is_visible?: boolean; /** * @description Determines how the products are sorted on category page load. - * * @enum {string} */ readonly default_product_sort?: "use_store_settings" | "featured" | "newest" | "best_selling" | "alpha_asc" | "alpha_desc" | "avg_customer_review" | "price_asc" | "price_desc"; /** * @description Image URL used for this category on the storefront. Images can be uploaded using form file post to `/categories/{categoryId}/image`, or by providing a publicly accessible URL in this field. An image extension like .jpg or .png is required. - * * @example https://cdn8.bigcommerce.com/s-123456/product_images/d/fakeimage.png */ readonly image_url?: string; @@ -1865,12 +1722,10 @@ export interface operations { readonly custom_url?: { /** * @description Category URL on the storefront. - * * @example /shoes */ readonly url?: string; - /** @description Returns `true` if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides). - * */ + /** @description Returns `true` if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides). */ readonly is_customized?: boolean; }; }; @@ -1890,8 +1745,7 @@ export interface operations { }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -1912,11 +1766,9 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -1934,11 +1786,9 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -1954,8 +1804,7 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Category` to which the resource belongs. - * */ + /** @description The ID of the `Category` to which the resource belongs. */ readonly category_id: components["parameters"]["CategoryIdParam"]; }; readonly cookie?: never; @@ -1973,8 +1822,7 @@ export interface operations { readonly getCategoryMetafields: { readonly parameters: { readonly query?: { - /** @description Filter items by metafield ID. - * */ + /** @description Filter items by metafield ID. */ readonly id?: components["parameters"]["IdMetafieldQueryParam"]; /** @description Explicitly include objects by passing a comma-separated list of IDs. */ readonly "id:in"?: components["parameters"]["IdInParam"]; @@ -1988,11 +1836,9 @@ export interface operations { readonly key?: components["parameters"]["MetafieldKeyParam"]; /** @description Filter based on a metafieldʼs namespaces. */ readonly namespace?: components["parameters"]["MetafieldNamespaceParam"]; - /** @description Specifies the page number in a limited (paginated) list of results. - * */ + /** @description Specifies the page number in a limited (paginated) list of results. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of results. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of results. */ readonly limit?: components["parameters"]["LimitParam"]; /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */ readonly include_fields?: components["parameters"]["IncludeFieldsParam"]; @@ -2004,8 +1850,7 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Category` to which the resource belongs. - * */ + /** @description The ID of the `Category` to which the resource belongs. */ readonly category_id: components["parameters"]["CategoryIdParam"]; }; readonly cookie?: never; @@ -2017,7 +1862,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": [ * { * "id": 6, @@ -2056,7 +1902,8 @@ export interface operations { * } * } * } - * } */ + * } + */ readonly "application/json": { readonly data?: readonly components["schemas"]["metafield_Full"][]; readonly meta?: components["schemas"]["metaCollection_Full"]; @@ -2075,8 +1922,7 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Category` to which the resource belongs. - * */ + /** @description The ID of the `Category` to which the resource belongs. */ readonly category_id: components["parameters"]["CategoryIdParam"]; }; readonly cookie?: never; @@ -2092,7 +1938,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 4, * "key": "location_id", @@ -2106,7 +1953,8 @@ export interface operations { * "date_modified": "2021-08-06T19:15:35+00:00" * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: components["schemas"]["metafield_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; @@ -2119,12 +1967,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2133,8 +1983,7 @@ export interface operations { }; }; }; - /** @description The `Metafield` was in conflict with another `Metafield`. This can be the result of duplicate, unique key combinations of the appʼs client id, namespace, key, resource_type, and resource_id. - * */ + /** @description The `Metafield` was in conflict with another `Metafield`. This can be the result of duplicate, unique key combinations of the appʼs client id, namespace, key, resource_type, and resource_id. */ readonly 409: { headers: { readonly [name: string]: unknown; @@ -2146,18 +1995,15 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; }; }; - /** @description The `Metafield` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description The `Metafield` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -2169,11 +2015,9 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -2194,11 +2038,9 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Category` to which the resource belongs. - * */ + /** @description The ID of the `Category` to which the resource belongs. */ readonly category_id: components["parameters"]["CategoryIdParam"]; - /** @description The ID of the `Metafield`. - * */ + /** @description The ID of the `Metafield`. */ readonly metafield_id: components["parameters"]["MetafieldIdParam"]; }; readonly cookie?: never; @@ -2210,7 +2052,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 4, * "key": "location_id", @@ -2224,7 +2067,8 @@ export interface operations { * "date_modified": "2021-08-06T19:15:35+00:00" * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: components["schemas"]["metafield_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; @@ -2238,8 +2082,7 @@ export interface operations { }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -2260,11 +2103,9 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Category` to which the resource belongs. - * */ + /** @description The ID of the `Category` to which the resource belongs. */ readonly category_id: components["parameters"]["CategoryIdParam"]; - /** @description The ID of the `Metafield`. - * */ + /** @description The ID of the `Metafield`. */ readonly metafield_id: components["parameters"]["MetafieldIdParam"]; }; readonly cookie?: never; @@ -2280,7 +2121,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 4, * "key": "location_id", @@ -2294,7 +2136,8 @@ export interface operations { * "date_modified": "2021-08-06T19:15:35+00:00" * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: components["schemas"]["metafield_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; @@ -2307,12 +2150,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2321,16 +2166,14 @@ export interface operations { }; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -2349,11 +2192,9 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Category` to which the resource belongs. - * */ + /** @description The ID of the `Category` to which the resource belongs. */ readonly category_id: components["parameters"]["CategoryIdParam"]; - /** @description The ID of the `Metafield`. - * */ + /** @description The ID of the `Metafield`. */ readonly metafield_id: components["parameters"]["MetafieldIdParam"]; }; readonly cookie?: never; @@ -2366,16 +2207,14 @@ export interface operations { }; content?: never; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -2394,8 +2233,7 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Category` to which the resource belongs. - * */ + /** @description The ID of the `Category` to which the resource belongs. */ readonly category_id: components["parameters"]["CategoryIdParam"]; }; readonly cookie?: never; @@ -2414,12 +2252,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "image_url": "https://cdn11.bigcommerce.com/s-{store_hash}/product_images/k/group_1545334669__76009.png" * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: { readonly image_url?: string; @@ -2439,16 +2279,14 @@ export interface operations { }; readonly 401: components["responses"]["UnauthorizedError"]; readonly 403: components["responses"]["Forbidden"]; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -2457,8 +2295,7 @@ export interface operations { }; }; }; - /** @description Image was not valid. This is the result of a missing `image_file` field or an incorrect file type. See the response for more details. - * */ + /** @description Image was not valid. This is the result of a missing `image_file` field or an incorrect file type. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -2470,11 +2307,9 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -2490,8 +2325,7 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Category` to which the resource belongs. - * */ + /** @description The ID of the `Category` to which the resource belongs. */ readonly category_id: components["parameters"]["CategoryIdParam"]; }; readonly cookie?: never; @@ -2506,16 +2340,14 @@ export interface operations { }; readonly 401: components["responses"]["UnauthorizedError"]; readonly 403: components["responses"]["Forbidden"]; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -2529,8 +2361,7 @@ export interface operations { readonly getCategorySortOrders: { readonly parameters: { readonly query?: { - /** @description Specifies the page number in a limited (paginated) list of results. - * */ + /** @description Specifies the page number in a limited (paginated) list of results. */ readonly page?: components["parameters"]["PageParam"]; }; readonly header?: { @@ -2538,8 +2369,7 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Category` to which the resource belongs. - * */ + /** @description The ID of the `Category` to which the resource belongs. */ readonly category_id: components["parameters"]["CategoryIdParam"]; }; readonly cookie?: never; @@ -2573,8 +2403,7 @@ export interface operations { readonly updateCategorySortOrders: { readonly parameters: { readonly query?: { - /** @description Specifies the page number in a limited (paginated) list of results. - * */ + /** @description Specifies the page number in a limited (paginated) list of results. */ readonly page?: components["parameters"]["PageParam"]; }; readonly header?: { @@ -2584,8 +2413,7 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Category` to which the resource belongs. - * */ + /** @description The ID of the `Category` to which the resource belongs. */ readonly category_id: components["parameters"]["CategoryIdParam"]; }; readonly cookie?: never; @@ -2616,11 +2444,13 @@ export interface operations { }; }; readonly 415: components["responses"]["Unsupported"]; - /** @description Unprocessable entity. + /** + * @description Unprocessable entity. * * Please verify if all requested products are assigned to the category. * - * Please verify if all required fields are present in the request body and are filled with values correctly. */ + * Please verify if all required fields are present in the request body and are filled with values correctly. + */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -2634,11 +2464,9 @@ export interface operations { readonly getCategoriesMetafields: { readonly parameters: { readonly query?: { - /** @description Specifies the page number in a limited (paginated) list of results. - * */ + /** @description Specifies the page number in a limited (paginated) list of results. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of results. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of results. */ readonly limit?: components["parameters"]["LimitParam"]; /** @description Filter based on a metafieldʼs key. */ readonly key?: components["parameters"]["MetafieldKeyParam"]; @@ -2648,22 +2476,17 @@ export interface operations { readonly namespace?: components["parameters"]["MetafieldNamespaceParam"]; /** @description Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. */ readonly "namespace:in"?: components["parameters"]["MetafieldNamespaceInParam"]; - /** @description Sort direction. Acceptable values are: `asc`, `desc`. - * */ + /** @description Sort direction. Acceptable values are: `asc`, `desc`. */ readonly direction?: components["parameters"]["DirectionParam"]; /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */ readonly include_fields?: components["parameters"]["IncludeFieldsParamMetafields"]; - /** @description 'Query parameter that lets you filter by the minimum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.' - * */ + /** @description 'Query parameter that lets you filter by the minimum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.' */ readonly "date_modified:min"?: components["parameters"]["date_modified_min"]; - /** @description 'Query parameter that lets you filter by the maximum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.' - * */ + /** @description 'Query parameter that lets you filter by the maximum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.' */ readonly "date_modified:max"?: components["parameters"]["date_modified_max"]; - /** @description 'Query parameter that lets you filter by the minimum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.' - * */ + /** @description 'Query parameter that lets you filter by the minimum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.' */ readonly "date_created:min"?: components["parameters"]["date_created_min"]; - /** @description 'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.' - * */ + /** @description 'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.' */ readonly "date_created:max"?: components["parameters"]["date_created_max"]; }; readonly header?: { @@ -2675,8 +2498,7 @@ export interface operations { }; readonly requestBody?: never; readonly responses: { - /** @description List of `Metafield` objects. - * */ + /** @description List of `Metafield` objects. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -2704,7 +2526,6 @@ export interface operations { readonly "application/json": readonly (components["schemas"]["MetafieldBase_Put"] & { /** * @description The ID of metafield to update. - * * @example 42 */ readonly id: number; @@ -2712,8 +2533,7 @@ export interface operations { }; }; readonly responses: { - /** @description List of updated `Metafield` objects. - * */ + /** @description List of updated `Metafield` objects. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -2728,12 +2548,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2742,8 +2564,7 @@ export interface operations { }; }; }; - /** @description Response object for metafields creation with partial success. - * */ + /** @description Response object for metafields creation with partial success. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -2771,7 +2592,6 @@ export interface operations { readonly "application/json": readonly (components["schemas"]["MetafieldBase_Post"] & { /** * @description The ID for the category with which the metafield is associated. - * * @example 42 */ readonly resource_id: number; @@ -2779,8 +2599,7 @@ export interface operations { }; }; readonly responses: { - /** @description List of created `Metafield` objects. - * */ + /** @description List of created `Metafield` objects. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -2795,12 +2614,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2809,8 +2630,7 @@ export interface operations { }; }; }; - /** @description Response object for metafields creation with partial success. - * */ + /** @description Response object for metafields creation with partial success. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -2838,8 +2658,7 @@ export interface operations { }; }; readonly responses: { - /** @description Response object for metafields deletion with success. - * */ + /** @description Response object for metafields deletion with success. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -2854,12 +2673,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2868,8 +2689,7 @@ export interface operations { }; }; }; - /** @description Response object for metafields deletion with partial success. - * */ + /** @description Response object for metafields deletion with partial success. */ readonly 422: { headers: { readonly [name: string]: unknown; diff --git a/src/internal/reference/generated/catalog/category_trees_catalog.v3.ts b/src/internal/reference/generated/catalog/category_trees_catalog.v3.ts index aeb60db..918d239 100644 --- a/src/internal/reference/generated/catalog/category_trees_catalog.v3.ts +++ b/src/internal/reference/generated/catalog/category_trees_catalog.v3.ts @@ -76,7 +76,6 @@ export interface paths { * **Usage Notes** * * 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. - * */ readonly put: operations["upsertCategoryTrees"]; /** @@ -154,61 +153,50 @@ export interface components { readonly CategoryBase: { /** * @description The product description, which can include HTML formatting. - * * @example

We offer a wide variety of products perfect for relaxing

*/ readonly description?: string; /** * @description Number of views the category has on the storefront. - * * @example 1050 */ readonly views?: number; /** * @description Priority this category will be given when included in the menu and category pages. The lower the number, the closer to the top of the results the category will be. - * * @example 3 */ readonly sort_order?: number; /** * @description Custom title for the category page. If not defined, the category name will be used as the meta title. - * * @example Bath */ readonly page_title?: string; /** * @description Custom meta keywords for the category page. If not defined, the storeʼs default keywords will be used. Must post as an array like: ["awesome","sauce"]. - * * @example [ * "shower", * "tub" * ] */ readonly meta_keywords?: readonly string[]; - /** @description Custom meta description for the category page. If not defined, the storeʼs default meta description will be used. - * */ + /** @description Custom meta description for the category page. If not defined, the storeʼs default meta description will be used. */ readonly meta_description?: string; /** * @description A valid layout file. (Please refer to [this article](https://support.bigcommerce.com/articles/Public/Creating-Custom-Template-Files/) on creating category files.) This field is writable only for stores with a Blueprint theme applied. - * * @example category.html */ readonly layout_file?: string; /** * @description Image URL used for this category on the storefront. Images can be uploaded via form file post to `/categories/{categoryId}/image`, or by providing a publicly accessible URL in this field. Must be either a full-qualified URL or an empty string. - * * @example https://cdn8.bigcommerce.com/s-123456/product_images/d/fakeimage.png */ readonly image_url?: string; - /** @description Flag to determine whether the product should be displayed to customers browsing the store. If `true`, the category will be displayed. If `false`, the category will be hidden from view. - * */ + /** @description Flag to determine whether the product should be displayed to customers browsing the store. If `true`, the category will be displayed. If `false`, the category will be hidden from view. */ readonly is_visible?: boolean; - /** @description A comma-separated list of keywords that can be used to locate the category when searching the store. - * */ + /** @description A comma-separated list of keywords that can be used to locate the category when searching the store. */ readonly search_keywords?: string; /** * @description Determines how the products are sorted on category page load. - * * @enum {string} */ readonly default_product_sort?: "use_store_settings" | "featured" | "newest" | "best_selling" | "alpha_asc" | "alpha_desc" | "avg_customer_review" | "price_asc" | "price_desc"; @@ -255,11 +243,9 @@ export interface components { readonly errors?: readonly components["schemas"]["ErrorBasic"][]; }; readonly ErrorBasic: { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -297,7 +283,8 @@ export interface components { readonly name?: string; readonly channels?: readonly number[]; }; - /** @example [ + /** + * @example [ * { * "id": 0, * "name": "string", @@ -305,7 +292,8 @@ export interface components { * 0 * ] * } - * ] */ + * ] + */ readonly CategoryTreeListRequest: readonly components["schemas"]["Tree"][]; readonly CategoryNode: { readonly id?: number; @@ -340,14 +328,11 @@ export interface components { readonly beta4DetailedErrors: { readonly [key: string]: unknown; }; - /** @description Error payload for the BigCommerce API. - * */ + /** @description Error payload for the BigCommerce API. */ readonly BaseError: { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; @@ -358,7 +343,6 @@ export interface components { /** * URL * @description If not provided in POST request, the URL is autogenerated from the category name. - * */ readonly url: { /** @example /bath/ */ @@ -471,11 +455,9 @@ export interface components { readonly Accept: string; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly ContentType: string; - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly PageParam: number; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly LimitParam: number; /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */ readonly IncludeFieldsParam: readonly string[]; @@ -485,15 +467,13 @@ export interface components { readonly KeywordParam: string; /** @description Filter items based on whether the product is currently visible on the storefront. */ readonly IsVisibleParam: boolean; - /** @description Filter items by name. - * */ + /** @description Filter items by name. */ readonly NameParam: string; /** @description Filter items by substring in the name property. `name:like=stick` returns both `Stickers` and `Lipstick colors`. */ readonly NameLikeParam: string; /** @description Filter items by substring in the page title property. `page_title:like=oil` returns both `Soil and mulch` and `Oil pastels`. */ readonly PageTitleLikeParam: string; - /** @description Filter items by page_title. - * */ + /** @description Filter items by page_title. */ readonly PageTitleParam: string; /** @description The ID of the category tree. */ readonly TreeIdParam: number; @@ -539,13 +519,11 @@ export interface operations { readonly "tree_id:not_in"?: components["parameters"]["TreeIdNotInParam"]; readonly "parent_id:in"?: components["parameters"]["ParentIdInParam"]; readonly "parent_id:not_in"?: components["parameters"]["ParentIdNotInParam"]; - /** @description Filter items by page_title. - * */ + /** @description Filter items by page_title. */ readonly page_title?: components["parameters"]["PageTitleParam"]; /** @description Filter items by substring in the page title property. `page_title:like=oil` returns both `Soil and mulch` and `Oil pastels`. */ readonly "page_title:like"?: components["parameters"]["PageTitleLikeParam"]; - /** @description Filter items by name. - * */ + /** @description Filter items by name. */ readonly name?: components["parameters"]["NameParam"]; /** @description Filter items by substring in the name property. `name:like=stick` returns both `Stickers` and `Lipstick colors`. */ readonly "name:like"?: components["parameters"]["NameLikeParam"]; @@ -557,11 +535,9 @@ export interface operations { readonly include_fields?: components["parameters"]["IncludeFieldsParam"]; /** @description Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded. */ readonly exclude_fields?: components["parameters"]["ExcludeFieldsParam"]; - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; }; readonly header?: { @@ -770,7 +746,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": [ * { * "id": 0, @@ -793,7 +770,8 @@ export interface operations { * } * } * } - * } */ + * } + */ readonly "application/json": components["schemas"]["CategoryTreeList"]; }; }; @@ -826,7 +804,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": [ * { * "id": 0, @@ -837,7 +816,8 @@ export interface operations { * } * ], * "meta": {} - * } */ + * } + */ readonly "application/json": components["schemas"]["CategoryTree"]; }; }; @@ -849,7 +829,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 0, * "title": "string", * "type": "string", @@ -859,7 +840,8 @@ export interface operations { * "additionalProp2": "string", * "additionalProp3": "string" * } - * } */ + * } + */ readonly "application/json": components["schemas"]["beta4ErrorResponse"]; }; }; @@ -916,7 +898,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": [ * { * "id": 0, @@ -938,7 +921,8 @@ export interface operations { * "properties": {}, * "description": "Empty meta object; reserved for use later." * } - * } */ + * } + */ readonly "application/json": components["schemas"]["CategoryNodeTree"]; }; }; @@ -950,7 +934,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 0, * "title": "string", * "type": "string", @@ -960,7 +945,8 @@ export interface operations { * "additionalProp2": "string", * "additionalProp3": "string" * } - * } */ + * } + */ readonly "application/json": components["schemas"]["beta4ErrorResponse"]; }; }; diff --git a/src/internal/reference/generated/catalog/product_modifiers_catalog.v3.ts b/src/internal/reference/generated/catalog/product_modifiers_catalog.v3.ts index 3658b46..5ca16f4 100644 --- a/src/internal/reference/generated/catalog/product_modifiers_catalog.v3.ts +++ b/src/internal/reference/generated/catalog/product_modifiers_catalog.v3.ts @@ -12,8 +12,7 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the product to which the resource belongs. - * */ + /** @description The ID of the product to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; }; readonly cookie?: never; @@ -37,6 +36,8 @@ export interface paths { * * **Notes** * It takes two separate requests to create a new checkbox modifier with option values. Perform a request to create a modifier, then perform a second request to update option values. + * + * Date modifiers are required to be provided in [ISO-8601 ATOM](https://www.php.net/manual/en/class.datetimeinterface.php#datetimeinterface.constants.atom) format. Excluding them in a request will throw a server error. */ readonly post: operations["createProductModifier"]; }; @@ -48,11 +49,9 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the product to which the resource belongs. - * */ + /** @description The ID of the product to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the product modifier. - * */ + /** @description The ID of the product modifier. */ readonly modifier_id: components["parameters"]["ModifierIdParam"]; }; readonly cookie?: never; @@ -65,6 +64,8 @@ export interface paths { /** * Update a product modifier * @description Updates a product modifier. + * + * Date modifiers are required to be provided in [ISO-8601 ATOM](https://www.php.net/manual/en/class.datetimeinterface.php#datetimeinterface.constants.atom) format. Excluding them in a request will throw a server error. */ readonly put: operations["updateProductModifier"]; /** @@ -81,11 +82,9 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the product to which the resource belongs. - * */ + /** @description The ID of the product to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the product modifier. - * */ + /** @description The ID of the product modifier. */ readonly modifier_id: components["parameters"]["ModifierIdParam"]; }; readonly cookie?: never; @@ -116,14 +115,11 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the product to which the resource belongs. - * */ + /** @description The ID of the product to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the product modifier. - * */ + /** @description The ID of the product modifier. */ readonly modifier_id: components["parameters"]["ModifierIdParam"]; - /** @description The ID of the product modifier value. - * */ + /** @description The ID of the product modifier value. */ readonly value_id: components["parameters"]["ValueIdParam"]; }; readonly cookie?: never; @@ -158,14 +154,11 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the product to which the resource belongs. - * */ + /** @description The ID of the product to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the product modifier. - * */ + /** @description The ID of the product modifier. */ readonly modifier_id: components["parameters"]["ModifierIdParam"]; - /** @description The ID of the product modifier value. - * */ + /** @description The ID of the product modifier value. */ readonly value_id: components["parameters"]["ValueIdParam"]; }; readonly cookie?: never; @@ -192,12 +185,10 @@ export interface components { readonly productModifier_Base: { /** * @description BigCommerce API, which determines how it will display on the storefront. Acceptable values: `date`, `checkbox`, `file`, `text`, `multi_line_text`, `numbers_only_text`, `radio_buttons`, `rectangles`, `dropdown`, `product_list`, `product_list_with_images`, `swatch`. Required in a /POST. - * * @enum {string} */ readonly type: "date" | "checkbox" | "file" | "text" | "multi_line_text" | "numbers_only_text" | "radio_buttons" | "rectangles" | "dropdown" | "product_list" | "product_list_with_images" | "swatch"; - /** @description Whether or not this modifier is required at checkout. Required in a /POST. - * */ + /** @description Whether or not this modifier is required at checkout. Required in a /POST. */ readonly required: boolean; /** @description The order the modifiers display on the product detail page. */ readonly sort_order?: number; @@ -212,39 +203,36 @@ export interface components { readonly productModifier_Post: { /** * @description BigCommerce API, which determines how it will display on the storefront. Acceptable values: `date`, `checkbox`, `file`, `text`, `multi_line_text`, `numbers_only_text`, `radio_buttons`, `rectangles`, `dropdown`, `product_list`, `product_list_with_images`, `swatch`. Required in a /POST. - * * @enum {string} */ readonly type: "date" | "checkbox" | "file" | "text" | "multi_line_text" | "numbers_only_text" | "radio_buttons" | "rectangles" | "dropdown" | "product_list" | "product_list_with_images" | "swatch"; - /** @description Whether or not this modifier is required at checkout. Required in a /POST. - * */ + /** @description Whether or not this modifier is required at checkout. Required in a /POST. */ readonly required: boolean; /** @description The order the modifiers display on the product detail page. */ readonly sort_order?: number; readonly config?: components["schemas"]["config_Full"]; + /** @description Contains information about the values for modifier types with options. Certain fields are not used for specific modifier types. See [Option Values](#option-values) for more details. */ readonly option_values?: readonly { - /** @description The unique numeric ID of the value; increments sequentially. - * */ + /** @description The unique numeric ID of the value; increments sequentially. */ readonly id?: number; /** * @description The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers. - * * @example false */ readonly is_default?: boolean; /** @description Adjuster for Complex Rules. */ readonly adjusters?: { readonly price?: { - /** @description The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront. + /** + * @description The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront. * enum: * - relative * - percentage * x-nullable: true - * */ + */ readonly adjuster?: string; /** * @description The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @example 5 */ readonly adjuster_value?: number; @@ -261,22 +249,20 @@ export interface components { readonly productModifier_Full: components["schemas"]["productModifier_Base"] & { /** * @description The unique numeric ID of the modifier; increments sequentially. - * * @example 12 */ readonly id?: number; /** * @description The unique numeric ID of the product to which the option belongs. - * * @example 77 */ readonly product_id?: number; /** * @description The unique option name. Auto-generated from the display name, a timestamp, and the product ID. - * * @example Add-a-$5-Donation1535039590-191 */ readonly name?: string; + /** @description Contains information about the values for modifier types with options. Certain fields are not used for specific modifier types. See [Option Values](#option-values) for more details. */ readonly option_values?: readonly components["schemas"]["productModifierOptionValue_Full"][]; }; /** @@ -286,24 +272,20 @@ export interface components { readonly productModifierOptionValue_Base: { /** * @description The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers. - * * @example false */ readonly is_default?: boolean; /** * @description The text display identifying the value on the storefront. Required in a /POST. - * * @example Green */ readonly label: string; /** * @description The order in which the value will be displayed on the product page. Required in a /POST. - * * @example 0 */ readonly sort_order: number; - /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexadecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. If no data is available, returns `null`. - * */ + /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. See [Option Values](#option-values) for more details. */ readonly value_data?: Record | null; readonly adjusters?: components["schemas"]["adjusters_Full"]; }; @@ -312,8 +294,7 @@ export interface components { * @description Product modifier `option_value`. */ readonly productModifierOptionValue_Full: components["schemas"]["productModifierOptionValue_Base"] & { - /** @description The unique numeric ID of the value; increments sequentially. - * */ + /** @description The unique numeric ID of the value; increments sequentially. */ readonly id?: number; readonly option_id?: number; }; @@ -324,13 +305,11 @@ export interface components { readonly adjuster_Full: { /** * @description The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @enum {string|null} */ readonly adjuster?: "relative" | "percentage" | null; /** * @description The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @example 5 */ readonly adjuster_value?: number; @@ -349,48 +328,39 @@ export interface components { readonly pagination_Full: { /** * @description Total number of items in the result set. - * * @example 36 */ readonly total?: number; /** * @description Total number of items in the collection response. - * * @example 36 */ readonly count?: number; /** * @description The amount of items returned in the collection per page, controlled by the limit parameter. - * * @example 50 */ readonly per_page?: number; /** * @description The page you are currently on within the collection. - * * @example 1 */ readonly current_page?: number; /** * @description The total number of pages in the collection. - * * @example 1 */ readonly total_pages?: number; - /** @description Pagination links for the previous and next parts of the whole collection. - * */ + /** @description Pagination links for the previous and next parts of the whole collection. */ readonly links?: { - /** @description Link to the previous page returned in the response. - * */ + /** @description Link to the previous page returned in the response. */ readonly previous?: string; /** * @description Link to the current page returned in the response. - * * @example ?page=1&limit=50 */ readonly current?: string; - /** @description Link to the next page returned in the response. - * */ + /** @description Link to the next page returned in the response. */ readonly next?: string; }; }; @@ -403,125 +373,99 @@ export interface components { }; /** * config_Full - * @description The values for option config can vary based on the Modifier created. + * @description The values for option config can vary based on the Modifier created. See [Configs](#configs) to learn more about the type-specific `config` fields. */ readonly config_Full: { - /** @description (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string. - * */ + /** @description (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601 ATOM formatted string, or on a text option as a string. See [Configs](#configs) for more details. */ readonly default_value?: string; - /** @description (checkbox) Flag for setting the checkbox to be checked by default. - * */ + /** @description (checkbox) Flag for setting the checkbox to be checked by default. */ readonly checked_by_default?: boolean; - /** @description (checkbox) Label displayed for the checkbox option. - * */ + /** @description (checkbox) Label displayed for the checkbox option. */ readonly checkbox_label?: string; - /** @description (date) Flag to limit the dates allowed to be entered on a date option. - * */ + /** @description (date) Flag to limit the dates allowed to be entered on a date option. */ readonly date_limited?: boolean; /** * @description (date) The type of limit that is allowed to be entered on a date option. - * * @example range * @enum {string} */ readonly date_limit_mode?: "earliest" | "range" | "latest"; /** - * Format: date - * @description (date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string. - * + * @description (date) The earliest date allowed to be entered on the date option, as an ISO-8601 ATOM formatted string. + * @example 2025-08-15T15:52:01+00:00 */ readonly date_earliest_value?: string; /** - * Format: date - * @description (date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string. - * + * @description (date) The latest date allowed to be entered on the date option, as an ISO-8601 ATOM formatted string. + * @example 2026-08-15T15:52:01+00:00 */ readonly date_latest_value?: string; /** * @description (file) The kind of restriction on the file types that can be uploaded with a file upload option. Values: `specific` - restricts uploads to particular file types; `all` - allows all file types. - * * @example specific * @enum {string} */ readonly file_types_mode?: "specific" | "all"; - /** @description (file) The type of files allowed to be uploaded if the `file_type_option` is set to `specific`. Values: - * `images` - Allows upload of image MIME types (`bmp`, `gif`, `jpg`, `jpeg`, `jpe`, `jif`, `jfif`, `jfi`, `png`, `wbmp`, `xbm`, `tiff`). `documents` - Allows upload of document MIME types (`txt`, `pdf`, `rtf`, `doc`, `docx`, `xls`, `xlsx`, `accdb`, `mdb`, `one`, `pps`, `ppsx`, `ppt`, `pptx`, `pub`, `odt`, `ods`, `odp`, `odg`, `odf`). - * `other` - Allows file types defined in the `file_types_other` array. - * */ + /** @description (file) The type of files allowed to be uploaded if the `file_type_option` is set to `specific`. See [Supported File Types](#supported-file-types) for more details. */ readonly file_types_supported?: readonly string[]; - /** @description (file) A list of other file types allowed with the file upload option. - * */ + /** @description (file) A list of other file types allowed with the file upload option. See [Supported File Types](#supported-file-types) for more details. */ readonly file_types_other?: readonly string[]; /** - * @description (file) The maximum size for a file that can be used with the file upload option. This will still be limited by the server. - * + * @description (file) The maximum size for a file that can be used with the file upload option. This will still be limited by the server. See [Configs](#configs) for more details. * @example 5 */ readonly file_max_size?: number; - /** @description (text, multi_line_text) Flag to validate the length of a text or multi-line text input. - * */ + /** @description (text, multi_line_text) Flag to validate the length of a text or multi-line text input. */ readonly text_characters_limited?: boolean; /** * @description (text, multi_line_text) The minimum length allowed for a text or multi-line text option. - * * @example 1 */ readonly text_min_length?: number; /** * @description (text, multi_line_text) The maximum length allowed for a text or multi line text option. - * * @example 55 */ readonly text_max_length?: number; /** * @description (multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input. - * * @example true */ readonly text_lines_limited?: boolean; /** * @description (multi_line_text) The maximum number of lines allowed on a multi-line text input. - * * @example 4 */ readonly text_max_lines?: number; /** * @description (numbers_only_text) Flag to limit the value of a number option. - * * @example true */ readonly number_limited?: boolean; /** * @description (numbers_only_text) The type of limit on values entered for a number option. - * * @example lowest * @enum {string} */ readonly number_limit_mode?: "lowest" | "highest" | "range"; /** * @description (numbers_only_text) The lowest allowed value for a number option if `number_limited` is true. - * * @example 100 */ readonly number_lowest_value?: number; - /** @description (numbers_only_text) The highest allowed value for a number option if `number_limited` is true. - * */ + /** @description (numbers_only_text) The highest allowed value for a number option if `number_limited` is true. */ readonly number_highest_value?: number; /** * @description (numbers_only_text) Flag to limit the input on a number option to whole numbers only. - * * @example false */ readonly number_integers_only?: boolean; - /** @description (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list. - * */ + /** @description (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list. */ readonly product_list_adjusts_inventory?: boolean; - /** @description (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price. - * */ + /** @description (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price. */ readonly product_list_adjusts_pricing?: boolean; /** - * @description (product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. Values: `none` - don't adjust; `weight` - use shipping weight only; `package` - use weight and dimensions. - * + * @description (product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. See [Configs](#configs) for more details. * @example weight * @enum {string} */ @@ -533,40 +477,32 @@ export interface components { readonly weight?: components["schemas"]["adjuster_Full"]; /** * @description The URL for an image displayed on the storefront when the modifier value is selected.Limit of 8MB per file. - * * @example https://cdn8.bigcommerce.com/s-{{store_hash}}/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.1280.1280.jpg?c=2 */ readonly image_url?: string; readonly purchasing_disabled?: { - /** @description Flag for whether the modifier value disables purchasing when selected on the storefront. This can be used for temporarily disabling a particular modifier value. - * */ + /** @description Flag for whether the modifier value disables purchasing when selected on the storefront. This can be used for temporarily disabling a particular modifier value. */ readonly status?: boolean; - /** @description The message displayed on the storefront when the purchasing disabled status is `true`. - * */ + /** @description The message displayed on the storefront when the purchasing disabled status is `true`. */ readonly message?: string; }; }; }; responses: never; parameters: { - /** @description The ID of the product to which the resource belongs. - * */ + /** @description The ID of the product to which the resource belongs. */ readonly ProductIdParam: number; - /** @description The ID of the product modifier. - * */ + /** @description The ID of the product modifier. */ readonly ModifierIdParam: number; - /** @description The ID of the product modifier value. - * */ + /** @description The ID of the product modifier value. */ readonly ValueIdParam: number; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept: string; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly ContentType: string; - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly PageParam: number; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly LimitParam: number; /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */ readonly IncludeFieldsParam: readonly string[]; @@ -586,11 +522,9 @@ export interface operations { readonly include_fields?: components["parameters"]["IncludeFieldsParam"]; /** @description Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded. */ readonly exclude_fields?: components["parameters"]["ExcludeFieldsParam"]; - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; }; readonly header?: { @@ -598,8 +532,7 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the product to which the resource belongs. - * */ + /** @description The ID of the product to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; }; readonly cookie?: never; @@ -611,7 +544,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": [ * { * "id": 206, @@ -678,7 +612,8 @@ export interface operations { * } * } * } - * } */ + * } + */ readonly "application/json": { readonly data?: readonly components["schemas"]["productModifier_Full"][]; readonly meta?: components["schemas"]["metaCollection_Full"]; @@ -697,15 +632,15 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the product to which the resource belongs. - * */ + /** @description The ID of the product to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; }; readonly cookie?: never; }; readonly requestBody?: { readonly content: { - /** @example { + /** + * @example { * "type": "radio_buttons", * "required": true, * "sort_order": 0, @@ -752,7 +687,8 @@ export interface operations { * } * ], * "display_name": "Donation" - * } */ + * } + */ readonly "application/json": components["schemas"]["productModifier_Post"]; }; }; @@ -762,7 +698,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 164, * "product_id": 161, @@ -822,7 +759,8 @@ export interface operations { * ] * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: { readonly items?: components["schemas"]["productModifier_Full"]; @@ -831,8 +769,7 @@ export interface operations { }; }; }; - /** @description The `Modifier` was in conflict with another option. This is the result of duplicate unique fields, such as `name`. - * */ + /** @description The `Modifier` was in conflict with another option. This is the result of duplicate unique fields, such as `name`. */ readonly 409: { headers: { readonly [name: string]: unknown; @@ -844,18 +781,15 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; }; }; - /** @description The `Modifier` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description The `Modifier` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -867,11 +801,9 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -892,11 +824,9 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the product to which the resource belongs. - * */ + /** @description The ID of the product to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the product modifier. - * */ + /** @description The ID of the product modifier. */ readonly modifier_id: components["parameters"]["ModifierIdParam"]; }; readonly cookie?: never; @@ -914,16 +844,14 @@ export interface operations { }; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -944,11 +872,9 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the product to which the resource belongs. - * */ + /** @description The ID of the product to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the product modifier. - * */ + /** @description The ID of the product modifier. */ readonly modifier_id: components["parameters"]["ModifierIdParam"]; }; readonly cookie?: never; @@ -959,146 +885,116 @@ export interface operations { readonly "application/json": { /** * @description BigCommerce API, which determines how it will display on the storefront. Acceptable values: `date`, `checkbox`, `file`, `text`, `multi_line_text`, `numbers_only_text`, `radio_buttons`, `rectangles`, `dropdown`, `product_list`, `product_list_with_images`, `swatch`. Required in a /POST. - * * @enum {string} */ readonly type: "date" | "checkbox" | "file" | "text" | "multi_line_text" | "numbers_only_text" | "radio_buttons" | "rectangles" | "dropdown" | "product_list" | "product_list_with_images" | "swatch"; - /** @description Whether or not this modifier is required at checkout. Required in a /POST. - * */ + /** @description Whether or not this modifier is required at checkout. Required in a /POST. */ readonly required: boolean; /** @description The order the modifiers display on the product detail page. */ readonly sort_order?: number; - /** @description The values for option config can vary based on the Modifier created. */ + /** @description The values for option config can vary based on the Modifier created. See [Configs](#configs) to learn more about the type-specific `config` fields. */ readonly config?: { - /** @description (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string. - * */ + /** @description (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601 ATOM formatted string, or on a text option as a string. See [Configs](#configs) for more details. */ readonly default_value?: string; - /** @description (checkbox) Flag for setting the checkbox to be checked by default. - * */ + /** @description (checkbox) Flag for setting the checkbox to be checked by default. */ readonly checked_by_default?: boolean; - /** @description (checkbox) Label displayed for the checkbox option. - * */ + /** @description (checkbox) Label displayed for the checkbox option. */ readonly checkbox_label?: string; - /** @description (date) Flag to limit the dates allowed to be entered on a date option. - * */ + /** @description (date) Flag to limit the dates allowed to be entered on a date option. */ readonly date_limited?: boolean; /** * @description (date) The type of limit that is allowed to be entered on a date option. - * * @example range * @enum {string} */ readonly date_limit_mode?: "earliest" | "range" | "latest"; /** - * Format: date - * @description (date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string. - * + * @description (date) The earliest date allowed to be entered on the date option, as an ISO-8601 ATOM formatted string. + * @example 2025-08-15T15:52:01+00:00 */ readonly date_earliest_value?: string; /** - * Format: date - * @description (date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string. - * + * @description (date) The latest date allowed to be entered on the date option, as an ISO-8601 ATOM formatted string. + * @example 2026-08-15T15:52:01+00:00 */ readonly date_latest_value?: string; /** * @description (file) The kind of restriction on the file types that can be uploaded with a file upload option. Values: `specific` - restricts uploads to particular file types; `all` - allows all file types. - * * @example specific * @enum {string} */ readonly file_types_mode?: "specific" | "all"; - /** @description (file) The type of files allowed to be uploaded if the `file_type_option` is set to `specific`. Values: - * `images` - Allows upload of image MIME types (`bmp`, `gif`, `jpg`, `jpeg`, `jpe`, `jif`, `jfif`, `jfi`, `png`, `wbmp`, `xbm`, `tiff`). `documents` - Allows upload of document MIME types (`txt`, `pdf`, `rtf`, `doc`, `docx`, `xls`, `xlsx`, `accdb`, `mdb`, `one`, `pps`, `ppsx`, `ppt`, `pptx`, `pub`, `odt`, `ods`, `odp`, `odg`, `odf`). - * `other` - Allows file types defined in the `file_types_other` array. - * */ + /** @description (file) The type of files allowed to be uploaded if the `file_type_option` is set to `specific`. See [Supported File Types](#supported-file-types) for more details. */ readonly file_types_supported?: readonly string[]; - /** @description (file) A list of other file types allowed with the file upload option. - * */ + /** @description (file) A list of other file types allowed with the file upload option. See [Supported File Types](#supported-file-types) for more details. */ readonly file_types_other?: readonly string[]; /** - * @description (file) The maximum size for a file that can be used with the file upload option. This will still be limited by the server. - * + * @description (file) The maximum size for a file that can be used with the file upload option. This will still be limited by the server. See [Configs](#configs) for more details. * @example 5 */ readonly file_max_size?: number; - /** @description (text, multi_line_text) Flag to validate the length of a text or multi-line text input. - * */ + /** @description (text, multi_line_text) Flag to validate the length of a text or multi-line text input. */ readonly text_characters_limited?: boolean; /** * @description (text, multi_line_text) The minimum length allowed for a text or multi-line text option. - * * @example 1 */ readonly text_min_length?: number; /** * @description (text, multi_line_text) The maximum length allowed for a text or multi line text option. - * * @example 55 */ readonly text_max_length?: number; /** * @description (multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input. - * * @example true */ readonly text_lines_limited?: boolean; /** * @description (multi_line_text) The maximum number of lines allowed on a multi-line text input. - * * @example 4 */ readonly text_max_lines?: number; /** * @description (numbers_only_text) Flag to limit the value of a number option. - * * @example true */ readonly number_limited?: boolean; /** * @description (numbers_only_text) The type of limit on values entered for a number option. - * * @example lowest * @enum {string} */ readonly number_limit_mode?: "lowest" | "highest" | "range"; /** * @description (numbers_only_text) The lowest allowed value for a number option if `number_limited` is true. - * * @example 100 */ readonly number_lowest_value?: number; - /** @description (numbers_only_text) The highest allowed value for a number option if `number_limited` is true. - * */ + /** @description (numbers_only_text) The highest allowed value for a number option if `number_limited` is true. */ readonly number_highest_value?: number; /** * @description (numbers_only_text) Flag to limit the input on a number option to whole numbers only. - * * @example false */ readonly number_integers_only?: boolean; - /** @description (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list. - * */ + /** @description (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list. */ readonly product_list_adjusts_inventory?: boolean; - /** @description (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price. - * */ + /** @description (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price. */ readonly product_list_adjusts_pricing?: boolean; /** - * @description (product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. Values: `none` - don't adjust; `weight` - use shipping weight only; `package` - use weight and dimensions. - * + * @description (product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. See [Configs](#configs) for more details. * @example weight * @enum {string} */ readonly product_list_shipping_calc?: "none" | "weight" | "package"; }; - /** @description Part of Modifier Value Response */ + /** @description Contains information about the values for modifier types with options. Certain fields are not used for specific modifier types. See [Option Values](#option-values) for more details. */ readonly option_values?: readonly { - /** @description The unique numeric ID of the value; increments sequentially. - * */ + /** @description The unique numeric ID of the value; increments sequentially. */ readonly id?: number; /** * @description The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers. - * * @example false */ readonly is_default?: boolean; @@ -1107,13 +1003,11 @@ export interface operations { readonly price?: { /** * @description The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @enum {string} */ readonly adjuster?: "relative" | "percentage"; /** * @description The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @example 5 */ readonly adjuster_value?: number; @@ -1122,7 +1016,6 @@ export interface operations { }[]; /** * @description The name of the option shown on the storefront. - * * @example Donation */ readonly display_name?: string; @@ -1143,175 +1036,142 @@ export interface operations { readonly data?: { /** * @description BigCommerce API, which determines how it will display on the storefront. Acceptable values: `date`, `checkbox`, `file`, `text`, `multi_line_text`, `numbers_only_text`, `radio_buttons`, `rectangles`, `dropdown`, `product_list`, `product_list_with_images`, `swatch`. Required in a /POST. - * * @enum {string} */ readonly type: "date" | "checkbox" | "file" | "text" | "multi_line_text" | "numbers_only_text" | "radio_buttons" | "rectangles" | "dropdown" | "product_list" | "product_list_with_images" | "swatch"; - /** @description Whether or not this modifier is required at checkout. Required in a /POST. - * */ + /** @description Whether or not this modifier is required at checkout. Required in a /POST. */ readonly required: boolean; /** @description The order the modifiers display on the product detail page. */ readonly sort_order?: number; /** * Option Config - * @description The values for option config can vary based on the Modifier created. + * @description The values for option config can vary based on the Modifier created. See [Configs](#configs) to learn more about the type-specific `config` fields. */ readonly config?: { - /** @description (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string. - * */ + /** @description (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601 ATOM formatted string, or on a text option as a string. See [Configs](#configs) for more details. */ readonly default_value?: string; - /** @description (checkbox) Flag for setting the checkbox to be checked by default. - * */ + /** @description (checkbox) Flag for setting the checkbox to be checked by default. */ readonly checked_by_default?: boolean; - /** @description (checkbox) Label displayed for the checkbox option. - * */ + /** @description (checkbox) Label displayed for the checkbox option. */ readonly checkbox_label?: string; - /** @description (date) Flag to limit the dates allowed to be entered on a date option. - * */ + /** @description (date) Flag to limit the dates allowed to be entered on a date option. */ readonly date_limited?: boolean; /** * @description (date) The type of limit that is allowed to be entered on a date option. - * * @example range * @enum {string} */ readonly date_limit_mode?: "earliest" | "range" | "latest"; /** - * Format: date - * @description (date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string. - * + * @description (date) The earliest date allowed to be entered on the date option, as an ISO-8601 ATOM formatted string. + * @example 2025-08-15T15:52:01+00:00 */ readonly date_earliest_value?: string; /** - * Format: date - * @description (date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string. - * + * @description (date) The latest date allowed to be entered on the date option, as an ISO-8601 ATOM formatted string. + * @example 2026-08-15T15:52:01+00:00 */ readonly date_latest_value?: string; /** * @description (file) The kind of restriction on the file types that can be uploaded with a file upload option. Values: `specific` - restricts uploads to particular file types; `all` - allows all file types. - * * @example specific * @enum {string} */ readonly file_types_mode?: "specific" | "all"; - /** @description (file) The type of files allowed to be uploaded if the `file_type_option` is set to `specific`. Values: - * `images` - Allows upload of image MIME types (`bmp`, `gif`, `jpg`, `jpeg`, `jpe`, `jif`, `jfif`, `jfi`, `png`, `wbmp`, `xbm`, `tiff`). `documents` - Allows upload of document MIME types (`txt`, `pdf`, `rtf`, `doc`, `docx`, `xls`, `xlsx`, `accdb`, `mdb`, `one`, `pps`, `ppsx`, `ppt`, `pptx`, `pub`, `odt`, `ods`, `odp`, `odg`, `odf`). - * `other` - Allows file types defined in the `file_types_other` array. - * */ + /** @description (file) The type of files allowed to be uploaded if the `file_type_option` is set to `specific`. See [Supported File Types](#supported-file-types) for more details. */ readonly file_types_supported?: readonly string[]; - /** @description (file) A list of other file types allowed with the file upload option. - * */ + /** @description (file) A list of other file types allowed with the file upload option. See [Supported File Types](#supported-file-types) for more details. */ readonly file_types_other?: readonly string[]; /** - * @description (file) The maximum size for a file that can be used with the file upload option. This will still be limited by the server. - * + * @description (file) The maximum size for a file that can be used with the file upload option. This will still be limited by the server. See [Configs](#configs) for more details. * @example 5 */ readonly file_max_size?: number; - /** @description (text, multi_line_text) Flag to validate the length of a text or multi-line text input. - * */ + /** @description (text, multi_line_text) Flag to validate the length of a text or multi-line text input. */ readonly text_characters_limited?: boolean; /** * @description (text, multi_line_text) The minimum length allowed for a text or multi-line text option. - * * @example 1 */ readonly text_min_length?: number; /** * @description (text, multi_line_text) The maximum length allowed for a text or multi line text option. - * * @example 55 */ readonly text_max_length?: number; /** * @description (multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input. - * * @example true */ readonly text_lines_limited?: boolean; /** * @description (multi_line_text) The maximum number of lines allowed on a multi-line text input. - * * @example 4 */ readonly text_max_lines?: number; /** * @description (numbers_only_text) Flag to limit the value of a number option. - * * @example true */ readonly number_limited?: boolean; /** * @description (numbers_only_text) The type of limit on values entered for a number option. - * * @example lowest * @enum {string} */ readonly number_limit_mode?: "lowest" | "highest" | "range"; /** * @description (numbers_only_text) The lowest allowed value for a number option if `number_limited` is true. - * * @example 100 */ readonly number_lowest_value?: number; - /** @description (numbers_only_text) The highest allowed value for a number option if `number_limited` is true. - * */ + /** @description (numbers_only_text) The highest allowed value for a number option if `number_limited` is true. */ readonly number_highest_value?: number; /** * @description (numbers_only_text) Flag to limit the input on a number option to whole numbers only. - * * @example false */ readonly number_integers_only?: boolean; - /** @description (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list. - * */ + /** @description (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list. */ readonly product_list_adjusts_inventory?: boolean; - /** @description (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price. - * */ + /** @description (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price. */ readonly product_list_adjusts_pricing?: boolean; /** - * @description (product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. Values: `none` - don't adjust; `weight` - use shipping weight only; `package` - use weight and dimensions. - * + * @description (product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. See [Configs](#configs) for more details. * @example weight * @enum {string} */ readonly product_list_shipping_calc?: "none" | "weight" | "package"; }; + /** @description Contains information about the values for modifier types with options. Certain fields are not used for specific modifier types. See [Option Values](#option-values) for more details. */ readonly option_values?: readonly { /** * @description The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers. - * * @example false */ readonly is_default?: boolean; /** * @description The text display identifying the value on the storefront. Required in a /POST. - * * @example Green */ readonly label: string; /** * @description The order in which the value will be displayed on the product page. Required in a /POST. - * * @example 0 */ readonly sort_order: number; - /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexadecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. - * */ + /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. See [Option Values](#option-values) for more details. */ readonly value_data?: Record; readonly adjusters?: { /** @description Adjuster for Complex Rules. */ readonly price?: { /** * @description The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @enum {string} */ readonly adjuster?: "relative" | "percentage"; /** * @description The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @example 5 */ readonly adjuster_value?: number; @@ -1320,58 +1180,48 @@ export interface operations { readonly weight?: { /** * @description The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @enum {string} */ readonly adjuster?: "relative" | "percentage"; /** * @description The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @example 5 */ readonly adjuster_value?: number; }; /** * @description The URL for an image displayed on the storefront when the modifier value is selected. Limit of 8MB per file. - * * @example https://cdn8.bigcommerce.com/s-{{store_hash}}/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.1280.1280.jpg?c=2 */ readonly image_url?: string; readonly purchasing_disabled?: { - /** @description Flag for whether the modifier value disables purchasing when selected on the storefront. This can be used for temporarily disabling a particular modifier value. - * */ + /** @description Flag for whether the modifier value disables purchasing when selected on the storefront. This can be used for temporarily disabling a particular modifier value. */ readonly status?: boolean; - /** @description The message displayed on the storefront when the purchasing disabled status is `true'. - * */ + /** @description The message displayed on the storefront when the purchasing disabled status is `true'. */ readonly message?: string; }; }; - /** @description The unique numeric ID of the value; increments sequentially. - * */ + /** @description The unique numeric ID of the value; increments sequentially. */ readonly id?: number; }[]; } & { /** * @description The unique numeric ID of the modifier; increments sequentially. - * * @example 12 */ readonly id?: number; /** * @description The unique numeric ID of the product to which the option belongs. - * * @example 77 */ readonly product_id?: number; /** * @description The unique option name. Auto-generated from the display name, a timestamp, and the product ID. - * * @example Add-a-$5-Donation1535039590-191 */ readonly name?: string; /** * @description The name of the option shown on the storefront. - * * @example Donation */ readonly display_name?: string; @@ -1380,8 +1230,7 @@ export interface operations { }; }; }; - /** @description The `Modifier` was in conflict with another modifier or option. This is the result of duplicate unique fields, such as `name`. - * */ + /** @description The `Modifier` was in conflict with another modifier or option. This is the result of duplicate unique fields, such as `name`. */ readonly 409: { headers: { readonly [name: string]: unknown; @@ -1393,18 +1242,15 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; }; }; - /** @description The `Modifier` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description The `Modifier` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -1416,11 +1262,9 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -1436,11 +1280,9 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the product to which the resource belongs. - * */ + /** @description The ID of the product to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the product modifier. - * */ + /** @description The ID of the product modifier. */ readonly modifier_id: components["parameters"]["ModifierIdParam"]; }; readonly cookie?: never; @@ -1462,11 +1304,9 @@ export interface operations { readonly include_fields?: components["parameters"]["IncludeFieldsParam"]; /** @description Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded. */ readonly exclude_fields?: components["parameters"]["ExcludeFieldsParam"]; - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; }; readonly header?: { @@ -1474,11 +1314,9 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the product to which the resource belongs. - * */ + /** @description The ID of the product to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the product modifier. - * */ + /** @description The ID of the product modifier. */ readonly modifier_id: components["parameters"]["ModifierIdParam"]; }; readonly cookie?: never; @@ -1490,7 +1328,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": [ * { * "id": 190, @@ -1546,7 +1385,8 @@ export interface operations { * } * } * } - * } */ + * } + */ readonly "application/json": { readonly data?: readonly components["schemas"]["productModifierOptionValue_Full"][]; readonly meta?: components["schemas"]["metaCollection_Full"]; @@ -1565,11 +1405,9 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the product to which the resource belongs. - * */ + /** @description The ID of the product to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the product modifier. - * */ + /** @description The ID of the product modifier. */ readonly modifier_id: components["parameters"]["ModifierIdParam"]; }; readonly cookie?: never; @@ -1579,24 +1417,20 @@ export interface operations { readonly "application/json": { /** * @description The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers. - * * @example false */ readonly is_default?: boolean; /** * @description The text display identifying the value on the storefront. Required in a /POST. - * * @example Green */ readonly label: string; /** * @description The order in which the value will be displayed on the product page. Required in a /POST. - * * @example 0 */ readonly sort_order: number; - /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexadecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. - * */ + /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexadecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. */ readonly value_data?: Record; } & { readonly adjusters?: { @@ -1607,13 +1441,11 @@ export interface operations { readonly price?: { /** * @description The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @enum {string|null} */ readonly adjuster?: "relative" | "percentage" | null; /** * @description The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @example 5 */ readonly adjuster_value?: number; @@ -1625,29 +1457,24 @@ export interface operations { readonly weight?: { /** * @description The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @enum {string|null} */ readonly adjuster?: "relative" | "percentage" | null; /** * @description The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @example 5 */ readonly adjuster_value?: number; }; /** * @description The URL for an image displayed on the storefront when the modifier value is selected.Limit of 8MB per file. - * * @example https://cdn8.bigcommerce.com/s-{{store_hash}}/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.1280.1280.jpg?c=2 */ readonly image_url?: string; readonly purchasing_disabled?: { - /** @description Flag for whether the modifier value disables purchasing when selected on the storefront. This can be used for temporarily disabling a particular modifier value. - * */ + /** @description Flag for whether the modifier value disables purchasing when selected on the storefront. This can be used for temporarily disabling a particular modifier value. */ readonly status?: boolean; - /** @description The message displayed on the storefront when the purchasing disabled status is `true`. - * */ + /** @description The message displayed on the storefront when the purchasing disabled status is `true`. */ readonly message?: string; }; }; @@ -1660,7 +1487,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 190, * "option_id": 222, @@ -1682,7 +1510,8 @@ export interface operations { * } * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { /** * Modifier Value @@ -1691,24 +1520,20 @@ export interface operations { readonly data?: ({ /** * @description The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers. - * * @example false */ readonly is_default?: boolean; /** * @description The text display identifying the value on the storefront. Required in a /POST. - * * @example Green */ readonly label: string; /** * @description The order in which the value will be displayed on the product page. Required in a /POST. - * * @example 0 */ readonly sort_order: number; - /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexadecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. - * */ + /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. See [Option Values](#option-values) for more details. */ readonly value_data?: Record; } & { readonly adjusters?: { @@ -1719,13 +1544,11 @@ export interface operations { readonly price?: { /** * @description The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @enum {string} */ readonly adjuster?: "relative" | "percentage"; /** * @description The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @example 5 */ readonly adjuster_value?: number; @@ -1737,43 +1560,36 @@ export interface operations { readonly weight?: { /** * @description The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @enum {string} */ readonly adjuster?: "relative" | "percentage"; /** * @description The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @example 5 */ readonly adjuster_value?: number; }; /** * @description The URL for an image displayed on the storefront when the modifier value is selected.Limit of 8MB per file. - * * @example https://cdn8.bigcommerce.com/s-{{store_hash}}/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.1280.1280.jpg?c=2 */ readonly image_url?: string; readonly purchasing_disabled?: { - /** @description Flag for whether the modifier value disables purchasing when selected on the storefront. This can be used for temporarily disabling a particular modifier value. - * */ + /** @description Flag for whether the modifier value disables purchasing when selected on the storefront. This can be used for temporarily disabling a particular modifier value. */ readonly status?: boolean; - /** @description The message displayed on the storefront when the purchasing disabled status is `true`. - * */ + /** @description The message displayed on the storefront when the purchasing disabled status is `true`. */ readonly message?: string; }; }; }) & { - /** @description The unique numeric ID of the value; increments sequentially. - * */ + /** @description The unique numeric ID of the value; increments sequentially. */ readonly id?: number; }; readonly meta?: components["schemas"]["metaEmpty_Full"]; }; }; }; - /** @description The `ModifierValue` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description The `ModifierValue` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -1785,11 +1601,9 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -1810,14 +1624,11 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the product to which the resource belongs. - * */ + /** @description The ID of the product to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the product modifier. - * */ + /** @description The ID of the product modifier. */ readonly modifier_id: components["parameters"]["ModifierIdParam"]; - /** @description The ID of the product modifier value. - * */ + /** @description The ID of the product modifier value. */ readonly value_id: components["parameters"]["ValueIdParam"]; }; readonly cookie?: never; @@ -1829,7 +1640,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 190, * "option_id": 222, @@ -1851,23 +1663,22 @@ export interface operations { * } * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: components["schemas"]["productModifierOptionValue_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; }; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -1888,14 +1699,11 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the product to which the resource belongs. - * */ + /** @description The ID of the product to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the product modifier. - * */ + /** @description The ID of the product modifier. */ readonly modifier_id: components["parameters"]["ModifierIdParam"]; - /** @description The ID of the product modifier value. - * */ + /** @description The ID of the product modifier value. */ readonly value_id: components["parameters"]["ValueIdParam"]; }; readonly cookie?: never; @@ -1905,24 +1713,20 @@ export interface operations { readonly "application/json": ({ /** * @description The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers. - * * @example false */ readonly is_default?: boolean; /** * @description The text display identifying the value on the storefront. Required in a /POST. - * * @example Green */ readonly label: string; /** * @description The order in which the value will be displayed on the product page. Required in a /POST. - * * @example 0 */ readonly sort_order: number; - /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexadecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. - * */ + /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. See [Option Values](#option-values) for more details. */ readonly value_data?: Record; } & { readonly adjusters?: { @@ -1933,13 +1737,11 @@ export interface operations { readonly price?: { /** * @description The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @enum {string|null} */ readonly adjuster?: "relative" | "percentage" | null; /** * @description The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @example 5 */ readonly adjuster_value?: number; @@ -1951,35 +1753,29 @@ export interface operations { readonly weight?: { /** * @description The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @enum {string|null} */ readonly adjuster?: "relative" | "percentage" | null; /** * @description The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @example 5 */ readonly adjuster_value?: number; }; /** * @description The URL for an image displayed on the storefront when the modifier value is selected.Limit of 8MB per file. - * * @example https://cdn8.bigcommerce.com/s-{{store_hash}}/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.1280.1280.jpg?c=2 */ readonly image_url?: string; readonly purchasing_disabled?: { - /** @description Flag for whether the modifier value disables purchasing when selected on the storefront. This can be used for temporarily disabling a particular modifier value. - * */ + /** @description Flag for whether the modifier value disables purchasing when selected on the storefront. This can be used for temporarily disabling a particular modifier value. */ readonly status?: boolean; - /** @description The message displayed on the storefront when the purchasing disabled status is `true`. - * */ + /** @description The message displayed on the storefront when the purchasing disabled status is `true`. */ readonly message?: string; }; }; }) & { - /** @description The unique numeric ID of the value; increments sequentially. - * */ + /** @description The unique numeric ID of the value; increments sequentially. */ readonly id?: number; }; }; @@ -1990,7 +1786,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 190, * "option_id": 222, @@ -2012,7 +1809,8 @@ export interface operations { * } * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { /** * Modifier Value @@ -2021,24 +1819,20 @@ export interface operations { readonly data?: ({ /** * @description The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers. - * * @example false */ readonly is_default?: boolean; /** * @description The text display identifying the value on the storefront. Required in a /POST. - * * @example Green */ readonly label: string; /** * @description The order in which the value will be displayed on the product page. Required in a /POST. - * * @example 0 */ readonly sort_order: number; - /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexadecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. - * */ + /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. See [Option Values](#option-values) for more details. */ readonly value_data?: Record; } & { readonly adjusters?: { @@ -2049,13 +1843,11 @@ export interface operations { readonly price?: { /** * @description The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @enum {string} */ readonly adjuster?: "relative" | "percentage"; /** * @description The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @example 5 */ readonly adjuster_value?: number; @@ -2067,43 +1859,36 @@ export interface operations { readonly weight?: { /** * @description The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @enum {string} */ readonly adjuster?: "relative" | "percentage"; /** * @description The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @example 5 */ readonly adjuster_value?: number; }; /** * @description The URL for an image displayed on the storefront when the modifier value is selected.Limit of 8MB per file. - * * @example https://cdn8.bigcommerce.com/s-{{store_hash}}/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.1280.1280.jpg?c=2 */ readonly image_url?: string; readonly purchasing_disabled?: { - /** @description Flag for whether the modifier value disables purchasing when selected on the storefront. This can be used for temporarily disabling a particular modifier value. - * */ + /** @description Flag for whether the modifier value disables purchasing when selected on the storefront. This can be used for temporarily disabling a particular modifier value. */ readonly status?: boolean; - /** @description The message displayed on the storefront when the purchasing disabled status is `true`. - * */ + /** @description The message displayed on the storefront when the purchasing disabled status is `true`. */ readonly message?: string; }; }; }) & { - /** @description The unique numeric ID of the value; increments sequentially. - * */ + /** @description The unique numeric ID of the value; increments sequentially. */ readonly id?: number; }; readonly meta?: components["schemas"]["metaEmpty_Full"]; }; }; }; - /** @description The `ModifierValue` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description The `ModifierValue` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -2115,11 +1900,9 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -2135,14 +1918,11 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the product to which the resource belongs. - * */ + /** @description The ID of the product to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the product modifier. - * */ + /** @description The ID of the product modifier. */ readonly modifier_id: components["parameters"]["ModifierIdParam"]; - /** @description The ID of the product modifier value. - * */ + /** @description The ID of the product modifier value. */ readonly value_id: components["parameters"]["ValueIdParam"]; }; readonly cookie?: never; @@ -2165,14 +1945,11 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the product to which the resource belongs. - * */ + /** @description The ID of the product to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the product modifier. - * */ + /** @description The ID of the product modifier. */ readonly modifier_id: components["parameters"]["ModifierIdParam"]; - /** @description The ID of the product modifier value. - * */ + /** @description The ID of the product modifier value. */ readonly value_id: components["parameters"]["ValueIdParam"]; }; readonly cookie?: never; @@ -2191,20 +1968,21 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "image_url": "https://cdn8.bigcommerce.com/s-id30h7ohwf/product_images/attribute_rule_images/85_source_1536863430.png" * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { /** * Resource Image * @description An object containing a publicly accessible image URL, or a form post that contains an image file. */ readonly data?: { - /** @description A public URL for a GIF, JPEG, or PNG image. Limit of 8MB per file. - * */ + /** @description A public URL for a GIF, JPEG, or PNG image. Limit of 8MB per file. */ readonly image_url?: string; }; readonly meta?: components["schemas"]["metaEmpty_Full"]; @@ -2220,16 +1998,14 @@ export interface operations { readonly "application/json": Record; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -2238,8 +2014,7 @@ export interface operations { }; }; }; - /** @description Modifier image was not valid. This is the result of missing `image_file` fields, or of a non-URL value for the `image_file` field. See the response for more details. - * */ + /** @description Modifier image was not valid. This is the result of missing `image_file` fields, or of a non-URL value for the `image_file` field. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -2251,11 +2026,9 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; diff --git a/src/internal/reference/generated/catalog/product_variant_options_catalog.v3.ts b/src/internal/reference/generated/catalog/product_variant_options_catalog.v3.ts index ee3b3e2..7da7342 100644 --- a/src/internal/reference/generated/catalog/product_variant_options_catalog.v3.ts +++ b/src/internal/reference/generated/catalog/product_variant_options_catalog.v3.ts @@ -12,8 +12,7 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; }; readonly cookie?: never; @@ -55,11 +54,9 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `Option`. - * */ + /** @description The ID of the `Option`. */ readonly option_id: components["parameters"]["OptionIdParam"]; }; readonly cookie?: never; @@ -91,11 +88,9 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `Option`. - * */ + /** @description The ID of the `Option`. */ readonly option_id: components["parameters"]["OptionIdParam"]; }; readonly cookie?: never; @@ -129,14 +124,11 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `Option`. - * */ + /** @description The ID of the `Option`. */ readonly option_id: components["parameters"]["OptionIdParam"]; - /** @description The ID of the `Modifier/Option Value`. - * */ + /** @description The ID of the `Modifier/Option Value`. */ readonly value_id: components["parameters"]["ValueIdParam"]; }; readonly cookie?: never; @@ -171,25 +163,21 @@ export interface components { readonly productOption_Base: { /** * @description The unique numerical ID of the option, increments sequentially. - * * @example 55 */ readonly id?: number | null; /** * @description The unique numerical ID of the product to which the option belongs. - * * @example 4 */ readonly product_id?: number; /** * @description The name of the option shown on the storefront. - * * @example Add-a-$5-Donation1535042499-187 */ readonly display_name?: string; /** * @description The type of option, which determines how it will display on the storefront. Acceptable values: `radio_buttons`, `rectangles`, `dropdown`, `product_list`, `product_list_with_images`, `swatch`. For reference, the former v2 API values are: RB = radio_buttons, RT = rectangles, S = dropdown, P = product_list, PI = product_list_with_images, CS = swatch. - * * @enum {string} */ readonly type?: "radio_buttons" | "rectangles" | "dropdown" | "product_list" | "product_list_with_images" | "swatch"; @@ -205,7 +193,6 @@ export interface components { readonly productOption_Full: components["schemas"]["productOption_Base"] & { /** * @description The unique option name, auto-generated from the display name, a timestamp, and the product ID. - * * @example Add-a-$5-Donation1535042499-187 */ readonly name?: string; @@ -217,24 +204,20 @@ export interface components { readonly productOptionOptionValue_Base: { /** * @description The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers. - * * @example false */ readonly is_default?: boolean; /** * @description The text display identifying the value on the storefront. Required in a /POST. - * * @example Green */ readonly label: string; /** * @description The order in which the value will be displayed on the product page. Required in a /POST. - * * @example 0 */ readonly sort_order: number; - /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. If no data is available, returns `null`. - * */ + /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. If no data is available, returns `null`. */ readonly value_data?: Record | null; }; /** @@ -242,8 +225,7 @@ export interface components { * @description Product Option `option_value`. */ readonly productOptionOptionValue_Full: components["schemas"]["productOptionOptionValue_Base"] & { - /** @description The unique numeric ID of the value; increments sequentially. - * */ + /** @description The unique numeric ID of the value; increments sequentially. */ readonly id?: number; }; /** @@ -251,21 +233,16 @@ export interface components { * @description The values for option config can vary based on the Modifier created. */ readonly productOptionConfig_Full: { - /** @description (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string. - * */ + /** @description (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string. */ readonly default_value?: string; - /** @description (checkbox) Flag for setting the checkbox to be checked by default. - * */ + /** @description (checkbox) Flag for setting the checkbox to be checked by default. */ readonly checked_by_default?: boolean; - /** @description (checkbox) Label displayed for the checkbox option. - * */ + /** @description (checkbox) Label displayed for the checkbox option. */ readonly checkbox_label?: string; - /** @description (date) Flag to limit the dates allowed to be entered on a date option. - * */ + /** @description (date) Flag to limit the dates allowed to be entered on a date option. */ readonly date_limited?: boolean; /** * @description (date) The type of limit that is allowed to be entered on a date option. - * * @example range * @enum {string} */ @@ -273,100 +250,83 @@ export interface components { /** * Format: date * @description (date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string. - * */ readonly date_earliest_value?: string; /** * Format: date * @description (date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string. - * */ readonly date_latest_value?: string; /** * @description (file) The kind of restriction on the file types that can be uploaded with a file upload option. Values: `specific` - restricts uploads to particular file types; `all` - allows all file types. - * * @example specific * @enum {string} */ readonly file_types_mode?: "specific" | "all"; - /** @description (file) The type of files allowed to be uploaded if the `file_type_option` is set to `specific`. Values: + /** + * @description (file) The type of files allowed to be uploaded if the `file_type_option` is set to `specific`. Values: * `images` - Allows upload of image MIME types (`bmp`, `gif`, `jpg`, `jpeg`, `jpe`, `jif`, `jfif`, `jfi`, `png`, `wbmp`, `xbm`, `tiff`). `documents` - Allows upload of document MIME types (`txt`, `pdf`, `rtf`, `doc`, `docx`, `xls`, `xlsx`, `accdb`, `mdb`, `one`, `pps`, `ppsx`, `ppt`, `pptx`, `pub`, `odt`, `ods`, `odp`, `odg`, `odf`). * `other` - Allows file types defined in the `file_types_other` array. - * */ + */ readonly file_types_supported?: readonly string[]; - /** @description (file) A list of other file types allowed with the file upload option. - * */ + /** @description (file) A list of other file types allowed with the file upload option. */ readonly file_types_other?: readonly string[]; /** * @description (file) The maximum size for a file that can be used with the file upload option. This will still be limited by the server. - * * @example 5 */ readonly file_max_size?: number; - /** @description (text, multi_line_text) Flag to validate the length of a text or multi-line text input. - * */ + /** @description (text, multi_line_text) Flag to validate the length of a text or multi-line text input. */ readonly text_characters_limited?: boolean; /** * @description (text, multi_line_text) The minimum length allowed for a text or multi-line text option. - * * @example 1 */ readonly text_min_length?: number; /** * @description (text, multi_line_text) The maximum length allowed for a text or multi line text option. - * * @example 55 */ readonly text_max_length?: number; /** * @description (multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input. - * * @example true */ readonly text_lines_limited?: boolean; /** * @description (multi_line_text) The maximum number of lines allowed on a multi-line text input. - * * @example 4 */ readonly text_max_lines?: number; /** * @description (numbers_only_text) Flag to limit the value of a number option. - * * @example true */ readonly number_limited?: boolean; /** * @description (numbers_only_text) The type of limit on values entered for a number option. - * * @example lowest * @enum {string} */ readonly number_limit_mode?: "lowest" | "highest" | "range"; /** * @description (numbers_only_text) The lowest allowed value for a number option if `number_limited` is true. - * * @example 100 */ readonly number_lowest_value?: number; - /** @description (numbers_only_text) The highest allowed value for a number option if `number_limited` is true. - * */ + /** @description (numbers_only_text) The highest allowed value for a number option if `number_limited` is true. */ readonly number_highest_value?: number; /** * @description (numbers_only_text) Flag to limit the input on a number option to whole numbers only. - * * @example false */ readonly number_integers_only?: boolean; - /** @description (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list. - * */ + /** @description (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list. */ readonly product_list_adjusts_inventory?: boolean; - /** @description (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price. - * */ + /** @description (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price. */ readonly product_list_adjusts_pricing?: boolean; /** * @description (product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. Values: `none` - don't adjust; `weight` - use shipping weight only; `package` - use weight and dimensions. - * * @example weight * @enum {string} */ @@ -386,48 +346,39 @@ export interface components { readonly pagination_Full: { /** * @description Total number of items in the result set. - * * @example 36 */ readonly total?: number; /** * @description Total number of items in the collection response. - * * @example 36 */ readonly count?: number; /** * @description The amount of items returned in the collection per page, controlled by the limit parameter. - * * @example 50 */ readonly per_page?: number; /** * @description The page you are currently on within the collection. - * * @example 1 */ readonly current_page?: number; /** * @description The total number of pages in the collection. - * * @example 1 */ readonly total_pages?: number; - /** @description Pagination links for the previous and next parts of the whole collection. - * */ + /** @description Pagination links for the previous and next parts of the whole collection. */ readonly links?: { - /** @description Link to the previous page returned in the response. - * */ + /** @description Link to the previous page returned in the response. */ readonly previous?: string; /** * @description Link to the current page returned in the response. - * * @example ?page=1&limit=50 */ readonly current?: string; - /** @description Link to the next page returned in the response. - * */ + /** @description Link to the next page returned in the response. */ readonly next?: string; }; }; @@ -441,20 +392,15 @@ export interface components { }; responses: never; parameters: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly ProductIdParam: number; - /** @description The ID of the `Modifier/Option Value`. - * */ + /** @description The ID of the `Modifier/Option Value`. */ readonly ValueIdParam: number; - /** @description The ID of the `Option`. - * */ + /** @description The ID of the `Option`. */ readonly OptionIdParam: number; - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly PageParam: number; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly LimitParam: number; /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */ readonly IncludeFieldsParam: readonly string[]; @@ -474,11 +420,9 @@ export interface operations { readonly getProductVariantOptions: { readonly parameters: { readonly query?: { - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */ readonly include_fields?: components["parameters"]["IncludeFieldsParam"]; @@ -490,8 +434,7 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; }; readonly cookie?: never; @@ -509,16 +452,14 @@ export interface operations { }; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -539,8 +480,7 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; }; readonly cookie?: never; @@ -550,19 +490,16 @@ export interface operations { readonly "application/json": { /** * @description The unique numerical ID of the product to which the option belongs. - * * @example 4 */ readonly product_id?: number; /** * @description The name of the option shown on the storefront. - * * @example Add-a-$5-Donation1535042499-187 */ readonly display_name?: string; /** * @description The type of option, which determines how it will display on the storefront. Acceptable values: `radio_buttons`, `rectangles`, `dropdown`, `product_list`, `product_list_with_images`, `swatch`. For reference, the former v2 API values are: RB = radio_buttons, RT = rectangles, S = dropdown, P = product_list, PI = product_list_with_images, CS = swatch. - * * @enum {string} */ readonly type?: "radio_buttons" | "rectangles" | "dropdown" | "product_list" | "product_list_with_images" | "swatch"; @@ -571,21 +508,16 @@ export interface operations { * @description The values for option config can vary based on the Modifier created. */ readonly config?: { - /** @description (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string. - * */ + /** @description (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string. */ readonly default_value?: string; - /** @description (checkbox) Flag for setting the checkbox to be checked by default. - * */ + /** @description (checkbox) Flag for setting the checkbox to be checked by default. */ readonly checked_by_default?: boolean; - /** @description (checkbox) Label displayed for the checkbox option. - * */ + /** @description (checkbox) Label displayed for the checkbox option. */ readonly checkbox_label?: string; - /** @description (date) Flag to limit the dates allowed to be entered on a date option. - * */ + /** @description (date) Flag to limit the dates allowed to be entered on a date option. */ readonly date_limited?: boolean; /** * @description (date) The type of limit that is allowed to be entered on a date option. - * * @example range * @enum {string} */ @@ -593,20 +525,17 @@ export interface operations { /** * Format: date-time * @description (date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string. - * * @example 2018-08-31T00:00:00+00:00 */ readonly date_earliest_value?: string; /** * Format: date-time * @description (date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string. - * * @example 2019-01-01T00:00:00+00:00 */ readonly date_latest_value?: string; /** * @description (file) The kind of restriction on the file types that can be uploaded with a file upload option. Values: `specific` - restricts uploads to particular file types; `all` - allows all file types. - * * @example specific * @enum {string} */ @@ -615,7 +544,6 @@ export interface operations { * @description (file) The type of files allowed to be uploaded if the `file_type_option` is set to `specific`. Values: * `images` - Allows upload of image MIME types (`bmp`, `gif`, `jpg`, `jpeg`, `jpe`, `jif`, `jfif`, `jfi`, `png`, `wbmp`, `xbm`, `tiff`). `documents` - Allows upload of document MIME types (`txt`, `pdf`, `rtf`, `doc`, `docx`, `xls`, `xlsx`, `accdb`, `mdb`, `one`, `pps`, `ppsx`, `ppt`, `pptx`, `pub`, `odt`, `ods`, `odp`, `odg`, `odf`). * `other` - Allows file types defined in the `file_types_other` array. - * * @example [ * "images", * "documents", @@ -625,7 +553,6 @@ export interface operations { readonly file_types_supported?: readonly string[]; /** * @description (file) A list of other file types allowed with the file upload option. - * * @example [ * "pdf", * "txt" @@ -634,74 +561,60 @@ export interface operations { readonly file_types_other?: readonly string[]; /** * @description (file) The maximum size for a file that can be used with the file upload option. This will still be limited by the server. - * * @example 5 */ readonly file_max_size?: number; - /** @description (text, multi_line_text) Flag to validate the length of a text or multi-line text input. - * */ + /** @description (text, multi_line_text) Flag to validate the length of a text or multi-line text input. */ readonly text_characters_limited?: boolean; /** * @description (text, multi_line_text) The minimum length allowed for a text or multi-line text option. - * * @example 1 */ readonly text_min_length?: number; /** * @description (text, multi_line_text) The maximum length allowed for a text or multi line text option. - * * @example 55 */ readonly text_max_length?: number; /** * @description (multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input. - * * @example true */ readonly text_lines_limited?: boolean; /** * @description (multi_line_text) The maximum number of lines allowed on a multi-line text input. - * * @example 4 */ readonly text_max_lines?: number; /** * @description (numbers_only_text) Flag to limit the value of a number option. - * * @example true */ readonly number_limited?: boolean; /** * @description (numbers_only_text) The type of limit on values entered for a number option. - * * @example lowest * @enum {string} */ readonly number_limit_mode?: "lowest" | "highest" | "range"; /** * @description (numbers_only_text) The lowest allowed value for a number option if `number_limited` is true. - * * @example 100 */ readonly number_lowest_value?: number; - /** @description (numbers_only_text) The highest allowed value for a number option if `number_limited` is true. - * */ + /** @description (numbers_only_text) The highest allowed value for a number option if `number_limited` is true. */ readonly number_highest_value?: number; /** * @description (numbers_only_text) Flag to limit the input on a number option to whole numbers only. - * * @example false */ readonly number_integers_only?: boolean; - /** @description (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list. - * */ + /** @description (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list. */ readonly product_list_adjusts_inventory?: boolean; - /** @description (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price. - * */ + /** @description (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price. */ readonly product_list_adjusts_pricing?: boolean; /** * @description (product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. Values: `none` - don't adjust; `weight` - use shipping weight only; `package` - use weight and dimensions. - * * @example weight * @enum {string} */ @@ -715,28 +628,23 @@ export interface operations { readonly option_values?: readonly ({ /** * @description The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers. - * * @example false */ readonly is_default?: boolean; /** * @description The text display identifying the value on the storefront. Required in a /POST. - * * @example Green */ readonly label: string; /** * @description The order in which the value will be displayed on the product page. Required in a /POST. - * * @example 0 */ readonly sort_order: number; - /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. - * */ + /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. */ readonly value_data?: Record; } & { - /** @description The unique numeric ID of the value; increments sequentially. - * */ + /** @description The unique numeric ID of the value; increments sequentially. */ readonly id?: number; })[]; /** @description Publicly available image url */ @@ -755,25 +663,21 @@ export interface operations { readonly data?: { /** * @description The unique numerical ID of the option, increments sequentially. - * * @example 55 */ readonly id?: number; /** * @description The unique numerical ID of the product to which the option belongs. - * * @example 4 */ readonly product_id?: number; /** * @description The name of the option shown on the storefront. - * * @example Add-a-$5-Donation1535042499-187 */ readonly display_name?: string; /** * @description The type of option, which determines how it will display on the storefront. Acceptable values: `radio_buttons`, `rectangles`, `dropdown`, `product_list`, `product_list_with_images`, `swatch`. For reference, the former v2 API values are: RB = radio_buttons, RT = rectangles, S = dropdown, P = product_list, PI = product_list_with_images, CS = swatch. - * * @enum {string} */ readonly type?: "radio_buttons" | "rectangles" | "dropdown" | "product_list" | "product_list_with_images" | "swatch"; @@ -782,21 +686,16 @@ export interface operations { * @description The values for option config can vary based on the Modifier created. */ readonly config?: { - /** @description (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string. - * */ + /** @description (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string. */ readonly default_value?: string; - /** @description (checkbox) Flag for setting the checkbox to be checked by default. - * */ + /** @description (checkbox) Flag for setting the checkbox to be checked by default. */ readonly checked_by_default?: boolean; - /** @description (checkbox) Label displayed for the checkbox option. - * */ + /** @description (checkbox) Label displayed for the checkbox option. */ readonly checkbox_label?: string; - /** @description (date) Flag to limit the dates allowed to be entered on a date option. - * */ + /** @description (date) Flag to limit the dates allowed to be entered on a date option. */ readonly date_limited?: boolean; /** * @description (date) The type of limit that is allowed to be entered on a date option. - * * @example range * @enum {string} */ @@ -804,100 +703,83 @@ export interface operations { /** * Format: date-time * @description (date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string. - * */ readonly date_earliest_value?: string; /** * Format: date-time * @description (date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string. - * */ readonly date_latest_value?: string; /** * @description (file) The kind of restriction on the file types that can be uploaded with a file upload option. Values: `specific` - restricts uploads to particular file types; `all` - allows all file types. - * * @example specific * @enum {string} */ readonly file_types_mode?: "specific" | "all"; - /** @description (file) The type of files allowed to be uploaded if the `file_type_option` is set to `specific`. Values: + /** + * @description (file) The type of files allowed to be uploaded if the `file_type_option` is set to `specific`. Values: * `images` - Allows upload of image MIME types (`bmp`, `gif`, `jpg`, `jpeg`, `jpe`, `jif`, `jfif`, `jfi`, `png`, `wbmp`, `xbm`, `tiff`). `documents` - Allows upload of document MIME types (`txt`, `pdf`, `rtf`, `doc`, `docx`, `xls`, `xlsx`, `accdb`, `mdb`, `one`, `pps`, `ppsx`, `ppt`, `pptx`, `pub`, `odt`, `ods`, `odp`, `odg`, `odf`). * `other` - Allows file types defined in the `file_types_other` array. - * */ + */ readonly file_types_supported?: readonly string[]; - /** @description (file) A list of other file types allowed with the file upload option. - * */ + /** @description (file) A list of other file types allowed with the file upload option. */ readonly file_types_other?: readonly string[]; /** * @description (file) The maximum size for a file that can be used with the file upload option. This will still be limited by the server. - * * @example 5 */ readonly file_max_size?: number; - /** @description (text, multi_line_text) Flag to validate the length of a text or multi-line text input. - * */ + /** @description (text, multi_line_text) Flag to validate the length of a text or multi-line text input. */ readonly text_characters_limited?: boolean; /** * @description (text, multi_line_text) The minimum length allowed for a text or multi-line text option. - * * @example 1 */ readonly text_min_length?: number; /** * @description (text, multi_line_text) The maximum length allowed for a text or multi line text option. - * * @example 55 */ readonly text_max_length?: number; /** * @description (multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input. - * * @example true */ readonly text_lines_limited?: boolean; /** * @description (multi_line_text) The maximum number of lines allowed on a multi-line text input. - * * @example 4 */ readonly text_max_lines?: number; /** * @description (numbers_only_text) Flag to limit the value of a number option. - * * @example true */ readonly number_limited?: boolean; /** * @description (numbers_only_text) The type of limit on values entered for a number option. - * * @example lowest * @enum {string} */ readonly number_limit_mode?: "lowest" | "highest" | "range"; /** * @description (numbers_only_text) The lowest allowed value for a number option if `number_limited` is true. - * * @example 100 */ readonly number_lowest_value?: number; - /** @description (numbers_only_text) The highest allowed value for a number option if `number_limited` is true. - * */ + /** @description (numbers_only_text) The highest allowed value for a number option if `number_limited` is true. */ readonly number_highest_value?: number; /** * @description (numbers_only_text) Flag to limit the input on a number option to whole numbers only. - * * @example false */ readonly number_integers_only?: boolean; - /** @description (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list. - * */ + /** @description (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list. */ readonly product_list_adjusts_inventory?: boolean; - /** @description (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price. - * */ + /** @description (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price. */ readonly product_list_adjusts_pricing?: boolean; /** * @description (product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. Values: `none` - don't adjust; `weight` - use shipping weight only; `package` - use weight and dimensions. - * * @example weight * @enum {string} */ @@ -911,28 +793,23 @@ export interface operations { readonly option_values?: readonly ({ /** * @description The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers. - * * @example false */ readonly is_default?: boolean; /** * @description The text display identifying the value on the storefront. Required in a /POST. - * * @example Green */ readonly label: string; /** * @description The order in which the value will be displayed on the product page. Required in a /POST. - * * @example 0 */ readonly sort_order: number; - /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. - * */ + /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. */ readonly value_data?: Record; } & { - /** @description The unique numeric ID of the value; increments sequentially. - * */ + /** @description The unique numeric ID of the value; increments sequentially. */ readonly id?: number; })[]; /** @description Publicly available image url */ @@ -940,7 +817,6 @@ export interface operations { } & { /** * @description The unique option name, auto-generated from the display name, a timestamp, and the product ID. - * * @example Add-a-$5-Donation1535042499-187 */ readonly name?: string; @@ -953,8 +829,7 @@ export interface operations { }; }; }; - /** @description Option was in conflict with another option. This is the result of duplicate unique fields, such as `name`. - * */ + /** @description Option was in conflict with another option. This is the result of duplicate unique fields, such as `name`. */ readonly 409: { headers: { readonly [name: string]: unknown; @@ -966,18 +841,15 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; }; }; - /** @description Option was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description Option was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -989,11 +861,9 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -1014,11 +884,9 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `Option`. - * */ + /** @description The ID of the `Option`. */ readonly option_id: components["parameters"]["OptionIdParam"]; }; readonly cookie?: never; @@ -1036,16 +904,14 @@ export interface operations { }; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -1066,11 +932,9 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `Option`. - * */ + /** @description The ID of the `Option`. */ readonly option_id: components["parameters"]["OptionIdParam"]; }; readonly cookie?: never; @@ -1080,25 +944,21 @@ export interface operations { readonly "application/json": { /** * @description The unique numerical ID of the option, increments sequentially. - * * @example 55 */ readonly id?: number | null; /** * @description The unique numerical ID of the product to which the option belongs. - * * @example 4 */ readonly product_id?: number; /** * @description The name of the option shown on the storefront. - * * @example Add-a-$5-Donation1535042499-187 */ readonly display_name?: string; /** * @description The type of option, which determines how it will display on the storefront. Acceptable values: `radio_buttons`, `rectangles`, `dropdown`, `product_list`, `product_list_with_images`, `swatch`. For reference, the former v2 API values are: RB = radio_buttons, RT = rectangles, S = dropdown, P = product_list, PI = product_list_with_images, CS = swatch. - * * @enum {string} */ readonly type?: "radio_buttons" | "rectangles" | "dropdown" | "product_list" | "product_list_with_images" | "swatch"; @@ -1107,21 +967,16 @@ export interface operations { * @description The values for option config can vary based on the Modifier created. */ readonly config?: { - /** @description (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string. - * */ + /** @description (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string. */ readonly default_value?: string; - /** @description (checkbox) Flag for setting the checkbox to be checked by default. - * */ + /** @description (checkbox) Flag for setting the checkbox to be checked by default. */ readonly checked_by_default?: boolean; - /** @description (checkbox) Label displayed for the checkbox option. - * */ + /** @description (checkbox) Label displayed for the checkbox option. */ readonly checkbox_label?: string; - /** @description (date) Flag to limit the dates allowed to be entered on a date option. - * */ + /** @description (date) Flag to limit the dates allowed to be entered on a date option. */ readonly date_limited?: boolean; /** * @description (date) The type of limit that is allowed to be entered on a date option. - * * @example range * @enum {string} */ @@ -1129,20 +984,17 @@ export interface operations { /** * Format: date-time * @description (date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string. - * * @example 2018-08-31T00:00:00+00:00 */ readonly date_earliest_value?: string; /** * Format: date-time * @description (date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string. - * * @example 2019-01-01T00:00:00+00:00 */ readonly date_latest_value?: string; /** * @description (file) The kind of restriction on the file types that can be uploaded with a file upload option. Values: `specific` - restricts uploads to particular file types; `all` - allows all file types. - * * @example specific * @enum {string} */ @@ -1151,7 +1003,6 @@ export interface operations { * @description (file) The type of files allowed to be uploaded if the `file_type_option` is set to `specific`. Values: * `images` - Allows upload of image MIME types (`bmp`, `gif`, `jpg`, `jpeg`, `jpe`, `jif`, `jfif`, `jfi`, `png`, `wbmp`, `xbm`, `tiff`). `documents` - Allows upload of document MIME types (`txt`, `pdf`, `rtf`, `doc`, `docx`, `xls`, `xlsx`, `accdb`, `mdb`, `one`, `pps`, `ppsx`, `ppt`, `pptx`, `pub`, `odt`, `ods`, `odp`, `odg`, `odf`). * `other` - Allows file types defined in the `file_types_other` array. - * * @example [ * "images", * "documents", @@ -1161,7 +1012,6 @@ export interface operations { readonly file_types_supported?: readonly string[]; /** * @description (file) A list of other file types allowed with the file upload option. - * * @example [ * "pdf", * "txt" @@ -1170,74 +1020,60 @@ export interface operations { readonly file_types_other?: readonly string[]; /** * @description (file) The maximum size for a file that can be used with the file upload option. This will still be limited by the server. - * * @example 5 */ readonly file_max_size?: number; - /** @description (text, multi_line_text) Flag to validate the length of a text or multi-line text input. - * */ + /** @description (text, multi_line_text) Flag to validate the length of a text or multi-line text input. */ readonly text_characters_limited?: boolean; /** * @description (text, multi_line_text) The minimum length allowed for a text or multi-line text option. - * * @example 1 */ readonly text_min_length?: number; /** * @description (text, multi_line_text) The maximum length allowed for a text or multi line text option. - * * @example 55 */ readonly text_max_length?: number; /** * @description (multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input. - * * @example true */ readonly text_lines_limited?: boolean; /** * @description (multi_line_text) The maximum number of lines allowed on a multi-line text input. - * * @example 4 */ readonly text_max_lines?: number; /** * @description (numbers_only_text) Flag to limit the value of a number option. - * * @example true */ readonly number_limited?: boolean; /** * @description (numbers_only_text) The type of limit on values entered for a number option. - * * @example lowest * @enum {string} */ readonly number_limit_mode?: "lowest" | "highest" | "range"; /** * @description (numbers_only_text) The lowest allowed value for a number option if `number_limited` is true. - * * @example 100 */ readonly number_lowest_value?: number; - /** @description (numbers_only_text) The highest allowed value for a number option if `number_limited` is true. - * */ + /** @description (numbers_only_text) The highest allowed value for a number option if `number_limited` is true. */ readonly number_highest_value?: number; /** * @description (numbers_only_text) Flag to limit the input on a number option to whole numbers only. - * * @example false */ readonly number_integers_only?: boolean; - /** @description (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list. - * */ + /** @description (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list. */ readonly product_list_adjusts_inventory?: boolean; - /** @description (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price. - * */ + /** @description (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price. */ readonly product_list_adjusts_pricing?: boolean; /** * @description (product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. Values: `none` - don't adjust; `weight` - use shipping weight only; `package` - use weight and dimensions. - * * @example weight * @enum {string} */ @@ -1251,28 +1087,23 @@ export interface operations { readonly option_values?: readonly ({ /** * @description The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers. - * * @example false */ readonly is_default?: boolean; /** * @description The text display identifying the value on the storefront. Required in a /POST. - * * @example Green */ readonly label: string; /** * @description The order in which the value will be displayed on the product page. Required in a /POST. - * * @example 0 */ readonly sort_order: number; - /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. - * */ + /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. */ readonly value_data?: Record; } & { - /** @description The unique numeric ID of the value; increments sequentially. - * */ + /** @description The unique numeric ID of the value; increments sequentially. */ readonly id?: number; })[]; /** @description Publicly available image url */ @@ -1286,7 +1117,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 220, * "product_id": 192, @@ -1343,31 +1175,28 @@ export interface operations { * "config": {} * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { /** Option */ readonly data?: { /** * @description The unique numerical ID of the option, increments sequentially. - * * @example 55 */ readonly id?: number; /** * @description The unique numerical ID of the product to which the option belongs. - * * @example 4 */ readonly product_id?: number; /** * @description The name of the option shown on the storefront. - * * @example Add-a-$5-Donation1535042499-187 */ readonly display_name?: string; /** * @description The type of option, which determines how it will display on the storefront. Acceptable values: `radio_buttons`, `rectangles`, `dropdown`, `product_list`, `product_list_with_images`, `swatch`. For reference, the former v2 API values are: RB = radio_buttons, RT = rectangles, S = dropdown, P = product_list, PI = product_list_with_images, CS = swatch. - * * @enum {string} */ readonly type?: "radio_buttons" | "rectangles" | "dropdown" | "product_list" | "product_list_with_images" | "swatch"; @@ -1376,21 +1205,16 @@ export interface operations { * @description The values for option config can vary based on the Modifier created. */ readonly config?: { - /** @description (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string. - * */ + /** @description (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string. */ readonly default_value?: string; - /** @description (checkbox) Flag for setting the checkbox to be checked by default. - * */ + /** @description (checkbox) Flag for setting the checkbox to be checked by default. */ readonly checked_by_default?: boolean; - /** @description (checkbox) Label displayed for the checkbox option. - * */ + /** @description (checkbox) Label displayed for the checkbox option. */ readonly checkbox_label?: string; - /** @description (date) Flag to limit the dates allowed to be entered on a date option. - * */ + /** @description (date) Flag to limit the dates allowed to be entered on a date option. */ readonly date_limited?: boolean; /** * @description (date) The type of limit that is allowed to be entered on a date option. - * * @example range * @enum {string} */ @@ -1398,100 +1222,83 @@ export interface operations { /** * Format: date * @description (date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string. - * */ readonly date_earliest_value?: string; /** * Format: date * @description (date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string. - * */ readonly date_latest_value?: string; /** * @description (file) The kind of restriction on the file types that can be uploaded with a file upload option. Values: `specific` - restricts uploads to particular file types; `all` - allows all file types. - * * @example specific * @enum {string} */ readonly file_types_mode?: "specific" | "all"; - /** @description (file) The type of files allowed to be uploaded if the `file_type_option` is set to `specific`. Values: + /** + * @description (file) The type of files allowed to be uploaded if the `file_type_option` is set to `specific`. Values: * `images` - Allows upload of image MIME types (`bmp`, `gif`, `jpg`, `jpeg`, `jpe`, `jif`, `jfif`, `jfi`, `png`, `wbmp`, `xbm`, `tiff`). `documents` - Allows upload of document MIME types (`txt`, `pdf`, `rtf`, `doc`, `docx`, `xls`, `xlsx`, `accdb`, `mdb`, `one`, `pps`, `ppsx`, `ppt`, `pptx`, `pub`, `odt`, `ods`, `odp`, `odg`, `odf`). * `other` - Allows file types defined in the `file_types_other` array. - * */ + */ readonly file_types_supported?: readonly string[]; - /** @description (file) A list of other file types allowed with the file upload option. - * */ + /** @description (file) A list of other file types allowed with the file upload option. */ readonly file_types_other?: readonly string[]; /** * @description (file) The maximum size for a file that can be used with the file upload option. This will still be limited by the server. - * * @example 5 */ readonly file_max_size?: number; - /** @description (text, multi_line_text) Flag to validate the length of a text or multi-line text input. - * */ + /** @description (text, multi_line_text) Flag to validate the length of a text or multi-line text input. */ readonly text_characters_limited?: boolean; /** * @description (text, multi_line_text) The minimum length allowed for a text or multi-line text option. - * * @example 1 */ readonly text_min_length?: number; /** * @description (text, multi_line_text) The maximum length allowed for a text or multi line text option. - * * @example 55 */ readonly text_max_length?: number; /** * @description (multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input. - * * @example true */ readonly text_lines_limited?: boolean; /** * @description (multi_line_text) The maximum number of lines allowed on a multi-line text input. - * * @example 4 */ readonly text_max_lines?: number; /** * @description (numbers_only_text) Flag to limit the value of a number option. - * * @example true */ readonly number_limited?: boolean; /** * @description (numbers_only_text) The type of limit on values entered for a number option. - * * @example lowest * @enum {string} */ readonly number_limit_mode?: "lowest" | "highest" | "range"; /** * @description (numbers_only_text) The lowest allowed value for a number option if `number_limited` is true. - * * @example 100 */ readonly number_lowest_value?: number; - /** @description (numbers_only_text) The highest allowed value for a number option if `number_limited` is true. - * */ + /** @description (numbers_only_text) The highest allowed value for a number option if `number_limited` is true. */ readonly number_highest_value?: number; /** * @description (numbers_only_text) Flag to limit the input on a number option to whole numbers only. - * * @example false */ readonly number_integers_only?: boolean; - /** @description (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list. - * */ + /** @description (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list. */ readonly product_list_adjusts_inventory?: boolean; - /** @description (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price. - * */ + /** @description (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price. */ readonly product_list_adjusts_pricing?: boolean; /** * @description (product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. Values: `none` - don't adjust; `weight` - use shipping weight only; `package` - use weight and dimensions. - * * @example weight * @enum {string} */ @@ -1505,28 +1312,23 @@ export interface operations { readonly option_values?: readonly ({ /** * @description The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers. - * * @example false */ readonly is_default?: boolean; /** * @description The text display identifying the value on the storefront. Required in a /POST. - * * @example Green */ readonly label: string; /** * @description The order in which the value will be displayed on the product page. Required in a /POST. - * * @example 0 */ readonly sort_order: number; - /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. - * */ + /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. */ readonly value_data?: Record; } & { - /** @description The unique numeric ID of the value; increments sequentially. - * */ + /** @description The unique numeric ID of the value; increments sequentially. */ readonly id?: number; })[]; /** @description Publicly available image url */ @@ -1534,7 +1336,6 @@ export interface operations { } & { /** * @description The unique option name, auto-generated from the display name, a timestamp, and the product ID. - * * @example Add-a-$5-Donation1535042499-187 */ readonly name?: string; @@ -1543,8 +1344,7 @@ export interface operations { }; }; }; - /** @description The `Option` was in conflict with another option. This is the result of duplicate unique fields, such as `name`. - * */ + /** @description The `Option` was in conflict with another option. This is the result of duplicate unique fields, such as `name`. */ readonly 409: { headers: { readonly [name: string]: unknown; @@ -1556,18 +1356,15 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; }; }; - /** @description The `Option` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description The `Option` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -1579,11 +1376,9 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -1599,11 +1394,9 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `Option`. - * */ + /** @description The ID of the `Option`. */ readonly option_id: components["parameters"]["OptionIdParam"]; }; readonly cookie?: never; @@ -1621,11 +1414,9 @@ export interface operations { readonly getProductVariantOptionValues: { readonly parameters: { readonly query?: { - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */ readonly include_fields?: components["parameters"]["IncludeFieldsParam"]; @@ -1637,11 +1428,9 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `Option`. - * */ + /** @description The ID of the `Option`. */ readonly option_id: components["parameters"]["OptionIdParam"]; }; readonly cookie?: never; @@ -1653,7 +1442,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": [ * { * "id": 174, @@ -1712,33 +1502,29 @@ export interface operations { * } * } * } - * } */ + * } + */ readonly "application/json": { readonly data?: readonly ({ /** * @description The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers. - * * @example false */ readonly is_default?: boolean; /** * @description The text display identifying the value on the storefront. Required in a /POST. - * * @example Green */ readonly label: string; /** * @description The order in which the value will be displayed on the product page. Required in a /POST. - * * @example 0 */ readonly sort_order: number; - /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. - * */ + /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. */ readonly value_data?: Record; } & { - /** @description The unique numeric ID of the value; increments sequentially. - * */ + /** @description The unique numeric ID of the value; increments sequentially. */ readonly id?: number; })[]; readonly meta?: components["schemas"]["metaCollection_Full"]; @@ -1757,11 +1543,9 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `Option`. - * */ + /** @description The ID of the `Option`. */ readonly option_id: components["parameters"]["OptionIdParam"]; }; readonly cookie?: never; @@ -1771,24 +1555,20 @@ export interface operations { readonly "application/json": { /** * @description The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers. - * * @example false */ readonly is_default?: boolean; /** * @description The text display identifying the value on the storefront. Required in a /POST. - * * @example Green */ readonly label: string; /** * @description The order in which the value will be displayed on the product page. Required in a /POST. - * * @example 0 */ readonly sort_order: number; - /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. - * */ + /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. */ readonly value_data?: Record; }; }; @@ -1799,7 +1579,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 44, * "label": "Pick a color", @@ -1811,42 +1592,37 @@ export interface operations { * }, * "is_default": false * } - * } */ + * } + */ readonly "application/json": { /** Option Value */ readonly data?: { /** * @description The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers. - * * @example false */ readonly is_default?: boolean; /** * @description The text display identifying the value on the storefront. Required in a /POST. - * * @example Green */ readonly label: string; /** * @description The order in which the value will be displayed on the product page. Required in a /POST. - * * @example 0 */ readonly sort_order: number; - /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. - * */ + /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. */ readonly value_data?: Record; } & { - /** @description The unique numeric ID of the value; increments sequentially. - * */ + /** @description The unique numeric ID of the value; increments sequentially. */ readonly id?: number; }; readonly meta?: components["schemas"]["metaEmpty_Full"]; }; }; }; - /** @description The `OptionValue` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description The `OptionValue` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -1858,11 +1634,9 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -1883,14 +1657,11 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `Option`. - * */ + /** @description The ID of the `Option`. */ readonly option_id: components["parameters"]["OptionIdParam"]; - /** @description The ID of the `Modifier/Option Value`. - * */ + /** @description The ID of the `Modifier/Option Value`. */ readonly value_id: components["parameters"]["ValueIdParam"]; }; readonly cookie?: never; @@ -1902,7 +1673,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 44, * "label": "Pick a color", @@ -1914,50 +1686,44 @@ export interface operations { * }, * "is_default": false * } - * } */ + * } + */ readonly "application/json": { /** Option Value */ readonly data?: { /** * @description The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers. - * * @example false */ readonly is_default?: boolean; /** * @description The text display identifying the value on the storefront. Required in a /POST. - * * @example Green */ readonly label: string; /** * @description The order in which the value will be displayed on the product page. Required in a /POST. - * * @example 0 */ readonly sort_order: number; - /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. - * */ + /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. */ readonly value_data?: Record; } & { - /** @description The unique numeric ID of the value; increments sequentially. - * */ + /** @description The unique numeric ID of the value; increments sequentially. */ readonly id?: number; }; readonly meta?: components["schemas"]["metaEmpty_Full"]; }; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -1978,47 +1744,38 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `Option`. - * */ + /** @description The ID of the `Option`. */ readonly option_id: components["parameters"]["OptionIdParam"]; - /** @description The ID of the `Modifier/Option Value`. - * */ + /** @description The ID of the `Modifier/Option Value`. */ readonly value_id: components["parameters"]["ValueIdParam"]; }; readonly cookie?: never; }; - /** @description A BigCommerce `OptionValue` object. - * */ + /** @description A BigCommerce `OptionValue` object. */ readonly requestBody: { readonly content: { readonly "application/json": { /** * @description The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers. - * * @example false */ readonly is_default?: boolean; /** * @description The text display identifying the value on the storefront. Required in a /POST. - * * @example Green */ readonly label: string; /** * @description The order in which the value will be displayed on the product page. Required in a /POST. - * * @example 0 */ readonly sort_order: number; - /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. - * */ + /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. */ readonly value_data?: Record; } & { - /** @description The unique numeric ID of the value; increments sequentially. - * */ + /** @description The unique numeric ID of the value; increments sequentially. */ readonly id?: number; }; }; @@ -2029,7 +1786,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 44, * "label": "Pick a color", @@ -2041,34 +1799,30 @@ export interface operations { * }, * "is_default": false * } - * } */ + * } + */ readonly "application/json": { /** Option Value */ readonly data?: { /** * @description The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers. - * * @example false */ readonly is_default?: boolean; /** * @description The text display identifying the value on the storefront. Required in a /POST. - * * @example Green */ readonly label: string; /** * @description The order in which the value will be displayed on the product page. Required in a /POST. - * * @example 0 */ readonly sort_order: number; - /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. - * */ + /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. */ readonly value_data?: Record; } & { - /** @description The unique numeric ID of the value; increments sequentially. - * */ + /** @description The unique numeric ID of the value; increments sequentially. */ readonly id?: number; }; readonly meta?: components["schemas"]["metaEmpty_Full"]; @@ -2082,8 +1836,7 @@ export interface operations { }; content?: never; }; - /** @description The `OptionValue` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description The `OptionValue` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -2095,11 +1848,9 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -2115,14 +1866,11 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `Option`. - * */ + /** @description The ID of the `Option`. */ readonly option_id: components["parameters"]["OptionIdParam"]; - /** @description The ID of the `Modifier/Option Value`. - * */ + /** @description The ID of the `Modifier/Option Value`. */ readonly value_id: components["parameters"]["ValueIdParam"]; }; readonly cookie?: never; diff --git a/src/internal/reference/generated/catalog/product_variants_catalog.v3.ts b/src/internal/reference/generated/catalog/product_variants_catalog.v3.ts index a7ca047..c90c9ae 100644 --- a/src/internal/reference/generated/catalog/product_variants_catalog.v3.ts +++ b/src/internal/reference/generated/catalog/product_variants_catalog.v3.ts @@ -12,8 +12,7 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. - * */ + /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. */ readonly product_id: components["parameters"]["ProductIdPathParam"]; }; readonly cookie?: never; @@ -50,11 +49,9 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. - * */ + /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. */ readonly product_id: components["parameters"]["ProductIdPathParam"]; - /** @description ID of the variant on a product, or on an associated Price List Record. - * */ + /** @description ID of the variant on a product, or on an associated Price List Record. */ readonly variant_id: components["parameters"]["VariantIdParam"]; }; readonly cookie?: never; @@ -83,11 +80,9 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. - * */ + /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. */ readonly product_id: components["parameters"]["ProductIdPathParam"]; - /** @description ID of the variant on a product, or on an associated Price List Record. - * */ + /** @description ID of the variant on a product, or on an associated Price List Record. */ readonly variant_id: components["parameters"]["VariantIdParam"]; }; readonly cookie?: never; @@ -122,14 +117,11 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. - * */ + /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. */ readonly product_id: components["parameters"]["ProductIdPathParam"]; - /** @description ID of the variant on a product, or on an associated Price List Record. - * */ + /** @description ID of the variant on a product, or on an associated Price List Record. */ readonly variant_id: components["parameters"]["VariantIdParam"]; - /** @description The ID of the `Metafield`. - * */ + /** @description The ID of the `Metafield`. */ readonly metafield_id: components["parameters"]["MetafieldIdParam"]; }; readonly cookie?: never; @@ -171,11 +163,9 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. - * */ + /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. */ readonly product_id: components["parameters"]["ProductIdPathParam"]; - /** @description ID of the variant on a product, or on an associated Price List Record. - * */ + /** @description ID of the variant on a product, or on an associated Price List Record. */ readonly variant_id: components["parameters"]["VariantIdParam"]; }; readonly cookie?: never; @@ -265,7 +255,6 @@ export interface components { /** * categoriesTree_Resp * @description Returns the categories tree, a nested lineage of the categories with parent->child relationship. The Category objects returned are simplified versions of the category objects returned in the rest of this API. - * */ readonly categoriesTree_Resp: { readonly data?: readonly components["schemas"]["categoriesTreeNode_Full"][]; @@ -278,31 +267,26 @@ export interface components { readonly categoriesTreeNode_Full: { /** * @description The unique numeric ID of the category; increments sequentially. - * * @example 26 */ readonly id?: number; /** * @description The unique numeric ID of the categoryʼs parent. This field controls where the category sits in the tree of categories that organize the catalog. - * * @example 25 */ readonly parent_id?: number; /** * @description The name displayed for the category. Name is unique with respect to the categoryʼs siblings. - * * @example Bath */ readonly name?: string; /** * @description Flag to determine whether the product should be displayed to customers browsing the store. If `true`, the category will be displayed. If `false`, the category will be hidden from view. - * * @example true */ readonly is_visible?: boolean; /** * @description The custom URL for the category on the storefront. - * * @example /towels/bath-towels/ */ readonly url?: string; @@ -340,28 +324,23 @@ export interface components { /** * Format: double * @description Width of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default width (set in the Product resourceʼs `width` field) will be used as the base width. - * */ readonly width?: number | null; /** * Format: double * @description Height of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default height (set in the Product resourceʼs `height` field) will be used as the base height. - * */ readonly height?: number | null; /** * Format: double * @description Depth of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default depth (set in the Product resourceʼs `depth` field) will be used as the base depth. - * */ readonly depth?: number | null; - /** @description Flag used to indicate whether the variant has free shipping. If `true`, the shipping cost for the variant will be zero. - * */ + /** @description Flag used to indicate whether the variant has free shipping. If `true`, the shipping cost for the variant will be zero. */ readonly is_free_shipping?: boolean; /** * Format: double * @description A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation. - * */ readonly fixed_cost_shipping_price?: number | null; /** @description If `true`, this variant will not be purchasable on the storefront. */ @@ -372,13 +351,15 @@ export interface components { readonly upc?: string | null; /** @description Publicly available image url */ readonly image_url?: string; - /** @description Inventory level for the variant, which is used when the product’s inventory_tracking is set to `variant`. The Catalog API returns the inventory for only the default location. + /** + * @description Inventory level for the variant, which is used when the product’s inventory_tracking is set to `variant`. The Catalog API returns the inventory for only the default location. * * The inventory for a variant cannot exceed 2,147,483,647 in the catalog. The sum of the variant inventories, or the total inventory for a product, cannot exceed 2,147,483,647. * * If you exceed the limit, the store sets the variant inventory to the limit if no other variant inventories are set. If other variant inventories are set, the store does not save the variant inventory rather than setting the variant inventory to the remaining limit. * - * The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). */ + * The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). + */ readonly inventory_level?: number | null; /** @description When the variant hits this inventory level, it is considered low stock. */ readonly inventory_warning_level?: number | null; @@ -401,7 +382,6 @@ export interface components { /** * Format: double * @description The price of the variant as seen on the storefront. This price takes into account `sale_price` and any price adjustment rules that are applicable to this variant. - * */ readonly calculated_price?: number; readonly calculated_weight?: number; @@ -409,7 +389,6 @@ export interface components { /** * productVariant_Post * @description The model for a POST to create variants on a product. - * */ readonly productVariant_Post: { /** @@ -440,28 +419,23 @@ export interface components { /** * Format: double * @description Width of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default width (set in the Product resourceʼs `width` field) will be used as the base width. - * */ readonly width?: number | null; /** * Format: double * @description Height of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default height (set in the Product resourceʼs `height` field) will be used as the base height. - * */ readonly height?: number | null; /** * Format: double * @description Depth of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default depth (set in the Product resourceʼs `depth` field) will be used as the base depth. - * */ readonly depth?: number | null; - /** @description Flag used to indicate whether the variant has free shipping. If `true`, the shipping cost for the variant will be zero. - * */ + /** @description Flag used to indicate whether the variant has free shipping. If `true`, the shipping cost for the variant will be zero. */ readonly is_free_shipping?: boolean; /** * Format: double * @description A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation. - * */ readonly fixed_cost_shipping_price?: number | null; /** @description If `true`, this variant will not be purchasable on the storefront. */ @@ -470,13 +444,15 @@ export interface components { readonly purchasing_disabled_message?: string; /** @description The UPC code used in feeds for shopping comparison sites and external channel integrations. */ readonly upc?: string | null; - /** @description Inventory level for the variant, which is used when the product’s inventory_tracking is set to `variant`. The Catalog API returns the inventory for only the default location. + /** + * @description Inventory level for the variant, which is used when the product’s inventory_tracking is set to `variant`. The Catalog API returns the inventory for only the default location. * * The inventory for a variant cannot exceed 2,147,483,647 in the catalog. The sum of the variant inventories, or the total inventory for a product, cannot exceed 2,147,483,647. * * If you exceed the limit, the store sets the variant inventory to the limit if no other variant inventories are set. If other variant inventories are set, the store does not save the variant inventory rather than setting the variant inventory to the remaining limit. * - * The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). */ + * The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). + */ readonly inventory_level?: number | null; /** @description When the variant hits this inventory level, it is considered low stock. */ readonly inventory_warning_level?: number | null; @@ -504,13 +480,11 @@ export interface components { readonly productVariantOptionValue_Full: { /** * @description The name of the option. - * * @example Color */ readonly option_display_name?: string; /** * @description The label of the option value. - * * @example Beige */ readonly label?: string; @@ -538,19 +512,16 @@ export interface components { readonly metafield_Base: { /** * @description The name of the field, for example: `location_id`, `color`. Required for POST. - * * @example Location */ readonly key: string; /** * @description The value of the field, for example: `1`, `blue`. You must enter a JSON formatted string for [ShipperHQ](/docs/store-operations/shipping/shipper-hq#shipperhq-object-properties) metafields. Required for POST. - * * @example 4HG */ readonly value: string; /** * @description Namespace for the metafield, for organizational purposes. This is set by the developer. Required for POST. - * * @example Warehouse Locations */ readonly namespace: string; @@ -569,7 +540,6 @@ export interface components { readonly permission_set: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; /** * @description Description for the metafields. - * * @example Location in the warehouse */ readonly description?: string; @@ -593,48 +563,39 @@ export interface components { readonly pagination_Full: { /** * @description Total number of items in the result set. - * * @example 36 */ readonly total?: number; /** * @description Total number of items in the collection response. - * * @example 36 */ readonly count?: number; /** * @description The amount of items returned in the collection per page, controlled by the limit parameter. - * * @example 50 */ readonly per_page?: number; /** * @description The page you are currently on within the collection. - * * @example 1 */ readonly current_page?: number; /** * @description The total number of pages in the collection. - * * @example 1 */ readonly total_pages?: number; - /** @description Pagination links for the previous and next parts of the whole collection. - * */ + /** @description Pagination links for the previous and next parts of the whole collection. */ readonly links?: { - /** @description Link to the previous page returned in the response. - * */ + /** @description Link to the previous page returned in the response. */ readonly previous?: string; /** * @description Link to the current page returned in the response. - * * @example ?page=1&limit=50 */ readonly current?: string; - /** @description Link to the next page returned in the response. - * */ + /** @description Link to the next page returned in the response. */ readonly next?: string; }; }; @@ -672,28 +633,24 @@ export interface components { } & components["schemas"]["metafield_Base"] & { /** * @description The type of resource with which the metafield is associated. - * * @example product * @enum {string} */ readonly resource_type?: "category" | "brand" | "product" | "variant"; /** * @description The ID of the resource with which the metafield is associated. - * * @example 111 */ readonly resource_id?: number; /** * Format: date-time * @description Date and time of the metafieldʼs creation. Read-Only. - * * @example 2018-05-07T20:14:17+00:00 */ readonly date_created?: string; /** * Format: date-time * @description Date and time when the metafield was last updated. Read-Only. - * * @example 2018-05-07T20:14:17+00:00 */ readonly date_modified?: string; @@ -706,26 +663,22 @@ export interface components { readonly product_id?: number; readonly sku?: string; }; - /** @description Common metafield properties. - * */ + /** @description Common metafield properties. */ readonly Metafield: { /** @description The unique identifier for the metafield. */ readonly id?: number; /** * @description The name of the field, for example: `location_id`, `color`. - * * @example Staff Name */ readonly key?: string; /** * @description The value of the field, for example: `1`, `blue`. - * * @example Ronaldo */ readonly value?: string; /** * @description Namespace for the metafield, for organizational purposes. - * * @example Sales Department */ readonly namespace?: string; @@ -738,26 +691,22 @@ export interface components { * | `write` | Open for reading and writing by other API consumers. | * | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | * | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | - * * @enum {string} */ readonly permission_set?: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; /** * @description The type of resource with which the metafield is associated. - * * @example cart * @enum {string} */ readonly resource_type?: "brand" | "product" | "variant" | "category" | "cart" | "channel" | "location" | "order" | "customer"; /** * @description The unique identifier for the resource with which the metafield is associated. - * * @example 424242 */ readonly resource_id?: number; /** * @description Description for the metafields. - * * @example order */ readonly description?: string; @@ -779,14 +728,12 @@ export interface components { */ readonly owner_client_id?: string; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponse: { readonly data?: readonly components["schemas"]["Metafield"][]; readonly meta?: components["schemas"]["CollectionMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponse_POST_PUT: { readonly data?: readonly components["schemas"]["Metafield"][]; /** @@ -796,31 +743,32 @@ export interface components { readonly errors?: readonly unknown[]; readonly meta?: components["schemas"]["CollectionMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponsePartialSuccess_POST_PUT: { readonly data?: readonly components["schemas"]["Metafield"][]; readonly errors?: readonly components["schemas"]["Error"][]; readonly meta?: components["schemas"]["WriteCollectionPartialSuccessMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponsePartialSuccess_DELETE: { - /** @example [ + /** + * @example [ * 123 - * ] */ + * ] + */ readonly data?: readonly number[]; readonly errors?: readonly components["schemas"]["Error"][]; readonly meta?: components["schemas"]["WriteCollectionPartialSuccessMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionDeleteResponseSuccess: { - /** @example [ + /** + * @example [ * 123, * 124, * 125 - * ] */ + * ] + */ readonly data?: readonly number[]; /** * @description Empty for 200 responses. @@ -836,19 +784,16 @@ export interface components { readonly WriteCollectionPartialSuccessMeta: { /** * @description Total number of items in the result set. - * * @example 3 */ readonly total?: number; /** * @description Total number of items that were successfully deleted. - * * @example 1 */ readonly success?: number; /** * @description Total number of items that failed to be deleted. - * * @example 2 */ readonly failed?: number; @@ -860,59 +805,49 @@ export interface components { readonly WriteCollectionSuccessMeta: { /** * @description Total number of items in the result set. - * * @example 3 */ readonly total?: number; /** * @description Total number of items that were successfully deleted. - * * @example 3 */ readonly success?: number; /** * @description Total number of items that failed to be deleted. - * * @example 0 */ readonly failed?: number; }; /** * @description Total number of items in the result set. - * * @example 3 */ readonly Total: number; /** * @description Total number of items that were successfully deleted. - * * @example 1 */ readonly Success: number; /** * @description Total number of items that failed to be deleted. - * * @example 2 */ readonly Failed: number; - /** @description Error response payload for the BigCommerce API. - * */ + /** @description Error response payload for the BigCommerce API. */ readonly Error: { /** * @description The HTTP status code for the error. - * * @example 422 */ readonly status?: number; /** * @description The error title. - * * @example Bulk operation has failed */ readonly title?: string; /** * @description The error type. - * * @example https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes */ readonly type?: string; @@ -920,7 +855,6 @@ export interface components { }; /** * @description Error detail response payload for the BigCommerce API. - * * @example { * "1": "Unauthorized to delete", * "2": "Metafield does not exist" @@ -941,72 +875,59 @@ export interface components { readonly pagination?: { /** * @description Total number of items in the result set. - * * @example 36 */ readonly total?: number; /** * @description Total number of items in the collection response. - * * @example 36 */ readonly count?: number; /** * @description The amount of items returned in the collection per page, controlled by the limit parameter. - * * @example 50 */ readonly per_page?: number; /** * @description The page you are currently on within the collection. - * * @example 1 */ readonly current_page?: number; /** * @description The total number of pages in the collection. - * * @example 1 */ readonly total_pages?: number; - /** @description Pagination links for the previous and next parts of the whole collection. - * */ + /** @description Pagination links for the previous and next parts of the whole collection. */ readonly links?: { - /** @description Link to the previous page returned in the response. - * */ + /** @description Link to the previous page returned in the response. */ readonly previous?: string; /** * @description Link to the current page returned in the response. - * * @example ?page=1&limit=50 */ readonly current?: string; - /** @description Link to the next page returned in the response. - * */ + /** @description Link to the next page returned in the response. */ readonly next?: string; }; }; } & { readonly [key: string]: unknown; }; - /** @description Common metafield properties. - * */ + /** @description Common metafield properties. */ readonly MetafieldBase_Post: { /** * @description The name of the field, for example: `location_id`, `color`. - * * @example Staff Name */ readonly key: string; /** * @description The value of the field, for example: `1`, `blue`. - * * @example Ronaldo */ readonly value: string; /** * @description Namespace for the metafield, for organizational purposes. - * * @example Sales Department */ readonly namespace: string; @@ -1019,35 +940,29 @@ export interface components { * | `write` | Open for reading and writing by other API consumers. | * | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | * | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | - * * @enum {string} */ readonly permission_set: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; /** * @description Description for the metafields. - * * @example Name of Staff Member */ readonly description?: string; }; - /** @description Common Metafield properties. - * */ + /** @description Common Metafield properties. */ readonly MetafieldBase_Put: { /** * @description The name of the field, for example: `location_id`, `color`. - * * @example Staff Name */ readonly key?: string; /** * @description The value of the field, for example: `1`, `blue`. - * * @example Ronaldo */ readonly value?: string; /** * @description Namespace for the metafield, for organizational purposes. - * * @example Sales Department */ readonly namespace?: string; @@ -1060,13 +975,11 @@ export interface components { * | `write` | Open for reading and writing by other API consumers. | * | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | * | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | - * * @enum {string} */ readonly permission_set?: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; /** * @description Description for the metafields. - * * @example Name of Staff Member */ readonly description?: string; @@ -1074,22 +987,20 @@ export interface components { }; responses: never; parameters: { - /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. - * */ + /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. */ readonly ProductIdPathParam: number; - /** @description ID of the variant on a product, or on an associated Price List Record. - * */ + /** @description ID of the variant on a product, or on an associated Price List Record. */ readonly VariantIdParam: number; - /** @description The ID of the `Metafield`. - * */ + /** @description The ID of the `Metafield`. */ readonly MetafieldIdParam: number; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept: string; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly ContentType: string; - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly PageParam: number; + /** @description A comma-separated list of entity ID values that filter results to metafields that belong to one of the matching entities. */ + readonly MetafieldResourceParam: string; /** @description Filter based on a metafieldʼs key. */ readonly MetafieldKeyParam: string; /** @description Filter based on comma-separated metafieldʼs keys. Could be used with vanilla `key` query parameter. */ @@ -1098,23 +1009,17 @@ export interface components { readonly MetafieldNamespaceParam: string; /** @description Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. */ readonly MetafieldNamespaceInParam: readonly string[]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly LimitParam: number; - /** @description Sort direction. Acceptable values are: `asc`, `desc`. - * */ + /** @description Sort direction. Acceptable values are: `asc`, `desc`. */ readonly DirectionParam: "asc" | "desc"; - /** @description 'Query parameter that lets you filter by the minimum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.' - * */ + /** @description 'Query parameter that lets you filter by the minimum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.' */ readonly date_created_min: string; - /** @description 'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.' - * */ + /** @description 'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.' */ readonly date_created_max: string; - /** @description 'Query parameter that lets you filter by the maximum date modified, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.' - * */ + /** @description 'Query parameter that lets you filter by the maximum date modified, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.' */ readonly date_modified_max: string; - /** @description 'Query parameter that lets you filter by the minimum date modified, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.' - * */ + /** @description 'Query parameter that lets you filter by the minimum date modified, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.' */ readonly date_modified_min: string; /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */ readonly IncludeFieldsParam: readonly string[]; @@ -1124,10 +1029,9 @@ export interface components { readonly ExcludeFieldsParam: readonly string[]; /** @description A comma-separated list of IDs of products you want to request. For example, `?product_id:in=77,80,81`. */ readonly ProductIdInParam: readonly number[]; - /** @description Filter items by UPC. - * */ + /** @description Filter items by UPC. */ readonly UpcParam: string; - /** @description Filter items by variant SKU. To filter by product / base variant SKU, see [Get all products](/docs/rest-catalog/products#get-all-products). */ + /** @description Filter items by variant SKU. To filter by product / base variant SKU, see [Get all products](/docs/rest-catalog/products#get-all-products). */ readonly SkuParam: string; }; requestBodies: never; @@ -1143,11 +1047,9 @@ export interface operations { readonly include_fields?: components["parameters"]["IncludeFieldsParam"]; /** @description Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded. */ readonly exclude_fields?: components["parameters"]["ExcludeFieldsParam"]; - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; }; readonly header?: { @@ -1155,8 +1057,7 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. - * */ + /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. */ readonly product_id: components["parameters"]["ProductIdPathParam"]; }; readonly cookie?: never; @@ -1168,7 +1069,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": [ * { * "id": 382, @@ -1291,23 +1193,22 @@ export interface operations { * } * } * } - * } */ + * } + */ readonly "application/json": { readonly data?: readonly components["schemas"]["productVariant_Full"][]; readonly meta?: components["schemas"]["metaCollection_Full"]; }; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -1328,8 +1229,7 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. - * */ + /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. */ readonly product_id: components["parameters"]["ProductIdPathParam"]; }; readonly cookie?: never; @@ -1351,9 +1251,11 @@ export interface operations { }; }; }; - /** @description Multi-status. The product information was updated successfully, but the inventory data failed to update. + /** + * @description Multi-status. The product information was updated successfully, but the inventory data failed to update. * - * Verify that the inventory-related updates are well-formed and correct; for example, that they donʼt result in negative stock levels. Then consider updating the inventory data again. */ + * Verify that the inventory-related updates are well-formed and correct; for example, that they donʼt result in negative stock levels. Then consider updating the inventory data again. + */ readonly 207: { headers: { readonly [name: string]: unknown; @@ -1362,16 +1264,14 @@ export interface operations { readonly "application/json": components["schemas"]["MultiStatus"]; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -1395,11 +1295,9 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. - * */ + /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. */ readonly product_id: components["parameters"]["ProductIdPathParam"]; - /** @description ID of the variant on a product, or on an associated Price List Record. - * */ + /** @description ID of the variant on a product, or on an associated Price List Record. */ readonly variant_id: components["parameters"]["VariantIdParam"]; }; readonly cookie?: never; @@ -1411,7 +1309,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 384, * "product_id": 192, @@ -1449,23 +1348,22 @@ export interface operations { * ] * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: components["schemas"]["productVariant_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; }; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -1486,11 +1384,9 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. - * */ + /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. */ readonly product_id: components["parameters"]["ProductIdPathParam"]; - /** @description ID of the variant on a product, or on an associated Price List Record. - * */ + /** @description ID of the variant on a product, or on an associated Price List Record. */ readonly variant_id: components["parameters"]["VariantIdParam"]; }; readonly cookie?: never; @@ -1506,7 +1402,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "bin_picking_number": "0", * "calculated_price": 85, @@ -1536,16 +1433,19 @@ export interface operations { * "width": 2 * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: components["schemas"]["productVariant_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; }; }; }; - /** @description Multi-status. The product information was updated successfully, but the inventory data failed to update. + /** + * @description Multi-status. The product information was updated successfully, but the inventory data failed to update. * - * Verify that the inventory-related updates are well-formed and correct; for example, that they donʼt result in negative stock levels. Then consider updating the inventory data again. */ + * Verify that the inventory-related updates are well-formed and correct; for example, that they donʼt result in negative stock levels. Then consider updating the inventory data again. + */ readonly 207: { headers: { readonly [name: string]: unknown; @@ -1554,16 +1454,14 @@ export interface operations { readonly "application/json": components["schemas"]["MultiStatus"]; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -1582,11 +1480,9 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. - * */ + /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. */ readonly product_id: components["parameters"]["ProductIdPathParam"]; - /** @description ID of the variant on a product, or on an associated Price List Record. - * */ + /** @description ID of the variant on a product, or on an associated Price List Record. */ readonly variant_id: components["parameters"]["VariantIdParam"]; }; readonly cookie?: never; @@ -1608,27 +1504,25 @@ export interface operations { readonly include_fields?: components["parameters"]["IncludeFieldsParam"]; /** @description Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded. */ readonly exclude_fields?: components["parameters"]["ExcludeFieldsParam"]; - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; /** @description Filter based on a metafieldʼs key. */ readonly key?: components["parameters"]["MetafieldKeyParam"]; /** @description Filter based on a metafieldʼs namespaces. */ readonly namespace?: components["parameters"]["MetafieldNamespaceParam"]; + /** @description A comma-separated list of entity ID values that filter results to metafields that belong to one of the matching entities. */ + readonly "resource_id:in"?: components["parameters"]["MetafieldResourceParam"]; }; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. - * */ + /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. */ readonly product_id: components["parameters"]["ProductIdPathParam"]; - /** @description ID of the variant on a product, or on an associated Price List Record. - * */ + /** @description ID of the variant on a product, or on an associated Price List Record. */ readonly variant_id: components["parameters"]["VariantIdParam"]; }; readonly cookie?: never; @@ -1658,11 +1552,9 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. - * */ + /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. */ readonly product_id: components["parameters"]["ProductIdPathParam"]; - /** @description ID of the variant on a product, or on an associated Price List Record. - * */ + /** @description ID of the variant on a product, or on an associated Price List Record. */ readonly variant_id: components["parameters"]["VariantIdParam"]; }; readonly cookie?: never; @@ -1678,7 +1570,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 4, * "key": "location_id", @@ -1692,7 +1585,8 @@ export interface operations { * "date_modified": "2021-08-06T19:15:35+00:00" * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: components["schemas"]["metafield_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; @@ -1705,12 +1599,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -1719,8 +1615,7 @@ export interface operations { }; }; }; - /** @description The `Metafield` was in conflict with another `Metafield`. This can be the result of duplicate unique-key combinations of the appʼs client id, namespace, key, resource_type, and resource_id. - * */ + /** @description The `Metafield` was in conflict with another `Metafield`. This can be the result of duplicate unique-key combinations of the appʼs client id, namespace, key, resource_type, and resource_id. */ readonly 409: { headers: { readonly [name: string]: unknown; @@ -1732,18 +1627,15 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; }; }; - /** @description The `Metafield` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description The `Metafield` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -1755,11 +1647,9 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -1780,14 +1670,11 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. - * */ + /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. */ readonly product_id: components["parameters"]["ProductIdPathParam"]; - /** @description ID of the variant on a product, or on an associated Price List Record. - * */ + /** @description ID of the variant on a product, or on an associated Price List Record. */ readonly variant_id: components["parameters"]["VariantIdParam"]; - /** @description The ID of the `Metafield`. - * */ + /** @description The ID of the `Metafield`. */ readonly metafield_id: components["parameters"]["MetafieldIdParam"]; }; readonly cookie?: never; @@ -1799,7 +1686,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 8, * "key": "location_id", @@ -1813,23 +1701,22 @@ export interface operations { * "date_modified": "2018-09-13T16:42:37+00:00" * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: components["schemas"]["metafield_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; }; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -1850,14 +1737,11 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. - * */ + /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. */ readonly product_id: components["parameters"]["ProductIdPathParam"]; - /** @description ID of the variant on a product, or on an associated Price List Record. - * */ + /** @description ID of the variant on a product, or on an associated Price List Record. */ readonly variant_id: components["parameters"]["VariantIdParam"]; - /** @description The ID of the `Metafield`. - * */ + /** @description The ID of the `Metafield`. */ readonly metafield_id: components["parameters"]["MetafieldIdParam"]; }; readonly cookie?: never; @@ -1873,7 +1757,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 8, * "key": "location_id", @@ -1887,7 +1772,8 @@ export interface operations { * "date_modified": "2018-09-13T16:42:37+00:00" * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: components["schemas"]["metafield_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; @@ -1900,12 +1786,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -1914,16 +1802,14 @@ export interface operations { }; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -1942,14 +1828,11 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. - * */ + /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. */ readonly product_id: components["parameters"]["ProductIdPathParam"]; - /** @description ID of the variant on a product, or on an associated Price List Record. - * */ + /** @description ID of the variant on a product, or on an associated Price List Record. */ readonly variant_id: components["parameters"]["VariantIdParam"]; - /** @description The ID of the `Metafield`. - * */ + /** @description The ID of the `Metafield`. */ readonly metafield_id: components["parameters"]["MetafieldIdParam"]; }; readonly cookie?: never; @@ -1962,16 +1845,14 @@ export interface operations { }; content?: never; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -1990,11 +1871,9 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. - * */ + /** @description The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency. */ readonly product_id: components["parameters"]["ProductIdPathParam"]; - /** @description ID of the variant on a product, or on an associated Price List Record. - * */ + /** @description ID of the variant on a product, or on an associated Price List Record. */ readonly variant_id: components["parameters"]["VariantIdParam"]; }; readonly cookie?: never; @@ -2002,13 +1881,11 @@ export interface operations { readonly requestBody?: { readonly content: { readonly "application/json": { - /** @description A public URL for a GIF, JPEG, or PNG image. Limit of 8MB per file. - * */ + /** @description A public URL for a GIF, JPEG, or PNG image. Limit of 8MB per file. */ readonly image_url?: string; }; readonly "multipart/form-data": { - /** @description A public URL for a GIF, JPEG, or PNG image. Limit of 8MB per file. - * */ + /** @description A public URL for a GIF, JPEG, or PNG image. Limit of 8MB per file. */ readonly image_url?: string; }; }; @@ -2020,20 +1897,21 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "image_url": "https://cdn8.bigcommerce.com/s-id30h7ohwf/product_images/attribute_rule_images/85_source_1536863430.png" * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { /** * Resource Image * @description An object containing a publicly accessible image URL, or a form post that contains an image file. */ readonly data?: { - /** @description A public URL for a GIF, JPEG, or PNG image. Limit of 8MB per file. - * */ + /** @description A public URL for a GIF, JPEG, or PNG image. Limit of 8MB per file. */ readonly image_url?: string; }; readonly meta?: components["schemas"]["metaEmpty_Full"]; @@ -2049,16 +1927,14 @@ export interface operations { readonly "application/json": Record; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -2067,8 +1943,7 @@ export interface operations { }; }; }; - /** @description Image was not valid. This is the result of a missing `image_file` field or of an incorrect file type. See the response for more details. - * */ + /** @description Image was not valid. This is the result of a missing `image_file` field or of an incorrect file type. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -2080,11 +1955,9 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -2102,11 +1975,9 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -2119,20 +1990,17 @@ export interface operations { readonly query?: { /** @description Filter items by variant ID. */ readonly id?: number; - /** @description Filter items by variant SKU. To filter by product / base variant SKU, see [Get all products](/docs/rest-catalog/products#get-all-products). */ + /** @description Filter items by variant SKU. To filter by product / base variant SKU, see [Get all products](/docs/rest-catalog/products#get-all-products). */ readonly sku?: components["parameters"]["SkuParam"]; - /** @description Filter items by UPC. - * */ + /** @description Filter items by UPC. */ readonly upc?: components["parameters"]["UpcParam"]; /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */ readonly include_fields?: components["parameters"]["IncludeFieldsParam"]; /** @description Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded. */ readonly exclude_fields?: components["parameters"]["ExcludeFieldsParam"]; - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; /** @description A comma-separated list of IDs of products you want to request. For example, `?product_id:in=77,80,81`. */ readonly "product_id:in"?: components["parameters"]["ProductIdInParam"]; @@ -2181,28 +2049,23 @@ export interface operations { /** * Format: double * @description Width of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default width (set in the Product resourceʼs `width` field) will be used as the base width. - * */ readonly width?: number; /** * Format: double * @description Height of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default height (set in the Product resourceʼs `height` field) will be used as the base height. - * */ readonly height?: number; /** * Format: double * @description Depth of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default depth (set in the Product resourceʼs `depth` field) will be used as the base depth. - * */ readonly depth?: number; - /** @description Flag used to indicate whether the variant has free shipping. If `true`, the shipping cost for the variant will be zero. - * */ + /** @description Flag used to indicate whether the variant has free shipping. If `true`, the shipping cost for the variant will be zero. */ readonly is_free_shipping?: boolean; /** * Format: double * @description A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation. - * */ readonly fixed_cost_shipping_price?: number; /** @description If `true`, this variant will not be purchasable on the storefront. */ @@ -2211,13 +2074,15 @@ export interface operations { readonly purchasing_disabled_message?: string; /** @description The UPC code used in feeds for shopping comparison sites and external channel integrations. */ readonly upc?: string | null; - /** @description Inventory level for the variant, which is used when the product’s inventory_tracking is set to `variant`. The Catalog API returns the inventory for only the default location. + /** + * @description Inventory level for the variant, which is used when the product’s inventory_tracking is set to `variant`. The Catalog API returns the inventory for only the default location. * * The inventory for a variant cannot exceed 2,147,483,647 in the catalog. The sum of the variant inventories, or the total inventory for a product, cannot exceed 2,147,483,647. * * If you exceed the limit, the store sets the variant inventory to the limit if no other variant inventories are set. If other variant inventories are set, the store does not save the variant inventory rather than setting the variant inventory to the remaining limit. * - * The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). */ + * The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). + */ readonly inventory_level?: number; /** @description When the variant hits this inventory level, it is considered low stock. */ readonly inventory_warning_level?: number; @@ -2233,13 +2098,11 @@ export interface operations { readonly option_values?: readonly ({ /** * @description The name of the option. - * * @example Color */ readonly option_display_name?: string; /** * @description The label of the option value. - * * @example Beige */ readonly label?: string; @@ -2250,7 +2113,6 @@ export interface operations { /** * Format: double * @description The price of the variant as seen on the storefront. This price takes into account `sale_price` and any price adjustment rules that are applicable to this variant. - * */ readonly calculated_price?: number; })[]; @@ -2265,8 +2127,7 @@ export interface operations { }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -2325,31 +2186,26 @@ export interface operations { /** * Format: double * @description Width of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default width (set in the Product resourceʼs `width` field) will be used as the base width. - * * @example 5 */ readonly width?: number; /** * Format: double * @description Height of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default height (set in the Product resourceʼs `height` field) will be used as the base height. - * * @example 5 */ readonly height?: number; /** * Format: double * @description Depth of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default depth (set in the Product resourceʼs `depth` field) will be used as the base depth. - * * @example 5 */ readonly depth?: number; - /** @description Flag used to indicate whether the variant has free shipping. If `true`, the shipping cost for the variant will be zero. - * */ + /** @description Flag used to indicate whether the variant has free shipping. If `true`, the shipping cost for the variant will be zero. */ readonly is_free_shipping?: boolean; /** * Format: double * @description A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation. - * */ readonly fixed_cost_shipping_price?: number; /** @description If `true`, this variant will not be purchasable on the storefront. */ @@ -2421,28 +2277,23 @@ export interface operations { /** * Format: double * @description Width of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default width (set in the Product resourceʼs `width` field) will be used as the base width. - * */ readonly width?: number; /** * Format: double * @description Height of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default height (set in the Product resourceʼs `height` field) will be used as the base height. - * */ readonly height?: number; /** * Format: double * @description Depth of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default depth (set in the Product resourceʼs `depth` field) will be used as the base depth. - * */ readonly depth?: number; - /** @description Flag used to indicate whether the variant has free shipping. If `true`, the shipping cost for the variant will be zero. - * */ + /** @description Flag used to indicate whether the variant has free shipping. If `true`, the shipping cost for the variant will be zero. */ readonly is_free_shipping?: boolean; /** * Format: double * @description A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation. - * */ readonly fixed_cost_shipping_price?: number; /** @description If `true`, this variant will not be purchasable on the storefront. */ @@ -2451,13 +2302,15 @@ export interface operations { readonly purchasing_disabled_message?: string; /** @description The UPC code used in feeds for shopping comparison sites and external channel integrations. */ readonly upc?: string | null; - /** @description Inventory level for the variant, which is used when the product’s inventory_tracking is set to `variant`. The Catalog API returns the inventory for only the default location. + /** + * @description Inventory level for the variant, which is used when the product’s inventory_tracking is set to `variant`. The Catalog API returns the inventory for only the default location. * * The inventory for a variant cannot exceed 2,147,483,647 in the catalog. The sum of the variant inventories, or the total inventory for a product, cannot exceed 2,147,483,647. * * If you exceed the limit, the store sets the variant inventory to the limit if no other variant inventories are set. If other variant inventories are set, the store does not save the variant inventory rather than setting the variant inventory to the remaining limit. * - * The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). */ + * The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). + */ readonly inventory_level?: number; /** @description When the variant hits this inventory level, it is considered low stock. */ readonly inventory_warning_level?: number; @@ -2473,13 +2326,11 @@ export interface operations { readonly option_values?: readonly ({ /** * @description The name of the option. - * * @example Color */ readonly option_display_name?: string; /** * @description The label of the option value. - * * @example Beige */ readonly label?: string; @@ -2490,7 +2341,6 @@ export interface operations { /** * Format: double * @description The price of the variant as seen on the storefront. This price takes into account `sale_price` and any price adjustment rules that are applicable to this variant. - * */ readonly calculated_price?: number; })[]; @@ -2506,48 +2356,39 @@ export interface operations { readonly pagination?: { /** * @description Total number of items in the result set. - * * @example 36 */ readonly total?: number; /** * @description Total number of items in the collection response. - * * @example 36 */ readonly count?: number; /** * @description The amount of items returned in the collection per page, controlled by the limit parameter. - * * @example 50 */ readonly per_page?: number; /** * @description The page you are currently on within the collection. - * * @example 1 */ readonly current_page?: number; /** * @description The total number of pages in the collection. - * * @example 1 */ readonly total_pages?: number; - /** @description Pagination links for the previous and next parts of the whole collection. - * */ + /** @description Pagination links for the previous and next parts of the whole collection. */ readonly links?: { - /** @description Link to the previous page returned in the response. - * */ + /** @description Link to the previous page returned in the response. */ readonly previous?: string; /** * @description Link to the current page returned in the response. - * * @example ?page=1&limit=50 */ readonly current?: string; - /** @description Link to the next page returned in the response. - * */ + /** @description Link to the next page returned in the response. */ readonly next?: string; }; }; @@ -2560,17 +2401,18 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "errors": {}, * "status": 413, * "title": "The request payload is too large. The maximum items allowed in the array is 50", * "type": "/api-docs/getting-started/api-status-codes" - * } */ + * } + */ readonly "application/json": unknown; }; }; - /** @description This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -2578,11 +2420,9 @@ export interface operations { content: { readonly "application/json": { readonly batch_errors?: readonly ({ - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; @@ -2600,11 +2440,9 @@ export interface operations { readonly getVariantsMetafields: { readonly parameters: { readonly query?: { - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; /** @description Filter based on a metafieldʼs key. */ readonly key?: components["parameters"]["MetafieldKeyParam"]; @@ -2614,22 +2452,17 @@ export interface operations { readonly namespace?: components["parameters"]["MetafieldNamespaceParam"]; /** @description Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. */ readonly "namespace:in"?: components["parameters"]["MetafieldNamespaceInParam"]; - /** @description Sort direction. Acceptable values are: `asc`, `desc`. - * */ + /** @description Sort direction. Acceptable values are: `asc`, `desc`. */ readonly direction?: components["parameters"]["DirectionParam"]; /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */ readonly include_fields?: components["parameters"]["IncludeFieldsParamMetafields"]; - /** @description 'Query parameter that lets you filter by the minimum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.' - * */ + /** @description 'Query parameter that lets you filter by the minimum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.' */ readonly "date_created:min"?: components["parameters"]["date_created_min"]; - /** @description 'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.' - * */ + /** @description 'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.' */ readonly "date_created:max"?: components["parameters"]["date_created_max"]; - /** @description 'Query parameter that lets you filter by the minimum date modified, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.' - * */ + /** @description 'Query parameter that lets you filter by the minimum date modified, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.' */ readonly "date_modified:min"?: components["parameters"]["date_modified_min"]; - /** @description 'Query parameter that lets you filter by the maximum date modified, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.' - * */ + /** @description 'Query parameter that lets you filter by the maximum date modified, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.' */ readonly "date_modified:max"?: components["parameters"]["date_modified_max"]; }; readonly header?: { @@ -2641,8 +2474,7 @@ export interface operations { }; readonly requestBody?: never; readonly responses: { - /** @description List of `Metafield` objects. - * */ + /** @description List of `Metafield` objects. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -2670,7 +2502,6 @@ export interface operations { readonly "application/json": readonly (components["schemas"]["MetafieldBase_Put"] & { /** * @description The ID of metafield to update. - * * @example 42 */ readonly id: number; @@ -2678,8 +2509,7 @@ export interface operations { }; }; readonly responses: { - /** @description List of updated `Metafield` objects. - * */ + /** @description List of updated `Metafield` objects. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -2694,12 +2524,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2708,8 +2540,7 @@ export interface operations { }; }; }; - /** @description Response object for metafields creation with partial success. - * */ + /** @description Response object for metafields creation with partial success. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -2737,7 +2568,6 @@ export interface operations { readonly "application/json": readonly (components["schemas"]["MetafieldBase_Post"] & { /** * @description The ID for the product variant with which the metafield is associated. - * * @example 42 */ readonly resource_id: number; @@ -2745,8 +2575,7 @@ export interface operations { }; }; readonly responses: { - /** @description List of created `Metafield` objects. - * */ + /** @description List of created `Metafield` objects. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -2761,12 +2590,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2775,8 +2606,7 @@ export interface operations { }; }; }; - /** @description Response object for metafields creation with partial success. - * */ + /** @description Response object for metafields creation with partial success. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -2804,8 +2634,7 @@ export interface operations { }; }; readonly responses: { - /** @description Response object for metafields deletion with success. - * */ + /** @description Response object for metafields deletion with success. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -2820,12 +2649,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2834,8 +2665,7 @@ export interface operations { }; }; }; - /** @description Response object for metafields deletion with partial success. - * */ + /** @description Response object for metafields deletion with partial success. */ readonly 422: { headers: { readonly [name: string]: unknown; diff --git a/src/internal/reference/generated/catalog/products_catalog.v3.ts b/src/internal/reference/generated/catalog/products_catalog.v3.ts index 4acf1f9..bcc45c7 100644 --- a/src/internal/reference/generated/catalog/products_catalog.v3.ts +++ b/src/internal/reference/generated/catalog/products_catalog.v3.ts @@ -81,8 +81,7 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; }; readonly cookie?: never; @@ -105,7 +104,6 @@ export interface paths { * - date_modified * - calculated_price * - base_variant_id - * */ readonly put: operations["updateProduct"]; /** @@ -122,8 +120,7 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; }; readonly cookie?: never; @@ -158,11 +155,9 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `Image` that is being operated on. - * */ + /** @description The ID of the `Image` that is being operated on. */ readonly image_id: components["parameters"]["ImageIdParam"]; }; readonly cookie?: never; @@ -196,8 +191,7 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; }; readonly cookie?: never; @@ -232,8 +226,7 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; /** @description The BigCommerce ID of the `Video` */ readonly id: components["parameters"]["VideoIdParam"]; @@ -273,8 +266,7 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; }; readonly cookie?: never; @@ -310,11 +302,9 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `ComplexRule`. - * */ + /** @description The ID of the `ComplexRule`. */ readonly complex_rule_id: components["parameters"]["ComplexRuleIdParam"]; }; readonly cookie?: never; @@ -349,8 +339,7 @@ export interface paths { readonly parameters: { readonly query?: never; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; }; readonly cookie?: never; @@ -384,11 +373,9 @@ export interface paths { readonly parameters: { readonly query?: never; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `CustomField`. - * */ + /** @description The ID of the `CustomField`. */ readonly custom_field_id: components["parameters"]["CustomFieldIdParam"]; }; readonly cookie?: never; @@ -396,7 +383,6 @@ export interface paths { /** * Get a Product Custom Field * @description Returns a *Custom Field*. - * */ readonly get: operations["getProductCustomField"]; /** @@ -433,8 +419,7 @@ export interface paths { readonly "Content-Type": components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; }; readonly cookie?: never; @@ -458,11 +443,9 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `BulkPricingRule`. - * */ + /** @description The ID of the `BulkPricingRule`. */ readonly bulk_pricing_rule_id: components["parameters"]["BulkPricingRuleIdParam"]; }; readonly cookie?: never; @@ -497,8 +480,7 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; }; readonly cookie?: never; @@ -530,11 +512,9 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `Metafield`. - * */ + /** @description The ID of the `Metafield`. */ readonly metafield_id: components["parameters"]["MetafieldIdParam"]; }; readonly cookie?: never; @@ -577,8 +557,7 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; }; readonly cookie?: never; @@ -609,11 +588,9 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `review` that is being operated on. - * */ + /** @description The ID of the `review` that is being operated on. */ readonly review_id: components["parameters"]["ReviewIdParam"]; }; readonly cookie?: never; @@ -662,7 +639,6 @@ export interface paths { * Notes: * * Avoid parallel assignment requests if possible. * * Do not make parallel assignment requests with the same product IDs. - * */ readonly put: operations["createProductsChannelAssignments"]; /** @@ -783,12 +759,10 @@ export interface components { readonly productModifier_Base: { /** * @description BigCommerce API, which determines how it will display on the storefront. Acceptable values: `date`, `checkbox`, `file`, `text`, `multi_line_text`, `numbers_only_text`, `radio_buttons`, `rectangles`, `dropdown`, `product_list`, `product_list_with_images`, `swatch`. Required in a /POST. - * * @enum {string} */ readonly type: "date" | "checkbox" | "file" | "text" | "multi_line_text" | "numbers_only_text" | "radio_buttons" | "rectangles" | "dropdown" | "product_list" | "product_list_with_images" | "swatch"; - /** @description Whether or not this modifer is required or not at checkout. Required in a /POST. - * */ + /** @description Whether or not this modifer is required or not at checkout. Required in a /POST. */ readonly required: boolean; /** @description The order the modifiers display on the product detail page. */ readonly sort_order?: number; @@ -803,19 +777,16 @@ export interface components { readonly productModifier_Full: components["schemas"]["productModifier_Base"] & { /** * @description The unique numeric ID of the modifier; increments sequentially. - * * @example 12 */ readonly id?: number; /** * @description The unique numeric ID of the product to which the option belongs. - * * @example 77 */ readonly product_id?: number; /** * @description The unique option name. Auto-generated from the display name, a timestamp, and the product ID. - * * @example Add-a-$5-Donation1535039590-191 */ readonly name?: string; @@ -828,24 +799,20 @@ export interface components { readonly productModifierOptionValue_Base: { /** * @description The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers. - * * @example false */ readonly is_default?: boolean; /** * @description The text display identifying the value on the storefront. Required in a /POST. - * * @example Green */ readonly label: string; /** * @description The order in which the value will be displayed on the product page. Required in a /POST. - * * @example 0 */ readonly sort_order: number; - /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. If no data is available, returns `null`. - * */ + /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. If no data is available, returns `null`. */ readonly value_data?: Record | null; readonly adjusters?: components["schemas"]["adjusters_Full"]; }; @@ -854,8 +821,7 @@ export interface components { * @description Product Modifer `option_value`. */ readonly productModifierOptionValue_Full: components["schemas"]["productModifierOptionValue_Base"] & { - /** @description The unique numeric ID of the value; increments sequentially. - * */ + /** @description The unique numeric ID of the value; increments sequentially. */ readonly id?: number; readonly option_id?: number; }; @@ -866,25 +832,21 @@ export interface components { readonly productOption_Base: { /** * @description The unique numerical ID of the option, increments sequentially. - * * @example 55 */ readonly id?: number | null; /** * @description The unique numerical ID of the product to which the option belongs. - * * @example 4 */ readonly product_id?: number; /** * @description The name of the option shown on the storefront. - * * @example Add-a-$5-Donation1535042499-187 */ readonly display_name?: string; /** * @description The type of option, which determines how it will display on the storefront. Acceptable values: `radio_buttons`, `rectangles`, `dropdown`, `product_list`, `product_list_with_images`, `swatch`. For reference, the former v2 API values are: RB = radio_buttons, RT = rectangles, S = dropdown, P = product_list, PI = product_list_with_images, CS = swatch. - * * @enum {string} */ readonly type?: "radio_buttons" | "rectangles" | "dropdown" | "product_list" | "product_list_with_images" | "swatch"; @@ -931,28 +893,23 @@ export interface components { /** * Format: double * @description Width of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default width (set in the Product resourceʼs `width` field) will be used as the base width. - * */ readonly width?: number | null; /** * Format: double * @description Height of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default height (set in the Product resourceʼs `height` field) will be used as the base height. - * */ readonly height?: number | null; /** * Format: double * @description Depth of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default depth (set in the Product resourceʼs `depth` field) will be used as the base depth. - * */ readonly depth?: number | null; - /** @description Flag used to indicate whether the variant has free shipping. If `true`, the shipping cost for the variant will be zero. - * */ + /** @description Flag used to indicate whether the variant has free shipping. If `true`, the shipping cost for the variant will be zero. */ readonly is_free_shipping?: boolean; /** * Format: double * @description A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation. - * */ readonly fixed_cost_shipping_price?: number | null; /** @description If `true`, this variant will not be purchasable on the storefront. */ @@ -961,19 +918,20 @@ export interface components { readonly purchasing_disabled_message?: string; /** * @description The URL for an image displayed on the storefront when the conditions are applied. Limit of 8MB per file. - * * @example https://cdn8.bigcommerce.com/s-123456/product_images/d/fakeimage.png */ readonly image_url?: string; /** @description The UPC code used in feeds for shopping comparison sites and external channel integrations. */ readonly upc?: string; - /** @description Inventory level for the variant, which is used when the product’s inventory_tracking is set to `variant`. The Catalog API returns the inventory for only the default location. + /** + * @description Inventory level for the variant, which is used when the product’s inventory_tracking is set to `variant`. The Catalog API returns the inventory for only the default location. * * The inventory for a variant cannot exceed 2,147,483,647 in the catalog. The sum of the variant inventories, or the total inventory for a product, cannot exceed 2,147,483,647. * * If you exceed the limit, the store sets the variant inventory to the limit if no other variant inventories are set. If other variant inventories are set, the store does not save the variant inventory rather than setting the variant inventory to the remaining limit. * - * The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). */ + * The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). + */ readonly inventory_level?: number | null; /** @description When the variant hits this inventory level, it is considered low stock. */ readonly inventory_warning_level?: number | null; @@ -999,7 +957,6 @@ export interface components { /** * Format: double * @description The price of the variant as seen on the storefront. This price takes into account `sale_price` and any price adjustment rules that are applicable to this variant. - * */ readonly calculated_price?: number; readonly calculated_weight?: number; @@ -1007,7 +964,6 @@ export interface components { /** * productVariant_Put_Product * @description The model for a PUT to update variants on a product. - * */ readonly productVariant_Put_Product: { /** @@ -1038,28 +994,23 @@ export interface components { /** * Format: double * @description Width of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default width (set in the Product resourceʼs `width` field) will be used as the base width. - * */ readonly width?: number | null; /** * Format: double * @description Height of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default height (set in the Product resourceʼs `height` field) will be used as the base height. - * */ readonly height?: number | null; /** * Format: double * @description Depth of the variant, which can be used when calculating shipping costs. If this value is `null`, the productʼs default depth (set in the Product resourceʼs `depth` field) will be used as the base depth. - * */ readonly depth?: number | null; - /** @description Flag used to indicate whether the variant has free shipping. If `true`, the shipping cost for the variant will be zero. - * */ + /** @description Flag used to indicate whether the variant has free shipping. If `true`, the shipping cost for the variant will be zero. */ readonly is_free_shipping?: boolean; /** * Format: double * @description A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation. - * */ readonly fixed_cost_shipping_price?: number | null; /** @description If `true`, this variant will not be purchasable on the storefront. */ @@ -1068,13 +1019,15 @@ export interface components { readonly purchasing_disabled_message?: string; /** @description The UPC code used in feeds for shopping comparison sites and external channel integrations. */ readonly upc?: string; - /** @description Inventory level for the variant, which is used when the product’s inventory_tracking is set to `variant`. The Catalog API returns the inventory for only the default location. + /** + * @description Inventory level for the variant, which is used when the product’s inventory_tracking is set to `variant`. The Catalog API returns the inventory for only the default location. * * The inventory for a variant cannot exceed 2,147,483,647 in the catalog. The sum of the variant inventories, or the total inventory for a product, cannot exceed 2,147,483,647. * * If you exceed the limit, the store sets the variant inventory to the limit if no other variant inventories are set. If other variant inventories are set, the store does not save the variant inventory rather than setting the variant inventory to the remaining limit. * - * The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). */ + * The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). + */ readonly inventory_level?: number | null; /** @description When the variant hits this inventory level, it is considered low stock. */ readonly inventory_warning_level?: number | null; @@ -1092,7 +1045,6 @@ export interface components { readonly id?: number; /** * @description The label of the option value. - * * @example Beige */ readonly label: string; @@ -1103,7 +1055,6 @@ export interface components { readonly option_id?: number; /** * @description The name of the option. - * * @example Color */ readonly option_display_name: string; @@ -1131,24 +1082,20 @@ export interface components { readonly productOptionOptionValue_Base: { /** * @description The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers. - * * @example false */ readonly is_default?: boolean; /** * @description The text display identifying the value on the storefront. Required in a /POST. - * * @example Green */ readonly label: string; /** * @description The order in which the value will be displayed on the product page. Required in a /POST. - * * @example 0 */ readonly sort_order: number; - /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. If no data is available, returns `null`. - * */ + /** @description Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. If no data is available, returns `null`. */ readonly value_data?: Record | null; }; /** @@ -1156,8 +1103,7 @@ export interface components { * @description Product Option `option_value`. */ readonly productOptionOptionValue_Full: components["schemas"]["productOptionOptionValue_Base"] & { - /** @description The unique numeric ID of the value; increments sequentially. - * */ + /** @description The unique numeric ID of the value; increments sequentially. */ readonly id?: number; }; /** @@ -1165,19 +1111,15 @@ export interface components { * @description Common ProductImage properties. */ readonly productImage_Base: { - /** @description Flag for identifying whether the image is used as the productʼs thumbnail. - * */ + /** @description Flag for identifying whether the image is used as the productʼs thumbnail. */ readonly is_thumbnail?: boolean; - /** @description The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a `sort_order` the same as or greater than the imageʼs new `sort_order` value will have their `sort_order`s reordered. - * */ + /** @description The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a `sort_order` the same as or greater than the imageʼs new `sort_order` value will have their `sort_order`s reordered. */ readonly sort_order?: number; - /** @description The description for the image. - * */ + /** @description The description for the image. */ readonly description?: string; /** * Format: date-time * @description The date on which the product image was modified. - * */ readonly date_modified?: string; }; @@ -1186,42 +1128,37 @@ export interface components { * @description The model for a POST or PUT to create or update applicable Product Image fields. */ readonly productImage_Post_Put: { - /** @description The unique numeric identifier for the product with which the image is associated. - * */ + /** @description The unique numeric identifier for the product with which the image is associated. */ readonly product_id?: number; - /** @description The URL for an image displayed on the storefront when the conditions are applied. Limit of 8MB per file. + /** + * @description The URL for an image displayed on the storefront when the conditions are applied. Limit of 8MB per file. * * Cannot be used with `image_file`. - * */ + */ readonly image_url?: string; } & components["schemas"]["productImage_Base"]; /** * productVideo_Base * @description The model for a POST to create a video on a product. - * */ readonly productVideo_Base: { /** * @description The title for the video. If left blank, this will be filled in according to data on a host site. - * * @example Writing Great Documentation */ readonly title?: string; /** * @description The description for the video. If left blank, this will be filled in according to data on a host site. - * * @example A video about documenation */ readonly description?: string; /** * @description The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a `sort_order` the same as or greater than the videoʼs new `sort_order` value will have their `sort_order`s reordered. - * * @example 1 */ readonly sort_order?: number; /** * @description The video type (a short name of a host site). - * * @enum {string} */ readonly type?: "youtube"; @@ -1234,17 +1171,13 @@ export interface components { /** * productVideo_Full * @description A product video model. - * */ readonly productVideo_Full: components["schemas"]["productVideo_Base"] & { - /** @description The unique numeric ID of the product video; increments sequentially. - * */ + /** @description The unique numeric ID of the product video; increments sequentially. */ readonly id?: number; - /** @description The unique numeric identifier for the product with which the image is associated. - * */ + /** @description The unique numeric identifier for the product with which the image is associated. */ readonly product_id?: number; - /** @description Length of the video. This will be filled in according to data on a host site. - * */ + /** @description Length of the video. This will be filled in according to data on a host site. */ readonly length?: string; }; readonly IncludeParamBase: readonly ("bulk_pricing_rules" | "reviews" | "modifiers" | "options" | "parent_relations" | "custom_fields" | "channels" | "videos")[]; @@ -1260,19 +1193,16 @@ export interface components { readonly metafield_Base: { /** * @description The name of the field, for example: `location_id`, `color`. Required for POST. - * * @example Location */ readonly key: string; /** * @description The value of the field, for example: `1`, `blue`. You must enter a JSON formatted string for [ShipperHQ](/docs/store-operations/shipping/shipper-hq#shipperhq-object-properties) metafields. Required for POST. - * * @example 4HG */ readonly value: string; /** * @description Namespace for the metafield, for organizational purposes. This is set by the developer. Required for POST. - * * @example Warehouse Locations */ readonly namespace: string; @@ -1291,7 +1221,6 @@ export interface components { readonly permission_set: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; /** * @description Description for the metafields. - * * @example Location in the warehouse */ readonly description?: string; @@ -1309,40 +1238,32 @@ export interface components { readonly id?: number; /** * @description The unique numeric ID of the product with which the rule is associated; increments sequentially. - * * @example 67 */ readonly product_id?: number | null; /** * @description The priority to give this rule when making adjustments to the product properties. - * * @example 0 */ readonly sort_order?: number; /** * @description Flag for determining whether the rule is to be used when adjusting a productʼs price, weight, image, or availabilty. - * * @example true */ readonly enabled?: boolean; - /** @description Flag for determining whether other rules should not be applied after this rule has been applied. - * */ + /** @description Flag for determining whether other rules should not be applied after this rule has been applied. */ readonly stop?: boolean; - /** @description Flag for determining whether the rule should disable purchasing of a product when the conditions are applied. - * */ + /** @description Flag for determining whether the rule should disable purchasing of a product when the conditions are applied. */ readonly purchasing_disabled?: boolean; /** * @description Message displayed on the storefront when a rule disables the purchasing of a product. - * * @example This product is not available at this time. */ readonly purchasing_disabled_message?: string; - /** @description Flag for determining whether the rule should hide purchasing of a product when the conditions are applied. - * */ + /** @description Flag for determining whether the rule should hide purchasing of a product when the conditions are applied. */ readonly purchasing_hidden?: boolean; /** * @description The URL for an image displayed on the storefront when the conditions are applied. Limit of 8MB per file. - * * @example https://cdn8.bigcommerce.com/s-123456/product_images/d/fakeimage.png */ readonly image_url?: string; @@ -1363,13 +1284,11 @@ export interface components { readonly id?: number; /** * @description The name of the field, shown on the storefront, orders, etc. Required for /POST - * * @example ISBN */ readonly name: string; /** * @description The name of the field, shown on the storefront, orders, etc. Required for /POST - * * @example 1234567890123 */ readonly value: string; @@ -1387,13 +1306,11 @@ export interface components { readonly id?: number; /** * @description The name of the field, shown on the storefront, orders, etc. Required for /POST - * * @example ISBN */ readonly name: string; /** * @description The name of the field, shown on the storefront, orders, etc. Required for /POST - * * @example 1234567890123 */ readonly value: string; @@ -1405,7 +1322,6 @@ export interface components { readonly complexRuleConditionBase: { /** * @description The unique numeric ID of the rule condition; increments sequentially. Read-Only - * * @example 3 */ readonly id?: number | null; @@ -1433,8 +1349,7 @@ export interface components { * @example 1 */ readonly variant_id: number | null; - /** @description (READ-ONLY:) The unique numeric ID of the SKU (v2 API), or Combination, with which the rule condition is associated. This is to maintain cross-compatibility between v2 and v3. - * */ + /** @description (READ-ONLY:) The unique numeric ID of the SKU (v2 API), or Combination, with which the rule condition is associated. This is to maintain cross-compatibility between v2 and v3. */ readonly combination_id?: number; }; /** @@ -1442,14 +1357,11 @@ export interface components { * @description The custom URL for the product on the storefront. If not provided in the POST request, the URL will be autogenerated from the product name. */ readonly customUrl_Full: { - /** @description Product URL on the storefront. - * */ + /** @description Product URL on the storefront. */ readonly url?: string; - /** @description Returns `true` if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides). - * */ + /** @description Returns `true` if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides). */ readonly is_customized?: boolean; - /** @description Optional field. This field automatically creates a dynamic 301 redirect when a product URL change occurs with a PUT request. Existing dynamic redirects will automatically update to a new URL to avoid a loop. - * */ + /** @description Optional field. This field automatically creates a dynamic 301 redirect when a product URL change occurs with a PUT request. Existing dynamic redirects will automatically update to a new URL to avoid a loop. */ readonly create_redirect?: boolean; }; /** bulkPricingRule_Response */ @@ -1457,7 +1369,6 @@ export interface components { /** * @description The minimum inclusive quantity of a product to satisfy this rule. Must be greater than or equal to zero. For `fixed` rules, the minimum quantity canʼt be less than two. * Required in /POST. - * * @example 10 */ readonly quantity_min?: number; @@ -1474,8 +1385,10 @@ export interface components { * @enum {string} */ readonly type?: "price" | "percent" | "fixed"; - /** @description You can express the adjustment type as either a fixed dollar amount or a percentage. Send a number; the response will return a number for `price` and `fixed` adjustments. - * Divide the adjustment percentage by 100 and send the result in string format. For example, represent 10% as “.10”. The response will return a float value for both `price` and `percentage` adjustments. */ + /** + * @description You can express the adjustment type as either a fixed dollar amount or a percentage. Send a number; the response will return a number for `price` and `fixed` adjustments. + * Divide the adjustment percentage by 100 and send the result in string format. For example, represent 10% as “.10”. The response will return a float value for both `price` and `percentage` adjustments. + */ readonly amount?: number | string; }; /** bulkPricingRule_Full */ @@ -1483,7 +1396,6 @@ export interface components { /** * @description The minimum inclusive quantity of a product to satisfy this rule. Must be greater than or equal to zero. For `fixed` rules, the minimum quantity canʼt be less than two. * Required in /POST. - * * @example 10 */ readonly quantity_min: number; @@ -1500,9 +1412,11 @@ export interface components { * @enum {string} */ readonly type: "price" | "percent" | "fixed"; - /** @description You can express the adjustment type as either a fixed dollar amount or a percentage. Send a number; the response will return a number for `price` and `fixed` adjustments. + /** + * @description You can express the adjustment type as either a fixed dollar amount or a percentage. Send a number; the response will return a number for `price` and `fixed` adjustments. * Divide the adjustment percentage by 100 and send the result in string format. For example, represent 10% as “.10”. The response will return a float value for both `price` and `percentage` adjustments. - * Required in /POST. */ + * Required in /POST. + */ readonly amount: number | string; }; /** @@ -1510,21 +1424,16 @@ export interface components { * @description The values for option config can vary based on the Modifier created. */ readonly productOptionConfig_Full: { - /** @description (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string. - * */ + /** @description (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string. */ readonly default_value?: string; - /** @description (checkbox) Flag for setting the checkbox to be checked by default. - * */ + /** @description (checkbox) Flag for setting the checkbox to be checked by default. */ readonly checked_by_default?: boolean; - /** @description (checkbox) Label displayed for the checkbox option. - * */ + /** @description (checkbox) Label displayed for the checkbox option. */ readonly checkbox_label?: string; - /** @description (date) Flag to limit the dates allowed to be entered on a date option. - * */ + /** @description (date) Flag to limit the dates allowed to be entered on a date option. */ readonly date_limited?: boolean; /** * @description (date) The type of limit that is allowed to be entered on a date option. - * * @example range * @enum {string} */ @@ -1532,100 +1441,83 @@ export interface components { /** * Format: date * @description (date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string. - * */ readonly date_earliest_value?: string; /** * Format: date * @description (date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string. - * */ readonly date_latest_value?: string; /** * @description (file) The kind of restriction on the file types that can be uploaded with a file upload option. Values: `specific` - restricts uploads to particular file types; `all` - allows all file types. - * * @example specific * @enum {string} */ readonly file_types_mode?: "specific" | "all"; - /** @description (file) The type of files allowed to be uploaded if the `file_type_option` is set to `specific`. Values: + /** + * @description (file) The type of files allowed to be uploaded if the `file_type_option` is set to `specific`. Values: * `images` - Allows upload of image MIME types (`bmp`, `gif`, `jpg`, `jpeg`, `jpe`, `jif`, `jfif`, `jfi`, `png`, `wbmp`, `xbm`, `tiff`). `documents` - Allows upload of document MIME types (`txt`, `pdf`, `rtf`, `doc`, `docx`, `xls`, `xlsx`, `accdb`, `mdb`, `one`, `pps`, `ppsx`, `ppt`, `pptx`, `pub`, `odt`, `ods`, `odp`, `odg`, `odf`). * `other` - Allows file types defined in the `file_types_other` array. - * */ + */ readonly file_types_supported?: readonly string[]; - /** @description (file) A list of other file types allowed with the file upload option. - * */ + /** @description (file) A list of other file types allowed with the file upload option. */ readonly file_types_other?: readonly string[]; /** * @description (file) The maximum size for a file that can be used with the file upload option. This will still be limited by the server. - * * @example 5 */ readonly file_max_size?: number; - /** @description (text, multi_line_text) Flag to validate the length of a text or multi-line text input. - * */ + /** @description (text, multi_line_text) Flag to validate the length of a text or multi-line text input. */ readonly text_characters_limited?: boolean; /** * @description (text, multi_line_text) The minimum length allowed for a text or multi-line text option. - * * @example 1 */ readonly text_min_length?: number; /** * @description (text, multi_line_text) The maximum length allowed for a text or multi line text option. - * * @example 55 */ readonly text_max_length?: number; /** * @description (multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input. - * * @example true */ readonly text_lines_limited?: boolean; /** * @description (multi_line_text) The maximum number of lines allowed on a multi-line text input. - * * @example 4 */ readonly text_max_lines?: number; /** * @description (numbers_only_text) Flag to limit the value of a number option. - * * @example true */ readonly number_limited?: boolean; /** * @description (numbers_only_text) The type of limit on values entered for a number option. - * * @example lowest * @enum {string} */ readonly number_limit_mode?: "lowest" | "highest" | "range"; /** * @description (numbers_only_text) The lowest allowed value for a number option if `number_limited` is true. - * * @example 100 */ readonly number_lowest_value?: number; - /** @description (numbers_only_text) The highest allowed value for a number option if `number_limited` is true. - * */ + /** @description (numbers_only_text) The highest allowed value for a number option if `number_limited` is true. */ readonly number_highest_value?: number; /** * @description (numbers_only_text) Flag to limit the input on a number option to whole numbers only. - * * @example false */ readonly number_integers_only?: boolean; - /** @description (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list. - * */ + /** @description (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list. */ readonly product_list_adjusts_inventory?: boolean; - /** @description (product_list, product_list_with_images) Flag to add the optional productʼs price to the main productʼs price. - * */ + /** @description (product_list, product_list_with_images) Flag to add the optional productʼs price to the main productʼs price. */ readonly product_list_adjusts_pricing?: boolean; /** * @description (product_list, product_list_with_images) How to factor the optional productʼs weight and package dimensions into the shipping quote. Values: `none` - donʼt adjust; `weight` - use shipping weight only; `package` - use weight and dimensions. - * * @example weight * @enum {string} */ @@ -1638,13 +1530,11 @@ export interface components { readonly adjuster_Full: { /** * @description The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @enum {string|null} */ readonly adjuster?: "relative" | "percentage" | null; /** * @description The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @example 5 */ readonly adjuster_value?: number; @@ -1663,48 +1553,39 @@ export interface components { readonly pagination_Full: { /** * @description Total number of items in the result set. - * * @example 36 */ readonly total?: number; /** * @description Total number of items in the collection response. - * * @example 36 */ readonly count?: number; /** * @description The amount of items returned in the collection per page, controlled by the limit parameter. - * * @example 50 */ readonly per_page?: number; /** * @description The page you are currently on within the collection. - * * @example 1 */ readonly current_page?: number; /** * @description The total number of pages in the collection. - * * @example 1 */ readonly total_pages?: number; - /** @description Pagination links for the previous and next parts of the whole collection. - * */ + /** @description Pagination links for the previous and next parts of the whole collection. */ readonly links?: { - /** @description Link to the previous page returned in the response. - * */ + /** @description Link to the previous page returned in the response. */ readonly previous?: string; /** * @description Link to the current page returned in the response. - * * @example ?page=1&limit=50 */ readonly current?: string; - /** @description Link to the next page returned in the response. - * */ + /** @description Link to the next page returned in the response. */ readonly next?: string; }; }; @@ -1718,14 +1599,11 @@ export interface components { /** * error_Base * @description Error payload for the BigCommerce API. - * */ readonly error_Base: { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; @@ -1755,14 +1633,12 @@ export interface components { /** * Format: date-time * @description The date on which the product was created. - * * @example 2018-08-15T14:49:05+00:00 */ readonly date_created?: string; /** * Format: date-time * @description The date on which the product was modified. - * * @example 2018-08-24T14:41:00+00:00 */ readonly date_modified?: string; @@ -1787,33 +1663,27 @@ export interface components { * @description Common ProductImage properties. */ readonly productImage_Full: components["schemas"]["productImage_Base"] & { - /** @description The unique numeric ID of the image; increments sequentially. - * */ + /** @description The unique numeric ID of the image; increments sequentially. */ readonly id?: number; - /** @description The unique numeric identifier for the product with which the image is associated. - * */ + /** @description The unique numeric identifier for the product with which the image is associated. */ readonly product_id?: number; - /** @description The URL for an image displayed on the storefront when the conditions are applied. Limit of 8MB per file. + /** + * @description The URL for an image displayed on the storefront when the conditions are applied. Limit of 8MB per file. * * Cannot be used with `image_file`. - * */ + */ readonly image_url?: string; - /** @description The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled. You should provide an image smaller than 1280x1280; otherwise, the API returns a resized image. - * */ + /** @description The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled. You should provide an image smaller than 1280x1280; otherwise, the API returns a resized image. */ readonly url_zoom?: string; - /** @description The standard URL for this image. By default, this is used for product-page images. - * */ + /** @description The standard URL for this image. By default, this is used for product-page images. */ readonly url_standard?: string; - /** @description The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels. - * */ + /** @description The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels. */ readonly url_thumbnail?: string; - /** @description The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page. - * */ + /** @description The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page. */ readonly url_tiny?: string; /** * Format: date-time * @description The date on which the product image was modified. - * */ readonly date_modified?: string; }; @@ -1822,42 +1692,33 @@ export interface components { * @description Common PrimaryImage properties. */ readonly primaryImage_Full: { - /** @description The unique numeric ID of the image; increments sequentially. - * */ + /** @description The unique numeric ID of the image; increments sequentially. */ readonly id?: number; - /** @description The unique numeric identifier for the product with which the image is associated. - * */ + /** @description The unique numeric identifier for the product with which the image is associated. */ readonly product_id?: number; - /** @description Flag for identifying whether the image is used as the productʼs thumbnail. - * */ + /** @description Flag for identifying whether the image is used as the productʼs thumbnail. */ readonly is_thumbnail?: boolean; - /** @description The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a `sort_order` the same as or greater than the imageʼs new `sort_order` value will have their `sort_order`s reordered. - * */ + /** @description The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a `sort_order` the same as or greater than the imageʼs new `sort_order` value will have their `sort_order`s reordered. */ readonly sort_order?: number; - /** @description The description for the image. - * */ + /** @description The description for the image. */ readonly description?: string; - /** @description The local path to the original image file uploaded to BigCommerce. Use image_url when creating a product. + /** + * @description The local path to the original image file uploaded to BigCommerce. Use image_url when creating a product. * * Must be sent as a `multipart/form-data` field in the request body. Limit of 8 MB per file. - * */ + */ readonly image_file?: string; - /** @description The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled. You should provide an image smaller than 1280x1280; otherwise, the API returns a resized image. - * */ + /** @description The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled. You should provide an image smaller than 1280x1280; otherwise, the API returns a resized image. */ readonly url_zoom?: string; - /** @description The standard URL for this image. By default, this is used for product-page images. - * */ + /** @description The standard URL for this image. By default, this is used for product-page images. */ readonly url_standard?: string; - /** @description The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels. - * */ + /** @description The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels. */ readonly url_thumbnail?: string; - /** @description The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page. - * */ + /** @description The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page. */ readonly url_tiny?: string; /** * Format: date-time * @description The date on which the product image was modified. - * */ readonly date_modified?: string; }; @@ -1874,21 +1735,16 @@ export interface components { * @description The values for option config can vary based on the Modifier created. */ readonly config_Full: { - /** @description (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string. - * */ + /** @description (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string. */ readonly default_value?: string; - /** @description (checkbox) Flag for setting the checkbox to be checked by default. - * */ + /** @description (checkbox) Flag for setting the checkbox to be checked by default. */ readonly checked_by_default?: boolean; - /** @description (checkbox) Label displayed for the checkbox option. - * */ + /** @description (checkbox) Label displayed for the checkbox option. */ readonly checkbox_label?: string; - /** @description (date) Flag to limit the dates allowed to be entered on a date option. - * */ + /** @description (date) Flag to limit the dates allowed to be entered on a date option. */ readonly date_limited?: boolean; /** * @description (date) The type of limit that is allowed to be entered on a date option. - * * @example range * @enum {string} */ @@ -1896,100 +1752,83 @@ export interface components { /** * Format: date * @description (date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string. - * */ readonly date_earliest_value?: string; /** * Format: date * @description (date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string. - * */ readonly date_latest_value?: string; /** * @description (file) The kind of restriction on the file types that can be uploaded with a file upload option. Values: `specific` - restricts uploads to particular file types; `all` - allows all file types. - * * @example specific * @enum {string} */ readonly file_types_mode?: "specific" | "all"; - /** @description (file) The type of files allowed to be uploaded if the `file_type_option` is set to `specific`. Values: + /** + * @description (file) The type of files allowed to be uploaded if the `file_type_option` is set to `specific`. Values: * `images` - Allows upload of image MIME types (`bmp`, `gif`, `jpg`, `jpeg`, `jpe`, `jif`, `jfif`, `jfi`, `png`, `wbmp`, `xbm`, `tiff`). `documents` - Allows upload of document MIME types (`txt`, `pdf`, `rtf`, `doc`, `docx`, `xls`, `xlsx`, `accdb`, `mdb`, `one`, `pps`, `ppsx`, `ppt`, `pptx`, `pub`, `odt`, `ods`, `odp`, `odg`, `odf`). * `other` - Allows file types defined in the `file_types_other` array. - * */ + */ readonly file_types_supported?: readonly string[]; - /** @description (file) A list of other file types allowed with the file upload option. - * */ + /** @description (file) A list of other file types allowed with the file upload option. */ readonly file_types_other?: readonly string[]; /** * @description (file) The maximum size for a file that can be used with the file upload option. This will still be limited by the server. - * * @example 5 */ readonly file_max_size?: number; - /** @description (text, multi_line_text) Flag to validate the length of a text or multi-line text input. - * */ + /** @description (text, multi_line_text) Flag to validate the length of a text or multi-line text input. */ readonly text_characters_limited?: boolean; /** * @description (text, multi_line_text) The minimum length allowed for a text or multi-line text option. - * * @example 1 */ readonly text_min_length?: number; /** * @description (text, multi_line_text) The maximum length allowed for a text or multi line text option. - * * @example 55 */ readonly text_max_length?: number; /** * @description (multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input. - * * @example true */ readonly text_lines_limited?: boolean; /** * @description (multi_line_text) The maximum number of lines allowed on a multi-line text input. - * * @example 4 */ readonly text_max_lines?: number; /** * @description (numbers_only_text) Flag to limit the value of a number option. - * * @example true */ readonly number_limited?: boolean; /** * @description (numbers_only_text) The type of limit on values entered for a number option. - * * @example lowest * @enum {string} */ readonly number_limit_mode?: "lowest" | "highest" | "range"; /** * @description (numbers_only_text) The lowest allowed value for a number option if `number_limited` is true. - * * @example 100 */ readonly number_lowest_value?: number; - /** @description (numbers_only_text) The highest allowed value for a number option if `number_limited` is true. - * */ + /** @description (numbers_only_text) The highest allowed value for a number option if `number_limited` is true. */ readonly number_highest_value?: number; /** * @description (numbers_only_text) Flag to limit the input on a number option to whole numbers only. - * * @example false */ readonly number_integers_only?: boolean; - /** @description (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list. - * */ + /** @description (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list. */ readonly product_list_adjusts_inventory?: boolean; - /** @description (product_list, product_list_with_images) Flag to add the optional productʼs price to the main productʼs price. - * */ + /** @description (product_list, product_list_with_images) Flag to add the optional productʼs price to the main productʼs price. */ readonly product_list_adjusts_pricing?: boolean; /** * @description (product_list, product_list_with_images) How to factor the optional productʼs weight and package dimensions into the shipping quote. Values: `none` - donʼt adjust; `weight` - use shipping weight only; `package` - use weight and dimensions. - * * @example weight * @enum {string} */ @@ -2001,16 +1840,13 @@ export interface components { readonly weight?: components["schemas"]["adjuster_Full"]; /** * @description The URL for an image displayed on the storefront when the modifier value is selected.Limit of 8MB per file. - * * @example https://cdn8.bigcommerce.com/s-{{store_hash}}/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.1280.1280.jpg?c=2 */ readonly image_url?: string; readonly purchasing_disabled?: { - /** @description Flag for whether the modifier value disables purchasing when selected on the storefront. This can be used for temporarily disabling a particular modifier value. - * */ + /** @description Flag for whether the modifier value disables purchasing when selected on the storefront. This can be used for temporarily disabling a particular modifier value. */ readonly status?: boolean; - /** @description The message displayed on the storefront when the purchasing disabled status is `true`. - * */ + /** @description The message displayed on the storefront when the purchasing disabled status is `true`. */ readonly message?: string; }; }; @@ -2022,150 +1858,122 @@ export interface components { readonly product_Base_POST: { /** * @description A unique product name. - * * @example Smith Journal 13 */ readonly name: string; /** * @description The product type. One of: `physical` - a physical stock unit, `digital` - a digital download. - * * @example physical * @enum {string} */ readonly type: "physical" | "digital"; /** * @description A unique user-defined alphanumeric product code/stock keeping unit (SKU). The SKU is always unique regardless of the letter case for both products and variants. - * * @example SM-13 */ readonly sku?: string; /** * @description The product description, which can include HTML formatting. - * * @example

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi vel metus ac est egestas porta sed quis erat. Integer id nulla massa. Proin vitae enim nisi. Praesent non dignissim nulla. Nulla mattis id massa ac pharetra. Mauris et nisi in dolor aliquam sodales. Aliquam dui nisl, dictum quis leo sit amet, rutrum volutpat metus. Curabitur libero nunc, interdum ac libero non, tristique porttitor metus. Ut non dignissim lorem, in vestibulum leo. Vivamus sodales quis turpis eget.

*/ readonly description?: string; /** * Format: float * @description Weight of the product, which can be used when calculating shipping costs. This is based on the unit set on the store - * */ readonly weight: number; /** * Format: float * @description Width of the product, which can be used when calculating shipping costs. - * */ readonly width?: number; /** * Format: float * @description Depth of the product, which can be used when calculating shipping costs. - * */ readonly depth?: number; /** * Format: float * @description Height of the product, which can be used when calculating shipping costs. - * */ readonly height?: number; /** * Format: float * @description The price of the product. The price should include or exclude tax, based on the store settings. - * */ readonly price: number; /** * Format: float * @description The cost price of the product. Stored for reference only; it is not used or displayed anywhere on the store. - * */ readonly cost_price?: number; /** * Format: float * @description The retail cost of the product. If entered, the retail cost price will be shown on the product page. - * */ readonly retail_price?: number; /** * Format: float * @description If entered, the sale price will be used instead of value in the price field when calculating the productʼs cost. - * */ readonly sale_price?: number; /** @description Minimum Advertised Price */ readonly map_price?: number; - /** @description The ID of the tax class applied to the product. (NOTE: Value ignored if automatic tax is enabled.) - * */ + /** @description The ID of the tax class applied to the product. (NOTE: Value ignored if automatic tax is enabled.) */ readonly tax_class_id?: number; - /** @description Tax Codes, such as AvaTax System Tax Codes, identify products and services that fall into special sales-tax categories. By using these codes, merchants who subscribe to a tax provider integration, such as BigCommerceʼs Avalara Premium, can calculate sales taxes more accurately. Stores without a tax provider will ignore the code when calculating sales tax. Do not pass more than one code. The codes are case-sensitive. For details, please see the tax providerʼs documentation. - * */ + /** @description Tax Codes, such as AvaTax System Tax Codes, identify products and services that fall into special sales-tax categories. By using these codes, merchants who subscribe to a tax provider integration, such as BigCommerceʼs Avalara Premium, can calculate sales taxes more accurately. Stores without a tax provider will ignore the code when calculating sales tax. Do not pass more than one code. The codes are case-sensitive. For details, please see the tax providerʼs documentation. */ readonly product_tax_code?: string; - /** @description An array of IDs for the categories to which this product belongs. You will overwrite all product categories when updating a product and supplying an array of categories. The limit is 1,000 ID values. When you enable the catalog V2 product experience in the control panel, you must include the categories array in the request body. - * */ + /** @description An array of IDs for the categories to which this product belongs. You will overwrite all product categories when updating a product and supplying an array of categories. The limit is 1,000 ID values. When you enable the catalog V2 product experience in the control panel, you must include the categories array in the request body. */ readonly categories?: readonly number[]; - /** @description You can add a product to an existing brand during a product /PUT or /POST. Use either the `brand_id` or the `brand_name` field. The response body can include `brand_id`. - * */ + /** @description You can add a product to an existing brand during a product /PUT or /POST. Use either the `brand_id` or the `brand_name` field. The response body can include `brand_id`. */ readonly brand_id?: number; /** * @description You can create the brand during a product PUT or POST request. If the brand already exists, the product /PUT or /POST request adds the product to the brand. If not, the product /PUT or /POST request creates the brand and then adds the product to the brand. Brand name is not case-sensitive; "Common Good" and "Common good" are the same. Use either the `brand_id` or the `brand_name` field. The response body does not include `brand_name`. * @example Common Good */ readonly brand_name?: string; - /** @description Current inventory level of the product. You must track inventory by _product_ for this to take effect (see the `inventory_tracking` field). The Catalog API returns the inventory for only the default location. + /** + * @description Current inventory level of the product. You must track inventory by _product_ for this to take effect (see the `inventory_tracking` field). The Catalog API returns the inventory for only the default location. * * The inventory for a product cannot exceed 2,147,483,647 in the catalog. If you exceed the limit, the store sets the inventory level to the limit. * - * The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). */ + * The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). + */ readonly inventory_level?: number; - /** @description Inventory warning level for the product. When the productʼs inventory level drops below the warning level, the store owner will be informed. Simple inventory tracking must be enabled (see the `inventory_tracking` field) for this to take any effect. - * */ + /** @description Inventory warning level for the product. When the productʼs inventory level drops below the warning level, the store owner will be informed. Simple inventory tracking must be enabled (see the `inventory_tracking` field) for this to take any effect. */ readonly inventory_warning_level?: number; /** * @description The type of inventory tracking for the product. Values are: `none` - inventory levels will not be tracked; `product` - inventory levels will be tracked using the `inventory_level` and `inventory_warning_level` fields; `variant` - inventory levels will be tracked based on variants, which maintain their own warning levels and inventory levels. - * * @enum {string} */ readonly inventory_tracking?: "none" | "product" | "variant"; /** * Format: float * @description A fixed shipping cost for the product. If defined, this value will be used during checkout instead of normal shipping-cost calculation. - * */ readonly fixed_cost_shipping_price?: number; - /** @description Flag used to indicate whether the product has free shipping. If `true`, the shipping cost for the product will be zero. - * */ + /** @description Flag used to indicate whether the product has free shipping. If `true`, the shipping cost for the product will be zero. */ readonly is_free_shipping?: boolean; - /** @description Flag to determine whether the product should be displayed to customers browsing the store. If `true`, the product will be displayed. If `false`, the product will be hidden from view. - * */ + /** @description Flag to determine whether the product should be displayed to customers browsing the store. If `true`, the product will be displayed. If `false`, the product will be hidden from view. */ readonly is_visible?: boolean; - /** @description Flag to determine whether the product should be included in the `featured products` panel when viewing the store. - * */ + /** @description Flag to determine whether the product should be included in the `featured products` panel when viewing the store. */ readonly is_featured?: boolean; - /** @description An array of IDs for the related products. - * */ + /** @description An array of IDs for the related products. */ readonly related_products?: readonly number[]; - /** @description Warranty information displayed on the product page. Can include HTML formatting. - * */ + /** @description Warranty information displayed on the product page. Can include HTML formatting. */ readonly warranty?: string; - /** @description The BIN picking number for the product. - * */ + /** @description The BIN picking number for the product. */ readonly bin_picking_number?: string; - /** @description The layout template file used to render this product category. This field is writable only for stores with a Blueprint theme applied. For stores with a Stencil theme applied, see [Custom Template Associations](/docs/rest-content/custom-template-associations). - * */ + /** @description The layout template file used to render this product category. This field is writable only for stores with a Blueprint theme applied. For stores with a Stencil theme applied, see [Custom Template Associations](/docs/rest-content/custom-template-associations). */ readonly layout_file?: string; - /** @description The product UPC code, which is used in feeds for shopping comparison sites and external channel integrations. - * */ + /** @description The product UPC code, which is used in feeds for shopping comparison sites and external channel integrations. */ readonly upc?: string; - /** @description A comma-separated list of keywords that can be used to locate the product when searching the store. - * */ + /** @description A comma-separated list of keywords that can be used to locate the product when searching the store. */ readonly search_keywords?: string; - /** @description Availability text displayed on the checkout page, under the product title. Tells the customer how long it will normally take to ship this product, such as: 'Usually ships in 24 hours.' - * */ + /** @description Availability text displayed on the checkout page, under the product title. Tells the customer how long it will normally take to ship this product, such as: 'Usually ships in 24 hours.' */ readonly availability_description?: string; /** * @description Availability of the product. (Corresponds to the productʼs [Purchasability](https://support.bigcommerce.com/s/article/Adding-Products-v3?language=en_US#sections) section in the control panel.) Supported values: `available` - the product is available for purchase; `disabled` - the product is listed on the storefront, but cannot be purchased; `preorder` - the product is listed for pre-orders. - * * @enum {string} */ readonly availability?: "available" | "disabled" | "preorder"; @@ -2173,89 +1981,71 @@ export interface components { * @description Type of gift-wrapping options. Values: `any` - allow any gift-wrapping options in the store; `none` - disallow gift-wrapping on the product; `list` – provide a list of IDs in the `gift_wrapping_options_list` field. * * Always included in the response body; not applicable for the `include_fields` and `exclude_fields` query parameters. - * * @enum {string} */ readonly gift_wrapping_options_type?: "any" | "none" | "list"; - /** @description A list of gift-wrapping option IDs. + /** + * @description A list of gift-wrapping option IDs. * * Always included in the response body; not applicable for the `include_fields` and `exclude_fields` query parameters. - * */ + */ readonly gift_wrapping_options_list?: readonly number[]; - /** @description Priority to give this product when included in product lists on category pages and in search results. Lower integers will place the product closer to the top of the results. - * */ + /** @description Priority to give this product when included in product lists on category pages and in search results. Lower integers will place the product closer to the top of the results. */ readonly sort_order?: number; /** * @description The product condition. Will be shown on the product page if the `is_condition_shown` fieldʼs value is `true`. Possible values: `New`, `Used`, `Refurbished`. - * * @enum {string} */ readonly condition?: "New" | "Used" | "Refurbished"; - /** @description Flag used to determine whether the product condition is shown to the customer on the product page. - * */ + /** @description Flag used to determine whether the product condition is shown to the customer on the product page. */ readonly is_condition_shown?: boolean; - /** @description The minimum quantity an order must contain, to be eligible to purchase this product. - * */ + /** @description The minimum quantity an order must contain, to be eligible to purchase this product. */ readonly order_quantity_minimum?: number; - /** @description The maximum quantity an order can contain when purchasing the product. - * */ + /** @description The maximum quantity an order can contain when purchasing the product. */ readonly order_quantity_maximum?: number; - /** @description Custom title for the product page. If not defined, the product name will be used as the meta title. - * */ + /** @description Custom title for the product page. If not defined, the product name will be used as the meta title. */ readonly page_title?: string; - /** @description Custom meta keywords for the product page. If not defined, the storeʼs default keywords will be used. - * */ + /** @description Custom meta keywords for the product page. If not defined, the storeʼs default keywords will be used. */ readonly meta_keywords?: readonly string[]; - /** @description Custom meta description for the product page. If not defined, the storeʼs default meta description will be used. - * */ + /** @description Custom meta description for the product page. If not defined, the storeʼs default meta description will be used. */ readonly meta_description?: string; /** * @deprecated * @description The number of times the product has been viewed. - * */ readonly view_count?: number; /** * Format: date-time * @description Pre-order release date. See the `availability` field for details on setting a productʼs availability to accept pre-orders. - * */ readonly preorder_release_date?: string | null; - /** @description Custom expected-date message to display on the product page. If undefined, the message defaults to the storewide setting. Can contain the `%%DATE%%` placeholder, which will be substituted for the release date. - * */ + /** @description Custom expected-date message to display on the product page. If undefined, the message defaults to the storewide setting. Can contain the `%%DATE%%` placeholder, which will be substituted for the release date. */ readonly preorder_message?: string; - /** @description If set to true then on the preorder release date the preorder status will automatically be removed. + /** + * @description If set to true then on the preorder release date the preorder status will automatically be removed. * If set to false, then on the release date the preorder status **will not** be removed. It will need to be changed manually either in the * control panel or using the API. Using the API set `availability` to `available`. - * */ + */ readonly is_preorder_only?: boolean; - /** @description False by default, indicating that this productʼs price should be shown on the product page. If set to `true`, the price is hidden. (NOTE: To successfully set `is_price_hidden` to `true`, the `availability` value must be `disabled`.) - * */ + /** @description False by default, indicating that this productʼs price should be shown on the product page. If set to `true`, the price is hidden. (NOTE: To successfully set `is_price_hidden` to `true`, the `availability` value must be `disabled`.) */ readonly is_price_hidden?: boolean; - /** @description By default, an empty string. If `is_price_hidden` is `true`, the value of `price_hidden_label` is displayed instead of the price. (NOTE: To successfully set a non-empty string value with `is_price_hidden` set to `true`, the `availability` value must be `disabled`.) - * */ + /** @description By default, an empty string. If `is_price_hidden` is `true`, the value of `price_hidden_label` is displayed instead of the price. (NOTE: To successfully set a non-empty string value with `is_price_hidden` set to `true`, the `availability` value must be `disabled`.) */ readonly price_hidden_label?: string; readonly custom_url?: components["schemas"]["customUrl_Full"]; /** * @description Type of product, defaults to `product`. - * * @enum {string} */ readonly open_graph_type?: "product" | "album" | "book" | "drink" | "food" | "game" | "movie" | "song" | "tv_show"; - /** @description Title of the product, if not specified the product name will be used instead. - * */ + /** @description Title of the product, if not specified the product name will be used instead. */ readonly open_graph_title?: string; - /** @description Description to use for the product, if not specified then the meta_description will be used instead. - * */ + /** @description Description to use for the product, if not specified then the meta_description will be used instead. */ readonly open_graph_description?: string; - /** @description Flag to determine if product description or open graph description is used. - * */ + /** @description Flag to determine if product description or open graph description is used. */ readonly open_graph_use_meta_description?: boolean; - /** @description Flag to determine if product name or open graph name is used. - * */ + /** @description Flag to determine if product name or open graph name is used. */ readonly open_graph_use_product_name?: boolean; - /** @description Flag to determine if product image or open graph image is used. - * */ + /** @description Flag to determine if product image or open graph image is used. */ readonly open_graph_use_image?: boolean; /** @description Global Trade Item Number */ readonly gtin?: string; @@ -2265,19 +2055,16 @@ export interface components { readonly date_last_imported?: string; /** * @description The total (cumulative) rating for the product. - * * @example 3 */ readonly reviews_rating_sum?: number; /** * @description The number of times the product has been rated. - * * @example 4 */ readonly reviews_count?: number; /** * @description The total quantity of this product sold. - * * @example 80 */ readonly total_sold?: number; @@ -2288,9 +2075,10 @@ export interface components { readonly id: number; } & components["schemas"]["bulkPricingRule_Full"])[]; readonly images?: readonly components["schemas"]["productImage_Full"][]; - /** @description The Catalog API integrates with third-party YouTube. + /** + * @description The Catalog API integrates with third-party YouTube. * The [YouTube Terms of Service](https://www.youtube.com/t/terms) and [Google Privacy Policy](https://policies.google.com/privacy) apply, as indicated in our [Privacy Policy](https://www.bigcommerce.com/privacy/) and [Terms of Service](https://www.bigcommerce.com/terms/). - * */ + */ readonly videos?: readonly components["schemas"]["productVideo_Full"][]; readonly variants?: readonly components["schemas"]["productVariant_Full"][]; }; @@ -2302,150 +2090,122 @@ export interface components { readonly product_Base_PUT: { /** * @description A unique product name. - * * @example Smith Journal 13 */ readonly name?: string; /** * @description The product type. One of: `physical` - a physical stock unit, `digital` - a digital download. - * * @example physical * @enum {string} */ readonly type?: "physical" | "digital"; /** * @description A unique user-defined alphanumeric product code/stock keeping unit (SKU). The SKU is always unique regardless of the letter case for both products and variants. - * * @example SM-13 */ readonly sku?: string; /** * @description The product description, which can include HTML formatting. - * * @example

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi vel metus ac est egestas porta sed quis erat. Integer id nulla massa. Proin vitae enim nisi. Praesent non dignissim nulla. Nulla mattis id massa ac pharetra. Mauris et nisi in dolor aliquam sodales. Aliquam dui nisl, dictum quis leo sit amet, rutrum volutpat metus. Curabitur libero nunc, interdum ac libero non, tristique porttitor metus. Ut non dignissim lorem, in vestibulum leo. Vivamus sodales quis turpis eget.

*/ readonly description?: string; /** * Format: float * @description Weight of the product, which can be used when calculating shipping costs. This is based on the unit set on the store. - * */ readonly weight?: number; /** * Format: float * @description Width of the product, which can be used when calculating shipping costs. - * */ readonly width?: number; /** * Format: float * @description Depth of the product, which can be used when calculating shipping costs. - * */ readonly depth?: number; /** * Format: float * @description Height of the product, which can be used when calculating shipping costs. - * */ readonly height?: number; /** * Format: float * @description The price of the product. The price should include or exclude tax, based on the store settings. - * */ readonly price?: number; /** * Format: float * @description The cost price of the product. Stored for reference only; it is not used or displayed anywhere on the store. - * */ readonly cost_price?: number; /** * Format: float * @description The retail cost of the product. If entered, the retail cost price will be shown on the product page. - * */ readonly retail_price?: number; /** * Format: float * @description If entered, the sale price will be used instead of value in the price field when calculating the productʼs cost. - * */ readonly sale_price?: number; /** @description Minimum Advertised Price */ readonly map_price?: number; - /** @description The ID of the tax class applied to the product. (NOTE: Value ignored if automatic tax is enabled.) - * */ + /** @description The ID of the tax class applied to the product. (NOTE: Value ignored if automatic tax is enabled.) */ readonly tax_class_id?: number; - /** @description Tax Codes, such as AvaTax System Tax Codes, identify products and services that fall into special sales-tax categories. By using these codes, merchants who subscribe to a tax provider integration, such as BigCommerceʼs Avalara Premium, can calculate sales taxes more accurately. Stores without a tax provider will ignore the code when calculating sales tax. Do not pass more than one code. The codes are case-sensitive. For details, please see the tax providerʼs documentation. - * */ + /** @description Tax Codes, such as AvaTax System Tax Codes, identify products and services that fall into special sales-tax categories. By using these codes, merchants who subscribe to a tax provider integration, such as BigCommerceʼs Avalara Premium, can calculate sales taxes more accurately. Stores without a tax provider will ignore the code when calculating sales tax. Do not pass more than one code. The codes are case-sensitive. For details, please see the tax providerʼs documentation. */ readonly product_tax_code?: string; - /** @description An array of IDs for the categories to which this product belongs. When updating a product, if an array of categories is supplied, all product categories will be overwritten. Does not accept more than 1,000 ID values. - * */ + /** @description An array of IDs for the categories to which this product belongs. When updating a product, if an array of categories is supplied, all product categories will be overwritten. Does not accept more than 1,000 ID values. */ readonly categories?: readonly number[]; - /** @description You can add a product to an existing brand during a product /PUT or /POST. Use either the `brand_id` or the `brand_name` field. The response body can include `brand_id`. - * */ + /** @description You can add a product to an existing brand during a product /PUT or /POST. Use either the `brand_id` or the `brand_name` field. The response body can include `brand_id`. */ readonly brand_id?: number; /** * @description You can create the brand during a product PUT or POST request. If the brand already exists, the product /PUT or /POST request adds the product to the brand. If not, the product /PUT or /POST request creates the brand and then adds the product to the brand. Brand name is not case-sensitive; "Common Good" and "Common good" are the same. Use either the `brand_id` or the `brand_name` field. The response body does not include `brand_name`. * @example Common Good */ readonly brand_name?: string; - /** @description Current inventory level of the product. You must track inventory by _product_ for this to take effect (see the `inventory_tracking` field). The Catalog API returns the inventory for only the default location. + /** + * @description Current inventory level of the product. You must track inventory by _product_ for this to take effect (see the `inventory_tracking` field). The Catalog API returns the inventory for only the default location. * * The inventory for a product cannot exceed 2,147,483,647 in the catalog. If you exceed the limit, the store sets the inventory level to the limit. * - * The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). */ + * The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). + */ readonly inventory_level?: number; - /** @description Inventory warning level for the product. When the productʼs inventory level drops below the warning level, the store owner will be informed. Simple inventory tracking must be enabled (see the `inventory_tracking` field) for this to take any effect. - * */ + /** @description Inventory warning level for the product. When the productʼs inventory level drops below the warning level, the store owner will be informed. Simple inventory tracking must be enabled (see the `inventory_tracking` field) for this to take any effect. */ readonly inventory_warning_level?: number; /** * @description The type of inventory tracking for the product. Values are: `none` - inventory levels will not be tracked; `product` - inventory levels will be tracked using the `inventory_level` and `inventory_warning_level` fields; `variant` - inventory levels will be tracked based on variants, which maintain their own warning levels and inventory levels. - * * @enum {string} */ readonly inventory_tracking?: "none" | "product" | "variant"; /** * Format: float * @description A fixed shipping cost for the product. If defined, this value will be used during checkout instead of normal shipping-cost calculation. - * */ readonly fixed_cost_shipping_price?: number; - /** @description Flag used to indicate whether the product has free shipping. If `true`, the shipping cost for the product will be zero. - * */ + /** @description Flag used to indicate whether the product has free shipping. If `true`, the shipping cost for the product will be zero. */ readonly is_free_shipping?: boolean; - /** @description Flag to determine whether the product should be displayed to customers browsing the store. If `true`, the product will be displayed. If `false`, the product will be hidden from view. - * */ + /** @description Flag to determine whether the product should be displayed to customers browsing the store. If `true`, the product will be displayed. If `false`, the product will be hidden from view. */ readonly is_visible?: boolean; - /** @description Flag to determine whether the product should be included in the `featured products` panel when viewing the store. - * */ + /** @description Flag to determine whether the product should be included in the `featured products` panel when viewing the store. */ readonly is_featured?: boolean; - /** @description An array of IDs for the related products. - * */ + /** @description An array of IDs for the related products. */ readonly related_products?: readonly number[]; - /** @description Warranty information displayed on the product page. Can include HTML formatting. - * */ + /** @description Warranty information displayed on the product page. Can include HTML formatting. */ readonly warranty?: string; - /** @description The BIN picking number for the product. - * */ + /** @description The BIN picking number for the product. */ readonly bin_picking_number?: string; - /** @description The layout template file used to render this product category. This field is writable only for stores with a Blueprint theme applied. For stores with a Stencil theme applied, see [Custom Template Associations](/docs/rest-content/custom-template-associations). - * */ + /** @description The layout template file used to render this product category. This field is writable only for stores with a Blueprint theme applied. For stores with a Stencil theme applied, see [Custom Template Associations](/docs/rest-content/custom-template-associations). */ readonly layout_file?: string; - /** @description The product UPC code, which is used in feeds for shopping comparison sites and external channel integrations. - * */ + /** @description The product UPC code, which is used in feeds for shopping comparison sites and external channel integrations. */ readonly upc?: string; - /** @description A comma-separated list of keywords that can be used to locate the product when searching the store. - * */ + /** @description A comma-separated list of keywords that can be used to locate the product when searching the store. */ readonly search_keywords?: string; - /** @description Availability text displayed on the checkout page, under the product title. Tells the customer how long it will normally take to ship this product, such as: 'Usually ships in 24 hours.' - * */ + /** @description Availability text displayed on the checkout page, under the product title. Tells the customer how long it will normally take to ship this product, such as: 'Usually ships in 24 hours.' */ readonly availability_description?: string; /** * @description Availability of the product. (Corresponds to the productʼs [Purchasability](https://support.bigcommerce.com/s/article/Adding-Products-v3?language=en_US#sections) section in the control panel.) Supported values: `available` - the product is available for purchase; `disabled` - the product is listed on the storefront, but cannot be purchased; `preorder` - the product is listed for pre-orders. - * * @enum {string} */ readonly availability?: "available" | "disabled" | "preorder"; @@ -2453,89 +2213,71 @@ export interface components { * @description Type of gift-wrapping options. Values: `any` - allow any gift-wrapping options in the store; `none` - disallow gift-wrapping on the product; `list` – provide a list of IDs in the `gift_wrapping_options_list` field. * * Always included in the response body; not applicable for the `include_fields` and `exclude_fields` query parameters. - * * @enum {string} */ readonly gift_wrapping_options_type?: "any" | "none" | "list"; - /** @description A list of gift-wrapping option IDs. + /** + * @description A list of gift-wrapping option IDs. * * Always included in the response body; not applicable for the `include_fields` and `exclude_fields` query parameters. - * */ + */ readonly gift_wrapping_options_list?: readonly number[]; - /** @description Priority to give this product when included in product lists on category pages and in search results. Lower integers will place the product closer to the top of the results. - * */ + /** @description Priority to give this product when included in product lists on category pages and in search results. Lower integers will place the product closer to the top of the results. */ readonly sort_order?: number; /** * @description The product condition. Will be shown on the product page if the `is_condition_shown` fieldʼs value is `true`. Possible values: `New`, `Used`, `Refurbished`. - * * @enum {string} */ readonly condition?: "New" | "Used" | "Refurbished"; - /** @description Flag used to determine whether the product condition is shown to the customer on the product page. - * */ + /** @description Flag used to determine whether the product condition is shown to the customer on the product page. */ readonly is_condition_shown?: boolean; - /** @description The minimum quantity an order must contain, to be eligible to purchase this product. - * */ + /** @description The minimum quantity an order must contain, to be eligible to purchase this product. */ readonly order_quantity_minimum?: number; - /** @description The maximum quantity an order can contain when purchasing the product. - * */ + /** @description The maximum quantity an order can contain when purchasing the product. */ readonly order_quantity_maximum?: number; - /** @description Custom title for the product page. If not defined, the product name will be used as the meta title. - * */ + /** @description Custom title for the product page. If not defined, the product name will be used as the meta title. */ readonly page_title?: string; - /** @description Custom meta keywords for the product page. If not defined, the storeʼs default keywords will be used. - * */ + /** @description Custom meta keywords for the product page. If not defined, the storeʼs default keywords will be used. */ readonly meta_keywords?: readonly string[]; - /** @description Custom meta description for the product page. If not defined, the storeʼs default meta description will be used. - * */ + /** @description Custom meta description for the product page. If not defined, the storeʼs default meta description will be used. */ readonly meta_description?: string; /** * @deprecated * @description The number of times the product has been viewed. - * */ readonly view_count?: number; /** * Format: date-time * @description Pre-order release date. See the `availability` field for details on setting a productʼs availability to accept pre-orders. - * */ readonly preorder_release_date?: string | null; - /** @description Custom expected-date message to display on the product page. If undefined, the message defaults to the storewide setting. Can contain the `%%DATE%%` placeholder, which will be substituted for the release date. - * */ + /** @description Custom expected-date message to display on the product page. If undefined, the message defaults to the storewide setting. Can contain the `%%DATE%%` placeholder, which will be substituted for the release date. */ readonly preorder_message?: string; - /** @description If set to true then on the preorder release date the preorder status will automatically be removed. + /** + * @description If set to true then on the preorder release date the preorder status will automatically be removed. * If set to false, then on the release date the preorder status **will not** be removed. It will need to be changed manually either in the * control panel or using the API. Using the API set `availability` to `available`. - * */ + */ readonly is_preorder_only?: boolean; - /** @description False by default, indicating that this productʼs price should be shown on the product page. If set to `true`, the price is hidden. (NOTE: To successfully set `is_price_hidden` to `true`, the `availability` value must be `disabled`.) - * */ + /** @description False by default, indicating that this productʼs price should be shown on the product page. If set to `true`, the price is hidden. (NOTE: To successfully set `is_price_hidden` to `true`, the `availability` value must be `disabled`.) */ readonly is_price_hidden?: boolean; - /** @description By default, an empty string. If `is_price_hidden` is `true`, the value of `price_hidden_label` is displayed instead of the price. (NOTE: To successfully set a non-empty string value with `is_price_hidden` set to `true`, the `availability` value must be `disabled`.) - * */ + /** @description By default, an empty string. If `is_price_hidden` is `true`, the value of `price_hidden_label` is displayed instead of the price. (NOTE: To successfully set a non-empty string value with `is_price_hidden` set to `true`, the `availability` value must be `disabled`.) */ readonly price_hidden_label?: string; readonly custom_url?: components["schemas"]["customUrl_Full"]; /** * @description Type of product, defaults to `product`. - * * @enum {string} */ readonly open_graph_type?: "product" | "album" | "book" | "drink" | "food" | "game" | "movie" | "song" | "tv_show"; - /** @description Title of the product, if not specified the product name will be used instead. - * */ + /** @description Title of the product, if not specified the product name will be used instead. */ readonly open_graph_title?: string; - /** @description Description to use for the product, if not specified then the meta_description will be used instead. - * */ + /** @description Description to use for the product, if not specified then the meta_description will be used instead. */ readonly open_graph_description?: string; - /** @description Flag to determine if product description or open graph description is used. - * */ + /** @description Flag to determine if product description or open graph description is used. */ readonly open_graph_use_meta_description?: boolean; - /** @description Flag to determine if product name or open graph name is used. - * */ + /** @description Flag to determine if product name or open graph name is used. */ readonly open_graph_use_product_name?: boolean; - /** @description Flag to determine if product image or open graph image is used. - * */ + /** @description Flag to determine if product image or open graph image is used. */ readonly open_graph_use_image?: boolean; /** @description Global Trade Item Number */ readonly gtin?: string; @@ -2545,19 +2287,16 @@ export interface components { readonly date_last_imported?: string; /** * @description The total (cumulative) rating for the product. - * * @example 3 */ readonly reviews_rating_sum?: number; /** * @description The number of times the product has been rated. - * * @example 4 */ readonly reviews_count?: number; /** * @description The total quantity of this product sold. - * * @example 80 */ readonly total_sold?: number; @@ -2568,9 +2307,10 @@ export interface components { readonly id: number; } & components["schemas"]["bulkPricingRule_Full"])[]; readonly images?: readonly components["schemas"]["productImage_Full"][]; - /** @description The Catalog API integrates with third-party YouTube. + /** + * @description The Catalog API integrates with third-party YouTube. * The [YouTube Terms of Service](https://www.youtube.com/t/terms) and [Google Privacy Policy](https://policies.google.com/privacy) apply, as indicated in our [Privacy Policy](https://www.bigcommerce.com/privacy/) and [Terms of Service](https://www.bigcommerce.com/terms/). - * */ + */ readonly videos?: readonly components["schemas"]["productVideo_Full"][]; }; /** @@ -2580,145 +2320,117 @@ export interface components { readonly product_Base_response: { /** * @description A unique product name. - * * @example Smith Journal 13 */ readonly name?: string; /** * @description The product type. One of: `physical` - a physical stock unit, `digital` - a digital download. - * * @example physical * @enum {string} */ readonly type?: "physical" | "digital"; /** * @description A unique user-defined alphanumeric product code/stock keeping unit (SKU). - * * @example SM-13 */ readonly sku?: string; /** * @description The product description, which can include HTML formatting. - * * @example

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi vel metus ac est egestas porta sed quis erat. Integer id nulla massa. Proin vitae enim nisi. Praesent non dignissim nulla. Nulla mattis id massa ac pharetra. Mauris et nisi in dolor aliquam sodales. Aliquam dui nisl, dictum quis leo sit amet, rutrum volutpat metus. Curabitur libero nunc, interdum ac libero non, tristique porttitor metus. Ut non dignissim lorem, in vestibulum leo. Vivamus sodales quis turpis eget.

*/ readonly description?: string; /** * Format: float * @description Weight of the product, which can be used when calculating shipping costs. This is based on the unit set on the store - * */ readonly weight?: number; /** * Format: float * @description Width of the product, which can be used when calculating shipping costs. - * */ readonly width?: number; /** * Format: float * @description Depth of the product, which can be used when calculating shipping costs. - * */ readonly depth?: number; /** * Format: float * @description Height of the product, which can be used when calculating shipping costs. - * */ readonly height?: number; /** * Format: float * @description The price of the product. The price should include or exclude tax, based on the store settings. - * */ readonly price?: number; /** * Format: float * @description The cost price of the product. Stored for reference only; it is not used or displayed anywhere on the store. - * */ readonly cost_price?: number; /** * Format: float * @description The retail cost of the product. If entered, the retail cost price will be shown on the product page. - * */ readonly retail_price?: number; /** * Format: float * @description If entered, the sale price will be used instead of value in the price field when calculating the productʼs cost. - * */ readonly sale_price?: number; /** @description Minimum Advertised Price */ readonly map_price?: number; - /** @description The ID of the tax class applied to the product. (NOTE: Value ignored if automatic tax is enabled.) - * */ + /** @description The ID of the tax class applied to the product. (NOTE: Value ignored if automatic tax is enabled.) */ readonly tax_class_id?: number; - /** @description Tax Codes, such as AvaTax System Tax Codes, identify products and services that fall into special sales-tax categories. By using these codes, merchants who subscribe to a tax provider integration, such as BigCommerceʼs Avalara Premium, can calculate sales taxes more accurately. Stores without a tax provider will ignore the code when calculating sales tax. Do not pass more than one code. The codes are case-sensitive. For details, please see the tax providerʼs documentation. - * */ + /** @description Tax Codes, such as AvaTax System Tax Codes, identify products and services that fall into special sales-tax categories. By using these codes, merchants who subscribe to a tax provider integration, such as BigCommerceʼs Avalara Premium, can calculate sales taxes more accurately. Stores without a tax provider will ignore the code when calculating sales tax. Do not pass more than one code. The codes are case-sensitive. For details, please see the tax providerʼs documentation. */ readonly product_tax_code?: string; - /** @description An array of IDs for the categories to which this product belongs. When updating a product, if an array of categories is supplied, all product categories will be overwritten. Does not accept more than 1,000 ID values. - * */ + /** @description An array of IDs for the categories to which this product belongs. When updating a product, if an array of categories is supplied, all product categories will be overwritten. Does not accept more than 1,000 ID values. */ readonly categories?: readonly number[]; - /** @description You can add a product to an existing brand during a product /PUT or /POST use the `brand_id` field. The response body can include `brand_id'. - * */ + /** @description You can add a product to an existing brand during a product /PUT or /POST use the `brand_id` field. The response body can include `brand_id'. */ readonly brand_id?: number; - /** @description Current inventory level of the product. You must track inventory by _product_ for this to take effect (see the `inventory_tracking` field). The Catalog API returns the inventory for only the default location. + /** + * @description Current inventory level of the product. You must track inventory by _product_ for this to take effect (see the `inventory_tracking` field). The Catalog API returns the inventory for only the default location. * * The inventory for a product cannot exceed 2,147,483,647 in the catalog. If you exceed the limit, the store sets the inventory level to the limit. * - * The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). */ + * The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api). + */ readonly inventory_level?: number; - /** @description Inventory warning level for the product. When the productʼs inventory level drops below the warning level, the store owner will be informed. Simple inventory tracking must be enabled (see the `inventory_tracking` field) for this to take any effect. - * */ + /** @description Inventory warning level for the product. When the productʼs inventory level drops below the warning level, the store owner will be informed. Simple inventory tracking must be enabled (see the `inventory_tracking` field) for this to take any effect. */ readonly inventory_warning_level?: number; /** * @description The type of inventory tracking for the product. Values are: `none` - inventory levels will not be tracked; `product` - inventory levels will be tracked using the `inventory_level` and `inventory_warning_level` fields; `variant` - inventory levels will be tracked based on variants, which maintain their own warning levels and inventory levels. - * * @enum {string} */ readonly inventory_tracking?: "none" | "product" | "variant"; /** * Format: float * @description A fixed shipping cost for the product. If defined, this value will be used during checkout instead of normal shipping-cost calculation. - * */ readonly fixed_cost_shipping_price?: number; - /** @description Flag used to indicate whether the product has free shipping. If `true`, the shipping cost for the product will be zero. - * */ + /** @description Flag used to indicate whether the product has free shipping. If `true`, the shipping cost for the product will be zero. */ readonly is_free_shipping?: boolean; - /** @description Flag to determine whether the product should be displayed to customers browsing the store. If `true`, the product will be displayed. If `false`, the product will be hidden from view. - * */ + /** @description Flag to determine whether the product should be displayed to customers browsing the store. If `true`, the product will be displayed. If `false`, the product will be hidden from view. */ readonly is_visible?: boolean; - /** @description Flag to determine whether the product should be included in the `featured products` panel when viewing the store. - * */ + /** @description Flag to determine whether the product should be included in the `featured products` panel when viewing the store. */ readonly is_featured?: boolean; - /** @description An array of IDs for the related products. - * */ + /** @description An array of IDs for the related products. */ readonly related_products?: readonly number[]; - /** @description Warranty information displayed on the product page. Can include HTML formatting. - * */ + /** @description Warranty information displayed on the product page. Can include HTML formatting. */ readonly warranty?: string; - /** @description The BIN picking number for the product. - * */ + /** @description The BIN picking number for the product. */ readonly bin_picking_number?: string; - /** @description The layout template file used to render this product category. This field is writable only for stores with a Blueprint theme applied. For stores with a Stencil theme applied, see [Custom Template Associations](/docs/rest-content/custom-template-associations). - * */ + /** @description The layout template file used to render this product category. This field is writable only for stores with a Blueprint theme applied. For stores with a Stencil theme applied, see [Custom Template Associations](/docs/rest-content/custom-template-associations). */ readonly layout_file?: string; - /** @description The product UPC code, which is used in feeds for shopping comparison sites and external channel integrations. - * */ + /** @description The product UPC code, which is used in feeds for shopping comparison sites and external channel integrations. */ readonly upc?: string; - /** @description A comma-separated list of keywords that can be used to locate the product when searching the store. - * */ + /** @description A comma-separated list of keywords that can be used to locate the product when searching the store. */ readonly search_keywords?: string; - /** @description Availability text displayed on the checkout page, under the product title. Tells the customer how long it will normally take to ship this product, such as: 'Usually ships in 24 hours.' - * */ + /** @description Availability text displayed on the checkout page, under the product title. Tells the customer how long it will normally take to ship this product, such as: 'Usually ships in 24 hours.' */ readonly availability_description?: string; /** * @description Availability of the product. (Corresponds to the productʼs [Purchasability](https://support.bigcommerce.com/s/article/Adding-Products-v3?language=en_US#sections) section in the control panel.) Supported values: `available` - the product is available for purchase; `disabled` - the product is listed on the storefront, but cannot be purchased; `preorder` - the product is listed for pre-orders. - * * @enum {string} */ readonly availability?: "available" | "disabled" | "preorder"; @@ -2726,89 +2438,71 @@ export interface components { * @description Type of gift-wrapping options. Values: `any` - allow any gift-wrapping options in the store; `none` - disallow gift-wrapping on the product; `list` – provide a list of IDs in the `gift_wrapping_options_list` field. * * Always included in the response body; not applicable for the `include_fields` and `exclude_fields` query parameters. - * * @enum {string} */ readonly gift_wrapping_options_type?: "any" | "none" | "list"; - /** @description A list of gift-wrapping option IDs. + /** + * @description A list of gift-wrapping option IDs. * * Always included in the response body; not applicable for the `include_fields` and `exclude_fields` query parameters. - * */ + */ readonly gift_wrapping_options_list?: readonly number[]; - /** @description Priority to give this product when included in product lists on category pages and in search results. Lower integers will place the product closer to the top of the results. - * */ + /** @description Priority to give this product when included in product lists on category pages and in search results. Lower integers will place the product closer to the top of the results. */ readonly sort_order?: number; /** * @description The product condition. Will be shown on the product page if the `is_condition_shown` fieldʼs value is `true`. Possible values: `New`, `Used`, `Refurbished`. - * * @enum {string} */ readonly condition?: "New" | "Used" | "Refurbished"; - /** @description Flag used to determine whether the product condition is shown to the customer on the product page. - * */ + /** @description Flag used to determine whether the product condition is shown to the customer on the product page. */ readonly is_condition_shown?: boolean; - /** @description The minimum quantity an order must contain, to be eligible to purchase this product. - * */ + /** @description The minimum quantity an order must contain, to be eligible to purchase this product. */ readonly order_quantity_minimum?: number; - /** @description The maximum quantity an order can contain when purchasing the product. - * */ + /** @description The maximum quantity an order can contain when purchasing the product. */ readonly order_quantity_maximum?: number; - /** @description Custom title for the product page. If not defined, the product name will be used as the meta title. - * */ + /** @description Custom title for the product page. If not defined, the product name will be used as the meta title. */ readonly page_title?: string; - /** @description Custom meta keywords for the product page. If not defined, the storeʼs default keywords will be used. - * */ + /** @description Custom meta keywords for the product page. If not defined, the storeʼs default keywords will be used. */ readonly meta_keywords?: readonly string[]; - /** @description Custom meta description for the product page. If not defined, the storeʼs default meta description will be used. - * */ + /** @description Custom meta description for the product page. If not defined, the storeʼs default meta description will be used. */ readonly meta_description?: string; /** * @deprecated * @description The number of times the product has been viewed. - * */ readonly view_count?: number; /** * Format: date-time * @description Pre-order release date. See the `availability` field for details on setting a productʼs availability to accept pre-orders. - * */ readonly preorder_release_date?: string | null; - /** @description Custom expected-date message to display on the product page. If undefined, the message defaults to the storewide setting. Can contain the `%%DATE%%` placeholder, which will be substituted for the release date. - * */ + /** @description Custom expected-date message to display on the product page. If undefined, the message defaults to the storewide setting. Can contain the `%%DATE%%` placeholder, which will be substituted for the release date. */ readonly preorder_message?: string; - /** @description If set to true then on the preorder release date the preorder status will automatically be removed. + /** + * @description If set to true then on the preorder release date the preorder status will automatically be removed. * If set to false, then on the release date the preorder status **will not** be removed. It will need to be changed manually either in the * control panel or using the API. Using the API set `availability` to `available`. - * */ + */ readonly is_preorder_only?: boolean; - /** @description False by default, indicating that this productʼs price should be shown on the product page. If set to `true`, the price is hidden. (NOTE: To successfully set `is_price_hidden` to `true`, the `availability` value must be `disabled`.) - * */ + /** @description False by default, indicating that this productʼs price should be shown on the product page. If set to `true`, the price is hidden. (NOTE: To successfully set `is_price_hidden` to `true`, the `availability` value must be `disabled`.) */ readonly is_price_hidden?: boolean; - /** @description By default, an empty string. If `is_price_hidden` is `true`, the value of `price_hidden_label` is displayed instead of the price. (NOTE: To successfully set a non-empty string value with `is_price_hidden` set to `true`, the `availability` value must be `disabled`.) - * */ + /** @description By default, an empty string. If `is_price_hidden` is `true`, the value of `price_hidden_label` is displayed instead of the price. (NOTE: To successfully set a non-empty string value with `is_price_hidden` set to `true`, the `availability` value must be `disabled`.) */ readonly price_hidden_label?: string; readonly custom_url?: components["schemas"]["customUrl_Full"]; /** * @description Type of product, defaults to `product`. - * * @enum {string} */ readonly open_graph_type?: "product" | "album" | "book" | "drink" | "food" | "game" | "movie" | "song" | "tv_show"; - /** @description Title of the product, if not specified the product name will be used instead. - * */ + /** @description Title of the product, if not specified the product name will be used instead. */ readonly open_graph_title?: string; - /** @description Description to use for the product, if not specified then the meta_description will be used instead. - * */ + /** @description Description to use for the product, if not specified then the meta_description will be used instead. */ readonly open_graph_description?: string; - /** @description Flag to determine if product description or open graph description is used. - * */ + /** @description Flag to determine if product description or open graph description is used. */ readonly open_graph_use_meta_description?: boolean; - /** @description Flag to determine if product name or open graph name is used. - * */ + /** @description Flag to determine if product name or open graph name is used. */ readonly open_graph_use_product_name?: boolean; - /** @description Flag to determine if product image or open graph image is used. - * */ + /** @description Flag to determine if product image or open graph image is used. */ readonly open_graph_use_image?: boolean; /** @description Global Trade Item Number */ readonly gtin?: string; @@ -2818,19 +2512,16 @@ export interface components { readonly date_last_imported?: string; /** * @description The total (cumulative) rating for the product. - * * @example 3 */ readonly reviews_rating_sum?: number; /** * @description The number of times the product has been rated. - * * @example 4 */ readonly reviews_count?: number; /** * @description The total quantity of this product sold. - * * @example 80 */ readonly total_sold?: number; @@ -2842,9 +2533,10 @@ export interface components { } & components["schemas"]["bulkPricingRule_Full"])[]; readonly images?: readonly components["schemas"]["productImage_Full"][]; readonly primary_image?: components["schemas"]["primaryImage_Full"]; - /** @description The Catalog API integrates with third-party YouTube. + /** + * @description The Catalog API integrates with third-party YouTube. * The [YouTube Terms of Service](https://www.youtube.com/t/terms) and [Google Privacy Policy](https://policies.google.com/privacy) apply, as indicated in our [Privacy Policy](https://www.bigcommerce.com/privacy/) and [Terms of Service](https://www.bigcommerce.com/terms/). - * */ + */ readonly videos?: readonly components["schemas"]["productVideo_Full"][]; }; /** metafield_Full */ @@ -2857,28 +2549,24 @@ export interface components { } & components["schemas"]["metafield_Base"] & { /** * @description The type of resource with which the metafield is associated. - * * @example product * @enum {string} */ readonly resource_type?: "category" | "brand" | "product" | "variant"; /** * @description The ID of the resource with which the metafield is associated. - * * @example 111 */ readonly resource_id?: number; /** * Format: date-time * @description Date and time of the metafieldʼs creation. Read-Only. - * * @example 2018-05-07T20:14:17+00:00 */ readonly date_created?: string; /** * Format: date-time * @description Date and time when the metafield was last updated. Read-Only. - * * @example 2018-05-07T20:14:17+00:00 */ readonly date_modified?: string; @@ -2927,14 +2615,11 @@ export interface components { }; }; }; - /** @description Error payload for the BigCommerce API. - * */ + /** @description Error payload for the BigCommerce API. */ readonly BaseError: { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; @@ -2953,8 +2638,7 @@ export interface components { readonly beta5ErrorResponse: components["schemas"]["BaseError"] & { readonly errors?: components["schemas"]["beta5DetailedErrors"]; }; - /** @description Common Metafield properties. - * */ + /** @description Common Metafield properties. */ readonly Metafield: { /** * @description Determines the visibility and writeability of the field by other API consumers. @@ -2965,44 +2649,37 @@ export interface components { * | `write` | Open for reading and writing by other API consumers. | * | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | * | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | - * * @enum {string} */ readonly permission_set: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; /** * @description Namespace for the metafield, for organizational purposes. - * * @example Sales Department */ readonly namespace: string; /** * @description The name of the field, for example: `location_id`, `color`. - * * @example Staff Name */ readonly key: string; /** * @description The value of the field, for example: `1`, `blue`. - * * @example Ronaldo */ readonly value: string; /** * @description Description for the metafields. - * * @example order */ readonly description: string; /** * @description The type of resource with which the metafield is associated. - * * @example cart * @enum {string} */ readonly resource_type: "brand" | "product" | "variant" | "category" | "cart" | "channel" | "location" | "order" | "customer"; /** * @description The unique identifier for the resource with which the metafield is associated. - * * @example 424242 */ readonly resource_id: number; @@ -3026,14 +2703,12 @@ export interface components { */ readonly owner_client_id?: string; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponse: { readonly data?: readonly components["schemas"]["Metafield"][]; readonly meta?: components["schemas"]["CollectionMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponse_POST_PUT: { readonly data?: readonly components["schemas"]["Metafield"][]; /** @@ -3043,31 +2718,32 @@ export interface components { readonly errors?: readonly unknown[]; readonly meta?: components["schemas"]["WriteCollectionSuccessMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponsePartialSuccess_POST_PUT: { readonly data?: readonly components["schemas"]["Metafield"][]; readonly errors?: readonly components["schemas"]["Error"][]; readonly meta?: components["schemas"]["WriteCollectionPartialSuccessMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponsePartialSuccess_DELETE: { - /** @example [ + /** + * @example [ * 123 - * ] */ + * ] + */ readonly data?: readonly number[]; readonly errors?: readonly components["schemas"]["Error"][]; readonly meta?: components["schemas"]["WriteCollectionPartialSuccessMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionDeleteResponseSuccess: { - /** @example [ + /** + * @example [ * 123, * 124, * 125 - * ] */ + * ] + */ readonly data?: readonly number[]; /** * @description Empty for 200 responses. @@ -3083,19 +2759,16 @@ export interface components { readonly WriteCollectionPartialSuccessMeta: { /** * @description Total number of items in the result set. - * * @example 3 */ readonly total?: number; /** * @description Total number of items that were successfully deleted. - * * @example 1 */ readonly success?: number; /** * @description Total number of items that failed to be deleted. - * * @example 2 */ readonly failed?: number; @@ -3107,59 +2780,49 @@ export interface components { readonly WriteCollectionSuccessMeta: { /** * @description Total number of items in the result set. - * * @example 3 */ readonly total?: number; /** * @description Total number of items that were successfully deleted. - * * @example 3 */ readonly success?: number; /** * @description Total number of items that failed to be deleted. - * * @example 0 */ readonly failed?: number; }; /** * @description Total number of items in the result set. - * * @example 3 */ readonly Total: number; /** * @description Total number of items that were successfully deleted. - * * @example 1 */ readonly Success: number; /** * @description Total number of items that failed to be deleted. - * * @example 2 */ readonly Failed: number; - /** @description Error response payload for the BigCommerce API. - * */ + /** @description Error response payload for the BigCommerce API. */ readonly Error: { /** * @description The HTTP status code for the error. - * * @example 422 */ readonly status?: number; /** * @description The error title. - * * @example Bulk operation has failed */ readonly title?: string; /** * @description The error type. - * * @example https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes */ readonly type?: string; @@ -3167,7 +2830,6 @@ export interface components { }; /** * @description Error detail response payload for the BigCommerce API. - * * @example { * "1": "Unauthorized to delete", * "2": "Metafield does not exist" @@ -3188,56 +2850,46 @@ export interface components { readonly pagination?: { /** * @description Total number of items in the result set. - * * @example 36 */ readonly total?: number; /** * @description Total number of items in the collection response. - * * @example 36 */ readonly count?: number; /** * @description The amount of items returned in the collection per page, controlled by the limit parameter. - * * @example 50 */ readonly per_page?: number; /** * @description The page you are currently on within the collection. - * * @example 1 */ readonly current_page?: number; /** * @description The total number of pages in the collection. - * * @example 1 */ readonly total_pages?: number; - /** @description Pagination links for the previous and next parts of the whole collection. - * */ + /** @description Pagination links for the previous and next parts of the whole collection. */ readonly links?: { - /** @description Link to the previous page returned in the response. - * */ + /** @description Link to the previous page returned in the response. */ readonly previous?: string; /** * @description Link to the current page returned in the response. - * * @example ?page=1&limit=50 */ readonly current?: string; - /** @description Link to the next page returned in the response. - * */ + /** @description Link to the next page returned in the response. */ readonly next?: string; }; }; } & { readonly [key: string]: unknown; }; - /** @description Common Metafield properties. - * */ + /** @description Common Metafield properties. */ readonly MetafieldBase_Post: { /** * @description Determines the visibility and writeability of the field by other API consumers. @@ -3248,37 +2900,31 @@ export interface components { * | `write` | Open for reading and writing by other API consumers. | * | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | * | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | - * * @enum {string} */ readonly permission_set: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; /** * @description Namespace for the metafield, for organizational purposes. - * * @example Sales Department */ readonly namespace: string; /** * @description The name of the field, for example: `location_id`, `color`. - * * @example Staff Name */ readonly key: string; /** * @description The value of the field, for example: `1`, `blue`. - * * @example Ronaldo */ readonly value: string; /** * @description Description for the metafields. - * * @example Name of Staff Member */ readonly description?: string; }; - /** @description Common Metafield properties. - * */ + /** @description Common Metafield properties. */ readonly MetafieldBase_Put: { /** * @description Determines the visibility and writeability of the field by other API consumers. @@ -3289,31 +2935,26 @@ export interface components { * | `write` | Open for reading and writing by other API consumers. | * | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | * | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | - * * @enum {string} */ readonly permission_set?: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; /** * @description Namespace for the metafield, for organizational purposes. - * * @example Sales Department */ readonly namespace?: string; /** * @description The name of the field, for example: `location_id`, `color`. - * * @example Staff Name */ readonly key?: string; /** * @description The value of the field, for example: `1`, `blue`. - * * @example Ronaldo */ readonly value?: string; /** * @description Description for the metafields. - * * @example Name of Staff Member */ readonly description?: string; @@ -3330,13 +2971,11 @@ export interface components { readonly id?: number; /** * @description The name of the field, shown on the storefront, orders, etc. This field is a requirement for /POST requests. - * * @example ISBN */ readonly name?: string; /** * @description The value of the field, shown on the storefront, orders, etc. This field is a requirement for /POST requests. - * * @example 1234567890123 */ readonly value?: string; @@ -3348,13 +2987,11 @@ export interface components { readonly customFieldPost: { /** * @description The name of the field, shown on the storefront, orders, etc. This field is a requirement for /POST requests. - * * @example ISBN */ readonly name: string; /** * @description The value of the field, shown on the storefront, orders, etc. This field is a requirement for /POST requests. - * * @example 1234567890123 */ readonly value: string; @@ -3366,13 +3003,11 @@ export interface components { readonly customFieldPut: { /** * @description The value of the field, shown on the storefront, orders, etc. This field is a requirement for /POST requests. - * * @example ISBN */ readonly name?: string; /** * @description The value of the field, shown on the storefront, orders, etc. This field is a requirement for /POST requests. - * * @example 1234567890123 */ readonly value?: string; @@ -3386,52 +3021,43 @@ export interface components { readonly pagination?: { /** * @description Total number of items in the result set. - * * @example 36 */ readonly total?: number; /** * @description Total number of items in the collection response. - * * @example 36 */ readonly count?: number; /** * @description The amount of items returned in the collection per page, controlled by the limit parameter. - * * @example 50 */ readonly per_page?: number; /** * @description The page you are currently on within the collection. - * * @example 2 */ readonly current_page?: number; /** * @description The total number of pages in the collection. - * * @example 3 */ readonly total_pages?: number; - /** @description Pagination links for the previous and next parts of the whole collection. - * */ + /** @description Pagination links for the previous and next parts of the whole collection. */ readonly links?: { /** * @description Link to the previous page returned in the response. - * * @example ?page=1&limit=50 */ readonly previous?: string; /** * @description Link to the current page returned in the response. - * * @example ?page=2&limit=50 */ readonly current?: string; /** * @description Link to the next page returned in the response. - * * @example ?page=3&limit=50 */ readonly next?: string; @@ -3556,36 +3182,30 @@ export interface components { }; }; parameters: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly ProductIdParam: number; - /** @description The ID of the `review` that is being operated on. - * */ + /** @description The ID of the `review` that is being operated on. */ readonly ReviewIdParam: number; - /** @description The ID of the `Image` that is being operated on. - * */ + /** @description The ID of the `Image` that is being operated on. */ readonly ImageIdParam: number; - /** @description The ID of the `Metafield`. - * */ + /** @description The ID of the `Metafield`. */ readonly MetafieldIdParam: number; /** @description The BigCommerce ID of the `Video` */ readonly VideoIdParam: number; - /** @description The ID of the `ComplexRule`. - * */ + /** @description The ID of the `ComplexRule`. */ readonly ComplexRuleIdParam: number; - /** @description The ID of the `CustomField`. - * */ + /** @description The ID of the `CustomField`. */ readonly CustomFieldIdParam: number; - /** @description The ID of the `BulkPricingRule`. - * */ + /** @description The ID of the `BulkPricingRule`. */ readonly BulkPricingRuleIdParam: number; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept: string; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly ContentType: string; - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly PageParam: number; + /** @description A comma-separated list of entity ID values that filter results to metafields that belong to one of the matching entities. */ + readonly MetafieldResourceParam: string; /** @description Filter based on a metafieldʼs key. */ readonly MetafieldKeyParam: string; /** @description Filter based on comma-separated metafieldʼs keys. Could be used with vanilla `key` query parameter. */ @@ -3594,26 +3214,19 @@ export interface components { readonly MetafieldNamespaceParam: string; /** @description Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. */ readonly MetafieldNamespaceInParam: readonly string[]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly LimitParam: number; - /** @description 'Query parameter that lets you filter by the minimum date created, ffor example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.' - * */ + /** @description 'Query parameter that lets you filter by the minimum date created, ffor example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.' */ readonly date_created_min: string; - /** @description 'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.' - * */ + /** @description 'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.' */ readonly date_created_max: string; - /** @description 'Query parameter that lets you filter by the maximum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.' - * */ + /** @description 'Query parameter that lets you filter by the maximum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.' */ readonly date_modified_max: string; - /** @description 'Query parameter that lets you filter by the minimum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.' - * */ + /** @description 'Query parameter that lets you filter by the minimum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.' */ readonly date_modified_min: string; - /** @description Sort direction. Acceptable values are: `asc`, `desc`. - * */ + /** @description Sort direction. Acceptable values are: `asc`, `desc`. */ readonly DirectionParam: "asc" | "desc"; - /** @description Field name to sort by. Note: Since ID increments when new products are added, you can use the ID value to sort by product create date. - * */ + /** @description Field name to sort by. Note: Since ID increments when new products are added, you can use the ID value to sort by product create date. */ readonly SortParam: "id" | "name" | "sku" | "price" | "date_modified" | "date_last_imported" | "inventory_level" | "is_visible" | "total_sold" | "calculated_price"; /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */ readonly IncludeFieldsBulkPricingParam: readonly ("quantity_min" | "quantity_max" | "type" | "amount")[]; @@ -3637,8 +3250,14 @@ export interface components { readonly CategoriesInParam: readonly number[]; /** @description Pass a comma-separated list to filter by one or more channel IDs. */ readonly ChannelIdInParam: readonly 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. */ + /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */ + readonly CustomFieldsIncludeFieldsParam: readonly ("name" | "value")[]; + /** @description Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded. */ + readonly CustomFieldsExcludeFieldsParam: readonly ("name" | "value")[]; + /** + * @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. + */ readonly IncludeParamGetProducts: components["schemas"]["IncludeParamBase"]; /** @description A comma-separated list of sub-resources to return with a product object. */ readonly IncludeParamGetProduct: components["schemas"]["IncludeParamBase"]; @@ -3646,26 +3265,19 @@ export interface components { readonly IdMaxParam: number; readonly IdGreaterParam: number; readonly IdLessParam: number; - /** @description Filter items by name. - * */ + /** @description Filter items by name. */ readonly NameParam: string; - /** @description Filter items by Manufacturer Part Number (MPN). - * */ + /** @description Filter items by Manufacturer Part Number (MPN). */ readonly MpnParam: string; - /** @description Filter items by UPC. - * */ + /** @description Filter items by UPC. */ readonly UpcParam: string; - /** @description Filter items by price. - * */ + /** @description Filter items by price. */ readonly PriceParam: number; - /** @description Filter items by weight. - * */ + /** @description Filter items by weight. */ readonly WeightParam: number; - /** @description Filter items by condition. - * */ + /** @description Filter items by condition. */ readonly ConditionParam: "new" | "used" | "refurbished"; - /** @description Filter items by brand ID. - * */ + /** @description Filter items by brand ID. */ readonly BrandIdParam: number; /** * @description Filter items by `date_modified`. @@ -3705,8 +3317,7 @@ export interface components { readonly IsFeaturedParam: 1 | 0; /** @description Filter items by is_free_shipping. `1` for true, `0` for false. */ readonly IsFreeShippingParam: number; - /** @description Filter items by inventory_level. - * */ + /** @description Filter items by inventory_level. */ readonly InventoryLevelParam: number; /** @description A comma-separated list of inventory levels. Returns a list of all products that have any of the listed inventory amounts. */ readonly InventoryLevelInParam: readonly number[]; @@ -3716,28 +3327,26 @@ export interface components { readonly InventoryLevelMaxParam: number; readonly InventoryLevelGreaterParam: number; readonly InventoryLevelLessParam: number; - /** @description Filter items by inventory_low. Values: 1, 0. - * */ + /** @description Filter items by inventory_low. Values: 1, 0. */ readonly InventoryLowParam: number; - /** @description Filter items by out_of_stock. To enable the filter, pass `out_of_stock`=`1`. - * */ + /** @description Filter items by out_of_stock. To enable the filter, pass `out_of_stock`=`1`. */ readonly OutOfStockParam: number; - /** @description Filter items by total_sold. - * */ + /** @description Filter items by total_sold. */ readonly TotalSoldParam: number; /** @description Filter items by type. */ readonly ProductTypeParam: "digital" | "physical"; - /** @description Filter items by categories. - * If a product is in more than one category, using this query will not return the product. Instead use `categories:in=12`. */ + /** + * @description Filter items by categories. + * If a product is in more than one category, using this query will not return the product. Instead use `categories:in=12`. + */ readonly CategoriesParam: number; /** @description Filter items by keywords found in the `name`, `description`, or `sku` fields, or in the brand name. */ readonly KeywordParam: string; /** @description Set context used by the search algorithm to return results targeted towards the specified group. Use `merchant` to help merchants search their own catalog. Use `shopper` to return shopper-facing search results. */ readonly KeywordContextParam: "shopper" | "merchant"; - /** @description Filter items by availability. Values are: available, disabled, preorder. - * */ + /** @description Filter items by availability. Values are: available, disabled, preorder. */ readonly AvailabilityParam: "available" | "disabled" | "preorder"; - /** @description Filter items by main SKU. To filter by variant SKU, see [Get all variants](/docs/rest-catalog/product-variants#get-all-product-variants). */ + /** @description Filter items by main SKU. To filter by variant SKU, see [Get all variants](/docs/rest-catalog/product-variants#get-all-product-variants). */ readonly SkuParam: string; /** @description A comma-separated list of SKUs. Returns a list of products with those SKUs. */ readonly SkuInParam: readonly string[]; @@ -3751,8 +3360,7 @@ export interface operations { readonly getProducts: { readonly parameters: { readonly query?: { - /** @description Filter items by product ID. - * */ + /** @description Filter items by product ID. */ readonly id?: number; /** @description Pass a comma-separated list to filter by one or more product IDs. */ readonly "id:in"?: components["parameters"]["IdInParam"]; @@ -3760,24 +3368,22 @@ export interface operations { readonly "channel_id:in"?: components["parameters"]["ChannelIdInParam"]; /** @description Pass a comma-separated list to exclude one or more product IDs. */ readonly "id:not_in"?: components["parameters"]["IdNotInParam"]; - /** @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. */ + /** + * @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. + */ readonly include?: components["parameters"]["IncludeParamGetProducts"]; /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */ readonly include_fields?: components["parameters"]["IncludeFieldsParam"]; /** @description Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded. */ readonly exclude_fields?: components["parameters"]["ExcludeFieldsParam"]; - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; - /** @description Sort direction. Acceptable values are: `asc`, `desc`. - * */ + /** @description Sort direction. Acceptable values are: `asc`, `desc`. */ readonly direction?: components["parameters"]["DirectionParam"]; - /** @description Field name to sort by. Note: Since ID increments when new products are added, you can use the ID value to sort by product create date. - * */ + /** @description Field name to sort by. Note: Since ID increments when new products are added, you can use the ID value to sort by product create date. */ readonly sort?: components["parameters"]["SortParam"]; /** @description A comma-separated list of category IDs. Returns a list of products that are in all the categories specified. */ readonly "categories:in"?: components["parameters"]["CategoriesInParam"]; @@ -3785,26 +3391,19 @@ export interface operations { readonly "id:max"?: components["parameters"]["IdMaxParam"]; readonly "id:greater"?: components["parameters"]["IdGreaterParam"]; readonly "id:less"?: components["parameters"]["IdLessParam"]; - /** @description Filter items by name. - * */ + /** @description Filter items by name. */ readonly name?: components["parameters"]["NameParam"]; - /** @description Filter items by Manufacturer Part Number (MPN). - * */ + /** @description Filter items by Manufacturer Part Number (MPN). */ readonly mpn?: components["parameters"]["MpnParam"]; - /** @description Filter items by UPC. - * */ + /** @description Filter items by UPC. */ readonly upc?: components["parameters"]["UpcParam"]; - /** @description Filter items by price. - * */ + /** @description Filter items by price. */ readonly price?: components["parameters"]["PriceParam"]; - /** @description Filter items by weight. - * */ + /** @description Filter items by weight. */ readonly weight?: components["parameters"]["WeightParam"]; - /** @description Filter items by condition. - * */ + /** @description Filter items by condition. */ readonly condition?: components["parameters"]["ConditionParam"]; - /** @description Filter items by brand ID. - * */ + /** @description Filter items by brand ID. */ readonly brand_id?: components["parameters"]["BrandIdParam"]; /** * @description Filter items by `date_modified`. @@ -3844,8 +3443,7 @@ export interface operations { readonly is_featured?: components["parameters"]["IsFeaturedParam"]; /** @description Filter items by is_free_shipping. `1` for true, `0` for false. */ readonly is_free_shipping?: components["parameters"]["IsFreeShippingParam"]; - /** @description Filter items by inventory_level. - * */ + /** @description Filter items by inventory_level. */ readonly inventory_level?: components["parameters"]["InventoryLevelParam"]; /** @description A comma-separated list of inventory levels. Returns a list of all products that have any of the listed inventory amounts. */ readonly "inventory_level:in"?: components["parameters"]["InventoryLevelInParam"]; @@ -3855,28 +3453,26 @@ export interface operations { readonly "inventory_level:max"?: components["parameters"]["InventoryLevelMaxParam"]; readonly "inventory_level:greater"?: components["parameters"]["InventoryLevelGreaterParam"]; readonly "inventory_level:less"?: components["parameters"]["InventoryLevelLessParam"]; - /** @description Filter items by inventory_low. Values: 1, 0. - * */ + /** @description Filter items by inventory_low. Values: 1, 0. */ readonly inventory_low?: components["parameters"]["InventoryLowParam"]; - /** @description Filter items by out_of_stock. To enable the filter, pass `out_of_stock`=`1`. - * */ + /** @description Filter items by out_of_stock. To enable the filter, pass `out_of_stock`=`1`. */ readonly out_of_stock?: components["parameters"]["OutOfStockParam"]; - /** @description Filter items by total_sold. - * */ + /** @description Filter items by total_sold. */ readonly total_sold?: components["parameters"]["TotalSoldParam"]; /** @description Filter items by type. */ readonly type?: components["parameters"]["ProductTypeParam"]; - /** @description Filter items by categories. - * If a product is in more than one category, using this query will not return the product. Instead use `categories:in=12`. */ + /** + * @description Filter items by categories. + * If a product is in more than one category, using this query will not return the product. Instead use `categories:in=12`. + */ readonly categories?: components["parameters"]["CategoriesParam"]; /** @description Filter items by keywords found in the `name`, `description`, or `sku` fields, or in the brand name. */ readonly keyword?: components["parameters"]["KeywordParam"]; /** @description Set context used by the search algorithm to return results targeted towards the specified group. Use `merchant` to help merchants search their own catalog. Use `shopper` to return shopper-facing search results. */ readonly keyword_context?: components["parameters"]["KeywordContextParam"]; - /** @description Filter items by availability. Values are: available, disabled, preorder. - * */ + /** @description Filter items by availability. Values are: available, disabled, preorder. */ readonly availability?: components["parameters"]["AvailabilityParam"]; - /** @description Filter items by main SKU. To filter by variant SKU, see [Get all variants](/docs/rest-catalog/product-variants#get-all-product-variants). */ + /** @description Filter items by main SKU. To filter by variant SKU, see [Get all variants](/docs/rest-catalog/product-variants#get-all-product-variants). */ readonly sku?: components["parameters"]["SkuParam"]; /** @description A comma-separated list of SKUs. Returns a list of products with those SKUs. */ readonly "sku:in"?: components["parameters"]["SkuInParam"]; @@ -3923,7 +3519,8 @@ export interface operations { }; readonly requestBody?: { readonly content: { - /** @example [ + /** + * @example [ * { * "id": 0, * "name": "Smith Journal 13", @@ -4027,7 +3624,8 @@ export interface operations { * } * ] * } - * ] */ + * ] + */ readonly "application/json": components["schemas"]["product_Put_Collection"]; }; }; @@ -4037,7 +3635,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "id": 0, * "name": "Smith Journal 13", * "type": "physical", @@ -4143,20 +3742,23 @@ export interface operations { * "date_modified": "2019-08-24T14:15:22Z" * } * ] - * } */ + * } + */ readonly "application/json": { readonly data?: readonly components["schemas"]["product_Full"][]; readonly meta?: unknown; }; }; }; - /** @description Multi-status. Typically indicates that a partial failure has occurred, such as when a POST or PUT request is successful, but saving one of the attributes has failed. + /** + * @description Multi-status. Typically indicates that a partial failure has occurred, such as when a POST or PUT request is successful, but saving one of the attributes has failed. * * For example, the product information was updated successfully, but the inventory data failed to update or saving the URL failed. * * If inventory data failed to update, verify that the inventory-related updates are well-formed and correct; for example, that they donʼt result in negative stock levels. Then consider updating the inventory data again. * - * If the URL failed to update, check that the URL uses Latin letters, is no more than 255 characters, and is not taken by any other entity. */ + * If the URL failed to update, check that the URL uses Latin letters, is no more than 255 characters, and is not taken by any other entity. + */ readonly 207: { headers: { readonly [name: string]: unknown; @@ -4176,8 +3778,7 @@ export interface operations { }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -4201,12 +3802,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "errors": {}, * "status": 413, * "title": "The request payload is too large. The maximum items allowed in the array is 10.", * "type": "/api-docs/getting-started/api-status-codes" - * } */ + * } + */ readonly "application/json": components["schemas"]["error_Base"]; }; }; @@ -4247,7 +3850,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "id": 0, * "name": "Smith Journal 13", * "type": "physical", @@ -4353,20 +3957,23 @@ export interface operations { * "date_modified": "2019-08-24T14:15:22Z" * } * ] - * } */ + * } + */ readonly "application/json": { readonly data?: components["schemas"]["product_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; }; }; }; - /** @description Multi-status. Typically indicates that a partial failure has occurred, such as when a POST or PUT request is successful, but saving one of the attributes has failed. + /** + * @description Multi-status. Typically indicates that a partial failure has occurred, such as when a POST or PUT request is successful, but saving one of the attributes has failed. * * For example, the product information was updated successfully, but the inventory data failed to update or saving the URL failed. * * If inventory data failed to update, verify that the inventory-related updates are well-formed and correct; for example, that they donʼt result in negative stock levels. Then consider updating the inventory data again. * - * If the URL failed to update, check that the URL uses Latin letters, is no more than 255 characters, and is not taken by any other entity. */ + * If the URL failed to update, check that the URL uses Latin letters, is no more than 255 characters, and is not taken by any other entity. + */ readonly 207: { headers: { readonly [name: string]: unknown; @@ -4379,8 +3986,7 @@ export interface operations { }; }; }; - /** @description `Product` conflicted with another product. This is the result of duplicate unique values, such as name or SKU; a missing or invalid `category_id`, `brand_id`, or `tax_class id`; or a conflicting `bulk_pricing_rule` or `custom_url`. - * */ + /** @description `Product` conflicted with another product. This is the result of duplicate unique values, such as name or SKU; a missing or invalid `category_id`, `brand_id`, or `tax_class id`; or a conflicting `bulk_pricing_rule` or `custom_url`. */ readonly 409: { headers: { readonly [name: string]: unknown; @@ -4392,18 +3998,15 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; }; }; - /** @description `Product` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description `Product` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -4415,11 +4018,9 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -4430,22 +4031,17 @@ export interface operations { readonly deleteProducts: { readonly parameters: { readonly query?: { - /** @description Filter items by name. - * */ + /** @description Filter items by name. */ readonly name?: components["parameters"]["NameParam"]; - /** @description Filter items by main SKU. To filter by variant SKU, see [Get all variants](/docs/rest-catalog/product-variants#get-all-product-variants). */ + /** @description Filter items by main SKU. To filter by variant SKU, see [Get all variants](/docs/rest-catalog/product-variants#get-all-product-variants). */ readonly sku?: components["parameters"]["SkuParam"]; - /** @description Filter items by price. - * */ + /** @description Filter items by price. */ readonly price?: components["parameters"]["PriceParam"]; - /** @description Filter items by weight. - * */ + /** @description Filter items by weight. */ readonly weight?: components["parameters"]["WeightParam"]; - /** @description Filter items by condition. - * */ + /** @description Filter items by condition. */ readonly condition?: components["parameters"]["ConditionParam"]; - /** @description Filter items by brand ID. - * */ + /** @description Filter items by brand ID. */ readonly brand_id?: components["parameters"]["BrandIdParam"]; /** * @description Filter items by `date_modified`. @@ -4466,16 +4062,16 @@ export interface operations { readonly is_featured?: components["parameters"]["IsFeaturedParam"]; /** @description Pass a comma-separated list to filter by one or more product IDs. */ readonly "id:in"?: components["parameters"]["IdInParam"]; - /** @description Filter items by inventory_level. - * */ + /** @description Filter items by inventory_level. */ readonly inventory_level?: components["parameters"]["InventoryLevelParam"]; - /** @description Filter items by total_sold. - * */ + /** @description Filter items by total_sold. */ readonly total_sold?: components["parameters"]["TotalSoldParam"]; /** @description Filter items by type. */ readonly type?: components["parameters"]["ProductTypeParam"]; - /** @description Filter items by categories. - * If a product is in more than one category, using this query will not return the product. Instead use `categories:in=12`. */ + /** + * @description Filter items by categories. + * If a product is in more than one category, using this query will not return the product. Instead use `categories:in=12`. + */ readonly categories?: components["parameters"]["CategoriesParam"]; /** @description Filter items by keywords found in the `name`, `description`, or `sku` fields, or in the brand name. */ readonly keyword?: components["parameters"]["KeywordParam"]; @@ -4512,8 +4108,7 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; }; readonly cookie?: never; @@ -4525,7 +4120,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 174, * "name": "1L Le Parfait Jar", @@ -4604,7 +4200,8 @@ export interface operations { * "open_graph_use_image": true * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: components["schemas"]["product_Full"] & { /** @description The channels to which the product is assigned. This field only appears in the response if you include `channels` in the `include` query parameter. */ @@ -4614,16 +4211,14 @@ export interface operations { }; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -4637,8 +4232,10 @@ export interface operations { readonly updateProduct: { readonly parameters: { readonly query?: { - /** @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. */ + /** + * @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. + */ readonly include?: components["parameters"]["IncludeParamGetProducts"]; /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */ readonly include_fields?: components["parameters"]["IncludeFieldsParam"]; @@ -4650,8 +4247,7 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; }; readonly cookie?: never; @@ -4671,7 +4267,8 @@ export interface operations { readonly data?: components["schemas"]["product_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; }; - /** @example { + /** + * @example { * "name": "Smith Journal 13", * "type": "physical", * "sku": "SM-13", @@ -4944,17 +4541,20 @@ export interface operations { * } * ], * "meta": {} - * } */ + * } + */ readonly "example-1": unknown; }; }; - /** @description Multi-status. Typically indicates that a partial failure has occurred, such as when a POST or PUT request is successful, but saving one of the attributes has failed. + /** + * @description Multi-status. Typically indicates that a partial failure has occurred, such as when a POST or PUT request is successful, but saving one of the attributes has failed. * * For example, the product information was updated successfully, but the inventory data failed to update or saving the URL failed. * * If inventory data failed to update, verify that the inventory-related updates are well-formed and correct; for example, that they donʼt result in negative stock levels. Then consider updating the inventory data again. * - * If the URL failed to update, check that the URL uses Latin letters, is no more than 255 characters, and is not taken by any other entity. */ + * If the URL failed to update, check that the URL uses Latin letters, is no more than 255 characters, and is not taken by any other entity. + */ readonly 207: { headers: { readonly [name: string]: unknown; @@ -4967,16 +4567,14 @@ export interface operations { }; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -4985,8 +4583,7 @@ export interface operations { }; }; }; - /** @description `Product` was in conflict with another product. This is caused by: duplicate unique values, such as name or SKU; a missing category, brand, or tax_class with which the product is being associated; or a conflicting bulk pricing rule. - * */ + /** @description `Product` was in conflict with another product. This is caused by: duplicate unique values, such as name or SKU; a missing category, brand, or tax_class with which the product is being associated; or a conflicting bulk pricing rule. */ readonly 409: { headers: { readonly [name: string]: unknown; @@ -4998,18 +4595,15 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; }; }; - /** @description `Product` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description `Product` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -5021,11 +4615,9 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -5041,8 +4633,7 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; }; readonly cookie?: never; @@ -5060,11 +4651,9 @@ export interface operations { readonly getProductImages: { readonly parameters: { readonly query?: { - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */ readonly include_fields?: components["parameters"]["IncludeFieldsParam"]; @@ -5076,8 +4665,7 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; }; readonly cookie?: never; @@ -5089,7 +4677,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": [ * { * "id": 382, @@ -5130,31 +4719,29 @@ export interface operations { * } * } * } - * } */ + * } + */ readonly "application/json": { readonly data?: readonly components["schemas"]["productImage_Full"][]; readonly meta?: components["schemas"]["metaCollection_Full"]; }; }; }; - /** @description There are not any images on this product. - * */ + /** @description There are not any images on this product. */ readonly 204: { headers: { readonly [name: string]: unknown; }; content?: never; }; - /** @description The product ID does not exist. - * */ + /** @description The product ID does not exist. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -5173,8 +4760,7 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; }; readonly cookie?: never; @@ -5183,28 +4769,24 @@ export interface operations { readonly content: { readonly "application/json": components["schemas"]["productImage_Post_Put"]; readonly "multipart/form-data": { - /** @description The unique numeric identifier for the product with which the image is associated. - * */ + /** @description The unique numeric identifier for the product with which the image is associated. */ readonly product_id?: number; /** * Format: date-time * @description The date on which the product image was modified. - * */ readonly date_modified?: string; - /** @description Flag for identifying whether the image is used as the productʼs thumbnail. - * */ + /** @description Flag for identifying whether the image is used as the productʼs thumbnail. */ readonly is_thumbnail?: boolean; - /** @description The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a `sort_order` the same as or greater than the imageʼs new `sort_order` value will have their `sort_order`s reordered. - * */ + /** @description The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a `sort_order` the same as or greater than the imageʼs new `sort_order` value will have their `sort_order`s reordered. */ readonly sort_order?: number; - /** @description The description for the image. - * */ + /** @description The description for the image. */ readonly description?: string; - /** @description The local path to the original image file uploaded to BigCommerce. Use image_url when creating a product. + /** + * @description The local path to the original image file uploaded to BigCommerce. Use image_url when creating a product. * * Must be sent as a `multipart/form-data` field in the request body. Limit of 8 MB per file. Cannot be used with `image_url`. - * */ + */ readonly image_file?: string; }; }; @@ -5219,80 +4801,61 @@ export interface operations { readonly "application/json": { /** Product Image */ readonly data?: { - /** @description The unique numeric ID of the image; increments sequentially. - * */ + /** @description The unique numeric ID of the image; increments sequentially. */ readonly id?: number; - /** @description The unique numeric identifier for the product with which the image is associated. - * */ + /** @description The unique numeric identifier for the product with which the image is associated. */ readonly product_id?: number; - /** @description The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled. You should provide an image smaller than 1280x1280; otherwise, the API returns a resized image. - * */ + /** @description The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled. You should provide an image smaller than 1280x1280; otherwise, the API returns a resized image. */ readonly url_zoom?: string; - /** @description The standard URL for this image. By default, this is used for product-page images. - * */ + /** @description The standard URL for this image. By default, this is used for product-page images. */ readonly url_standard?: string; - /** @description The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels. - * */ + /** @description The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels. */ readonly url_thumbnail?: string; - /** @description The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page. - * */ + /** @description The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page. */ readonly url_tiny?: string; /** * Format: date-time * @description The date on which the product image was modified. - * */ readonly date_modified?: string; - /** @description Flag for identifying whether the image is used as the productʼs thumbnail. - * */ + /** @description Flag for identifying whether the image is used as the productʼs thumbnail. */ readonly is_thumbnail?: boolean; - /** @description The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a `sort_order` the same as or greater than the imageʼs new `sort_order` value will have their `sort_order`s reordered. - * */ + /** @description The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a `sort_order` the same as or greater than the imageʼs new `sort_order` value will have their `sort_order`s reordered. */ readonly sort_order?: number; - /** @description The description for the image. - * */ + /** @description The description for the image. */ readonly description?: string; - /** @description Must be a fully qualified URL path, including protocol. Limit of 8MB per file. - * */ + /** @description Must be a fully qualified URL path, including protocol. Limit of 8MB per file. */ readonly image_url?: string; } | { - /** @description The unique numeric ID of the image; increments sequentially. - * */ + /** @description The unique numeric ID of the image; increments sequentially. */ readonly id?: number; - /** @description The unique numeric identifier for the product with which the image is associated. - * */ + /** @description The unique numeric identifier for the product with which the image is associated. */ readonly product_id?: number; - /** @description The local path to the original image file uploaded to BigCommerce. Use image_url when creating a product. + /** + * @description The local path to the original image file uploaded to BigCommerce. Use image_url when creating a product. * A `multipart/form-data` media type. * - * Must be sent as a multipart/form-data field in the request body. Limit of 8 MB per file. */ + * Must be sent as a multipart/form-data field in the request body. Limit of 8 MB per file. + */ readonly image_file?: string; - /** @description The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled. You should provide an image smaller than 1280x1280; otherwise, the API returns a resized image. - * */ + /** @description The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled. You should provide an image smaller than 1280x1280; otherwise, the API returns a resized image. */ readonly url_zoom?: string; - /** @description The standard URL for this image. By default, this is used for product-page images. - * */ + /** @description The standard URL for this image. By default, this is used for product-page images. */ readonly url_standard?: string; - /** @description The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels. - * */ + /** @description The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels. */ readonly url_thumbnail?: string; - /** @description The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page. - * */ + /** @description The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page. */ readonly url_tiny?: string; /** * Format: date-time * @description The date on which the product image was modified. - * */ readonly date_modified?: string; - /** @description Flag for identifying whether the image is used as the productʼs thumbnail. - * */ + /** @description Flag for identifying whether the image is used as the productʼs thumbnail. */ readonly is_thumbnail?: boolean; - /** @description The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a `sort_order` the same as or greater than the imageʼs new `sort_order` value will have their `sort_order`s reordered. - * */ + /** @description The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a `sort_order` the same as or greater than the imageʼs new `sort_order` value will have their `sort_order`s reordered. */ readonly sort_order?: number; - /** @description The description for the image. - * */ + /** @description The description for the image. */ readonly description?: string; }; readonly meta?: components["schemas"]["metaEmpty_Full"]; @@ -5308,16 +4871,14 @@ export interface operations { readonly "application/json": Record; }; }; - /** @description The product ID does not exist. - * */ + /** @description The product ID does not exist. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -5326,19 +4887,23 @@ export interface operations { }; }; }; - /** @description Unprocessable Entity. + /** + * @description Unprocessable Entity. * - * May occur if the `Content-Type` header is set to `multipart/form-data` rather than `application/json` when creating a product image using `image_url`. */ + * May occur if the `Content-Type` header is set to `multipart/form-data` rather than `application/json` when creating a product image using `image_url`. + */ readonly 422: { headers: { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 422, * "title": "image_url must be present if uploading by url", * "type": "/api-docs/getting-started/api-status-codes" - * } */ + * } + */ readonly "application/json": { readonly status: number; readonly title: string; @@ -5361,11 +4926,9 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `Image` that is being operated on. - * */ + /** @description The ID of the `Image` that is being operated on. */ readonly image_id: components["parameters"]["ImageIdParam"]; }; readonly cookie?: never; @@ -5377,7 +4940,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 485, * "product_id": 158, @@ -5392,23 +4956,22 @@ export interface operations { * "date_modified": "2018-09-13T15:57:07+00:00" * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: components["schemas"]["productImage_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; }; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -5429,11 +4992,9 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `Image` that is being operated on. - * */ + /** @description The ID of the `Image` that is being operated on. */ readonly image_id: components["parameters"]["ImageIdParam"]; }; readonly cookie?: never; @@ -5442,28 +5003,24 @@ export interface operations { readonly content: { readonly "application/json": components["schemas"]["productImage_Post_Put"]; readonly "multipart/form-data": { - /** @description The unique numeric identifier for the product with which the image is associated. - * */ + /** @description The unique numeric identifier for the product with which the image is associated. */ readonly product_id?: number; /** * Format: date-time * @description The date on which the product image was modified. - * */ readonly date_modified?: string; - /** @description Flag for identifying whether the image is used as the productʼs thumbnail. - * */ + /** @description Flag for identifying whether the image is used as the productʼs thumbnail. */ readonly is_thumbnail?: boolean; - /** @description The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a `sort_order` the same as or greater than the imageʼs new `sort_order` value will have their `sort_order`s reordered. - * */ + /** @description The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a `sort_order` the same as or greater than the imageʼs new `sort_order` value will have their `sort_order`s reordered. */ readonly sort_order?: number; - /** @description The description for the image. - * */ + /** @description The description for the image. */ readonly description?: string; - /** @description The local path to the original image file uploaded to BigCommerce. Use image_url when creating a product. + /** + * @description The local path to the original image file uploaded to BigCommerce. Use image_url when creating a product. * * Must be sent as a `multipart/form-data` field in the request body. Limit of 8 MB per file. Cannot be used with `image_url`. - * */ + */ readonly image_file?: string; }; }; @@ -5478,80 +5035,61 @@ export interface operations { readonly "application/json": { /** Product Image */ readonly data?: { - /** @description The unique numeric ID of the image; increments sequentially. - * */ + /** @description The unique numeric ID of the image; increments sequentially. */ readonly id?: number; - /** @description The unique numeric identifier for the product with which the image is associated. - * */ + /** @description The unique numeric identifier for the product with which the image is associated. */ readonly product_id?: number; - /** @description The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled. You should provide an image smaller than 1280x1280; otherwise, the API returns a resized image. - * */ + /** @description The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled. You should provide an image smaller than 1280x1280; otherwise, the API returns a resized image. */ readonly url_zoom?: string; - /** @description The standard URL for this image. By default, this is used for product-page images. - * */ + /** @description The standard URL for this image. By default, this is used for product-page images. */ readonly url_standard?: string; - /** @description The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels. - * */ + /** @description The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels. */ readonly url_thumbnail?: string; - /** @description The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page. - * */ + /** @description The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page. */ readonly url_tiny?: string; /** * Format: date-time * @description The date on which the product image was modified. - * */ readonly date_modified?: string; - /** @description Flag for identifying whether the image is used as the productʼs thumbnail. - * */ + /** @description Flag for identifying whether the image is used as the productʼs thumbnail. */ readonly is_thumbnail?: boolean; - /** @description The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a `sort_order` the same as or greater than the imageʼs new `sort_order` value will have their `sort_order`s reordered. - * */ + /** @description The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a `sort_order` the same as or greater than the imageʼs new `sort_order` value will have their `sort_order`s reordered. */ readonly sort_order?: number; - /** @description The description for the image. - * */ + /** @description The description for the image. */ readonly description?: string; - /** @description Must be a fully qualified URL path, including protocol. Limit of 8MB per file. - * */ + /** @description Must be a fully qualified URL path, including protocol. Limit of 8MB per file. */ readonly image_url?: string; } | { - /** @description The unique numeric ID of the image; increments sequentially. - * */ + /** @description The unique numeric ID of the image; increments sequentially. */ readonly id?: number; - /** @description The unique numeric identifier for the product with which the image is associated. - * */ + /** @description The unique numeric identifier for the product with which the image is associated. */ readonly product_id?: number; - /** @description The local path to the original image file uploaded to BigCommerce. Use image_url when creating a product. + /** + * @description The local path to the original image file uploaded to BigCommerce. Use image_url when creating a product. * A `multipart/form-data` media type. * - * Must be sent as a multipart/form-data field in the request body. Limit of 8 MB per file. */ + * Must be sent as a multipart/form-data field in the request body. Limit of 8 MB per file. + */ readonly image_file?: string; - /** @description The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled. You should provide an image smaller than 1280x1280; otherwise, the API returns a resized image. - * */ + /** @description The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled. You should provide an image smaller than 1280x1280; otherwise, the API returns a resized image. */ readonly url_zoom?: string; - /** @description The standard URL for this image. By default, this is used for product-page images. - * */ + /** @description The standard URL for this image. By default, this is used for product-page images. */ readonly url_standard?: string; - /** @description The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels. - * */ + /** @description The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels. */ readonly url_thumbnail?: string; - /** @description The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page. - * */ + /** @description The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page. */ readonly url_tiny?: string; /** * Format: date-time * @description The date on which the product image was modified. - * */ readonly date_modified?: string; - /** @description Flag for identifying whether the image is used as the productʼs thumbnail. - * */ + /** @description Flag for identifying whether the image is used as the productʼs thumbnail. */ readonly is_thumbnail?: boolean; - /** @description The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a `sort_order` the same as or greater than the imageʼs new `sort_order` value will have their `sort_order`s reordered. - * */ + /** @description The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a `sort_order` the same as or greater than the imageʼs new `sort_order` value will have their `sort_order`s reordered. */ readonly sort_order?: number; - /** @description The description for the image. - * */ + /** @description The description for the image. */ readonly description?: string; }; readonly meta?: components["schemas"]["metaEmpty_Full"]; @@ -5567,16 +5105,14 @@ export interface operations { readonly "application/json": Record; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -5604,11 +5140,9 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `Image` that is being operated on. - * */ + /** @description The ID of the `Image` that is being operated on. */ readonly image_id: components["parameters"]["ImageIdParam"]; }; readonly cookie?: never; @@ -5630,11 +5164,9 @@ export interface operations { readonly include_fields?: components["parameters"]["IncludeFieldsParam"]; /** @description Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded. */ readonly exclude_fields?: components["parameters"]["ExcludeFieldsParam"]; - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; }; readonly header?: { @@ -5642,8 +5174,7 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; }; readonly cookie?: never; @@ -5655,7 +5186,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": [ * { * "id": 6, @@ -5700,7 +5232,8 @@ export interface operations { * } * } * } - * } */ + * } + */ readonly "application/json": { readonly data?: readonly components["schemas"]["productVideo_Full"][]; readonly meta?: components["schemas"]["metaCollection_Full"]; @@ -5719,8 +5252,7 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; }; readonly cookie?: never; @@ -5730,32 +5262,27 @@ export interface operations { readonly "application/json": { /** * @description The title for the video. If left blank, this will be filled in according to data on a host site. - * * @example Writing Great Documentation */ readonly title?: string; /** * @description The description for the video. If left blank, this will be filled in according to data on a host site. - * * @example A video about documenation */ readonly description?: string; /** * @description The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a `sort_order` the same as or greater than the videoʼs new `sort_order` value will have their `sort_order`s reordered. - * * @example 1 */ readonly sort_order?: number; /** * @description The video type (a short name of a host site). - * * @enum {string} */ readonly type?: "youtube"; } & { /** * @description The ID of the video on a host site. - * * @example z3fRu9pkuXE */ readonly video_id?: string; @@ -5768,63 +5295,54 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "title": "Your Video", * "description": "Company Values", * "sort_order": 1, * "type": "youtube", * "video_id": "123345AA" - * } */ + * } + */ readonly "application/json": { /** * Product Video * @description A product video model. - * */ readonly data?: { - /** @description The title for the video. If left blank, this will be filled in according to data on a host site. - * */ + /** @description The title for the video. If left blank, this will be filled in according to data on a host site. */ readonly title?: string; - /** @description The description for the video. If left blank, this will be filled in according to data on a host site. - * */ + /** @description The description for the video. If left blank, this will be filled in according to data on a host site. */ readonly description?: string; - /** @description The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a `sort_order` the same as or greater than the videoʼs new `sort_order` value will have their `sort_order`s reordered. - * */ + /** @description The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a `sort_order` the same as or greater than the videoʼs new `sort_order` value will have their `sort_order`s reordered. */ readonly sort_order?: number; /** * @description The video type (a short name of a host site). - * * @enum {string} */ readonly type?: "youtube"; } & { - /** @description The unique numeric ID of the product video; increments sequentially. - * */ + /** @description The unique numeric ID of the product video; increments sequentially. */ readonly id?: number; - /** @description The ID of the video on a host site. - * */ + /** @description The ID of the video on a host site. */ readonly video_id?: string; - /** @description The unique numeric identifier for the product with which the image is associated. - * */ + /** @description The unique numeric identifier for the product with which the image is associated. */ readonly product_id?: number; - /** @description Length of the video. This will be filled in according to data on a host site. - * */ + /** @description Length of the video. This will be filled in according to data on a host site. */ readonly length?: string; }; readonly meta?: components["schemas"]["metaEmpty_Full"]; }; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -5848,8 +5366,7 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; /** @description The BigCommerce ID of the `Video` */ readonly id: components["parameters"]["VideoIdParam"]; @@ -5863,29 +5380,29 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "title": "Your Video", * "description": "Company Values", * "sort_order": 1, * "type": "youtube", * "video_id": "123345AA" - * } */ + * } + */ readonly "application/json": { readonly data?: components["schemas"]["productVideo_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; }; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -5906,8 +5423,7 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; /** @description The BigCommerce ID of the `Video` */ readonly id: components["parameters"]["VideoIdParam"]; @@ -5917,24 +5433,19 @@ export interface operations { readonly requestBody: { readonly content: { readonly "application/json": { - /** @description The title for the video. If left blank, this will be filled in according to data on a host site. - * */ + /** @description The title for the video. If left blank, this will be filled in according to data on a host site. */ readonly title?: string; - /** @description The description for the video. If left blank, this will be filled in according to data on a host site. - * */ + /** @description The description for the video. If left blank, this will be filled in according to data on a host site. */ readonly description?: string; - /** @description The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a `sort_order` the same as or greater than the videoʼs new `sort_order` value will have their `sort_order`s reordered. - * */ + /** @description The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a `sort_order` the same as or greater than the videoʼs new `sort_order` value will have their `sort_order`s reordered. */ readonly sort_order?: number; /** * @description The video type (a short name of a host site). - * * @enum {string} */ readonly type?: "youtube"; } & { - /** @description The unique numeric ID of the product video; increments sequentially. - * */ + /** @description The unique numeric ID of the product video; increments sequentially. */ readonly id?: number; }; }; @@ -5945,63 +5456,54 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "title": "Your Video", * "description": "Company Values", * "sort_order": 1, * "type": "youtube", * "video_id": "123345AA" - * } */ + * } + */ readonly "application/json": { /** * Product Video * @description A product video model. - * */ readonly data?: { - /** @description The title for the video. If left blank, this will be filled in according to data on a host site. - * */ + /** @description The title for the video. If left blank, this will be filled in according to data on a host site. */ readonly title?: string; - /** @description The description for the video. If left blank, this will be filled in according to data on a host site. - * */ + /** @description The description for the video. If left blank, this will be filled in according to data on a host site. */ readonly description?: string; - /** @description The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a `sort_order` the same as or greater than the videoʼs new `sort_order` value will have their `sort_order`s reordered. - * */ + /** @description The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a `sort_order` the same as or greater than the videoʼs new `sort_order` value will have their `sort_order`s reordered. */ readonly sort_order?: number; /** * @description The video type (a short name of a host site). - * * @enum {string} */ readonly type?: "youtube"; } & { - /** @description The unique numeric ID of the product video; increments sequentially. - * */ + /** @description The unique numeric ID of the product video; increments sequentially. */ readonly id?: number; - /** @description The ID of the video on a host site. - * */ + /** @description The ID of the video on a host site. */ readonly video_id?: string; - /** @description The unique numeric identifier for the product with which the image is associated. - * */ + /** @description The unique numeric identifier for the product with which the image is associated. */ readonly product_id?: number; - /** @description Length of the video. This will be filled in according to data on a host site. - * */ + /** @description Length of the video. This will be filled in according to data on a host site. */ readonly length?: string; }; readonly meta?: components["schemas"]["metaEmpty_Full"]; }; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -6020,8 +5522,7 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; /** @description The BigCommerce ID of the `Video` */ readonly id: components["parameters"]["VideoIdParam"]; @@ -6045,11 +5546,9 @@ export interface operations { readonly include_fields?: components["parameters"]["IncludeFieldsParam"]; /** @description Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded. */ readonly exclude_fields?: components["parameters"]["ExcludeFieldsParam"]; - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; }; readonly header?: { @@ -6057,8 +5556,7 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; }; readonly cookie?: never; @@ -6070,7 +5568,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": [ * { * "id": 82, @@ -6135,7 +5634,8 @@ export interface operations { * } * } * } - * } */ + * } + */ readonly "application/json": { readonly data?: readonly components["schemas"]["complexRule_Base"][]; readonly meta?: components["schemas"]["metaCollection_Full"]; @@ -6154,8 +5654,7 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; }; readonly cookie?: never; @@ -6165,34 +5664,27 @@ export interface operations { readonly "application/json": { /** * @description The priority to give this rule when making adjustments to the product properties. - * * @example 0 */ readonly sort_order?: number; /** * @description Flag for determining whether the rule is to be used when adjusting a productʼs price, weight, image, or availabilty. - * * @example true */ readonly enabled?: boolean; - /** @description Flag for determining whether other rules should not be applied after this rule has been applied. - * */ + /** @description Flag for determining whether other rules should not be applied after this rule has been applied. */ readonly stop?: boolean; - /** @description Flag for determining whether the rule should disable purchasing of a product when the conditions are applied. - * */ + /** @description Flag for determining whether the rule should disable purchasing of a product when the conditions are applied. */ readonly purchasing_disabled?: boolean; /** * @description Message displayed on the storefront when a rule disables the purchasing of a product. - * * @example This product is not available at this time. */ readonly purchasing_disabled_message?: string; - /** @description Flag for determining whether the rule should hide purchasing of a product when the conditions are applied. - * */ + /** @description Flag for determining whether the rule should hide purchasing of a product when the conditions are applied. */ readonly purchasing_hidden?: boolean; /** * @description The URL for an image displayed on the storefront when the conditions are applied. Limit of 8MB per file. - * * @example https://cdn8.bigcommerce.com/s-123456/product_images/d/fakeimage.png */ readonly image_url?: string; @@ -6203,13 +5695,11 @@ export interface operations { readonly price_adjuster?: { /** * @description The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @enum {string|null} */ readonly adjuster?: "relative" | "percentage" | null; /** * @description The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @example 5 */ readonly adjuster_value?: number; @@ -6221,13 +5711,11 @@ export interface operations { readonly weight_adjuster?: { /** * @description The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @enum {string|null} */ readonly adjuster?: "relative" | "percentage" | null; /** * @description The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @example 5 */ readonly adjuster_value?: number; @@ -6256,40 +5744,32 @@ export interface operations { readonly id?: number; /** * @description The unique numeric ID of the product with which the rule is associated; increments sequentially. - * * @example 67 */ readonly product_id?: number | null; /** * @description The priority to give this rule when making adjustments to the product properties. - * * @example 0 */ readonly sort_order?: number; /** * @description Flag for determining whether the rule is to be used when adjusting a productʼs price, weight, image, or availabilty. - * * @example true */ readonly enabled?: boolean; - /** @description Flag for determining whether other rules should not be applied after this rule has been applied. - * */ + /** @description Flag for determining whether other rules should not be applied after this rule has been applied. */ readonly stop?: boolean; - /** @description Flag for determining whether the rule should disable purchasing of a product when the conditions are applied. - * */ + /** @description Flag for determining whether the rule should disable purchasing of a product when the conditions are applied. */ readonly purchasing_disabled?: boolean; /** * @description Message displayed on the storefront when a rule disables the purchasing of a product. - * * @example This product is not available at this time. */ readonly purchasing_disabled_message?: string; - /** @description Flag for determining whether the rule should hide purchasing of a product when the conditions are applied. - * */ + /** @description Flag for determining whether the rule should hide purchasing of a product when the conditions are applied. */ readonly purchasing_hidden?: boolean; /** * @description The URL for an image displayed on the storefront when the conditions are applied. Limit of 8MB per file. - * * @example https://cdn8.bigcommerce.com/s-123456/product_images/d/fakeimage.png */ readonly image_url?: string; @@ -6300,13 +5780,11 @@ export interface operations { readonly price_adjuster?: { /** * @description The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @enum {string|null} */ readonly adjuster?: "relative" | "percentage" | null; /** * @description The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @example 5 */ readonly adjuster_value?: number; @@ -6318,13 +5796,11 @@ export interface operations { readonly weight_adjuster?: { /** * @description The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @enum {string|null} */ readonly adjuster?: "relative" | "percentage" | null; /** * @description The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @example 5 */ readonly adjuster_value?: number; @@ -6332,7 +5808,6 @@ export interface operations { readonly conditions?: readonly { /** * @description The unique numeric ID of the rule condition; increments sequentially. Read-Only - * * @example 3 */ readonly id?: number | null; @@ -6360,8 +5835,7 @@ export interface operations { * @example 1 */ readonly variant_id: number | null; - /** @description (READ-ONLY:) The unique numeric ID of the SKU (v2 API), or Combination, with which the rule condition is associated. This is to maintain cross-compatibility between v2 and v3. - * */ + /** @description (READ-ONLY:) The unique numeric ID of the SKU (v2 API), or Combination, with which the rule condition is associated. This is to maintain cross-compatibility between v2 and v3. */ readonly combination_id?: number; }[]; }; @@ -6369,8 +5843,7 @@ export interface operations { }; }; }; - /** @description The `ComplexRule` was in conflict with another `ComplexRule`. This is the result of duplicate conditions. - * */ + /** @description The `ComplexRule` was in conflict with another `ComplexRule`. This is the result of duplicate conditions. */ readonly 409: { headers: { readonly [name: string]: unknown; @@ -6382,18 +5855,15 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; }; }; - /** @description The `ComplexRule` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description The `ComplexRule` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -6405,11 +5875,9 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -6430,11 +5898,9 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `ComplexRule`. - * */ + /** @description The ID of the `ComplexRule`. */ readonly complex_rule_id: components["parameters"]["ComplexRuleIdParam"]; }; readonly cookie?: never; @@ -6460,40 +5926,32 @@ export interface operations { readonly id?: number; /** * @description The unique numeric ID of the product with which the rule is associated; increments sequentially. - * * @example 67 */ readonly product_id?: number; /** * @description The priority to give this rule when making adjustments to the product properties. - * * @example 0 */ readonly sort_order?: number; /** * @description Flag for determining whether the rule is to be used when adjusting a productʼs price, weight, image, or availabilty. - * * @example true */ readonly enabled?: boolean; - /** @description Flag for determining whether other rules should not be applied after this rule has been applied. - * */ + /** @description Flag for determining whether other rules should not be applied after this rule has been applied. */ readonly stop?: boolean; - /** @description Flag for determining whether the rule should disable purchasing of a product when the conditions are applied. - * */ + /** @description Flag for determining whether the rule should disable purchasing of a product when the conditions are applied. */ readonly purchasing_disabled?: boolean; /** * @description Message displayed on the storefront when a rule disables the purchasing of a product. - * * @example This product is not available at this time. */ readonly purchasing_disabled_message?: string; - /** @description Flag for determining whether the rule should hide purchasing of a product when the conditions are applied. - * */ + /** @description Flag for determining whether the rule should hide purchasing of a product when the conditions are applied. */ readonly purchasing_hidden?: boolean; /** * @description The URL for an image displayed on the storefront when the conditions are applied. Limit of 8MB per file. - * * @example https://cdn8.bigcommerce.com/s-123456/product_images/d/fakeimage.png */ readonly image_url?: string; @@ -6504,13 +5962,11 @@ export interface operations { readonly price_adjuster?: { /** * @description The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @enum {string} */ readonly adjuster?: "relative" | "percentage"; /** * @description The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @example 5 */ readonly adjuster_value?: number; @@ -6522,13 +5978,11 @@ export interface operations { readonly weight_adjuster?: { /** * @description The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @enum {string} */ readonly adjuster?: "relative" | "percentage"; /** * @description The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @example 5 */ readonly adjuster_value?: number; @@ -6536,7 +5990,6 @@ export interface operations { readonly conditions?: readonly { /** * @description The unique numeric ID of the rule condition; increments sequentially. Read-Only - * * @example 3 */ readonly id?: number; @@ -6564,8 +6017,7 @@ export interface operations { * @example 1 */ readonly variant_id: number; - /** @description (READ-ONLY:) The unique numeric ID of the SKU (v2 API), or Combination, with which the rule condition is associated. This is to maintain cross-compatibility between v2 and v3. - * */ + /** @description (READ-ONLY:) The unique numeric ID of the SKU (v2 API), or Combination, with which the rule condition is associated. This is to maintain cross-compatibility between v2 and v3. */ readonly combination_id?: number; }[]; }; @@ -6573,16 +6025,14 @@ export interface operations { }; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -6603,11 +6053,9 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `ComplexRule`. - * */ + /** @description The ID of the `ComplexRule`. */ readonly complex_rule_id: components["parameters"]["ComplexRuleIdParam"]; }; readonly cookie?: never; @@ -6617,34 +6065,27 @@ export interface operations { readonly "application/json": { /** * @description The priority to give this rule when making adjustments to the product properties. - * * @example 0 */ readonly sort_order?: number; /** * @description Flag for determining whether the rule is to be used when adjusting a productʼs price, weight, image, or availabilty. - * * @example true */ readonly enabled?: boolean; - /** @description Flag for determining whether other rules should not be applied after this rule has been applied. - * */ + /** @description Flag for determining whether other rules should not be applied after this rule has been applied. */ readonly stop?: boolean; - /** @description Flag for determining whether the rule should disable purchasing of a product when the conditions are applied. - * */ + /** @description Flag for determining whether the rule should disable purchasing of a product when the conditions are applied. */ readonly purchasing_disabled?: boolean; /** * @description Message displayed on the storefront when a rule disables the purchasing of a product. - * * @example This product is not available at this time. */ readonly purchasing_disabled_message?: string; - /** @description Flag for determining whether the rule should hide purchasing of a product when the conditions are applied. - * */ + /** @description Flag for determining whether the rule should hide purchasing of a product when the conditions are applied. */ readonly purchasing_hidden?: boolean; /** * @description The URL for an image displayed on the storefront when the conditions are applied. Limit of 8MB per file. - * * @example https://cdn8.bigcommerce.com/s-123456/product_images/d/fakeimage.png */ readonly image_url?: string; @@ -6655,13 +6096,11 @@ export interface operations { readonly price_adjuster?: { /** * @description The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @enum {string|null} */ readonly adjuster?: "relative" | "percentage" | null; /** * @description The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @example 5 */ readonly adjuster_value?: number; @@ -6673,13 +6112,11 @@ export interface operations { readonly weight_adjuster?: { /** * @description The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @enum {string|null} */ readonly adjuster?: "relative" | "percentage" | null; /** * @description The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @example 5 */ readonly adjuster_value?: number; @@ -6727,40 +6164,32 @@ export interface operations { readonly id?: number; /** * @description The unique numeric ID of the product with which the rule is associated; increments sequentially. - * * @example 67 */ readonly product_id?: number; /** * @description The priority to give this rule when making adjustments to the product properties. - * * @example 0 */ readonly sort_order?: number; /** * @description Flag for determining whether the rule is to be used when adjusting a productʼs price, weight, image, or availabilty. - * * @example true */ readonly enabled?: boolean; - /** @description Flag for determining whether other rules should not be applied after this rule has been applied. - * */ + /** @description Flag for determining whether other rules should not be applied after this rule has been applied. */ readonly stop?: boolean; - /** @description Flag for determining whether the rule should disable purchasing of a product when the conditions are applied. - * */ + /** @description Flag for determining whether the rule should disable purchasing of a product when the conditions are applied. */ readonly purchasing_disabled?: boolean; /** * @description Message displayed on the storefront when a rule disables the purchasing of a product. - * * @example This product is not available at this time. */ readonly purchasing_disabled_message?: string; - /** @description Flag for determining whether the rule should hide purchasing of a product when the conditions are applied. - * */ + /** @description Flag for determining whether the rule should hide purchasing of a product when the conditions are applied. */ readonly purchasing_hidden?: boolean; /** * @description The URL for an image displayed on the storefront when the conditions are applied. Limit of 8MB per file. - * * @example https://cdn8.bigcommerce.com/s-123456/product_images/d/fakeimage.png */ readonly image_url?: string; @@ -6771,13 +6200,11 @@ export interface operations { readonly price_adjuster?: { /** * @description The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @enum {string} */ readonly adjuster?: "relative" | "percentage"; /** * @description The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @example 5 */ readonly adjuster_value?: number; @@ -6789,13 +6216,11 @@ export interface operations { readonly weight_adjuster?: { /** * @description The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @enum {string} */ readonly adjuster?: "relative" | "percentage"; /** * @description The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront. - * * @example 5 */ readonly adjuster_value?: number; @@ -6803,7 +6228,6 @@ export interface operations { readonly conditions?: readonly { /** * @description The unique numeric ID of the rule condition; increments sequentially. Read-Only - * * @example 3 */ readonly id?: number; @@ -6831,8 +6255,7 @@ export interface operations { * @example 1 */ readonly variant_id: number; - /** @description (READ-ONLY:) The unique numeric ID of the SKU (v2 API), or Combination, with which the rule condition is associated. This is to maintain cross-compatibility between v2 and v3. - * */ + /** @description (READ-ONLY:) The unique numeric ID of the SKU (v2 API), or Combination, with which the rule condition is associated. This is to maintain cross-compatibility between v2 and v3. */ readonly combination_id?: number; }[]; }; @@ -6840,8 +6263,7 @@ export interface operations { }; }; }; - /** @description The `ComplexRule` was in conflict with another `ComplexRule`. This is the result of duplicate conditions. - * */ + /** @description The `ComplexRule` was in conflict with another `ComplexRule`. This is the result of duplicate conditions. */ readonly 409: { headers: { readonly [name: string]: unknown; @@ -6853,18 +6275,15 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; }; }; - /** @description The `ComplexRule` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description The `ComplexRule` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -6876,11 +6295,9 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -6896,11 +6313,9 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `ComplexRule`. - * */ + /** @description The ID of the `ComplexRule`. */ readonly complex_rule_id: components["parameters"]["ComplexRuleIdParam"]; }; readonly cookie?: never; @@ -6919,20 +6334,17 @@ export interface operations { readonly parameters: { readonly query?: { /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */ - readonly include_fields?: components["parameters"]["IncludeFieldsParam"]; + readonly include_fields?: components["parameters"]["CustomFieldsIncludeFieldsParam"]; /** @description Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded. */ - readonly exclude_fields?: components["parameters"]["ExcludeFieldsParam"]; - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + readonly exclude_fields?: components["parameters"]["CustomFieldsExcludeFieldsParam"]; + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; }; readonly header?: never; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; }; readonly cookie?: never; @@ -6951,8 +6363,7 @@ export interface operations { readonly query?: never; readonly header?: never; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; }; readonly cookie?: never; @@ -6976,17 +6387,15 @@ export interface operations { readonly parameters: { readonly query?: { /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */ - readonly include_fields?: components["parameters"]["IncludeFieldsParam"]; + readonly include_fields?: components["parameters"]["CustomFieldsIncludeFieldsParam"]; /** @description Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded. */ - readonly exclude_fields?: components["parameters"]["ExcludeFieldsParam"]; + readonly exclude_fields?: components["parameters"]["CustomFieldsExcludeFieldsParam"]; }; readonly header?: never; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `CustomField`. - * */ + /** @description The ID of the `CustomField`. */ readonly custom_field_id: components["parameters"]["CustomFieldIdParam"]; }; readonly cookie?: never; @@ -7005,11 +6414,9 @@ export interface operations { readonly query?: never; readonly header?: never; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `CustomField`. - * */ + /** @description The ID of the `CustomField`. */ readonly custom_field_id: components["parameters"]["CustomFieldIdParam"]; }; readonly cookie?: never; @@ -7034,11 +6441,9 @@ export interface operations { readonly query?: never; readonly header?: never; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `CustomField`. - * */ + /** @description The ID of the `CustomField`. */ readonly custom_field_id: components["parameters"]["CustomFieldIdParam"]; }; readonly cookie?: never; @@ -7073,8 +6478,7 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; }; readonly cookie?: never; @@ -7086,7 +6490,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 83, * "quantity_min": 1, @@ -7106,7 +6511,8 @@ export interface operations { * } * } * } - * } */ + * } + */ readonly "application/json": { readonly data?: { /** @description Unique ID of the *Bulk Pricing Rule*. Read-Only. */ @@ -7128,8 +6534,7 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; }; readonly cookie?: never; @@ -7145,7 +6550,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 83, * "quantity_min": 1, @@ -7154,7 +6560,8 @@ export interface operations { * "amount": 1 * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: { /** @description Unique ID of the *Bulk Pricing Rule*. Read-Only. */ @@ -7179,11 +6586,9 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `BulkPricingRule`. - * */ + /** @description The ID of the `BulkPricingRule`. */ readonly bulk_pricing_rule_id: components["parameters"]["BulkPricingRuleIdParam"]; }; readonly cookie?: never; @@ -7195,7 +6600,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 83, * "quantity_min": 1, @@ -7204,7 +6610,8 @@ export interface operations { * "amount": 1 * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: { /** @description Unique ID of the *Bulk Pricing Rule*. Read-Only. */ @@ -7214,16 +6621,14 @@ export interface operations { }; }; }; - /** @description The resource or parent resource was not found. - * */ + /** @description The resource or parent resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -7244,11 +6649,9 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `BulkPricingRule`. - * */ + /** @description The ID of the `BulkPricingRule`. */ readonly bulk_pricing_rule_id: components["parameters"]["BulkPricingRuleIdParam"]; }; readonly cookie?: never; @@ -7267,7 +6670,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 83, * "quantity_min": 1, @@ -7276,7 +6680,8 @@ export interface operations { * "amount": 1 * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: { /** @description Unique ID of the *Bulk Pricing Rule*. Read-Only. */ @@ -7286,16 +6691,14 @@ export interface operations { }; }; }; - /** @description The resource or parent resource was not found. - * */ + /** @description The resource or parent resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -7304,8 +6707,7 @@ export interface operations { }; }; }; - /** @description The `BulkPricingRule` was in conflict with another bulk pricing rule. This is the result of quantity range overlapping with existing bulk pricing rules. - * */ + /** @description The `BulkPricingRule` was in conflict with another bulk pricing rule. This is the result of quantity range overlapping with existing bulk pricing rules. */ readonly 409: { headers: { readonly [name: string]: unknown; @@ -7317,18 +6719,15 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; }; }; - /** @description The `BulkPricingRule` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description The `BulkPricingRule` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -7340,11 +6739,9 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -7360,11 +6757,9 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `BulkPricingRule`. - * */ + /** @description The ID of the `BulkPricingRule`. */ readonly bulk_pricing_rule_id: components["parameters"]["BulkPricingRuleIdParam"]; }; readonly cookie?: never; @@ -7377,16 +6772,14 @@ export interface operations { }; content?: never; }; - /** @description The resource or parent resource was not found. - * */ + /** @description The resource or parent resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -7400,11 +6793,9 @@ export interface operations { readonly getProductMetafields: { readonly parameters: { readonly query?: { - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; /** @description Filter based on a metafieldʼs key. */ readonly key?: components["parameters"]["MetafieldKeyParam"]; @@ -7414,14 +6805,15 @@ export interface operations { readonly include_fields?: components["parameters"]["IncludeFieldsParam"]; /** @description Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded. */ readonly exclude_fields?: components["parameters"]["ExcludeFieldsParam"]; + /** @description A comma-separated list of entity ID values that filter results to metafields that belong to one of the matching entities. */ + readonly "resource_id:in"?: components["parameters"]["MetafieldResourceParam"]; }; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; }; readonly cookie?: never; @@ -7433,7 +6825,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": [ * { * "id": 6, @@ -7472,7 +6865,8 @@ export interface operations { * } * } * } - * } */ + * } + */ readonly "application/json": { readonly data?: readonly components["schemas"]["metafield_Full"][]; readonly meta?: components["schemas"]["metaCollection_Full"]; @@ -7491,8 +6885,7 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; }; readonly cookie?: never; @@ -7508,7 +6901,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 8, * "key": "location_id", @@ -7522,7 +6916,8 @@ export interface operations { * "date_modified": "2018-09-13T16:42:37+00:00" * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: components["schemas"]["metafield_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; @@ -7535,12 +6930,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -7549,8 +6946,7 @@ export interface operations { }; }; }; - /** @description The `Metafield` was in conflict with another `Metafield`. This can be the result of duplicate unique key combinations of the appʼs client ID, namespace, key, resource_type, and resource_id. - * */ + /** @description The `Metafield` was in conflict with another `Metafield`. This can be the result of duplicate unique key combinations of the appʼs client ID, namespace, key, resource_type, and resource_id. */ readonly 409: { headers: { readonly [name: string]: unknown; @@ -7570,8 +6966,7 @@ export interface operations { }; }; }; - /** @description The `Metafield` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description The `Metafield` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -7583,11 +6978,9 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -7608,11 +7001,9 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `Metafield`. - * */ + /** @description The ID of the `Metafield`. */ readonly metafield_id: components["parameters"]["MetafieldIdParam"]; }; readonly cookie?: never; @@ -7624,7 +7015,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 4, * "key": "location_id", @@ -7638,23 +7030,22 @@ export interface operations { * "date_modified": "2021-08-06T19:15:35+00:00" * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: components["schemas"]["metafield_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; }; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -7675,11 +7066,9 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `Metafield`. - * */ + /** @description The ID of the `Metafield`. */ readonly metafield_id: components["parameters"]["MetafieldIdParam"]; }; readonly cookie?: never; @@ -7695,7 +7084,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 4, * "key": "location_id", @@ -7709,7 +7099,8 @@ export interface operations { * "date_modified": "2021-08-06T19:15:35+00:00" * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: components["schemas"]["metafield_Full"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; @@ -7722,12 +7113,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -7736,16 +7129,14 @@ export interface operations { }; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -7764,11 +7155,9 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `Metafield`. - * */ + /** @description The ID of the `Metafield`. */ readonly metafield_id: components["parameters"]["MetafieldIdParam"]; }; readonly cookie?: never; @@ -7781,16 +7170,14 @@ export interface operations { }; content?: never; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -7808,11 +7195,9 @@ export interface operations { readonly include_fields?: components["parameters"]["IncludeFieldsParam"]; /** @description Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded. */ readonly exclude_fields?: components["parameters"]["ExcludeFieldsParam"]; - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; /** @description Filter items by status. `1` for approved, `0` for pending. */ readonly status?: 0 | 1; @@ -7822,8 +7207,7 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; }; readonly cookie?: never; @@ -7837,14 +7221,14 @@ export interface operations { content: { readonly "application/json": { readonly data?: readonly ({ - /** @description The title for the product review. - * Required in /POST. */ + /** + * @description The title for the product review. + * Required in /POST. + */ readonly title: string; - /** @description The text for the product review. - * */ + /** @description The text for the product review. */ readonly text?: string; - /** @description The status of the product review. Must be one of `approved`, `disapproved` or `pending`. - * */ + /** @description The status of the product review. Must be one of `approved`, `disapproved` or `pending`. */ readonly status?: string; /** @description The rating of the product review. Must be one of 0, 1, 2, 3, 4, 5. */ readonly rating?: number; @@ -7855,23 +7239,19 @@ export interface operations { /** * Format: date-time * @description Date the product was reviewed. Required in /POST. - * */ readonly date_reviewed: string; } & { - /** @description The unique numeric ID of the product review; increments sequentially. - * */ + /** @description The unique numeric ID of the product review; increments sequentially. */ readonly id?: number; /** * Format: date-time * @description Date the product review was created. - * */ readonly date_created?: string; /** * Format: date-time * @description Date the product review was modified. - * */ readonly date_modified?: string; })[]; @@ -7879,24 +7259,21 @@ export interface operations { }; }; }; - /** @description There are no reviews on this product. - * */ + /** @description There are no reviews on this product. */ readonly 204: { headers: { readonly [name: string]: unknown; }; content?: never; }; - /** @description The product ID does not exist. - * */ + /** @description The product ID does not exist. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -7917,8 +7294,7 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; }; readonly cookie?: never; @@ -7932,12 +7308,10 @@ export interface operations { * @example Great Product */ readonly title: string; - /** @description The text for the product review. - * */ + /** @description The text for the product review. */ readonly text?: string; /** * @description The status of the product review. Must be one of `approved`, `disapproved` or `pending`. - * * @example approved */ readonly status?: string; @@ -7959,7 +7333,6 @@ export interface operations { /** * Format: date-time * @description Date the product was reviewed. Required in /POST. - * */ readonly date_reviewed: string; }; @@ -7971,7 +7344,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "title": "irur", * "text": "anim aute", @@ -7986,22 +7360,22 @@ export interface operations { * "date_modified": "2004-09-28T14:38:21.973Z" * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { /** * Product Review * @description A product review model. - * */ readonly data?: { - /** @description The title for the product review. - * Required in /POST. */ + /** + * @description The title for the product review. + * Required in /POST. + */ readonly title: string; - /** @description The text for the product review. - * */ + /** @description The text for the product review. */ readonly text?: string; - /** @description The status of the product review. Must be one of `approved`, `disapproved` or `pending`. - * */ + /** @description The status of the product review. Must be one of `approved`, `disapproved` or `pending`. */ readonly status?: string; /** @description The rating of the product review. Must be one of 0, 1, 2, 3, 4, 5. */ readonly rating?: number; @@ -8012,23 +7386,19 @@ export interface operations { /** * Format: date-time * @description Date the product was reviewed. Required in /POST. - * */ readonly date_reviewed: string; } & { - /** @description The unique numeric ID of the product review; increments sequentially. - * */ + /** @description The unique numeric ID of the product review; increments sequentially. */ readonly id?: number; /** * Format: date-time * @description Date the product review was created. - * */ readonly date_created?: string; /** * Format: date-time * @description Date the product review was modified. - * */ readonly date_modified?: string; }; @@ -8036,16 +7406,14 @@ export interface operations { }; }; }; - /** @description The product ID does not exist. - * */ + /** @description The product ID does not exist. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -8069,11 +7437,9 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `review` that is being operated on. - * */ + /** @description The ID of the `review` that is being operated on. */ readonly review_id: components["parameters"]["ReviewIdParam"]; }; readonly cookie?: never; @@ -8085,7 +7451,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "title": "irur", * "text": "anim aute", @@ -8100,22 +7467,22 @@ export interface operations { * "date_modified": "2004-09-28T14:38:21.973Z" * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { /** * Product Review * @description A product review model. - * */ readonly data?: { - /** @description The title for the product review. - * Required in /POST. */ + /** + * @description The title for the product review. + * Required in /POST. + */ readonly title: string; - /** @description The text for the product review. - * */ + /** @description The text for the product review. */ readonly text?: string; - /** @description The status of the product review. Must be one of `approved`, `disapproved` or `pending`. - * */ + /** @description The status of the product review. Must be one of `approved`, `disapproved` or `pending`. */ readonly status?: string; /** @description The rating of the product review. Must be one of 0, 1, 2, 3, 4, 5. */ readonly rating?: number; @@ -8126,23 +7493,19 @@ export interface operations { /** * Format: date-time * @description Date the product was reviewed. Required in /POST. - * */ readonly date_reviewed: string; } & { - /** @description The unique numeric ID of the product review; increments sequentially. - * */ + /** @description The unique numeric ID of the product review; increments sequentially. */ readonly id?: number; /** * Format: date-time * @description Date the product review was created. - * */ readonly date_created?: string; /** * Format: date-time * @description Date the product review was modified. - * */ readonly date_modified?: string; }; @@ -8150,16 +7513,14 @@ export interface operations { }; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -8180,28 +7541,25 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `review` that is being operated on. - * */ + /** @description The ID of the `review` that is being operated on. */ readonly review_id: components["parameters"]["ReviewIdParam"]; }; readonly cookie?: never; }; - /** @description A BigCommerce `ProductReview` object. - * */ + /** @description A BigCommerce `ProductReview` object. */ readonly requestBody: { readonly content: { readonly "application/json": { - /** @description The title for the product review. - * Required in /POST. */ + /** + * @description The title for the product review. + * Required in /POST. + */ readonly title: string; - /** @description The text for the product review. - * */ + /** @description The text for the product review. */ readonly text?: string; - /** @description The status of the product review. Must be one of `approved`, `disapproved` or `pending`. - * */ + /** @description The status of the product review. Must be one of `approved`, `disapproved` or `pending`. */ readonly status?: string; /** @description The rating of the product review. Must be one of 0, 1, 2, 3, 4, 5. */ readonly rating?: number; @@ -8212,7 +7570,6 @@ export interface operations { /** * Format: date-time * @description Date the product was reviewed. Required in /POST. - * */ readonly date_reviewed: string; }; @@ -8224,7 +7581,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "title": "irur", * "text": "anim aute", @@ -8239,22 +7597,22 @@ export interface operations { * "date_modified": "2004-09-28T14:38:21.973Z" * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { /** * Product Review * @description A product review model. - * */ readonly data?: { - /** @description The title for the product review. - * Required in /POST. */ + /** + * @description The title for the product review. + * Required in /POST. + */ readonly title: string; - /** @description The text for the product review. - * */ + /** @description The text for the product review. */ readonly text?: string; - /** @description The status of the product review. Must be one of `approved`, `disapproved` or `pending`. - * */ + /** @description The status of the product review. Must be one of `approved`, `disapproved` or `pending`. */ readonly status?: string; /** @description The rating of the product review. Must be one of 0, 1, 2, 3, 4, 5. */ readonly rating?: number; @@ -8265,23 +7623,19 @@ export interface operations { /** * Format: date-time * @description Date the product was reviewed. Required in /POST. - * */ readonly date_reviewed: string; } & { - /** @description The unique numeric ID of the product review; increments sequentially. - * */ + /** @description The unique numeric ID of the product review; increments sequentially. */ readonly id?: number; /** * Format: date-time * @description Date the product review was created. - * */ readonly date_created?: string; /** * Format: date-time * @description Date the product review was modified. - * */ readonly date_modified?: string; }; @@ -8289,16 +7643,14 @@ export interface operations { }; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -8317,11 +7669,9 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Product` to which the resource belongs. - * */ + /** @description The ID of the `Product` to which the resource belongs. */ readonly product_id: components["parameters"]["ProductIdParam"]; - /** @description The ID of the `review` that is being operated on. - * */ + /** @description The ID of the `review` that is being operated on. */ readonly review_id: components["parameters"]["ReviewIdParam"]; }; readonly cookie?: never; @@ -8339,11 +7689,9 @@ export interface operations { readonly getProductsChannelAssignments: { readonly parameters: { readonly query?: { - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; /** @description Pass a comma-separated list to filter by one or more product IDs. */ readonly "product_id:in"?: components["parameters"]["ProductIdInParam"]; @@ -8447,11 +7795,9 @@ export interface operations { readonly getProductsCategoryAssignments: { readonly parameters: { readonly query?: { - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; /** @description Pass a comma-separated list to filter by one or more product IDs. */ readonly "product_id:in"?: components["parameters"]["ProductIdInParam"]; @@ -8577,26 +7923,22 @@ export interface operations { readonly data?: { /** * @description A count of all inventory items in the catalog. - * * @example 2000 */ readonly inventory_count?: number; /** * Format: double * @description Total value of storeʼs inventory. - * * @example 267000 */ readonly inventory_value?: number; /** * @description ID of the category containing the most products. - * * @example 23 */ readonly primary_category_id?: number; /** * @description Name of the category containing the most products. - * * @example Shop All */ readonly primary_category_name?: string; @@ -8636,11 +7978,9 @@ export interface operations { readonly getProductsMetafields: { readonly parameters: { readonly query?: { - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; /** @description Filter based on a metafieldʼs key. */ readonly key?: components["parameters"]["MetafieldKeyParam"]; @@ -8650,22 +7990,17 @@ export interface operations { readonly namespace?: components["parameters"]["MetafieldNamespaceParam"]; /** @description Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. */ readonly "namespace:in"?: components["parameters"]["MetafieldNamespaceInParam"]; - /** @description Sort direction. Acceptable values are: `asc`, `desc`. - * */ + /** @description Sort direction. Acceptable values are: `asc`, `desc`. */ readonly direction?: components["parameters"]["DirectionParam"]; /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */ readonly include_fields?: components["parameters"]["IncludeFieldsParamMetafields"]; - /** @description 'Query parameter that lets you filter by the minimum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.' - * */ + /** @description 'Query parameter that lets you filter by the minimum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.' */ readonly "date_modified:min"?: components["parameters"]["date_modified_min"]; - /** @description 'Query parameter that lets you filter by the maximum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.' - * */ + /** @description 'Query parameter that lets you filter by the maximum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.' */ readonly "date_modified:max"?: components["parameters"]["date_modified_max"]; - /** @description 'Query parameter that lets you filter by the minimum date created, ffor example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.' - * */ + /** @description 'Query parameter that lets you filter by the minimum date created, ffor example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.' */ readonly "date_created:min"?: components["parameters"]["date_created_min"]; - /** @description 'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.' - * */ + /** @description 'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.' */ readonly "date_created:max"?: components["parameters"]["date_created_max"]; }; readonly header?: never; @@ -8674,8 +8009,7 @@ export interface operations { }; readonly requestBody?: never; readonly responses: { - /** @description List of `Metafield` objects. - * */ + /** @description List of `Metafield` objects. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -8698,7 +8032,6 @@ export interface operations { readonly "application/json": readonly (components["schemas"]["MetafieldBase_Put"] & { /** * @description The ID of metafield to update. - * * @example 42 */ readonly id: number; @@ -8706,8 +8039,7 @@ export interface operations { }; }; readonly responses: { - /** @description List of updated `Metafield` objects. - * */ + /** @description List of updated `Metafield` objects. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -8722,12 +8054,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -8736,8 +8070,7 @@ export interface operations { }; }; }; - /** @description Response object for metafields creation with partial success. - * */ + /** @description Response object for metafields creation with partial success. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -8760,7 +8093,6 @@ export interface operations { readonly "application/json": readonly (components["schemas"]["MetafieldBase_Post"] & { /** * @description The ID for the product with which the metafield is associated. - * * @example 42 */ readonly resource_id: number; @@ -8768,8 +8100,7 @@ export interface operations { }; }; readonly responses: { - /** @description List of created `Metafield` objects. - * */ + /** @description List of created `Metafield` objects. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -8784,12 +8115,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -8798,8 +8131,7 @@ export interface operations { }; }; }; - /** @description Response object for metafields creation with partial success. - * */ + /** @description Response object for metafields creation with partial success. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -8824,8 +8156,7 @@ export interface operations { }; }; readonly responses: { - /** @description Response object for metafields deletion with success. - * */ + /** @description Response object for metafields deletion with success. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -8840,12 +8171,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -8854,8 +8187,7 @@ export interface operations { }; }; }; - /** @description Response object for metafields deletion with partial success. - * */ + /** @description Response object for metafields deletion with partial success. */ readonly 422: { headers: { readonly [name: string]: unknown; diff --git a/src/internal/reference/generated/channels.v3.ts b/src/internal/reference/generated/channels.v3.ts index 0e7aaeb..06e0838 100644 --- a/src/internal/reference/generated/channels.v3.ts +++ b/src/internal/reference/generated/channels.v3.ts @@ -260,7 +260,6 @@ export interface paths { * * If the customer saves a URL with `www`, the API returns it with `www`. * * If the customer saves a URL without `www`, the API returns it without `www`. * - * */ readonly get: operations["getChannelSite"]; /** @@ -309,7 +308,6 @@ export interface paths { /** * Get Channel Menus * @description Returns list of Control Panel side navigation menus for a channel. - * */ readonly get: operations["getChannelMenus"]; /** @@ -445,52 +443,44 @@ export interface components { readonly namespace?: string; /** * @description The name of the field, for example: `location_id`, `color`. - * * @example Location */ readonly key?: string; /** * @description The value of the field. - * * @example 4HG */ readonly value?: string; /** * @description Description for the metafields. - * * @example Location in the warehouse */ readonly description?: string; /** * @description The type of resource with which the metafield is associated. - * * @example product * @enum {string} */ readonly resource_type?: "category" | "brand" | "product" | "variant"; /** * @description The ID for the resource with which the metafield is associated. - * * @example 111 */ readonly resource_id?: number; /** * Format: date-time * @description Date and time of the metafieldʼs creation. Read-Only. - * * @example 2018-05-07T20:14:17.000Z */ readonly date_created?: string; /** * Format: date-time * @description Date and time when the metafield was last updated. Read-Only. - * * @example 2018-05-07T20:14:17.000Z */ readonly date_modified?: string; }; - /** @description Common Metafield properties. - * */ + /** @description Common Metafield properties. */ readonly Metafield: { /** * @description Determines the visibility and writeability of the field by other API consumers. @@ -501,44 +491,37 @@ export interface components { * | `write` | Open for reading and writing by other API consumers. | * | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | * | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | - * * @enum {string} */ readonly permission_set: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; /** * @description Namespace for the metafield, for organizational purposes. - * * @example Sales Department */ readonly namespace: string; /** * @description The name of the field, for example: `location_id`, `color`. - * * @example Staff Name */ readonly key: string; /** * @description The value of the field, for example: `1`, `blue`. - * * @example Ronaldo */ readonly value: string; /** * @description Description for the metafields. - * * @example order */ readonly description: string; /** * @description The type of resource with which the metafield is associated. - * * @example cart * @enum {string} */ readonly resource_type: "brand" | "product" | "variant" | "category" | "cart" | "channel" | "location" | "order" | "customer"; /** * @description The unique identifier for the resource with which the metafield is associated. - * * @example 424242 */ readonly resource_id: number; @@ -562,14 +545,12 @@ export interface components { */ readonly owner_client_id?: string; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponse: { readonly data?: readonly components["schemas"]["Metafield"][]; readonly meta?: components["schemas"]["CollectionMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponse_POST_PUT: { readonly data?: readonly components["schemas"]["Metafield"][]; /** @@ -579,31 +560,32 @@ export interface components { readonly errors?: readonly unknown[]; readonly meta?: components["schemas"]["CollectionMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponsePartialSuccess_POST_PUT: { readonly data?: readonly components["schemas"]["Metafield"][]; readonly errors?: readonly components["schemas"]["Error"][]; readonly meta?: components["schemas"]["WriteCollectionPartialSuccessMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponsePartialSuccess_DELETE: { - /** @example [ + /** + * @example [ * 123 - * ] */ + * ] + */ readonly data?: readonly number[]; readonly errors?: readonly components["schemas"]["Error"][]; readonly meta?: components["schemas"]["WriteCollectionPartialSuccessMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionDeleteResponseSuccess: { - /** @example [ + /** + * @example [ * 123, * 124, * 125 - * ] */ + * ] + */ readonly data?: readonly number[]; /** * @description Empty for 200 responses. @@ -619,19 +601,16 @@ export interface components { readonly WriteCollectionPartialSuccessMeta: { /** * @description Total number of items in the result set. - * * @example 3 */ readonly total?: number; /** * @description Total number of items that were successfully deleted. - * * @example 1 */ readonly success?: number; /** * @description Total number of items that failed to be deleted. - * * @example 2 */ readonly failed?: number; @@ -643,60 +622,50 @@ export interface components { readonly WriteCollectionSuccessMeta: { /** * @description Total number of items in the result set. - * * @example 3 */ readonly total?: number; /** * @description Total number of items that were successfully deleted. - * * @example 3 */ readonly success?: number; /** * @description Total number of items that failed to be deleted. - * * @example 0 */ readonly failed?: number; }; /** * @description Total number of items in the result set. - * * @example 3 */ readonly Total: number; /** * @description Total number of items that were successfully deleted. - * * @example 1 */ readonly Success: number; /** * @description Total number of items that failed to be deleted. - * * @example 2 */ readonly Failed: number; - /** @description Error response payload for the BigCommerce API. - * */ + /** @description Error response payload for the BigCommerce API. */ readonly Error: { /** * Format: int32 * @description The HTTP status code for the error. - * * @example 422 */ readonly status?: number; /** * @description The error title describing the particular error. - * * @example Bulk operation has failed */ readonly title?: string; /** * @description The error type. - * * @example https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes */ readonly type?: string; @@ -704,7 +673,6 @@ export interface components { }; /** * @description Error detail response payload for the BigCommerce API. - * * @example { * "1": "Unauthorized to delete", * "2": "Metafield does not exist" @@ -734,56 +702,46 @@ export interface components { readonly pagination?: { /** * @description Total number of items in the result set. - * * @example 36 */ readonly total?: number; /** * @description Total number of items in the collection response. - * * @example 36 */ readonly count?: number; /** * @description The amount of items returned in the collection per page, controlled by the limit parameter. - * * @example 50 */ readonly per_page?: number; /** * @description The page you are currently on within the collection. - * * @example 1 */ readonly current_page?: number; /** * @description The total number of pages in the collection. - * * @example 1 */ readonly total_pages?: number; - /** @description Pagination links for the previous and next parts of the whole collection. - * */ + /** @description Pagination links for the previous and next parts of the whole collection. */ readonly links?: { - /** @description Link to the previous page returned in the response. - * */ + /** @description Link to the previous page returned in the response. */ readonly previous?: string; /** * @description Link to the current page returned in the response. - * * @example ?page=1&limit=50 */ readonly current?: string; - /** @description Link to the next page returned in the response. - * */ + /** @description Link to the next page returned in the response. */ readonly next?: string; }; }; } & { readonly [key: string]: unknown; }; - /** @description Common Metafield properties. - * */ + /** @description Common Metafield properties. */ readonly MetafieldBase_Post: { /** * @description Determines the visibility and writeability of the field by other API consumers. @@ -794,47 +752,39 @@ export interface components { * | `write` | Open for reading and writing by other API consumers. | * | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | * | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | - * * @enum {string} */ readonly permission_set: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; /** * @description Namespace for the metafield, for organizational purposes. - * * @example Sales Department */ readonly namespace: string; /** * @description The name of the field, for example: `location_id`, `color`. - * * @example Staff Name */ readonly key: string; /** * @description The value of the field, for example: `1`, `blue`. - * * @example Ronaldo */ readonly value: string; /** * @description Description for the metafields. - * * @example Name of Staff Member */ readonly description?: string; }; - /** @description The model for a POST to create metafield. - * */ + /** @description The model for a POST to create metafield. */ readonly MetafieldPost: components["schemas"]["MetafieldBase_Post"] & { /** * @description The ID for the resource with which the metafield is associated. - * * @example 42 */ readonly resource_id: number; }; - /** @description Common Metafield properties. - * */ + /** @description Common Metafield properties. */ readonly MetafieldBase_Put: { /** * @description Determines the visibility and writeability of the field by other API consumers. @@ -845,41 +795,34 @@ export interface components { * | `write` | Open for reading and writing by other API consumers. | * | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | * | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | - * * @enum {string} */ readonly permission_set?: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; /** * @description Namespace for the metafield, for organizational purposes. - * * @example Sales Department */ readonly namespace?: string; /** * @description The name of the field, for example: `location_id`, `color`. - * * @example Staff Name */ readonly key?: string; /** * @description The value of the field, for example: `1`, `blue`. - * * @example Ronaldo */ readonly value?: string; /** * @description Description for the metafields. - * * @example Name of Staff Member */ readonly description?: string; }; - /** @description The model for a PUT to create metafield. - * */ + /** @description The model for a PUT to create metafield. */ readonly MetafieldPut: components["schemas"]["MetafieldBase_Put"] & { /** * @description The ID of metafield to update. - * * @example 42 */ readonly id: number; @@ -889,8 +832,7 @@ export interface components { * @description Error payload for the BigCommerce API. */ readonly NotFound: { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -1166,61 +1108,44 @@ export interface components { readonly EmptyMeta: { readonly [key: string]: unknown; }; - /** @description Data about the pagination. - * */ + /** @description Data about the pagination. */ readonly pagination_Full: { - /** @description The maximum number of items per page. - * */ + /** @description The maximum number of items per page. */ readonly per_page?: number; - /** @description Total number of items in the result set. - * */ + /** @description Total number of items in the result set. */ readonly total?: number; - /** @description Total number of items in the collection response. - * */ + /** @description Total number of items in the collection response. */ readonly count?: number; - /** @description The total number of pages in the collection. - * */ + /** @description The total number of pages in the collection. */ readonly total_pages?: number; /** @description The current page number. */ readonly current_page?: number; - /** @description Pagination links for the previous, current, or next parts of the whole collection. - * */ + /** @description Pagination links for the previous, current, or next parts of the whole collection. */ readonly links?: { - /** @description Link to the previous page returned in the response. - * */ + /** @description Link to the previous page returned in the response. */ readonly previous?: string; - /** @description Link to the current page returned in the response. - * */ + /** @description Link to the current page returned in the response. */ readonly current?: string; - /** @description Link to the next page returned in the response. - * */ + /** @description Link to the next page returned in the response. */ readonly next?: string; }; }; - /** @description Data about the pagination. - * */ + /** @description Data about the pagination. */ readonly pagination_Partial: { - /** @description Total number of items in the collection response. - * */ + /** @description Total number of items in the collection response. */ readonly count?: number; - /** @description Total number of items in the result set. - * */ + /** @description Total number of items in the result set. */ readonly total?: number; - /** @description Pagination links for the previous, current, or next parts of the whole collection. - * */ + /** @description Pagination links for the previous, current, or next parts of the whole collection. */ readonly links?: { - /** @description Link to the previous page returned in the response. - * */ + /** @description Link to the previous page returned in the response. */ readonly previous?: string; - /** @description Link to the current page returned in the response. - * */ + /** @description Link to the current page returned in the response. */ readonly current?: string; - /** @description Link to the next page returned in the response. - * */ + /** @description Link to the next page returned in the response. */ readonly next?: string; }; - /** @description The total number of pages in the collection. - * */ + /** @description The total number of pages in the collection. */ readonly total_pages?: number; }; readonly Site: { @@ -1355,13 +1280,11 @@ export interface components { readonly namespace: string; /** * @description The name of the field. - * * @example Location */ readonly key: string; /** * @description The value of the field. - * * @example 4HG */ readonly value: string; @@ -1380,7 +1303,6 @@ export interface components { readonly permission_set: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; /** * @description Description for the metafield. - * * @example Location in the warehouse */ readonly description?: string; @@ -1397,13 +1319,11 @@ export interface components { readonly namespace?: string; /** * @description The name of the field. - * * @example Location */ readonly key?: string; /** * @description The value of the field. - * * @example 4HG */ readonly value?: string; @@ -1422,7 +1342,6 @@ export interface components { readonly permission_set?: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; /** * @description Description for the metafield. - * * @example Location in the warehouse. */ readonly description?: string; @@ -1711,46 +1630,39 @@ export interface components { readonly namespace?: string; /** * @description The name of the field, for example: `location_id`, `color`. - * * @example Location */ readonly key?: string; /** * @description The value of the field. - * * @example 4HG */ readonly value?: string; /** * @description Description for the metafields. - * * @example Location in the warehouse */ readonly description?: string; /** * @description The type of resource with which the metafield is associated. - * * @example product * @enum {string} */ readonly resource_type?: "category" | "brand" | "product" | "variant"; /** * @description The ID for the resource with which the metafield is associated. - * * @example 111 */ readonly resource_id?: number; /** * Format: date-time * @description Date and time of the metafieldʼs creation. Read-Only. - * * @example 2018-05-07T20:14:17.000Z */ readonly date_created?: string; /** * Format: date-time * @description Date and time when the metafield was last updated. Read-Only. - * * @example 2018-05-07T20:14:17.000Z */ readonly date_modified?: string; @@ -1776,14 +1688,11 @@ export interface components { readonly Accept: string; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly ContentType: string; - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly PageParam: number; - /** @description The ID of the `Metafield`. - * */ + /** @description The ID of the `Metafield`. */ readonly MetafieldIdParam: number; - /** @description Filter based on a metafieldʼs key. - * */ + /** @description Filter based on a metafieldʼs key. */ readonly MetafieldKeyParam: string; /** @description Filter based on comma-separated metafieldʼs keys. Could be used with vanilla `key` query parameter. */ readonly MetafieldKeyInParam: readonly string[]; @@ -1791,8 +1700,7 @@ export interface components { readonly MetafieldNamespaceParam: string; /** @description Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. */ readonly MetafieldNamespaceInParam: readonly string[]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly LimitParam: number; /** @description Sort direction. Acceptable values are: `asc`, `desc`. */ readonly DirectionParam: "asc" | "desc"; @@ -2441,8 +2349,7 @@ export interface operations { }; readonly responses: { readonly 200: components["responses"]["channel_menus_Resp"]; - /** @description Unprocessable entity (The following fields are invalid.) - * */ + /** @description Unprocessable entity (The following fields are invalid.) */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -2484,14 +2391,11 @@ export interface operations { readonly getChannelMetafields: { readonly parameters: { readonly query?: { - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; - /** @description Filter based on a metafieldʼs key. - * */ + /** @description Filter based on a metafieldʼs key. */ readonly key?: components["parameters"]["MetafieldKeyParam"]; /** @description Filter based on a metafieldʼs namespace. */ readonly namespace?: components["parameters"]["MetafieldNamespaceParam"]; @@ -2541,12 +2445,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2555,8 +2461,7 @@ export interface operations { }; }; }; - /** @description The `Metafield` conflicts with another `Metafield`. This can result from duplicate unique key combinations of the appʼs client id, namespace, key, resource_type, and resource_id. - * */ + /** @description The `Metafield` conflicts with another `Metafield`. This can result from duplicate unique key combinations of the appʼs client id, namespace, key, resource_type, and resource_id. */ readonly 409: { headers: { readonly [name: string]: unknown; @@ -2565,8 +2470,7 @@ export interface operations { readonly "application/json": components["schemas"]["ErrorResponse"]; }; }; - /** @description The `Metafield` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description The `Metafield` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -2594,8 +2498,7 @@ export interface operations { readonly requestBody?: never; readonly responses: { readonly 200: components["responses"]["metafield_200"]; - /** @description Not found (A metafield was not found with this query). - * */ + /** @description Not found (A metafield was not found with this query). */ readonly 404: { headers: { readonly [name: string]: unknown; @@ -2635,12 +2538,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2649,8 +2554,7 @@ export interface operations { }; }; }; - /** @description Not found (A metafield was not found with this query). - * */ + /** @description Not found (A metafield was not found with this query). */ readonly 404: { headers: { readonly [name: string]: unknown; @@ -2684,8 +2588,7 @@ export interface operations { }; content?: never; }; - /** @description Not found (A metafield was not found with this query). - * */ + /** @description Not found (A metafield was not found with this query). */ readonly 404: { headers: { readonly [name: string]: unknown; @@ -2699,14 +2602,11 @@ export interface operations { readonly getChannelsMetafields: { readonly parameters: { readonly query?: { - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; - /** @description Filter based on a metafieldʼs key. - * */ + /** @description Filter based on a metafieldʼs key. */ readonly key?: components["parameters"]["MetafieldKeyParam"]; /** @description Filter based on comma-separated metafieldʼs keys. Could be used with vanilla `key` query parameter. */ readonly "key:in"?: components["parameters"]["MetafieldKeyInParam"]; @@ -2733,8 +2633,7 @@ export interface operations { }; readonly requestBody?: never; readonly responses: { - /** @description List of `Metafield` objects. - * */ + /** @description List of `Metafield` objects. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -2758,8 +2657,7 @@ export interface operations { }; }; readonly responses: { - /** @description List of updated `Metafield` objects. - * */ + /** @description List of updated `Metafield` objects. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -2774,12 +2672,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2788,8 +2688,7 @@ export interface operations { }; }; }; - /** @description Response object for metafields creation with partial success. - * */ + /** @description Response object for metafields creation with partial success. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -2813,8 +2712,7 @@ export interface operations { }; }; readonly responses: { - /** @description List of created `Metafield` objects. - * */ + /** @description List of created `Metafield` objects. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -2829,12 +2727,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2868,8 +2768,7 @@ export interface operations { }; }; readonly responses: { - /** @description Response object for metafields deletion with success. - * */ + /** @description Response object for metafields deletion with success. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -2884,12 +2783,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2898,8 +2799,7 @@ export interface operations { }; }; }; - /** @description Response object for metafields deletion with partial success. - * */ + /** @description Response object for metafields deletion with partial success. */ readonly 422: { headers: { readonly [name: string]: unknown; diff --git a/src/internal/reference/generated/checkouts.sf.ts b/src/internal/reference/generated/checkouts.sf.ts index 674f064..d0ad3d3 100644 --- a/src/internal/reference/generated/checkouts.sf.ts +++ b/src/internal/reference/generated/checkouts.sf.ts @@ -148,7 +148,8 @@ export interface paths { readonly "/checkouts/{checkoutId}/consignments": { readonly parameters: { readonly query?: { - /** @description * `cart.lineItems.physicalItems.options` - physical options + /** + * @description * `cart.lineItems.physicalItems.options` - physical options * * `cart.lineItems.digitalItems.options` - digital options * * `cart.lineItems.physicalItems.categoryNames` - physical categories * * `cart.lineItems.digitalItems.categoryNames` - digital categories @@ -158,7 +159,8 @@ export interface paths { * * `payments` - payments * * `promotions` - promotions * * `consignments.availableShippingOptions` - shipping options - * * `consignments.availablePickupOptions` - pickup options */ + * * `consignments.availablePickupOptions` - pickup options + */ readonly include?: components["parameters"]["IncludeShippingDefault"]; }; readonly header: { @@ -210,7 +212,6 @@ export interface paths { * > * The Send a Test Request feature is not currently supported for this endpoint. * > * Please note that this API endpoint is not concurrent safe, meaning multiple simultaneous requests could result in unexpected and inconsistent results. * > * This endpoint requires using Stencil CLI, a local session, and a csrf token to work. - * */ readonly post: operations["createCheckoutConsignment"]; }; @@ -381,7 +382,6 @@ export interface paths { * > * Substitute your storefront domain for `yourstore.example.com`. * > * The Send a Test Request feature is not currently supported for this endpoint. * > * This endpoint requires using Stencil CLI, a local session, and a csrf token to work. - * */ readonly delete: operations["deleteCheckoutCoupon"]; }; @@ -485,12 +485,10 @@ export interface components { readonly handlingCostTotal?: number; /** Format: uuid */ readonly id?: string; - /** @description `true` value indicates StoreCredit has been applied. - * */ + /** @description `true` value indicates StoreCredit has been applied. */ readonly isStoreCreditApplied?: boolean; readonly orderId?: string | null; - /** @description `grandTotal` subtract the store-credit amount - * */ + /** @description `grandTotal` subtract the store-credit amount */ readonly outstandingBalance?: number; readonly payments?: readonly { /** @description Payment provider ID. */ @@ -562,14 +560,16 @@ export interface components { readonly code: string; /** @description The coupon name displayed on the storefront. */ readonly displayName?: string; - /** @description |Type `int`|Type Name| + /** + * @description |Type `int`|Type Name| * |-|-| * |`0`|`per_item_discount`| * |`1`|`percentage_discount`| * |`2`|`per_total_discount`| * |`3`|`shipping_discount`| * |`4`|`free_shipping`| - * |`5`|`promotion`| */ + * |`5`|`promotion`| + */ readonly couponType?: number; /** * Format: double @@ -819,10 +819,12 @@ export interface components { * @example true */ readonly wrapTogether: boolean; - /** @description Details for the gift wrapping option selected. This can be specified for each line item or together based on wrapTogether value. + /** + * @description Details for the gift wrapping option selected. This can be specified for each line item or together based on wrapTogether value. * If wrapTogether is false, each element in the wrapDetails array determines each item's specific wrapping. * (e.g if this line item has 6 quantity, you can pass at maximum 6 elements for the array to spefified each one's wrapping) - * If wrapTogether is true, we will only use 1st element in the wrapDetails array to determine what to be wrapped */ + * If wrapTogether is true, we will only use 1st element in the wrapDetails array to determine what to be wrapped + */ readonly wrapDetails: readonly { /** * @description Identifier of the gift wrapping option selected. @@ -1210,11 +1212,13 @@ export interface components { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 409, * "title": "The request cannot be processed due to a possible conflict. Please review the changes and try again.", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -1242,7 +1246,8 @@ export interface components { readonly GiftCertificateCodePath: string; /** @description The code of the subject coupon. */ readonly CouponCodePath: string; - /** @description * `cart.lineItems.physicalItems.options` - physical options + /** + * @description * `cart.lineItems.physicalItems.options` - physical options * * `cart.lineItems.digitalItems.options` - digital options * * `cart.lineItems.physicalItems.categoryNames` - physical categories * * `cart.lineItems.digitalItems.categoryNames` - digital categories @@ -1252,9 +1257,11 @@ export interface components { * * `payments` - payments * * `promotions` - promotions * * `consignments.availableShippingOptions` - shipping options - * * `consignments.availablePickupOptions` - pickup options */ + * * `consignments.availablePickupOptions` - pickup options + */ readonly IncludeShippingDefault: readonly ("cart.lineItems.physicalItems.options" | "cart.lineItems.digitalItems.options" | "cart.lineItems.physicalItems.categoryNames" | "cart.lineItems.digitalItems.categoryNames" | "cart.lineItems.customItems.categoryNames" | "customer" | "customer.customerGroup" | "payments" | "promotions" | "consignments.availableShippingOptions" | "consignments.availablePickupOptions")[]; - /** @description * `cart.lineItems.physicalItems.options` - physical options + /** + * @description * `cart.lineItems.physicalItems.options` - physical options * * `cart.lineItems.digitalItems.options` - digital options * * `cart.lineItems.physicalItems.categoryNames` - physical categories * * `cart.lineItems.digitalItems.categoryNames` - digital categories @@ -1264,7 +1271,8 @@ export interface components { * * `payments` - payments * * `promotions` - promotions * * `consignments.availableShippingOptions` - shipping options - * * `consignments.availablePickupOptions` - pickup options */ + * * `consignments.availablePickupOptions` - pickup options + */ readonly IncludeShippingPickupDefault: readonly ("cart.lineItems.physicalItems.options" | "cart.lineItems.digitalItems.options" | "cart.lineItems.physicalItems.categoryNames" | "cart.lineItems.digitalItems.categoryNames" | "cart.lineItems.customItems.categoryNames" | "customer" | "customer.customerGroup" | "payments" | "promotions" | "consignments.availableShippingOptions" | "consignments.availablePickupOptions")[]; }; requestBodies: never; @@ -1276,7 +1284,8 @@ export interface operations { readonly getCheckout: { readonly parameters: { readonly query?: { - /** @description * `cart.lineItems.physicalItems.options` - physical options + /** + * @description * `cart.lineItems.physicalItems.options` - physical options * * `cart.lineItems.digitalItems.options` - digital options * * `cart.lineItems.physicalItems.categoryNames` - physical categories * * `cart.lineItems.digitalItems.categoryNames` - digital categories @@ -1286,7 +1295,8 @@ export interface operations { * * `payments` - payments * * `promotions` - promotions * * `consignments.availableShippingOptions` - shipping options - * * `consignments.availablePickupOptions` - pickup options */ + * * `consignments.availablePickupOptions` - pickup options + */ readonly include?: components["parameters"]["IncludeShippingDefault"]; }; readonly header?: { @@ -1306,7 +1316,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "value": { * "billingAddress": { * "address1": "123 Main Street", @@ -1710,7 +1721,8 @@ export interface operations { * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * } - * } */ + * } + */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; @@ -1759,7 +1771,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "value": { * "billingAddress": { * "address1": "123 Main Street", @@ -2163,7 +2176,8 @@ export interface operations { * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * } - * } */ + * } + */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; @@ -2200,7 +2214,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "value": { * "billingAddress": { * "address1": "123 Main Street", @@ -2604,7 +2619,8 @@ export interface operations { * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * } - * } */ + * } + */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; @@ -2635,7 +2651,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "value": { * "billingAddress": { * "address1": "123 Main Street", @@ -3039,7 +3056,8 @@ export interface operations { * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * } - * } */ + * } + */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; @@ -3071,7 +3089,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "value": { * "billingAddress": { * "address1": "123 Main Street", @@ -3475,7 +3494,8 @@ export interface operations { * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * } - * } */ + * } + */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; @@ -3524,7 +3544,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "value": { * "billingAddress": { * "address1": "123 Main Street", @@ -3928,7 +3949,8 @@ export interface operations { * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * } - * } */ + * } + */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; @@ -3952,7 +3974,8 @@ export interface operations { readonly createCheckoutConsignment: { readonly parameters: { readonly query?: { - /** @description * `cart.lineItems.physicalItems.options` - physical options + /** + * @description * `cart.lineItems.physicalItems.options` - physical options * * `cart.lineItems.digitalItems.options` - digital options * * `cart.lineItems.physicalItems.categoryNames` - physical categories * * `cart.lineItems.digitalItems.categoryNames` - digital categories @@ -3962,7 +3985,8 @@ export interface operations { * * `payments` - payments * * `promotions` - promotions * * `consignments.availableShippingOptions` - shipping options - * * `consignments.availablePickupOptions` - pickup options */ + * * `consignments.availablePickupOptions` - pickup options + */ readonly include?: components["parameters"]["IncludeShippingDefault"]; }; readonly header?: { @@ -3988,7 +4012,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "value": { * "billingAddress": { * "address1": "123 Main Street", @@ -4392,7 +4417,8 @@ export interface operations { * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * } - * } */ + * } + */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; @@ -4402,7 +4428,8 @@ export interface operations { readonly updateCheckoutConsignment: { readonly parameters: { readonly query?: { - /** @description * `cart.lineItems.physicalItems.options` - physical options + /** + * @description * `cart.lineItems.physicalItems.options` - physical options * * `cart.lineItems.digitalItems.options` - digital options * * `cart.lineItems.physicalItems.categoryNames` - physical categories * * `cart.lineItems.digitalItems.categoryNames` - digital categories @@ -4412,7 +4439,8 @@ export interface operations { * * `payments` - payments * * `promotions` - promotions * * `consignments.availableShippingOptions` - shipping options - * * `consignments.availablePickupOptions` - pickup options */ + * * `consignments.availablePickupOptions` - pickup options + */ readonly include?: components["parameters"]["IncludeShippingPickupDefault"]; }; readonly header?: { @@ -4440,7 +4468,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "value": { * "billingAddress": { * "address1": "123 Main Street", @@ -4844,7 +4873,8 @@ export interface operations { * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * } - * } */ + * } + */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; @@ -4877,7 +4907,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "value": { * "billingAddress": { * "address1": "123 Main Street", @@ -5281,7 +5312,8 @@ export interface operations { * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * } - * } */ + * } + */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; @@ -5314,7 +5346,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "value": { * "billingAddress": { * "address1": "123 Main Street", @@ -5718,7 +5751,8 @@ export interface operations { * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * } - * } */ + * } + */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; @@ -5793,7 +5827,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "value": { * "billingAddress": { * "address1": "123 Main Street", @@ -6197,7 +6232,8 @@ export interface operations { * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * } - * } */ + * } + */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; @@ -6230,7 +6266,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "value": { * "billingAddress": { * "address1": "123 Main Street", @@ -6634,7 +6671,8 @@ export interface operations { * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * } - * } */ + * } + */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; diff --git a/src/internal/reference/generated/checkouts.v3.ts b/src/internal/reference/generated/checkouts.v3.ts index 561c915..d7744d7 100644 --- a/src/internal/reference/generated/checkouts.v3.ts +++ b/src/internal/reference/generated/checkouts.v3.ts @@ -226,7 +226,6 @@ export interface paths { * * > #### Note * > * The `Try It` feature is not currently supported for this endpoint. - * */ readonly delete: operations["CheckoutsFeesByCheckoutIdDelete"]; }; @@ -1156,7 +1155,8 @@ export interface components { readonly "application/json": { readonly data?: components["schemas"]["Checkout"]; }; - /** @example { + /** + * @example { * "data": { * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", * "cart": { @@ -1328,9 +1328,11 @@ export interface components { * "customer_message": "" * }, * "meta": {} - * } */ + * } + */ readonly "Available Shipping Options": unknown; - /** @example { + /** + * @example { * "data": { * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", * "cart": { @@ -1465,9 +1467,11 @@ export interface components { * "customer_message": "" * }, * "meta": {} - * } */ + * } + */ readonly "Selected Shipping Options": unknown; - /** @example { + /** + * @example { * "data": { * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", * "cart": { @@ -1612,9 +1616,11 @@ export interface components { * "customer_message": "" * }, * "meta": {} - * } */ + * } + */ readonly "Coupon Applied": unknown; - /** @example { + /** + * @example { * "data": { * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", * "cart": { @@ -1717,9 +1723,11 @@ export interface components { * "customer_message": "" * }, * "meta": {} - * } */ + * } + */ readonly "No Coupon Applied": unknown; - /** @example { + /** + * @example { * "data": { * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", * "cart": { @@ -1837,9 +1845,11 @@ export interface components { * ] * }, * "meta": {} - * } */ + * } + */ readonly "Include promotions": unknown; - /** @example { + /** + * @example { * "data": { * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", * "cart": { @@ -2099,7 +2109,8 @@ export interface components { * ], * "version": 1 * } - * } */ + * } + */ readonly "example-1": unknown; }; }; @@ -2109,11 +2120,13 @@ export interface components { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 409, * "title": "The request cannot be processed due to a possible conflict. Please review the changes and try again.", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2126,7 +2139,8 @@ export interface components { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "custom_checkout_script_url": "https://example.com/custom-checkout-script.js", * "order_confirmation_use_custom_checkout_script": false, @@ -2134,19 +2148,22 @@ export interface components { * "custom_checkout_supports_uco_settings": false * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: components["schemas"]["CheckoutsSettings"]; readonly meta?: Record; }; - /** @example { + /** + * @example { * "data": { * "custom_checkout_script_url": "webdav:vtz-checkout/dist/auto-loader.js", * "order_confirmation_use_custom_checkout_script": false, * "custom_order_confirmation_script_url": "webdav:vtz-order-confirmation/dist/auto-loader.js" * }, * "meta": {} - * } */ + * } + */ readonly "WebDAV protocol": unknown; }; }; @@ -2155,12 +2172,14 @@ export interface components { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 75 * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: components["schemas"]["Order"]; readonly meta?: Record; @@ -2181,10 +2200,12 @@ export interface components { readonly "Content-Type": string; /** @description Include the shipping options available to this checkout. */ readonly IncludeShippingOptions: "consignments.available_shipping_options"; - /** @description * `cart.line_items.physical_items.options` - physical options + /** + * @description * `cart.line_items.physical_items.options` - physical options * * `cart.line_items.digital_items.options` - digital options * * `consignments.available_shipping_options` - shipping options - * * `promotions.banners` - promotion options */ + * * `promotions.banners` - promotion options + */ readonly IncludeGeneral: readonly ("cart.line_items.physical_items.options" | "cart.line_items.digital_items.options" | "consignments.available_shipping_options" | "promotions.banners")[]; }; requestBodies: never; @@ -2196,10 +2217,12 @@ export interface operations { readonly getCheckout: { readonly parameters: { readonly query?: { - /** @description * `cart.line_items.physical_items.options` - physical options + /** + * @description * `cart.line_items.physical_items.options` - physical options * * `cart.line_items.digital_items.options` - digital options * * `consignments.available_shipping_options` - shipping options - * * `promotions.banners` - promotion options */ + * * `promotions.banners` - promotion options + */ readonly include?: components["parameters"]["IncludeGeneral"]; }; readonly header?: { @@ -2223,7 +2246,8 @@ export interface operations { readonly data?: components["schemas"]["Checkout"]; readonly meta?: components["schemas"]["MetaOpen"]; }; - /** @example { + /** + * @example { * "data": { * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", * "cart": { @@ -2395,9 +2419,11 @@ export interface operations { * "customer_message": "" * }, * "meta": {} - * } */ + * } + */ readonly "Available Shipping Options": unknown; - /** @example { + /** + * @example { * "data": { * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", * "cart": { @@ -2532,9 +2558,11 @@ export interface operations { * "customer_message": "" * }, * "meta": {} - * } */ + * } + */ readonly "Selected Shipping Options": unknown; - /** @example { + /** + * @example { * "data": { * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", * "cart": { @@ -2679,9 +2707,11 @@ export interface operations { * "customer_message": "" * }, * "meta": {} - * } */ + * } + */ readonly "Coupon Applied": unknown; - /** @example { + /** + * @example { * "data": { * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", * "cart": { @@ -2784,9 +2814,11 @@ export interface operations { * "customer_message": "" * }, * "meta": {} - * } */ + * } + */ readonly "No Coupon Applied": unknown; - /** @example { + /** + * @example { * "data": { * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", * "cart": { @@ -2904,9 +2936,11 @@ export interface operations { * ] * }, * "meta": {} - * } */ + * } + */ readonly "Include promotions": unknown; - /** @example { + /** + * @example { * "data": { * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", * "cart": { @@ -3166,7 +3200,8 @@ export interface operations { * ], * "version": 1 * } - * } */ + * } + */ readonly "example-1": unknown; }; }; @@ -3220,7 +3255,8 @@ export interface operations { readonly data?: components["schemas"]["Checkout"]; readonly meta?: components["schemas"]["MetaOpen"]; }; - /** @example { + /** + * @example { * "data": { * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", * "cart": { @@ -3393,9 +3429,11 @@ export interface operations { * "version": 1 * }, * "meta": {} - * } */ + * } + */ readonly "Available Shipping Options": unknown; - /** @example { + /** + * @example { * "data": { * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", * "cart": { @@ -3531,9 +3569,11 @@ export interface operations { * "version": 1 * }, * "meta": {} - * } */ + * } + */ readonly "Selected Shipping Options": unknown; - /** @example { + /** + * @example { * "data": { * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", * "cart": { @@ -3679,9 +3719,11 @@ export interface operations { * "version": 1 * }, * "meta": {} - * } */ + * } + */ readonly "Coupon Applied": unknown; - /** @example { + /** + * @example { * "data": { * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", * "cart": { @@ -3785,9 +3827,11 @@ export interface operations { * "version": 1 * }, * "meta": {} - * } */ + * } + */ readonly "No Coupon Applied": unknown; - /** @example { + /** + * @example { * "data": { * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", * "cart": { @@ -3906,9 +3950,11 @@ export interface operations { * "version": 1 * }, * "meta": {} - * } */ + * } + */ readonly "Include promotions": unknown; - /** @example { + /** + * @example { * "data": { * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", * "cart": { @@ -4168,7 +4214,8 @@ export interface operations { * ], * "version": 1 * } - * } */ + * } + */ readonly "example-1": unknown; }; }; @@ -4192,7 +4239,8 @@ export interface operations { }; readonly requestBody?: { readonly content: { - /** @example { + /** + * @example { * "cart": { * "discounts": [ * { @@ -4201,7 +4249,8 @@ export interface operations { * ] * }, * "version": 1 - * } */ + * } + */ readonly "application/json": { readonly cart?: { readonly discounts?: readonly { @@ -4229,7 +4278,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", * "cart": { @@ -4327,12 +4377,14 @@ export interface operations { * "fees": [] * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: components["schemas"]["Checkout"]; readonly meta?: components["schemas"]["MetaOpen"]; }; - /** @example { + /** + * @example { * "data": { * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", * "cart": { @@ -4504,9 +4556,11 @@ export interface operations { * "customer_message": "" * }, * "meta": {} - * } */ + * } + */ readonly "Available Shipping Options": unknown; - /** @example { + /** + * @example { * "data": { * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", * "cart": { @@ -4641,9 +4695,11 @@ export interface operations { * "customer_message": "" * }, * "meta": {} - * } */ + * } + */ readonly "Selected Shipping Options": unknown; - /** @example { + /** + * @example { * "data": { * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", * "cart": { @@ -4788,9 +4844,11 @@ export interface operations { * "customer_message": "" * }, * "meta": {} - * } */ + * } + */ readonly "Coupon Applied": unknown; - /** @example { + /** + * @example { * "data": { * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", * "cart": { @@ -4893,9 +4951,11 @@ export interface operations { * "customer_message": "" * }, * "meta": {} - * } */ + * } + */ readonly "No Coupon Applied": unknown; - /** @example { + /** + * @example { * "data": { * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", * "cart": { @@ -5013,9 +5073,11 @@ export interface operations { * ] * }, * "meta": {} - * } */ + * } + */ readonly "Include promotions": unknown; - /** @example { + /** + * @example { * "data": { * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", * "cart": { @@ -5275,7 +5337,8 @@ export interface operations { * ], * "version": 1 * } - * } */ + * } + */ readonly "example-1": unknown; }; }; @@ -5312,7 +5375,8 @@ export interface operations { readonly data?: components["schemas"]["Checkout"]; readonly meta?: components["schemas"]["MetaOpen"]; }; - /** @example { + /** + * @example { * "data": { * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", * "cart": { @@ -5485,9 +5549,11 @@ export interface operations { * "version": 1 * }, * "meta": {} - * } */ + * } + */ readonly "Available Shipping Options": unknown; - /** @example { + /** + * @example { * "data": { * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", * "cart": { @@ -5623,9 +5689,11 @@ export interface operations { * "version": 1 * }, * "meta": {} - * } */ + * } + */ readonly "Selected Shipping Options": unknown; - /** @example { + /** + * @example { * "data": { * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", * "cart": { @@ -5771,9 +5839,11 @@ export interface operations { * "version": 1 * }, * "meta": {} - * } */ + * } + */ readonly "Coupon Applied": unknown; - /** @example { + /** + * @example { * "data": { * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", * "cart": { @@ -5877,9 +5947,11 @@ export interface operations { * "version": 1 * }, * "meta": {} - * } */ + * } + */ readonly "No Coupon Applied": unknown; - /** @example { + /** + * @example { * "data": { * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", * "cart": { @@ -5998,9 +6070,11 @@ export interface operations { * "version": 1 * }, * "meta": {} - * } */ + * } + */ readonly "Include promotions": unknown; - /** @example { + /** + * @example { * "data": { * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", * "cart": { @@ -6260,7 +6334,8 @@ export interface operations { * ], * "version": 1 * } - * } */ + * } + */ readonly "example-1": unknown; }; }; @@ -6298,7 +6373,8 @@ export interface operations { readonly data?: components["schemas"]["Checkout"]; readonly meta?: components["schemas"]["MetaOpen"]; }; - /** @example { + /** + * @example { * "data": { * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", * "cart": { @@ -6471,9 +6547,11 @@ export interface operations { * "version": 1 * }, * "meta": {} - * } */ + * } + */ readonly "Available Shipping Options": unknown; - /** @example { + /** + * @example { * "data": { * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", * "cart": { @@ -6609,9 +6687,11 @@ export interface operations { * "version": 1 * }, * "meta": {} - * } */ + * } + */ readonly "Selected Shipping Options": unknown; - /** @example { + /** + * @example { * "data": { * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", * "cart": { @@ -6757,9 +6837,11 @@ export interface operations { * "version": 1 * }, * "meta": {} - * } */ + * } + */ readonly "Coupon Applied": unknown; - /** @example { + /** + * @example { * "data": { * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", * "cart": { @@ -6863,9 +6945,11 @@ export interface operations { * "version": 1 * }, * "meta": {} - * } */ + * } + */ readonly "No Coupon Applied": unknown; - /** @example { + /** + * @example { * "data": { * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", * "cart": { @@ -6984,9 +7068,11 @@ export interface operations { * "version": 1 * }, * "meta": {} - * } */ + * } + */ readonly "Include promotions": unknown; - /** @example { + /** + * @example { * "data": { * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", * "cart": { @@ -7246,7 +7332,8 @@ export interface operations { * ], * "version": 1 * } - * } */ + * } + */ readonly "example-1": unknown; }; }; @@ -7286,7 +7373,8 @@ export interface operations { readonly data?: components["schemas"]["Checkout"]; readonly meta?: components["schemas"]["MetaOpen"]; }; - /** @example { + /** + * @example { * "data": { * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", * "cart": { @@ -7458,9 +7546,11 @@ export interface operations { * "customer_message": "" * }, * "meta": {} - * } */ + * } + */ readonly "Available Shipping Options": unknown; - /** @example { + /** + * @example { * "data": { * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", * "cart": { @@ -7595,9 +7685,11 @@ export interface operations { * "customer_message": "" * }, * "meta": {} - * } */ + * } + */ readonly "Selected Shipping Options": unknown; - /** @example { + /** + * @example { * "data": { * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", * "cart": { @@ -7742,9 +7834,11 @@ export interface operations { * "customer_message": "" * }, * "meta": {} - * } */ + * } + */ readonly "Coupon Applied": unknown; - /** @example { + /** + * @example { * "data": { * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", * "cart": { @@ -7847,9 +7941,11 @@ export interface operations { * "customer_message": "" * }, * "meta": {} - * } */ + * } + */ readonly "No Coupon Applied": unknown; - /** @example { + /** + * @example { * "data": { * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", * "cart": { @@ -7967,9 +8063,11 @@ export interface operations { * ] * }, * "meta": {} - * } */ + * } + */ readonly "Include promotions": unknown; - /** @example { + /** + * @example { * "data": { * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", * "cart": { @@ -8229,7 +8327,8 @@ export interface operations { * ], * "version": 1 * } - * } */ + * } + */ readonly "example-1": unknown; }; }; @@ -8270,7 +8369,8 @@ export interface operations { readonly data?: components["schemas"]["Checkout"]; readonly meta?: components["schemas"]["MetaOpen"]; }; - /** @example { + /** + * @example { * "data": { * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", * "cart": { @@ -8442,9 +8542,11 @@ export interface operations { * "customer_message": "" * }, * "meta": {} - * } */ + * } + */ readonly "Available Shipping Options": unknown; - /** @example { + /** + * @example { * "data": { * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", * "cart": { @@ -8579,9 +8681,11 @@ export interface operations { * "customer_message": "" * }, * "meta": {} - * } */ + * } + */ readonly "Selected Shipping Options": unknown; - /** @example { + /** + * @example { * "data": { * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", * "cart": { @@ -8726,9 +8830,11 @@ export interface operations { * "customer_message": "" * }, * "meta": {} - * } */ + * } + */ readonly "Coupon Applied": unknown; - /** @example { + /** + * @example { * "data": { * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", * "cart": { @@ -8831,9 +8937,11 @@ export interface operations { * "customer_message": "" * }, * "meta": {} - * } */ + * } + */ readonly "No Coupon Applied": unknown; - /** @example { + /** + * @example { * "data": { * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", * "cart": { @@ -8951,9 +9059,11 @@ export interface operations { * ] * }, * "meta": {} - * } */ + * } + */ readonly "Include promotions": unknown; - /** @example { + /** + * @example { * "data": { * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", * "cart": { @@ -9213,7 +9323,8 @@ export interface operations { * ], * "version": 1 * } - * } */ + * } + */ readonly "example-1": unknown; }; }; @@ -9249,7 +9360,8 @@ export interface operations { readonly data?: components["schemas"]["Checkout"]; readonly meta?: components["schemas"]["MetaOpen"]; }; - /** @example { + /** + * @example { * "data": { * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", * "cart": { @@ -9421,9 +9533,11 @@ export interface operations { * "customer_message": "" * }, * "meta": {} - * } */ + * } + */ readonly "Available Shipping Options": unknown; - /** @example { + /** + * @example { * "data": { * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", * "cart": { @@ -9558,9 +9672,11 @@ export interface operations { * "customer_message": "" * }, * "meta": {} - * } */ + * } + */ readonly "Selected Shipping Options": unknown; - /** @example { + /** + * @example { * "data": { * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", * "cart": { @@ -9705,9 +9821,11 @@ export interface operations { * "customer_message": "" * }, * "meta": {} - * } */ + * } + */ readonly "Coupon Applied": unknown; - /** @example { + /** + * @example { * "data": { * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", * "cart": { @@ -9810,9 +9928,11 @@ export interface operations { * "customer_message": "" * }, * "meta": {} - * } */ + * } + */ readonly "No Coupon Applied": unknown; - /** @example { + /** + * @example { * "data": { * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", * "cart": { @@ -9930,9 +10050,11 @@ export interface operations { * ] * }, * "meta": {} - * } */ + * } + */ readonly "Include promotions": unknown; - /** @example { + /** + * @example { * "data": { * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", * "cart": { @@ -10192,7 +10314,8 @@ export interface operations { * ], * "version": 1 * } - * } */ + * } + */ readonly "example-1": unknown; }; }; @@ -10228,7 +10351,8 @@ export interface operations { readonly data?: components["schemas"]["Checkout"]; readonly meta?: components["schemas"]["MetaOpen"]; }; - /** @example { + /** + * @example { * "data": { * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", * "cart": { @@ -10400,9 +10524,11 @@ export interface operations { * "customer_message": "" * }, * "meta": {} - * } */ + * } + */ readonly "Available Shipping Options": unknown; - /** @example { + /** + * @example { * "data": { * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", * "cart": { @@ -10537,9 +10663,11 @@ export interface operations { * "customer_message": "" * }, * "meta": {} - * } */ + * } + */ readonly "Selected Shipping Options": unknown; - /** @example { + /** + * @example { * "data": { * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", * "cart": { @@ -10684,9 +10812,11 @@ export interface operations { * "customer_message": "" * }, * "meta": {} - * } */ + * } + */ readonly "Coupon Applied": unknown; - /** @example { + /** + * @example { * "data": { * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", * "cart": { @@ -10789,9 +10919,11 @@ export interface operations { * "customer_message": "" * }, * "meta": {} - * } */ + * } + */ readonly "No Coupon Applied": unknown; - /** @example { + /** + * @example { * "data": { * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", * "cart": { @@ -10909,9 +11041,11 @@ export interface operations { * ] * }, * "meta": {} - * } */ + * } + */ readonly "Include promotions": unknown; - /** @example { + /** + * @example { * "data": { * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", * "cart": { @@ -11171,7 +11305,8 @@ export interface operations { * ], * "version": 1 * } - * } */ + * } + */ readonly "example-1": unknown; }; }; @@ -11208,7 +11343,8 @@ export interface operations { readonly data?: components["schemas"]["Checkout"]; readonly meta?: components["schemas"]["MetaOpen"]; }; - /** @example { + /** + * @example { * "data": { * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", * "cart": { @@ -11372,9 +11508,11 @@ export interface operations { * "customer_message": "" * }, * "meta": {} - * } */ + * } + */ readonly "Available Shipping Options": unknown; - /** @example { + /** + * @example { * "data": { * "id": "306d57d7-124e-4112-82cd-35e060c0d4d9", * "cart": { @@ -11509,9 +11647,11 @@ export interface operations { * "customer_message": "" * }, * "meta": {} - * } */ + * } + */ readonly "Selected Shipping Options": unknown; - /** @example { + /** + * @example { * "data": { * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", * "cart": { @@ -11656,9 +11796,11 @@ export interface operations { * "customer_message": "" * }, * "meta": {} - * } */ + * } + */ readonly "Coupon Applied": unknown; - /** @example { + /** + * @example { * "data": { * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", * "cart": { @@ -11761,9 +11903,11 @@ export interface operations { * "customer_message": "" * }, * "meta": {} - * } */ + * } + */ readonly "No Coupon Applied": unknown; - /** @example { + /** + * @example { * "data": { * "id": "267c5d6f-0d27-48ea-b731-e7832a4c5537", * "cart": { @@ -11881,7 +12025,8 @@ export interface operations { * ] * }, * "meta": {} - * } */ + * } + */ readonly "Include promotions": unknown; }; }; @@ -12008,12 +12153,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 75 * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: components["schemas"]["Order"]; readonly meta?: components["schemas"]["MetaOpen"]; @@ -12039,7 +12186,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "custom_checkout_script_url": "https://example.com/custom-checkout-script.js", * "order_confirmation_use_custom_checkout_script": false, @@ -12049,19 +12197,22 @@ export interface operations { * "order_confirmation_sri_hash": "sha256-0987654321" * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: components["schemas"]["CheckoutsSettings"]; readonly meta?: components["schemas"]["MetaOpen"]; }; - /** @example { + /** + * @example { * "data": { * "custom_checkout_script_url": "webdav:vtz-checkout/dist/auto-loader.js", * "order_confirmation_use_custom_checkout_script": false, * "custom_order_confirmation_script_url": "webdav:vtz-order-confirmation/dist/auto-loader.js" * }, * "meta": {} - * } */ + * } + */ readonly "WebDAV protocol": unknown; }; }; @@ -12090,7 +12241,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "custom_checkout_script_url": "https://example.com/custom-checkout-script.js", * "order_confirmation_use_custom_checkout_script": false, @@ -12100,19 +12252,22 @@ export interface operations { * "order_confirmation_sri_hash": "sha256-0987654321" * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: components["schemas"]["CheckoutsSettings"]; readonly meta?: components["schemas"]["MetaOpen"]; }; - /** @example { + /** + * @example { * "data": { * "custom_checkout_script_url": "webdav:vtz-checkout/dist/auto-loader.js", * "order_confirmation_use_custom_checkout_script": false, * "custom_order_confirmation_script_url": "webdav:vtz-order-confirmation/dist/auto-loader.js" * }, * "meta": {} - * } */ + * } + */ readonly "WebDAV protocol": unknown; }; }; @@ -12248,7 +12403,6 @@ export interface operations { readonly title?: string; /** * @description A link to a list of BigCommerce API status codes. - * * @example https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes */ readonly type?: string; diff --git a/src/internal/reference/generated/consent.sf.ts b/src/internal/reference/generated/consent.sf.ts index af6e029..f675b0a 100644 --- a/src/internal/reference/generated/consent.sf.ts +++ b/src/internal/reference/generated/consent.sf.ts @@ -31,7 +31,6 @@ export interface paths { * * > #### Note * > * Substitute your storefront domain for `yourstore.example.com`. - * */ readonly post: operations["postCookieConsent"]; }; diff --git a/src/internal/reference/generated/currencies.v2.ts b/src/internal/reference/generated/currencies.v2.ts index d24b21d..7795e32 100644 --- a/src/internal/reference/generated/currencies.v2.ts +++ b/src/internal/reference/generated/currencies.v2.ts @@ -384,11 +384,9 @@ export interface components { readonly StoreHash: string; /** @description The ID of the subject currency. */ readonly CurrencyIdPath: string; - /** @description Specifies the page number in a limited (paginated) list of currencies. - * */ + /** @description Specifies the page number in a limited (paginated) list of currencies. */ readonly PageNumberQuery: number; - /** @description Controls the number of items per page in a limited (paginated) list of currencies. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of currencies. */ readonly LimitQuery: number; readonly Accept: string; readonly ContentType: string; @@ -402,11 +400,9 @@ export interface operations { readonly getCurrencies: { readonly parameters: { readonly query?: { - /** @description Specifies the page number in a limited (paginated) list of currencies. - * */ + /** @description Specifies the page number in a limited (paginated) list of currencies. */ readonly page?: components["parameters"]["PageNumberQuery"]; - /** @description Controls the number of items per page in a limited (paginated) list of currencies. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of currencies. */ readonly limit?: components["parameters"]["LimitQuery"]; }; readonly header?: { diff --git a/src/internal/reference/generated/current_customer.ts b/src/internal/reference/generated/current_customer.ts index 680a8ff..d8cb1da 100644 --- a/src/internal/reference/generated/current_customer.ts +++ b/src/internal/reference/generated/current_customer.ts @@ -57,7 +57,8 @@ export interface operations { }; readonly requestBody?: never; readonly responses: { - /** @description A JWT to decode using the client secret that corresponds with the app client ID you sent as a query parameter. + /** + * @description A JWT to decode using the client secret that corresponds with the app client ID you sent as a query parameter. * * After you decode the JWT, the payload resembles the following: * @@ -78,7 +79,8 @@ export interface operations { * "store_hash": "abc123", * "operation": "current_customer" * } - * ``` */ + * ``` + */ readonly 200: { headers: { readonly [name: string]: unknown; diff --git a/src/internal/reference/generated/custom_template_associations.v3.ts b/src/internal/reference/generated/custom_template_associations.v3.ts index 238062d..bb2eb1d 100644 --- a/src/internal/reference/generated/custom_template_associations.v3.ts +++ b/src/internal/reference/generated/custom_template_associations.v3.ts @@ -73,14 +73,11 @@ export interface components { readonly DetailedErrors: { readonly [key: string]: string; }; - /** @description Error payload for the BigCommerce API. - * */ + /** @description Error payload for the BigCommerce API. */ readonly BaseError: { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; @@ -121,7 +118,7 @@ export interface components { readonly IdInQuery: readonly number[]; /** @description Return results or act upon only template associations in the specified channel. */ readonly ChannelIdQuery: number; - /** @description A comma-separated list of entity IDs to return or act upon. Must be used together with the `type` filter. Currently, all supported entities have integer-type IDs. */ + /** @description A comma-separated list of entity IDs to return or act upon. Must be used together with the `type` filter. Currently, all supported entities have integer-type IDs. */ readonly EntityIdInQuery: readonly number[]; /** @description Filter associations by type. */ readonly TypeQuery: "product" | "category" | "brand" | "page"; @@ -143,7 +140,7 @@ export interface operations { readonly query?: { /** @description Return results or act upon only template associations in the specified channel. */ readonly channel_id?: components["parameters"]["ChannelIdQuery"]; - /** @description A comma-separated list of entity IDs to return or act upon. Must be used together with the `type` filter. Currently, all supported entities have integer-type IDs. */ + /** @description A comma-separated list of entity IDs to return or act upon. Must be used together with the `type` filter. Currently, all supported entities have integer-type IDs. */ readonly "entity_id:in"?: components["parameters"]["EntityIdInQuery"]; /** @description Filter associations by type. */ readonly type?: components["parameters"]["TypeQuery"]; @@ -226,7 +223,7 @@ export interface operations { readonly channel_id?: components["parameters"]["ChannelIdQuery"]; /** @description Filter associations by type. */ readonly type?: components["parameters"]["TypeQuery"]; - /** @description A comma-separated list of entity IDs to return or act upon. Must be used together with the `type` filter. Currently, all supported entities have integer-type IDs. */ + /** @description A comma-separated list of entity IDs to return or act upon. Must be used together with the `type` filter. Currently, all supported entities have integer-type IDs. */ readonly "entity_id:in"?: components["parameters"]["EntityIdInQuery"]; }; readonly header?: { diff --git a/src/internal/reference/generated/customer_login.ts b/src/internal/reference/generated/customer_login.ts index 12684a3..1b316ab 100644 --- a/src/internal/reference/generated/customer_login.ts +++ b/src/internal/reference/generated/customer_login.ts @@ -52,25 +52,21 @@ export interface components { readonly operation?: string; /** * @description Store hash identifying the store you are logging into. - * * @example "abc123" */ readonly store_hash?: string; /** * @description ID of the customer you are logging in, as obtained through the Customer API. - * * @example 2 */ readonly customer_id?: number; /** * @description Optional field containing a relative path for the shopper’s destination after login. Will default to `/account.php`. - * * @default /account.php */ readonly redirect_to: string; /** * @description **(Optional)** Field containing the expected IP address for the request. If provided, BigCommerce will check that it matches the browser trying to log in. If there is not a match, it will be rejected. - * * @example "111.222.333.444" */ readonly request_ip?: string; diff --git a/src/internal/reference/generated/customers.v2.ts b/src/internal/reference/generated/customers.v2.ts index eb7f1fa..cd21c5e 100644 --- a/src/internal/reference/generated/customers.v2.ts +++ b/src/internal/reference/generated/customers.v2.ts @@ -462,8 +462,7 @@ export interface components { readonly id?: number; /** @description Date on which the customer registered from the storefront or was created in the control panel. This is a Read-Only field; do not set or modify its value in a POST or PUT request. */ readonly date_created?: string; - /** @description Date on which the customer updated their details in the storefront or was updated in the control panel. This is a Read-Only field; do not set or modify its value in a POST or PUT request. - * */ + /** @description Date on which the customer updated their details in the storefront or was updated in the control panel. This is a Read-Only field; do not set or modify its value in a POST or PUT request. */ readonly date_modified?: string; } & components["schemas"]["customer_Base"]; /** categoryAccessLevel_Full */ @@ -931,11 +930,9 @@ export interface components { readonly errors?: readonly components["schemas"]["ErrorBasic"][]; }; readonly ErrorBasic: { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -1215,9 +1212,11 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "count": 27 - * } */ + * } + */ readonly "application/json": components["schemas"]["count_Full"]; }; }; @@ -1252,9 +1251,11 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "success": false - * } */ + * } + */ readonly "application/json": components["schemas"]["validatePassword"]; }; }; @@ -1532,9 +1533,11 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "count": 27 - * } */ + * } + */ readonly "application/json": components["schemas"]["count_Full"]; }; }; @@ -1776,9 +1779,11 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "count": 27 - * } */ + * } + */ readonly "application/json": components["schemas"]["count_Full"]; }; }; diff --git a/src/internal/reference/generated/customers.v3.ts b/src/internal/reference/generated/customers.v3.ts index 02ca953..bfca545 100644 --- a/src/internal/reference/generated/customers.v3.ts +++ b/src/internal/reference/generated/customers.v3.ts @@ -190,7 +190,6 @@ export interface paths { * * **Notes:** * * Global customer settings don't apply on a channel when there are channel specific settings configured through [Channel Settings](/docs/rest-management/customers/channel-settings). - * */ readonly get: operations["getCustomersSettings"]; /** @@ -214,7 +213,6 @@ export interface paths { * **Notes:** * * * `null` value configuration indicates that there is no override provided for a given channel; thus, values are inherited from [Global Settings](/docs/rest-management/customers/global-settings). - * */ readonly get: operations["getCustomersSettingsChannel"]; /** @@ -397,7 +395,6 @@ export interface paths { /** * Get a Customer Metafield * @description Returns a single *Customer Metafield*. - * */ readonly get: operations["getMetafieldsCustomerId"]; /** @@ -408,7 +405,6 @@ export interface paths { /** * Delete a Customer Metafield * @description Deletes a customer metafield. To delete a customer metafield, use 'customerId' and 'metafieldId' in the query parameters. - * */ readonly delete: operations["deleteCustomerMetafieldsId"]; }; @@ -644,8 +640,7 @@ export interface components { * ] */ readonly channel_ids?: readonly number[]; - /** @description Array of form fields. Controlled by formfields parameter. - * */ + /** @description Array of form fields. Controlled by formfields parameter. */ readonly form_fields?: readonly components["schemas"]["formFieldValue"][]; /** @description Indicates whether to send a customer registered welcome email. */ readonly trigger_account_created_notification?: boolean; @@ -686,8 +681,7 @@ export interface components { readonly origin_channel_id?: number; /** @description Arrays of channels the customer can access. */ readonly channel_ids?: readonly number[]; - /** @description Array of form fields. Controlled by formfields parameter. - * */ + /** @description Array of form fields. Controlled by formfields parameter. */ readonly form_fields?: readonly components["schemas"]["formFieldValue"][]; }; /** attributeValue_Base */ @@ -867,8 +861,7 @@ export interface components { * @example 1 */ readonly id: number; - /** @description Array of form fields. Controlled by formfields parameter. - * */ + /** @description Array of form fields. Controlled by formfields parameter. */ readonly form_fields?: readonly components["schemas"]["formFieldValue"][]; }; /** address_Post */ @@ -936,8 +929,7 @@ export interface components { * @example 1 */ readonly customer_id: number; - /** @description The address custom form field values - * */ + /** @description The address custom form field values */ readonly form_fields?: readonly components["schemas"]["formFieldValue"][]; }; /** @@ -1104,6 +1096,10 @@ export interface components { /** * Format: date-time * @description The date of which the customer consent was last updated. + * + * > NOTE + * > + * > Currently, this field returns the time of the current API Call, not the time of last update. For PUT requests, this is typically accurate; however, it will not be accurate for GET requests. */ readonly updated_at?: string; }; @@ -1345,8 +1341,10 @@ export interface components { */ readonly default_customer_group_id?: number; }; - /** @description * Determines if a channel allows global customer to login - * * Determines if customers created on this channel will get global access/login */ + /** + * @description * Determines if a channel allows global customer to login + * * Determines if customers created on this channel will get global access/login + */ readonly allow_global_logins?: boolean; }; /** ValidateCustomerCredentialsObject */ @@ -1365,8 +1363,7 @@ export interface components { /** @description indicates if the provided credentials are valid. */ readonly is_valid?: boolean; }; - /** @description Common metafield properties. - * */ + /** @description Common metafield properties. */ readonly Metafield: { /** * @description Determines the visibility and writeability of the field by other API consumers. @@ -1377,44 +1374,37 @@ export interface components { * | `write` | Open for reading and writing by other API consumers. | * | `read_and_sf_access` | Visible to other API consumers, including on storefront. | * | `write_and_sf_access` | Open for reading and writing by other API consumers, including on storefront. | - * * @enum {string} */ readonly permission_set: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; /** * @description Namespace for the metafield, for organizational purposes. - * * @example Sales Department */ readonly namespace: string; /** * @description The name of the field, for example: `location_id`, `color`. - * * @example Staff Name */ readonly key: string; /** * @description The value of the field, for example: `1`, `blue`. - * * @example Ronaldo */ readonly value: string; /** * @description Description for the metafields. - * * @example order */ readonly description: string; /** * @description The type of resource with which the metafield is associated. - * * @example cart * @enum {string} */ readonly resource_type: "brand" | "product" | "variant" | "category" | "cart" | "channel" | "location" | "order" | "customer"; /** * @description The unique identifier for the resource with which the metafield is associated. - * * @example 424242 */ readonly resource_id: number; @@ -1438,8 +1428,7 @@ export interface components { */ readonly owner_client_id?: string; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponse: { readonly data?: readonly components["schemas"]["Metafield"][]; readonly meta?: components["schemas"]["CollectionMeta"]; @@ -1454,31 +1443,32 @@ export interface components { readonly errors?: readonly unknown[]; readonly meta?: components["schemas"]["CollectionMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponsePartialSuccess_POST_PUT: { readonly data?: readonly components["schemas"]["Metafield"][]; readonly errors?: readonly components["schemas"]["Error"][]; readonly meta?: components["schemas"]["WriteCollectionPartialSuccessMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponsePartialSuccess_DELETE: { - /** @example [ + /** + * @example [ * 123 - * ] */ + * ] + */ readonly data?: readonly number[]; readonly errors?: readonly components["schemas"]["Error"][]; readonly meta?: components["schemas"]["WriteCollectionPartialSuccessMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionDeleteResponseSuccess: { - /** @example [ + /** + * @example [ * 123, * 124, * 125 - * ] */ + * ] + */ readonly data?: readonly number[]; /** * @description Empty for 200 responses. @@ -1494,19 +1484,16 @@ export interface components { readonly WriteCollectionPartialSuccessMeta: { /** * @description Total number of items in the result set. - * * @example 3 */ readonly total?: number; /** * @description Total number of items that were successfully deleted. - * * @example 1 */ readonly success?: number; /** * @description Total number of items that failed to be deleted. - * * @example 2 */ readonly failed?: number; @@ -1518,59 +1505,49 @@ export interface components { readonly WriteCollectionSuccessMeta: { /** * @description Total number of items in the result set. - * * @example 3 */ readonly total?: number; /** * @description Total number of items that were successfully deleted. - * * @example 3 */ readonly success?: number; /** * @description Total number of items that failed to be deleted. - * * @example 0 */ readonly failed?: number; }; /** * @description Total number of items in the result set. - * * @example 3 */ readonly Total: number; /** * @description Total number of items that were successfully deleted. - * * @example 1 */ readonly Success: number; /** * @description Total number of items that failed to be deleted. - * * @example 2 */ readonly Failed: number; - /** @description Error response payload for the BigCommerce API. - * */ + /** @description Error response payload for the BigCommerce API. */ readonly Error: { /** * @description The HTTP status code for the error. - * * @example 422 */ readonly status?: number; /** * @description The error title. - * * @example Bulk operation has failed */ readonly title?: string; /** * @description The error type. - * * @example https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes */ readonly type?: string; @@ -1578,7 +1555,6 @@ export interface components { }; /** * @description Error detail response payload for the BigCommerce API. - * * @example { * "1": "Unauthorized to delete", * "2": "Metafield does not exist" @@ -1599,56 +1575,46 @@ export interface components { readonly pagination?: { /** * @description Total number of items in the result set. - * * @example 36 */ readonly total?: number; /** * @description Total number of items in the collection response. - * * @example 36 */ readonly count?: number; /** * @description The amount of items returned in the collection per page, controlled by the limit parameter. - * * @example 50 */ readonly per_page?: number; /** * @description The page you are currently on within the collection. - * * @example 1 */ readonly current_page?: number; /** * @description The total number of pages in the collection. - * * @example 1 */ readonly total_pages?: number; - /** @description Pagination links for the previous and next parts of the whole collection. - * */ + /** @description Pagination links for the previous and next parts of the whole collection. */ readonly links?: { - /** @description Link to the previous page returned in the response. - * */ + /** @description Link to the previous page returned in the response. */ readonly previous?: string; /** * @description Link to the current page returned in the response. - * * @example ?page=1&limit=50 */ readonly current?: string; - /** @description Link to the next page returned in the response. - * */ + /** @description Link to the next page returned in the response. */ readonly next?: string; }; }; } & { readonly [key: string]: unknown; }; - /** @description Common Metafield properties. - * */ + /** @description Common Metafield properties. */ readonly MetafieldBase_Post: { /** * @description Determines the visibility and writeability of the field by other API consumers. @@ -1665,31 +1631,26 @@ export interface components { readonly permission_set: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; /** * @description Namespace for the metafield, for organizational purposes. - * * @example Sales Department */ readonly namespace: string; /** * @description The name of the field, for example: `location_id`, `color`. - * * @example Staff Name */ readonly key: string; /** * @description The value of the field, for example: `1`, `blue`. - * * @example Ronaldo */ readonly value: string; /** * @description Description for the metafields. - * * @example Name of Staff Member */ readonly description?: string; }; - /** @description Common Metafield properties. - * */ + /** @description Common Metafield properties. */ readonly MetafieldBase_Put: { /** * @description Determines the visibility and writeability of the field by other API consumers. @@ -1701,31 +1662,26 @@ export interface components { * | `write` | Open for reading and writing by other API consumers. | * | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | * | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | - * * @enum {string} */ readonly permission_set?: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; /** * @description Namespace for the metafield, for organizational purposes. - * * @example Sales Department */ readonly namespace?: string; /** * @description The name of the field, for example: `location_id`, `color`. - * * @example Staff Name */ readonly key?: string; /** * @description The value of the field, for example: `1`, `blue`. - * * @example Ronaldo */ readonly value?: string; /** * @description Description for the metafields. - * * @example Name of Staff Member */ readonly description?: string; @@ -1740,28 +1696,24 @@ export interface components { } & components["schemas"]["metafield_Base"] & { /** * @description The type of resource with which the metafield is associated. - * * @example customer * @enum {string} */ readonly resource_type?: "category" | "brand" | "product" | "variant" | "customer"; /** * @description The ID of the resource with which the metafield is associated. - * * @example 111 */ readonly resource_id?: number; /** * Format: date-time * @description Date and time of the metafieldʼs creation. Read-Only. - * * @example 2018-05-07T20:14:17+00:00 */ readonly date_created?: string; /** * Format: date-time * @description Date and time when the metafield was last updated. Read-Only. - * * @example 2018-05-07T20:14:17+00:00 */ readonly date_modified?: string; @@ -1773,19 +1725,16 @@ export interface components { readonly metafield_Base: { /** * @description The name of the field, for example: `location_id`, `color`. Required for POST. - * * @example Location */ readonly key: string; /** * @description The value of the field, for example: `1`, `blue`. Required for POST. - * * @example 4HG */ readonly value: string; /** * @description Namespace for the metafield, for organizational purposes. This is set by the developer. Required for POST. - * * @example Warehouse Locations */ readonly namespace: string; @@ -1804,7 +1753,6 @@ export interface components { readonly permission_set: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; /** * @description Description for the metafields. - * * @example Location in the warehouse */ readonly description?: string; @@ -1828,8 +1776,7 @@ export interface components { * @description Error payload for the BigCommerce API. */ readonly NotFound: { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -1843,48 +1790,39 @@ export interface components { readonly pagination_Full: { /** * @description Total number of items in the result set. - * * @example 36 */ readonly total?: number; /** * @description Total number of items in the collection response. - * * @example 36 */ readonly count?: number; /** * @description The amount of items returned in the collection per page, controlled by the limit parameter. - * * @example 50 */ readonly per_page?: number; /** * @description The page you are currently on within the collection. - * * @example 1 */ readonly current_page?: number; /** * @description The total number of pages in the collection. - * * @example 1 */ readonly total_pages?: number; - /** @description Pagination links for the previous and next parts of the whole collection. - * */ + /** @description Pagination links for the previous and next parts of the whole collection. */ readonly links?: { - /** @description Link to the previous page returned in the response. - * */ + /** @description Link to the previous page returned in the response. */ readonly previous?: string; /** * @description Link to the current page returned in the response. - * * @example ?page=1&limit=50 */ readonly current?: string; - /** @description Link to the next page returned in the response. - * */ + /** @description Link to the next page returned in the response. */ readonly next?: string; }; }; @@ -2077,9 +2015,11 @@ export interface components { * @description Attribute ID. */ readonly attribute_id: number; - /** @description Attribute value. This will always be a string, regardless of the attributes type. + /** + * @description Attribute value. This will always be a string, regardless of the attributes type. * - * Corresponds to `value` used in customer attribute values `PUT` requests. */ + * Corresponds to `value` used in customer attribute values `PUT` requests. + */ readonly attribute_value: string; /** * Format: int32 @@ -2264,8 +2204,7 @@ export interface components { readonly metafieldId: number; /** @description The ID of the customer. */ readonly customerId: number; - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly PageParam: number; /** @description Filter based on a metafieldʼs key. */ readonly MetafieldKeyParam: string; @@ -2275,8 +2214,7 @@ export interface components { readonly MetafieldNamespaceParam: string; /** @description Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. */ readonly MetafieldNamespaceInParam: readonly string[]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly LimitParam: number; /** @description Filter items by minimum date created. For example, `date_created:min=2019-09-04T00:00:00` or `date_created:min=2019-09-04`. Returns metafields created after this date. */ readonly date_created_min: string; @@ -2286,8 +2224,7 @@ export interface components { readonly date_modified_min: string; /** @description Filter items by maximum date modified. For example, `date_modified:max=2019-09-04T00:00:00` or `date_modified:max=2019-09-04`. Returns metafields modified before this date. */ readonly date_modified_max: string; - /** @description Sort direction. Acceptable values are: `asc`, `desc`. - * */ + /** @description Sort direction. Acceptable values are: `asc`, `desc`. */ readonly DirectionParam: "asc" | "desc"; /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */ readonly IncludeFieldsParamMetafields: readonly ("resource_id" | "key" | "value" | "namespace" | "permission_set" | "resource_type" | "description" | "owner_client_id" | "date_created" | "date_modified")[]; @@ -2305,8 +2242,10 @@ export interface operations { readonly page?: number; /** @description Items count per page. `limit=50` */ readonly limit?: number; - /** @description Filter items by ID. - * `id:in=4,5,6` */ + /** + * @description Filter items by ID. + * `id:in=4,5,6` + */ readonly "id:in"?: readonly number[]; /** @description Filter items by company. `company:in=bigcommerce,commongood` */ readonly "company:in"?: readonly string[]; @@ -2328,16 +2267,21 @@ export interface operations { readonly "email:in"?: readonly string[]; /** @description Filter items by first_name and last_name. `name=james moriarty` */ readonly "name:in"?: readonly string[]; - /** @description Filter items by substring in first_name and last_name. + /** + * @description Filter items by substring in first_name and last_name. * `name:like=moriarty,sherlock` - * Concatenates the first_name and last_name fields. */ + * Concatenates the first_name and last_name fields. + */ readonly "name:like"?: readonly string[]; /** @description Filter items by phone number. `phone:in=555-55-5555` */ readonly "phone:in"?: string; - /** @description Filter items by registration_ip_address. If the customer was created using the API, then registration address is blank. - * `registration_ip_address:in=12.345.6.789` */ + /** + * @description Filter items by registration_ip_address. If the customer was created using the API, then registration address is blank. + * `registration_ip_address:in=12.345.6.789` + */ readonly "registration_ip_address:in"?: readonly number[]; - /** @description Indicates whether to include customer sub-resources: + /** + * @description Indicates whether to include customer sub-resources: * * `addresses` - customer addresses * * `storecredit` - store credit * * `attributes` - customer attributes and address attributes @@ -2345,11 +2289,12 @@ export interface operations { * * `shopper_profile_id` - the ID of the shopper profile associated with the customer (Beta) * * `segment_ids`- segments the customer belongs to (Beta) * - * `include=addresses,storecredit,attributes,formfields,shopper_profile_id,segment_ids` */ + * `include=addresses,storecredit,attributes,formfields,shopper_profile_id,segment_ids` + */ readonly include?: readonly ("addresses" | "storecredit" | "attributes" | "formfields" | "shopper_profile_id" | "segment_ids")[]; /** @description Sort items by date_created, date_modified, or last_name:* `date_created:asc` - date created, ascending* `date_created:desc` - date created, descending* `last_name:asc` - last name, ascending* `last_name:desc` - last name, descending * `date_modified:asc` - date modified, ascending* `date_modified:desc`- date modified, descending Example: `sort=last_name:asc` */ readonly sort?: "date_created:asc" | "date_created:desc" | "last_name:asc" | "last_name:desc" | "date_modified:asc" | "date_modified:desc"; - /** @description The cursor reference of the last entry for the previous page. Use the `end_cursor` value from the last response to get the next page (`end_cursor` is only returned on the first page or when the request contains query parameter `before` or `after`). For example `after=eyJpZCI6MjA0fQ`. */ + /** @description The cursor reference of the last entry for the previous page. Use the `end_cursor` value from the last response to get the next page (`end_cursor` is only returned on the first page or when the request contains query parameter `before` or `after`). For example `after=eyJpZCI6MjA0fQ`. */ readonly after?: string; /** @description The cursor reference of the first entry for the next page. Use the `start_cursor` value from the last response to get the previous page (`start_cursor` is only returned on the first page or when the request contains query parameter `before` or `after`). For example `before=eyJpZCI6MjA1fQ`. */ readonly before?: string; @@ -2361,8 +2306,7 @@ export interface operations { readonly requestBody?: never; readonly responses: { readonly 200: components["responses"]["GetCustomerCollectionResponse"]; - /** @description The optional filter parameter was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description The optional filter parameter was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -2394,8 +2338,7 @@ export interface operations { }; content?: never; }; - /** @description The `Customer` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description The `Customer` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -2441,8 +2384,10 @@ export interface operations { readonly deleteCustomers: { readonly parameters: { readonly query: { - /** @description Filter items by ID. - * `id:in=4,5,6` */ + /** + * @description Filter items by ID. + * `id:in=4,5,6` + */ readonly "id:in": readonly number[]; }; readonly header?: never; @@ -2481,12 +2426,16 @@ export interface operations { readonly "name:in"?: readonly string[]; /** @description Filter by the ID of the customer. Also accepts comma-separated IDs to filter for multiple customers. `customer_id:in=23,24,55` */ readonly "customer_id:in"?: readonly number[]; - /** @description Indicates whether to include customer address sub-resources: + /** + * @description Indicates whether to include customer address sub-resources: * * `formfields` - address form fields - * `include=formfields` */ + * `include=formfields` + */ readonly include?: readonly "formfields"[]; - /** @description Filter items by ID. - * `id:in=4,5,6` */ + /** + * @description Filter items by ID. + * `id:in=4,5,6` + */ readonly "id:in"?: readonly number[]; }; readonly header?: { @@ -2518,8 +2467,7 @@ export interface operations { }; readonly responses: { readonly 200: components["responses"]["AddressCollectionResponsePostPut"]; - /** @description The `Address` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description The `Address` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -2547,8 +2495,7 @@ export interface operations { }; readonly responses: { readonly 200: components["responses"]["AddressCollectionResponsePostPut"]; - /** @description The `Address` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description The `Address` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -2562,8 +2509,10 @@ export interface operations { readonly deleteCustomersAddresses: { readonly parameters: { readonly query: { - /** @description Filter items by ID. - * `id:in=4,5,6` */ + /** + * @description Filter items by ID. + * `id:in=4,5,6` + */ readonly "id:in": readonly number[]; }; readonly header?: { @@ -2614,8 +2563,7 @@ export interface operations { readonly "application/json": components["schemas"]["ErrorResponse"]; }; }; - /** @description Allowed number of requests exceeded. - * */ + /** @description Allowed number of requests exceeded. */ readonly 429: { headers: { readonly [name: string]: unknown; @@ -2793,8 +2741,7 @@ export interface operations { }; readonly responses: { readonly 200: components["responses"]["CustomerAttributesResponse"]; - /** @description The `Attribute` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description The `Attribute` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -2822,8 +2769,7 @@ export interface operations { }; readonly responses: { readonly 200: components["responses"]["CustomerAttributesResponse"]; - /** @description The `Attribute` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description The `Attribute` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -2912,8 +2858,7 @@ export interface operations { }; readonly responses: { readonly 200: components["responses"]["CustomerAttributeValueCollectionResponse"]; - /** @description The `CustomerAttributeValue` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description The `CustomerAttributeValue` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -2927,8 +2872,10 @@ export interface operations { readonly deleteCustomersAttributeValues: { readonly parameters: { readonly query: { - /** @description Filter items by ID. - * `id:in=4,5,6` */ + /** + * @description Filter items by ID. + * `id:in=4,5,6` + */ readonly "id:in": readonly number[]; }; readonly header?: { @@ -2961,7 +2908,8 @@ export interface operations { readonly address_id?: number; /** @description Filter by the field name. */ readonly field_name?: string; - /** @description Filter by the field type. + /** + * @description Filter by the field type. * * `checkboxes` - checkboxes field * * `date` - date field * * `multiline` - multiline text field @@ -2969,9 +2917,10 @@ export interface operations { * * `password` - password field * * `radiobuttons` - radio buttons field * * `text` - text field - * * `picklist` - pick list field */ + * * `picklist` - pick list field + */ readonly field_type?: "checkboxes" | "date" | "multiline" | "numbers" | "password" | "radiobuttons" | "text" | "picklist"; - /** @description The cursor reference of the last entry for the previous page. Use the `end_cursor` value from the last response to get the next page (`end_cursor` is only returned on the first page or when the request contains query parameter `before` or `after`). For example `after=eyJzZXNzaW9uSWQiOjM4LCJmaWVsZElkIjo0MH0`. */ + /** @description The cursor reference of the last entry for the previous page. Use the `end_cursor` value from the last response to get the next page (`end_cursor` is only returned on the first page or when the request contains query parameter `before` or `after`). For example `after=eyJzZXNzaW9uSWQiOjM4LCJmaWVsZElkIjo0MH0`. */ readonly after?: string; /** @description The cursor reference of the first entry for the next page. Use the `start_cursor` value from the last response to get the previous page (`start_cursor` is only returned on the first page or when the request contains query parameter `before` or `after`). For example `before=eyJzZXNzaW9uSWQiOjgsImZpZWxkSWQiOjMxfQ`. */ readonly before?: string; @@ -3139,10 +3088,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "code": 401, * "message": "Unauthorized" - * } */ + * } + */ readonly "application/json": components["schemas"]["ErrorResponse"]; }; }; @@ -3152,10 +3103,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "code": 403, * "message": "Missing scope" - * } */ + * } + */ readonly "application/json": components["schemas"]["ErrorResponse"]; }; }; @@ -3218,12 +3171,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -3232,8 +3187,7 @@ export interface operations { }; }; }; - /** @description The `Metafield` conflicts with another `Metafield`. This can result from duplicate unique key combinations of the appʼs client id, namespace, key, resource_type, and resource_id. - * */ + /** @description The `Metafield` conflicts with another `Metafield`. This can result from duplicate unique key combinations of the appʼs client id, namespace, key, resource_type, and resource_id. */ readonly 409: { headers: { readonly [name: string]: unknown; @@ -3278,8 +3232,7 @@ export interface operations { }; }; }; - /** @description Not found (A metafield was not found with this query). - * */ + /** @description Not found (A metafield was not found with this query). */ readonly 404: { headers: { readonly [name: string]: unknown; @@ -3310,7 +3263,6 @@ export interface operations { readonly "application/json": components["schemas"]["MetafieldBase_Put"] & { /** * @description The ID of metafield to update. - * * @example 42 */ readonly id: number; @@ -3333,12 +3285,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -3347,8 +3301,7 @@ export interface operations { }; }; }; - /** @description Not found (A metafield was not found with this query). - * */ + /** @description Not found (A metafield was not found with this query). */ readonly 404: { headers: { readonly [name: string]: unknown; @@ -3373,16 +3326,14 @@ export interface operations { }; readonly requestBody?: never; readonly responses: { - /** @description Response object for customer metafields deletion with success. - * */ + /** @description Response object for customer metafields deletion with success. */ readonly 204: { headers: { readonly [name: string]: unknown; }; content?: never; }; - /** @description Not found (A metafield was not found with this query). - * */ + /** @description Not found (A metafield was not found with this query). */ readonly 404: { headers: { readonly [name: string]: unknown; @@ -3396,11 +3347,9 @@ export interface operations { readonly getAllCustomersMetafields: { readonly parameters: { readonly query?: { - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; /** @description Filter based on a metafieldʼs key. */ readonly key?: components["parameters"]["MetafieldKeyParam"]; @@ -3410,8 +3359,7 @@ export interface operations { readonly namespace?: components["parameters"]["MetafieldNamespaceParam"]; /** @description Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. */ readonly "namespace:in"?: components["parameters"]["MetafieldNamespaceInParam"]; - /** @description Sort direction. Acceptable values are: `asc`, `desc`. - * */ + /** @description Sort direction. Acceptable values are: `asc`, `desc`. */ readonly direction?: components["parameters"]["DirectionParam"]; /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */ readonly include_fields?: components["parameters"]["IncludeFieldsParamMetafields"]; @@ -3430,8 +3378,7 @@ export interface operations { }; readonly requestBody?: never; readonly responses: { - /** @description List of `Metafield` objects. - * */ + /** @description List of `Metafield` objects. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -3454,7 +3401,6 @@ export interface operations { readonly "application/json": readonly (components["schemas"]["MetafieldBase_Put"] & { /** * @description The ID of metafield to update. - * * @example 42 */ readonly id: number; @@ -3477,12 +3423,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -3491,8 +3439,7 @@ export interface operations { }; }; }; - /** @description Response object for metafields creation with partial success. - * */ + /** @description Response object for metafields creation with partial success. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -3515,7 +3462,6 @@ export interface operations { readonly "application/json": readonly (components["schemas"]["MetafieldBase_Post"] & { /** * @description The ID for the resource with which the metafield is associated. - * * @example 42 */ readonly resource_id: number; @@ -3538,12 +3484,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -3552,8 +3500,7 @@ export interface operations { }; }; }; - /** @description Response object for metafields creation with partial success. - * */ + /** @description Response object for metafields creation with partial success. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -3573,8 +3520,7 @@ export interface operations { }; readonly requestBody?: never; readonly responses: { - /** @description Response object for metafields deletion with success. - * */ + /** @description Response object for metafields deletion with success. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -3589,12 +3535,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -3603,8 +3551,7 @@ export interface operations { }; }; }; - /** @description Response object for metafields deletion with partial success. - * */ + /** @description Response object for metafields deletion with partial success. */ readonly 422: { headers: { readonly [name: string]: unknown; diff --git a/src/internal/reference/generated/email_templates.v3.ts b/src/internal/reference/generated/email_templates.v3.ts index 5fd7cfa..19d5061 100644 --- a/src/internal/reference/generated/email_templates.v3.ts +++ b/src/internal/reference/generated/email_templates.v3.ts @@ -55,14 +55,11 @@ export interface components { readonly ErrorResponse: components["schemas"]["BaseError"] & { readonly errors?: components["schemas"]["DetailedErrors"]; }; - /** @description Error payload for the BigCommerce API. - * */ + /** @description Error payload for the BigCommerce API. */ readonly BaseError: { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; @@ -164,8 +161,7 @@ export interface operations { }; readonly requestBody?: never; readonly responses: { - /** @description An array of email templates on the store - * */ + /** @description An array of email templates on the store */ readonly 200: { headers: { readonly [name: string]: unknown; diff --git a/src/internal/reference/generated/geography.v2.ts b/src/internal/reference/generated/geography.v2.ts index 35cc6e8..2f409b1 100644 --- a/src/internal/reference/generated/geography.v2.ts +++ b/src/internal/reference/generated/geography.v2.ts @@ -223,7 +223,8 @@ export interface components { readonly [name: string]: unknown; }; content: { - /** @example [ + /** + * @example [ * { * "id": 1, * "country": "Afghanistan", @@ -244,7 +245,8 @@ export interface components { * "resource": "/countries/2/states" * } * } - * ] */ + * ] + */ readonly "application/json": readonly components["schemas"]["country_Full"][]; }; }; diff --git a/src/internal/reference/generated/inventory.v3.ts b/src/internal/reference/generated/inventory.v3.ts index bc99c2d..ff2b882 100644 --- a/src/internal/reference/generated/inventory.v3.ts +++ b/src/internal/reference/generated/inventory.v3.ts @@ -21,7 +21,6 @@ export interface paths { * **Limits** * * For maximum inventory levels, see [Inventory adjustments](/docs/store-operations/catalog/inventory-adjustments#inventory-adjustments). * * Limit of 2000 items for payload length, see [Optimizing performance](/docs/store-operations/catalog/inventory-adjustments#optimizing-performance) for more information. - * */ readonly put: operations["put-absolute-adjustment"]; }; @@ -42,7 +41,6 @@ export interface paths { * **Limits** * * For maximum inventory levels, see [Inventory adjustments](/docs/store-operations/catalog/inventory-adjustments#inventory-adjustments). * * Limit of 2000 items for payload length, see [Optimizing performance](/docs/store-operations/catalog/inventory-adjustments#optimizing-performance) for more information. - * */ readonly post: operations["post-relative-adjustment"]; }; @@ -62,7 +60,6 @@ export interface paths { * * **Limits** * * Limit of 1000 items for payload length. - * */ readonly get: operations["get-inventory-items"]; }; @@ -82,17 +79,14 @@ export interface paths { * * **Limits** * * Limit of 1000 items for payload length. - * */ readonly get: operations["get-location-inventory-items"]; /** * Update Inventory Settings for a Location - * @description - * Update inventory settings for items at a location. + * @description Update inventory settings for items at a location. * * **Limits** * * Limit of 2000 items for payload length. - * */ readonly put: operations["put-location-inventory-items"]; }; @@ -105,8 +99,7 @@ export interface components { readonly status?: number; /** @description Human readable error message. */ readonly title?: string; - /** @description URL identifying the error type. Dereferencing the URL leads to documentation about the error type. - * */ + /** @description URL identifying the error type. Dereferencing the URL leads to documentation about the error type. */ readonly type?: string; /** @description Detailed summary describing the particular error. */ readonly errors?: { @@ -298,22 +291,18 @@ export interface components { }; /** * @description Safety stock. Decreases the amount available for selling items at that amount. If missing, the value will remain the same. - * * @example 5 */ readonly safety_stock?: number; - /** @description Shows whether an item is available for purchase independent of quantity. If missing, the value will remain the same. - * */ + /** @description Shows whether an item is available for purchase independent of quantity. If missing, the value will remain the same. */ readonly is_in_stock?: boolean; /** * @description Inventory warning level for the product. The store owner will be informed when the product's inventory level drops below the warning level. If missing, the value will remain the same. - * * @example 10 */ readonly warning_level?: number; /** * @description Warehouse location identifier; bin picking number for the item. - * * @example 1 */ readonly bin_picking_number?: string; @@ -350,7 +339,6 @@ export interface components { readonly settings?: { /** * @description Safety stock. Decreases the amount available for selling an item. If missing, the value will remain the same. - * * @default 0 * @example 2 */ @@ -362,14 +350,12 @@ export interface components { readonly is_in_stock: boolean; /** * @description Inventory warning level for the product. The store owner will be informed when the product's inventory level drops below the warning level. If missing, the value will remain the same. - * * @default 0 * @example 2 */ readonly warning_level: number; /** * @description Warehouse location identifier; bin picking number for the item. - * * @example 1 */ readonly bin_picking_number?: string; @@ -543,8 +529,7 @@ export interface operations { readonly "application/json": components["schemas"]["SimpleTransactionResponse"]; }; }; - /** @description Incorrect entity. The adjustment was not valid. This is the result of missing required fields or invalid data. See the response for more details. - * */ + /** @description Incorrect entity. The adjustment was not valid. This is the result of missing required fields or invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -673,8 +658,7 @@ export interface operations { readonly "application/json": components["schemas"]["SimpleTransactionResponse"]; }; }; - /** @description Incorrect entity. Item was not valid due to missing required fields or invalid data. See the response for more details. - * */ + /** @description Incorrect entity. Item was not valid due to missing required fields or invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; diff --git a/src/internal/reference/generated/locations.v3.ts b/src/internal/reference/generated/locations.v3.ts index dc4235b..29656a2 100644 --- a/src/internal/reference/generated/locations.v3.ts +++ b/src/internal/reference/generated/locations.v3.ts @@ -21,18 +21,15 @@ export interface paths { * **Limits** * * Limit of 50 concurrent requests. * * Limit of 1000 items for payload length. - * */ readonly get: operations["getLocations"]; /** * Update Locations - * @description - * Update existing locations. + * @description Update existing locations. * * **Limits** * * Limit of 50 concurrent requests. * * Limit of 100 active locations. - * */ readonly put: operations["updateLocations"]; /** @@ -42,7 +39,6 @@ export interface paths { * **Limits** * * Limit of 50 concurrent requests. * * Limit of 100 active locations. - * */ readonly post: operations["createLocations"]; /** @@ -56,7 +52,6 @@ export interface paths { * > Warning: * > * > Deleting locations that have inventory also deletes its stock. - * */ readonly delete: operations["deleteLocations"]; }; @@ -143,8 +138,7 @@ export interface components { readonly status?: number; /** @description Human readable error message. */ readonly title?: string; - /** @description URL identifying the error type. Dereferencing the URL leads to documentation about the error type. - * */ + /** @description URL identifying the error type. Dereferencing the URL leads to documentation about the error type. */ readonly type?: string; /** @description The detailed summary describing the particular error. */ readonly errors?: { @@ -276,7 +270,6 @@ export interface components { readonly description?: string; /** * @description Indicates if the third-party system is the source of truth for inventory values. If set to true, manually editing inventory in BCʼs control panel will be disabled. - * * @default false */ readonly managed_by_external_source: boolean; @@ -419,7 +412,6 @@ export interface components { readonly description?: string; /** * @description Indicates if the third-party system is the source of truth for inventory values. If set to true, manually editing inventory in BCʼs control panel will be disabled. - * * @default false */ readonly managed_by_external_source: boolean; @@ -521,7 +513,6 @@ export interface components { readonly description?: string; /** * @description Indicates if the third-party system is the source of truth for inventory values. If set to true, manually editing inventory in BCʼs control panel will be disabled. - * * @default false */ readonly managed_by_external_source: boolean; @@ -605,8 +596,7 @@ export interface components { /** @description Unique identifier of performed action. */ readonly transaction_id?: string; }; - /** @description Common metafield properties. - * */ + /** @description Common metafield properties. */ readonly MetafieldBase: { /** * @description The name of the field, for example: `location_id`, `color`. @@ -615,13 +605,11 @@ export interface components { readonly key?: string; /** * @description The value of the field, for example: `1`, `blue`. - * * @example upcoming */ readonly value?: string; /** * @description Namespace for the metafield, for organizational purposes. - * * @example headquarters */ readonly namespace?: string; @@ -634,16 +622,13 @@ export interface components { * | `write` | Open for reading and writing by other API consumers. | * | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | * | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | - * * @enum {string} */ readonly permission_set?: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; - /** @description Description for the metafields. - * */ + /** @description Description for the metafields. */ readonly description?: string; }; - /** @description Allows app partners to write custom data to various resources in the API. - * */ + /** @description Allows app partners to write custom data to various resources in the API. */ readonly Metafield: { /** * @description Unique ID for the metafield. @@ -653,25 +638,21 @@ export interface components { } & components["schemas"]["MetafieldBase"] & { /** * @description The type of resource with which the metafield is associated. - * * @enum {string} */ readonly resource_type?: "location"; - /** @description The unique identifier for the resource with which the metafield is associated. - * */ + /** @description The unique identifier for the resource with which the metafield is associated. */ readonly resource_id?: number; } & { /** * Format: date-time * @description Date and time when the metafield was created. - * * @example 2022-04-14T23:06:45+00:00 */ readonly date_created?: string; /** * Format: date-time * @description Date and time when the metafield was last updated. - * * @example 2022-09-08T04:18:55+00:00 */ readonly date_modified?: string; @@ -681,14 +662,12 @@ export interface components { */ readonly owner_client_id?: string; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponse: { readonly data?: readonly components["schemas"]["Metafield"][]; readonly meta?: components["schemas"]["CollectionMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponse_POST_PUT: { readonly data?: readonly components["schemas"]["Metafield"][]; /** @@ -698,31 +677,32 @@ export interface components { readonly errors?: readonly unknown[]; readonly meta?: components["schemas"]["CollectionMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponsePartialSuccess_POST_PUT: { readonly data?: readonly components["schemas"]["Metafield"][]; readonly errors?: readonly components["schemas"]["Error"][]; readonly meta?: components["schemas"]["WriteCollectionPartialSuccessMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponsePartialSuccess_DELETE: { - /** @example [ + /** + * @example [ * 123 - * ] */ + * ] + */ readonly data?: readonly number[]; readonly errors?: readonly components["schemas"]["Error"][]; readonly meta?: components["schemas"]["WriteCollectionPartialSuccessMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionDeleteResponseSuccess: { - /** @example [ + /** + * @example [ * 123, * 124, * 125 - * ] */ + * ] + */ readonly data?: readonly number[]; /** * @description Empty for 200 responses. @@ -738,19 +718,16 @@ export interface components { readonly WriteCollectionPartialSuccessMeta: { /** * @description Total number of items in the result set. - * * @example 3 */ readonly total?: number; /** * @description Total number of items that were successfully deleted. - * * @example 1 */ readonly success?: number; /** * @description Total number of items that failed to be deleted. - * * @example 2 */ readonly failed?: number; @@ -762,59 +739,49 @@ export interface components { readonly WriteCollectionSuccessMeta: { /** * @description Total number of items in the result set. - * * @example 3 */ readonly total?: number; /** * @description Total number of items that were successfully deleted. - * * @example 3 */ readonly success?: number; /** * @description Total number of items that failed to be deleted. - * * @example 0 */ readonly failed?: number; }; /** * @description Total number of items in the result set. - * * @example 3 */ readonly Total: number; /** * @description Total number of items that were successfully deleted. - * * @example 1 */ readonly Success: number; /** * @description Total number of items that failed to be deleted. - * * @example 2 */ readonly Failed: number; - /** @description Error response payload for the BigCommerce API. - * */ + /** @description Error response payload for the BigCommerce API. */ readonly Error: { /** * @description The HTTP status code for the error. - * * @example 422 */ readonly status?: number; /** * @description The error title. - * * @example Bulk operation has failed */ readonly title?: string; /** * @description The error type. - * * @example https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes */ readonly type?: string; @@ -822,7 +789,6 @@ export interface components { }; /** * @description Error detail response payload for the BigCommerce API. - * * @example { * "1": "Unauthorized to delete", * "2": "Metafield does not exist" @@ -843,56 +809,46 @@ export interface components { readonly pagination?: { /** * @description Total number of items in the result set. - * * @example 36 */ readonly total?: number; /** * @description Total number of items in the collection response. - * * @example 36 */ readonly count?: number; /** * @description The amount of items returned in the collection per page, controlled by the limit parameter. - * * @example 50 */ readonly per_page?: number; /** * @description The page you are currently on within the collection. - * * @example 1 */ readonly current_page?: number; /** * @description The total number of pages in the collection. - * * @example 1 */ readonly total_pages?: number; - /** @description Pagination links for the previous and next parts of the whole collection. - * */ + /** @description Pagination links for the previous and next parts of the whole collection. */ readonly links?: { - /** @description Link to the previous page returned in the response. - * */ + /** @description Link to the previous page returned in the response. */ readonly previous?: string; /** * @description Link to the current page returned in the response. - * * @example ?page=1&limit=50 */ readonly current?: string; - /** @description Link to the next page returned in the response. - * */ + /** @description Link to the next page returned in the response. */ readonly next?: string; }; }; } & { readonly [key: string]: unknown; }; - /** @description Common Metafield properties. - * */ + /** @description Common Metafield properties. */ readonly MetafieldBase_Post: { /** * @description Determines the visibility and writeability of the field by other API consumers. @@ -903,37 +859,31 @@ export interface components { * | `write` | Open for reading and writing by other API consumers. | * | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | * | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | - * * @enum {string} */ readonly permission_set: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; /** * @description Namespace for the metafield, for organizational purposes. - * * @example Sales Department */ readonly namespace: string; /** * @description The name of the field, for example: `location_id`, `color`. - * * @example Staff Name */ readonly key: string; /** * @description The value of the field, for example: `1`, `blue`. - * * @example Ronaldo */ readonly value: string; /** * @description Description for the metafields. - * * @example Name of Staff Member */ readonly description?: string; }; - /** @description Common Metafield properties. - * */ + /** @description Common Metafield properties. */ readonly MetafieldBase_Put: { /** * @description Determines the visibility and writeability of the field by other API consumers. @@ -944,31 +894,26 @@ export interface components { * | `write` | Open for reading and writing by other API consumers. | * | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | * | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | - * * @enum {string} */ readonly permission_set?: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; /** * @description Namespace for the metafield, for organizational purposes. - * * @example Sales Department */ readonly namespace?: string; /** * @description The name of the field, for example: `location_id`, `color`. - * * @example Staff Name */ readonly key?: string; /** * @description The value of the field, for example: `1`, `blue`. - * * @example Ronaldo */ readonly value?: string; /** * @description Description for the metafields. - * * @example Name of Staff Member */ readonly description?: string; @@ -998,8 +943,7 @@ export interface components { readonly LocationStorefrontVisibilityParam: boolean; /** @description Unique identifier for a metafield. */ readonly MetafieldIdParam: number; - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly PageParam: number; /** @description Filter based on a metafieldʼs key. */ readonly MetafieldKeyParam: string; @@ -1009,23 +953,17 @@ export interface components { readonly MetafieldNamespaceParam: string; /** @description Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla 'namespace' query parameter. */ readonly MetafieldNamespaceInParam: readonly string[]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly LimitParam: number; - /** @description Sort direction. Acceptable values are: `asc`, `desc`. - * */ + /** @description Sort direction. Acceptable values are: `asc`, `desc`. */ readonly DirectionParam: "asc" | "desc"; - /** @description 'Query parameter that lets you filter by the minimum date created, for example, `2024-05-14T09:34:00`, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.' - * */ + /** @description 'Query parameter that lets you filter by the minimum date created, for example, `2024-05-14T09:34:00`, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.' */ readonly date_created_min: string; - /** @description 'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00`, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.' - * */ + /** @description 'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00`, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.' */ readonly date_created_max: string; - /** @description 'Query parameter that lets you filter by the maximum date modified, for example, `2024-05-14T09:34:00`, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.' - * */ + /** @description 'Query parameter that lets you filter by the maximum date modified, for example, `2024-05-14T09:34:00`, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.' */ readonly date_modified_max: string; - /** @description 'Query parameter that lets you filter by the minimum date modified, for example, `2024-05-14T09:34:00`, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.' - * */ + /** @description 'Query parameter that lets you filter by the minimum date modified, for example, `2024-05-14T09:34:00`, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.' */ readonly date_modified_min: string; /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */ readonly IncludeFieldsParamMetafields: readonly ("resource_id" | "key" | "value" | "namespace" | "permission_set" | "resource_type" | "description" | "owner_client_id" | "date_created" | "date modified")[]; @@ -1053,11 +991,9 @@ export interface operations { readonly is_active?: components["parameters"]["LocationIsActiveParam"]; /** @description Filter by storefront_visibility flag; return both if not specified. */ readonly storefront_visibility?: components["parameters"]["LocationStorefrontVisibilityParam"]; - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; }; readonly header?: { @@ -1108,8 +1044,7 @@ export interface operations { readonly "application/json": components["schemas"]["SimpleTransactionResponse"]; }; }; - /** @description Incorrect entity. Locations were not valid. This results from missing required fields, invalid data, or partial error. See the response for more details. - * */ + /** @description Incorrect entity. Locations were not valid. This results from missing required fields, invalid data, or partial error. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -1148,8 +1083,7 @@ export interface operations { readonly "application/json": components["schemas"]["SimpleTransactionResponse"]; }; }; - /** @description Incorrect entity. Locations were not valid. This results from missing required fields, invalid data, or partial error. See the response for more details. - * */ + /** @description Incorrect entity. Locations were not valid. This results from missing required fields, invalid data, or partial error. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -1193,8 +1127,7 @@ export interface operations { readonly "application/problem+json": components["schemas"]["ErrorResponse"]; }; }; - /** @description Incorrect entity. The location is not valid. This error is the result of missing required fields or invalid data. See the response for more details. - * */ + /** @description Incorrect entity. The location is not valid. This error is the result of missing required fields or invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -1296,12 +1229,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -1310,8 +1245,7 @@ export interface operations { }; }; }; - /** @description The `Metafield` conflicted with another `Metafield`. This can result from duplicate unique key combinations of the appʼs client id, namespace, key, resource_type, and resource_id. - * */ + /** @description The `Metafield` conflicted with another `Metafield`. This can result from duplicate unique key combinations of the appʼs client id, namespace, key, resource_type, and resource_id. */ readonly 409: { headers: { readonly [name: string]: unknown; @@ -1327,8 +1261,7 @@ export interface operations { }; }; }; - /** @description The `Metafield` was not valid. This is the result of missing required fields or invalid data. See the response for more details. - * */ + /** @description The `Metafield` was not valid. This is the result of missing required fields or invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -1422,12 +1355,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -1501,11 +1436,9 @@ export interface operations { readonly getLocationsMetafields: { readonly parameters: { readonly query?: { - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; /** @description Filter based on a metafieldʼs key. */ readonly key?: components["parameters"]["MetafieldKeyParam"]; @@ -1515,22 +1448,17 @@ export interface operations { readonly namespace?: components["parameters"]["MetafieldNamespaceParam"]; /** @description Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla 'namespace' query parameter. */ readonly "namespace:in"?: components["parameters"]["MetafieldNamespaceInParam"]; - /** @description Sort direction. Acceptable values are: `asc`, `desc`. - * */ + /** @description Sort direction. Acceptable values are: `asc`, `desc`. */ readonly direction?: components["parameters"]["DirectionParam"]; /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */ readonly include_fields?: components["parameters"]["IncludeFieldsParamMetafields"]; - /** @description 'Query parameter that lets you filter by the minimum date modified, for example, `2024-05-14T09:34:00`, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.' - * */ + /** @description 'Query parameter that lets you filter by the minimum date modified, for example, `2024-05-14T09:34:00`, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.' */ readonly "date_modified:min"?: components["parameters"]["date_modified_min"]; - /** @description 'Query parameter that lets you filter by the maximum date modified, for example, `2024-05-14T09:34:00`, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.' - * */ + /** @description 'Query parameter that lets you filter by the maximum date modified, for example, `2024-05-14T09:34:00`, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.' */ readonly "date_modified:max"?: components["parameters"]["date_modified_max"]; - /** @description 'Query parameter that lets you filter by the minimum date created, for example, `2024-05-14T09:34:00`, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.' - * */ + /** @description 'Query parameter that lets you filter by the minimum date created, for example, `2024-05-14T09:34:00`, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.' */ readonly "date_created:min"?: components["parameters"]["date_created_min"]; - /** @description 'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00`, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.' - * */ + /** @description 'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00`, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.' */ readonly "date_created:max"?: components["parameters"]["date_created_max"]; }; readonly header?: never; @@ -1539,8 +1467,7 @@ export interface operations { }; readonly requestBody?: never; readonly responses: { - /** @description List of `Metafield` objects. - * */ + /** @description List of `Metafield` objects. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -1563,7 +1490,6 @@ export interface operations { readonly "application/json": readonly (components["schemas"]["MetafieldBase_Put"] & { /** * @description The ID of metafield to update. - * * @example 42 */ readonly id: string; @@ -1571,8 +1497,7 @@ export interface operations { }; }; readonly responses: { - /** @description List of updated `Metafield` objects. - * */ + /** @description List of updated `Metafield` objects. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -1587,12 +1512,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -1601,8 +1528,7 @@ export interface operations { }; }; }; - /** @description Response object for metafields creation with partial success. - * */ + /** @description Response object for metafields creation with partial success. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -1625,7 +1551,6 @@ export interface operations { readonly "application/json": readonly (components["schemas"]["MetafieldBase_Post"] & { /** * @description The ID of the location with which the metafield is associated. - * * @example 42 */ readonly resource_id: number; @@ -1633,8 +1558,7 @@ export interface operations { }; }; readonly responses: { - /** @description List of created `Metafield` objects. # TODO - * */ + /** @description List of created `Metafield` objects. # TODO */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -1649,12 +1573,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -1663,8 +1589,7 @@ export interface operations { }; }; }; - /** @description Response object for metafields creation with partial success. - * */ + /** @description Response object for metafields creation with partial success. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -1689,8 +1614,7 @@ export interface operations { }; }; readonly responses: { - /** @description Response object for metafields deletion with success. - * */ + /** @description Response object for metafields deletion with success. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -1699,8 +1623,7 @@ export interface operations { readonly "application/json": components["schemas"]["MetaFieldCollectionDeleteResponseSuccess"]; }; }; - /** @description Response object for metafields deletion with partial success. - * */ + /** @description Response object for metafields deletion with partial success. */ readonly 422: { headers: { readonly [name: string]: unknown; diff --git a/src/internal/reference/generated/marketing.v2.ts b/src/internal/reference/generated/marketing.v2.ts index 8b0a299..188d5a4 100644 --- a/src/internal/reference/generated/marketing.v2.ts +++ b/src/internal/reference/generated/marketing.v2.ts @@ -76,7 +76,6 @@ export interface paths { * Delete All Coupons * @description ## Usage Notes * * Deleting a coupon via this endpoint will delete the coupon but not the promotion it is attached to - * */ readonly delete: operations["deleteCoupons"]; }; @@ -468,7 +467,6 @@ export interface components { /** * @description Id of the banner. * This is a READ-ONLY field; do not set or modify its value in a POST or PUT request. - * * @example 1 */ readonly id?: number; @@ -678,7 +676,8 @@ export interface components { readonly [name: string]: unknown; }; content: { - /** @example [ + /** + * @example [ * { * "id": 1, * "name": "This is a banner", @@ -705,7 +704,8 @@ export interface components { * "date_to": "0", * "visible": "1" * } - * ] */ + * ] + */ readonly "application/json": readonly components["schemas"]["banner_Full"][]; }; }; @@ -714,7 +714,8 @@ export interface components { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "id": 1, * "name": "Sale Banner", * "content": "

Sale! Tuesday at 9am!

", @@ -726,7 +727,8 @@ export interface components { * "date_from": "0", * "date_to": "0", * "visible": "1" - * } */ + * } + */ readonly "application/json": components["schemas"]["banner_Full"]; }; }; @@ -735,9 +737,11 @@ export interface components { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "count": 27 - * } */ + * } + */ readonly "application/json": { readonly count?: number; }; @@ -748,7 +752,8 @@ export interface components { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "id": 1, * "name": "$5 off", * "type": "per_total_discount", @@ -769,7 +774,8 @@ export interface components { * "restricted_to": {}, * "shipping_methods": [], * "date_created": "Tue, 13 Mar 2018 16:18:59 +0000" - * } */ + * } + */ readonly "application/json": components["schemas"]["coupon_Full"]; }; }; @@ -778,7 +784,8 @@ export interface components { readonly [name: string]: unknown; }; content: { - /** @example [ + /** + * @example [ * { * "id": 1, * "name": "$5 off", @@ -827,7 +834,8 @@ export interface components { * ], * "date_created": "Tue, 12 Jun 2018 20:22:19 +0000" * } - * ] */ + * ] + */ readonly "application/json": readonly components["schemas"]["coupon_Full"][]; }; }; @@ -836,7 +844,8 @@ export interface components { readonly [name: string]: unknown; }; content: { - /** @example [ + /** + * @example [ * { * "id": 24, * "code": "10R-5E2-BO4-RWT", @@ -888,7 +897,8 @@ export interface components { * "purchase_date": "1603306", * "currency_code": "USD" * } - * ] */ + * ] + */ readonly "application/json": readonly components["schemas"]["giftCertificate_Full"][]; }; }; @@ -897,7 +907,8 @@ export interface components { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "id": 1, * "customer_id": 5, * "order_id": 116, @@ -914,7 +925,8 @@ export interface components { * "purchase_date": "1603306", * "expiry_date": "1694738", * "currency_code": "USD" - * } */ + * } + */ readonly "application/json": components["schemas"]["giftCertificate_Full"]; }; }; @@ -967,7 +979,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example [ + /** + * @example [ * { * "id": 1, * "name": "$5 off", @@ -1016,7 +1029,8 @@ export interface operations { * ], * "date_created": "Tue, 12 Jun 2018 20:22:19 +0000" * } - * ] */ + * ] + */ readonly "application/json": readonly components["schemas"]["coupon_Full"][]; }; }; @@ -1045,7 +1059,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "id": 1, * "name": "$5 off", * "type": "per_total_discount", @@ -1066,7 +1081,8 @@ export interface operations { * "restricted_to": {}, * "shipping_methods": [], * "date_created": "Tue, 13 Mar 2018 16:18:59 +0000" - * } */ + * } + */ readonly "application/json": components["schemas"]["coupon_Full"]; }; }; @@ -1112,9 +1128,11 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "count": 27 - * } */ + * } + */ readonly "application/json": { readonly count?: number; }; @@ -1148,7 +1166,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "id": 1, * "name": "$5 off", * "type": "per_total_discount", @@ -1169,7 +1188,8 @@ export interface operations { * "restricted_to": {}, * "shipping_methods": [], * "date_created": "Tue, 13 Mar 2018 16:18:59 +0000" - * } */ + * } + */ readonly "application/json": components["schemas"]["coupon_Full"]; }; }; @@ -1224,7 +1244,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example [ + /** + * @example [ * { * "id": 1, * "name": "This is a banner", @@ -1251,7 +1272,8 @@ export interface operations { * "date_to": "0", * "visible": "1" * } - * ] */ + * ] + */ readonly "application/json": readonly components["schemas"]["banner_Full"][]; }; }; @@ -1280,7 +1302,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "id": 1, * "name": "Sale Banner", * "content": "

Sale! Tuesday at 9am!

", @@ -1292,7 +1315,8 @@ export interface operations { * "date_from": "0", * "date_to": "0", * "visible": "1" - * } */ + * } + */ readonly "application/json": components["schemas"]["banner_Full"]; }; }; @@ -1338,7 +1362,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "id": 1, * "name": "Sale Banner", * "content": "

Sale! Tuesday at 9am!

", @@ -1350,7 +1375,8 @@ export interface operations { * "date_from": "0", * "date_to": "0", * "visible": "1" - * } */ + * } + */ readonly "application/json": components["schemas"]["banner_Full"]; }; }; @@ -1382,7 +1408,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "id": 1, * "name": "Sale Banner", * "content": "

Sale! Tuesday at 9am!

", @@ -1394,7 +1421,8 @@ export interface operations { * "date_from": "0", * "date_to": "0", * "visible": "1" - * } */ + * } + */ readonly "application/json": components["schemas"]["banner_Full"]; }; }; @@ -1440,9 +1468,11 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "count": 27 - * } */ + * } + */ readonly "application/json": { readonly count?: number; }; @@ -1470,7 +1500,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "id": 1, * "customer_id": 5, * "order_id": 116, @@ -1487,7 +1518,8 @@ export interface operations { * "purchase_date": "1603306", * "expiry_date": "1694738", * "currency_code": "USD" - * } */ + * } + */ readonly "application/json": components["schemas"]["giftCertificate_Full"]; }; }; @@ -1519,7 +1551,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "id": 1, * "customer_id": 5, * "order_id": 116, @@ -1536,7 +1569,8 @@ export interface operations { * "purchase_date": "1603306", * "expiry_date": "1672670738", * "currency_code": "USD" - * } */ + * } + */ readonly "application/json": components["schemas"]["giftCertificate_Full"]; }; }; @@ -1578,6 +1612,10 @@ export interface operations { readonly from_email?: string; readonly page?: number; readonly limit?: number; + /** @description Field to sort results by. */ + readonly sort?: "id"; + /** @description Sort direction. Defaults to asc. */ + readonly direction?: "asc" | "desc"; }; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ @@ -1593,7 +1631,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example [ + /** + * @example [ * { * "id": 24, * "code": "10R-5E2-BO4-RWT", @@ -1648,7 +1687,8 @@ export interface operations { * "purchase_date": "1672670738", * "currency_code": "USD" * } - * ] */ + * ] + */ readonly "application/json": readonly components["schemas"]["giftCertificate_Full"][]; }; }; @@ -1677,7 +1717,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "id": 1, * "customer_id": 5, * "order_id": 116, @@ -1694,7 +1735,8 @@ export interface operations { * "purchase_date": "1603306", * "expiry_date": "1694738", * "currency_code": "USD" - * } */ + * } + */ readonly "application/json": components["schemas"]["giftCertificate_Full"]; }; }; diff --git a/src/internal/reference/generated/orders.sf.ts b/src/internal/reference/generated/orders.sf.ts index a574016..ce45012 100644 --- a/src/internal/reference/generated/orders.sf.ts +++ b/src/internal/reference/generated/orders.sf.ts @@ -81,7 +81,14 @@ export interface components { /** @description Shopperʼs provided message for the order. */ readonly customerMessage?: string; readonly shippingCostTotal?: number; + /** @description Estimated total shipping cost before any shipping discounts have been applied. */ readonly shippingCostBeforeDiscount?: number; + /** + * @description The total shipping cost to be shown to shopper in the summary as struck-through. + * - If the entered-price and display-price have the same tax setting (e.g.: both are tax-inclusive), this field will be the estimated total shipping cost before any coupons applied (but after automatic promotions applied). + * - If the entered-price and display-price have different tax setting (e.g.: one is tax-inclusive, and one is tax-exclusive), this field will be the estimated total shipping cost before any discounts applied, similar to the `shippingCostBeforeDiscount`. + */ + readonly comparisonShippingCost?: number; readonly handlingCostTotal?: number; readonly customerCanBeCreated?: boolean; readonly taxes?: readonly { @@ -550,6 +557,14 @@ export interface components { readonly costTax?: number; /** @example 2 */ readonly costTaxClassId?: number; + /** @description Estimated consignment shipping cost before any shipping discounts have been applied. */ + readonly shippingCostBeforeDiscount?: number; + /** + * @description The consignment shipping cost to be shown to shopper in the summary as struck-through. + * - If the entered-price and display-price have the same tax setting (e.g.: both are tax-inclusive), this field will be the estimated shipping cost before any coupons applied (but after automatic promotions applied). + * - If the entered-price and display-price have different tax setting (e.g.: one is tax-inclusive, and one is tax-exclusive), this field will be the estimated shipping cost before any discounts applied, similar to the `shippingCostBeforeDiscount`. + */ + readonly comparisonShippingCost?: number; /** @example 0 */ readonly baseHandlingCost?: number; /** @example 0 */ diff --git a/src/internal/reference/generated/orders.v2.oas2.ts b/src/internal/reference/generated/orders.v2.oas2.ts index 5df8656..3e75028 100644 --- a/src/internal/reference/generated/orders.v2.oas2.ts +++ b/src/internal/reference/generated/orders.v2.oas2.ts @@ -75,29 +75,37 @@ export interface paths { readonly cart_id?: components["parameters"]["cart_id"]; /** @description The display name of the payment method used on the order. For example, `Manual`, `Credit Card`, `cash`, `Test Payment Gateway`, etc.' */ readonly payment_method?: components["parameters"]["payment_method"]; - /** @description Minimum date the order was created in RFC-2822 or ISO-8601. + /** + * @description Minimum date the order was created in RFC-2822 or ISO-8601. * * RFC-2822: `Thu, 20 Apr 2017 11:32:00 -0400` * - * ISO-8601: `2017-04-20T11:32:00.000-04:00` */ + * ISO-8601: `2017-04-20T11:32:00.000-04:00` + */ readonly min_date_created?: components["parameters"]["min_date_created"]; - /** @description Maximum date the order was created in RFC-2822 or ISO-8601. + /** + * @description Maximum date the order was created in RFC-2822 or ISO-8601. * * RFC-2822: `Thu, 20 Apr 2017 11:32:00 -0400` * - * ISO-8601: `2017-04-20T11:32:00.000-04:00` */ + * ISO-8601: `2017-04-20T11:32:00.000-04:00` + */ readonly max_date_created?: components["parameters"]["max_date_created"]; - /** @description Minimum date the order was modified in RFC-2822 or ISO-8601. + /** + * @description Minimum date the order was modified in RFC-2822 or ISO-8601. * * RFC-2822: `Thu, 20 Apr 2017 11:32:00 -0400` * - * ISO-8601: `2017-04-20T11:32:00.000-04:00` */ + * ISO-8601: `2017-04-20T11:32:00.000-04:00` + */ readonly min_date_modified?: components["parameters"]["min_date_modified"]; - /** @description Maximum date the order was modified in RFC-2822 or ISO-8601. + /** + * @description Maximum date the order was modified in RFC-2822 or ISO-8601. * * RFC-2822: `Thu, 20 Apr 2017 11:32:00 -0400` * - * ISO-8601: `2017-04-20T11:32:00.000-04:00` */ + * ISO-8601: `2017-04-20T11:32:00.000-04:00` + */ readonly max_date_modified?: components["parameters"]["max_date_modified"]; /** @description The channel ID of the sales channel the shopper used to place the order. */ readonly channel_id?: components["parameters"]["channel_id"]; @@ -400,7 +408,6 @@ export interface paths { * - `carrier_{your_carrier_id}`, when the carrier is a [third-party Shipping Provider](/docs/integrations/shipping) * * Acceptable values for `tracking_carrier` include an empty string (`""`) or one of the valid [tracking-carrier values](https://www.aftership.com/docs/tracking/others/supported-couriers). - * */ readonly post: operations["createOrderShipments"]; /** @@ -1063,10 +1070,16 @@ export interface components { */ readonly order_address_id?: number; /** - * @description The unique numeric identifier of the tax rate. + * @deprecated + * @description The unique numeric identifier of the tax rate. This field has been deprecated, use sales_tax_id instead. * @example 1 */ readonly tax_rate_id?: number; + /** + * @description A unique identifier for the applied tax rate. This may be a third-party tax provider's identifier. + * @example TaxId123 + */ + readonly sales_tax_id?: string; /** * @description A unique numeric identifier for the tax class. If not provided or null, the default fee tax class from the control panel is used. * @example 0 @@ -1448,7 +1461,6 @@ export interface components { /** * @description Additional information to describe the method of shipment (ex. Standard, Ship by Weight, Custom Shipment). Can be used for live quotes from certain shipping providers. * If different from `shipping_provider`, `shipping_method` should correspond to `tracking_carrier`. - * * @example Ship by Weight */ readonly shipping_method?: string; @@ -1490,7 +1502,6 @@ export interface components { /** * @description Additional information to describe the method of shipment (ex. Standard, Ship by Weight, Custom Shipment). Can be used for live quotes from certain shipping providers. * If different from `shipping_provider`, `shipping_method` should correspond to `tracking_carrier`. - * * @example Ship by Weight */ readonly shipping_method?: string; @@ -1582,7 +1593,7 @@ export interface components { * @example Thank you */ readonly customer_message?: string; - /** @description The date the order was created, formatted in the RFC-2822 standard. You set this attribute on Order creation (POST) to support the migration of historical orders. If you do not provide a value, then it will default to the current date/time. e.g., `Tue, 20 Nov 2012 00:00:00 +0000`. */ + /** @description The date the order was created, formatted in the RFC-2822 standard. You set this attribute on Order creation (POST) to support the migration of historical orders. If you do not provide a value, then it will default to the current date/time. e.g., `Tue, 20 Nov 2012 00:00:00 +0000`. This date time is always in UTC in the api response. */ readonly date_created?: string; /** * @description Amount of discount for this transaction. The value can't be negative. (Float, Float-As-String, Integer) @@ -1686,13 +1697,11 @@ export interface components { readonly refunded_amount?: string; /** * @description The value of shipping cost, excluding tax. When specified in a POST or PUT request, the field `shipping_cost_inc_tax` is also required. The value can't be negative (Float, Float-As-String, Integer) - * * @example 0.0000 */ readonly shipping_cost_ex_tax?: string; /** * @description The value of shipping cost, including tax. When specified in a POST or PUT request, the field `shipping_cost_ex_tax` is also required. The value can't be negative. (Float, Float-As-String, Integer) - * * @example 0.0000 */ readonly shipping_cost_inc_tax?: string; @@ -1713,17 +1722,22 @@ export interface components { * @example 225.0000 */ readonly subtotal_inc_tax?: string; - /** @description Read-only. + /** + * @description Read-only. * BasicTaxProvider - Tax is set to manual and order is created in the store. * * AvaTaxProvider - Tax is set to automatic and order is created in the store. Used for Avalara. * * "" (empty string) - The order is created with the API, or the tax provider is unknown. - * */ + */ readonly tax_provider_id?: string; /** - * @description The customer’s locale. - * @example en + * @description The customer’s locale. The supported formats are: + * - 2-char lowercase characters. e.g., `en` + * - 3-char lowercase characters. e.g., `asa` + * - 5-char the language code is 2 lowercase characters and the region code is 2 uppercase characters, with `-` in the middle. e.g., `en-US` + * - 6-char the language code is 2 lowercase character and the region code is three digit number, with `-` in the middle. e.g., `es-419` + * @example en, asa, en-US, es-419 */ readonly customer_locale?: string; /** @@ -1830,11 +1844,10 @@ export interface components { * @example 118 */ readonly id?: number; - /** @description A read-only value representing the last modification of the order. Do not attempt to modify or set this value in a POST or PUT request. RFC-2822 */ + /** @description A read-only value representing the last modification of the order. Do not attempt to modify or set this value in a POST or PUT request. RFC-2822. This date time is always in UTC in the api response. */ readonly date_modified?: string; /** * @description A read-only value representing the date when the order is fully shipped. Do not attempt to modify or set this value in a POST or PUT request. RFC-2822 - * * @example Wed, 25 Jun 2025 05:22:10 +0000 */ readonly date_shipped?: string; @@ -1968,10 +1981,12 @@ export interface components { * @example false */ readonly is_email_opt_in?: boolean; - /** @description Reflects the origin of the order. It can affect the order’s icon and source as defined in the control panel listing. - * Allowed values: `www` (Desktop) | `iphone` (Iphone) | `ipad` (Ipad) | `android` (Android) | `mobile` (Mobile) | `manual` (manual order) | `external` (Orders API) | `checkout_api` (Checkout API) | `buybutton` (Buy Button) | `amazon` (Amazon) | `ebay` (Ebay) | `facebookshop` (Facebook Shop) | `facebookcheckout` (Facebook Checkout) | `facebookmarketplace` (Facebook Marketplace) | `pinterest` (Pinterest) | `socialshop` (Social Shop) */ + /** + * @description Reflects the origin of the order. It can affect the order’s icon and source as defined in the control panel listing. + * Allowed values: `www` (Desktop) | `iphone` (Iphone) | `ipad` (Ipad) | `android` (Android) | `mobile` (Mobile) | `manual` (manual order) | `external` (Orders API) | `checkout_api` (Checkout API) | `buybutton` (Buy Button) | `amazon` (Amazon) | `ebay` (Ebay) | `facebookshop` (Facebook Shop) | `facebookcheckout` (Facebook Checkout) | `facebookmarketplace` (Facebook Marketplace) | `pinterest` (Pinterest) | `socialshop` (Social Shop) + */ readonly order_source?: string; - readonly consignments?: components["schemas"]["orderConsignments_Resource"]; + readonly consignments?: components["schemas"]["orderConsignments_Resource"] | components["schemas"]["orderConsignment_Get"]; readonly products?: components["schemas"]["products_Resource"]; readonly shipping_addresses?: components["schemas"]["shippingAddresses_Resource"]; readonly coupons?: components["schemas"]["coupons_Resource"]; @@ -2002,7 +2017,6 @@ export interface components { readonly orderCustomProduct_Put: { /** * @description Alias for name_customer. The product name that is shown to customer in storefront. - * * @example Fog Linen Chambray Towel - Beige Stripe */ readonly name: string; @@ -2039,7 +2053,6 @@ export interface components { * - When updating an existing order product, requests that do not contain both fields `xxx` and `xxx_customer` will fail. * - Empty strings `''` and `null` are invalid for `xxx`, `xxx_customer, and `xxx_merchant`. If `xxx_merchant` is omitted, it will default to have the catalog value. * - If both fields `xxx` and `xxx_customer` are omitted from the request, they will default to the catalog value. - * */ readonly orderCatalogProduct_Put: { /** @description The order product `id`. To add a product to an existing order, donʼt include `id` in the payload. `id` is required when updating an order product. */ @@ -2085,7 +2098,6 @@ export interface components { * - If both fields `xxx` and `xxx_customer` are present, they must have same value. * - Empty strings `''` and `null` are invalid for `xxx` and `xxx_customer, and `xxx_merchant`. * - `xxx`, `xxx_customer`, and `xxx_merchant` default to the value from `catalog` if not supplied in the request. - * */ readonly orderCatalogProduct_Post: { readonly product_id?: number; @@ -2108,7 +2120,8 @@ export interface components { readonly product_options?: readonly { /** @description Numeric ID of an option applied to the product from a list of options available to the product. This field has the same value as `product_option_id` when [retrieving products in an order](/docs/rest-management/orders/order-products#list-order-products). */ readonly id?: number; - /** @description Depending on the option type, value can be one of the following: + /** + * @description Depending on the option type, value can be one of the following: * - The variant option value id or the modifier value id for modifier types with a list of defined values, such as drop down or checkbox modifiers. * - The modifier value for modifier types without a list of defined values, such as text field or date field modifiers. * @@ -2117,7 +2130,8 @@ export interface components { * - File upload * - Pick list * - For date modifiers use either the `YYYY-MM-DDThh:mm:ss±hh:mm` or the `YYYY-MM-DD` ISO-8601 formats. The date field modifier values are saved and returned as timestamps. For values entered using the YYYY-MM-DD format, the store timezone is used when creating the timestamp. - * - For multi-line text field modifiers, use the `\n` characters for separating the lines. */ + * - For multi-line text field modifiers, use the `\n` characters for separating the lines. + */ readonly value?: string; /** * @description Alias for display_name_customer. The product option name that is shown to customer in storefront. `xxx` and `xxx_customer` always hold the same value, updating either `xxx` or `xxx_customer` will change value for both of those fields. @@ -2364,17 +2378,22 @@ export interface components { * @example 225.0000 */ readonly subtotal_inc_tax?: string; - /** @description Read-only. + /** + * @description Read-only. * BasicTaxProvider - Tax is set to manual and order is created in the store. * * AvaTaxProvider - Tax is set to automatic and order is created in the store. Used for Avalara. * * "" (empty string) - The order is created with the API, or the tax provider is unknown. - * */ + */ readonly tax_provider_id?: string; /** - * @description The customer’s locale. - * @example en + * @description The customer’s locale. The supported formats are: + * - 2-char lowercase characters. e.g., `en` + * - 3-char lowercase characters. e.g., `asa` + * - 5-char the language code is 2 lowercase characters and the region code is 2 uppercase characters, with `-` in the middle. e.g., `en-US` + * - 6-char the language code is 2 lowercase character and the region code is three digit number, with `-` in the middle. e.g., `es-419` + * @example en, asa, en-US, es-419 */ readonly customer_locale?: string; /** @@ -2553,7 +2572,7 @@ export interface components { * @example recipient@email.com */ readonly recipient_email?: string; - readonly line_items?: readonly components["schemas"]["products_Resource"][]; + readonly line_items?: readonly components["schemas"]["products_Resource"][] | readonly components["schemas"]["orderProducts"][]; }; readonly pickupConsignment_Get: { /** @@ -2568,7 +2587,7 @@ export interface components { readonly pickup_method_id?: number; } & components["schemas"]["pickupConsignment_Base"] & { readonly location?: components["schemas"]["pickupConsignmentLocation_Get"]; - readonly line_items?: readonly components["schemas"]["products_Resource"][]; + readonly line_items?: readonly components["schemas"]["products_Resource"][] | readonly components["schemas"]["orderProducts"][]; }; readonly pickupConsignmentLocation_Get: { /** @@ -2584,7 +2603,7 @@ export interface components { */ readonly id?: number; } & components["schemas"]["shippingConsignment_Base"] & { - readonly line_items?: readonly components["schemas"]["products_Resource"][]; + readonly line_items?: readonly components["schemas"]["products_Resource"][] | readonly components["schemas"]["orderProducts"][]; /** * @description The total number of items in the order. * @example 1 @@ -2720,7 +2739,7 @@ export interface components { * @example recipient@email.com */ readonly recipient_email?: string; - readonly line_items?: readonly components["schemas"]["products_Resource"][]; + readonly line_items?: readonly components["schemas"]["products_Resource"][] | readonly components["schemas"]["orderProducts"][]; }; /** orderFees_Resp */ readonly orderFees_Resp: { @@ -3042,29 +3061,37 @@ export interface components { readonly cart_id: string; /** @description The display name of the payment method used on the order. For example, `Manual`, `Credit Card`, `cash`, `Test Payment Gateway`, etc.' */ readonly payment_method: string; - /** @description Minimum date the order was created in RFC-2822 or ISO-8601. + /** + * @description Minimum date the order was created in RFC-2822 or ISO-8601. * * RFC-2822: `Thu, 20 Apr 2017 11:32:00 -0400` * - * ISO-8601: `2017-04-20T11:32:00.000-04:00` */ + * ISO-8601: `2017-04-20T11:32:00.000-04:00` + */ readonly min_date_created: string; - /** @description Maximum date the order was created in RFC-2822 or ISO-8601. + /** + * @description Maximum date the order was created in RFC-2822 or ISO-8601. * * RFC-2822: `Thu, 20 Apr 2017 11:32:00 -0400` * - * ISO-8601: `2017-04-20T11:32:00.000-04:00` */ + * ISO-8601: `2017-04-20T11:32:00.000-04:00` + */ readonly max_date_created: string; - /** @description Minimum date the order was modified in RFC-2822 or ISO-8601. + /** + * @description Minimum date the order was modified in RFC-2822 or ISO-8601. * * RFC-2822: `Thu, 20 Apr 2017 11:32:00 -0400` * - * ISO-8601: `2017-04-20T11:32:00.000-04:00` */ + * ISO-8601: `2017-04-20T11:32:00.000-04:00` + */ readonly min_date_modified: string; - /** @description Maximum date the order was modified in RFC-2822 or ISO-8601. + /** + * @description Maximum date the order was modified in RFC-2822 or ISO-8601. * * RFC-2822: `Thu, 20 Apr 2017 11:32:00 -0400` * - * ISO-8601: `2017-04-20T11:32:00.000-04:00` */ + * ISO-8601: `2017-04-20T11:32:00.000-04:00` + */ readonly max_date_modified: string; /** @description The page to return in the response. */ readonly page: number; @@ -3090,9 +3117,11 @@ export interface components { readonly shipping_consignment_id: number; /** @description Should be specified along with `include=consignments` or `include=consignments.line_items` to return consignments in the supported object structure. The default array structure provided is legacy and may not be supported in the future. */ readonly consignment_structure: "object"; - /** @description * `consignments` - include the response returned from the request to the `/orders/{order_id}/consignments` endpoint. You should also specify `consignment_structure=object` as a request parameter when including consignments. The default array structure provided is legacy and may not be supported in the future. - * * `consignments.line_items` - include the response returned from the request to the `/orders/{order_id}/products` endpoint in consignments. This implies `include=consignments`. You should also specify `consignment_structure=object` as a request parameter when including consignments. The default array structure provided is legacy and will be removed in the future. - * * `fees` - include the response returned from the request to the `/orders/{order_id}/fees` endpoint. */ + /** + * @description * `consignments` - include the response returned from the request to the `/orders/{order_id}/consignments` endpoint. Current default array structure is legacy and will be deprecated from **1 Feb 2026**. Specify `consignment_structure=object` as a request parameter when including consignments. + * * `consignments.line_items` - include the response returned from the request to the `/orders/{order_id}/products` endpoint in consignments. This will also includes the resources associated with `include=consignments`. Current default array structure is legacy and will be deprecated from **1 Feb 2026**. Specify `consignment_structure=object` as a request parameter when including consignments. + * * `fees` - include the response returned from the request to the `/orders/{order_id}/fees` endpoint. + */ readonly order_includes: readonly ("consignments" | "consignments.line_items" | "fees")[]; }; requestBodies: never; @@ -3104,9 +3133,11 @@ export interface operations { readonly getOrder: { readonly parameters: { readonly query?: { - /** @description * `consignments` - include the response returned from the request to the `/orders/{order_id}/consignments` endpoint. You should also specify `consignment_structure=object` as a request parameter when including consignments. The default array structure provided is legacy and may not be supported in the future. - * * `consignments.line_items` - include the response returned from the request to the `/orders/{order_id}/products` endpoint in consignments. This implies `include=consignments`. You should also specify `consignment_structure=object` as a request parameter when including consignments. The default array structure provided is legacy and will be removed in the future. - * * `fees` - include the response returned from the request to the `/orders/{order_id}/fees` endpoint. */ + /** + * @description * `consignments` - include the response returned from the request to the `/orders/{order_id}/consignments` endpoint. Current default array structure is legacy and will be deprecated from **1 Feb 2026**. Specify `consignment_structure=object` as a request parameter when including consignments. + * * `consignments.line_items` - include the response returned from the request to the `/orders/{order_id}/products` endpoint in consignments. This will also includes the resources associated with `include=consignments`. Current default array structure is legacy and will be deprecated from **1 Feb 2026**. Specify `consignment_structure=object` as a request parameter when including consignments. + * * `fees` - include the response returned from the request to the `/orders/{order_id}/fees` endpoint. + */ readonly include?: components["parameters"]["order_includes"]; /** @description Should be specified along with `include=consignments` or `include=consignments.line_items` to return consignments in the supported object structure. The default array structure provided is legacy and may not be supported in the future. */ readonly consignment_structure?: components["parameters"]["consignment_structure"]; @@ -3203,29 +3234,37 @@ export interface operations { readonly cart_id?: components["parameters"]["cart_id"]; /** @description The display name of the payment method used on the order. For example, `Manual`, `Credit Card`, `cash`, `Test Payment Gateway`, etc.' */ readonly payment_method?: components["parameters"]["payment_method"]; - /** @description Minimum date the order was created in RFC-2822 or ISO-8601. + /** + * @description Minimum date the order was created in RFC-2822 or ISO-8601. * * RFC-2822: `Thu, 20 Apr 2017 11:32:00 -0400` * - * ISO-8601: `2017-04-20T11:32:00.000-04:00` */ + * ISO-8601: `2017-04-20T11:32:00.000-04:00` + */ readonly min_date_created?: components["parameters"]["min_date_created"]; - /** @description Maximum date the order was created in RFC-2822 or ISO-8601. + /** + * @description Maximum date the order was created in RFC-2822 or ISO-8601. * * RFC-2822: `Thu, 20 Apr 2017 11:32:00 -0400` * - * ISO-8601: `2017-04-20T11:32:00.000-04:00` */ + * ISO-8601: `2017-04-20T11:32:00.000-04:00` + */ readonly max_date_created?: components["parameters"]["max_date_created"]; - /** @description Minimum date the order was modified in RFC-2822 or ISO-8601. + /** + * @description Minimum date the order was modified in RFC-2822 or ISO-8601. * * RFC-2822: `Thu, 20 Apr 2017 11:32:00 -0400` * - * ISO-8601: `2017-04-20T11:32:00.000-04:00` */ + * ISO-8601: `2017-04-20T11:32:00.000-04:00` + */ readonly min_date_modified?: components["parameters"]["min_date_modified"]; - /** @description Maximum date the order was modified in RFC-2822 or ISO-8601. + /** + * @description Maximum date the order was modified in RFC-2822 or ISO-8601. * * RFC-2822: `Thu, 20 Apr 2017 11:32:00 -0400` * - * ISO-8601: `2017-04-20T11:32:00.000-04:00` */ + * ISO-8601: `2017-04-20T11:32:00.000-04:00` + */ readonly max_date_modified?: components["parameters"]["max_date_modified"]; /** @description The channel ID of the sales channel the shopper used to place the order. */ readonly channel_id?: components["parameters"]["channel_id"]; @@ -3265,29 +3304,37 @@ export interface operations { readonly cart_id?: components["parameters"]["cart_id"]; /** @description The display name of the payment method used on the order. For example, `Manual`, `Credit Card`, `cash`, `Test Payment Gateway`, etc.' */ readonly payment_method?: components["parameters"]["payment_method"]; - /** @description Minimum date the order was created in RFC-2822 or ISO-8601. + /** + * @description Minimum date the order was created in RFC-2822 or ISO-8601. * * RFC-2822: `Thu, 20 Apr 2017 11:32:00 -0400` * - * ISO-8601: `2017-04-20T11:32:00.000-04:00` */ + * ISO-8601: `2017-04-20T11:32:00.000-04:00` + */ readonly min_date_created?: components["parameters"]["min_date_created"]; - /** @description Maximum date the order was created in RFC-2822 or ISO-8601. + /** + * @description Maximum date the order was created in RFC-2822 or ISO-8601. * * RFC-2822: `Thu, 20 Apr 2017 11:32:00 -0400` * - * ISO-8601: `2017-04-20T11:32:00.000-04:00` */ + * ISO-8601: `2017-04-20T11:32:00.000-04:00` + */ readonly max_date_created?: components["parameters"]["max_date_created"]; - /** @description Minimum date the order was modified in RFC-2822 or ISO-8601. + /** + * @description Minimum date the order was modified in RFC-2822 or ISO-8601. * * RFC-2822: `Thu, 20 Apr 2017 11:32:00 -0400` * - * ISO-8601: `2017-04-20T11:32:00.000-04:00` */ + * ISO-8601: `2017-04-20T11:32:00.000-04:00` + */ readonly min_date_modified?: components["parameters"]["min_date_modified"]; - /** @description Maximum date the order was modified in RFC-2822 or ISO-8601. + /** + * @description Maximum date the order was modified in RFC-2822 or ISO-8601. * * RFC-2822: `Thu, 20 Apr 2017 11:32:00 -0400` * - * ISO-8601: `2017-04-20T11:32:00.000-04:00` */ + * ISO-8601: `2017-04-20T11:32:00.000-04:00` + */ readonly max_date_modified?: components["parameters"]["max_date_modified"]; /** @description The page to return in the response. */ readonly page?: components["parameters"]["page"]; @@ -3297,9 +3344,11 @@ export interface operations { readonly sort?: components["parameters"]["sort"]; /** @description The channel ID of the sales channel the shopper used to place the order. */ readonly channel_id?: components["parameters"]["channel_id"]; - /** @description * `consignments` - include the response returned from the request to the `/orders/{order_id}/consignments` endpoint. You should also specify `consignment_structure=object` as a request parameter when including consignments. The default array structure provided is legacy and may not be supported in the future. - * * `consignments.line_items` - include the response returned from the request to the `/orders/{order_id}/products` endpoint in consignments. This implies `include=consignments`. You should also specify `consignment_structure=object` as a request parameter when including consignments. The default array structure provided is legacy and will be removed in the future. - * * `fees` - include the response returned from the request to the `/orders/{order_id}/fees` endpoint. */ + /** + * @description * `consignments` - include the response returned from the request to the `/orders/{order_id}/consignments` endpoint. Current default array structure is legacy and will be deprecated from **1 Feb 2026**. Specify `consignment_structure=object` as a request parameter when including consignments. + * * `consignments.line_items` - include the response returned from the request to the `/orders/{order_id}/products` endpoint in consignments. This will also includes the resources associated with `include=consignments`. Current default array structure is legacy and will be deprecated from **1 Feb 2026**. Specify `consignment_structure=object` as a request parameter when including consignments. + * * `fees` - include the response returned from the request to the `/orders/{order_id}/fees` endpoint. + */ readonly include?: components["parameters"]["order_includes"]; /** @description Should be specified along with `include=consignments` or `include=consignments.line_items` to return consignments in the supported object structure. The default array structure provided is legacy and may not be supported in the future. */ readonly consignment_structure?: components["parameters"]["consignment_structure"]; @@ -3321,9 +3370,11 @@ export interface operations { readonly createOrder: { readonly parameters: { readonly query?: { - /** @description * `consignments` - include the response returned from the request to the `/orders/{order_id}/consignments` endpoint. You should also specify `consignment_structure=object` as a request parameter when including consignments. The default array structure provided is legacy and may not be supported in the future. - * * `consignments.line_items` - include the response returned from the request to the `/orders/{order_id}/products` endpoint in consignments. This implies `include=consignments`. You should also specify `consignment_structure=object` as a request parameter when including consignments. The default array structure provided is legacy and will be removed in the future. - * * `fees` - include the response returned from the request to the `/orders/{order_id}/fees` endpoint. */ + /** + * @description * `consignments` - include the response returned from the request to the `/orders/{order_id}/consignments` endpoint. Current default array structure is legacy and will be deprecated from **1 Feb 2026**. Specify `consignment_structure=object` as a request parameter when including consignments. + * * `consignments.line_items` - include the response returned from the request to the `/orders/{order_id}/products` endpoint in consignments. This will also includes the resources associated with `include=consignments`. Current default array structure is legacy and will be deprecated from **1 Feb 2026**. Specify `consignment_structure=object` as a request parameter when including consignments. + * * `fees` - include the response returned from the request to the `/orders/{order_id}/fees` endpoint. + */ readonly include?: components["parameters"]["order_includes"]; /** @description Should be specified along with `include=consignments` or `include=consignments.line_items` to return consignments in the supported object structure. The default array structure provided is legacy and may not be supported in the future. */ readonly consignment_structure?: components["parameters"]["consignment_structure"]; @@ -3673,17 +3724,21 @@ export interface operations { readonly max_id?: components["parameters"]["max_id"]; /** @description Customer ID. */ readonly customer_id?: components["parameters"]["customer_id"]; - /** @description Minimum date the order was created in RFC-2822 or ISO-8601. + /** + * @description Minimum date the order was created in RFC-2822 or ISO-8601. * * RFC-2822: `Thu, 20 Apr 2017 11:32:00 -0400` * - * ISO-8601: `2017-04-20T11:32:00.000-04:00` */ + * ISO-8601: `2017-04-20T11:32:00.000-04:00` + */ readonly min_date_created?: components["parameters"]["min_date_created"]; - /** @description Maximum date the order was created in RFC-2822 or ISO-8601. + /** + * @description Maximum date the order was created in RFC-2822 or ISO-8601. * * RFC-2822: `Thu, 20 Apr 2017 11:32:00 -0400` * - * ISO-8601: `2017-04-20T11:32:00.000-04:00` */ + * ISO-8601: `2017-04-20T11:32:00.000-04:00` + */ readonly max_date_created?: components["parameters"]["max_date_created"]; /** @description Whether the message is [flagged](https://support.bigcommerce.com/s/article/Communicating-with-Customers#Messages). */ readonly is_flagged?: components["parameters"]["is_flagged"]; diff --git a/src/internal/reference/generated/orders.v3.ts b/src/internal/reference/generated/orders.v3.ts index 638adb4..b92ccac 100644 --- a/src/internal/reference/generated/orders.v3.ts +++ b/src/internal/reference/generated/orders.v3.ts @@ -12,8 +12,7 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Order` to which the transactions belong. - * */ + /** @description The ID of the `Order` to which the transactions belong. */ readonly order_id: components["parameters"]["OrderIdParam"]; }; readonly cookie?: never; @@ -35,8 +34,7 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Order` to which the transactions belong. - * */ + /** @description The ID of the `Order` to which the transactions belong. */ readonly order_id: components["parameters"]["OrderIdParam"]; }; readonly cookie?: never; @@ -59,8 +57,7 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Order` to which the transactions belong. - * */ + /** @description The ID of the `Order` to which the transactions belong. */ readonly order_id: components["parameters"]["OrderIdParam"]; }; readonly cookie?: never; @@ -87,8 +84,7 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Order` to which the transactions belong. - * */ + /** @description The ID of the `Order` to which the transactions belong. */ readonly order_id: components["parameters"]["OrderIdParam"]; }; readonly cookie?: never; @@ -118,8 +114,7 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Order` to which the transactions belong. - * */ + /** @description The ID of the `Order` to which the transactions belong. */ readonly order_id: components["parameters"]["OrderIdParam"]; }; readonly cookie?: never; @@ -197,8 +192,7 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Order` to which the transactions belong. - * */ + /** @description The ID of the `Order` to which the transactions belong. */ readonly order_id: components["parameters"]["OrderIdParam"]; }; readonly cookie?: never; @@ -208,7 +202,6 @@ export interface paths { * @description Gets a `Metafield` object list, by `order_id`. * * The maximum number of metafields allowed on each order, product, category, variant, or brand is 250 per client ID. - * */ readonly get: operations["getOrderMetafields"]; /** @@ -227,11 +220,9 @@ export interface paths { readonly Accept: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Order` to which the transactions belong. - * */ + /** @description The ID of the `Order` to which the transactions belong. */ readonly order_id: components["parameters"]["OrderIdParam"]; - /** @description The ID of the `Metafield`. - * */ + /** @description The ID of the `Metafield`. */ readonly metafield_id: number; }; readonly cookie?: never; @@ -239,7 +230,6 @@ export interface paths { /** * Get a Metafield * @description Gets a `Metafield`, by `order_id`. - * */ readonly get: operations["getOrderMetafield"]; /** @@ -252,7 +242,6 @@ export interface paths { /** * Delete a Metafield * @description Deletes a `Metafield`. - * */ readonly delete: operations["deleteOrderMetafield"]; }; @@ -494,48 +483,39 @@ export interface components { readonly Pagination: { /** * @description Total number of items in the result set. - * * @example 36 */ readonly total?: number; /** * @description Total number of items in the collection response. - * * @example 36 */ readonly count?: number; /** * @description The amount of items returned in the collection per page, controlled by the limit parameter. - * * @example 50 */ readonly per_page?: number; /** * @description The page you are currently on within the collection. - * * @example 1 */ readonly current_page?: number; /** * @description The total number of pages in the collection. - * * @example 1 */ readonly total_pages?: number; - /** @description Pagination links for the previous and next parts of the whole collection. - * */ + /** @description Pagination links for the previous and next parts of the whole collection. */ readonly links?: { - /** @description Link to the previous page returned in the response. - * */ + /** @description Link to the previous page returned in the response. */ readonly previous?: string; /** * @description Link to the current page returned in the response. - * * @example ?page=1&limit=50 */ readonly current?: string; - /** @description Link to the next page returned in the response. - * */ + /** @description Link to the next page returned in the response. */ readonly next?: string; }; }; @@ -646,48 +626,39 @@ export interface components { readonly pagination?: { /** * @description Total number of items in the result set. - * * @example 36 */ readonly total?: number; /** * @description Total number of items in the collection response. - * * @example 36 */ readonly count?: number; /** * @description The amount of items returned in the collection per page, controlled by the limit parameter. - * * @example 50 */ readonly per_page?: number; /** * @description The page you are currently on within the collection. - * * @example 1 */ readonly current_page?: number; /** * @description The total number of pages in the collection. - * * @example 1 */ readonly total_pages?: number; - /** @description Pagination links for the previous and next parts of the whole collection. - * */ + /** @description Pagination links for the previous and next parts of the whole collection. */ readonly links?: { - /** @description Link to the previous page returned in the response. - * */ + /** @description Link to the previous page returned in the response. */ readonly previous?: string; /** * @description Link to the current page returned in the response. - * * @example ?page=1&limit=50 */ readonly current?: string; - /** @description Link to the next page returned in the response. - * */ + /** @description Link to the next page returned in the response. */ readonly next?: string; }; }; @@ -701,48 +672,39 @@ export interface components { readonly meta?: { /** * @description Total number of items in the result set. - * * @example 36 */ readonly total?: number; /** * @description Total number of items in the collection response. - * * @example 36 */ readonly count?: number; /** * @description The amount of items returned in the collection per page, controlled by the limit parameter. - * * @example 50 */ readonly per_page?: number; /** * @description The page you are currently on within the collection. - * * @example 1 */ readonly current_page?: number; /** * @description The total number of pages in the collection. - * * @example 1 */ readonly total_pages?: number; - /** @description Pagination links for the previous and next parts of the whole collection. - * */ + /** @description Pagination links for the previous and next parts of the whole collection. */ readonly links?: { - /** @description Link to the previous page returned in the response. - * */ + /** @description Link to the previous page returned in the response. */ readonly previous?: string; /** * @description Link to the current page returned in the response. - * * @example ?page=1&limit=50 */ readonly current?: string; - /** @description Link to the next page returned in the response. - * */ + /** @description Link to the next page returned in the response. */ readonly next?: string; }; }; @@ -762,57 +724,46 @@ export interface components { readonly Transaction_Post: { /** * @description Store event that created the transaction. - * * @enum {string} */ readonly event: "purchase" | "authorization" | "capture" | "refund" | "void" | "pending" | "settled"; /** * @description The payment method: `credit_card` - a credit card transaction; `electronic_wallet` - an online wallet; `store_credit` - a transaction using store credit; `gift_certificate` - a transaction using a gift certificate; `custom` - manual payment methods; `token` - payment token; `nonce` - temporary payment token; `offsite` - online payment off the site (e.g., PayPal); `offline` - payment method that takes place offline. - * * @enum {string} */ readonly method: "credit_card" | "electronic_wallet" | "gift_certificate" | "store_credit" | "apple_pay_card" | "apple_pay_token" | "bigpay_token" | "token" | "custom" | "offsite" | "offline" | "nonce"; /** * Format: float * @description Amount of money in the transaction. - * */ readonly amount: number; /** * Format: ISO-4217 * @description Currency used for the transaction. - * */ readonly currency: string; /** * @description The payment gateway, where applicable. - * * @enum {string} */ readonly gateway: "2checkout" | "adyen" | "amazon" | "authorizenet" | "bankdeposit" | "braintree" | "cheque" | "cod" | "custom" | "firstdatagge4" | "giftcertificate" | "hps" | "instore" | "klarna" | "migs" | "moneyorder" | "nmi" | "paypalexpress" | "paypalpaymentsprous" | "paypalpaymentsprouk" | "plugnpay" | "qbmsv2" | "securenet" | "square" | "storecredit" | "stripe" | "testgateway" | "usaepay"; - /** @description The transaction ID returned by the payment gateway for this transaction item. - * */ + /** @description The transaction ID returned by the payment gateway for this transaction item. */ readonly gateway_transaction_id?: string; /** * Format: date-time * @description The date/time of the transaction. - * */ readonly date_created?: string; - /** @description True if the transaction performed was a test, or if the gateway is in test mode. - * */ + /** @description True if the transaction performed was a test, or if the gateway is in test mode. */ readonly test?: boolean; /** * @description Status of the transaction. - * * @enum {string} */ readonly status?: "ok" | "error"; - /** @description Result of gateway fraud review, if any. Default is `false`. - * */ + /** @description Result of gateway fraud review, if any. Default is `false`. */ readonly fraud_review?: boolean; - /** @description Identifier for an existing transaction upon which this transaction acts. - * */ + /** @description Identifier for an existing transaction upon which this transaction acts. */ readonly reference_transaction_id?: number; readonly offline?: components["schemas"]["Offline"]; readonly custom?: components["schemas"]["Custom"]; @@ -822,8 +773,7 @@ export interface components { * @description Error payload for the BigCommerce API. */ readonly NotFound: { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The resource at that URL is not found. */ readonly title?: string; @@ -834,59 +784,48 @@ export interface components { readonly Transaction: { /** * @description Store event that created the transaction. - * * @enum {string} */ readonly event: "purchase" | "authorization" | "capture" | "refund" | "void" | "pending" | "settled"; /** * @description The payment method: `credit_card` - a credit card transaction; `electronic_wallet` - an online wallet; `store_credit` - a transaction using store credit; `gift_certificate` - a transaction using a gift certificate; `custom` - manual payment methods; `token` - payment token; `nonce` - temporary payment token; `offsite` - online payment off the site; `offline` - payment method that takes place offline. - * * @enum {string} */ readonly method: "credit_card" | "electronic_wallet" | "gift_certificate" | "store_credit" | "apple_pay_card" | "bigpay_token" | "apple_pay_token" | "token" | "custom" | "offsite" | "offline" | "nonce"; /** * Format: float * @description Amount of money in the transaction. - * */ readonly amount: number; /** * Format: ISO-4217 * @description Currency used for the transaction. - * */ readonly currency: string; /** * @description The payment gateway, where applicable. - * * @enum {string} */ readonly gateway: "2checkout" | "adyen" | "amazon" | "authorizenet" | "bankdeposit" | "braintree" | "cheque" | "cod" | "custom" | "firstdatagge4" | "giftcertificate" | "hps" | "instore" | "klarna" | "migs" | "moneyorder" | "nmi" | "paypalexpress" | "paypalpaymentsprous" | "paypalpaymentsprouk" | "plugnpay" | "qbmsv2" | "securenet" | "square" | "storecredit" | "stripe" | "testgateway" | "usaepay"; - /** @description The transaction ID returned by the payment gateway for this transaction item. - * */ + /** @description The transaction ID returned by the payment gateway for this transaction item. */ readonly gateway_transaction_id?: string; - /** @description True if the transaction performed was a test, or if the gateway is in test mode. - * */ + /** @description True if the transaction performed was a test, or if the gateway is in test mode. */ readonly test?: boolean; /** * @description Status of the transaction. - * * @enum {string} */ readonly status?: "ok" | "error"; - /** @description Result of gateway fraud review, if any. Default is `false`. - * */ + /** @description Result of gateway fraud review, if any. Default is `false`. */ readonly fraud_review?: boolean; - /** @description Identifier for an existing transaction upon which this transaction acts. - * */ + /** @description Identifier for an existing transaction upon which this transaction acts. */ readonly reference_transaction_id?: number; /** * Offline * @description Offline payment (e.g., check or purchase order). */ readonly offline?: { - /** @description Display name for the offline payment. - * */ + /** @description Display name for the offline payment. */ readonly display_name?: string; } | null; /** @@ -894,24 +833,19 @@ export interface components { * @description Custom payment from manual order. */ readonly custom?: { - /** @description Text entered for the payment method in the control panel. - * */ + /** @description Text entered for the payment method in the control panel. */ readonly payment_method?: string; } | null; - /** @description The payment method ID used for this transaction. - * */ + /** @description The payment method ID used for this transaction. */ readonly payment_method_id?: string; } & { - /** @description Unique identifier for the transaction. - * */ + /** @description Unique identifier for the transaction. */ readonly id?: number; - /** @description Identifier for the BigCommerce Order with which this transaction is associated. - * */ + /** @description Identifier for the BigCommerce Order with which this transaction is associated. */ readonly order_id?: string; /** * Format: date-time * @description The date/time of the transaction in ISO-8601 format. - * */ readonly date_created?: string; /** @description This field contains internal BigPay token for stored card that is then mapped to the actual third-party token. We currently do not offer a way to get third party tokens.These tokens are read-only and do not return any information about the payment. */ @@ -948,45 +882,38 @@ export interface components { readonly gift_certificate?: { /** * @description The gift-certificate code. - * * @example MB345 */ readonly code?: string; /** * Format: float * @description The balance on a gift certificate when it was purchased. - * * @example 100 */ readonly original_balance?: number; /** * Format: float * @description The balance on a gift certificate at the time of this purchase. - * * @example 100 */ readonly starting_balance?: number; /** * Format: float * @description The remaining balance on a gift certificate. - * * @example 35.42 */ readonly remaining_balance?: number; /** * @description The status of a gift certificate: `active` - gift certificate is active; `pending` - gift certificate purchase is pending; `disabled` - gift certificate is disabled; `expired` - gift certificate is expired. - * * @enum {string} */ readonly status?: "active" | "pending" | "disabled" | "expired"; } | null; - /** @description A store credit model. - * */ + /** @description A store credit model. */ readonly store_credit?: { /** * Format: float * @description Remaining balance of shopperʼs store credit. - * * @example 35.42 */ readonly remaining_balance?: number; @@ -996,19 +923,15 @@ export interface components { * @description Fields for custom payment providers. */ readonly custom_provider_field_result?: { - /** @description The receipt number associated with the transaction. - * */ + /** @description The receipt number associated with the transaction. */ readonly receipt_number?: string | null; - /** @description Authorization code for the transaction. - * */ + /** @description Authorization code for the transaction. */ readonly authorization_code?: string | null; - /** @description The fraud response associated with the transaction. - * */ + /** @description The fraud response associated with the transaction. */ readonly fraud_response?: string | null; /** * Format: float * @description The amount received for the transaction, divided by 100 to convert to the correct currency format. - * */ readonly amount_received?: number | null; } | null; @@ -1023,26 +946,20 @@ export interface components { * @enum {string} */ readonly card_type?: "alelo" | "alia" | "american_express" | "cabal" | "carnet" | "dankort" | "diners_club" | "discover" | "elo" | "forbrugsforeningen" | "jcb" | "maestro" | "master" | "naranja" | "sodexo" | "unionpay" | "visa" | "vr"; - /** @description The IIN of a credit card number. - * */ + /** @description The IIN of a credit card number. */ readonly card_iin?: string; - /** @description The last 4 digits of a credit card number. - * */ + /** @description The last 4 digits of a credit card number. */ readonly card_last4?: string; - /** @description The expiry month of a credit card. - * */ + /** @description The expiry month of a credit card. */ readonly card_expiry_month?: number; - /** @description The expiry year of a credit card. - * */ + /** @description The expiry year of a credit card. */ readonly card_expiry_year?: number; }; - /** @description A store credit model. - * */ + /** @description A store credit model. */ readonly StoreCredit: { /** * Format: float * @description Remaining balance of shopperʼs store credit. - * * @example 35.42 */ readonly remaining_balance?: number; @@ -1052,8 +969,7 @@ export interface components { * @description Custom payment from manual order. */ readonly Custom: { - /** @description Text entered for the payment method in the control panel. - * */ + /** @description Text entered for the payment method in the control panel. */ readonly payment_method?: string; }; /** @@ -1061,8 +977,7 @@ export interface components { * @description Offline payment (e.g., check or purchase order). */ readonly Offline: { - /** @description Display name for the offline payment. - * */ + /** @description Display name for the offline payment. */ readonly display_name?: string; }; /** @@ -1072,34 +987,29 @@ export interface components { readonly GiftCertificate: { /** * @description The gift-certificate code. - * * @example MB345 */ readonly code?: string; /** * Format: float * @description The balance on a gift certificate when it was purchased. - * * @example 100 */ readonly original_balance?: number; /** * Format: float * @description The balance on a gift certificate at the time of this purchase. - * * @example 100 */ readonly starting_balance?: number; /** * Format: float * @description The remaining balance on a gift certificate. - * * @example 35.42 */ readonly remaining_balance?: number; /** * @description The status of a gift certificate: `active` - gift certificate is active; `pending` - gift certificate purchase is pending; `disabled` - gift certificate is disabled; `expired` - gift certificate is expired. - * * @enum {string} */ readonly status?: "active" | "pending" | "disabled" | "expired"; @@ -1133,8 +1043,7 @@ export interface components { * @description No-content response for the BigCommerce API. */ readonly NoContent: { - /** @description 204 HTTP status code. - * */ + /** @description 204 HTTP status code. */ readonly status?: number; /** @description The error title describing the situation. */ readonly title?: string; @@ -1183,17 +1092,14 @@ export interface components { }; /** links_Full */ readonly links_Full: { - /** @description Link to the previous page returned in the response. - * */ + /** @description Link to the previous page returned in the response. */ readonly previous?: string; /** * @description Link to the current page returned in the response. - * * @example ?page=1&limit=50 */ readonly current?: string; - /** @description Link to the next page returned in the response. - * */ + /** @description Link to the next page returned in the response. */ readonly next?: string; }; /** @@ -1201,11 +1107,9 @@ export interface components { * @description Error payload for the BigCommerce API. */ readonly error_Base: { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -1240,7 +1144,8 @@ export interface components { readonly adjustment?: components["schemas"]["AdjustmentAmount"]; /** @description Indicate if `total_refund_amount` includes tax amount. */ readonly tax_inclusive?: boolean; - /** @description An array of available refund methods. + /** + * @description An array of available refund methods. * * Note that `refund_methods` is an array of refund methods, with each refund method being an array of payment options. * @@ -1295,7 +1200,7 @@ export interface components { * 1. Refund up to the entire order amount to store credit. * 2. Mark an amount up to the full order amount as refunded externally, through a provider or means not represented directly in BC ("custom"). * 3. Refund the amount paid by store credit to store credit, and the amount paid by bank deposit with a manual refund, which will be recorded as being refunded against the bank deposit. - * */ + */ readonly refund_methods?: readonly components["schemas"]["RefundMethod"][]; }; /** @@ -1316,81 +1221,65 @@ export interface components { }; readonly RefundID_Get: { readonly data?: { - /** @description Refund ID for the returned refund. - * */ + /** @description Refund ID for the returned refund. */ readonly id?: number; /** @description Order ID associated with the refund. */ readonly order_id?: number; - /** @description Reference to the user ID who created the refund. This is automatically populated by BigCommerce. - * */ + /** @description Reference to the user ID who created the refund. This is automatically populated by BigCommerce. */ readonly user_id?: number; /** * Format: date-time * @description Timestamp of when the refund was created. - * */ readonly created?: string; - /** @description Reason for refund. - * */ + /** @description Reason for refund. */ readonly reason?: string; /** * @description A non-negative 2 decimal place rounded value that represents the amount that can be refunded with the correct payment provider(s). - * * @example 109.11 */ readonly total_amount?: number; - /** @description Total tax amount refunded back to the shopper. This can be a negative amount indicating we have collected tax by refunding less to the customer. - * */ + /** @description Total tax amount refunded back to the shopper. This can be a negative amount indicating we have collected tax by refunding less to the customer. */ readonly total_tax?: number; - /** @description Whether refund amount and tax are provided explicitly by merchant override. - * */ + /** @description Whether refund amount and tax are provided explicitly by merchant override. */ readonly uses_merchant_override_values?: boolean; readonly payments?: readonly { - /** @description Reference to refund payment ID. - * */ + /** @description Reference to refund payment ID. */ readonly id?: number; - /** @description Reference to payment provider. + /** + * @description Reference to payment provider. * example: storecredit - * */ + */ readonly provider_id?: string; /** * @description A non-negative two decimal place rounded value represents the amount that can be charged/refunded with payment providers. - * * @example 109.11 */ readonly amount?: number; - /** @description Indicates whether the payment was offline. - * */ + /** @description Indicates whether the payment was offline. */ readonly offline?: boolean; - /** @description Indicates if this payment has been declined by the payment provider. - * */ + /** @description Indicates if this payment has been declined by the payment provider. */ readonly is_declined?: boolean; - /** @description Message indicates why the payment was declined. - * */ + /** @description Message indicates why the payment was declined. */ readonly declined_message?: string; }[]; /** @description Array of items refunded. In cases when `tax_refund_adjustment` was used to create the refund, this array will be empty. */ readonly items?: readonly { /** * @description Type of item that was refunded. - * * @enum {string} */ readonly item_type?: "PRODUCT" | "GIFT_WRAPPING" | "SHIPPING" | "HANDLING" | "ORDER" | "FEE"; - /** @description `order_product.id` corresponding to the item_types of PRODUCT, GIFT_WRAPPING. `order_address.id` corresponding to the item_types of SHIPPING, HANDLING. `order.id` corresponding to the item_type of ORDER, FEE. - * */ + /** @description `order_product.id` corresponding to the item_types of PRODUCT, GIFT_WRAPPING. `order_address.id` corresponding to the item_types of SHIPPING, HANDLING. `order.id` corresponding to the item_type of ORDER, FEE. */ readonly item_id?: number; - /** @description Quantity of item refunded. Note: this will only be populated for item_type PRODUCT. - * */ + /** @description Quantity of item refunded. Note: this will only be populated for item_type PRODUCT. */ readonly quantity?: number; /** * @description A non-negative two decimal place rounded value that represents the amount that can be refunded with the payment provider(s). - * * @example 109.11 */ readonly requested_amount?: string | null; - /** @description Reason for refunding an item. - * */ + /** @description Reason for refunding an item. */ readonly reason?: string; }[]; }; @@ -1444,7 +1333,6 @@ export interface components { * Type of refund item that capture refunding of items in the order that are of type quantity. * * `PRODUCT` * * `GIFT_WRAPPING` - * */ readonly QuantityBoundItem: { /** @@ -1567,10 +1455,18 @@ export interface components { * - bypass any tax correction due to tax rate/providers changes between when a customer places an order and a merchant initiates a refund * - use explicit values calculated by external systems (e.g., merchants' own Extended Producer Responsibility or Order Management System) * + * When using this when submitting refunds, please update the amount in payments section of the request payload to match the override value. + * * Note: when using the override, BC internal tax based refund calculation is skipped and therefore order/taxes records are not updated. */ readonly MerchantOverride: { - readonly total_amount: components["schemas"]["Amount"]; + /** + * Amount + * Format: float + * @description A non-negative 2 decimal place rounded value that represents the amount that to be used as override for the refund. + * @example 9.99 + */ + readonly total_amount: number; /** @description Total tax amount refunded back to the shopper. Use 0 value if there is no tax liability change for the refund or tax does not need to be recorded on the refund and would be handled externally. */ readonly total_tax: number; }; @@ -1584,12 +1480,10 @@ export interface components { /** Items Refund */ readonly RefundQuote_ItemsRefund: { readonly items: readonly components["schemas"]["ItemsRefund"][]; - readonly merchant_calculated_override?: components["schemas"]["MerchantOverride"]; }; /** Tax Adjustment Refund */ readonly RefundQuote_TaxAdjustmentAmount: { readonly tax_adjustment_amount: components["schemas"]["TaxAdjustmentAmount"]; - readonly merchant_calculated_override?: components["schemas"]["MerchantOverride"]; }; /** Refund */ readonly Refund: { @@ -1721,14 +1615,12 @@ export interface components { readonly success?: number; readonly total?: number; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponse: { readonly data?: readonly components["schemas"]["Metafield"][]; readonly meta?: components["schemas"]["CollectionMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponse_POST_PUT: { readonly data?: readonly components["schemas"]["Metafield"][]; /** @@ -1738,14 +1630,12 @@ export interface components { readonly errors?: readonly unknown[]; readonly meta?: components["schemas"]["BatchOperationMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetafieldResponse: { readonly data?: components["schemas"]["Metafield"]; readonly meta?: components["schemas"]["metaEmpty_Full"]; }; - /** @description Common Metafield properties. - * */ + /** @description Common Metafield properties. */ readonly MetafieldBase: { /** * @description Determines the visibility and writeability of the field by other API consumers. @@ -1757,50 +1647,42 @@ export interface components { * |`write`|Open for reading and writing by other API consumers| * |`read_and_sf_access`|Visible to other API consumers, including on storefront| * |`write_and_sf_access`|Open for reading and writing by other API consumers, including on storefront| - * * @enum {string} */ readonly permission_set: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; /** * @description Namespace for the metafield, for organizational purposes. - * * @example Sales Department */ readonly namespace?: string; /** * @description The name of the field, for example: `location_id`, `color`. - * * @example Staff Name */ readonly key?: string; /** * @description The value of the field, for example: `1`, `blue`. - * * @example Ronaldo */ readonly value?: string; /** * @description Description for the metafields. - * * @example order */ readonly description?: string; /** * @description The type of resource with which the metafield is associated. - * * @example order * @enum {string} */ readonly resource_type?: "order" | "brand" | "product" | "variant" | "category"; /** * @description The unique identifier for the resource with which the metafield is associated. - * * @example 0 */ readonly resource_id?: number; }; - /** @description Common Metafield properties. - * */ + /** @description Common Metafield properties. */ readonly MetafieldBase_Post: { /** * @description Determines the visibility and writeability of the field by other API consumers. @@ -1812,52 +1694,43 @@ export interface components { * |`write`|Open for reading and writing by other API consumers| * |`read_and_sf_access`|Visible to other API consumers, including on storefront| * |`write_and_sf_access`|Open for reading and writing by other API consumers, including on storefront| - * * @enum {string} */ readonly permission_set: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; /** * @description Namespace for the metafield, for organizational purposes. - * * @example Sales Department */ readonly namespace: string; /** * @description The name of the field, for example: `location_id`, `color`. - * * @example Staff Name */ readonly key: string; /** * @description The value of the field, for example: `1`, `blue`. - * * @example Ronaldo */ readonly value: string; /** * @description Description for the metafields. - * * @example Name of Staff Member */ readonly description?: string; }; - /** @description Allows app partners to write custom data to various resources in the API. - * */ + /** @description Allows app partners to write custom data to various resources in the API. */ readonly Metafield: components["schemas"]["MetafieldBase"] & { - /** @description The unique identifier for the metafields. - * */ + /** @description The unique identifier for the metafields. */ readonly id?: number; /** * Format: date-time * @description Date and time of the metafieldʼs creation. - * * @example 2022-06-16T18:39:00+00:00 */ readonly date_created?: string; /** * Format: date-time * @description Date and time when the metafield was last updated. - * * @example 2022-06-16T18:39:00+00:00 */ readonly date_modified?: string; @@ -1867,8 +1740,7 @@ export interface components { */ readonly owner_client_id?: string; }; - /** @description The model for a PUT to update metafield. - * */ + /** @description The model for a PUT to update metafield. */ readonly MetafieldPut: components["schemas"]["MetafieldBase_Post"]; /** * GlobalOrderSettings @@ -1904,31 +1776,32 @@ export interface components { }; }; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponsePartialSuccess_POST_PUT: { readonly data?: readonly components["schemas"]["Metafield"][]; readonly errors?: readonly components["schemas"]["Error"][]; readonly meta?: components["schemas"]["WriteCollectionPartialSuccessMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponsePartialSuccess_DELETE: { - /** @example [ + /** + * @example [ * 123 - * ] */ + * ] + */ readonly data?: readonly number[]; readonly errors?: readonly components["schemas"]["Error"][]; readonly meta?: components["schemas"]["WriteCollectionPartialSuccessMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionDeleteResponseSuccess: { - /** @example [ + /** + * @example [ * 123, * 124, * 125 - * ] */ + * ] + */ readonly data?: readonly number[]; /** * @description Empty for 200 responses. @@ -1944,19 +1817,16 @@ export interface components { readonly WriteCollectionPartialSuccessMeta: { /** * @description Total number of items in the result set. - * * @example 3 */ readonly total?: number; /** * @description Total number of items that were successfully deleted. - * * @example 1 */ readonly success?: number; /** * @description Total number of items that failed to be deleted. - * * @example 2 */ readonly failed?: number; @@ -1968,59 +1838,49 @@ export interface components { readonly WriteCollectionSuccessMeta: { /** * @description Total number of items in the result set. - * * @example 3 */ readonly total?: number; /** * @description Total number of items that were successfully deleted. - * * @example 3 */ readonly success?: number; /** * @description Total number of items that failed to be deleted. - * * @example 0 */ readonly failed?: number; }; /** * @description Total number of items in the result set. - * * @example 3 */ readonly Total: number; /** * @description Total number of items that were successfully deleted. - * * @example 1 */ readonly Success: number; /** * @description Total number of items that failed to be deleted. - * * @example 2 */ readonly Failed: number; - /** @description Error response payload for the BigCommerce API. - * */ + /** @description Error response payload for the BigCommerce API. */ readonly Error: { /** * @description The HTTP status code for the error. - * * @example 422 */ readonly status?: number; /** * @description The error title. - * * @example Bulk operation has failed */ readonly title?: string; /** * @description The error type. - * * @example https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes */ readonly type?: string; @@ -2028,7 +1888,6 @@ export interface components { }; /** * @description Error detail response payload for the BigCommerce API. - * * @example { * "1": "Unauthorized to delete", * "2": "Metafield does not exist" @@ -2037,28 +1896,23 @@ export interface components { readonly ErrorDetail: { readonly [key: string]: unknown; }; - /** @description The model for a POST to create metafield. - * */ + /** @description The model for a POST to create metafield. */ readonly MetafieldPost_Batch: components["schemas"]["MetafieldBase_Post"] & { /** * @description The ID for the resource with which the metafield is associated. - * * @example 42 */ readonly resource_id: number; }; - /** @description The model for a PUT to create metafield. - * */ + /** @description The model for a PUT to create metafield. */ readonly MetafieldPut_Batch: components["schemas"]["MetafieldBase_Post"] & { /** * @description The ID of metafield to update. - * * @example 42 */ readonly id: number; /** * @description The ID for the resource with which the metafield is associated. - * * @example 42 */ readonly resource_id?: number; @@ -2093,14 +1947,11 @@ export interface components { readonly [key: string]: unknown; }; }; - /** @description Error payload for the BigCommerce API. - * */ + /** @description Error payload for the BigCommerce API. */ readonly BaseError: { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -2211,8 +2062,10 @@ export interface components { readonly "application/json": components["schemas"]["error_Base"]; }; }; - /** @description Malformed request syntax. Typically need to fix the JSON. - * Body to resend successfully. */ + /** + * @description Malformed request syntax. Typically need to fix the JSON. + * Body to resend successfully. + */ readonly "400_BadRequest": { headers: { readonly [name: string]: unknown; @@ -2350,15 +2203,13 @@ export interface components { content: { readonly "application/json": { readonly data?: components["schemas"]["Transaction_Post"] & { - /** @description Unique identifier for the transaction. - * */ + /** @description Unique identifier for the transaction. */ readonly id?: number; /** @description Identifier for the BigCommerce Order with which this transaction is associated. */ readonly order_id?: string; /** * Format: date-time * @description The datetime of the transaction. - * */ readonly date_created?: string; /** @description This field contains internal BigPay token for stored card that is then mapped to the actual third-party token. We currently do not offer a way to get third party tokens.These tokens are read-only and do not return any information about the payment. */ @@ -2395,15 +2246,13 @@ export interface components { }; }; parameters: { - /** @description The ID of the `Order` to which the transactions belong. - * */ + /** @description The ID of the `Order` to which the transactions belong. */ readonly OrderIdParam: number; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept: string; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly ContentType: string; - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly PageParam: number; /** @description Filter items by minimum date created. For example, `date_created:min=2019-09-04T00:00:00` or `date_created:min=2019-09-04`. Returns metafields created after this date. */ readonly date_created_min: string; @@ -2417,24 +2266,19 @@ export interface components { readonly date_modified_max: string; /** @description Filter items by date modified. For example, `date_modified=2019-09-04T00:00:00`. Returns metafields modified on this date. */ readonly date_modified: string; - /** @description The ID of the `Metafield`. - * */ + /** @description The ID of the `Metafield`. */ readonly MetafieldIdParam: number; - /** @description Filter based on a metafieldʼs key. - * */ + /** @description Filter based on a metafieldʼs key. */ readonly MetafieldKeyParam: string; /** @description Filter using a comma-separated list of metafield keys. Could be used with vanilla `key` query parameter. */ readonly MetafieldKeyInParam: readonly string[]; - /** @description Filter based on a metafieldʼs key. - * */ + /** @description Filter based on a metafieldʼs key. */ readonly MetafieldNamespaceParam: string; /** @description Filter using a comma-separated list of metafield namespaces. Can be used with vanilla `namespace` query parameter. */ readonly MetafieldNamespaceInParam: readonly string[]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly LimitParam: number; - /** @description Sort direction. Acceptable values are: `asc`, `desc`. - * */ + /** @description Sort direction. Acceptable values are: `asc`, `desc`. */ readonly DirectionParam: "asc" | "desc"; /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */ readonly IncludeFieldsParamMetafields: readonly ("resource_id" | "key" | "value" | "namespace" | "permission_set" | "resource_type" | "description" | "owner_client_id" | "date_created" | "date_modified")[]; @@ -2455,8 +2299,7 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Order` to which the transactions belong. - * */ + /** @description The ID of the `Order` to which the transactions belong. */ readonly order_id: components["parameters"]["OrderIdParam"]; }; readonly cookie?: never; @@ -2482,8 +2325,7 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Order` to which the transactions belong. - * */ + /** @description The ID of the `Order` to which the transactions belong. */ readonly order_id: components["parameters"]["OrderIdParam"]; }; readonly cookie?: never; @@ -2507,8 +2349,7 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Order` to which the transactions belong. - * */ + /** @description The ID of the `Order` to which the transactions belong. */ readonly order_id: components["parameters"]["OrderIdParam"]; }; readonly cookie?: never; @@ -2516,16 +2357,14 @@ export interface operations { readonly requestBody?: never; readonly responses: { readonly 200: components["responses"]["TransactionCollection_Resp"]; - /** @description No content found to fulfill request. - * */ + /** @description No content found to fulfill request. */ readonly 204: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 204 HTTP status code. - * */ + /** @description 204 HTTP status code. */ readonly status?: number; /** @description The error title describing the situation. */ readonly title?: string; @@ -2534,16 +2373,14 @@ export interface operations { }; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -2552,16 +2389,14 @@ export interface operations { }; }; }; - /** @description Service Unavailable. - * */ + /** @description Service Unavailable. */ readonly 503: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 503 HTTP status code. - * */ + /** @description 503 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -2581,8 +2416,7 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Order` to which the transactions belong. - * */ + /** @description The ID of the `Order` to which the transactions belong. */ readonly order_id: components["parameters"]["OrderIdParam"]; }; readonly cookie?: never; @@ -2610,8 +2444,7 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Order` to which the transactions belong. - * */ + /** @description The ID of the `Order` to which the transactions belong. */ readonly order_id: components["parameters"]["OrderIdParam"]; }; readonly cookie?: never; @@ -2634,8 +2467,7 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Order` to which the transactions belong. - * */ + /** @description The ID of the `Order` to which the transactions belong. */ readonly order_id: components["parameters"]["OrderIdParam"]; }; readonly cookie?: never; @@ -2647,8 +2479,7 @@ export interface operations { }; readonly responses: { readonly 201: components["responses"]["Refund_Resp"]; - /** @description Unable to process a guest refund with store credit. - * */ + /** @description Unable to process a guest refund with store credit. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -2698,18 +2529,22 @@ export interface operations { readonly "order_id:in"?: readonly number[]; /** @description Pass a comma-separated list of refund IDs to filter the included refunds. Accepts multiple values. */ readonly "id:in"?: readonly number[]; - /** @description Filter results so they are later than or equal to provided date. + /** + * @description Filter results so they are later than or equal to provided date. * * * Must be in url-encoded RFC 3339 format. * e.g. `2020-01-15T01:02:34-01:00` is RFC 3339 format. - * Url-encoded this will be `2020-01-15T01%3A02%3A34%2B01%3A00` */ + * Url-encoded this will be `2020-01-15T01%3A02%3A34%2B01%3A00` + */ readonly "created:min"?: string; - /** @description Filter results so they are earlier than or equal to provided date. + /** + * @description Filter results so they are earlier than or equal to provided date. * * Must be in url-encoded RFC 3339 format. * e.g. `2020-01-15T01:02:34-01:00` is RFC 3339 format. - * Url-encoded this will be `2020-01-15T01%3A02%3A34%2B01%3A00` */ + * Url-encoded this will be `2020-01-15T01%3A02%3A34%2B01%3A00` + */ readonly "created:max"?: string; /** @description Filters by refund payment using the BigCommerce `transaction_id`. */ readonly transaction_id?: string; @@ -2733,20 +2568,15 @@ export interface operations { readonly getOrderMetafields: { readonly parameters: { readonly query?: { - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; - /** @description Filter based on a metafieldʼs key. - * */ + /** @description Filter based on a metafieldʼs key. */ readonly key?: components["parameters"]["MetafieldKeyParam"]; - /** @description Filter based on a metafieldʼs key. - * */ + /** @description Filter based on a metafieldʼs key. */ readonly namespace?: components["parameters"]["MetafieldNamespaceParam"]; - /** @description Sort direction. Acceptable values are: `asc`, `desc`. - * */ + /** @description Sort direction. Acceptable values are: `asc`, `desc`. */ readonly direction?: components["parameters"]["DirectionParam"]; }; readonly header?: { @@ -2754,16 +2584,14 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Order` to which the transactions belong. - * */ + /** @description The ID of the `Order` to which the transactions belong. */ readonly order_id: components["parameters"]["OrderIdParam"]; }; readonly cookie?: never; }; readonly requestBody?: never; readonly responses: { - /** @description An array of metafields and metadata. - * */ + /** @description An array of metafields and metadata. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -2784,29 +2612,28 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Order` to which the transactions belong. - * */ + /** @description The ID of the `Order` to which the transactions belong. */ readonly order_id: components["parameters"]["OrderIdParam"]; }; readonly cookie?: never; }; - /** @description A `Metafield` object. - * */ + /** @description A `Metafield` object. */ readonly requestBody: { readonly content: { - /** @example { + /** + * @example { * "permission_set": "app_only", * "namespace": "Sales Department", * "key": "Staff Name", * "value": "Sam", * "description": "Name of staff member" - * } */ + * } + */ readonly "application/json": components["schemas"]["MetafieldBase_Post"]; }; }; readonly responses: { - /** @description A `Metafield` object. - * */ + /** @description A `Metafield` object. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -2821,12 +2648,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2835,8 +2664,7 @@ export interface operations { }; }; }; - /** @description The metafield conflicts with another metafield. This can result from duplicate unique key combinations of the appʼs client ID, namespace, key, resource type, and resource ID. - * */ + /** @description The metafield conflicts with another metafield. This can result from duplicate unique key combinations of the appʼs client ID, namespace, key, resource type, and resource ID. */ readonly 409: { headers: { readonly [name: string]: unknown; @@ -2845,8 +2673,7 @@ export interface operations { readonly "application/json": components["schemas"]["ErrorResponse"]; }; }; - /** @description The `Metafield` is not valid. This is the result of missing required fields or of invalid data. See the response for more details. - * */ + /** @description The `Metafield` is not valid. This is the result of missing required fields or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -2865,19 +2692,16 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Order` to which the transactions belong. - * */ + /** @description The ID of the `Order` to which the transactions belong. */ readonly order_id: components["parameters"]["OrderIdParam"]; - /** @description The ID of the `Metafield`. - * */ + /** @description The ID of the `Metafield`. */ readonly metafield_id: number; }; readonly cookie?: never; }; readonly requestBody?: never; readonly responses: { - /** @description A `Metafield` object. - * */ + /** @description A `Metafield` object. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -2886,8 +2710,7 @@ export interface operations { readonly "application/json": components["schemas"]["MetafieldResponse"]; }; }; - /** @description A metafield was not found with this query. - * */ + /** @description A metafield was not found with this query. */ readonly 404: { headers: { readonly [name: string]: unknown; @@ -2908,25 +2731,21 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Order` to which the transactions belong. - * */ + /** @description The ID of the `Order` to which the transactions belong. */ readonly order_id: components["parameters"]["OrderIdParam"]; - /** @description The ID of the `Metafield`. - * */ + /** @description The ID of the `Metafield`. */ readonly metafield_id: number; }; readonly cookie?: never; }; - /** @description A `Metafield` object. - * */ + /** @description A `Metafield` object. */ readonly requestBody: { readonly content: { readonly "application/json": components["schemas"]["MetafieldPut"]; }; }; readonly responses: { - /** @description A metafield and metadata. - * */ + /** @description A metafield and metadata. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -2941,12 +2760,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -2955,8 +2776,7 @@ export interface operations { }; }; }; - /** @description A metafield was not found with this query. - * */ + /** @description A metafield was not found with this query. */ readonly 404: { headers: { readonly [name: string]: unknown; @@ -2975,27 +2795,23 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Order` to which the transactions belong. - * */ + /** @description The ID of the `Order` to which the transactions belong. */ readonly order_id: components["parameters"]["OrderIdParam"]; - /** @description The ID of the `Metafield`. - * */ + /** @description The ID of the `Metafield`. */ readonly metafield_id: number; }; readonly cookie?: never; }; readonly requestBody?: never; readonly responses: { - /** @description An empty response. - * */ + /** @description An empty response. */ readonly 204: { headers: { readonly [name: string]: unknown; }; content?: never; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; @@ -3181,24 +2997,19 @@ export interface operations { readonly getOrdersMetafields: { readonly parameters: { readonly query?: { - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; - /** @description Filter based on a metafieldʼs key. - * */ + /** @description Filter based on a metafieldʼs key. */ readonly key?: components["parameters"]["MetafieldKeyParam"]; /** @description Filter using a comma-separated list of metafield keys. Could be used with vanilla `key` query parameter. */ readonly "key:in"?: components["parameters"]["MetafieldKeyInParam"]; - /** @description Filter based on a metafieldʼs key. - * */ + /** @description Filter based on a metafieldʼs key. */ readonly namespace?: components["parameters"]["MetafieldNamespaceParam"]; /** @description Filter using a comma-separated list of metafield namespaces. Can be used with vanilla `namespace` query parameter. */ readonly "namespace:in"?: components["parameters"]["MetafieldNamespaceInParam"]; - /** @description Sort direction. Acceptable values are: `asc`, `desc`. - * */ + /** @description Sort direction. Acceptable values are: `asc`, `desc`. */ readonly direction?: components["parameters"]["DirectionParam"]; /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */ readonly include_fields?: components["parameters"]["IncludeFieldsParamMetafields"]; @@ -3221,8 +3032,7 @@ export interface operations { }; readonly requestBody?: never; readonly responses: { - /** @description List of `Metafield` objects. - * */ + /** @description List of `Metafield` objects. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -3245,7 +3055,6 @@ export interface operations { readonly "application/json": readonly (components["schemas"]["MetafieldBase_Post"] & { /** * @description The ID of metafield to update. - * * @example 42 */ readonly id: number; @@ -3253,8 +3062,7 @@ export interface operations { }; }; readonly responses: { - /** @description List of updated `Metafield` objects. - * */ + /** @description List of updated `Metafield` objects. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -3269,12 +3077,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -3283,8 +3093,7 @@ export interface operations { }; }; }; - /** @description Response object for metafields creation with partial success. - * */ + /** @description Response object for metafields creation with partial success. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -3307,7 +3116,6 @@ export interface operations { readonly "application/json": readonly (components["schemas"]["MetafieldBase_Post"] & { /** * @description The ID for the order with which the metafield is associated. - * * @example 42 */ readonly resource_id: number; @@ -3315,8 +3123,7 @@ export interface operations { }; }; readonly responses: { - /** @description List of created `Metafield` objects. - * */ + /** @description List of created `Metafield` objects. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -3331,12 +3138,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -3345,8 +3154,7 @@ export interface operations { }; }; }; - /** @description Response object for metafields creation with partial success. - * */ + /** @description Response object for metafields creation with partial success. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -3371,8 +3179,7 @@ export interface operations { }; }; readonly responses: { - /** @description Response object for metafields deletion with success. - * */ + /** @description Response object for metafields deletion with success. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -3387,12 +3194,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -3401,8 +3210,7 @@ export interface operations { }; }; }; - /** @description Response object for metafields deletion with partial success. - * */ + /** @description Response object for metafields deletion with partial success. */ readonly 422: { headers: { readonly [name: string]: unknown; diff --git a/src/internal/reference/generated/page_widgets.v3.ts b/src/internal/reference/generated/page_widgets.v3.ts index 8176a75..5c3a135 100644 --- a/src/internal/reference/generated/page_widgets.v3.ts +++ b/src/internal/reference/generated/page_widgets.v3.ts @@ -570,35 +570,25 @@ export interface components { /** * Pagination object * @description Data about the response, including pagination and collection totals. - * */ readonly pagination: { - /** @description Total number of items in the result set. - * */ + /** @description Total number of items in the result set. */ readonly total?: number; - /** @description Total number of items in the collection response. - * */ + /** @description Total number of items in the collection response. */ readonly count?: number; - /** @description The amount of items returned in the collection per page, controlled by the limit parameter. - * */ + /** @description The amount of items returned in the collection per page, controlled by the limit parameter. */ readonly per_page?: number; - /** @description The page you are currently on within the collection. - * */ + /** @description The page you are currently on within the collection. */ readonly current_page?: number; - /** @description The total number of pages in the collection. - * */ + /** @description The total number of pages in the collection. */ readonly total_pages?: number; - /** @description Pagination links for the previous and next parts of the whole collection. - * */ + /** @description Pagination links for the previous and next parts of the whole collection. */ readonly links?: { - /** @description Link to the previous page returned in the response. - * */ + /** @description Link to the previous page returned in the response. */ readonly previous?: string; - /** @description Link to the current page returned in the response. - * */ + /** @description Link to the current page returned in the response. */ readonly current?: string; - /** @description Link to the next page returned in the response. - * */ + /** @description Link to the next page returned in the response. */ readonly next?: string; }; }; @@ -609,14 +599,11 @@ export interface components { /** * Base error * @description Error payload for the BigCommerce API. - * */ readonly BaseError: { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; diff --git a/src/internal/reference/generated/pages.v3.ts b/src/internal/reference/generated/pages.v3.ts index 3eca3fa..074cdce 100644 --- a/src/internal/reference/generated/pages.v3.ts +++ b/src/internal/reference/generated/pages.v3.ts @@ -26,6 +26,8 @@ export interface paths { /** * Create Pages * @description Creates one or more content pages. This endpoint supports bulk operations. + * + * Web pages created via this endpoint are subject to the 4000 web page platform limit. Attempting to create pages over the limit will return an error. For more information on platform limits, see [Platform Limits (Help Center)](https://support.bigcommerce.com/s/article/Platform-Limits). */ readonly post: operations["createPages"]; /** @@ -74,25 +76,19 @@ export interface paths { export type webhooks = Record; export interface components { schemas: { - /** @description Error payload for the BigCommerce API. - * */ + /** @description Error payload for the BigCommerce API. */ readonly ResponseErrorBrief: { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; - /** @description Error payload for the BigCommerce API. - * */ + /** @description Error payload for the BigCommerce API. */ readonly ResponseErrorDetailed: { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly detail?: string; @@ -100,50 +96,36 @@ export interface components { /** * ResponseErrorItemized * @description Error payload for the BigCommerce API. - * */ readonly ResponseErrorItemized: { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly errors?: readonly string[]; }; - /** @description Data about the response, including pagination and collection totals. - * */ + /** @description Data about the response, including pagination and collection totals. */ readonly ResponseMeta: { - /** @description Data about the response, including pagination and collection totals. - * */ + /** @description Data about the response, including pagination and collection totals. */ readonly pagination?: { - /** @description Total number of items in the result set. - * */ + /** @description Total number of items in the result set. */ readonly total?: number; - /** @description Total number of items in the collection response. - * */ + /** @description Total number of items in the collection response. */ readonly count?: number; - /** @description The amount of items returned in the collection per page, controlled by the limit parameter. - * */ + /** @description The amount of items returned in the collection per page, controlled by the limit parameter. */ readonly per_page?: number; - /** @description The page you are currently on within the collection. - * */ + /** @description The page you are currently on within the collection. */ readonly current_page?: number; - /** @description The total number of pages in the collection. - * */ + /** @description The total number of pages in the collection. */ readonly total_pages?: number; - /** @description Pagination links for the previous and next parts of the whole collection. - * */ + /** @description Pagination links for the previous and next parts of the whole collection. */ readonly links?: { - /** @description Link to the previous page returned in the response. - * */ + /** @description Link to the previous page returned in the response. */ readonly previous?: string; - /** @description Link to the current page returned in the response. - * */ + /** @description Link to the current page returned in the response. */ readonly current?: string; - /** @description Link to the next page returned in the response. - * */ + /** @description Link to the next page returned in the response. */ readonly next?: string; }; }; @@ -151,7 +133,6 @@ export interface components { /** * Body * @description Response payload for the BigCommerce API. - * */ readonly PagesCollectionResponse: { readonly data?: readonly (components["schemas"]["typePage"] | components["schemas"]["typeBlog"] | components["schemas"]["typeContactForm"] | components["schemas"]["typeRaw"] | components["schemas"]["typeLink"])[]; @@ -160,7 +141,6 @@ export interface components { /** * PageResponseObject * @description Response payload for a single content page. - * */ readonly SinglePageResponse: { readonly data?: components["schemas"]["typePage"] | components["schemas"]["typeBlog"] | components["schemas"]["typeContactForm"] | components["schemas"]["typeRaw"] | components["schemas"]["typeLink"]; @@ -170,32 +150,29 @@ export interface components { readonly PagePutObj: { /** * @description The ID of the channel where this page should be shown. - * * @default 1 * @example 12 */ readonly channel_id: number; /** * @description The name of the page. Must be unique. - * * @example My Store Page */ readonly name?: string; - /** @description Boolean value that specifies the visibility of the page in the storefront’s navigation menu. + /** + * @description Boolean value that specifies the visibility of the page in the storefront’s navigation menu. * * Indicates whether the page is available to users and visible in any menus. - * */ + */ readonly is_visible?: boolean; /** * @description ID of any parent Web page. - * * @default 0 * @example 0 */ readonly parent_id: number; /** * @description Specifies the order in which the page is displayed on the storefront. (Lower integers specify earlier display.) - * * @default 0 * @example 0 */ @@ -208,21 +185,17 @@ export interface components { readonly type?: "page" | "raw" | "contact_form" | "link" | "blog"; /** * @description HTML or variable that populates the element of this page, in default/desktop view. Required in a `POST` request if the page type is `raw`. - * * @example
Hello World!
*/ readonly body?: string | null; - /** @description Boolean value that specifies whether this page is the storefront’s home page. - * */ + /** @description Boolean value that specifies whether this page is the storefront’s home page. */ readonly is_homepage?: boolean; - /** @description Boolean value. When `true`, this page is visible only to logged-in customers. - * */ + /** @description Boolean value. When `true`, this page is visible only to logged-in customers. */ readonly is_customers_only?: boolean; /** @description Applicable when the page type is `contact_form`: contact email address that receives messages sent via the form. Must be unique. */ readonly email?: string; readonly meta_title?: string | null; - /** @description Required in a `POST` request to create a link if the page type is `link`. - * */ + /** @description Required in a `POST` request to create a link if the page type is `link`. */ readonly link?: string; /** * @description Applicable when the page type is `contact_form`: comma-separated list of keywords representing the fields enabled in the control panel for storefront display. Possible fields include: @@ -234,28 +207,23 @@ export interface components { * |`companyname`|Customer’s submitted company name| * |`orderno`|Customer’s submitted order number| * |`rma`|Customer’s submitted RMA (Return Merchandise Authorization) number| - * * @example fullname,companyname,phone,orderno,rma */ readonly contact_fields?: string; /** * @description Comma-separated list of SEO-relevant keywords to include in the element of this page. - * * @default */ readonly meta_keywords: string | null; - /** @description Description contained within the element of this page. - * */ + /** @description Description contained within the element of this page. */ readonly meta_description?: string | null; /** * @description Comma-separated list of keywords that shoppers can use to locate this page when searching the store. - * * @example trousers,pockets,luxury */ readonly search_keywords?: string | null; /** * @description Relative URL on the storefront for this page. - * * @example /my-store-page */ readonly url?: string; @@ -264,8 +232,7 @@ export interface components { /** @description The ID of the target page. */ readonly id: number; } & components["schemas"]["PagePutObj"]; - /** @description Properties of all Pages V3 pages. - * */ + /** @description Properties of all Pages V3 pages. */ readonly anyTypePage: { readonly id?: number; /** @default 1 */ @@ -310,7 +277,6 @@ export interface components { readonly is_customers_only: boolean; /** * @description Relative URL on the storefront for this page. - * * @example /my-store-page */ readonly url?: string; @@ -318,7 +284,6 @@ export interface components { /** * page * @description `type: page`. A user-defined plain-text page. - * */ readonly typePage: components["schemas"]["anyTypePage"] & components["schemas"]["pageMeta"] & components["schemas"]["searchKeywords"]; /** @@ -328,7 +293,6 @@ export interface components { readonly typeBlog: unknown & components["schemas"]["anyTypePage"] & components["schemas"]["pageMeta"] & components["schemas"]["searchKeywords"] & { /** * @description Relative URL on the storefront for this page. - * * @example /blog/ */ readonly url?: string; @@ -350,7 +314,6 @@ export interface components { * | `companyname` | The customer’s company name. | * | `orderno` | A field that lets customers specify a subject order number. | * | `rma` | A customer’s submitted RMA (Return Merchandise Authorization) number. | - * * @example fullname,companyname,phone,orderno,rma */ readonly contact_fields?: string; @@ -362,7 +325,6 @@ export interface components { readonly typeRaw: components["schemas"]["anyTypePage"] & components["schemas"]["searchKeywords"] & { /** * @description HTML or variable that populates the element of this page, in default/desktop view. Required in a `POST` request if the page type is `raw`. - * * @example
Hello World!
*/ readonly body: string | null; @@ -384,13 +346,11 @@ export interface components { readonly meta_title?: string | null; /** * @description Comma-separated list of SEO-relevant keywords to include in the element of this page. - * * @default "" */ readonly meta_keywords: string | null; /** * @description Description contained within the element of this page. - * * @default "" */ readonly meta_description: string | null; @@ -398,7 +358,6 @@ export interface components { readonly searchKeywords: { /** * @description Comma-separated list of keywords that shoppers can use to locate this page when searching the store. - * * @default "" * @example trousers,pockets,luxury */ @@ -415,13 +374,15 @@ export interface components { readonly "application/json": unknown; }; }; - /** @description Created. + /** + * @description Created. * * Response.data will inherit the data type of the request. A single entry passed as an object will return an object for the data property. Any number of entries passed in an array will return an array for the data property. * * Properties associated with a page `type` that are not required to create an entry will be created with default values. * - * When you make bulk requests, an invalid input in any one entry will return 422. The entries that are valid will still be created. */ + * When you make bulk requests, an invalid input in any one entry will return 422. The entries that are valid will still be created. + */ readonly HTTP201CreatePages: { headers: { readonly [name: string]: unknown; @@ -457,7 +418,6 @@ export interface components { /** * @description When you explicitly set this query parameter to `true`, deleting a parent page will recursively delete all its immediate children and their descendants. * Otherwise, if you set this query parameter to `false` or not provided, deleting a parent page will update its immediate children by setting their `parent_id` to `0` and their `is_visible` status to `false`. - * * @example true */ readonly deleteChildrenQuery: boolean; @@ -549,8 +509,7 @@ export interface operations { }; }; readonly responses: { - /** @description Updated. - * */ + /** @description Updated. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -600,9 +559,11 @@ export interface operations { readonly responses: { readonly 201: components["responses"]["HTTP201CreatePages"]; readonly 207: components["responses"]["HTTP207Response"]; - /** @description The input was not valid. This is the result of missing required fields or other invalid arguments. See the response for more details. + /** + * @description The input was not valid. This is the result of missing required fields or other invalid arguments. See the response for more details. * - * When making bulk requests, an invalid input in any one entry will cause the whole request to return 422. The entries that are valid will still be created. */ + * When making bulk requests, an invalid input in any one entry will cause the whole request to return 422. The entries that are valid will still be created. + */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -621,7 +582,6 @@ export interface operations { /** * @description When you explicitly set this query parameter to `true`, deleting a parent page will recursively delete all its immediate children and their descendants. * Otherwise, if you set this query parameter to `false` or not provided, deleting a parent page will update its immediate children by setting their `parent_id` to `0` and their `is_visible` status to `false`. - * * @example true */ readonly delete_children?: components["parameters"]["deleteChildrenQuery"]; diff --git a/src/internal/reference/generated/payments/methods_payments.v2.ts b/src/internal/reference/generated/payments/methods_payments.v2.ts index e7cb238..0e586fd 100644 --- a/src/internal/reference/generated/payments/methods_payments.v2.ts +++ b/src/internal/reference/generated/payments/methods_payments.v2.ts @@ -21,7 +21,6 @@ export interface paths { * * > #### Note * > Avoid using this API operation if possible. It is not supported; therefore, all enabled providers may not appear. - * */ readonly get: operations["getAllPaymentMethods"]; }; diff --git a/src/internal/reference/generated/pickup.v3.ts b/src/internal/reference/generated/pickup.v3.ts index b29c5c0..16129d3 100644 --- a/src/internal/reference/generated/pickup.v3.ts +++ b/src/internal/reference/generated/pickup.v3.ts @@ -141,7 +141,6 @@ export interface components { * @description Can be provided as two inputs. * Unix: Represents the time in seconds that has elapsed since Unix epoch (00:00:00 UTC on 1 January 1970) * ISO-8601: Represents the time in ISO format. - * * @example '1660555844' or '2022-06-11T00:00:20Z' */ readonly ready_at: string; @@ -150,7 +149,6 @@ export interface components { * Unix: Represents the time in seconds that has elapsed since Unix epoch (00:00:00 UTC on 1 January 1970). * ISO-8601: Represents the time in ISO format. * If this value is not supplied, the pickup item collected_at property will be null. - * * @example '1660831392' or '2022-06-18T00:00:30Z' */ readonly collected_at?: string; @@ -183,7 +181,6 @@ export interface components { * @description Can be provided as two inputs. * Unix: Represents the time in seconds that has elapsed since Unix epoch (00:00:00 UTC on 1 January 1970) * ISO-8601: Represents the time in ISO format. - * * @example '1660555844' or '2022-06-11T00:00:20Z' */ readonly ready_at?: string; @@ -192,7 +189,6 @@ export interface components { * Unix: Represents the time in seconds that has elapsed since Unix epoch (00:00:00 UTC on 1 January 1970). * ISO-8601: Represents the time in ISO format. * If this value is not supplied, the pickup item collected_at property will be null. - * * @example '1660831392' or '2022-06-18T00:00:30Z' */ readonly collected_at?: string; @@ -208,8 +204,7 @@ export interface components { * @example JSON data is missing or invalid */ readonly title?: string; - /** @description URL identifying the error type. Dereferencing the URL leads to documentation about the error type. - * */ + /** @description URL identifying the error type. Dereferencing the URL leads to documentation about the error type. */ readonly type?: string; /** @description Detailed summary describing the particular error. */ readonly errors?: { @@ -292,8 +287,7 @@ export interface operations { }; }; }; - /** @description Incorrect entity. Locations were not valid. This results from missing required fields, invalid data, or partial error. See the response for more details. - * */ + /** @description Incorrect entity. Locations were not valid. This results from missing required fields, invalid data, or partial error. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -336,8 +330,7 @@ export interface operations { }; }; }; - /** @description Incorrect entity. Locations were not valid. This results from missing required fields, invalid data, or partial error. See the response for more details. - * */ + /** @description Incorrect entity. Locations were not valid. This results from missing required fields, invalid data, or partial error. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; diff --git a/src/internal/reference/generated/pickup_methods.v3.ts b/src/internal/reference/generated/pickup_methods.v3.ts index 20239d0..91b6ca2 100644 --- a/src/internal/reference/generated/pickup_methods.v3.ts +++ b/src/internal/reference/generated/pickup_methods.v3.ts @@ -213,12 +213,14 @@ export interface operations { * @example 2023-09-07T06:23:13Z */ readonly "date_modified:max"?: string; - /** @description Sort pickup methods by date_modified:* or name:* ; for example, `sort=name:asc`. + /** + * @description Sort pickup methods by date_modified:* or name:* ; for example, `sort=name:asc`. * * - `date_modified:asc` - sort by date modified in ascending order * - `date_modified:desc` - sort by date modified in descending order * - `name:asc` - sort by name in ascending order - * - `name:desc` - sort by name in descending order */ + * - `name:desc` - sort by name in descending order + */ readonly sort?: "date_modified:asc" | "date_modified:desc" | "name:asc" | "name:desc"; }; readonly header?: { diff --git a/src/internal/reference/generated/price_lists.v3.ts b/src/internal/reference/generated/price_lists.v3.ts index 3de6018..d23689a 100644 --- a/src/internal/reference/generated/price_lists.v3.ts +++ b/src/internal/reference/generated/price_lists.v3.ts @@ -45,7 +45,7 @@ export interface paths { }; /** * Get a Price List - * @description Returns a single *Price List*. + * @description Returns a single *Price List*. */ readonly get: operations["getPriceList"]; /** @@ -132,7 +132,6 @@ export interface paths { * **Notes** * * Supports up to 40 simultaneous GET requests. Running more than the allowed number of requests concurrently on the same store will result in a `429` status error, and your additional requests will fail. * * Store Pricelist Records data to reduce the number of calls and maximize performance. - * */ readonly get: operations["getPriceListRecordsByVariantId"]; }; @@ -448,31 +447,26 @@ export interface components { readonly pagination?: { /** * @description Total number of items in the result set. - * * @example 36 */ readonly total?: number; /** * @description Total number of items in the collection response. - * * @example 36 */ readonly count?: number; /** * @description The amount of items returned in the collection per page, controlled by the limit parameter. - * * @example 50 */ readonly per_page?: number; /** * @description The page you are currently on within the collection. - * * @example 1 */ readonly current_page?: number; /** * @description The total number of pages in the collection. - * * @example 1 */ readonly total_pages?: number; @@ -516,11 +510,9 @@ export interface components { }; /** Error Response */ readonly ErrorResponse: { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; @@ -537,8 +529,7 @@ export interface components { parameters: { /** @description Filter results by a comma-separated list of channel IDs. */ readonly ChannelIdInParam: readonly number[]; - /** @description The ID of the `Price List` requested. - * */ + /** @description The ID of the `Price List` requested. */ readonly PriceListIdParam: number; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept: string; @@ -562,11 +553,9 @@ export interface operations { readonly getPriceLists: { readonly parameters: { readonly query?: { - /** @description Filter items by name. - * */ + /** @description Filter items by name. */ readonly name?: string; - /** @description Filter items by date_created. - * */ + /** @description Filter items by date_created. */ readonly date_created?: string; /** @description Filter items by date_modified. For example `v3/catalog/products?date_last_imported:min=2018-06-15` */ readonly date_modified?: string; @@ -599,7 +588,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": [ * { * "id": 1, @@ -639,26 +629,24 @@ export interface operations { * "links": {} * } * } - * } */ + * } + */ readonly "application/json": { readonly data?: readonly ({ /** * @description The unique numeric ID of the `Price List`; this number increments sequentially. - * * @example 3 */ readonly id?: number; /** * Format: date-time * @description The date on which the `Price List` was created. - * * @example 2018-04-05T16:05:12Z */ readonly date_created?: string; /** * Format: date-time * @description The date on which the `Price List` was created. - * * @example 2018-04-05T16:05:12Z */ readonly date_modified?: string; @@ -670,7 +658,6 @@ export interface operations { readonly name: string; /** * @description Boolean value that specifies whether this `Price List` and its prices are active or not. Defaults to `true`. - * * @example true */ readonly active?: boolean; @@ -687,31 +674,26 @@ export interface operations { readonly pagination?: { /** * @description Total number of items in the result set. - * * @example 36 */ readonly total?: number; /** * @description Total number of items in the collection response. - * * @example 36 */ readonly count?: number; /** * @description The amount of items returned in the collection per page, controlled by the limit parameter. - * * @example 50 */ readonly per_page?: number; /** * @description The page you are currently on within the collection. - * * @example 1 */ readonly current_page?: number; /** * @description The total number of pages in the collection. - * * @example 1 */ readonly total_pages?: number; @@ -773,7 +755,6 @@ export interface operations { readonly name: string; /** * @description Boolean value that specifies whether this `Price List` and its prices are active or not. Defaults to `true`. - * * @example true */ readonly active?: boolean; @@ -786,7 +767,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 4, * "name": "Wholesale Group - Trade Show", @@ -795,27 +777,25 @@ export interface operations { * "active": false * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { /** Price List */ readonly data?: { /** * @description The unique numeric ID of the `Price List`; this number increments sequentially. - * * @example 3 */ readonly id?: number; /** * Format: date-time * @description The date on which the `Price List` was created. - * * @example 2022-04-05T16:05:12Z */ readonly date_created?: string; /** * Format: date-time * @description The date on which the `Price List` was created. - * * @example 2022-04-05T16:05:12Z */ readonly date_modified?: string; @@ -827,7 +807,6 @@ export interface operations { readonly name: string; /** * @description Boolean value that specifies whether this `Price List` and its prices are active or not. Defaults to `true`. - * * @example true */ readonly active?: boolean; @@ -836,8 +815,7 @@ export interface operations { }; }; }; - /** @description `Price List` conflicts with another Price List. This is the result of duplicate unique values, such as `name`. - * */ + /** @description `Price List` conflicts with another Price List. This is the result of duplicate unique values, such as `name`. */ readonly 409: { headers: { readonly [name: string]: unknown; @@ -849,18 +827,15 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; }; }; - /** @description `Price List` is not valid. This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description `Price List` is not valid. This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -872,11 +847,9 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -887,11 +860,9 @@ export interface operations { readonly deletePriceLists: { readonly parameters: { readonly query?: { - /** @description Filter by ID. Accepts multiple comma-separated values. - * */ + /** @description Filter by ID. Accepts multiple comma-separated values. */ readonly "id:in"?: readonly number[]; - /** @description Filter items by name. - * */ + /** @description Filter items by name. */ readonly name?: string; }; readonly header?: { @@ -924,8 +895,7 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Price List` requested. - * */ + /** @description The ID of the `Price List` requested. */ readonly price_list_id: number; }; readonly cookie?: never; @@ -937,7 +907,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 2, * "name": "B2B", @@ -946,7 +917,8 @@ export interface operations { * "active": true * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { /** * Price List @@ -955,21 +927,18 @@ export interface operations { readonly data?: { /** * @description The unique numeric ID of the `Price List`; this number increments sequentially. - * * @example 3 */ readonly id?: number; /** * Format: date-time * @description The date on which the `Price List` was created. - * * @example 2022-04-05T16:05:12Z */ readonly date_created?: string; /** * Format: date-time * @description The date on which the `Price List` was created. - * * @example 2022-04-05T16:05:12Z */ readonly date_modified?: string; @@ -980,7 +949,6 @@ export interface operations { readonly name: string; /** * @description Boolean value that specifies whether this `Price List` and its prices are active or not. Defaults to `true`. - * * @example true */ readonly active?: boolean; @@ -1001,8 +969,7 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Price List` requested. - * */ + /** @description The ID of the `Price List` requested. */ readonly price_list_id: number; }; readonly cookie?: never; @@ -1017,7 +984,6 @@ export interface operations { readonly name: string; /** * @description Whether or not this `Price List` and its prices are active. Defaults to `true`. - * * @example true */ readonly active?: boolean; @@ -1030,7 +996,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 2, * "name": "BigCommerce", @@ -1039,27 +1006,25 @@ export interface operations { * "active": false * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { /** Price List */ readonly data?: { /** * @description The unique numeric ID of the `Price List`; this number increments sequentially. - * * @example 3 */ readonly id?: number; /** * Format: date-time * @description The date on which the `Price List` was created. - * * @example 2022-04-05T16:05:12Z */ readonly date_created?: string; /** * Format: date-time * @description The date on which the `Price List` was created. - * * @example 2022-04-05T16:05:12Z */ readonly date_modified?: string; @@ -1071,7 +1036,6 @@ export interface operations { readonly name: string; /** * @description Whether or not this `Price List` and its prices are active. Defaults to `true`. - * * @example true */ readonly active?: boolean; @@ -1080,16 +1044,14 @@ export interface operations { }; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -1098,8 +1060,7 @@ export interface operations { }; }; }; - /** @description `Price List` was in conflict with another Price List. This is the result of duplicate unique values, such as `name`. - * */ + /** @description `Price List` was in conflict with another Price List. This is the result of duplicate unique values, such as `name`. */ readonly 409: { headers: { readonly [name: string]: unknown; @@ -1111,18 +1072,15 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; }; }; - /** @description `Price List` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description `Price List` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -1134,11 +1092,9 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -1154,8 +1110,7 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Price List` requested. - * */ + /** @description The ID of the `Price List` requested. */ readonly price_list_id: number; }; readonly cookie?: never; @@ -1187,8 +1142,7 @@ export interface operations { }; }; readonly responses: { - /** @description Success response for batch PUT of `Price Records`. - * */ + /** @description Success response for batch PUT of `Price Records`. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -1197,8 +1151,7 @@ export interface operations { readonly "application/json": components["schemas"]["SuccessBatchResponse"]; }; }; - /** @description Error response for batch PUT of `Price Records`. May include errors during partial update in non-strict mode. - * */ + /** @description Error response for batch PUT of `Price Records`. May include errors during partial update in non-strict mode. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -1214,11 +1167,9 @@ export interface operations { readonly query?: { /** @description A comma-separated list of IDs for one or more variants for which prices were requested. */ readonly "variant_id:in"?: readonly number[]; - /** @description A comma-separated list of IDs for one or more products for which prices were requested. - * */ + /** @description A comma-separated list of IDs for one or more products for which prices were requested. */ readonly "product_id:in"?: readonly number[]; - /** @description Filter items by currency. - * */ + /** @description Filter items by currency. */ readonly currency?: string; /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: number; @@ -1228,31 +1179,23 @@ export interface operations { readonly before?: string; /** @description A cursor that can be used for forwards pagination. Will fetch results after the position corresponding to the cursor. Cannot be used with the 'page' query parameter. Cannot be used with the 'before' query parameter. */ readonly after?: string; - /** @description Sub-resources to include on a price record, in a comma-separated list. Valid expansions currently include `bulk_pricing_tiers` and `sku`. Other values will be ignored. - * */ + /** @description Sub-resources to include on a price record, in a comma-separated list. Valid expansions currently include `bulk_pricing_tiers` and `sku`. Other values will be ignored. */ readonly include?: readonly ("bulk_pricing_tiers" | "sku")[]; - /** @description Filter items by price. - * */ + /** @description Filter items by price. */ readonly price?: number; - /** @description Filter items by sale_price. - * */ + /** @description Filter items by sale_price. */ readonly sale_price?: number; - /** @description Filter items by retail_price. - * */ + /** @description Filter items by retail_price. */ readonly retail_price?: number; - /** @description Filter items by map_price. - * */ + /** @description Filter items by map_price. */ readonly map_price?: number; - /** @description Filter items by calculated_price. - * */ + /** @description Filter items by calculated_price. */ readonly calculated_price?: number; - /** @description Filter items by date_created. - * */ + /** @description Filter items by date_created. */ readonly date_created?: string; /** @description Filter items by date_modified. For example `v3/catalog/products?date_last_imported:min=2022-06-15` */ readonly date_modified?: string; - /** @description Filter items by SKU. - * */ + /** @description Filter items by SKU. */ readonly sku?: string; readonly "sku:in"?: readonly string[]; readonly "currency:in"?: readonly string[]; @@ -1276,8 +1219,7 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Price List` requested. - * */ + /** @description The ID of the `Price List` requested. */ readonly price_list_id: number; }; readonly cookie?: never; @@ -1289,7 +1231,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": [ * { * "price_list_id": 3, @@ -1599,56 +1542,49 @@ export interface operations { * "links": {} * } * } - * } */ + * } + */ readonly "application/json": { readonly data?: readonly ({ /** * Format: double * @description The price of the variant as seen on the storefront if a price record is in effect. It will be equal to the `sale_price`, if set, and the `price` if there is not a `sale_price`. Read only. - * * @example 24.64 */ readonly calculated_price?: number; /** * Format: date-time * @description The date on which the Price entry was created. - * * @example 2018-08-23T19:59:23Z */ readonly date_created?: string; /** * Format: date-time * @description The date on which the Price entry was created. - * * @example 2018-08-23T19:59:23Z */ readonly date_modified?: string; /** * @description The ID of the `Product` this `Price Record`ʼs `variant_id` is associated with. Read only. - * * @example 158 */ readonly product_id?: number; } & { /** * @description The Price List with which this price set is associated. - * * @example 2 */ readonly price_list_id?: number; /** * @description The variant with which this price set is associated. Either `variant_id` or `sku` is required. - * * @example 325 */ readonly variant_id?: number; - /** @description The variant with which this price set is associated. Either `sku` or `variant_id` is required. - * */ + /** @description The variant with which this price set is associated. Either `sku` or `variant_id` is required. */ readonly sku?: string; /** * Format: ISO-4217 * @description The 3-letter currency code with which this price set is associated. - * * @example usd */ readonly currency?: string; @@ -1656,44 +1592,37 @@ export interface operations { /** * Format: double * @description The list price for the variant mapped in a Price List. Overrides any existing or Catalog list price for the variant/product. - * * @example 3.99 */ readonly price?: number; /** * Format: double * @description The sale price for the variant mapped in a Price List. Overrides any existing or Catalog sale price for the variant/product. If empty, the sale price will be treated as not being set on this variant. - * */ readonly sale_price?: number; /** * Format: double * @description The retail price for the variant mapped in a Price List. Overrides any existing or Catalog retail price for the variant/product. If empty, the retail price will be treated as not being set on this variant. - * */ readonly retail_price?: number; /** * Format: double * @description The MAP (Minimum Advertised Price) for the variant mapped in a Price List. Overrides any existing or Catalog MAP price for the variant/product. If empty, the MAP price will be treated as not being set on this variant. - * */ readonly map_price?: number; readonly bulk_pricing_tiers?: readonly { /** * @description The minimum quantity of associated variant in the cart needed to qualify for this tier's pricing. - * * @example 1 */ readonly quantity_min?: number; /** * @description The maximum allowed quantity of associated variant in the cart to qualify for this tier's pricing. `null` indicates that there is no maximum allowed quantity for this tier. - * * @example 10 */ readonly quantity_max?: number | null; /** * @description The type of adjustment that is made. Acceptable values: price – the adjustment amount per product; percent – the adjustment as a percentage of the original price; fixed – the adjusted absolute price of the product. - * * @example price * @enum {string} */ @@ -1701,14 +1630,12 @@ export interface operations { /** * Format: double * @description The price adjustment amount. This value along with the type will decide the price per variant for the pricing tier. - * * @example 3 */ readonly amount?: number; }[]; /** * @description The SKU code associated with this `Price Record` if requested and it exists. - * * @example SMB-123 */ readonly sku?: string; @@ -1725,31 +1652,26 @@ export interface operations { readonly pagination?: { /** * @description Total number of items in the result set. - * * @example 36 */ readonly total?: number; /** * @description Total number of items in the collection response. - * * @example 36 */ readonly count?: number; /** * @description The amount of items returned in the collection per page, controlled by the limit parameter. - * * @example 50 */ readonly per_page?: number; /** * @description The page you are currently on within the collection. - * * @example 1 */ readonly current_page?: number; /** * @description The total number of pages in the collection. - * * @example 1 */ readonly total_pages?: number; @@ -1787,8 +1709,7 @@ export interface operations { }; }; }; - /** @description Allowed number of requests exceeded. - * */ + /** @description Allowed number of requests exceeded. */ readonly 429: { headers: { readonly [name: string]: unknown; @@ -1810,8 +1731,7 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Price List` requested. - * */ + /** @description The ID of the `Price List` requested. */ readonly price_list_id: number; }; readonly cookie?: never; @@ -1821,20 +1741,17 @@ export interface operations { readonly "application/json": readonly ({ /** * @description The variant ID with which this price set is associated. Either `variant_id` or `sku` is required. - * * @example 331 */ readonly variant_id?: number; /** * @description The SKU for the variant with which this price set is associated. Either `sku` or `variant_id` is required. - * * @example SMB-123 */ readonly sku?: string; /** * Format: ISO-4217 * @description The 3-letter currency code with which this price set is associated. - * * @example usd */ readonly currency?: string; @@ -1842,47 +1759,40 @@ export interface operations { /** * Format: double * @description The list price for the variant mapped in a Price List. Overrides any existing or Catalog list price for the variant/product. - * * @example 3.99 */ readonly price?: number; /** * Format: double * @description The sale price for the variant mapped in a Price List. Overrides any existing or Catalog sale price for the variant/product. If empty, the sale price will be treated as not being set on this variant. - * * @example 3.49 */ readonly sale_price?: number; /** * Format: double * @description The retail price for the variant mapped in a Price List. Overrides any existing or Catalog retail price for the variant/product. If empty, the retail price will be treated as not being set on this variant. - * * @example 4.99 */ readonly retail_price?: number; /** * Format: double * @description The MAP (Minimum Advertised Price) for the variant mapped in a Price List. Overrides any existing or Catalog MAP price for the variant/product. If empty, the MAP price will be treated as not being set on this variant. - * * @example 2.5 */ readonly map_price?: number; readonly bulk_pricing_tiers?: readonly { /** * @description The minimum quantity of associated variant in the cart needed to qualify for the pricing of this tier. - * * @example 1 */ readonly quantity_min?: number; /** * @description The maximum allowed quantity of associated variant in the cart to qualify for the pricing of this tier. - * * @example 10 */ readonly quantity_max?: number; /** * @description The type of adjustment that is made. Acceptable values: price – the adjustment amount per product; percent – the adjustment as a percentage of the original price; fixed – the adjusted absolute price of the product. - * * @example price * @enum {string} */ @@ -1890,14 +1800,12 @@ export interface operations { /** * Format: double * @description The price adjustment amount. This value along with the type will decide the price per variant for the pricing tier. - * * @example 3 */ readonly amount?: number; }[]; /** * @description The SKU code associated with this `Price Record` if requested and it exists. - * * @example SMB-123 */ readonly sku?: string; @@ -1932,23 +1840,19 @@ export interface operations { readonly data?: { /** * @description The Price List with which this price set is associated. - * * @example 2 */ readonly price_list_id?: number; /** * @description The variant ID with which this price set is associated. Either `variant_id` or `sku` is required. - * * @example 325 */ readonly variant_id?: number; - /** @description The variant with which this price set is associated. Either `sku` or `variant_id` is required. - * */ + /** @description The variant with which this price set is associated. Either `sku` or `variant_id` is required. */ readonly sku?: string; /** * Format: ISO-4217 * @description The 3-letter currency code with which this price set is associated. - * * @example usd */ readonly currency?: string; @@ -1961,8 +1865,7 @@ export interface operations { }; }; }; - /** @description Allowed number of requests exceeded. - * */ + /** @description Allowed number of requests exceeded. */ readonly 429: { headers: { readonly [name: string]: unknown; @@ -1989,8 +1892,7 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Price List` requested. - * */ + /** @description The ID of the `Price List` requested. */ readonly price_list_id: number; }; readonly cookie?: never; @@ -2003,8 +1905,7 @@ export interface operations { }; content: { readonly "application/json": { - /** @description 204 HTTP status code. - * */ + /** @description 204 HTTP status code. */ readonly status?: number; /** @description The error title describing the situation. */ readonly title?: string; @@ -2018,8 +1919,7 @@ export interface operations { readonly getPriceListRecordsByVariantId: { readonly parameters: { readonly query?: { - /** @description Sub-resources to include on a price record, in a comma-separated list. Valid expansions currently include `bulk_pricing_tiers` and `sku`. Other values will be ignored. - * */ + /** @description Sub-resources to include on a price record, in a comma-separated list. Valid expansions currently include `bulk_pricing_tiers` and `sku`. Other values will be ignored. */ readonly include?: readonly ("bulk_pricing_tiers" | "sku")[]; /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: number; @@ -2035,11 +1935,9 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Price List` requested. - * */ + /** @description The ID of the `Price List` requested. */ readonly price_list_id: number; - /** @description ID of the variant on a product, or on an associated Price List Record. - * */ + /** @description ID of the variant on a product, or on an associated Price List Record. */ readonly variant_id: number; }; readonly cookie?: never; @@ -2056,49 +1954,41 @@ export interface operations { /** * Format: double * @description The price of the variant as seen on the storefront if a price record is in effect. It will be equal to the `sale_price`, if set, and the `price` if there is not a `sale_price`. Read only. - * * @example 24.64 */ readonly calculated_price?: number; /** * Format: date-time * @description The date on which the Price entry was created. - * * @example 2022-08-23T19:59:23Z */ readonly date_created?: string; /** * Format: date-time * @description The date on which the Price entry was created. - * * @example 2022-08-23T19:59:23Z */ readonly date_modified?: string; /** * @description The ID of the `Product` this `Price Record`ʼs `variant_id` is associated with. Read only. - * * @example 158 */ readonly product_id?: number; } & { /** * @description The Price List with which this price set is associated. - * * @example 2 */ readonly price_list_id?: number; /** * @description The variant ID with which this price set is associated. Either `variant_id` or `sku` is required. - * * @example 325 */ readonly variant_id?: number; - /** @description The variant ID with which this price set is associated. Either `sku` or `variant_id` is required. - * */ + /** @description The variant ID with which this price set is associated. Either `sku` or `variant_id` is required. */ readonly sku?: string; /** * @description The 3-letter currency code with which this price set is associated. - * * @example usd */ readonly currency?: string; @@ -2106,47 +1996,40 @@ export interface operations { /** * Format: double * @description The list price for the variant mapped in a Price List. Overrides any existing or Catalog list price for the variant/product. - * * @example 3.99 */ readonly price?: number; /** * Format: double * @description The sale price for the variant mapped in a Price List. Overrides any existing or Catalog sale price for the variant/product. If empty, the sale price will be treated as not being set on this variant. - * * @example 5.99 */ readonly sale_price?: number; /** * Format: double * @description The retail price for the variant mapped in a Price List. Overrides any existing or Catalog retail price for the variant/product. If empty, the retail price will be treated as not being set on this variant. - * * @example 6.99 */ readonly retail_price?: number; /** * Format: double * @description The MAP (Minimum Advertised Price) for the variant mapped in a Price List. Overrides any existing or Catalog MAP price for the variant/product. If empty, the MAP price will be treated as not being set on this variant. - * * @example 5.99 */ readonly map_price?: number; readonly bulk_pricing_tiers?: readonly { /** * @description The minimum quantity of associated variant in the cart needed to qualify for this tiers pricing. - * * @example 1 */ readonly quantity_min?: number; /** * @description The maximum allowed quantity of associated variant in the cart to qualify for this tiers pricing. - * * @example 10 */ readonly quantity_max?: number; /** * @description The type of adjustment that is made. Acceptable values: price – the adjustment amount per product; percent – the adjustment as a percentage of the original price; fixed – the adjusted absolute price of the product. - * * @example price * @enum {string} */ @@ -2154,14 +2037,12 @@ export interface operations { /** * Format: double * @description The price adjustment amount. This value along with the type will decide the price per variant for the pricing tier. - * * @example 3 */ readonly amount?: number; }[]; /** * @description The SKU code associated with this `Price Record` if requested and it exists. - * * @example SMB-123 */ readonly sku?: string; @@ -2178,31 +2059,26 @@ export interface operations { readonly pagination?: { /** * @description Total number of items in the result set. - * * @example 36 */ readonly total?: number; /** * @description Total number of items in the collection response. - * * @example 36 */ readonly count?: number; /** * @description The amount of items returned in the collection per page, controlled by the limit parameter. - * * @example 50 */ readonly per_page?: number; /** * @description The page you are currently on within the collection. - * * @example 1 */ readonly current_page?: number; /** * @description The total number of pages in the collection. - * * @example 1 */ readonly total_pages?: number; @@ -2243,8 +2119,7 @@ export interface operations { }; }; }; - /** @description Allowed number of requests exceeded. - * */ + /** @description Allowed number of requests exceeded. */ readonly 429: { headers: { readonly [name: string]: unknown; @@ -2259,8 +2134,7 @@ export interface operations { readonly getPriceListRecord: { readonly parameters: { readonly query?: { - /** @description Sub-resources to include on a price record, in a comma-separated list. Valid expansions currently include `bulk_pricing_tiers` and `sku`. Other values will be ignored. - * */ + /** @description Sub-resources to include on a price record, in a comma-separated list. Valid expansions currently include `bulk_pricing_tiers` and `sku`. Other values will be ignored. */ readonly include?: readonly ("bulk_pricing_tiers" | "sku")[]; }; readonly header?: { @@ -2268,14 +2142,11 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Price List` requested. - * */ + /** @description The ID of the `Price List` requested. */ readonly price_list_id: number; - /** @description ID of the variant on a product, or on an associated Price List Record. - * */ + /** @description ID of the variant on a product, or on an associated Price List Record. */ readonly variant_id: number; - /** @description The currency code associated with the price record being acted upon. - * */ + /** @description The currency code associated with the price record being acted upon. */ readonly currency_code: string; }; readonly cookie?: never; @@ -2287,7 +2158,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "price_list_id": 4, * "variant_id": 356, @@ -2301,7 +2173,8 @@ export interface operations { * "currency": "eur", * "product_id": 185 * } - * } */ + * } + */ readonly "application/json": { /** * Price Record @@ -2311,50 +2184,42 @@ export interface operations { /** * Format: double * @description The price of the variant as seen on the storefront if a price record is in effect. It will be equal to the `sale_price`, if set, and the `price` if there is not a `sale_price`. Read only. - * * @example 24.64 */ readonly calculated_price?: number; /** * Format: date-time * @description The date on which the Price entry was created. - * * @example 2022-08-23T19:59:23Z */ readonly date_created?: string; /** * Format: date-time * @description The date on which the Price entry was created. - * * @example 2022-08-23T19:59:23Z */ readonly date_modified?: string; /** * @description The ID of the `Product` this `Price Record`ʼs `variant_id` is associated with. Read only. - * * @example 158 */ readonly product_id?: number; } & { /** * @description The Price List with which this price set is associated. - * * @example 2 */ readonly price_list_id?: number; /** * @description The variant with which this price set is associated. Either `variant_id` or `sku` is required. - * * @example 325 */ readonly variant_id?: number; - /** @description The variant with which this price set is associated. Either `sku` or `variant_id` is required. - * */ + /** @description The variant with which this price set is associated. Either `sku` or `variant_id` is required. */ readonly sku?: string; /** * Format: ISO-4217 * @description The 3-letter currency code with which this price set is associated. - * * @example usd */ readonly currency?: string; @@ -2362,44 +2227,37 @@ export interface operations { /** * Format: double * @description The list price for the variant mapped in a Price List. Overrides any existing or Catalog list price for the variant/product. - * * @example 3.99 */ readonly price?: number; /** * Format: double * @description The sale price for the variant mapped in a Price List. Overrides any existing or Catalog sale price for the variant/product. If empty, the sale price will be treated as not being set on this variant. - * */ readonly sale_price?: number; /** * Format: double * @description The retail price for the variant mapped in a Price List. Overrides any existing or Catalog retail price for the variant/product. If empty, the retail price will be treated as not being set on this variant. - * */ readonly retail_price?: number; /** * Format: double * @description The MAP (Minimum Advertised Price) for the variant mapped in a Price List. Overrides any existing or Catalog MAP price for the variant/product. If empty, the MAP price will be treated as not being set on this variant. - * */ readonly map_price?: number; readonly bulk_pricing_tiers?: readonly { /** * @description The minimum quantity of associated variant in the cart needed to qualify for the pricing of this tier. - * * @example 1 */ readonly quantity_min?: number; /** * @description The maximum allowed quantity of associated variant in the cart to qualify for the pricing of this tier. - * * @example 10 */ readonly quantity_max?: number; /** * @description The type of adjustment that is made. Acceptable values: price – the adjustment amount per product; percent – the adjustment as a percentage of the original price; fixed – the adjusted absolute price of the product. - * * @example price * @enum {string} */ @@ -2407,14 +2265,12 @@ export interface operations { /** * Format: double * @description The price adjustment amount. This value along with the type will decide the price per variant for the pricing tier. - * * @example 3 */ readonly amount?: number; }[]; /** * @description The SKU code associated with this `Price Record` if requested and it exists. - * * @example SMB-123 */ readonly sku?: string; @@ -2423,8 +2279,7 @@ export interface operations { }; }; }; - /** @description Allowed number of requests exceeded. - * */ + /** @description Allowed number of requests exceeded. */ readonly 429: { headers: { readonly [name: string]: unknown; @@ -2446,14 +2301,11 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Price List` requested. - * */ + /** @description The ID of the `Price List` requested. */ readonly price_list_id: number; - /** @description ID of the variant on a product, or on an associated Price List Record. - * */ + /** @description ID of the variant on a product, or on an associated Price List Record. */ readonly variant_id: number; - /** @description The currency code associated with the price record being acted upon. - * */ + /** @description The currency code associated with the price record being acted upon. */ readonly currency_code: string; }; readonly cookie?: never; @@ -2464,44 +2316,37 @@ export interface operations { /** * Format: double * @description The list price for the variant mapped in a Price List. Overrides any existing or Catalog list price for the variant/product. - * * @example 3.99 */ readonly price?: number; /** * Format: double * @description The sale price for the variant mapped in a Price List. Overrides any existing or Catalog sale price for the variant/product. If empty, the sale price will be treated as not being set on this variant. - * */ readonly sale_price?: number; /** * Format: double * @description The retail price for the variant mapped in a Price List. Overrides any existing or Catalog retail price for the variant/product. If empty, the retail price will be treated as not being set on this variant. - * */ readonly retail_price?: number; /** * Format: double * @description The MAP (Minimum Advertised Price) for the variant mapped in a Price List. Overrides any existing or Catalog MAP price for the variant/product. If empty, the MAP price will be treated as not being set on this variant. - * */ readonly map_price?: number; readonly bulk_pricing_tiers?: readonly { /** * @description The minimum quantity of associated variant in the cart needed to qualify for this tiers pricing. - * * @example 1 */ readonly quantity_min?: number; /** * @description The maximum allowed quantity of associated variant in the cart to qualify for this tiers pricing. - * * @example 10 */ readonly quantity_max?: number; /** * @description The type of adjustment that is made. Acceptable values: price – the adjustment amount per product; percent – the adjustment as a percentage of the original price; fixed – the adjusted absolute price of the product. - * * @example price * @enum {string} */ @@ -2509,7 +2354,6 @@ export interface operations { /** * Format: double * @description The price adjustment amount. This value along with the type will decide the price per variant for the pricing tier. - * * @example 3 */ readonly amount?: number; @@ -2532,47 +2376,40 @@ export interface operations { /** * Format: double * @description The price of the variant as seen on the storefront if a price record is in effect. It will be equal to the `sale_price`, if set, and the `price` if there is not a `sale_price`. Read only. - * * @example 24.64 */ readonly calculated_price?: number; /** * Format: date-time * @description The date on which the Price entry was created. - * * @example 2018-08-23T19:59:23Z */ readonly date_created?: string; /** * Format: date-time * @description The date on which the Price entry was created. - * * @example 2018-08-23T19:59:23Z */ readonly date_modified?: string; /** * @description The ID of the `Product` this `Price Record`ʼs `variant_id` is associated with. Read only. - * * @example 158 */ readonly product_id?: number; } & { /** * @description The Price List with which this price set is associated. - * * @example 2 */ readonly price_list_id?: number; /** * @description The variant with which this price set is associated. Either `variant_id` or `sku` is required. - * * @example 325 */ readonly variant_id?: number; /** * Format: ISO-4217 * @description The 3-letter currency code with which this price set is associated. - * * @example usd */ readonly currency?: string; @@ -2580,44 +2417,37 @@ export interface operations { /** * Format: double * @description The list price for the variant mapped in a Price List. Overrides any existing or Catalog list price for the variant/product. - * * @example 3.99 */ readonly price?: number; /** * Format: double * @description The sale price for the variant mapped in a Price List. Overrides any existing or Catalog sale price for the variant/product. If empty, the sale price will be treated as not being set on this variant. - * */ readonly sale_price?: number; /** * Format: double * @description The retail price for the variant mapped in a Price List. Overrides any existing or Catalog retail price for the variant/product. If empty, the retail price will be treated as not being set on this variant. - * */ readonly retail_price?: number; /** * Format: double * @description The MAP (Minimum Advertised Price) for the variant mapped in a Price List. Overrides any existing or Catalog MAP price for the variant/product. If empty, the MAP price will be treated as not being set on this variant. - * */ readonly map_price?: number; readonly bulk_pricing_tiers?: readonly { /** * @description The minimum quantity of associated variant in the cart needed to qualify for the pricing of this tier. - * * @example 1 */ readonly quantity_min?: number; /** * @description The maximum allowed quantity of associated variant in the cart to qualify for the pricing of this tier. - * * @example 10 */ readonly quantity_max?: number; /** * @description The type of adjustment that is made. Acceptable values: price – the adjustment amount per product; percent – the adjustment as a percentage of the original price; fixed – the adjusted absolute price of the product. - * * @example price * @enum {string} */ @@ -2625,7 +2455,6 @@ export interface operations { /** * Format: double * @description The price adjustment amount. This value along with the type will decide the price per variant for the pricing tier. - * * @example 3 */ readonly amount?: number; @@ -2635,16 +2464,14 @@ export interface operations { }; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -2653,8 +2480,7 @@ export interface operations { }; }; }; - /** @description `Price Record` was in conflict with another price record. This is the result of duplicate unique values. - * */ + /** @description `Price Record` was in conflict with another price record. This is the result of duplicate unique values. */ readonly 409: { headers: { readonly [name: string]: unknown; @@ -2666,18 +2492,15 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; }; }; - /** @description `Price Record` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description `Price Record` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -2689,18 +2512,15 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; }; }; - /** @description Allowed number of requests exceeded. - * */ + /** @description Allowed number of requests exceeded. */ readonly 429: { headers: { readonly [name: string]: unknown; @@ -2720,14 +2540,11 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Price List` requested. - * */ + /** @description The ID of the `Price List` requested. */ readonly price_list_id: number; - /** @description ID of the variant on a product, or on an associated Price List Record. - * */ + /** @description ID of the variant on a product, or on an associated Price List Record. */ readonly variant_id: number; - /** @description The currency code associated with the price record being acted upon. - * */ + /** @description The currency code associated with the price record being acted upon. */ readonly currency_code: string; }; readonly cookie?: never; @@ -2868,8 +2685,7 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Price List` requested. - * */ + /** @description The ID of the `Price List` requested. */ readonly price_list_id: components["parameters"]["PriceListIdParam"]; }; readonly cookie?: never; diff --git a/src/internal/reference/generated/pricing.sf.ts b/src/internal/reference/generated/pricing.sf.ts index 354552a..5817438 100644 --- a/src/internal/reference/generated/pricing.sf.ts +++ b/src/internal/reference/generated/pricing.sf.ts @@ -372,9 +372,11 @@ export interface components { readonly options?: readonly { /** @description The ID of the variant option or modifier option being configured for this product. */ readonly option_id?: number; - /** @description The ID of the value matching the option being configured. + /** + * @description The ID of the value matching the option being configured. * - * **Note:** must be ID, not the value. */ + * **Note:** must be ID, not the value. + */ readonly value_id?: number; }[]; }; @@ -401,10 +403,11 @@ export interface components { readonly options?: readonly { /** @description The ID of the variant option or modifier option being configured for this product. */ readonly option_id?: number; - /** @description The ID of the value matching the option being configured. + /** + * @description The ID of the value matching the option being configured. * * **Note:** This must be the ID, not the value. - * */ + */ readonly value_id?: number; }[]; }[]; @@ -457,9 +460,11 @@ export interface operations { readonly options?: readonly { /** @description The ID of the variant option or modifier option that is being configured for this product. */ readonly option_id?: number; - /** @description The ID of the value matching the option that's being configured. + /** + * @description The ID of the value matching the option that's being configured. * - * **Note:*** This must be the ID, not the value. */ + * **Note:*** This must be the ID, not the value. + */ readonly value_id?: number; }[]; }[]; @@ -473,7 +478,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": [ * { * "product_id": 1, @@ -577,7 +583,8 @@ export interface operations { * } * ], * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: readonly (components["schemas"]["ReferenceRequest"] & { readonly reference_request?: components["schemas"]["ReferenceRequest"]; diff --git a/src/internal/reference/generated/promotion_settings.v3.ts b/src/internal/reference/generated/promotion_settings.v3.ts index 6fb4114..3fbc090 100644 --- a/src/internal/reference/generated/promotion_settings.v3.ts +++ b/src/internal/reference/generated/promotion_settings.v3.ts @@ -91,14 +91,11 @@ export interface components { readonly message?: string; }[]; }; - /** @description Error payload for the BigCommerce API. - * */ + /** @description Error payload for the BigCommerce API. */ readonly BaseError: { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; }; }; @@ -133,12 +130,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "promotions_triggered_by_products_with_zero_product_price": true, * "promotions_apply_on_products_with_custom_product_price": false, * "number_of_coupons_allowed_at_checkout": 1, * "promotions_applied_on_original_product_price": true - * } */ + * } + */ readonly "application/json": components["schemas"]["GlobalPromotionSettings"]; }; }; @@ -167,12 +166,14 @@ export interface operations { }; readonly requestBody: { readonly content: { - /** @example { + /** + * @example { * "promotions_triggered_by_products_with_zero_product_price": true, * "promotions_apply_on_products_with_custom_product_price": false, * "number_of_coupons_allowed_at_checkout": 1, * "promotions_applied_on_original_product_price": true - * } */ + * } + */ readonly "application/json": components["schemas"]["GlobalPromotionSettings"]; }; }; diff --git a/src/internal/reference/generated/promotions.v3.ts b/src/internal/reference/generated/promotions.v3.ts index b654714..c543f6d 100644 --- a/src/internal/reference/generated/promotions.v3.ts +++ b/src/internal/reference/generated/promotions.v3.ts @@ -252,6 +252,14 @@ export interface components { * @example false */ readonly coupon_overrides_automatic_when_offering_higher_discounts: boolean; + /** + * @description The type of the coupon promotion, whether it will have single or multiple codes. + * + * Must be the same as existing value because changing coupon type is not supported. The field is there just for the ease of drafting PUT payload. + * @example BULK + * @enum {string} + */ + readonly coupon_type?: "SINGLE" | "BULK"; }; /** * Draft Coupon Promotion @@ -273,6 +281,13 @@ export interface components { * @enum {string} */ readonly redemption_type: "COUPON"; + /** + * @description The type of the coupon promotion, whether it will have single or multiple codes, defaults to "SINGLE" if not provided. + * @default SINGLE + * @example BULK + * @enum {string} + */ + readonly coupon_type: "SINGLE" | "BULK"; }; /** * Saved Coupon Promotion @@ -308,6 +323,12 @@ export interface components { */ readonly has_multiple_codes: boolean; }; + /** + * @description The type of the coupon promotion, whether it will have single or multiple codes. + * @example BULK + * @enum {string} + */ + readonly coupon_type: "SINGLE" | "BULK"; }; /** * Patch Automatic Promotion @@ -342,11 +363,13 @@ export interface components { readonly id: number; readonly created_from: components["schemas"]["CreatedFrom"]; }; - /** @description Specifies the requirements which make the customer eligible for the promotion. + /** + * @description Specifies the requirements which make the customer eligible for the promotion. * * Note: * - Only "group_ids" or "excluded_group_ids" should be specified (have non-empty array data), but not both. - * - group_id zero (0) signifies guest customers or registered customers who are not assigned to any groups. */ + * - group_id zero (0) signifies guest customers or registered customers who are not assigned to any groups. + */ readonly Customer: { /** * @description A list of customer group IDs that the promotion targets. Only customers in those groups are eligible for this promotion. When unspecified, or set to an empty array, this requirement is not effective, and all customers who satisfy the other requirements (minimum_order_count, excluded_group_ids) are eligible for the promotion. @@ -588,8 +611,10 @@ export interface components { readonly discount: components["schemas"]["Discount"]; }; }; - /** @description **Gift Item Action** - * Give a gift item for free. */ + /** + * @description **Gift Item Action** + * Give a gift item for free. + */ readonly GiftItemAction: { readonly gift_item?: { /** @description Quantity of gift item to give. */ @@ -633,9 +658,11 @@ export interface components { readonly CartItemsAction: { readonly cart_items?: { readonly discount: components["schemas"]["Discount"]; - /** @description Set this value to true to distribute the discount as a total among matching items. By default, the discount applies to each item. + /** + * @description Set this value to true to distribute the discount as a total among matching items. By default, the discount applies to each item. * Example: If set to false, the discount is $10 and you have 2 eligible items for this discount in the cart, both items will be discounted by $10, with a total of $20 off the order. - * If set to true, $10 will be distributed among the 2 items, weighted by their respective price. In a case where there are 2 of the same items, each item will be discounted by $5. */ + * If set to true, $10 will be distributed among the 2 items, weighted by their respective price. In a case where there are 2 of the same items, each item will be discounted by $5. + */ readonly as_total?: boolean; readonly items?: components["schemas"]["ItemMatcher"]; /** @description Setting this value to true enables you to discount items that are used to satisfy the condition. By default items that are used to satisfy the condition are excluded from receiving the discount. For example, "Buy 1 Get 1 20% off." When the cart only contains 1 item, the discount won’t apply. */ @@ -698,7 +725,6 @@ export interface components { /** * Collection Meta * @description Contains data about paginating the response via cursors. If no pagination details are specified, then both properties will be present. When a 'before' or 'after' cursor is provided, only the 'cursor_pagination' property will be present. When a 'page' parameter is provided, only the offset based 'pagination' property will be present. - * */ readonly OptionalCursorCollectionMeta: { readonly pagination?: components["schemas"]["DeprecatedPagination"]; @@ -740,7 +766,6 @@ export interface components { * Pagination * @deprecated * @description Data about the response, including pagination and collection totals. This property has been deprecated and cursor_pagination should be used instead. - * */ readonly DeprecatedPagination: { /** @description Total number of items in the result set. */ @@ -780,26 +805,22 @@ export interface components { readonly per_page: number; /** * @description The cursor to the first item in the result set. Can be used with the "before" query parameter to paginate backwards. This property is omitted when the result set is empty. - * * @example eyJpZCI6IjIzNzU1NyJ9 */ readonly start_cursor?: string; /** * @description The cursor to the last item in the result set. Can be used with the "after" query parameter to paginate forwards. This property is omitted when the result set is empty. - * * @example eyJpZCI6IjIzNzU1NyJ9 */ readonly end_cursor?: string; readonly links: { /** * @description Link to the previous page returned in the response. This property is omitted when the result set is empty or on the first page. - * * @example ?limit=5&before=eyJpZCI6IjIzNzU1NyJ9 */ readonly previous?: string; /** * @description Link to the next page returned in the response. This property is omitted when the result set is empty. - * * @example ?limit=5&after=eyJpZCI6IjIzNzU1NyJ9 */ readonly next?: string; @@ -840,6 +861,18 @@ export interface components { /** @description Error payload for the BigCommerce API. */ readonly error?: string; }; + /** + * 405 Error Response + * @description The requested method is not allowed for the specified resource. + */ + readonly ErrorResponse405: { + /** @description Method not allowed. */ + readonly status?: string; + /** @description The error title describing the particular error. */ + readonly title?: string; + /** @description Error payload for the BigCommerce API. */ + readonly error?: string; + }; /** * Notification * @description **Notification** @@ -1101,7 +1134,8 @@ export interface components { readonly errors?: readonly components["schemas"]["BulkActionResponseError"][]; readonly meta?: components["schemas"]["BulkActionResponseMeta"]; }; - /** @example { + /** + * @example { * "errors": [ * { * "status": 422, @@ -1114,9 +1148,11 @@ export interface components { * "success": 0, * "failed": 0 * } - * } */ + * } + */ readonly "422 - Missing Parameter": unknown; - /** @example { + /** + * @example { * "errors": [ * { * "status": 422, @@ -1133,7 +1169,8 @@ export interface components { * "success": 3, * "failed": 2 * } - * } */ + * } + */ readonly "422 - Error Deleting": unknown; }; }; @@ -1223,20 +1260,20 @@ export interface components { readonly CodeIdPath: string; /** @description Filter items by `id`. */ readonly IdQuery: number; - /** @description A comma-separated list of promotions to filter or target with this operation. + /** + * @description A comma-separated list of promotions to filter or target with this operation. * - * Example: **?id:in=11,12,13,14** */ + * Example: **?id:in=11,12,13,14** + */ readonly IdInQuery: readonly number[]; /** @description Query parameter that specifies the page number in a paginated list of resources. */ readonly PageQuery: number; /** * @deprecated * @description Query parameter that specifies the page number in a paginated list of resources. This field is deprecated and the 'before' and 'after' cursor parameters should be used instead. - * */ readonly DeprecatedPageQuery: number; - /** @description Query parameter that limits the number of items displayed per page in a paginated list of resources. When none is specified a default value of 50 is used. - * */ + /** @description Query parameter that limits the number of items displayed per page in a paginated list of resources. When none is specified a default value of 50 is used. */ readonly LimitQuery: number; /** @description Filter items by `name`. */ readonly NameQuery: string; @@ -1256,11 +1293,9 @@ export interface components { readonly DirectionQuery: "asc" | "desc"; /** @description The ID of the associated promotion. */ readonly PromotionIdPath: string; - /** @description A cursor that can be used for backwards pagination. Will fetch results before the position corresponding to the cursor. Cannot be used with the 'page' query parameter. Cannot be used with the 'after' query parameter. - * */ + /** @description A cursor that can be used for backwards pagination. Will fetch results before the position corresponding to the cursor. Cannot be used with the 'page' query parameter. Cannot be used with the 'after' query parameter. */ readonly BeforeCursorQuery: string; - /** @description A cursor that can be used for forwards pagination. Will fetch results after the position corresponding to the cursor. Cannot be used with the 'page' query parameter. Cannot be used with the 'before' query parameter. - * */ + /** @description A cursor that can be used for forwards pagination. Will fetch results after the position corresponding to the cursor. Cannot be used with the 'page' query parameter. Cannot be used with the 'before' query parameter. */ readonly AfterCursorQuery: string; /** @description Filter promotions that target those `channel IDs`. Example: **?channels=1,2**. Note: promotions that target all the channels are included in the filtering result. */ readonly ChannelQuery: readonly number[]; @@ -1288,8 +1323,7 @@ export interface operations { readonly status?: components["parameters"]["StatusQuery"]; /** @description Query parameter that specifies the page number in a paginated list of resources. */ readonly page?: components["parameters"]["PageQuery"]; - /** @description Query parameter that limits the number of items displayed per page in a paginated list of resources. When none is specified a default value of 50 is used. - * */ + /** @description Query parameter that limits the number of items displayed per page in a paginated list of resources. When none is specified a default value of 50 is used. */ readonly limit?: components["parameters"]["LimitQuery"]; /** @description Query parameter that specifies the field name to sort by. The default value is *id*. */ readonly sort?: components["parameters"]["SortQuery"]; @@ -1372,9 +1406,11 @@ export interface operations { readonly deletePromotions: { readonly parameters: { readonly query: { - /** @description A comma-separated list of promotions to filter or target with this operation. + /** + * @description A comma-separated list of promotions to filter or target with this operation. * - * Example: **?id:in=11,12,13,14** */ + * Example: **?id:in=11,12,13,14** + */ readonly "id:in": components["parameters"]["IdInQuery"]; }; readonly header?: { @@ -1483,20 +1519,16 @@ export interface operations { readonly getPromotionCodes: { readonly parameters: { readonly query?: { - /** @description A cursor that can be used for backwards pagination. Will fetch results before the position corresponding to the cursor. Cannot be used with the 'page' query parameter. Cannot be used with the 'after' query parameter. - * */ + /** @description A cursor that can be used for backwards pagination. Will fetch results before the position corresponding to the cursor. Cannot be used with the 'page' query parameter. Cannot be used with the 'after' query parameter. */ readonly before?: components["parameters"]["BeforeCursorQuery"]; - /** @description A cursor that can be used for forwards pagination. Will fetch results after the position corresponding to the cursor. Cannot be used with the 'page' query parameter. Cannot be used with the 'before' query parameter. - * */ + /** @description A cursor that can be used for forwards pagination. Will fetch results after the position corresponding to the cursor. Cannot be used with the 'page' query parameter. Cannot be used with the 'before' query parameter. */ readonly after?: components["parameters"]["AfterCursorQuery"]; /** * @deprecated * @description Query parameter that specifies the page number in a paginated list of resources. This field is deprecated and the 'before' and 'after' cursor parameters should be used instead. - * */ readonly page?: components["parameters"]["DeprecatedPageQuery"]; - /** @description Query parameter that limits the number of items displayed per page in a paginated list of resources. When none is specified a default value of 50 is used. - * */ + /** @description Query parameter that limits the number of items displayed per page in a paginated list of resources. When none is specified a default value of 50 is used. */ readonly limit?: components["parameters"]["LimitQuery"]; }; readonly header?: { @@ -1548,15 +1580,17 @@ export interface operations { }; }; readonly responses: { - readonly 200: components["responses"]["PromotionCodeResponse"]; + readonly 201: components["responses"]["PromotionCodeResponse"]; }; }; readonly deleteCouponCodes: { readonly parameters: { readonly query: { - /** @description A comma-separated list of promotions to filter or target with this operation. + /** + * @description A comma-separated list of promotions to filter or target with this operation. * - * Example: **?id:in=11,12,13,14** */ + * Example: **?id:in=11,12,13,14** + */ readonly "id:in": components["parameters"]["IdInQuery"]; }; readonly header?: { @@ -1637,6 +1671,15 @@ export interface operations { readonly "application/json": components["schemas"]["ErrorResponse403"]; }; }; + /** @description Method not allowed. Bulk code generation is only supported for promotions with redemption_type of 'COUPON' and coupon_type of 'BULK'. */ + readonly 405: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorResponse405"]; + }; + }; /** @description The request payload is invalid. */ readonly 422: { headers: { diff --git a/src/internal/reference/generated/redirects.v3.ts b/src/internal/reference/generated/redirects.v3.ts index 3bad8de..6bdef82 100644 --- a/src/internal/reference/generated/redirects.v3.ts +++ b/src/internal/reference/generated/redirects.v3.ts @@ -246,14 +246,11 @@ export interface components { readonly DetailedErrors: { readonly [key: string]: unknown; }; - /** @description Error payload for the BigCommerce API. - * */ + /** @description Error payload for the BigCommerce API. */ readonly BaseError: { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; @@ -298,8 +295,7 @@ export interface operations { readonly limit?: number; /** @description Specifies the page number in a limited (paginated) list of items. Used to paginate large collections. */ readonly page?: number; - /** @description Field name to sort by. Since redirect IDs increment when new redirects are added, you can sort by ID to return results in redirect create date order. - * */ + /** @description Field name to sort by. Since redirect IDs increment when new redirects are added, you can sort by ID to return results in redirect create date order. */ readonly sort?: "from_path" | "type" | "site_id" | "id"; /** @description Sort direction. Acceptable values are `asc`, `desc`. */ readonly direction?: "asc" | "desc"; diff --git a/src/internal/reference/generated/scripts.v3.ts b/src/internal/reference/generated/scripts.v3.ts index 730b874..678a6db 100644 --- a/src/internal/reference/generated/scripts.v3.ts +++ b/src/internal/reference/generated/scripts.v3.ts @@ -92,48 +92,39 @@ export interface components { readonly pagination?: { /** * @description Total number of items in the result set. - * * @example 36 */ readonly total?: number; /** * @description Total number of items in the collection response. - * * @example 36 */ readonly count?: number; /** * @description The amount of items returned in the collection per page, controlled by the limit parameter. - * * @example 50 */ readonly per_page?: number; /** * @description The page you are currently on within the collection. - * * @example 1 */ readonly current_page?: number; /** * @description The total number of pages in the collection. - * * @example 1 */ readonly total_pages?: number; - /** @description Pagination links for the previous and next parts of the whole collection. - * */ + /** @description Pagination links for the previous and next parts of the whole collection. */ readonly links?: { - /** @description Link to the previous page returned in the response. - * */ + /** @description Link to the previous page returned in the response. */ readonly previous?: string; /** * @description Link to the current page returned in the response. - * * @example ?page=1&limit=50 */ readonly current?: string; - /** @description Link to the next page returned in the response. - * */ + /** @description Link to the next page returned in the response. */ readonly next?: string; }; }; @@ -145,48 +136,39 @@ export interface components { readonly Pagination: { /** * @description Total number of items in the result set. - * * @example 36 */ readonly total?: number; /** * @description Total number of items in the collection response. - * * @example 36 */ readonly count?: number; /** * @description The amount of items returned in the collection per page, controlled by the limit parameter. - * * @example 50 */ readonly per_page?: number; /** * @description The page you are currently on within the collection. - * * @example 1 */ readonly current_page?: number; /** * @description The total number of pages in the collection. - * * @example 1 */ readonly total_pages?: number; - /** @description Pagination links for the previous and next parts of the whole collection. - * */ + /** @description Pagination links for the previous and next parts of the whole collection. */ readonly links?: { - /** @description Link to the previous page returned in the response. - * */ + /** @description Link to the previous page returned in the response. */ readonly previous?: string; /** * @description Link to the current page returned in the response. - * * @example ?page=1&limit=50 */ readonly current?: string; - /** @description Link to the next page returned in the response. - * */ + /** @description Link to the next page returned in the response. */ readonly next?: string; }; }; @@ -199,11 +181,9 @@ export interface components { }; /** Error Response */ readonly ErrorResponse: { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; @@ -216,14 +196,11 @@ export interface components { /** * Base Error * @description Error payload for the BigCommerce API. - * */ readonly BaseError: { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; @@ -237,8 +214,7 @@ export interface components { * @description Error payload for the BigCommerce API. */ readonly NotFound: { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -252,7 +228,6 @@ export interface components { readonly NoContent: { /** * @description 204 HTTP status code. - * * @example 204 */ readonly status?: number; @@ -372,7 +347,6 @@ export interface components { * @description Array of [Subresource integrity (SRI) hashes](https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity) for external SRC scripts that lets browsers validate the contents of the script. * * The hash is the `integrity` attribute on the `script` tag. You can add up to five hashes for a script and generate them using any SRI standard-supported algorithm, including SHA-256, SHA-384, and SHA-512. If you provide more than one hash, they will all be added to the `integrity` attribute in order, separated by whitespace. - * * @example [ * "sha384-DgtwqxoPLKnJSER+TUmSPIpE6ZbVb2ZZwR241HHiqJipLiZQPN/JkKX5xxrEHUTt", * "sha384-UiwrqEuzfCtJKLI+dXmPNOpE6ZvBh2IIqT371rJiqJxyKjZ6PP/JmSD5hdsEUPOl" @@ -403,18 +377,15 @@ export interface components { readonly PageParam: number; /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly LimitParam: number; - /** @description Scripts field name to sort by. - * */ + /** @description Scripts field name to sort by. */ readonly ScriptsSortKeyParam: "name" | "description" | "date_created" | "date_modified"; - /** @description Sort direction. Acceptable values are: `asc`, `desc`. - * */ + /** @description Sort direction. Acceptable values are: `asc`, `desc`. */ readonly DirectionParam: "asc" | "desc"; /** @description The identifier for a specific template. */ readonly TemplateUUID: string; /** @description The template file, for example: `pages/home`. */ readonly RequiredTemplateFile: string; - /** @description The query string associated with a widget's name and description. - * */ + /** @description The query string associated with a widget's name and description. */ readonly QueryWidgetsParam: string; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept: string; @@ -434,11 +405,9 @@ export interface operations { readonly page?: number; /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: number; - /** @description Field name to sort the scripts by. Note: Since `id` increments when new scripts are added, you can use that field to sort by script create date. - * */ + /** @description Field name to sort the scripts by. Note: Since `id` increments when new scripts are added, you can use that field to sort by script create date. */ readonly sort?: "name" | "description" | "date_created" | "date_modified"; - /** @description Sort direction. Acceptable values are: `asc`, `desc`. - * */ + /** @description Sort direction. Acceptable values are: `asc`, `desc`. */ readonly direction?: "asc" | "desc"; /** @description Filters list of scripts by the associated channel ID. */ readonly "channel_id:in"?: readonly number[]; @@ -463,19 +432,16 @@ export interface operations { }; }; }; - /** @description This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; @@ -514,19 +480,16 @@ export interface operations { readonly "application/json": components["schemas"]["script_Response"]; }; }; - /** @description This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; @@ -564,19 +527,16 @@ export interface operations { readonly "application/json": components["schemas"]["script_Response"]; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; @@ -588,19 +548,16 @@ export interface operations { }; }; }; - /** @description This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; @@ -643,19 +600,16 @@ export interface operations { readonly "application/json": components["schemas"]["script_Response"]; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; @@ -667,19 +621,16 @@ export interface operations { }; }; }; - /** @description This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; @@ -723,11 +674,9 @@ export interface operations { }; content: { readonly "application/json": { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; @@ -746,11 +695,9 @@ export interface operations { }; content: { readonly "application/json": { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; diff --git a/src/internal/reference/generated/segments.v3.ts b/src/internal/reference/generated/segments.v3.ts index 5510f73..5cb8ac0 100644 --- a/src/internal/reference/generated/segments.v3.ts +++ b/src/internal/reference/generated/segments.v3.ts @@ -25,7 +25,6 @@ export interface paths { * * **Limits** * * Limit of 10 concurrent requests. - * */ readonly put: operations["PutSegmentObjects"]; /** @@ -34,13 +33,11 @@ export interface paths { * * **Limits** * * Limit of 10 concurrent requests. - * */ readonly post: operations["SegmentsPostRequest"]; /** * Delete Segments * @description Deletes one or more *Segments* from a store. This will not delete any associated *Shopper Profiles*. - * */ readonly delete: operations["DeleteStoreSegment"]; }; @@ -62,7 +59,6 @@ export interface paths { * @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. - * */ readonly get: operations["GetSegmentProfiles"]; /** @@ -77,7 +73,6 @@ export interface paths { /** * Remove Shopper Profiles from a Segment * @description Remove one or more *Shopper Profiles* that are associated with a *Segment*. This operation only removes the association; it doesn't delete the *Shopper Profiles*. - * */ readonly delete: operations["DeleteShopperProfile"]; }; @@ -94,19 +89,16 @@ export interface paths { /** * Get All Shopper Profiles * @description Returns a paginated *Shopper Profiles* list. - * */ readonly get: operations["GetShopperList"]; /** * Create Shopper Profiles * @description Creates a *Shopper Profile*. - * */ readonly post: operations["ShopperProfilesRequest"]; /** * Delete Shopper Profiles * @description Deletes one or more *Shopper Profiles* from a store. - * */ readonly delete: operations["DeleteStoreShopperProfile"]; }; @@ -133,17 +125,14 @@ export interface paths { export type webhooks = Record; export interface components { schemas: { - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly SegmentsResponse: { readonly data?: readonly components["schemas"]["Segment"][]; readonly meta?: Record; }; - /** @description Request payload for the BigCommerce API. - * */ + /** @description Request payload for the BigCommerce API. */ readonly SegmentsPostRequest: readonly components["schemas"]["SegmentPost"][]; - /** @description Request payload for the BigCommerce API. - * */ + /** @description Request payload for the BigCommerce API. */ readonly SegmentsPutRequest: readonly components["schemas"]["SegmentPut"][]; readonly SegmentPost: { /** @@ -174,56 +163,46 @@ export interface components { */ readonly description?: string; }; - /** @description Data about the response including pagination, and collection totals. - * */ + /** @description Data about the response including pagination, and collection totals. */ readonly Pagination: { /** * @description Total number of items in the result set. - * * @example 1 */ readonly total?: number; /** * @description Total number of items in the collection response. - * * @example 1 */ readonly count?: number; /** * @description The amount of items returned in the collection per page, controlled by the limit parameter. - * * @example 50 */ readonly per_page?: number; /** * @description The page you are currently on within the collection. - * * @example 1 */ readonly current_page?: number; /** * @description The total number of pages in the collection. - * * @example 1 */ readonly total_pages?: number; }; - /** @description Data about the response including pagination, and collection totals. - * */ + /** @description Data about the response including pagination, and collection totals. */ readonly CollectionMeta: { readonly pagination?: components["schemas"]["Pagination"]; }; readonly ErrorResponse: components["schemas"]["BaseError"] & { readonly errors?: components["schemas"]["DetailedErrors"]; }; - /** @description Error payload for the BigCommerce API. - * */ + /** @description Error payload for the BigCommerce API. */ readonly BaseError: { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; @@ -235,38 +214,32 @@ export interface components { /** * Format: uuid * @description The ID of the segment. - * */ readonly id?: string; /** * @description The name of the segment. - * * @example My Segment */ readonly name?: string; /** * @description The description of the segment. - * * @example Description */ readonly description?: string; /** * Format: date-time * @description The date of which the segment was created. - * * @example 2022-09-15T23:44:05Z */ readonly created_at?: string; /** * Format: date-time * @description The date of which the segment was updated. - * * @example 2022-09-15T23:44:05Z */ readonly updated_at?: string; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly SegmentCollectionResponse: { readonly data?: readonly components["schemas"]["Segment"][]; readonly meta?: components["schemas"]["CollectionMeta"]; @@ -275,25 +248,21 @@ export interface components { /** * Format: uuid * @description The ID of the *Shopper Profile*. - * */ readonly id?: string; /** * @description The ID of the registered *Customer* associated with this *Shopper Profile*. - * * @example 1 */ readonly customer_id?: number; /** * Format: date-time * @description The date and time when the *Shopper Profile* was created. - * */ readonly created_at?: string; /** * Format: date-time * @description The date and time when the *Shopper Profile* was last updated. - * */ readonly updated_at?: string; }; @@ -306,14 +275,12 @@ export interface components { readonly data?: readonly components["schemas"]["ShopperProfile"][]; readonly meta?: components["schemas"]["CollectionMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly ShopperProfilesCollectionResponse: { readonly data?: readonly components["schemas"]["ShopperProfile"][]; readonly meta?: components["schemas"]["CollectionMeta"]; }; - /** @description Request payload for the BigCommerce API. - * */ + /** @description Request payload for the BigCommerce API. */ readonly ShopperProfilesPostRequest: readonly components["schemas"]["ShopperProfilePost"][]; readonly ShopperProfilePost: { /** @@ -322,8 +289,7 @@ export interface components { */ readonly customer_id?: number; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly ShopperProfilesResponse: { readonly data?: readonly components["schemas"]["ShopperProfile"][]; readonly meta?: Record; @@ -339,14 +305,11 @@ export interface components { readonly SegmentIdPathParam: string; /** @description The *Shopper Profile* ID. */ readonly ShopperIdPathParam: string; - /** @description Comma separated IDs. - * */ + /** @description Comma separated IDs. */ readonly FilterIdParam: readonly string[]; - /** @description Page number. - * */ + /** @description Page number. */ readonly FilterPageParam: number; - /** @description Items count per page. - * */ + /** @description Items count per page. */ readonly FilterLimitParam: number; }; requestBodies: never; @@ -358,14 +321,11 @@ export interface operations { readonly GetPaginatedSegmentsList: { readonly parameters: { readonly query?: { - /** @description Page number. - * */ + /** @description Page number. */ readonly page?: components["parameters"]["FilterPageParam"]; - /** @description Items count per page. - * */ + /** @description Items count per page. */ readonly limit?: components["parameters"]["FilterLimitParam"]; - /** @description Comma separated IDs. - * */ + /** @description Comma separated IDs. */ readonly "id:in"?: components["parameters"]["FilterIdParam"]; }; readonly header?: { @@ -405,8 +365,7 @@ export interface operations { }; }; readonly responses: { - /** @description An array of created *Segments*. - * */ + /** @description An array of created *Segments*. */ readonly 201: { headers: { readonly [name: string]: unknown; @@ -415,8 +374,7 @@ export interface operations { readonly "application/json": components["schemas"]["SegmentsResponse"]; }; }; - /** @description The *Segment* was not valid. This is the result of either missing required fields, or because of invalid data. See the response for more details. - * */ + /** @description The *Segment* was not valid. This is the result of either missing required fields, or because of invalid data. See the response for more details. */ readonly 400: { headers: { readonly [name: string]: unknown; @@ -455,8 +413,7 @@ export interface operations { readonly "application/json": components["schemas"]["SegmentsResponse"]; }; }; - /** @description The *Segment* was not valid. This is the result of either missing required fields, or because of invalid data. See the response for more details. - * */ + /** @description The *Segment* was not valid. This is the result of either missing required fields, or because of invalid data. See the response for more details. */ readonly 400: { headers: { readonly [name: string]: unknown; @@ -492,8 +449,7 @@ export interface operations { readonly DeleteStoreSegment: { readonly parameters: { readonly query?: { - /** @description Comma separated IDs. - * */ + /** @description Comma separated IDs. */ readonly "id:in"?: components["parameters"]["FilterIdParam"]; }; readonly header?: { @@ -505,8 +461,7 @@ export interface operations { }; readonly requestBody?: never; readonly responses: { - /** @description An empty response. - * */ + /** @description An empty response. */ readonly 204: { headers: { readonly [name: string]: unknown; @@ -518,11 +473,9 @@ export interface operations { readonly GetSegmentProfiles: { readonly parameters: { readonly query?: { - /** @description Page number. - * */ + /** @description Page number. */ readonly page?: components["parameters"]["FilterPageParam"]; - /** @description Items count per page. - * */ + /** @description Items count per page. */ readonly limit?: components["parameters"]["FilterLimitParam"]; }; readonly header?: { @@ -537,8 +490,7 @@ export interface operations { }; readonly requestBody?: never; readonly responses: { - /** @description An array of *Shopper Profiles* objects and metadata. - * */ + /** @description An array of *Shopper Profiles* objects and metadata. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -608,8 +560,7 @@ export interface operations { readonly DeleteShopperProfile: { readonly parameters: { readonly query?: { - /** @description Comma separated IDs. - * */ + /** @description Comma separated IDs. */ readonly "id:in"?: components["parameters"]["FilterIdParam"]; }; readonly header?: { @@ -624,8 +575,7 @@ export interface operations { }; readonly requestBody?: never; readonly responses: { - /** @description An empty response. - * */ + /** @description An empty response. */ readonly 204: { headers: { readonly [name: string]: unknown; @@ -637,11 +587,9 @@ export interface operations { readonly GetShopperList: { readonly parameters: { readonly query?: { - /** @description Page number. - * */ + /** @description Page number. */ readonly page?: components["parameters"]["FilterPageParam"]; - /** @description Items count per page. - * */ + /** @description Items count per page. */ readonly limit?: components["parameters"]["FilterLimitParam"]; }; readonly header?: { @@ -653,8 +601,7 @@ export interface operations { }; readonly requestBody?: never; readonly responses: { - /** @description An array of *Shopper Profiles* objects and metadata. - * */ + /** @description An array of *Shopper Profiles* objects and metadata. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -683,8 +630,7 @@ export interface operations { }; }; readonly responses: { - /** @description An array of created *Shopper Profiles*. - * */ + /** @description An array of created *Shopper Profiles*. */ readonly 201: { headers: { readonly [name: string]: unknown; @@ -693,8 +639,7 @@ export interface operations { readonly "application/json": components["schemas"]["ShopperProfilesResponse"]; }; }; - /** @description The *Segment* was not valid. This is the result of either missing required fields, or because of invalid data. See the response for more details. - * */ + /** @description The *Segment* was not valid. This is the result of either missing required fields, or because of invalid data. See the response for more details. */ readonly 400: { headers: { readonly [name: string]: unknown; @@ -708,8 +653,7 @@ export interface operations { readonly DeleteStoreShopperProfile: { readonly parameters: { readonly query?: { - /** @description Comma separated IDs. - * */ + /** @description Comma separated IDs. */ readonly "id:in"?: components["parameters"]["FilterIdParam"]; }; readonly header?: { @@ -721,8 +665,7 @@ export interface operations { }; readonly requestBody?: never; readonly responses: { - /** @description An empty response. - * */ + /** @description An empty response. */ readonly 204: { headers: { readonly [name: string]: unknown; @@ -734,11 +677,9 @@ export interface operations { readonly GetListShopperProfile: { readonly parameters: { readonly query?: { - /** @description Page number. - * */ + /** @description Page number. */ readonly page?: components["parameters"]["FilterPageParam"]; - /** @description Items count per page. - * */ + /** @description Items count per page. */ readonly limit?: components["parameters"]["FilterLimitParam"]; }; readonly header?: { @@ -753,8 +694,7 @@ export interface operations { }; readonly requestBody?: never; readonly responses: { - /** @description An array of *Segments* objects and metadata. - * */ + /** @description An array of *Segments* objects and metadata. */ readonly 200: { headers: { readonly [name: string]: unknown; diff --git a/src/internal/reference/generated/settings.v3.ts b/src/internal/reference/generated/settings.v3.ts index 242053e..51005a7 100644 --- a/src/internal/reference/generated/settings.v3.ts +++ b/src/internal/reference/generated/settings.v3.ts @@ -260,11 +260,15 @@ export interface paths { /** * Get Locale Settings * @description Returns global locale settings. + * + * For stores with Catalyst channels, the `shopper_language_selection_method` field is deprecated. Using this endpoint on those stores will return a warning about the deprecation. For additional information, refer to [Locale Configuration](/docs/store-operations/settings/locales). */ readonly get: operations["getSettingsLocale"]; /** * Update Locale Settings * @description Updates global locale settings. + * + * For stores with Catalyst channels, the `shopper_language_selection_method` field is deprecated. Using this endpoint on those stores will return a warning about the deprecation. For additional information, refer to [Locale Configuration](/docs/store-operations/settings/locales). */ readonly put: operations["updateSettingsLocale"]; }; @@ -601,15 +605,12 @@ export interface components { /** @enum {string} */ readonly type?: "price"; }; - /** @description Error payload for the BigCommerce API. - * */ + /** @description Error payload for the BigCommerce API. */ readonly BaseError: { readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -800,13 +801,17 @@ export interface components { * @enum {string} */ readonly update_stock_behavior?: "order_placed" | "order_completed_or_shipped"; - /** @description Describes whether stock levels automatically adjust when you edit an order. + /** + * @description Describes whether stock levels automatically adjust when you edit an order. * - * Global settings apply when inventory changes through a [manual order](https://support.bigcommerce.com/s/article/Creating-a-Manual-Order?language=en_US). Settings for a channel apply when inventory changes through an order in a channel. These settings affect webhooks that trigger from order-related events, including [product](/docs/integrations/webhooks/events#products), [SKU](/docs/integrations/webhooks/events#skus), and [inventory](/docs/integrations/webhooks/events/inventory-location#inventory) webhooks. */ + * Global settings apply when inventory changes through a [manual order](https://support.bigcommerce.com/s/article/Creating-a-Manual-Order?language=en_US). Settings for a channel apply when inventory changes through an order in a channel. These settings affect webhooks that trigger from order-related events, including [product](/docs/integrations/webhooks/events#products), [SKU](/docs/integrations/webhooks/events#skus), and [inventory](/docs/integrations/webhooks/events/inventory-location#inventory) webhooks. + */ readonly edit_order_stock_adjustment?: boolean; - /** @description Describes whether stock levels automatically adjust when you refund or cancel an order. + /** + * @description Describes whether stock levels automatically adjust when you refund or cancel an order. * - * Global settings apply when inventory changes through a [manual order](https://support.bigcommerce.com/s/article/Creating-a-Manual-Order?language=en_US). Settings for a channel apply when inventory changes through an order in a channel. These settings affect webhooks that trigger from order-related events, including [product](/docs/integrations/webhooks/events#products), [SKU](/docs/integrations/webhooks/events#skus), and [inventory](/docs/integrations/webhooks/events/inventory-location#inventory) webhooks. */ + * Global settings apply when inventory changes through a [manual order](https://support.bigcommerce.com/s/article/Creating-a-Manual-Order?language=en_US). Settings for a channel apply when inventory changes through an order in a channel. These settings affect webhooks that trigger from order-related events, including [product](/docs/integrations/webhooks/events#products), [SKU](/docs/integrations/webhooks/events#skus), and [inventory](/docs/integrations/webhooks/events/inventory-location#inventory) webhooks. + */ readonly refund_order_stock_adjustment?: boolean; /** * @description Describes whether a storefront displays stock levels. @@ -818,7 +823,7 @@ export interface components { * @example Currently out of stock */ readonly default_out_of_stock_message?: string; - /** @description Describes whether an option is hidden in product filtering. Applies when `option_out_of_stock_behavior` is set to `label_option`. */ + /** @description Describes whether an option is hidden in product filtering. Applies when `option_out_of_stock_behavior` is set to `label_option`. */ readonly hide_in_product_filtering?: boolean; /** * @description Describes whether pre-order stock levels are shown. @@ -935,49 +940,41 @@ export interface components { readonly StorefrontProductSettings: { /** * @description Determines the visibility of the product price. - * * @example true */ readonly show_product_price?: boolean; /** * @description Determines the visibility of the product SKU. - * * @example true */ readonly show_product_sku?: boolean; /** * @description Determines the visibility of the productʼs weight. - * * @example false */ readonly show_product_weight?: boolean; /** * @description Determines the visibility of the productʼs brand. - * * @example true */ readonly show_product_brand?: boolean; /** * @description Determines the visibility of the productʼs shipping option. - * * @example false */ readonly show_product_shipping?: boolean; /** * @description Determines the visibility of the productʼs rating. - * * @example true */ readonly show_product_rating?: boolean; /** * @description Determines the visibility of the Add to Cart link. - * * @example true */ readonly show_add_to_cart_link?: boolean; /** * @description The productʼs pre-order message. If undefined, the message defaults to the storewide setting. - * * @example Preorder message */ readonly default_preorder_message?: string; @@ -988,19 +985,16 @@ export interface components { readonly show_breadcrumbs_product_pages?: "show_one" | "show_none"; /** * @description Determines the visibility of the Add to Cart quantity setting. - * * @example true */ readonly show_add_to_cart_qty_box?: boolean; /** * @description Determines the visibility of the Add to Wishlist setting. - * * @example true */ readonly show_add_to_wishlist?: boolean; /** * @description Determines the visibility of the price. - * * @example false */ readonly hide_price_from_guests?: boolean; @@ -1075,8 +1069,7 @@ export interface components { }; }; }; - /** @description `422 Unprocessable Entity` Provided settings could not be applied for some reason - detailed errors in the response. - * */ + /** @description `422 Unprocessable Entity` Provided settings could not be applied for some reason - detailed errors in the response. */ readonly "422ErrorResp": { headers: { readonly [name: string]: unknown; diff --git a/src/internal/reference/generated/shipping.v2.ts b/src/internal/reference/generated/shipping.v2.ts index 2085e45..b9d304a 100644 --- a/src/internal/reference/generated/shipping.v2.ts +++ b/src/internal/reference/generated/shipping.v2.ts @@ -1976,7 +1976,8 @@ export interface operations { }; readonly requestBody: { readonly content: { - /** @example { + /** + * @example { * "name": "Per Order", * "type": "perorder", * "settings": { @@ -1989,7 +1990,8 @@ export interface operations { * "channel_ids": [ * 1 * ] - * } */ + * } + */ readonly "application/json": components["schemas"]["shippingMethod_Base"]; }; }; @@ -2097,7 +2099,8 @@ export interface operations { }; readonly requestBody: { readonly content: { - /** @example { + /** + * @example { * "settings": { * "rate": 11 * }, @@ -2108,7 +2111,8 @@ export interface operations { * 2, * 3 * ] - * } */ + * } + */ readonly "application/json": components["schemas"]["shippingMethod_Base"]; }; }; @@ -2163,13 +2167,15 @@ export interface operations { /** @description The request body will vary by carrier. See [Create a Carrier Connection](/docs/rest-management/shipping-v2/shipping-carrier#create-a-carrier-connection). */ readonly requestBody?: { readonly content: { - /** @example { + /** + * @example { * "carrier_id": "endicia", * "connection": { * "account_id": "yourEndiciaAccountId", * "pass_phrase": "yourEndiciaPassphrase" * } - * } */ + * } + */ readonly "application/json": components["schemas"]["carrierConnection"]; }; }; @@ -2181,14 +2187,16 @@ export interface operations { }; content?: never; }; - /** @description If a required field is not provided, the request will return a 400 response. + /** + * @description If a required field is not provided, the request will return a 400 response. * * [ * { * "status": 400, * "message": "Required fields missing [key]" * } - * ] */ + * ] + */ readonly 400: { headers: { readonly [name: string]: unknown; @@ -2213,13 +2221,15 @@ export interface operations { }; readonly requestBody?: { readonly content: { - /** @example { + /** + * @example { * "carrier_id": "auspost", * "connection": { * "auth_key": "yourAusPostAuthKey", * "test_mode": false * } - * } */ + * } + */ readonly "application/json": components["schemas"]["carrierConnection"]; }; }; @@ -2231,7 +2241,8 @@ export interface operations { }; content?: never; }; - /** @description Invalid requests will return a 400 response. + /** + * @description Invalid requests will return a 400 response. * * [ * { @@ -2248,7 +2259,7 @@ export interface operations { * "message": "Required fields missing [key]" * } * ] - * */ + */ readonly 400: { headers: { readonly [name: string]: unknown; @@ -2271,9 +2282,11 @@ export interface operations { }; readonly requestBody: { readonly content: { - /** @example { + /** + * @example { * "carrier_id": "fedex" - * } */ + * } + */ readonly "application/json": { /** @example fedex */ readonly carrier_id?: string; @@ -2288,14 +2301,16 @@ export interface operations { }; content?: never; }; - /** @description If a required field is not provided, the request will return a 400 response. + /** + * @description If a required field is not provided, the request will return a 400 response. * * [ * { * "status": 400, * "message": "Required fields missing [key]" * } - * ] */ + * ] + */ readonly 400: { headers: { readonly [name: string]: unknown; diff --git a/src/internal/reference/generated/shipping.v3.ts b/src/internal/reference/generated/shipping.v3.ts index fe01f14..68c2476 100644 --- a/src/internal/reference/generated/shipping.v3.ts +++ b/src/internal/reference/generated/shipping.v3.ts @@ -321,9 +321,11 @@ export interface components { readonly "application/json": components["schemas"]["error_Full"]; }; }; - /** @description If this occurs, you should retry the request. If you are unable to successfully make a request, please check the [BigCommerce system status](https://status.bigcommerce.com/). A service is likely down and the request will need to be made again when it is back up. + /** + * @description If this occurs, you should retry the request. If you are unable to successfully make a request, please check the [BigCommerce system status](https://status.bigcommerce.com/). A service is likely down and the request will need to be made again when it is back up. * - * Occurs when the store is down for maintenance, is being upgraded to a new version, or is suspended for administrative or billing reasons. */ + * Occurs when the store is down for maintenance, is being upgraded to a new version, or is suspended for administrative or billing reasons. + */ readonly "503_ServiceUnavailable": { headers: { readonly [name: string]: unknown; @@ -536,12 +538,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -556,11 +560,13 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 422, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -636,12 +642,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -656,11 +664,13 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 422, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; diff --git a/src/internal/reference/generated/sites.v3.ts b/src/internal/reference/generated/sites.v3.ts index cc6db6d..3cf887c 100644 --- a/src/internal/reference/generated/sites.v3.ts +++ b/src/internal/reference/generated/sites.v3.ts @@ -108,7 +108,6 @@ export interface paths { /** * Update a Site Route * @description Update a site’s route. - * */ readonly put: operations["updateSiteRoute"]; /** @@ -265,35 +264,25 @@ export interface components { /** * _pagination * @description Data about the response, including pagination and collection totals. - * */ readonly _pagination: { - /** @description Total number of items in the result set. - * */ + /** @description Total number of items in the result set. */ readonly total?: number; - /** @description Total number of items in the collection response. - * */ + /** @description Total number of items in the collection response. */ readonly count?: number; - /** @description The amount of items returned in the collection per page, controlled by the limit parameter. - * */ + /** @description The amount of items returned in the collection per page, controlled by the limit parameter. */ readonly per_page?: number; - /** @description The page you are currently on within the collection. - * */ + /** @description The page you are currently on within the collection. */ readonly current_page?: number; - /** @description The total number of pages in the collection. - * */ + /** @description The total number of pages in the collection. */ readonly total_pages?: number; - /** @description Pagination links for the previous and next parts of the whole collection. - * */ + /** @description Pagination links for the previous and next parts of the whole collection. */ readonly links?: { - /** @description Link to the previous page returned in the response. - * */ + /** @description Link to the previous page returned in the response. */ readonly previous?: string; - /** @description Link to the current page returned in the response. - * */ + /** @description Link to the current page returned in the response. */ readonly current?: string; - /** @description Link to the next page returned in the response. - * */ + /** @description Link to the next page returned in the response. */ readonly next?: string; }; }; @@ -310,11 +299,9 @@ export interface components { }; /** error_Full */ readonly error_Full: { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -504,17 +491,14 @@ export interface components { readonly ErrorResponse: components["schemas"]["BaseError"] & { readonly errors?: components["schemas"]["DetailedErrors"]; }; - /** @description Error payload for the BigCommerce API. - * */ + /** @description Error payload for the BigCommerce API. */ readonly BaseError: { /** * @description The HTTP status code. - * * @example 404 */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; @@ -573,8 +557,10 @@ export interface components { readonly "application/json": components["schemas"]["error_Full"]; }; }; - /** @description Malformed request syntax. Typically need to fix the JSON - * request body to resend successfully. */ + /** + * @description Malformed request syntax. Typically need to fix the JSON + * request body to resend successfully. + */ readonly "400_BadRequest": { headers: { readonly [name: string]: unknown; diff --git a/src/internal/reference/generated/store_content.v2.ts b/src/internal/reference/generated/store_content.v2.ts index a08313a..11af495 100644 --- a/src/internal/reference/generated/store_content.v2.ts +++ b/src/internal/reference/generated/store_content.v2.ts @@ -126,7 +126,6 @@ export interface paths { * > **Deprecated** * > * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version. * > * To get one or more pages, use Pages V3ʼs [Get pages](/docs/rest-content/pages#get-pages) endpoint. To get a single page, use Pages V3ʼs [Get a page](/docs/rest-content/pages#get-a-page) endpoint. - * */ readonly get: operations["getPages"]; /** @@ -176,7 +175,6 @@ export interface paths { * > **Deprecated** * > * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version. * > * To get a single page, use Pages V3ʼs [Get a page](/docs/rest-content/pages#get-a-page) endpoint. - * */ readonly get: operations["getPage"]; /** @@ -204,7 +202,6 @@ export interface paths { * > **Deprecated** * > * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version. * > * To delete multiple pages, use Pages V3ʼs [Delete pages](/docs/rest-content/pages#delete-pages) endpoint. To delete a single page, use Pages V3ʼs [Delete a page](/docs/rest-content/pages#delete-a-page) endpoint. - * */ readonly delete: operations["deletePage"]; }; @@ -494,7 +491,6 @@ export interface components { /** * Format: date-time * @description Date on which the customer updated their details in the storefront or was updated in the control panel. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request. - * */ readonly date_modified?: string; /** @@ -518,7 +514,6 @@ export interface components { readonly tax_exempt_category?: string; /** * @description Records whether the customer would like to receive marketing content from this store. READ-ONLY.This is a READ-ONLY field; do not set or modify its value in a POST or PUT request. - * * @example true */ readonly accepts_marketing?: boolean; @@ -547,7 +542,6 @@ export interface components { readonly timeZone: { /** * @description A string identifying the time zone, in the format: `/`. - * * @example America/Chicago */ readonly name?: string; @@ -600,11 +594,13 @@ export interface components { readonly blogTags: readonly { /** @example Blog */ readonly tag?: string; - /** @example [ + /** + * @example [ * 1, * 2, * 4 - * ] */ + * ] + */ readonly post_ids?: readonly number[]; }[]; /** @@ -873,7 +869,6 @@ export interface components { * @description `page`: free-text page * `link`: link to another web address * `contact_form`: When the store’s contact form is used - * * @enum {string} */ readonly type: "page" | "contact_form" | "raw" | "link"; @@ -974,7 +969,6 @@ export interface components { * @description `page`: free-text page * `link`: link to another web address * `contact_form`: When the store’s contact form is used - * * @enum {string} */ readonly type?: "page" | "contact_form" | "raw" | "link"; @@ -1094,7 +1088,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example [ + /** + * @example [ * { * "id": 3, * "title": "Hello Again", @@ -1168,7 +1163,8 @@ export interface operations { * "author": "", * "thumbnail_path": "" * } - * ] */ + * ] + */ readonly "application/json": readonly components["schemas"]["blogPost_Full"][]; }; }; @@ -1197,7 +1193,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "id": 3, * "title": "Welcome to BigCommerce", * "url": "/blog/welcome-bigcommerce/", @@ -1220,7 +1217,8 @@ export interface operations { * "meta_keywords": "BigCommerce, welcome, ecommerce", * "author": "BigCommerce", * "thumbnail_path": "" - * } */ + * } + */ readonly "application/json": components["schemas"]["blogPost_Base_Res"]; }; }; @@ -1282,7 +1280,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "id": 3, * "title": "Welcome to BigCommerce", * "url": "/blog/welcome-bigcommerce/", @@ -1305,7 +1304,8 @@ export interface operations { * "meta_keywords": "BigCommerce, welcome, ecommerce", * "author": "BigCommerce", * "thumbnail_path": "" - * } */ + * } + */ readonly "application/json": components["schemas"]["blogPost_Full"]; }; }; @@ -1337,7 +1337,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "id": 3, * "title": "Welcome to BigCommerce", * "url": "/blog/welcome-bigcommerce/", @@ -1360,7 +1361,8 @@ export interface operations { * "meta_keywords": "BigCommerce, welcome, ecommerce", * "author": "BigCommerce", * "thumbnail_path": "" - * } */ + * } + */ readonly "application/json": components["schemas"]["blogPost_Base_Res"]; }; }; @@ -1417,9 +1419,11 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "count": 27 - * } */ + * } + */ readonly "application/json": components["schemas"]["count_Response"]; }; }; @@ -1447,7 +1451,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example [ + /** + * @example [ * { * "id": 6, * "channel_id": 11, @@ -1470,7 +1475,8 @@ export interface operations { * "mobile_body": "", * "url": "/contact-us/" * } - * ] */ + * ] + */ readonly "application/json": readonly components["schemas"]["page_Full"][]; }; }; @@ -1490,7 +1496,8 @@ export interface operations { }; readonly requestBody: { readonly content: { - /** @example { + /** + * @example { * "channel_id": 1, * "name": "Contact Form", * "meta_title": "string", @@ -1508,7 +1515,8 @@ export interface operations { * "has_mobile_version": false, * "mobile_body": "0", * "url": "/contact-us/" - * } */ + * } + */ readonly "application/json": components["schemas"]["page_Base"]; }; }; @@ -1518,7 +1526,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "id": 6, * "channel_id": 11, * "name": "Contact Form", @@ -1537,7 +1546,8 @@ export interface operations { * "has_mobile_version": false, * "mobile_body": "", * "url": "/contact-us/" - * } */ + * } + */ readonly "application/json": components["schemas"]["page_Full"]; }; }; @@ -1574,7 +1584,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "id": 6, * "channel_id": 11, * "name": "Contact Form", @@ -1593,7 +1604,8 @@ export interface operations { * "has_mobile_version": false, * "mobile_body": "", * "url": "/contact-us/" - * } */ + * } + */ readonly "application/json": components["schemas"]["page_Full"]; }; }; @@ -1625,7 +1637,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "id": 2, * "channel_id": 11, * "name": "Shipping & Returns", @@ -1645,7 +1658,8 @@ export interface operations { * "link": "", * "mobile_body": "", * "url": "/shipping-returns/" - * } */ + * } + */ readonly "application/json": components["schemas"]["page_Full"]; }; }; @@ -1737,7 +1751,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "id": 3, * "path": "/mens_clothing", * "forward": { @@ -1745,7 +1760,8 @@ export interface operations { * "ref": 3 * }, * "url": "http://store.example.com/mens" - * } */ + * } + */ readonly "application/json": components["schemas"]["redirect"]; }; }; @@ -1791,7 +1807,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "id": 1, * "path": "/smith-journal-13/", * "forward": { @@ -1799,7 +1816,8 @@ export interface operations { * "ref": 111 * }, * "url": "http://store-store_hash.mybigcommerce.com/towels/bath-towels/hand-towels/" - * } */ + * } + */ readonly "application/json": components["schemas"]["redirect"]; }; }; @@ -1836,7 +1854,6 @@ export interface operations { readonly forward: { /** * @description The type of redirect. If it is a manual redirect then type will always be manual. Dynamic redirects will have the type of the page. Such as product or category. - * * @example product */ readonly type?: string; @@ -1860,7 +1877,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "id": 1, * "path": "/smith-journal-13/", * "forward": { @@ -1868,7 +1886,8 @@ export interface operations { * "ref": 111 * }, * "url": "http://store-store_hash.mybigcommerce.com/towels/bath-towels/hand-towels/" - * } */ + * } + */ readonly "application/json": components["schemas"]["redirect"]; }; }; @@ -1914,9 +1933,11 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "count": 27 - * } */ + * } + */ readonly "application/json": components["schemas"]["count_Response"]; }; }; diff --git a/src/internal/reference/generated/store_information.v2.ts b/src/internal/reference/generated/store_information.v2.ts index 7f7d1c0..c879878 100644 --- a/src/internal/reference/generated/store_information.v2.ts +++ b/src/internal/reference/generated/store_information.v2.ts @@ -51,8 +51,7 @@ export interface paths { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Metafield`. - * */ + /** @description The ID of the `Metafield`. */ readonly metafieldId: components["parameters"]["MetafieldIdParam"]; }; readonly cookie?: never; @@ -65,13 +64,11 @@ export interface paths { /** * Update a Store Metafield * @description Update a store `Metafield`. - * */ readonly put: operations["updateStoreMetafield"]; /** * Delete a Metafield * @description Deletes a store `Metafield`. - * */ readonly delete: operations["deleteStoreMetafield"]; }; @@ -98,7 +95,6 @@ export interface components { readonly NotFound: { /** * @description 404 HTTP status code. - * * @example 404 */ readonly status?: number; @@ -117,14 +113,12 @@ export interface components { readonly instance?: string; readonly errors?: Record; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetafieldResponse: { readonly data?: components["schemas"]["Metafield"]; readonly meta?: components["schemas"]["metaCollection_open"]; }; - /** @description Allows app partners to write custom data to various resources in the API. - * */ + /** @description Allows app partners to write custom data to various resources in the API. */ readonly Metafield: components["schemas"]["MetafieldBase"] & { /** @description The unique identifier for the metafield. */ readonly id?: string; @@ -146,8 +140,7 @@ export interface components { */ readonly owner_client_id?: string; }; - /** @description Common Metafield properties. - * */ + /** @description Common Metafield properties. */ readonly MetafieldBase: { /** * @description Determines the visibility and writeability of the field by other API consumers. @@ -159,50 +152,42 @@ export interface components { * | `write` | Open for reading and writing by other API consumers. | * | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | * | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | - * * @enum {string} */ readonly permission_set: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; /** * @description Namespace for the metafield, for organizational purposes. - * * @example Sales Department */ readonly namespace?: string; /** * @description The name of the field, for example: `location_id`, `color`. - * * @example Staff Name */ readonly key?: string; /** * @description The value of the field, for example: `1`, `blue`. - * * @example Ronaldo */ readonly value?: string; /** * @description Description for the metafields. - * * @example order */ readonly description?: string; /** * @description The type of resource with which the metafield is associated. - * * @example store * @enum {string} */ readonly resource_type?: "brand" | "product" | "variant" | "category" | "cart" | "store"; /** * @description The unique identifier for the resource with which the metafield is associated. - * * @example 0 */ readonly resource_id?: string; }; - /** @description Common Metafield properties. - * */ + /** @description Common Metafield properties. */ readonly MetafieldBase_Post_Put: { /** * @description Determines the visibility and writeability of the field by other API consumers. @@ -214,49 +199,41 @@ export interface components { * | `write` | Open for reading and writing by other API consumers. | * | `read_and_sf_access` | Visible to other API consumers, including on the storefront. | * | `write_and_sf_access` | Open for reading and writing by other API consumers, including on the storefront. | - * * @enum {string} */ readonly permission_set: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access"; /** * @description Namespace for the metafield, for organizational purposes. - * * @example Sales Department */ readonly namespace: string; /** * @description The name of the field, for example: `location_id`, `color`. - * * @example Staff Name */ readonly key: string; /** * @description The value of the field, for example: `1`, `blue`. - * * @example Ronaldo */ readonly value: string; /** * @description Description for the metafields. - * * @example Name of Staff Member */ readonly description?: string; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponse: { readonly data?: components["schemas"]["Metafield"]; readonly meta?: components["schemas"]["metaCollection_open"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponse_Batch: { readonly data?: readonly components["schemas"]["Metafield"][]; readonly meta?: components["schemas"]["CollectionMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponse_Batch_POST_PUT: { readonly data?: readonly components["schemas"]["Metafield"][]; /** @@ -266,14 +243,15 @@ export interface components { readonly errors?: readonly unknown[]; readonly meta?: components["schemas"]["WriteCollectionSuccessMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionDeleteResponseSuccess: { - /** @example [ + /** + * @example [ * 123, * 124, * 125 - * ] */ + * ] + */ readonly data?: readonly number[]; /** * @description Empty for 200 responses. @@ -282,8 +260,7 @@ export interface components { readonly errors?: readonly unknown[]; readonly meta?: components["schemas"]["WriteCollectionSuccessMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponsePartialSuccess_POST_PUT: { /** * @description Empty for 200 responses. @@ -293,34 +270,31 @@ export interface components { readonly errors?: components["schemas"]["Error"]; readonly meta?: components["schemas"]["WriteCollectionPartialSuccessMeta"]; }; - /** @description Response payload for the BigCommerce API. - * */ + /** @description Response payload for the BigCommerce API. */ readonly MetaFieldCollectionResponsePartialSuccess_DELETE: { - /** @example [ + /** + * @example [ * 123 - * ] */ + * ] + */ readonly data?: readonly number[]; readonly errors?: readonly components["schemas"]["Error"][]; readonly meta?: components["schemas"]["WriteCollectionPartialSuccessMeta"]; }; - /** @description Error response payload for the BigCommerce API. - * */ + /** @description Error response payload for the BigCommerce API. */ readonly Error: { /** * @description The HTTP status code for the error. - * * @example 422 */ readonly status?: number; /** * @description The error title. - * * @example Bulk operation has failed */ readonly title?: string; /** * @description The error type. - * * @example https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes */ readonly type?: string; @@ -328,7 +302,6 @@ export interface components { }; /** * @description Error detail response payload for the BigCommerce API. - * * @example { * "0": "Entity already exists", * "1": "Unauthorized to delete", @@ -345,19 +318,16 @@ export interface components { readonly WriteCollectionSuccessMeta: { /** * @description Total number of items in the result set. - * * @example 3 */ readonly total?: number; /** * @description Total number of items that were successfully deleted. - * * @example 3 */ readonly success?: number; /** * @description Total number of items that failed to be deleted. - * * @example 0 */ readonly failed?: number; @@ -369,19 +339,16 @@ export interface components { readonly WriteCollectionPartialSuccessMeta: { /** * @description Total number of items in the result set. - * * @example 3 */ readonly total?: number; /** * @description Total number of items that were successfully deleted. - * * @example 1 */ readonly success?: number; /** * @description Total number of items that failed to be deleted. - * * @example 2 */ readonly failed?: number; @@ -398,48 +365,39 @@ export interface components { readonly pagination?: { /** * @description Total number of items in the result set. - * * @example 36 */ readonly total?: number; /** * @description Total number of items in the collection response. - * * @example 36 */ readonly count?: number; /** * @description The amount of items returned in the collection per page, controlled by the limit parameter. - * * @example 50 */ readonly per_page?: number; /** * @description The page you are currently on within the collection. - * * @example 1 */ readonly current_page?: number; /** * @description The total number of pages in the collection. - * * @example 1 */ readonly total_pages?: number; - /** @description Pagination links for the previous and next parts of the whole collection. - * */ + /** @description Pagination links for the previous and next parts of the whole collection. */ readonly links?: { - /** @description Link to the previous page returned in the response. - * */ + /** @description Link to the previous page returned in the response. */ readonly previous?: string; /** * @description Link to the current page returned in the response. - * * @example ?page=1&limit=50 */ readonly current?: string; - /** @description Link to the next page returned in the response. - * */ + /** @description Link to the next page returned in the response. */ readonly next?: string; }; }; @@ -744,11 +702,9 @@ export interface components { responses: never; parameters: { readonly ContentType: string; - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly PageParam: number; - /** @description The ID of the `Metafield`. - * */ + /** @description The ID of the `Metafield`. */ readonly MetafieldIdParam: number; /** @description Filter based on a metafieldʼs key. */ readonly MetafieldKeyParam: string; @@ -758,11 +714,9 @@ export interface components { readonly MetafieldNamespaceParam: string; /** @description Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter */ readonly MetafieldNamespaceInParam: readonly string[]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly LimitParam: number; - /** @description Sort direction. Acceptable values are: `asc`, `desc`. - * */ + /** @description Sort direction. Acceptable values are: `asc`, `desc`. */ readonly DirectionParam: "asc" | "desc"; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept: string; @@ -798,11 +752,9 @@ export interface operations { readonly getStoreMetafields: { readonly parameters: { readonly query?: { - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; /** @description Filter based on a metafieldʼs key. */ readonly key?: components["parameters"]["MetafieldKeyParam"]; @@ -812,8 +764,7 @@ export interface operations { readonly namespace?: components["parameters"]["MetafieldNamespaceParam"]; /** @description Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter */ readonly "namespace:in"?: components["parameters"]["MetafieldNamespaceInParam"]; - /** @description Sort direction. Acceptable values are: `asc`, `desc`. - * */ + /** @description Sort direction. Acceptable values are: `asc`, `desc`. */ readonly direction?: components["parameters"]["DirectionParam"]; }; readonly header?: never; @@ -822,8 +773,7 @@ export interface operations { }; readonly requestBody?: never; readonly responses: { - /** @description List of `Metafield` objects. - * */ + /** @description List of `Metafield` objects. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -846,7 +796,6 @@ export interface operations { readonly "application/json": readonly (components["schemas"]["MetafieldBase_Post_Put"] & { /** * @description The ID of metafield to update. - * * @example 42 */ readonly id: number; @@ -869,12 +818,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "status": 400, * "title": "Input is invalid", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes", * "detail": "Syntax error" - * } */ + * } + */ readonly "application/json": { readonly status?: number; readonly title?: string; @@ -883,8 +834,7 @@ export interface operations { }; }; }; - /** @description Response object for metafields creation with partial success. - * */ + /** @description Response object for metafields creation with partial success. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -909,8 +859,7 @@ export interface operations { }; }; readonly responses: { - /** @description List of created `Metafield` objects. - * */ + /** @description List of created `Metafield` objects. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -919,8 +868,7 @@ export interface operations { readonly "application/json": components["schemas"]["MetaFieldCollectionResponse_Batch_POST_PUT"]; }; }; - /** @description Response object for metafields creation with partial success. - * */ + /** @description Response object for metafields creation with partial success. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -941,16 +889,17 @@ export interface operations { /** @description Metafields ID list. */ readonly requestBody?: { readonly content: { - /** @example [ + /** + * @example [ * 69, * 70 - * ] */ + * ] + */ readonly "application/json": readonly number[]; }; }; readonly responses: { - /** @description Response object for metafields deletion with success. - * */ + /** @description Response object for metafields deletion with success. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -969,16 +918,14 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Metafield`. - * */ + /** @description The ID of the `Metafield`. */ readonly metafieldId: components["parameters"]["MetafieldIdParam"]; }; readonly cookie?: never; }; readonly requestBody?: never; readonly responses: { - /** @description A `Metafield` object. - * */ + /** @description A `Metafield` object. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -987,8 +934,7 @@ export interface operations { readonly "application/json": components["schemas"]["MetafieldResponse"]; }; }; - /** @description Not found (A metafield was not found with this query). - * */ + /** @description Not found (A metafield was not found with this query). */ readonly 404: { headers: { readonly [name: string]: unknown; @@ -1008,22 +954,19 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Metafield`. - * */ + /** @description The ID of the `Metafield`. */ readonly metafieldId: components["parameters"]["MetafieldIdParam"]; }; readonly cookie?: never; }; - /** @description A `Metafield` object. - * */ + /** @description A `Metafield` object. */ readonly requestBody?: { readonly content: { readonly "application/json": components["schemas"]["MetafieldBase_Post_Put"]; }; }; readonly responses: { - /** @description A metafield and metadata. - * */ + /** @description A metafield and metadata. */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -1032,20 +975,21 @@ export interface operations { readonly "application/json": components["schemas"]["MetaFieldCollectionResponse"]; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "value": { * "status": 404, * "title": "There was no metafield found with ID 1010", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes" * } - * } */ + * } + */ readonly "application/json": components["schemas"]["NotFound"]; }; }; @@ -1059,24 +1003,21 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Metafield`. - * */ + /** @description The ID of the `Metafield`. */ readonly metafieldId: components["parameters"]["MetafieldIdParam"]; }; readonly cookie?: never; }; readonly requestBody?: never; readonly responses: { - /** @description An empty response. - * */ + /** @description An empty response. */ readonly 204: { headers: { readonly [name: string]: unknown; }; content?: never; }; - /** @description Not found (A metafield was not found with this query). - * */ + /** @description Not found (A metafield was not found with this query). */ readonly 404: { headers: { readonly [name: string]: unknown; diff --git a/src/internal/reference/generated/store_logs.v3.ts b/src/internal/reference/generated/store_logs.v3.ts index 03f4835..29a1c33 100644 --- a/src/internal/reference/generated/store_logs.v3.ts +++ b/src/internal/reference/generated/store_logs.v3.ts @@ -46,14 +46,11 @@ export interface components { readonly ErrorResponse: components["schemas"]["BaseError"] & { readonly errors?: components["schemas"]["DetailedErrors"]; }; - /** @description Error payload for the BigCommerce API. - * */ + /** @description Error payload for the BigCommerce API. */ readonly BaseError: { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The title of the message describing the particular error. - * */ + /** @description The title of the message describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; @@ -104,6 +101,10 @@ export interface operations { readonly "severity:max"?: number; /** @description A comma-separated list of log IDs by which to filter. For example, `?id:in=3,4,6`. */ readonly "id:in"?: readonly number[]; + /** @description The log key by which to sort results. If left blank, results will be reported in order of creation. This parameter is case-sensitive. */ + readonly sort?: "date_created" | "type"; + /** @description The direction in which to sort results. Defaults to ascending (`asc`). This parameter is case-sensitive. */ + readonly direction?: "asc" | "desc"; }; readonly header?: never; readonly path?: never; diff --git a/src/internal/reference/generated/storefront_tokens.v3.ts b/src/internal/reference/generated/storefront_tokens.v3.ts index cc591c7..65a07a0 100644 --- a/src/internal/reference/generated/storefront_tokens.v3.ts +++ b/src/internal/reference/generated/storefront_tokens.v3.ts @@ -20,6 +20,8 @@ export interface paths { * * **Required Scopes** * * `Manage` `Storefront API Tokens` + * + * > NOTE: While neither `channel_id` nor `channel_ids` is labelled as required, one must be included in the request body. Including neither will throw an error, and including both will result in unexpected behaviors. */ readonly post: operations["createToken"]; /** @@ -44,6 +46,8 @@ export interface paths { * * **Required Scopes** * * `Manage` `Storefront API Customer Impersonation Tokens` + * + * > NOTE: While neither `channel_id` nor `channel_ids` is labelled as required, one must be included in the request body. Including neither will throw an error, and including both will result in unexpected behaviors. */ readonly post: operations["createTokenWithCustomerImpersonation"]; }; @@ -57,7 +61,7 @@ export interface components { * @example 1885635176 */ readonly expires_at: number; - } & (components["schemas"]["Channels"] | components["schemas"]["Channel"]); + } & components["schemas"]["Channels"] & components["schemas"]["Channel"]; readonly TokenPostSimple: { /** @description List of allowed domains for Cross-Origin Request Sharing. Currently accepts a maximum of two domains per created token. */ readonly allowed_cors_origins?: readonly string[]; @@ -79,7 +83,7 @@ export interface components { * @description Channel ID that is valid for the requested token. Use this field to enter a channel ID. Do not use this field if you have more than one channel. We support this field for backwards compatibility, but `channel_ids` is preferred. You can not use both `channel_id` and `channel_ids` in your request. * @example 1 */ - readonly channel_id: number; + readonly channel_id?: number; }; /** channel_ids */ readonly Channels: { @@ -90,19 +94,16 @@ export interface components { * 1 * ] */ - readonly channel_ids: readonly number[]; + readonly channel_ids?: readonly number[]; }; readonly ErrorResponse: components["schemas"]["BaseError"] & { readonly errors?: components["schemas"]["DetailedErrors"]; }; - /** @description Error payload for the BigCommerce API. - * */ + /** @description Error payload for the BigCommerce API. */ readonly BaseError: { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -146,13 +147,6 @@ export interface operations { }; readonly requestBody?: { readonly content: { - /** @example { - * "allowed_cors_origins": [ - * "https://www.yourstorefront.com" - * ], - * "channel_id": 1, - * "expires_at": 1885635176 - * } */ readonly "application/json": components["schemas"]["TokenPostSimple"] & components["schemas"]["TokenPostImpersonation"]; }; }; diff --git a/src/internal/reference/generated/subscribers.v3.ts b/src/internal/reference/generated/subscribers.v3.ts index eec3d12..68bc47f 100644 --- a/src/internal/reference/generated/subscribers.v3.ts +++ b/src/internal/reference/generated/subscribers.v3.ts @@ -79,13 +79,11 @@ export interface components { /** * Format: date-time * @description The date on which the subscriber was modified. - * */ readonly date_modified?: string; /** * Format: date-time * @description The date of which the subscriber was created. - * */ readonly date_created?: string; /** @@ -101,20 +99,15 @@ export interface components { * @description Common Subscriber properties. */ readonly subscriber_Base: { - /** @description The email of the subscriber. Must be unique. - * */ + /** @description The email of the subscriber. Must be unique. */ readonly email?: string; - /** @description The first name of the subscriber. - * */ + /** @description The first name of the subscriber. */ readonly first_name?: string; - /** @description The last name of the subscriber. - * */ + /** @description The last name of the subscriber. */ readonly last_name?: string; - /** @description The source of the subscriber. Values are: `storefront`, `order`, or `custom`. - * */ + /** @description The source of the subscriber. Values are: `storefront`, `order`, or `custom`. */ readonly source?: string; - /** @description The ID of the source order, if source was an order. - * */ + /** @description The ID of the source order, if source was an order. */ readonly order_id?: number | null; /** @description The channel ID where the subscriber was created. */ readonly channel_id?: number; @@ -127,48 +120,38 @@ export interface components { readonly consents?: readonly ("marketing_newsletter" | "abandoned_cart")[]; }; readonly Subscriber: { - /** @description The unique numeric ID of the subscriber; increments sequentially. - * */ + /** @description The unique numeric ID of the subscriber; increments sequentially. */ readonly id?: number; - /** @description The email of the subscriber. Must be unique. - * */ + /** @description The email of the subscriber. Must be unique. */ readonly email?: string; - /** @description The first name of the subscriber. - * */ + /** @description The first name of the subscriber. */ readonly first_name?: string; - /** @description The last name of the subscriber. - * */ + /** @description The last name of the subscriber. */ readonly last_name?: string; - /** @description The source of the subscriber. Values are: `storefront`, `order`, or `custom`. - * */ + /** @description The source of the subscriber. Values are: `storefront`, `order`, or `custom`. */ readonly source?: string; - /** @description The ID of the source order, if source was an order. - * */ + /** @description The ID of the source order, if source was an order. */ readonly order_id?: number | null; } & { /** * Format: date-time * @description The date on which the subscriber was modified. - * */ readonly date_modified?: string; /** * Format: date-time * @description The date of which the subscriber was created. - * */ readonly date_created?: string; }; /** * subscriber_Post * @description The model for a POST to create a subscriber. - * */ readonly subscriber_Post: components["schemas"]["subscriber_Base"]; /** * subscriber_Put * @description The model for a PUT to update a subscriber. - * */ readonly subscriber_Put: components["schemas"]["subscriber_Base"]; /** @@ -183,48 +166,39 @@ export interface components { readonly pagination?: { /** * @description Total number of items in the result set. - * * @example 36 */ readonly total?: number; /** * @description Total number of items in the collection response. - * * @example 36 */ readonly count?: number; /** * @description The amount of items returned in the collection per page, controlled by the limit parameter. - * * @example 50 */ readonly per_page?: number; /** * @description The page you are currently on within the collection. - * * @example 1 */ readonly current_page?: number; /** * @description The total number of pages in the collection. - * * @example 1 */ readonly total_pages?: number; - /** @description Pagination links for the previous and next parts of the whole collection. - * */ + /** @description Pagination links for the previous and next parts of the whole collection. */ readonly links?: { - /** @description Link to the previous page returned in the response. - * */ + /** @description Link to the previous page returned in the response. */ readonly previous?: string; /** * @description Link to the current page returned in the response. - * * @example ?page=1&limit=50 */ readonly current?: string; - /** @description Link to the next page returned in the response. - * */ + /** @description Link to the next page returned in the response. */ readonly next?: string; }; }; @@ -236,48 +210,39 @@ export interface components { readonly Pagination: { /** * @description Total number of items in the result set. - * * @example 36 */ readonly total?: number; /** * @description Total number of items in the collection response. - * * @example 36 */ readonly count?: number; /** * @description The amount of items returned in the collection per page, controlled by the limit parameter. - * * @example 50 */ readonly per_page?: number; /** * @description The page you are currently on within the collection. - * * @example 1 */ readonly current_page?: number; /** * @description The total number of pages in the collection. - * * @example 1 */ readonly total_pages?: number; - /** @description Pagination links for the previous and next parts of the whole collection. - * */ + /** @description Pagination links for the previous and next parts of the whole collection. */ readonly links?: { - /** @description Link to the previous page returned in the response. - * */ + /** @description Link to the previous page returned in the response. */ readonly previous?: string; /** * @description Link to the current page returned in the response. - * * @example ?page=1&limit=50 */ readonly current?: string; - /** @description Link to the next page returned in the response. - * */ + /** @description Link to the next page returned in the response. */ readonly next?: string; }; }; @@ -290,11 +255,9 @@ export interface components { }; /** Error Response */ readonly ErrorResponse: { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; @@ -307,14 +270,11 @@ export interface components { /** * Base Error * @description Error payload for the BigCommerce API. - * */ readonly BaseError: { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; @@ -324,8 +284,7 @@ export interface components { * @description Error payload for the BigCommerce API. */ readonly NotFound: { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -362,20 +321,15 @@ export interface components { }; }; parameters: { - /** @description Filter items by email. - * */ + /** @description Filter items by email. */ readonly FilterEmailParam: string; - /** @description Filter items by first_name. - * */ + /** @description Filter items by first_name. */ readonly FilterFirstNameParam: string; - /** @description Filter items by last_name. - * */ + /** @description Filter items by last_name. */ readonly FilterLastNameParam: string; - /** @description Filter items by source. - * */ + /** @description Filter items by source. */ readonly FilterSourceParam: string; - /** @description Filter items by order_id. - * */ + /** @description Filter items by order_id. */ readonly FilterOrderIdParam: number; /** @description Filter items by date_modified. For example `v3/catalog/products?date_last_imported:min=2018-06-15` */ readonly FilterDateModifiedParam: string; @@ -383,8 +337,7 @@ export interface components { readonly FilterDateModifiedMinParam: string; /** @description Filter items by maximum date modified, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date. */ readonly FilterDateModifiedMaxParam: string; - /** @description Filter items by date_created. - * */ + /** @description Filter items by date_created. */ readonly FilterDateCreatedParam: string; /** @description Filter items by minimum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date. */ readonly FilterDateCreatedMinParam: string; @@ -394,21 +347,18 @@ export interface components { readonly PageParam: number; /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly LimitParam: number; - /** @description Scripts field name to sort by. - * */ + /** @description Scripts field name to sort by. */ readonly ScriptsSortKeyParam: "name" | "description" | "date_created" | "date_modified"; - /** @description Sort direction. Acceptable values are: `asc`, `desc`. - * */ + /** @description Sort direction. Acceptable values are: `asc`, `desc`. */ readonly DirectionParam: "asc" | "desc"; - /** @description Filter items by ID. - * */ + /** @description Filter items by ID. */ readonly IdParam: number; - /** @description Filter items by ID. + /** + * @description Filter items by ID. * `id:in=4,5,6` - * */ + */ readonly IdInParam: readonly number[]; - /** @description The ID of the subscriber requested. - * */ + /** @description The ID of the subscriber requested. */ readonly SubscriberIdParam: number; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept: string; @@ -424,23 +374,17 @@ export interface operations { readonly getSubscribers: { readonly parameters: { readonly query: { - /** @description Filter items by email. - * */ + /** @description Filter items by email. */ readonly email?: components["parameters"]["FilterEmailParam"]; - /** @description Filter items by first_name. - * */ + /** @description Filter items by first_name. */ readonly first_name?: components["parameters"]["FilterFirstNameParam"]; - /** @description Filter items by last_name. - * */ + /** @description Filter items by last_name. */ readonly last_name?: components["parameters"]["FilterLastNameParam"]; - /** @description Filter items by source. - * */ + /** @description Filter items by source. */ readonly source?: components["parameters"]["FilterSourceParam"]; - /** @description Filter items by order_id. - * */ + /** @description Filter items by order_id. */ readonly order_id?: components["parameters"]["FilterOrderIdParam"]; - /** @description Filter items by date_created. - * */ + /** @description Filter items by date_created. */ readonly date_created?: components["parameters"]["FilterDateCreatedParam"]; /** @description Filter items by minimum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date. */ readonly "date_created:min"?: components["parameters"]["FilterDateCreatedMinParam"]; @@ -456,12 +400,12 @@ export interface operations { readonly page?: components["parameters"]["PageParam"]; /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; - /** @description Filter items by ID. - * */ + /** @description Filter items by ID. */ readonly id: components["parameters"]["IdParam"]; - /** @description Filter items by ID. + /** + * @description Filter items by ID. * `id:in=4,5,6` - * */ + */ readonly "id:in"?: components["parameters"]["IdInParam"]; }; readonly header?: { @@ -515,8 +459,7 @@ export interface operations { }; }; }; - /** @description The `Subscriber` was in conflict with another subscriber. This is the result of duplicate unique values, such as email. - * */ + /** @description The `Subscriber` was in conflict with another subscriber. This is the result of duplicate unique values, such as email. */ readonly 409: { headers: { readonly [name: string]: unknown; @@ -528,18 +471,15 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; }; }; - /** @description The `Subscriber` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description The `Subscriber` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -551,11 +491,9 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -566,23 +504,17 @@ export interface operations { readonly deleteSubscribers: { readonly parameters: { readonly query?: { - /** @description Filter items by email. - * */ + /** @description Filter items by email. */ readonly email?: components["parameters"]["FilterEmailParam"]; - /** @description Filter items by first_name. - * */ + /** @description Filter items by first_name. */ readonly first_name?: components["parameters"]["FilterFirstNameParam"]; - /** @description Filter items by last_name. - * */ + /** @description Filter items by last_name. */ readonly last_name?: components["parameters"]["FilterLastNameParam"]; - /** @description Filter items by source. - * */ + /** @description Filter items by source. */ readonly source?: components["parameters"]["FilterSourceParam"]; - /** @description Filter items by order_id. - * */ + /** @description Filter items by order_id. */ readonly order_id?: components["parameters"]["FilterOrderIdParam"]; - /** @description Filter items by date_created. - * */ + /** @description Filter items by date_created. */ readonly date_created?: components["parameters"]["FilterDateCreatedParam"]; /** @description Filter items by date_modified. For example `v3/catalog/products?date_last_imported:min=2018-06-15` */ readonly date_modified?: components["parameters"]["FilterDateModifiedParam"]; @@ -612,8 +544,7 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Subscriber` requested. - * */ + /** @description The ID of the `Subscriber` requested. */ readonly subscriber_id: number; }; readonly cookie?: never; @@ -631,16 +562,14 @@ export interface operations { }; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -661,8 +590,7 @@ export interface operations { readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { - /** @description The ID of the `Subscriber` requested. - * */ + /** @description The ID of the `Subscriber` requested. */ readonly subscriber_id: number; }; readonly cookie?: never; @@ -684,16 +612,14 @@ export interface operations { }; }; }; - /** @description The resource was not found. - * */ + /** @description The resource was not found. */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -702,8 +628,7 @@ export interface operations { }; }; }; - /** @description The `Subscriber` was in conflict with another subscriber. This is the result of duplicate unique values, such as `email`. - * */ + /** @description The `Subscriber` was in conflict with another subscriber. This is the result of duplicate unique values, such as `email`. */ readonly 409: { headers: { readonly [name: string]: unknown; @@ -715,18 +640,15 @@ export interface operations { readonly [key: string]: unknown; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; }; }; - /** @description The `Subscriber` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description The `Subscriber` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -738,11 +660,9 @@ export interface operations { readonly additionalProperties?: string; }; readonly instance?: string; - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; }; @@ -758,8 +678,7 @@ export interface operations { readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { - /** @description The ID of the `Subscriber` requested. - * */ + /** @description The ID of the `Subscriber` requested. */ readonly subscriber_id: number; }; readonly cookie?: never; diff --git a/src/internal/reference/generated/subscriptions.sf.ts b/src/internal/reference/generated/subscriptions.sf.ts index 945c204..f87dcf0 100644 --- a/src/internal/reference/generated/subscriptions.sf.ts +++ b/src/internal/reference/generated/subscriptions.sf.ts @@ -38,26 +38,19 @@ export interface components { }; /** @description Subscription properties. */ readonly Subscription: { - /** @description The unique numeric ID of the subscriber; increments sequentially. - * */ + /** @description The unique numeric ID of the subscriber; increments sequentially. */ readonly id?: number; - /** @description The email of the subscriber. Must be unique. - * */ + /** @description The email of the subscriber. Must be unique. */ readonly email?: string; - /** @description The first name of the subscriber. - * */ + /** @description The first name of the subscriber. */ readonly firstName?: string; - /** @description The last name of the subscriber. - * */ + /** @description The last name of the subscriber. */ readonly lastName?: string; - /** @description The source of the subscriber. Values are: `storefront`, `order`, or `custom`. - * */ + /** @description The source of the subscriber. Values are: `storefront`, `order`, or `custom`. */ readonly source?: string; - /** @description The ID of the source order, if source was an order. - * */ + /** @description The ID of the source order, if source was an order. */ readonly orderId?: number | null; - /** @description The collection of consents the shopper is subscribing to. - * */ + /** @description The collection of consents the shopper is subscribing to. */ readonly consents?: readonly unknown[]; }; }; diff --git a/src/internal/reference/generated/tax.v3.ts b/src/internal/reference/generated/tax.v3.ts index b0f2216..d40702c 100644 --- a/src/internal/reference/generated/tax.v3.ts +++ b/src/internal/reference/generated/tax.v3.ts @@ -23,7 +23,6 @@ export interface paths { * * > #### Note * > * Requires **read** permissions on the **Information and Settings** scope. - * */ readonly get: operations["getTaxProviderConnection"]; /** @@ -47,7 +46,6 @@ export interface paths { * > #### Note * > * This operation will be logged in [Store Logs](https://support.bigcommerce.com/s/article/Using-Store-Logs) under **Staff Actions**. * > * Requires **write** permissions on the **Information and Settings** [scope](/docs/start/authentication/api-accounts#oauth-scopes). - * */ readonly delete: operations["deleteTaxProviderConnection"]; }; @@ -60,9 +58,11 @@ export interface components { readonly data?: { /** @description Identifies a unique account on the external tax provider infrastructure. May be used to reconcile the two platforms. */ readonly username?: string; - /** @description Describes whether the stored credentials are considered complete and configured, ready to be used for Tax Provider API requests. + /** + * @description Describes whether the stored credentials are considered complete and configured, ready to be used for Tax Provider API requests. * - * Merchants may enable any **configured** tax provider for storefront tax quotation. */ + * Merchants may enable any **configured** tax provider for storefront tax quotation. + */ readonly configured?: boolean; /** @description The countries and subdivisions in which this tax provider connection is active. */ readonly target?: { diff --git a/src/internal/reference/generated/tax_classes.v2.ts b/src/internal/reference/generated/tax_classes.v2.ts index a8fb108..99862f4 100644 --- a/src/internal/reference/generated/tax_classes.v2.ts +++ b/src/internal/reference/generated/tax_classes.v2.ts @@ -103,7 +103,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example [ + /** + * @example [ * { * "id": "1", * "name": "Non-Taxable Products", @@ -122,7 +123,8 @@ export interface operations { * "created_at": "1973-01-20T21:34:57.903+00:00", * "updated_at": "1990-12-30T00:29:23.515+00:00" * } - * ] */ + * ] + */ readonly "application/json": readonly components["schemas"]["taxClass_Full"][]; }; }; @@ -148,12 +150,14 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "id": "1", * "name": "Shipping", * "created_at": "1973-01-20T21:34:57.903+00:00", * "updated_at": "1990-12-30T00:29:23.515+00:00" - * } */ + * } + */ readonly "application/json": components["schemas"]["taxClass_Full"]; }; }; diff --git a/src/internal/reference/generated/tax_rates_zones.v3.ts b/src/internal/reference/generated/tax_rates_zones.v3.ts index 2f59807..53c6be4 100644 --- a/src/internal/reference/generated/tax_rates_zones.v3.ts +++ b/src/internal/reference/generated/tax_rates_zones.v3.ts @@ -116,10 +116,12 @@ export interface components { * ] */ readonly subdivision_codes?: readonly string[]; - /** @example [ + /** + * @example [ * "2234", * "2170" - * ] */ + * ] + */ readonly postal_codes?: readonly string[]; }[]; /** @description One or more customer groups that a tax zone targets. Empty array if zone applies to all customers. */ @@ -165,10 +167,12 @@ export interface components { * ] */ readonly subdivision_codes?: readonly string[]; - /** @example [ + /** + * @example [ * "2234", * "2170" - * ] */ + * ] + */ readonly postal_codes?: readonly string[]; }[]; /** @description One or more customer groups that a tax zone targets. Empty array if zone applies to all customers. */ @@ -218,10 +222,12 @@ export interface components { * ] */ readonly subdivision_codes?: readonly string[]; - /** @example [ + /** + * @example [ * "2234", * "2170" - * ] */ + * ] + */ readonly postal_codes?: readonly string[]; }[]; /** @description One or more customer groups that a tax zone targets. Empty array if zone applies to all customers. */ diff --git a/src/internal/reference/generated/tax_zone_check.v3.ts b/src/internal/reference/generated/tax_zone_check.v3.ts index 24c3d79..2063c64 100644 --- a/src/internal/reference/generated/tax_zone_check.v3.ts +++ b/src/internal/reference/generated/tax_zone_check.v3.ts @@ -88,10 +88,12 @@ export interface components { * ] */ readonly subdivision_codes?: readonly string[]; - /** @example [ + /** + * @example [ * "2234", * "2170" - * ] */ + * ] + */ readonly postal_codes?: readonly string[]; }[]; /** @description One or more customer groups that a tax zone targets. Empty array if zone applies to all customers. */ diff --git a/src/internal/reference/generated/themes.v3.ts b/src/internal/reference/generated/themes.v3.ts index df05f1b..b862692 100644 --- a/src/internal/reference/generated/themes.v3.ts +++ b/src/internal/reference/generated/themes.v3.ts @@ -200,11 +200,9 @@ export interface components { }; /** Error Response */ readonly ErrorResponse: { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; @@ -217,14 +215,11 @@ export interface components { /** * Base Error * @description Error payload for the BigCommerce API. - * */ readonly BaseError: { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; @@ -238,8 +233,7 @@ export interface components { * @description Error payload for the BigCommerce API. */ readonly NotFound: { - /** @description 404 HTTP status code. - * */ + /** @description 404 HTTP status code. */ readonly status?: number; /** @description The error title describing the particular error. */ readonly title?: string; @@ -259,8 +253,7 @@ export interface components { * @description No-content response for the BigCommerce API. */ readonly NoContent: { - /** @description 204 HTTP status code. - * */ + /** @description 204 HTTP status code. */ readonly status?: number; /** @description The error title describing the situation. */ readonly title?: string; @@ -356,7 +349,6 @@ export interface components { /** * Themes Collection Response * @description Response payload for the BigCommerce API. - * */ readonly ThemesCollectionResponse: { readonly data?: readonly { @@ -393,7 +385,6 @@ export interface components { /** * Theme Response * @description Response payload for the BigCommerce API. - * */ readonly ThemeResponse: { readonly data?: components["schemas"]["Theme"]; @@ -530,11 +521,9 @@ export interface components { readonly Accept: string; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly ContentType: string; - /** @description Specifies the page number in a limited (paginated) list. - * */ + /** @description Specifies the page number in a limited (paginated) list. */ readonly PageParam: number; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly LimitParam: number; }; requestBodies: never; @@ -605,11 +594,9 @@ export interface operations { }; content: { readonly "application/json": { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; @@ -653,11 +640,9 @@ export interface operations { }; content: { readonly "application/json": { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; @@ -699,11 +684,9 @@ export interface operations { }; content: { readonly "application/json": { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; @@ -754,11 +737,9 @@ export interface operations { }; content: { readonly "application/json": { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; @@ -810,11 +791,9 @@ export interface operations { }; content: { readonly "application/json": { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; @@ -858,11 +837,9 @@ export interface operations { }; content: { readonly "application/json": { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; @@ -885,11 +862,9 @@ export interface operations { readonly variation_uuid?: string; /** @description Filter configurations by passing a comma-separated list of channel IDs. */ readonly "channel_id:in"?: readonly number[]; - /** @description Specifies the page number in a limited (paginated) list. - * */ + /** @description Specifies the page number in a limited (paginated) list. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; }; readonly header?: { diff --git a/src/internal/reference/generated/webhooks.v3.ts b/src/internal/reference/generated/webhooks.v3.ts index 8805d57..e8d3afd 100644 --- a/src/internal/reference/generated/webhooks.v3.ts +++ b/src/internal/reference/generated/webhooks.v3.ts @@ -62,7 +62,6 @@ export interface paths { /** * Upsert Email Notifications * @description Update email addresses that are sent notification emails when any domain associated with the API account is denylisted or when a webhook is deactivated. Supports `upsert` functionality in the case that no email address exists yet. - * */ readonly put: operations["updateHooksAdmin"]; }; @@ -468,7 +467,6 @@ export interface components { /** * store/category/* * @description Fires for all `store/category` events. - * */ readonly store_category_wildcard: unknown; /** @@ -659,7 +657,6 @@ export interface components { /** * store/customer/* * @description Fires for all `store/customer` events. - * */ readonly store_customer_wildcard: unknown; /** @@ -2045,22 +2042,18 @@ export interface components { }; /** error_Full */ readonly error_Full: { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; /** @description This value is typically a link to BigCommerce API Status codes. */ readonly type?: string; }; /** errorDetailed_Full */ readonly errorDetailed_Full: { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; /** @description Typically a link to BigCommerce API Status codes */ readonly type?: string; @@ -2137,8 +2130,7 @@ export interface components { */ readonly updated_at?: number; } & components["schemas"]["webhook_Base"]; - /** @description Data about the response, including pagination and collection totals. - * */ + /** @description Data about the response, including pagination and collection totals. */ readonly Pagination: { /** @description Total number of returned items across all pages. */ readonly total?: number; @@ -2335,20 +2327,15 @@ export interface components { parameters: { /** @description The ID of a Webhook. */ readonly WebhookId: number; - /** @description Enables user to filter for webhooks that are active or not. A webhook subscription becomes deactivated after 90 days of inactivity. - * */ + /** @description Enables user to filter for webhooks that are active or not. A webhook subscription becomes deactivated after 90 days of inactivity. */ readonly IsActive: boolean; - /** @description Enables user to filter for webhooks by scope. - * */ + /** @description Enables user to filter for webhooks by scope. */ readonly FilterByScope: string; - /** @description Enables user to filter for webhooks by destination. - * */ + /** @description Enables user to filter for webhooks by destination. */ readonly FilterByDestination: string; - /** @description Page number. - * */ + /** @description Page number. */ readonly FilterPageParam: number; - /** @description Items count per page. - * */ + /** @description Items count per page. */ readonly FilterLimitParam: number; readonly Accept: string; readonly "Content-Type": string; @@ -2362,20 +2349,15 @@ export interface operations { readonly getWebhooks: { readonly parameters: { readonly query?: { - /** @description Page number. - * */ + /** @description Page number. */ readonly page?: components["parameters"]["FilterPageParam"]; - /** @description Items count per page. - * */ + /** @description Items count per page. */ readonly limit?: components["parameters"]["FilterLimitParam"]; - /** @description Enables user to filter for webhooks that are active or not. A webhook subscription becomes deactivated after 90 days of inactivity. - * */ + /** @description Enables user to filter for webhooks that are active or not. A webhook subscription becomes deactivated after 90 days of inactivity. */ readonly is_active?: components["parameters"]["IsActive"]; - /** @description Enables user to filter for webhooks by scope. - * */ + /** @description Enables user to filter for webhooks by scope. */ readonly scope?: components["parameters"]["FilterByScope"]; - /** @description Enables user to filter for webhooks by destination. - * */ + /** @description Enables user to filter for webhooks by destination. */ readonly destination?: components["parameters"]["FilterByDestination"]; }; readonly header?: { @@ -2486,8 +2468,7 @@ export interface operations { readonly getHooksAdmin: { readonly parameters: { readonly query?: { - /** @description Enables user to filter for webhooks that are active or not. A webhook subscription becomes deactivated after 90 days of inactivity. - * */ + /** @description Enables user to filter for webhooks that are active or not. A webhook subscription becomes deactivated after 90 days of inactivity. */ readonly is_active?: components["parameters"]["IsActive"]; }; readonly header?: never; diff --git a/src/internal/reference/generated/widgets.v3.ts b/src/internal/reference/generated/widgets.v3.ts index bf1661d..281dcb7 100644 --- a/src/internal/reference/generated/widgets.v3.ts +++ b/src/internal/reference/generated/widgets.v3.ts @@ -361,35 +361,25 @@ export interface components { /** * pagination * @description Data about the response, including pagination and collection totals. - * */ readonly pagination: { - /** @description Total number of items in the result set. - * */ + /** @description Total number of items in the result set. */ readonly total?: number; - /** @description Total number of items in the collection response. - * */ + /** @description Total number of items in the collection response. */ readonly count?: number; - /** @description The amount of items returned in the collection per page, controlled by the limit parameter. - * */ + /** @description The amount of items returned in the collection per page, controlled by the limit parameter. */ readonly per_page?: number; - /** @description The page you are currently on within the collection. - * */ + /** @description The page you are currently on within the collection. */ readonly current_page?: number; - /** @description The total number of pages in the collection. - * */ + /** @description The total number of pages in the collection. */ readonly total_pages?: number; - /** @description Pagination links for the previous and next parts of the whole collection. - * */ + /** @description Pagination links for the previous and next parts of the whole collection. */ readonly links?: { - /** @description Link to the previous page returned in the response. - * */ + /** @description Link to the previous page returned in the response. */ readonly previous?: string; - /** @description Link to the current page returned in the response. - * */ + /** @description Link to the current page returned in the response. */ readonly current?: string; - /** @description Link to the next page returned in the response. - * */ + /** @description Link to the next page returned in the response. */ readonly next?: string; }; }; @@ -409,14 +399,11 @@ export interface components { readonly instance?: string; readonly errors?: Record; }; - /** @description Error payload for the BigCommerce API. - * */ + /** @description Error payload for the BigCommerce API. */ readonly BaseError: { - /** @description The HTTP status code. - * */ + /** @description The HTTP status code. */ readonly status?: number; - /** @description The error title describing the particular error. - * */ + /** @description The error title describing the particular error. */ readonly title?: string; readonly type?: string; readonly instance?: string; @@ -612,7 +599,7 @@ export interface components { }; readonly conditional?: components["schemas"]["widgetSchemaConditional"]; }; - /** @description The schema for the widget’s merchant-facing UI. For more information on the available schema settings, see [Widget UI Schema](/docs/storefront/widgets/input-reference/schema). */ + /** @description The schema for the widget’s merchant-facing UI. For more information on the available schema settings, see [Widget UI Schema](/docs/storefront/widgets/input-reference/schema). */ readonly widgetSchema: readonly (components["schemas"]["widgetSchemaTab"] | components["schemas"]["widgetSchemaArray"] | components["schemas"]["widgetSchemaHidden"])[]; /** * widgetSchemaHidden @@ -736,35 +723,25 @@ export interface components { * @description Data about the response, including pagination and collection totals. */ readonly meta?: { - /** @description Data about the response, including pagination and collection totals. - * */ + /** @description Data about the response, including pagination and collection totals. */ readonly pagination?: { - /** @description Total number of items in the result set. - * */ + /** @description Total number of items in the result set. */ readonly total?: number; - /** @description Total number of items in the collection response. - * */ + /** @description Total number of items in the collection response. */ readonly count?: number; - /** @description The amount of items returned in the collection per page, controlled by the limit parameter. - * */ + /** @description The amount of items returned in the collection per page, controlled by the limit parameter. */ readonly per_page?: number; - /** @description The page you are currently on within the collection. - * */ + /** @description The page you are currently on within the collection. */ readonly current_page?: number; - /** @description The total number of pages in the collection. - * */ + /** @description The total number of pages in the collection. */ readonly total_pages?: number; - /** @description Pagination links for the previous and next parts of the whole collection. - * */ + /** @description Pagination links for the previous and next parts of the whole collection. */ readonly links?: { - /** @description Link to the previous page returned in the response. - * */ + /** @description Link to the previous page returned in the response. */ readonly previous?: string; - /** @description Link to the current page returned in the response. - * */ + /** @description Link to the current page returned in the response. */ readonly current?: string; - /** @description Link to the next page returned in the response. - * */ + /** @description Link to the next page returned in the response. */ readonly next?: string; }; }; @@ -872,8 +849,7 @@ export interface components { }; }; }; - /** @description This is the result of missing required fields, or of invalid data. See the response for more details. - * */ + /** @description This is the result of missing required fields, or of invalid data. See the response for more details. */ readonly Error422_Resp: { headers: { readonly [name: string]: unknown; @@ -915,16 +891,13 @@ export interface components { readonly WidgetUUID: string; /** @description The identifier for a specific widget. */ readonly FilterWidgetUUIDParam: string; - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly PageParam: number; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly LimitParam: number; /** @description This is an optional query parameter used to fetch a specific widget template version. */ readonly FilterVersionUUID: string; - /** @description The query string associated with a widget's name and description. - * */ + /** @description The query string associated with a widget's name and description. */ readonly QueryWidgetsParam: string; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept: string; @@ -946,11 +919,9 @@ export interface operations { readonly getWidgetTemplates: { readonly parameters: { readonly query?: { - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; /** @description The kind of widget template. */ readonly widget_template_kind?: components["parameters"]["FilterWidgetTemplateKindParam"]; @@ -1113,11 +1084,9 @@ export interface operations { readonly getWidgets: { readonly parameters: { readonly query?: { - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; /** @description The kind of widget template. */ readonly widget_template_kind?: components["parameters"]["FilterWidgetTemplateKindParam"]; @@ -1242,11 +1211,9 @@ export interface operations { readonly getPlacements: { readonly parameters: { readonly query?: { - /** @description Specifies the page number in a limited (paginated) list of products. - * */ + /** @description Specifies the page number in a limited (paginated) list of products. */ readonly page?: components["parameters"]["PageParam"]; - /** @description Controls the number of items per page in a limited (paginated) list of products. - * */ + /** @description Controls the number of items per page in a limited (paginated) list of products. */ readonly limit?: components["parameters"]["LimitParam"]; /** @description The kind of widget template. */ readonly widget_template_kind?: components["parameters"]["FilterWidgetTemplateKindParam"]; diff --git a/src/internal/reference/generated/wishlists.v3.ts b/src/internal/reference/generated/wishlists.v3.ts index 19825cb..a972843 100644 --- a/src/internal/reference/generated/wishlists.v3.ts +++ b/src/internal/reference/generated/wishlists.v3.ts @@ -311,7 +311,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": [ * { * "id": 1, @@ -399,7 +400,8 @@ export interface operations { * "total_pages": 0 * } * } - * } */ + * } + */ readonly "application/json": { readonly data?: readonly components["schemas"]["wishlist_Full"][]; readonly meta?: components["schemas"]["metaCollection"]; @@ -459,7 +461,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 30, * "customer_id": 10, @@ -495,7 +498,8 @@ export interface operations { * ] * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: components["schemas"]["wishlist_Full"]; /** @description Response metadata. */ @@ -556,7 +560,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 30, * "customer_id": 10, @@ -592,7 +597,8 @@ export interface operations { * ] * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: components["schemas"]["wishlist_Full"]; /** @description Response metadata. */ @@ -661,7 +667,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 30, * "customer_id": 10, @@ -697,7 +704,8 @@ export interface operations { * ] * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: components["schemas"]["wishlist_Full"]; /** @description Response metadata. */ @@ -772,7 +780,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 30, * "customer_id": 10, @@ -808,7 +817,8 @@ export interface operations { * ] * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: components["schemas"]["wishlist_Full"]; /** @description Response metadata. */ @@ -925,7 +935,8 @@ export interface operations { readonly [name: string]: unknown; }; content: { - /** @example { + /** + * @example { * "data": { * "id": 30, * "customer_id": 10, @@ -961,7 +972,8 @@ export interface operations { * ] * }, * "meta": {} - * } */ + * } + */ readonly "application/json": { readonly data?: components["schemas"]["wishlist_Full"]; /** @description Response metadata. */