diff --git a/.changeset/orange-months-shave.md b/.changeset/orange-months-shave.md new file mode 100644 index 0000000..c713536 --- /dev/null +++ b/.changeset/orange-months-shave.md @@ -0,0 +1,5 @@ +--- +'bigrequest': patch +--- + +bigcommerce/docs#107,bigcommerce/docs#114,bigcommerce/docs#118,bigcommerce/docs#120,bigcommerce/docs#108,bigcommerce/docs#123,bigcommerce/docs#128,bigcommerce/docs#125,bigcommerce/docs#127,bigcommerce/docs#137,bigcommerce/docs#138,bigcommerce/docs#140,bigcommerce/docs#146,bigcommerce/docs#145,bigcommerce/docs#141,bigcommerce/docs#152,bigcommerce/docs#154,bigcommerce/docs#149,bigcommerce/docs#156,bigcommerce/docs#157,bigcommerce/docs#142,bigcommerce/docs#153,bigcommerce/docs#155,bigcommerce/docs#163,bigcommerce/docs#172,bigcommerce/docs#171 diff --git a/src/generated/brands_catalog.v3.ts b/src/generated/brands_catalog.v3.ts index b7674e1..1107e09 100644 --- a/src/generated/brands_catalog.v3.ts +++ b/src/generated/brands_catalog.v3.ts @@ -819,10 +819,6 @@ export interface operations { id?: number; "id:in"?: number[]; "id:not_in"?: number[]; - "id:min"?: number[]; - "id:max"?: number[]; - "id:greater"?: number[]; - "id:less"?: number[]; /** @description Filter items by name. */ name?: string; /** @description Filter items by part of a name. For example, `name:like=new` returns brands with names that include `new`. */ @@ -1559,7 +1555,6 @@ export interface operations { parameters: { header: { Accept: components["parameters"]["Accept"]; - "Content-Type": components["parameters"]["ContentType"]; }; path: { brand_id: components["parameters"]["BrandIdParam"]; @@ -1572,7 +1567,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["metafield_Base"]; + "application/json": components["schemas"]["MetafieldBase_Put"]; }; }; responses: { diff --git a/src/generated/carts.v3.ts b/src/generated/carts.v3.ts index 43bc43e..cda0767 100644 --- a/src/generated/carts.v3.ts +++ b/src/generated/carts.v3.ts @@ -84,6 +84,7 @@ export interface paths { * * If your application requires URLs to be visited more than once, consider generating a fresh one each time you need to restore a cart, and redirecting to the URL from your own application. * * Redirect URLs can be generated only from carts that were created using the **REST Management API**. * * To restore a cart that was created on the storefront, either by a shopper or a Storefront API, first recreate the cart using the **REST Management API**. + * * When redirecting the shopper, you can add a set of `query_params` to the URL. The `query_params` feature allows passing additional information to the redirect URL. */ post: operations["createCartRedirectURL"]; parameters: { @@ -1347,6 +1348,13 @@ export interface components { })[]; custom_items?: components["schemas"]["cart_PostCustomItem"]; }; + /** Redirect_urls_Post */ + Redirect_urls_Post: { + query_params?: { + key?: string; + value?: string; + }[]; + }; /** Cart_Line_Item_Update_Post */ Cart_Line_Item_Update_Post: { line_items?: unknown; @@ -2088,6 +2096,7 @@ export interface operations { * * If your application requires URLs to be visited more than once, consider generating a fresh one each time you need to restore a cart, and redirecting to the URL from your own application. * * Redirect URLs can be generated only from carts that were created using the **REST Management API**. * * To restore a cart that was created on the storefront, either by a shopper or a Storefront API, first recreate the cart using the **REST Management API**. + * * When redirecting the shopper, you can add a set of `query_params` to the URL. The `query_params` feature allows passing additional information to the redirect URL. */ createCartRedirectURL: { parameters: { @@ -2099,6 +2108,11 @@ export interface operations { cartId: components["parameters"]["cartId"]; }; }; + requestBody?: { + content: { + "application/json": components["schemas"]["Redirect_urls_Post"]; + }; + }; responses: { 201: components["responses"]["CartRedirectResponse"]; }; diff --git a/src/generated/category-trees_catalog.v3.ts b/src/generated/category-trees_catalog.v3.ts index 462ffd3..6c3bfa2 100644 --- a/src/generated/category-trees_catalog.v3.ts +++ b/src/generated/category-trees_catalog.v3.ts @@ -27,7 +27,6 @@ export interface paths { * * Creating a category requires: * - `name` - * - `url` * - `tree_id` or `parent_id` */ post: operations["createCategories"]; @@ -120,7 +119,7 @@ export interface components { /** Create Categories */ CreateCategories: ({ name: components["schemas"]["name"]; - url: components["schemas"]["url"]; + url?: components["schemas"]["url"]; parent_id: components["schemas"]["parent_id"]; tree_id: components["schemas"]["tree_id"]; } & components["schemas"]["CategoryBase"])[]; @@ -330,7 +329,10 @@ export interface components { beta4ErrorResponse: components["schemas"]["BaseError"] & { errors?: components["schemas"]["beta4DetailedErrors"]; }; - /** URL */ + /** + * URL + * @description If not provided, the URL is autogenerated from the category name. + */ url: { /** @example /bath/ */ path?: string; @@ -500,7 +502,6 @@ export interface operations { * * Creating a category requires: * - `name` - * - `url` * - `tree_id` or `parent_id` */ createCategories: { diff --git a/src/generated/channels.v3.ts b/src/generated/channels.v3.ts index a3b0afa..6e5e42b 100644 --- a/src/generated/channels.v3.ts +++ b/src/generated/channels.v3.ts @@ -798,7 +798,7 @@ export interface components { ChannelIdForListing: number; /** * Format: int64 - * @description The ID of the channel listing that has been created, returned, or updated. + * @description The ID of the channel listing that has been created, returned, or updated. In a 422 error, you may receive a response that references the `group_id`. The `group_id` in the Invalid Listing ID example refers to the `listing_id`. Please use `listing_id` instead of `group_id` in the request payload. */ ListingId: number; /** diff --git a/src/generated/checkouts.v3.ts b/src/generated/checkouts.v3.ts index 4f5b324..952b2d2 100644 --- a/src/generated/checkouts.v3.ts +++ b/src/generated/checkouts.v3.ts @@ -243,7 +243,7 @@ export interface components { channel_id?: number; /** * Format: double - * @description Order-based discounted amount only - Excludes coupon discounts and product-based discounts. + * @description The amount includes order-level automatic promotions plus manual discounts and excludes coupon and product-based discounts. * @example 0.5 */ discount_amount?: number; diff --git a/src/generated/customers.v3.ts b/src/generated/customers.v3.ts index 7123997..2afb3b8 100644 --- a/src/generated/customers.v3.ts +++ b/src/generated/customers.v3.ts @@ -329,30 +329,30 @@ export interface paths { }; "/customers/{customerId}/metafields": { /** - * Get Customer metafields - * @description Get a customer's metafields. + * Get Customer Metafields + * @description Gets customer metafields by passing the `customerId` in the query parameters. */ get: operations["getCustomersMetafields"]; /** * Create Customer Metafields - * @description Creates Customer metafields. + * @description Creates Customer metafields by passing the `customerId` in the query parameters. */ post: operations["createCustomerMetafields"]; }; "/customers/{customerId}/metafields/{metafieldId}": { /** - * Get Metafields by CustomerId - * @description Lists all available metafields for a customer. Use both `customerId` and `metafieldId` in the parameters to retrieve the full list. + * Get Customer Metafields List + * @description Lists available metafields for a customer. To retrieve the list, use `customerId` and `metafieldId` in the query parameters. */ get: operations["getMetafieldsCustomerId"]; /** - * Update a metafield - * @description Updates Customer metafields. Use both 'customerId' and 'metafield' in the parameter to update the customer metafields. + * Update a Metafield + * @description Updates customer metafields. To update the customer metafields, use 'customerId' and 'metafield' in the query parameters. */ put: operations["updateCustomerMetafield"]; /** - * Delete customer metafields - * @description Deletes customer metafields. Use both 'customerId' and 'metafieldId' in the parameter to delete the customer metafields. + * Delete Customer Metafields + * @description Deletes customer metafields. To delete customer metafields, use 'customerId' and 'metafieldId' in the query parameters. */ delete: operations["deleteCustomerMetafieldsId"]; }; @@ -363,12 +363,12 @@ export interface paths { */ get: operations["getallCustomersMetafields"]; /** - * Update multiple Metafields + * Update Multiple Metafields * @description Create multiple metafields. */ put: operations["updateCustomersMetafields"]; /** - * Create multiple Metafields + * Create Multiple Metafields * @description Create multiple metafields. */ post: operations["createCustomersMetafields"]; @@ -1342,17 +1342,16 @@ export interface components { date_modified: string; /** * @description Client ID for the metafieldʼs creator. - * @example asdfasdfasdfasdfasdfasdfasdf + * @example ramciw4fnoz87it3ynjfif2zrkil5p */ owner_client_id?: string; }; /** @description Response payload for the BigCommerce API. */ MetaFieldCollectionResponse: { data?: components["schemas"]["Metafield"][]; - meta?: components["schemas"]["CollectionMeta"]; }; /** @description Response payload for the BigCommerce API. */ - MetaFieldCollectionResponse_POST_PUT: { + MetaFieldCollectionPostPutResponses: { data?: components["schemas"]["Metafield"][]; /** * @description Empty for 200 responses. @@ -2105,25 +2104,24 @@ export interface components { }; }; /** @description Response payload for the BigCommerce API. */ - MetafieldResponse_Post: { - content: never; - }; - "application/json": { - content: never; - }; - /** @description Response payload for the BigCommerce API. */ MetafieldCollectionResponse: { content: { "application/json": { data?: unknown[]; /** * @description Unique ID of the *Metafield*. Read-Only. - * @example 24 + * @example 0 */ id: number; - /** @description The key for the metafields. */ + /** + * @description The key for the metafields. + * @example Staff Name + */ key: string; - /** @description The description for the metafield. */ + /** + * @description The description for the metafield. + * @example Ronaldo + */ value: string; /** * @description Namespace for the metafield, for organizational purposes. @@ -2154,10 +2152,14 @@ export interface components { /** * @description The unique identifier for the resource with which the metafield is associated. * - * @example 424242 + * @example 0 */ resource_id: number; - /** @description Description for the metafields. */ + /** + * @description Description for the metafields. + * + * @example order + */ description: string; /** * Format: date-time @@ -2171,7 +2173,10 @@ export interface components { * @example 2022-06-16T18:39:00+00:00 */ date_modified: string; - /** @description Client ID for the metafield's creator. */ + /** + * @description Client ID for the metafield's creator. + * @example ramciw4fnoz87it3ynjfif2zrkil5p + */ owner_client_id?: string; }; }; @@ -3104,14 +3109,11 @@ export interface operations { }; }; /** - * Get Customer metafields - * @description Get a customer's metafields. + * Get Customer Metafields + * @description Gets customer metafields by passing the `customerId` in the query parameters. */ getCustomersMetafields: { parameters: { - query?: { - customerId?: number; - }; path: { customerId: components["parameters"]["customerId"]; }; @@ -3122,12 +3124,7 @@ export interface operations { }; }; responses: { - /** @description List of `Metafield` objects. */ - 200: { - content: { - "application/json": components["responses"]["MetafieldResponse_Post"]; - }; - }; + 200: components["responses"]["MetafieldCollectionResponse"]; /** @description Internal Server Error */ 500: { content: never; @@ -3136,36 +3133,38 @@ export interface operations { }; /** * Create Customer Metafields - * @description Creates Customer metafields. + * @description Creates Customer metafields by passing the `customerId` in the query parameters. */ createCustomerMetafields: { parameters: { - query?: { - customerId?: number; - }; path: { customerId: components["parameters"]["customerId"]; }; }; - requestBody?: { + requestBody: { content: { - "application/json": Record; + "application/json": components["schemas"]["MetafieldBase_Post"]; }; }; responses: { - 200: components["responses"]["MetafieldResponse_Post"]; + /** @description Response payload for the BigCommerce API. */ + 200: { + content: { + "application/json": components["schemas"]["MetaFieldCollectionPostPutResponses"]; + }; + }; }; }; /** - * Get Metafields by CustomerId - * @description Lists all available metafields for a customer. Use both `customerId` and `metafieldId` in the parameters to retrieve the full list. + * Get Customer Metafields List + * @description Lists available metafields for a customer. To retrieve the list, use `customerId` and `metafieldId` in the query parameters. */ getMetafieldsCustomerId: { parameters: { path: { /** @description The ID that belongs to the customer. */ customerId: number; - /** @description The ID that is assigned to a metafield when created. */ + /** @description The ID that is generated for a metafield when created. */ metafieldId: number; }; }; @@ -3179,13 +3178,13 @@ export interface operations { }; }; /** - * Update a metafield - * @description Updates Customer metafields. Use both 'customerId' and 'metafield' in the parameter to update the customer metafields. + * Update a Metafield + * @description Updates customer metafields. To update the customer metafields, use 'customerId' and 'metafield' in the query parameters. */ updateCustomerMetafield: { parameters: { query?: { - /** @description The ID that is assigned to a metafield when created. */ + /** @description The ID that is generated for a metafield when created. */ metafieldId?: number; }; path: { @@ -3206,12 +3205,17 @@ export interface operations { }; }; responses: { - 200: components["responses"]["MetafieldResponse_Post"]; + /** @description Response payload for the BigCommerce API. */ + 200: { + content: { + "application/json": components["schemas"]["MetaFieldCollectionPostPutResponses"]; + }; + }; }; }; /** - * Delete customer metafields - * @description Deletes customer metafields. Use both 'customerId' and 'metafieldId' in the parameter to delete the customer metafields. + * Delete Customer Metafields + * @description Deletes customer metafields. To delete customer metafields, use 'customerId' and 'metafieldId' in the query parameters. */ deleteCustomerMetafieldsId: { parameters: { @@ -3262,7 +3266,7 @@ export interface operations { }; }; /** - * Update multiple Metafields + * Update Multiple Metafields * @description Create multiple metafields. */ updateCustomersMetafields: { @@ -3279,10 +3283,10 @@ export interface operations { }; }; responses: { - /** @description List of updated `Metafield` objects. */ + /** @description Response payload for the BigCommerce API. */ 200: { content: { - "application/json": components["schemas"]["MetaFieldCollectionResponse_POST_PUT"]; + "application/json": components["schemas"]["MetaFieldCollectionPostPutResponses"]; }; }; /** @description Response object for metafields creation with partial success. */ @@ -3298,7 +3302,7 @@ export interface operations { }; }; /** - * Create multiple Metafields + * Create Multiple Metafields * @description Create multiple metafields. */ createCustomersMetafields: { @@ -3315,10 +3319,10 @@ export interface operations { }; }; responses: { - /** @description List of created `Metafield` objects. */ + /** @description Response payload for the BigCommerce API. */ 200: { content: { - "application/json": components["schemas"]["MetaFieldCollectionResponse_POST_PUT"]; + "application/json": components["schemas"]["MetaFieldCollectionPostPutResponses"]; }; }; /** @description Response object for metafields creation with partial success. */ diff --git a/src/generated/marketing.v2.ts b/src/generated/marketing.v2.ts index 7843b0d..4883677 100644 --- a/src/generated/marketing.v2.ts +++ b/src/generated/marketing.v2.ts @@ -9,7 +9,7 @@ export interface paths { "/coupons": { /** * Get All Coupons - * @description Returns a list of *Coupons*. Default sorting is by coupon/discount id, from lowest to highest. Optional filter parameters can be passed in. + * @description Returns a list of *Coupons*. Default sorting is by coupon/discount id, from lowest to highest. You can pass in optional filter parameters. We recommended using `?min_id=x&limit=y` to paginate through a large set of data because it offers better performance. * * ## Usage Notes * @@ -704,7 +704,7 @@ export interface operations { /** * Get All Coupons - * @description Returns a list of *Coupons*. Default sorting is by coupon/discount id, from lowest to highest. Optional filter parameters can be passed in. + * @description Returns a list of *Coupons*. Default sorting is by coupon/discount id, from lowest to highest. You can pass in optional filter parameters. We recommended using `?min_id=x&limit=y` to paginate through a large set of data because it offers better performance. * * ## Usage Notes * diff --git a/src/generated/orders.v2.oas2.ts b/src/generated/orders.v2.oas2.ts index dd776dd..45f2a4b 100644 --- a/src/generated/orders.v2.oas2.ts +++ b/src/generated/orders.v2.oas2.ts @@ -1350,7 +1350,6 @@ export interface components { * @example 0.0000 */ base_wrapping_cost?: string; - billing_address?: components["schemas"]["billingAddress_Base"]; /** * @description Shows where the order originated. The channel_id will default to 1. * @example 1 @@ -1364,8 +1363,6 @@ export interface components { 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`. */ date_created?: string; - /** @description The currency code of the transactional currency the shopper pays in; writeable when multi-currency is enabled. */ - default_currency_code?: string; /** * @description Amount of discount for this transaction. (Float, Float-As-String, Integer) * @example 0.0000 @@ -1491,15 +1488,14 @@ export interface components { */ subtotal_inc_tax?: string; /** - * @description BasicTaxProvider - Tax is set to manual and order is created in the store. + * @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. - * - * @enum {string} */ - tax_provider_id?: "BasicTaxProvider" | "AvaTaxProvider" | ""; + tax_provider_id?: string; /** * @description The customer’s locale. * @example en @@ -1748,9 +1744,7 @@ export interface components { * @example 7 */ status_id?: number; - billing_address?: { - form_fields?: components["schemas"]["formFields"][]; - }; + billing_address?: components["schemas"]["billingAddress_Resp"]; }; /** * Custom product @@ -2128,15 +2122,14 @@ export interface components { */ subtotal_inc_tax?: string; /** - * @description BasicTaxProvider - Tax is set to manual and order is created in the store. + * @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. - * - * @enum {string} */ - tax_provider_id?: "BasicTaxProvider" | "AvaTaxProvider" | ""; + tax_provider_id?: string; /** * @description The customer’s locale. * @example en @@ -2173,6 +2166,9 @@ export interface components { * @description Products and Billing address only required for POST operation. */ order_Post: ({ + billing_address?: components["schemas"]["billingAddress_Base"]; + /** @description The currency code of the transactional currency the shopper pays in is writeable when multi-currency is enabled. */ + default_currency_code?: string; products?: (components["schemas"]["orderCatalogProduct_Post"] | components["schemas"]["orderCustomProduct_Post"])[]; shipping_addresses?: components["schemas"]["shippingAddress_Base"][]; consignments?: components["schemas"]["orderConsignment_Post"]; @@ -2183,6 +2179,9 @@ export interface components { billingAddress_Put: components["schemas"]["billingAddress_Base"] & { form_fields?: components["schemas"]["formFields"][]; }; + billingAddress_Resp: components["schemas"]["billingAddress_Base"] & { + form_fields?: components["schemas"]["formFields"][]; + }; orderConsignment_Put: { pickups?: components["schemas"]["pickupConsignment_Put"][]; }; @@ -2571,7 +2570,7 @@ export interface components { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ ContentType: string; /** @description The order ID in another system, such as the Amazon Order ID if this is an Amazon order. After setting it, you can update this field using a POST or PUT request. */ - external_order_id?: number; + external_order_id?: string; /** @description The minimum order ID. */ min_id?: number; /** @description The maximum order ID. */ diff --git a/src/generated/price_lists.v3.ts b/src/generated/price_lists.v3.ts index a59f19b..c28491e 100644 --- a/src/generated/price_lists.v3.ts +++ b/src/generated/price_lists.v3.ts @@ -252,37 +252,68 @@ export interface components { }; meta?: components["schemas"]["Meta"]; }; - PriceRecordCollectionPutWithPriceListId: components["schemas"]["PriceRecordBatchItem"][]; - /** @description The `Price Record` object used in batch create or update. */ - PriceRecordBatchItem: components["schemas"]["PriceRecordBase"][]; + PriceRecordBatchItem: { + /** + * @description The price list ID the price record is associated with. + * @example 1 + */ + price_list_id?: number; + /** + * @description The price list with which the price record is associated. Either `variant_id` or `sku` is required. + * @example 5 + */ + variant_id?: number; + /** + * @description The SKU for the variant with which this price record is associated. Either `sku` or `variant_id` is required. + * @example SKU-001 + */ + sku?: string; + /** + * Format: ISO:4217 + * @description The 3-letter country code with which this price record is associated. + * @example usd + */ + currency?: string; + items?: components["schemas"]["PriceRecordBase"]; + }; /** @description Common Price Record properties. */ PriceRecordBase: { /** * 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. If empty, the sale price will be treated as not being set on this variant. + * @example 0 */ 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 0 */ 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 0 */ 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 0 */ map_price?: number; bulk_pricing_tiers?: components["schemas"]["BulkPricingTier"][]; }; BulkPricingTier: { - /** @description The cart's minimum quantity of associated variants needed to qualify for this tier's pricing. */ + /** + * @description The cart's minimum quantity of associated variants needed to qualify for this tier's pricing. + * @example 1 + */ quantity_min?: number; - /** @description The cart's maximum allowed quantity of associated variants to qualify for this tier's pricing. */ + /** + * @description The cart's maximum allowed quantity of associated variants to qualify for this tier's pricing. + * @example 10 + */ quantity_max?: number; /** * @description The type of adjustment that is made. @@ -290,17 +321,24 @@ export interface components { * * 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 fixed * @enum {string} */ type?: "fixed" | "price" | "percent"; /** * Format: double * @description The price adjustment amount. This value and the type will decide the price per variant for the pricing tier. + * @example 0 */ amount?: number; }; /** @description Empty object for Success case for Batch API. */ - SuccessBatchResponse: Record; + SuccessBatchResponse: { + /** @example {} */ + data?: Record; + /** @example {} */ + meta?: Record; + }; /** @description Error during `Price Record` batch PUT. Includes data sent in the request and errors. */ PriceRecordBatchErrorResponse: { data?: components["schemas"]["PriceRecordIdentifiers"]; @@ -972,7 +1010,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["PriceRecordCollectionPutWithPriceListId"]; + "application/json": components["schemas"]["PriceRecordBatchItem"]; }; }; responses: { diff --git a/src/generated/product-variants_catalog.v3.ts b/src/generated/product-variants_catalog.v3.ts index 89b70d0..7686861 100644 --- a/src/generated/product-variants_catalog.v3.ts +++ b/src/generated/product-variants_catalog.v3.ts @@ -27,7 +27,7 @@ export interface paths { * * 600 SKUs per product limit. * * 255 characters SKU length limit. * - * Variants need to be created one at a time using this endpoint. To use a variant array and create products and variants in the same call use the [Create Products](/docs/rest-catalog/products#create-a-product) during the initial product creation. + * Variants need to be created one at a time using this endpoint. To use a variant array, create products, and variants in the same call use the [Create Products](/docs/rest-catalog/products#create-a-product) endpoint during the initial product creation. */ post: operations["createProductVariant"]; parameters: { @@ -1103,7 +1103,7 @@ export interface operations { * * 600 SKUs per product limit. * * 255 characters SKU length limit. * - * Variants need to be created one at a time using this endpoint. To use a variant array and create products and variants in the same call use the [Create Products](/docs/rest-catalog/products#create-a-product) during the initial product creation. + * Variants need to be created one at a time using this endpoint. To use a variant array, create products, and variants in the same call use the [Create Products](/docs/rest-catalog/products#create-a-product) endpoint during the initial product creation. */ createProductVariant: { parameters: { diff --git a/src/generated/products_catalog.v3.ts b/src/generated/products_catalog.v3.ts index 6bf8bd8..789f68b 100644 --- a/src/generated/products_catalog.v3.ts +++ b/src/generated/products_catalog.v3.ts @@ -187,7 +187,9 @@ export interface paths { * * id * * Publicly accessible URLs are valid parameters. - * Videos must be loaded through YouTube at this time. + * + * The Catalog API integrates with third-party YouTube, and you must load videos through 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/). */ post: operations["createProductVideo"]; parameters: { @@ -214,6 +216,9 @@ export interface paths { * * **Read-Only Fields** * * id + * + * The Catalog API integrates with third-party YouTube, and you must load videos through 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/). */ put: operations["updateProductVideo"]; /** @@ -352,11 +357,16 @@ export interface paths { * **Required Fields** * - none * + * **Name-Value Pair Uniqueness** + * - Every name-value pair must be unique inside a product. + * * **Read-Only** * - id * - * **Note:** - * The default rate limit for this endpoint is 40 concurrent requests. + * **Limits** + * - 200 custom fields per product limit. + * - 250 characters per custom field limit. + * - 40 concurrent requests default rate limit. */ put: operations["updateProductCustomField"]; /** @@ -825,7 +835,10 @@ export interface components { }; /** productVariant_Full */ productVariant_Full: WithRequired; + }, "sku" | "id" | "product_id">; /** * productVariant_Put_Product * @description The model for a PUT to update variants on a product. @@ -1006,7 +1019,7 @@ export interface components { productImage_Put: { /** @description The unique numeric identifier for the product with which the image is associated. */ 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. */ + /** @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. */ url_zoom?: string; /** @description The standard URL for this image. By default, this is used for product-page images. */ url_standard?: string; @@ -1066,9 +1079,7 @@ export interface components { * product_Put * @description The model for a PUT to update a product. */ - product_Put: components["schemas"]["product_Base"] & { - variants?: components["schemas"]["productVariant_Put_Product"][]; - }; + product_Put: components["schemas"]["product_Base"] & Record; /** * metafield_Base * @description Metafield for products, categories, variants, and brands; the max number of metafields allowed on each is 250. For more information, see [Platform Limits](https://support.bigcommerce.com/s/article/Platform-Limits) in the Help Center. @@ -1258,6 +1269,8 @@ export interface components { url?: string; /** @description Returns `true` if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides). */ 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. */ + create_redirect?: boolean; }; /** * bulkPricingRule_Full @@ -1551,7 +1564,6 @@ export interface components { option_set_id?: number; /** @description Legacy template setting which controls if the option set shows up to the side of or below the product image and description. */ option_set_display?: string; - variants?: components["schemas"]["productVariant_Full"][]; }; /** * productImage_Full @@ -1562,7 +1574,7 @@ export interface components { id?: number; /** @description The unique numeric identifier for the product with which the image is associated. */ 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. */ + /** @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. */ url_zoom?: string; /** @description The standard URL for this image. By default, this is used for product-page images. */ url_standard?: string; @@ -1929,6 +1941,8 @@ export interface components { gtin?: string; /** @description Manufacturer Part Number */ mpn?: string; + /** @description the date when the Product had been imported */ + date_last_imported?: string; /** * @description The total (cumulative) rating for the product. * @@ -1954,6 +1968,10 @@ export interface components { id: number; } & components["schemas"]["bulkPricingRule_Full"])[]; images?: components["schemas"]["productImage_Full"][]; + /** + * @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/). + */ videos?: components["schemas"]["productVideo_Full"][]; variants?: components["schemas"]["productVariant_Full"][]; }; @@ -2689,6 +2707,8 @@ export interface operations { "id:less"?: number[]; /** @description Filter items by name. */ name?: string; + /** @description Filter items by Manufacturer Part Number (MPN). */ + mpn?: string; /** @description Filter items by UPC. */ upc?: string; /** @description Filter items by price. */ @@ -2707,9 +2727,11 @@ export interface operations { "date_modified:min"?: string; /** @description Filter items by date_last_imported. */ date_last_imported?: string; - /** @description Filter items by date_last_imported. For example, `date_last_imported:max=2020-06-15`. */ + /** @description Filter items by date_last_imported. For example, `date_last_imported:not=2015-08-21T22%3A53%3A23%2B00%3A00`. */ + "date_last_imported:not"?: string; + /** @description Filter items by date_last_imported. For example, `date_last_imported:max=2015-08-21T22%3A53%3A23%2B00%3A00`. */ "date_last_imported:max"?: string; - /** @description Filter items by date_last_imported. For example, `date_last_imported:min=2018-06-15`. */ + /** @description Filter items by date_last_imported. For example, `date_last_imported:min=2015-08-21T22%3A53%3A23%2B00%3A00`. */ "date_last_imported:min"?: string; /** @description Filter items based on whether the product is currently visible on the storefront. */ is_visible?: boolean; @@ -3016,7 +3038,7 @@ export interface operations { brand_id?: number; /** @description Filter items by date_modified. For example `v3/catalog/products?date_modified:min=2018-06-15` */ date_modified?: string; - /** @description Filter items by date_last_imported. For example `v3/catalog/products?date_last_imported:min=2018-06-15` */ + /** @description Filter items by date_last_imported. For example `v3/catalog/products?date_last_imported:min=2015-08-21T22%3A53%3A23%2B00%3A00` */ date_last_imported?: string; /** @description Filter items by if visible on the storefront. */ is_visible?: boolean; @@ -3312,7 +3334,7 @@ export interface operations { "application/json": { /** @description The unique numeric identifier for the product with which the image is associated. */ 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. */ + /** @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. */ url_zoom?: string; /** @description The standard URL for this image. By default, this is used for product-page images. */ url_standard?: string; @@ -3346,7 +3368,7 @@ export interface operations { id?: number; /** @description The unique numeric identifier for the product with which the image is associated. */ 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. */ + /** @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. */ url_zoom?: string; /** @description The standard URL for this image. By default, this is used for product-page images. */ url_standard?: string; @@ -3388,7 +3410,7 @@ export interface operations { id?: number; /** @description The unique numeric identifier for the product with which the image is associated. */ 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. */ + /** @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. */ url_zoom?: string; /** @description The standard URL for this image. By default, this is used for product-page images. */ url_standard?: string; @@ -3419,7 +3441,7 @@ export interface operations { * Must be sent as a multipart/form-data field in the request body. Limit of 8 MB per file. */ 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. */ + /** @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. */ url_zoom?: string; /** @description The standard URL for this image. By default, this is used for product-page images. */ url_standard?: string; @@ -3557,7 +3579,7 @@ export interface operations { id?: number; /** @description The unique numeric identifier for the product with which the image is associated. */ 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. */ + /** @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. */ url_zoom?: string; /** @description The standard URL for this image. By default, this is used for product-page images. */ url_standard?: string; @@ -3587,7 +3609,7 @@ export interface operations { * Must be sent as a `multipart/form-data` field in the request body. Limit of 8 MB per file. */ 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. */ + /** @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. */ url_zoom?: string; /** @description The standard URL for this image. By default, this is used for product-page images. */ url_standard?: string; @@ -3704,7 +3726,9 @@ export interface operations { * * id * * Publicly accessible URLs are valid parameters. - * Videos must be loaded through YouTube at this time. + * + * The Catalog API integrates with third-party YouTube, and you must load videos through 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/). */ createProductVideo: { parameters: { @@ -3856,6 +3880,9 @@ export interface operations { * * **Read-Only Fields** * * id + * + * The Catalog API integrates with third-party YouTube, and you must load videos through 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/). */ updateProductVideo: { parameters: { @@ -4855,11 +4882,16 @@ export interface operations { * **Required Fields** * - none * + * **Name-Value Pair Uniqueness** + * - Every name-value pair must be unique inside a product. + * * **Read-Only** * - id * - * **Note:** - * The default rate limit for this endpoint is 40 concurrent requests. + * **Limits** + * - 200 custom fields per product limit. + * - 250 characters per custom field limit. + * - 40 concurrent requests default rate limit. */ updateProductCustomField: { parameters: { diff --git a/src/generated/settings.v3.ts b/src/generated/settings.v3.ts index ae84125..e8ed853 100644 --- a/src/generated/settings.v3.ts +++ b/src/generated/settings.v3.ts @@ -217,8 +217,6 @@ export interface paths { /** * Update Locale Settings * @description Updates global locale settings. - * - * Set a channel override by using the `channel_id` query parameter. To remove a channel override, set `null` for a field. The field then inherits the global value. */ put: operations["updateSettingsLocale"]; }; @@ -1607,9 +1605,6 @@ export interface operations { */ getSettingsLocale: { parameters: { - query?: { - channel_id?: components["parameters"]["ChannelIdParam"]; - }; header: { Accept: components["parameters"]["Accept"]; }; @@ -1628,14 +1623,9 @@ export interface operations { /** * Update Locale Settings * @description Updates global locale settings. - * - * Set a channel override by using the `channel_id` query parameter. To remove a channel override, set `null` for a field. The field then inherits the global value. */ updateSettingsLocale: { parameters: { - query?: { - channel_id?: components["parameters"]["ChannelIdParam"]; - }; header: { Accept: components["parameters"]["Accept"]; "Content-Type": components["parameters"]["ContentType"]; diff --git a/src/generated/store_content.v2.ts b/src/generated/store_content.v2.ts index d1bba7b..adf8544 100644 --- a/src/generated/store_content.v2.ts +++ b/src/generated/store_content.v2.ts @@ -34,7 +34,7 @@ export interface paths { * * **Notes** * - * * When including `published_date` in a request, supply it as a flat date string (not an object) in valid RFC 2822. The example request below includes a `published_date` in RFC 2822 format. + * * When including `published_date` in a request, supply it as a flat date string (not an object) in valid RFC 2822. The following example request includes a `published_date` in RFC 2822 format. * * Blog posts default to draft status. To publish blog posts to the storefront, set the `is_published` property to `true`. * * If a custom URL is not provided, the post’s URL will be generated based on the value of `title`. */ @@ -62,7 +62,7 @@ export interface paths { * * **Notes** * - * * When including `published_date` in a request, supply it as a flat date string (not an object) in valid RFC 2822. The example request below includes a `published_date` in RFC 2822 format. + * * To include `published_date` in a request, provide a flat date string (not an object) in valid RFC 2822. The following example request includes a `published_date` in RFC 2822 format. * * * Blog posts default to draft status. To publish blog posts to the storefront, set the `is_published` property to `true`. */ @@ -309,7 +309,7 @@ export interface components { /** blogPost_Full */ blogPost_Full: { /** - * @description ID of this blog post. (READ-ONLY) + * @description ID of this blog post. READ-ONLY. * @example 3 */ id?: number; @@ -343,7 +343,7 @@ export interface components { /** page_Full */ page_Full: { /** - * @description ID of the page. + * @description ID of the page. Read-Only. * @example 44 */ id?: number; @@ -357,7 +357,7 @@ export interface components { * "type": "product", * "ref": 111 * }, - * "url": "http://store-url.mybigcommerce.com/towels/bath-towels/hand-towels/" + * "url": "http://store-store_hash.mybigcommerce.com/towels/bath-towels/hand-towels/" * } */ redirect: { @@ -373,8 +373,8 @@ export interface components { path: string; forward: components["schemas"]["forward"]; /** - * @description URL of the redirect. READ-ONLY - * @example http://store-url.mybigcommerce.com/towels/bath-towels/hand-towels/ + * @description URL of the redirect. READ-ONLY. + * @example http://store-store_hash.mybigcommerce.com/towels/bath-towels/hand-towels/ */ url?: string; }; @@ -466,7 +466,7 @@ export interface components { accepts_marketing?: boolean; addresses?: components["schemas"]["addresses"]; /** @description Array of custom fields. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request. */ - form_fields?: components["schemas"]["formField"][]; + form_fields?: readonly components["schemas"]["formField"][]; /** * @description Force a password change on next login. * @example false @@ -477,23 +477,19 @@ export interface components { categoryAccessLevel: { /** * @description + `all` - Customers can access all categories - * + `specific` - Customers can access a specific list of categories + * + `specific` - Customers can access a specific list of categories * + `none` - Customers are prevented from viewing any of the categories in this group. * @enum {string} */ type?: "all" | "specific" | "none"; - /** - * @description Is an array of category IDs and should be supplied only if `type` is specific. - * @example [ - * "18,19,23,34" - * ] - */ - categories?: string[]; + /** @description A comma-separated list of category IDs. Should be supplied only if `type` is `specific`. */ + categories?: number[]; }; /** timeZone */ timeZone: { /** - * @description A string identifying the time zone, in the format: /. + * @description A string identifying the time zone, in the format: `/`. + * * @example America/Chicago */ name?: string; @@ -558,6 +554,23 @@ export interface components { /** * blogPost_Base_Post * @description blogPost base for POST requests + * @example { + * "title": "Welcome to BigCommerce", + * "url": "/blog/welcome-bigcommerce/", + * "preview_url": "/blog/welcome-bigcommerce/", + * "body": "

