[nightly] generate types against bigcommerce/api-specs@ad4c7e3 (#48)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
matthewvolk · Sep 19, 2023 · 3a38c79 · 3a38c79
1 parent 1b8f685
commit 3a38c79
Show file tree

Hide file tree

Showing 15 changed files with 74 additions and 141 deletions.
diff --git a/.changeset/grumpy-buses-turn.md 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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: {