From 3a38c7949c9b0211a91c51b01c6c96416216e53a Mon Sep 17 00:00:00 2001 From: Matthew Volk Date: Tue, 19 Sep 2023 16:08:06 -0500 Subject: [PATCH] [nightly] generate types against bigcommerce/api-specs@ad4c7e3 (#48) Co-authored-by: github-actions[bot] --- .changeset/grumpy-buses-turn.md | 5 ++ .../src/generated/brands_catalog.v3.ts | 14 ---- packages/bigrequest/src/generated/carts.v3.ts | 12 ++++ .../src/generated/categories_catalog.v3.ts | 40 +++-------- .../bigrequest/src/generated/currencies.v2.ts | 6 ++ .../bigrequest/src/generated/customers.v3.ts | 8 +-- .../src/generated/form_fields.sf.ts | 4 +- .../bigrequest/src/generated/pricing.sf.ts | 2 +- .../generated/product-modifiers_catalog.v3.ts | 6 -- .../product-variant-options_catalog.v3.ts | 6 -- .../generated/product-variants_catalog.v3.ts | 18 ----- .../src/generated/products_catalog.v3.ts | 68 ++++++------------- .../bigrequest/src/generated/settings.v3.ts | 1 + .../src/generated/shipping_provider.ts | 21 ++++-- .../bigrequest/src/generated/themes.v3.ts | 4 -- 15 files changed, 74 insertions(+), 141 deletions(-) create mode 100644 .changeset/grumpy-buses-turn.md diff --git a/.changeset/grumpy-buses-turn.md b/.changeset/grumpy-buses-turn.md new file mode 100644 index 0000000..31e08e3 --- /dev/null +++ b/.changeset/grumpy-buses-turn.md @@ -0,0 +1,5 @@ +--- +"bigrequest": patch +--- + +Remove duplicate `brand_id` param on brand metafield endpoints (bigcommerce/api-specs#1445). Add `gift_wrapping` property in V3 Cart line items response (bigcommerce/api-specs#1470). Add `sort` query parameter to Get All Categories endpoint (bigcommerce/api-specs#1465). Remove duplicate `category_id` and `metafield_id` path parameters in V3 Categories endpoints (bigcommerce/api-specs#1439). Add pagination properties to V2 GET Currencies response (bigcommerce/api-specs#1464). Remove duplicate `customer_id` path param on V3 Customer Consent endpoint (bigcommerce/api-specs#1441). Remove duplicate `modifier_id` path param on V3 Product Modifier endpoint (bigcommerce/api-specs#1448). Remove duplicate `option_id` path param from V3 Product Variant Option endpoint (bigcommerce/api-specs#1449). Remove duplicate variant `metafield_id` and `variant_id` params on V3 Product Variants endpoint (bigcommerce/api-specs#1447). Remove duplicate `image_id` path param from V3 Product Image endpoint (bigcommerce/api-specs#1434). Remove duplicate `video_id` path param from V3 Product Video endpoint (bigcommerce/api-specs#1454). Remove duplicate `complex_rule_id` path param from V3 Complex Rule endpoint (bigcommerce/api-specs#1440). Remove duplicate `custom_field_id` path param from V3 Custom Field endpoint (bigcommerce/api-specs#1442). Remove duplicate `bulk_pricing_rule_id` path param from Bulk Pricing Rules endpoint (bigcommerce/api-specs#1437). Remove duplicate `metafield_id` path param on Product Metafields endpoint (bigcommerce/api-specs#1446). Remove duplicate `review_id` path param on Product Reviews endpoint (bigcommerce/api-specs#1451). Remove duplicate `uuid` path param on Theme Configuration endpoint (bigcommerce/api-specs#1453). diff --git a/packages/bigrequest/src/generated/brands_catalog.v3.ts b/packages/bigrequest/src/generated/brands_catalog.v3.ts index 600f93e..0d3cff0 100644 --- a/packages/bigrequest/src/generated/brands_catalog.v3.ts +++ b/packages/bigrequest/src/generated/brands_catalog.v3.ts @@ -674,8 +674,6 @@ export interface operations { }; path: { brand_id: components["parameters"]["BrandIdParam"]; - /** @description The ID of the `Brand` to which the resource belongs. */ - brand_id: number; }; }; responses: { @@ -722,8 +720,6 @@ export interface operations { }; path: { brand_id: components["parameters"]["BrandIdParam"]; - /** @description The ID of the `Brand` to which the resource belongs. */ - brand_id: number; }; }; requestBody: { @@ -923,8 +919,6 @@ export interface operations { }; path: { brand_id: components["parameters"]["BrandIdParam"]; - /** @description The ID of the `Brand` to which the resource belongs. */ - brand_id: number; }; }; responses: { @@ -967,8 +961,6 @@ export interface operations { }; path: { brand_id: components["parameters"]["BrandIdParam"]; - /** @description The ID of the `Brand` to which the resource belongs. */ - brand_id: number; }; }; responses: { @@ -1018,8 +1010,6 @@ export interface operations { }; path: { brand_id: components["parameters"]["BrandIdParam"]; - /** @description The ID of the `Brand` to which the resource belongs. */ - brand_id: number; }; }; requestBody: { @@ -1231,8 +1221,6 @@ export interface operations { }; path: { brand_id: components["parameters"]["BrandIdParam"]; - /** @description The ID of the `Brand` to which the resource belongs. */ - brand_id: number; }; }; requestBody?: { @@ -1303,8 +1291,6 @@ export interface operations { }; path: { brand_id: components["parameters"]["BrandIdParam"]; - /** @description The ID of the `Brand` to which the resource belongs. */ - brand_id: number; }; }; responses: { diff --git a/packages/bigrequest/src/generated/carts.v3.ts b/packages/bigrequest/src/generated/carts.v3.ts index 33a69f1..3878911 100644 --- a/packages/bigrequest/src/generated/carts.v3.ts +++ b/packages/bigrequest/src/generated/carts.v3.ts @@ -1542,6 +1542,18 @@ export interface components { */ valueId?: number; }[]; + /** @description The gift wrapping details for this item. */ + gift_wrapping?: { + /** @example Gift Wrap 1 */ + name?: string; + /** @example Happy Birthday! */ + message?: string; + /** + * Format: float + * @example 1.99 + */ + amount?: number; + }; }; /** * Not Found diff --git a/packages/bigrequest/src/generated/categories_catalog.v3.ts b/packages/bigrequest/src/generated/categories_catalog.v3.ts index f100bc3..698fa7b 100644 --- a/packages/bigrequest/src/generated/categories_catalog.v3.ts +++ b/packages/bigrequest/src/generated/categories_catalog.v3.ts @@ -652,6 +652,16 @@ export interface operations { include_fields?: string; /** @description Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded. */ exclude_fields?: string; + /** + * @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?: string; }; header: { Accept: components["parameters"]["Accept"]; @@ -898,8 +908,6 @@ export interface operations { }; path: { category_id: components["parameters"]["CategoryIdParam"]; - /** @description The ID of the `Category` to which the resource belongs. */ - category_id: number; }; }; responses: { @@ -944,8 +952,6 @@ export interface operations { }; path: { category_id: components["parameters"]["CategoryIdParam"]; - /** @description The ID of the `Category` to which the resource belongs. */ - category_id: number; }; }; requestBody: { @@ -1195,8 +1201,6 @@ export interface operations { }; path: { category_id: components["parameters"]["CategoryIdParam"]; - /** @description The ID of the `Category` to which the resource belongs. */ - category_id: number; }; }; responses: { @@ -1239,8 +1243,6 @@ export interface operations { }; path: { category_id: components["parameters"]["CategoryIdParam"]; - /** @description The ID of the `Category` to which the resource belongs. */ - category_id: number; }; }; responses: { @@ -1290,8 +1292,6 @@ export interface operations { }; path: { category_id: components["parameters"]["CategoryIdParam"]; - /** @description The ID of the `Category` to which the resource belongs. */ - category_id: number; }; }; requestBody: { @@ -1362,10 +1362,6 @@ export interface operations { path: { category_id: components["parameters"]["CategoryIdParam"]; metafield_id: components["parameters"]["MetafieldIdParam"]; - /** @description The ID of the `Metafield`. */ - metafield_id: number; - /** @description The ID of the `Category` to which the resource belongs. */ - category_id: number; }; }; responses: { @@ -1418,10 +1414,6 @@ export interface operations { path: { category_id: components["parameters"]["CategoryIdParam"]; metafield_id: components["parameters"]["MetafieldIdParam"]; - /** @description The ID of the `Metafield`. */ - metafield_id: number; - /** @description The ID of the `Category` to which the resource belongs. */ - category_id: number; }; }; requestBody: { @@ -1465,10 +1457,6 @@ export interface operations { path: { category_id: components["parameters"]["CategoryIdParam"]; metafield_id: components["parameters"]["MetafieldIdParam"]; - /** @description The ID of the `Metafield`. */ - metafield_id: number; - /** @description The ID of the `Category` to which the resource belongs. */ - category_id: number; }; }; responses: { @@ -1497,8 +1485,6 @@ export interface operations { }; path: { category_id: components["parameters"]["CategoryIdParam"]; - /** @description The ID of the `Category` to which the resource belongs. */ - category_id: number; }; }; requestBody?: { @@ -1569,8 +1555,6 @@ export interface operations { }; path: { category_id: components["parameters"]["CategoryIdParam"]; - /** @description The ID of the `Category` to which the resource belongs. */ - category_id: number; }; }; responses: { @@ -1600,8 +1584,6 @@ export interface operations { }; path: { category_id: components["parameters"]["CategoryIdParam"]; - /** @description The ID of the `Category` to which the resource belongs. */ - category_id: number; }; }; responses: { @@ -1633,8 +1615,6 @@ export interface operations { }; path: { category_id: components["parameters"]["CategoryIdParam"]; - /** @description The ID of the `Category` to which the resource belongs. */ - category_id: number; }; }; requestBody?: { diff --git a/packages/bigrequest/src/generated/currencies.v2.ts b/packages/bigrequest/src/generated/currencies.v2.ts index d51a21a..ff18a23 100644 --- a/packages/bigrequest/src/generated/currencies.v2.ts +++ b/packages/bigrequest/src/generated/currencies.v2.ts @@ -226,6 +226,12 @@ export interface operations { */ getAllCurrencies: { parameters: { + query?: { + /** @description Specifies the page number in a limited (paginated) list of currencies. */ + page?: number; + /** @description Controls the number of items per page in a limited (paginated) list of currencies. */ + limit?: number; + }; header: { Accept: components["parameters"]["Accept"]; }; diff --git a/packages/bigrequest/src/generated/customers.v3.ts b/packages/bigrequest/src/generated/customers.v3.ts index ad77b35..541c17d 100644 --- a/packages/bigrequest/src/generated/customers.v3.ts +++ b/packages/bigrequest/src/generated/customers.v3.ts @@ -63,7 +63,7 @@ export interface paths { * * attribute_value -- This is input as a string, regardless of the [Type](/docs/rest-management/customers/customer-attributes#create-a-customer-attribute). * * **Limits** - * * Limit of 10 concurrent requests + * * Create 20 customers over the span of an hour. Attempting to make more than 20 API calls will result in a `429` return status until the hour has lapsed. * * **Notes** * @@ -313,7 +313,7 @@ export interface paths { put: operations["CustomersConsentByCustomerId_PUT"]; parameters: { path: { - customerId: string; + customerId: components["parameters"]["customerId"]; }; }; }; @@ -1707,7 +1707,7 @@ export interface operations { * * attribute_value -- This is input as a string, regardless of the [Type](/docs/rest-management/customers/customer-attributes#create-a-customer-attribute). * * **Limits** - * * Limit of 10 concurrent requests + * * Create 20 customers over the span of an hour. Attempting to make more than 20 API calls will result in a `429` return status until the hour has lapsed. * * **Notes** * @@ -2352,7 +2352,6 @@ export interface operations { CustomersConsentByCustomerId_GET: { parameters: { path: { - customerId: string; customerId: components["parameters"]["customerId"]; }; }; @@ -2388,7 +2387,6 @@ export interface operations { "Content-Type"?: string; }; path: { - customerId: string; customerId: components["parameters"]["customerId"]; }; }; diff --git a/packages/bigrequest/src/generated/form_fields.sf.ts b/packages/bigrequest/src/generated/form_fields.sf.ts index 2814ca5..5255ac7 100644 --- a/packages/bigrequest/src/generated/form_fields.sf.ts +++ b/packages/bigrequest/src/generated/form_fields.sf.ts @@ -37,11 +37,11 @@ export interface components { id?: string; /** @description Field name */ name?: string; - /** @description Wether is a custom field or system built-in field. */ + /** @description Whether this is a custom field or system built-in field. */ custom?: boolean; /** @description User-friendly label */ label?: string; - /** @description Wether this field is required or not */ + /** @description Whether this field is required or not */ required?: boolean; /** @description The field unique ID */ default?: string; diff --git a/packages/bigrequest/src/generated/pricing.sf.ts b/packages/bigrequest/src/generated/pricing.sf.ts index 24cc9c1..f57dacf 100644 --- a/packages/bigrequest/src/generated/pricing.sf.ts +++ b/packages/bigrequest/src/generated/pricing.sf.ts @@ -253,7 +253,7 @@ export interface components { sale_price?: { /** @description The price provided by the merchant as entered in their catalog/price list; may include or exclude tax. */ as_entered?: number; - /** @description Determines wether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction. */ + /** @description Determines whether the `as_entered` price is inclusive or exclusive of tax, based on the stores tax jurisdiction. */ entered_inclusive?: boolean; /** @description The estimated tax exclusive price for this product based on the provided customer group. */ tax_exclusive?: number; diff --git a/packages/bigrequest/src/generated/product-modifiers_catalog.v3.ts b/packages/bigrequest/src/generated/product-modifiers_catalog.v3.ts index 9b94c2c..f1e904a 100644 --- a/packages/bigrequest/src/generated/product-modifiers_catalog.v3.ts +++ b/packages/bigrequest/src/generated/product-modifiers_catalog.v3.ts @@ -1055,8 +1055,6 @@ export interface operations { path: { product_id: components["parameters"]["ProductIdParam"]; modifier_id: components["parameters"]["ModifierIdParam"]; - /** @description The ID of the `Modifier`. */ - modifier_id: number; }; }; responses: { @@ -1096,8 +1094,6 @@ export interface operations { path: { product_id: components["parameters"]["ProductIdParam"]; modifier_id: components["parameters"]["ModifierIdParam"]; - /** @description The ID of the `Modifier`. */ - modifier_id: number; }; }; requestBody: { @@ -1531,8 +1527,6 @@ export interface operations { path: { product_id: components["parameters"]["ProductIdParam"]; modifier_id: components["parameters"]["ModifierIdParam"]; - /** @description The ID of the `Modifier`. */ - modifier_id: number; }; }; responses: { diff --git a/packages/bigrequest/src/generated/product-variant-options_catalog.v3.ts b/packages/bigrequest/src/generated/product-variant-options_catalog.v3.ts index 801367c..f4c41f3 100644 --- a/packages/bigrequest/src/generated/product-variant-options_catalog.v3.ts +++ b/packages/bigrequest/src/generated/product-variant-options_catalog.v3.ts @@ -938,8 +938,6 @@ export interface operations { path: { product_id: components["parameters"]["ProductIdParam"]; option_id: components["parameters"]["OptionIdParam"]; - /** @description The ID of the `Option`. */ - option_id: number; }; }; responses: { @@ -982,8 +980,6 @@ export interface operations { path: { product_id: components["parameters"]["ProductIdParam"]; option_id: components["parameters"]["OptionIdParam"]; - /** @description The ID of the `Option`. */ - option_id: number; }; }; requestBody: { @@ -1419,8 +1415,6 @@ export interface operations { path: { product_id: components["parameters"]["ProductIdParam"]; option_id: components["parameters"]["OptionIdParam"]; - /** @description The ID of the `Option`. */ - option_id: number; }; }; responses: { diff --git a/packages/bigrequest/src/generated/product-variants_catalog.v3.ts b/packages/bigrequest/src/generated/product-variants_catalog.v3.ts index 729014e..a55aaca 100644 --- a/packages/bigrequest/src/generated/product-variants_catalog.v3.ts +++ b/packages/bigrequest/src/generated/product-variants_catalog.v3.ts @@ -779,8 +779,6 @@ export interface operations { path: { product_id: components["parameters"]["ProductIdParam"]; variant_id: components["parameters"]["VariantIdParam"]; - /** @description ID of the variant on a product, or on an associated Price List Record. */ - variant_id: number; }; }; responses: { @@ -820,8 +818,6 @@ export interface operations { path: { product_id: components["parameters"]["ProductIdParam"]; variant_id: components["parameters"]["VariantIdParam"]; - /** @description ID of the variant on a product, or on an associated Price List Record. */ - variant_id: number; }; }; requestBody: { @@ -879,8 +875,6 @@ export interface operations { path: { product_id: components["parameters"]["ProductIdParam"]; variant_id: components["parameters"]["VariantIdParam"]; - /** @description ID of the variant on a product, or on an associated Price List Record. */ - variant_id: number; }; }; responses: { @@ -1041,10 +1035,6 @@ export interface operations { product_id: components["parameters"]["ProductIdParam"]; variant_id: components["parameters"]["VariantIdParam"]; metafield_id: components["parameters"]["MetafieldIdParam"]; - /** @description The ID of the `Metafield`. */ - metafield_id: number; - /** @description ID of the variant on a product, or on an associated Price List Record. */ - variant_id: number; }; }; responses: { @@ -1098,10 +1088,6 @@ export interface operations { product_id: components["parameters"]["ProductIdParam"]; variant_id: components["parameters"]["VariantIdParam"]; metafield_id: components["parameters"]["MetafieldIdParam"]; - /** @description The ID of the `Metafield`. */ - metafield_id: number; - /** @description ID of the variant on a product, or on an associated Price List Record. */ - variant_id: number; }; }; requestBody: { @@ -1146,10 +1132,6 @@ export interface operations { product_id: components["parameters"]["ProductIdParam"]; variant_id: components["parameters"]["VariantIdParam"]; metafield_id: components["parameters"]["MetafieldIdParam"]; - /** @description The ID of the `Metafield`. */ - metafield_id: number; - /** @description ID of the variant on a product, or on an associated Price List Record. */ - variant_id: number; }; }; responses: { diff --git a/packages/bigrequest/src/generated/products_catalog.v3.ts b/packages/bigrequest/src/generated/products_catalog.v3.ts index e5b9949..0e63dc2 100644 --- a/packages/bigrequest/src/generated/products_catalog.v3.ts +++ b/packages/bigrequest/src/generated/products_catalog.v3.ts @@ -49,6 +49,7 @@ export interface paths { * * **Limits** * - 250 characters product name length. + * - A product can have up to 1000 images. Each image file or image uploaded by URL can be up to 8 MB. * * **Usage Notes** * * This endpoint accepts a `video` array. To create a product video that accepts a `video` object, see [Create a Product Video](/docs/rest-catalog/products/videos#create-a-product-video) for information. @@ -81,6 +82,9 @@ export interface paths { * Update a Product * @description Updates a *Product*. * + * **Limits** + * - A product can have up to 1000 images. Each image file or image uploaded by URL can be up to 8 MB. + * * **Read-Only Fields** * - id * - date_created @@ -119,9 +123,10 @@ export interface paths { * * **Usage Notes** * - `image_url` - `255` character limit - * - For file uploads, use the `multipart/form-data` media type - * - Only one image at a time can be created + * - For file uploads, use the `multipart/form-data` media type. + * - You can create only one image at a time. A product can have up to 1000 images. * - Supported image file types are BMP, GIF, JPEG, PNG, WBMP, XBM, and WEBP. + * - Each image file or image uploaded by URL can be up to 8 MB. */ post: operations["createProductImage"]; parameters: { @@ -145,6 +150,7 @@ export interface paths { * * **Usage Notes** * - `image_url` - `255` character limit + * - Each image file or image uploaded by URL can be up to 8 MB. * - For file uploads, send a POST request using the `multipart/form-data` media type */ put: operations["updateProductImage"]; @@ -975,7 +981,7 @@ export interface components { * @description Common ProductImage properties. */ productImage_Base: { - /** @description The local path to the original image file uploaded to BigCommerce. Limit of 8MB per file. */ + /** @description The local path to the original image file uploaded to BigCommerce. Limit of 8 MB per file. */ image_file?: string; /** @description Flag for identifying whether the image is used as the product's thumbnail. */ is_thumbnail?: boolean; @@ -2294,6 +2300,7 @@ export interface operations { * * **Limits** * - 250 characters product name length. + * - A product can have up to 1000 images. Each image file or image uploaded by URL can be up to 8 MB. * * **Usage Notes** * * This endpoint accepts a `video` array. To create a product video that accepts a `video` object, see [Create a Product Video](/docs/rest-catalog/products/videos#create-a-product-video) for information. @@ -2483,6 +2490,9 @@ export interface operations { * Update a Product * @description Updates a *Product*. * + * **Limits** + * - A product can have up to 1000 images. Each image file or image uploaded by URL can be up to 8 MB. + * * **Read-Only Fields** * - id * - date_created @@ -2670,9 +2680,10 @@ export interface operations { * * **Usage Notes** * - `image_url` - `255` character limit - * - For file uploads, use the `multipart/form-data` media type - * - Only one image at a time can be created + * - For file uploads, use the `multipart/form-data` media type. + * - You can create only one image at a time. A product can have up to 1000 images. * - Supported image file types are BMP, GIF, JPEG, PNG, WBMP, XBM, and WEBP. + * - Each image file or image uploaded by URL can be up to 8 MB. */ createProductImage: { parameters: { @@ -2716,7 +2727,7 @@ export interface operations { } & { /** @description Must be a fully qualified URL path, including protocol. Limit of 8MB per file. */ image_url?: string; - /** @description Must be sent as a multipart/form-data field in the request body. Limit of 1MB per file. */ + /** @description Must be sent as a multipart/form-data field in the request body. Limit of 8 MB per file. */ image_file?: string; }; "multipart/form-data": { @@ -2751,7 +2762,7 @@ export interface operations { } & { /** @description Must be a fully qualified URL path, including protocol. Limit of 8MB per file. */ image_url?: string; - /** @description Must be sent as a multipart/form-data field in the request body. Limit of 1MB per file. */ + /** @description Must be sent as a multipart/form-data field in the request body. Limit of 8 MB per file. */ image_file?: string; }; }; @@ -2879,8 +2890,6 @@ export interface operations { path: { product_id: components["parameters"]["ProductIdParam"]; image_id: components["parameters"]["ImageIdParam"]; - /** @description The ID of the `Image` that is being operated on. */ - image_id: number; }; }; responses: { @@ -2913,6 +2922,7 @@ export interface operations { * * **Usage Notes** * - `image_url` - `255` character limit + * - Each image file or image uploaded by URL can be up to 8 MB. * - For file uploads, send a POST request using the `multipart/form-data` media type */ updateProductImage: { @@ -2924,8 +2934,6 @@ export interface operations { path: { product_id: components["parameters"]["ProductIdParam"]; image_id: components["parameters"]["ImageIdParam"]; - /** @description The ID of the `Image` that is being operated on. */ - image_id: number; }; }; requestBody: { @@ -3034,8 +3042,6 @@ export interface operations { path: { product_id: components["parameters"]["ProductIdParam"]; image_id: components["parameters"]["ImageIdParam"]; - /** @description The ID of the `Image` that is being operated on. */ - image_id: number; }; }; responses: { @@ -3207,8 +3213,6 @@ export interface operations { path: { product_id: components["parameters"]["ProductIdParam"]; id: components["parameters"]["VideoIdParam"]; - /** @description The BigCommerce ID of the `Video` */ - id: number; }; }; responses: { @@ -3254,8 +3258,6 @@ export interface operations { path: { product_id: components["parameters"]["ProductIdParam"]; id: components["parameters"]["VideoIdParam"]; - /** @description The BigCommerce ID of the `Video` */ - id: number; }; }; requestBody: { @@ -3341,8 +3343,6 @@ export interface operations { path: { product_id: components["parameters"]["ProductIdParam"]; id: components["parameters"]["VideoIdParam"]; - /** @description The BigCommerce ID of the `Video` */ - id: number; }; }; responses: { @@ -3690,8 +3690,6 @@ export interface operations { path: { product_id: components["parameters"]["ProductIdParam"]; complex_rule_id: components["parameters"]["ComplexRuleIdParam"]; - /** @description The ID of the `ComplexRule`. */ - complex_rule_id: number; }; }; responses: { @@ -3858,8 +3856,6 @@ export interface operations { path: { product_id: components["parameters"]["ProductIdParam"]; complex_rule_id: components["parameters"]["ComplexRuleIdParam"]; - /** @description The ID of the `ComplexRule`. */ - complex_rule_id: number; }; }; requestBody: { @@ -4134,8 +4130,6 @@ export interface operations { path: { product_id: components["parameters"]["ProductIdParam"]; complex_rule_id: components["parameters"]["ComplexRuleIdParam"]; - /** @description The ID of the `ComplexRule`. */ - complex_rule_id: number; }; }; responses: { @@ -4323,8 +4317,6 @@ export interface operations { path: { product_id: components["parameters"]["ProductIdParam"]; custom_field_id: components["parameters"]["CustomFieldIdParam"]; - /** @description The ID of the `CustomField`. */ - custom_field_id: number; }; }; responses: { @@ -4370,8 +4362,6 @@ export interface operations { path: { product_id: components["parameters"]["ProductIdParam"]; custom_field_id: components["parameters"]["CustomFieldIdParam"]; - /** @description The ID of the `CustomField`. */ - custom_field_id: number; }; }; requestBody: { @@ -4474,8 +4464,6 @@ export interface operations { path: { product_id: components["parameters"]["ProductIdParam"]; custom_field_id: components["parameters"]["CustomFieldIdParam"]; - /** @description The ID of the `CustomField`. */ - custom_field_id: number; }; }; responses: { @@ -4669,8 +4657,6 @@ export interface operations { path: { product_id: components["parameters"]["ProductIdParam"]; bulk_pricing_rule_id: components["parameters"]["BulkPricingRuleIdParam"]; - /** @description The ID of the `BulkPricingRule`. */ - bulk_pricing_rule_id: number; }; }; responses: { @@ -4719,8 +4705,6 @@ export interface operations { path: { product_id: components["parameters"]["ProductIdParam"]; bulk_pricing_rule_id: components["parameters"]["BulkPricingRuleIdParam"]; - /** @description The ID of the `BulkPricingRule`. */ - bulk_pricing_rule_id: number; }; }; requestBody: { @@ -4833,8 +4817,6 @@ export interface operations { path: { product_id: components["parameters"]["ProductIdParam"]; bulk_pricing_rule_id: components["parameters"]["BulkPricingRuleIdParam"]; - /** @description The ID of the `BulkPricingRule`. */ - bulk_pricing_rule_id: number; }; }; responses: { @@ -4998,8 +4980,6 @@ export interface operations { path: { product_id: components["parameters"]["ProductIdParam"]; metafield_id: components["parameters"]["MetafieldIdParam"]; - /** @description The ID of the `Metafield`. */ - metafield_id: number; }; }; responses: { @@ -5053,8 +5033,6 @@ export interface operations { path: { product_id: components["parameters"]["ProductIdParam"]; metafield_id: components["parameters"]["MetafieldIdParam"]; - /** @description The ID of the `Metafield`. */ - metafield_id: number; }; }; requestBody: { @@ -5098,8 +5076,6 @@ export interface operations { path: { product_id: components["parameters"]["ProductIdParam"]; metafield_id: components["parameters"]["MetafieldIdParam"]; - /** @description The ID of the `Metafield`. */ - metafield_id: number; }; }; responses: { @@ -5328,8 +5304,6 @@ export interface operations { path: { product_id: components["parameters"]["ProductIdParam"]; review_id: components["parameters"]["ReviewIdParam"]; - /** @description The ID of the `review` that is being operated on. */ - review_id: number; }; }; responses: { @@ -5413,8 +5387,6 @@ export interface operations { path: { product_id: components["parameters"]["ProductIdParam"]; review_id: components["parameters"]["ReviewIdParam"]; - /** @description The ID of the `review` that is being operated on. */ - review_id: number; }; }; /** @description A BigCommerce `ProductReview` object. */ @@ -5520,8 +5492,6 @@ export interface operations { path: { product_id: components["parameters"]["ProductIdParam"]; review_id: components["parameters"]["ReviewIdParam"]; - /** @description The ID of the `review` that is being operated on. */ - review_id: number; }; }; responses: { diff --git a/packages/bigrequest/src/generated/settings.v3.ts b/packages/bigrequest/src/generated/settings.v3.ts index a510033..ae98ede 100644 --- a/packages/bigrequest/src/generated/settings.v3.ts +++ b/packages/bigrequest/src/generated/settings.v3.ts @@ -147,6 +147,7 @@ export interface paths { Accept: components["parameters"]["Accept"]; }; path: { + /** @description Web Analytics Provider ID. */ id: number; }; }; diff --git a/packages/bigrequest/src/generated/shipping_provider.ts b/packages/bigrequest/src/generated/shipping_provider.ts index 51f64c3..23bc7ae 100644 --- a/packages/bigrequest/src/generated/shipping_provider.ts +++ b/packages/bigrequest/src/generated/shipping_provider.ts @@ -292,13 +292,16 @@ export interface components { rate_id?: string; /** * Money Value - * @description Value object for a money amount. + * @description Value object for a money amount. Optional field; merchants may request features. */ discounted_cost?: { currency: string; amount: number; }; - /** Format: date */ + /** + * Format: date + * @description Date at which carrier dispatches to the shipping destination. Optional field; merchants may request features. + */ dispatch_date?: string; /** * Transit Time Object @@ -346,13 +349,16 @@ export interface components { rate_id?: string; /** * Money Value - * @description Value object for a money amount. + * @description Value object for a money amount. Optional field; merchants may request features. */ discounted_cost?: { currency: string; amount: number; }; - /** Format: date */ + /** + * Format: date + * @description Date at which carrier dispatches to the shipping destination. Optional field; merchants may request features. + */ dispatch_date?: string; /** * Transit Time Object @@ -507,13 +513,16 @@ export interface components { rate_id?: string; /** * Money Value - * @description Value object for a money amount. + * @description Value object for a money amount. Optional field; merchants may request features. */ discounted_cost?: { currency: string; amount: number; }; - /** Format: date */ + /** + * Format: date + * @description Date at which carrier dispatches to the shipping destination. Optional field; merchants may request features. + */ dispatch_date?: string; /** * Transit Time Object diff --git a/packages/bigrequest/src/generated/themes.v3.ts b/packages/bigrequest/src/generated/themes.v3.ts index 80430ed..3e47656 100644 --- a/packages/bigrequest/src/generated/themes.v3.ts +++ b/packages/bigrequest/src/generated/themes.v3.ts @@ -121,7 +121,6 @@ export interface paths { Accept: components["parameters"]["Accept"]; }; path: { - uuid: string; uuid: components["parameters"]["ThemeIdParam"]; }; }; @@ -145,9 +144,6 @@ export interface paths { header: { Accept: components["parameters"]["Accept"]; }; - path: { - uuid: string; - }; }; }; "/themes/{uuid}/configurations/validate": {