Customize your site, manage shipping and payments, and list your products on Amazon, eBay, and Facebook by Meta with the #1 ecommerce platform.

", + * "tags": [ + * "string" + * ], + * "summary": "

We power ecommerce websites for successful retailers all over the world

", + * "is_published": true, + * "published_date": "Thu, 18 May 2023 13:26:42 -0000", + * "published_date_iso8601": "5/18/2023 1:26:42 PM", + * "meta_description": "Welcome Post", + * "meta_keywords": "BigCommerce, welcome, ecommerce", + * "author": "BigCommerce", + * "thumbnail_path": "string" + * } */ blogPost_Base_Post: { /** @@ -578,7 +591,8 @@ export interface components { /** @description Tags to characterize the blog post. */ tags?: string[]; /** - * @description Whether the blog post is published. + * @description Whether the blog post is published. If you want the post to be or remain published following the request, you must set the field explicitly to true, even if the blog post was already published prior to the request. + * @default false * @example true */ is_published?: boolean; @@ -597,12 +611,35 @@ export interface components { * @example BigCommerce */ author?: string; - /** @description Local path to a thumbnail uploaded to `/product_images/` via [WebDav](https://support.bigcommerce.com/s/article/File-Access-WebDAV). */ + /** @description Local path to a thumbnail uploaded to `/product_images/` using [WebDAV](https://support.bigcommerce.com/s/article/File-Access-WebDAV). */ thumbnail_path?: string; /** @example Wed, 10 Aug 2022 15:39:15 -0500 */ published_date?: string; }; - /** blogPost_Base */ + /** + * blogPost_Base + * @example { + * "title": "Welcome to BigCommerce", + * "url": "/blog/welcome-bigcommerce/", + * "preview_url": "/blog/welcome-bigcommerce/", + * "body": "

