[nightly] generate types against bigcommerce/docs@f94b794 (#377)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
matthewvolk · Sep 8, 2024 · c5c88a7 · c5c88a7
1 parent 3641965
commit c5c88a7
Show file tree

Hide file tree

Showing 12 changed files with 710 additions and 44 deletions.
diff --git a/.changeset/green-pandas-hug.md b/.changeset/green-pandas-hug.md
@@ -0,0 +1,4 @@
+---
+'bigrequest': patch
+---
+bigcommerce/docs#487, bigcommerce/docs#492, bigcommerce/docs#481, bigcommerce/docs#500, bigcommerce/docs#502, bigcommerce/docs#362, bigcommerce/docs#360, bigcommerce/docs#498, bigcommerce/docs#501
diff --git a/src/generated/carts.sf.ts b/src/generated/carts.sf.ts
@@ -222,7 +222,7 @@ export interface components {
       /** @description Locale of the cart. */
       locale?: string;
       /**
-       * @description The current version of the cart.
+       * @description The current version of the cart increments with each successful update. You can use it to enable optimistic concurrency control for subsequent updates.
        * @example 1
        */
       version?: number;
@@ -304,22 +304,22 @@ export interface components {
     LineItemsRequest: {
       lineItems: components["schemas"]["requestCartPostLineItem"][];
       /**
-       * @description The expected version of the cart.
+       * @description The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply.
        * @example 1
        */
       version?: number;
     } | {
       giftCertificates: components["schemas"]["requestLineItemGiftCertificate"][];
       /**
-       * @description The expected version of the cart.
+       * @description The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply.
        * @example 1
        */
       version?: number;
     } | {
       lineItems: components["schemas"]["requestCartPostLineItem"][];
       giftCertificates: components["schemas"]["requestLineItemGiftCertificate"][];
       /**
-       * @description The expected version of the cart.
+       * @description The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply.
        * @example 1
        */
       version?: number;
@@ -328,29 +328,29 @@ export interface components {
     requestLineItemPut: {
       lineItem: components["schemas"]["requestCartPostLineItem"];
       /**
-       * @description The expected version of the cart.
+       * @description The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply.
        * @example 1
        */
       version?: number;
     } | {
       giftCertificate?: components["schemas"]["requestLineItemGiftCertificate"];
       /**
-       * @description The expected version of the cart.
+       * @description The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply.
        * @example 1
        */
       version?: number;
     } | {
       lineItem: components["schemas"]["requestCartPostLineItem"];
       giftCertificate?: components["schemas"]["requestLineItemGiftCertificate"];
       /**
-       * @description The expected version of the cart.
+       * @description The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply.
        * @example 1
        */
       version?: number;
     };
     requestLineItemDelete: {
       /**
-       * @description The expected version of the cart.
+       * @description The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply.
        * @example 1
        */
       version?: number;

diff --git a/src/generated/carts.v3.ts b/src/generated/carts.v3.ts
@@ -447,7 +447,7 @@ export interface components {
     CartUpdatePutRequestData: {
       customer_id?: number;
       /**
-       * @description The expected version of the cart.
+       * @description The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply.
        * @example 1
        */
       version?: number;
@@ -571,7 +571,7 @@ export interface components {
         };
       };
       /**
-       * @description The current version of the cart.
+       * @description The current version of the cart increments with each successful update. You can use it to enable optimistic concurrency control for subsequent updates.
        * @example 1
        */
       version?: number;
@@ -923,6 +923,11 @@ export interface components {
        * @example true
        */
       is_mutable?: boolean;
+      /**
+       * @description Whether or not a promotion added an additional item.
+       * @example false
+       */
+      added_by_promotion?: boolean;
       /** @description URLs to download all product files. */
       download_file_urls?: string[];
       /**
@@ -1405,14 +1410,14 @@ export interface components {
         })[];
       custom_items?: components["schemas"]["cart_PostCustomItem"];
       /**
-       * @description The expected version of the cart.
+       * @description The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply.
        * @example 1
        */
       version?: number;
     };
     CartLineItemDelete: {
       /**
-       * @description The expected version of the cart.
+       * @description The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply.
        * @example 1
        */
       version?: number;
@@ -1452,7 +1457,7 @@ export interface components {
         })[];
       custom_items?: components["schemas"]["cart_PostCustomItem"];
       /**
-       * @description The expected version of the cart.
+       * @description The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply.
        * @example 1
        */
       version?: number;
@@ -1628,6 +1633,11 @@ export interface components {
        * @example true
        */
       is_mutable?: boolean;
+      /**
+       * @description Whether or not a promotion added an additional item.
+       * @example false
+       */
+      added_by_promotion?: boolean;
       /** @description The gift wrapping details for this item. */
       gift_wrapping?: {
         /** @example Gift Wrap 1 */

diff --git a/src/generated/checkouts.sf.ts b/src/generated/checkouts.sf.ts
@@ -428,7 +428,7 @@ export interface components {
       /** @description `true` value indicates StoreCredit has been applied. */
       isStoreCreditApplied?: boolean;
       /**
-       * @description The current version of the checkout.
+       * @description The current version of the checkout increments with each successful update. You can use it to enable optimistic concurrency control for subsequent updates.
        * @example 1
        */
       version?: number;
@@ -521,7 +521,7 @@ export interface components {
     /** Billing address request */
     BillingAddressRequest: components["schemas"]["address_Base"] & {
       /**
-       * @description The expected version of the checkout.
+       * @description The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply.
        * @example 1
        */
       version?: number;
@@ -593,7 +593,7 @@ export interface components {
     checkout_Put: {
       customerMessage?: string;
       /**
-       * @description The expected version of the checkout.
+       * @description The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply.
        * @example 1
        */
       version?: number;
@@ -1156,23 +1156,23 @@ export interface components {
         pickupMethodId?: number;
       };
       /**
-       * @description The expected version of the checkout.
+       * @description The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply.
        * @example 1
        */
       version?: number;
     };
     /** Delete Coupon Request */
     DeleteCouponCodeRequest: {
       /**
-       * @description The expected version of the checkout.
+       * @description The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply.
        * @example 1
        */
       version?: number;
     };
     /** Delete Consignment Request */
     DeleteConsignmentRequest: {
       /**
-       * @description The expected version of the checkout.
+       * @description The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply.
        * @example 1
        */
       version?: number;
@@ -1229,7 +1229,7 @@ export interface components {
         pickupMethodId?: number;
       };
       /**
-       * @description The expected version of the checkout.
+       * @description The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply.
        * @example 1
        */
       version?: number;
@@ -2108,7 +2108,7 @@ export interface operations {
         "application/json": {
           couponCode?: string;
           /**
-           * @description The expected version of the checkout.
+           * @description The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply.
            * @example 1
            */
           version?: number;

diff --git a/src/generated/checkouts.v3.ts b/src/generated/checkouts.v3.ts
@@ -383,6 +383,11 @@ export interface components {
               extended_comparison_price?: number;
               is_require_shipping?: boolean;
               is_mutable?: boolean;
+              /**
+               * @description Whether or not a promotion added an additional item.
+               * @example false
+               */
+              added_by_promotion?: boolean;
               parent_id?: number | null;
               /** Gift Wrapping */
               gift_wrapping?: {
@@ -411,6 +416,11 @@ export interface components {
               url?: string;
               is_mutable?: boolean;
               is_require_shipping?: boolean;
+              /**
+               * @description Whether or not a promotion added an additional item.
+               * @example false
+               */
+              added_by_promotion?: boolean;
               is_taxable?: boolean;
               image_url?: string;
               discounts?: {
@@ -688,7 +698,7 @@ export interface components {
             }[];
         }[];
       /**
-       * @description The current version of the checkout.
+       * @description The current version of the checkout increments with each successful update. You can use it to enable optimistic concurrency control for subsequent updates.
        * @example 1
        */
       version?: number;
@@ -697,7 +707,7 @@ export interface components {
     Checkout_Put: {
       customer_message: string;
       /**
-       * @description The expected version of the checkout.
+       * @description The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply.
        * @example 1
        */
       version?: number;
@@ -748,7 +758,7 @@ export interface components {
           field_value?: string;
         }[];
       /**
-       * @description The expected version of the checkout.
+       * @description The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply.
        * @example 1
        */
       version?: number;
@@ -790,15 +800,15 @@ export interface components {
           pickup_method_id?: number;
         };
         /**
-         * @description The expected version of the checkout.
+         * @description The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply.
          * @example 1
          */
         version?: number;
       }[];
     /** Delete Consignment Request */
     DeleteConsignmentRequest: {
       /**
-       * @description The expected version of the checkout.
+       * @description The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply.
        * @example 1
        */
       version?: number;
@@ -847,7 +857,7 @@ export interface components {
         description?: string;
       };
       /**
-       * @description The expected version of the checkout.
+       * @description The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply.
        * @example 1
        */
       version?: number;
@@ -857,15 +867,15 @@ export interface components {
       /** @description Coupon codes have a 50-character limit. */
       coupon_code?: string;
       /**
-       * @description The expected version of the checkout.
+       * @description The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply.
        * @example 1
        */
       version?: number;
     };
     /** Delete Coupon Request */
     DeleteCouponCodeRequest: {
       /**
-       * @description The expected version of the checkout.
+       * @description The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply.
        * @example 1
        */
       version?: number;
@@ -1132,7 +1142,7 @@ export interface operations {
                 discounted_amount?: number;
               }[];
             /**
-             * @description The expected version of the checkout.
+             * @description The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply.
              * @example 1
              */
             version?: number;

diff --git a/src/generated/orders.v2.oas2.ts b/src/generated/orders.v2.oas2.ts
@@ -1755,19 +1755,19 @@ export interface components {
       coupon_discount?: string;
       /** @description The number of shipping addresses associated with this transaction. A read-only value. Do not pass in a POST or PUT. */
       shipping_address_count?: number;
+      /**
+       * @description Indicates whether the order is deleted/archived. When set to true in a PUT request, it has the same result as the DELETE an order request.
+       * @example false
+       */
+      is_deleted?: boolean;
       /**
        * @description Indicates whether the shopper has selected an opt-in check box (on the checkout page) to receive emails. A read-only value. Do not pass in a POST or PUT.
        * @example false
        */
       is_email_opt_in?: boolean;
       /**
-       * @description The `order_source` is set upon order creation and reflects the origin of the order. It will indicate whether the order was created by one of the following:
-       * * storefront
-       * * control panel
-       * * manual order
-       * * /v2/orders API
-       * * Checkout API
-       * * or by an integration with an external platform such as Facebook by Meta or Amazon.
+       * @description Reflects the origin of the order. It can affect the order’s icon and source as defined in the control panel listing.
+       * Allowed values: `www` (Desktop) | `iphone` (Iphone) | `ipad` (Ipad) | `android` (Android) | `mobile` (Mobile) | `manual` (manual order) | `external` (Orders API) | `checkout_api` (Checkout API) | `buybutton` (Buy Button) | `amazon` (Amazon) | `ebay` (Ebay) | `facebookshop` (Facebook Shop) | `facebookcheckout` (Facebook Checkout) | `facebookmarketplace` (Facebook Marketplace) | `pinterest` (Pinterest) | `socialshop` (Social Shop)
        */
       order_source?: string;
       consignments?: components["schemas"]["orderConsignments_Resource"];