[nightly] generate types against bigcommerce/api-specs@0acf5ff (#122)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
matthewvolk · Dec 6, 2023 · 43ad6d0 · 43ad6d0
1 parent 0e50eeb
commit 43ad6d0
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 25 deletions.
diff --git a/.changeset/green-carrots-cough.md b/.changeset/green-carrots-cough.md
@@ -0,0 +1,5 @@
+---
+"bigrequest": patch
+---
+
+Adds `.html` to template strings for gift certificates (bigcommerce/api-specs#1529). Cart product option value identifiers can be either string or number (bigcommerce/api-specs#1528). Changes `options` to `option_selections` for cart API (bigcommerce/api-specs#1530). Remove the `X-Strict-Mode` header from the price list records upsert endpoint (bigcommerce/api-specs#1532).
diff --git a/packages/bigrequest/src/generated/carts.v3.ts b/packages/bigrequest/src/generated/carts.v3.ts
@@ -279,7 +279,7 @@ export interface components {
          * @description The theme of the gift certificate.
          * @enum {string}
          */
-        theme: "Birthday" | "Boy" | "Celebration" | "Christmas" | "General" | "Girl";
+        theme: "birthday.html" | "boy.html" | "celebration.html" | "christmas.html" | "general.html" | "girl.html";
         amount: number;
         quantity: number;
         /** Contact Entity */
@@ -308,7 +308,7 @@ export interface components {
            * @description The theme of the gift certificate.
            * @enum {string}
            */
-          theme: "Birthday" | "Boy" | "Celebration" | "Christmas" | "General" | "Girl";
+          theme: "birthday.html" | "boy.html" | "celebration.html" | "christmas.html" | "general.html" | "girl.html";
           amount: number;
           quantity: number;
           /** Contact Entity */
@@ -361,7 +361,7 @@ export interface components {
            * @description The theme of the gift certificate.
            * @enum {string}
            */
-          theme: "Birthday" | "Boy" | "Celebration" | "Christmas" | "General" | "Girl";
+          theme: "birthday.html" | "boy.html" | "celebration.html" | "christmas.html" | "general.html" | "girl.html";
           amount: number;
           quantity: number;
           /** Contact Entity */
@@ -409,7 +409,7 @@ export interface components {
        * @description The theme of the gift certificate.
        * @enum {string}
        */
-      theme: "Birthday" | "Boy" | "Celebration" | "Christmas" | "General" | "Girl";
+      theme: "birthday.html" | "boy.html" | "celebration.html" | "christmas.html" | "general.html" | "girl.html";
       amount: number;
       quantity: number;
       /** Contact Entity */
@@ -533,7 +533,7 @@ export interface components {
        * @description The theme of the gift certificate.
        * @enum {string}
        */
-      theme: "Birthday" | "Boy" | "Celebration" | "Christmas" | "General" | "Girl";
+      theme: "birthday.html" | "boy.html" | "celebration.html" | "christmas.html" | "general.html" | "girl.html";
       /** @description Value must be between 1.00 and 1,000.00 in the store’s default currency. */
       amount: number;
       is_taxable?: boolean;
@@ -555,7 +555,7 @@ export interface components {
       id?: string;
       /** @description Name provided for the gift certificate that will appear in the control panel. */
       name?: string;
-      /** @description The theme of the gift certificate. The following options are available:`Birthday`, `Boy`, `Celebration`, `Christmas`, `General`, and `Girl`. */
+      /** @description The theme of the gift certificate. The following options are available:`birthday.html`, `boy.html`, `celebration.html`, `christmas.html`, `general.html`, and `girl.html`. */
       theme?: string;
       /** @description Value must be between 1.00 and 1,000.00 in the store’s default currency. */
       amount?: number;
@@ -1307,7 +1307,7 @@ export interface components {
            * @description The theme of the gift certificate.
            * @enum {string}
            */
-          theme: "Birthday" | "Boy" | "Celebration" | "Christmas" | "General" | "Girl";
+          theme: "birthday.html" | "boy.html" | "celebration.html" | "christmas.html" | "general.html" | "girl.html";
           amount: number;
           quantity: number;
           /** Contact Entity */
@@ -1335,7 +1335,7 @@ export interface components {
            * @description The theme of the gift certificate.
            * @enum {string}
            */
-          theme: "Birthday" | "Boy" | "Celebration" | "Christmas" | "General" | "Girl";
+          theme: "birthday.html" | "boy.html" | "celebration.html" | "christmas.html" | "general.html" | "girl.html";
           amount: number;
           quantity: number;
           /** Contact Entity */
@@ -1533,19 +1533,19 @@ export interface components {
       /** @description Sale price of the item multiplied by the quantity. */
       extended_sale_price?: number;
       /** @description The list of selected options for this product. */
-      options?: {
+      options?: ({
           /** @description The product option name; for example, Color or Size. */
           name?: string;
-          /** @description The product option identifier. */
+          /**
+           * @description The product option identifier.
+           * @example 151
+           */
           nameId?: number;
           /** @description The product option value; for example, Red or Medium. */
           value?: string;
-          /**
-           * @description The product option value identifier in number format.
-           * @example 128
-           */
-          valueId?: number;
-        }[];
+          /** @description The product option value identifier in number format. */
+          valueId?: number | string;
+        })[];
       /** @description The gift wrapping details for this item. */
       gift_wrapping?: {
         /** @example Gift Wrap 1 */
@@ -1689,7 +1689,7 @@ export interface components {
     };
     /** @description Response payload for the BigCommerce API. */
     MetaFieldCollectionResponse: {
-      data?: Record<string, never>;
+      data?: components["schemas"]["Metafield"];
       meta?: components["schemas"]["CollectionMeta"];
     };
     /**

diff --git a/packages/bigrequest/src/generated/marketing.v2.ts b/packages/bigrequest/src/generated/marketing.v2.ts
@@ -513,10 +513,10 @@ export interface components {
       expiry_date?: string;
       /**
        * @description The email theme to use in the message sent to the recipient.
-       * @example Celebration
+       * @example celebration.html
        * @enum {string}
        */
-      template?: "Birthday" | "Girl" | "Boy" | "Celebration" | "Christmas" | "General";
+      template?: "birthday.html" | "girl.html" | "boy.html" | "celebration.html" | "christmas.html" | "general.html";
       /**
        * @description Text that will be sent to the recipient, such as “Congratulations.”
        * @example Congratulations!
@@ -565,10 +565,10 @@ export interface components {
       customer_id?: number;
       /**
        * @description The email theme to use in the message sent to the recipient.
-       * @example Celebration
+       * @example celebration.html
        * @enum {string}
        */
-      template?: "Birthday" | "Boy" | "Girl" | "Celebration" | "Christmas" | "General";
+      template?: "birthday.html" | "boy.html" | "girl.html" | "celebration.html" | "christmas.html" | "general.html";
       /**
        * @description Text that will be sent to the recipient, such as “Congratulations.”
        * @example Congratulations!
@@ -617,10 +617,10 @@ export interface components {
       customer_id?: number;
       /**
        * @description The email theme to use in the message sent to the recipient.
-       * @example Celebration
+       * @example celebration.html
        * @enum {string}
        */
-      template?: "Birthday" | "Boy" | "Girl" | "Celebration" | "Christmas" | "General";
+      template?: "birthday.html" | "boy.html" | "girl.html" | "celebration.html" | "christmas.html" | "general.html";
       /**
        * @description Text that will be sent to the recipient, such as “Congratulations.”
        * @example Congratulations!

diff --git a/packages/bigrequest/src/generated/price_lists.v3.ts b/packages/bigrequest/src/generated/price_lists.v3.ts
@@ -1241,8 +1241,6 @@ export interface operations {
     parameters: {
       header: {
         Accept: components["parameters"]["Accept"];
-        /** @description Header that determines whether the Batch API operates in strict mode or not. Strict mode will reject the entire request if any item in the batch has an error. */
-        "X-Strict-Mode"?: number;
         "Content-Type": components["parameters"]["ContentType"];
       };
       path: {