Customize your site, manage shipping and payments, and list your products on Amazon, eBay, and Facebook by Meta with the #1 ecommerce platform.

", + * "tags": [ + * "string" + * ], + * "summary": "

We power ecommerce websites for successful retailers all over the world

", + * "is_published": true, + * "published_date": { + * "timezone_type": 1, + * "date": "2018-05-18T08:26:42Z", + * "timezone": "+00:00" + * }, + * "published_date_iso8601": "5/18/2018 1:26:42 PM", + * "meta_description": "Welcome Post", + * "meta_keywords": "BigCommerce, welcome, ecommerce", + * "author": "BigCommerce", + * "thumbnail_path": "string" + * } + */ blogPost_Base: { /** * @description Title of this blog post. @@ -615,7 +652,7 @@ export interface components { */ url?: string; /** - * @description URL to preview the blog post. (READ-ONLY) + * @description URL to preview the blog post. READ-ONLY. * @example /blog/welcome-bigcommerce/ */ preview_url?: string; @@ -627,19 +664,20 @@ export interface components { /** @description Tags to characterize the blog post. */ tags?: string[]; /** - * @description Summary of the blog post. (READ-ONLY) + * @description Summary of the blog post. READ-ONLY. * @example

We power ecommerce websites for successful retailers all over the world

*/ summary?: string; /** - * @description Whether the blog post is published. + * @description Whether the blog post is published. If you want the post to be or remain published following the request, you must set the field explicitly to true, even if the blog post was already published prior to the request. + * @default false * @example true */ is_published?: boolean; published_date?: components["schemas"]["publishedDate"]; /** * @description Published date in `ISO 8601` format. - * @example 5/18/2018 1:26:42 PM + * @example 5/18/2023 1:26:42 PM */ published_date_iso8601?: string; /** @@ -657,7 +695,7 @@ export interface components { * @example BigCommerce */ author?: string; - /** @description Local path to a thumbnail uploaded to `/product_images/` via [WebDav](https://support.bigcommerce.com/s/article/File-Access-WebDAV). */ + /** @description Local path to a thumbnail uploaded to `/product_images/` using [WebDAV](https://support.bigcommerce.com/s/article/File-Access-WebDAV). */ thumbnail_path?: string; }; /** @@ -676,7 +714,7 @@ export interface components { */ url?: string; /** - * @description URL to preview the blog post. (READ-ONLY) + * @description URL to preview the blog post. READ-ONLY. * @example /blog/welcome-bigcommerce/ */ preview_url?: string; @@ -688,19 +726,20 @@ export interface components { /** @description Tags to characterize the blog post. */ tags?: string[]; /** - * @description Summary of the blog post. (READ-ONLY) + * @description Summary of the blog post. READ-ONLY. * @example

We power ecommerce websites for successful retailers all over the world

*/ summary?: string; /** - * @description Whether the blog post is published. + * @description Whether the blog post is published. If you want the post to be or remain published following the request, you must set the field explicitly to true, even if the blog post was already published prior to the request. + * @default false * @example true */ is_published?: boolean; published_date?: components["schemas"]["publishedDate"]; /** * @description Published date in `ISO 8601` format. - * @example 5/18/2018 1:26:42 PM + * @example 5/18/2023 1:26:42 PM */ published_date_iso8601?: string; /** @@ -718,7 +757,7 @@ export interface components { * @example BigCommerce */ author?: string | null; - /** @description Local path to a thumbnail uploaded to `/product_images/` via [WebDav](https://support.bigcommerce.com/s/article/File-Access-WebDAV). */ + /** @description Local path to a thumbnail uploaded to `/product_images/` using [WebDAV](https://support.bigcommerce.com/s/article/File-Access-WebDAV). */ thumbnail_path?: string | null; }; publishedDate: { @@ -751,8 +790,7 @@ export interface components { * @description `page`: free-text page * `link`: link to another web address * `rss_feed`: syndicated content from an RSS feed - * `contact_form`: When the store's contact form is used. - * + * `contact_form`: When the store’s contact form is used * * @enum {string} */ @@ -763,7 +801,7 @@ export interface components { */ contact_fields?: string; /** - * @description Where the page’s type is a contact form: email address that receives messages sent via the form. + * @description Where the page’s type is a contact form, the email address that receives messages sent using the form. * @example janedoes@example.com */ email?: string; @@ -785,7 +823,7 @@ export interface components { */ body: string; /** - * @description HTML to use for this page's body when viewed in the mobile template (deprecated). + * @description HTML to use for this page’s body when viewed in the mobile template (deprecated). * @example 0 */ mobile_body?: string; @@ -804,7 +842,7 @@ export interface components { * @example false */ is_homepage?: boolean; - /** @description Text specified for this page’s `` element. (If empty, the value of the name property is used.) */ + /** @description Text specified for this page’s `<title>` element. If empty, the value of the name property is used. */ meta_title?: string; /** * @description Layout template for this page. This field is writable only for stores with a Blueprint theme applied. @@ -841,8 +879,7 @@ export interface components { * @description `page`: free-text page * `link`: link to another web address * `rss_feed`: syndicated content from an RSS feed - * `contact_form`: When the store's contact form is used. - * + * `contact_form`: When the store’s contact form is used * * @enum {string} */ @@ -853,7 +890,7 @@ export interface components { */ contact_fields?: string; /** - * @description Where the page’s type is a contact form: email address that receives messages sent via the form. + * @description Where the page’s type is a contact form, the email address that receives messages sent using the form. * @example janedoes@example.com */ email?: string; @@ -875,7 +912,7 @@ export interface components { */ body?: string; /** - * @description HTML to use for this page's body when viewed in the mobile template (deprecated). + * @description HTML to use for this page’s body when viewed in the mobile template (deprecated). * @example 0 */ mobile_body?: string; @@ -894,7 +931,7 @@ export interface components { * @example false */ is_homepage?: boolean; - /** @description Text specified for this page’s `<title>` element. (If empty, the value of the name property is used.) */ + /** @description Text specified for this page’s `<title>` element. If empty, the value of the name property is used. */ meta_title?: string; /** * @description Layout template for this page. This field is writable only for stores with a Blueprint theme applied. @@ -965,7 +1002,7 @@ export interface operations { parameters: { query?: { /** @description Filter param. */ - is_published?: string; + is_published?: boolean; /** @description Filter param. Value must be URL encoded. */ url?: string; /** @description Filter param. */ @@ -999,7 +1036,7 @@ export interface operations { * * **Notes** * - * * When including `published_date` in a request, supply it as a flat date string (not an object) in valid <a href="http://tools.ietf.org/html/rfc2822#section-3.3" target="_blank">RFC 2822</a>. The example request below includes a `published_date` in RFC 2822 format. + * * When including `published_date` in a request, supply it as a flat date string (not an object) in valid <a href="http://tools.ietf.org/html/rfc2822#section-3.3" target="_blank">RFC 2822</a>. The following example request includes a `published_date` in RFC 2822 format. * * Blog posts default to draft status. To publish blog posts to the storefront, set the `is_published` property to `true`. * * If a custom URL is not provided, the post’s URL will be generated based on the value of `title`. */ @@ -1080,7 +1117,7 @@ export interface operations { * * **Notes** * - * * When including `published_date` in a request, supply it as a flat date string (not an object) in valid <a href="http://tools.ietf.org/html/rfc2822#section-3.3" target="_blank">RFC 2822</a>. The example request below includes a `published_date` in RFC 2822 format. + * * To include `published_date` in a request, provide a flat date string (not an object) in valid <a href="http://tools.ietf.org/html/rfc2822#section-3.3" target="_blank">RFC 2822</a>. The following example request includes a `published_date` in RFC 2822 format. * * * Blog posts default to draft status. To publish blog posts to the storefront, set the `is_published` property to `true`. */ @@ -1217,6 +1254,30 @@ export interface operations { }; requestBody: { content: { + /** + * @example { + * "parent_id": 5, + * "type": "page", + * "contact_fields": "fullname,companyname,phone,orderno,rma", + * "email": "janedoes@example.com", + * "name": "Contact Form", + * "url": "/contact-us/", + * "meta_description": "string", + * "body": "<p>We're happy to answer questions or help you with returns.<br />Please fill out the form below if you need assistance.</p>", + * "mobile_body": "0", + * "has_mobile_version": false, + * "is_visible": true, + * "is_homepage": false, + * "meta_title": "string", + * "layout_file": "page.html", + * "sort_order": 3, + * "search_keywords": "string", + * "meta_keywords": "string", + * "feed": "string", + * "link": "string", + * "content_type": "text/html" + * } + */ "application/json": components["schemas"]["page_Base"]; }; }; @@ -1288,13 +1349,13 @@ export interface operations { }; requestBody?: { content: { - "application/json": components["schemas"]["page_Base"]; + "application/json": components["schemas"]["page_Full"]; }; }; responses: { 200: { content: { - "application/json": components["schemas"]["page_Base"]; + "application/json": components["schemas"]["page_Full"]; }; }; /** @description Multiple operations have taken place and the status for each operation can be viewed in the body of the response. Typically indicates that a partial failure has occurred, such as when a `POST` or `PUT` request is successful, but saving the URL has failed. */ @@ -1507,8 +1568,8 @@ export interface operations { ref?: string; }; /** - * @description URL of the redirect. READ-ONLY - * @example http://store-url.mybigcommerce.com/towels/bath-towels/hand-towels/ + * @description URL of the redirect. READ-ONLY. + * @example http://store-store_hash.mybigcommerce.com/towels/bath-towels/hand-towels/ */ url?: string; }; diff --git a/src/generated/tax_provider.ts b/src/generated/tax_provider.ts index d59d34f..db5a539 100644 --- a/src/generated/tax_provider.ts +++ b/src/generated/tax_provider.ts @@ -539,7 +539,7 @@ export interface operations { /** @description Returned Tax Quote response matches the updated QuoteRequest provided to the service method. */ 200: { content: { - "application/json": components["schemas"]["request-adjust"]; + "application/json": components["schemas"]["response-quote"]; }; }; /** @description General response that points to an issue with the incoming request that means a valid response is unable to be returned. */ diff --git a/src/generated/themes.v3.ts b/src/generated/themes.v3.ts index dc5d97c..19e9fb9 100644 --- a/src/generated/themes.v3.ts +++ b/src/generated/themes.v3.ts @@ -71,6 +71,10 @@ export interface paths { */ post: operations["activateStoreTheme"]; parameters: { + query?: { + /** @description The ID for the channel where you want to activate the theme. */ + channel_id?: number; + }; header: { Accept: components["parameters"]["Accept"]; }; @@ -486,7 +490,7 @@ export interface components { * @description Which configuration to use. * @enum {string} */ - which: "original" | "last_activated" | "last_created"; + which?: "original" | "last_activated" | "last_created"; }; /** @description A variation. */ Variation: { @@ -921,6 +925,10 @@ export interface operations { */ activateStoreTheme: { parameters: { + query?: { + /** @description The ID for the channel where you want to activate the theme. */ + channel_id?: number; + }; header: { Accept: components["parameters"]["Accept"]; "Content-Type": components["parameters"]["ContentType"];