[nightly] generate types against bigcommerce/docs@a5aa6ef (#491)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
matthewvolk · Dec 28, 2024 · ae85b1f · ae85b1f
1 parent 27412e0
commit ae85b1f
Show file tree

Hide file tree

Showing 28 changed files with 1,591 additions and 280 deletions.
diff --git a/.changeset/mighty-birds-cough.md b/.changeset/mighty-birds-cough.md
@@ -0,0 +1,5 @@
+---
+'bigrequest': patch
+---
+
+bigcommerce/docs#717, bigcommerce/docs#720, bigcommerce/docs#719, bigcommerce/docs#718, bigcommerce/docs#613, bigcommerce/docs#711, bigcommerce/docs#681, bigcommerce/docs#642, bigcommerce/docs#709, bigcommerce/docs#707, bigcommerce/docs#708, bigcommerce/docs#706, bigcommerce/docs#622, bigcommerce/docs#704, bigcommerce/docs#701, bigcommerce/docs#630
diff --git a/src/generated/carts.sf.ts b/src/generated/carts.sf.ts
@@ -671,7 +671,7 @@ export interface components {
       /** @description Quantity of this item. */
       quantity: number;
       /** @description ID of the variant. */
-      variantId: number;
+      variantId?: number;
       optionSelections?: ({
           /**
            * @description Modifier option ID.

diff --git a/src/generated/carts.v3.ts b/src/generated/carts.v3.ts
@@ -53,7 +53,7 @@ export interface paths {
      *
      * To add a custom item use `custom_items`.
      *
-     * Overriding a product’s `list_price` will make that item ineligible for V3 product level promotions.
+     * By default, overriding a product's list_price makes it ineligible for V3 product-level promotions. In **Store Settings** under **Promotions and Coupons** in the control panel, you can change this behavior to allow promotions on overridden prices.
      *
      * If a product has modifiers, omit the `variant_id` and instead use the `option_selections` array to describe both the **variant** and the **modifier** selections.
      *
@@ -77,6 +77,7 @@ export interface paths {
      *
      * **Usage Notes**
      *
+     * * To use redirect URLs, first create the cart using the REST Management API or GraphQL Storefront API.
      * * Redirect URLs can also be created with **Create a Cart** requests by appending `include=redirect_urls`.
      * * A **Carts** redirect URL is valid for 30 days and may only be used once.
      * * Redirect URLs point to either a shared checkout domain or a channel-specific domain, depending on the storefront configuration.
@@ -103,7 +104,7 @@ export interface paths {
      *
      * **Notes**
      *
-     * Currently, only updating `list_price` and `quantity` are supported. Updating a product’s `list_price` will make that item ineligible for V3 product-level promotions.
+     * Currently, only updating `list_price` and `quantity` are supported. By default, overriding a product's list_price makes it ineligible for V3 product-level promotions. In **Store Settings** under **Promotions and Coupons** in the control panel, you can change this behavior to allow promotions on overridden prices.
      *
      * If the product has modifiers, omit the `variant_id` and instead use the `option_selections` array to describe both the **variant** and the **modifier** selections.
      *
@@ -1263,6 +1264,11 @@ export interface components {
        * @description The discounted amount applied within a given context.
        */
       discounted_amount?: number;
+      /**
+       * @description Display name of the coupon.
+       * @example 20% Off
+       */
+      display_name?: string;
     };
     /** Applied Discount */
     AppliedDiscount: {
@@ -2141,7 +2147,7 @@ export interface operations {
    *
    * To add a custom item use `custom_items`.
    *
-   * Overriding a product’s `list_price` will make that item ineligible for V3 product level promotions.
+   * By default, overriding a product's list_price makes it ineligible for V3 product-level promotions. In **Store Settings** under **Promotions and Coupons** in the control panel, you can change this behavior to allow promotions on overridden prices.
    *
    * If a product has modifiers, omit the `variant_id` and instead use the `option_selections` array to describe both the **variant** and the **modifier** selections.
    *
@@ -2181,6 +2187,7 @@ export interface operations {
    *
    * **Usage Notes**
    *
+   * * To use redirect URLs, first create the cart using the REST Management API or GraphQL Storefront API.
    * * Redirect URLs can also be created with **Create a Cart** requests by appending `include=redirect_urls`.
    * * A **Carts** redirect URL is valid for 30 days and may only be used once.
    * * Redirect URLs point to either a shared checkout domain or a channel-specific domain, depending on the storefront configuration.
@@ -2222,7 +2229,7 @@ export interface operations {
    *
    * **Notes**
    *
-   * Currently, only updating `list_price` and `quantity` are supported. Updating a product’s `list_price` will make that item ineligible for V3 product-level promotions.
+   * Currently, only updating `list_price` and `quantity` are supported. By default, overriding a product's list_price makes it ineligible for V3 product-level promotions. In **Store Settings** under **Promotions and Coupons** in the control panel, you can change this behavior to allow promotions on overridden prices.
    *
    * If the product has modifiers, omit the `variant_id` and instead use the `option_selections` array to describe both the **variant** and the **modifier** selections.
    *

diff --git a/src/generated/categories_catalog.v3.ts b/src/generated/categories_catalog.v3.ts
@@ -222,6 +222,9 @@ export interface paths {
      * Get Product Sort Order
      * @description Returns a list of products and their sort order for a specific category.
      *
+     * **Limits**
+     * * page=2&limit=250 will return page 2 of the results with 250 items per page.
+     *
      * **Usage Notes**
      * * Data pairs are displayed in ascending order based on products' `sort_order` values.
      * * `null` values are allowed for products without specified `sort_order` values.
@@ -238,6 +241,9 @@ export interface paths {
      */
     put: operations["updateCategorySortOrders"];
     parameters: {
+      query?: {
+        page?: components["parameters"]["PageParam"];
+      };
       header: {
         Accept: components["parameters"]["Accept"];
       };
@@ -2094,6 +2100,9 @@ export interface operations {
    * Get Product Sort Order
    * @description Returns a list of products and their sort order for a specific category.
    *
+   * **Limits**
+   * * page=2&limit=250 will return page 2 of the results with 250 items per page.
+   *
    * **Usage Notes**
    * * Data pairs are displayed in ascending order based on products' `sort_order` values.
    * * `null` values are allowed for products without specified `sort_order` values.
@@ -2105,6 +2114,9 @@ export interface operations {
    */
   getCategorySortOrders: {
     parameters: {
+      query?: {
+        page?: components["parameters"]["PageParam"];
+      };
       header: {
         Accept: components["parameters"]["Accept"];
       };
@@ -2115,7 +2127,10 @@ export interface operations {
     responses: {
       200: {
         content: {
-          "application/json": components["schemas"]["productSortOrder"][];
+          "application/json": {
+            data?: components["schemas"]["productSortOrder"][];
+            meta?: components["schemas"]["metaCollection_Full"];
+          };
         };
       };
       401: components["responses"]["UnauthorizedError"];
@@ -2134,6 +2149,9 @@ export interface operations {
    */
   updateCategorySortOrders: {
     parameters: {
+      query?: {
+        page?: components["parameters"]["PageParam"];
+      };
       header: {
         Accept: components["parameters"]["Accept"];
         "Content-Type": components["parameters"]["ContentType"];

diff --git a/src/generated/channels.v3.ts b/src/generated/channels.v3.ts
@@ -2244,6 +2244,12 @@ export interface operations {
     };
     responses: {
       200: components["responses"]["channel_menus_Resp"];
+      /** @description Unprocessable entity (The following fields are invalid.) */
+      422: {
+        content: {
+          "application/json": components["schemas"]["ErrorResponse"];
+        };
+      };
     };
   };
   /**

diff --git a/src/generated/checkouts.sf.ts b/src/generated/checkouts.sf.ts
@@ -132,8 +132,11 @@ export interface paths {
      * @description Adds a new *Consignment* to *Checkout*.
      *
      * Perform the following two steps to define the fulfillment of the items in the cart.
-     * ### For **shipping** consignments:
+     *
+     * ### For shipping consignments:
+     *
      *   1. Add a new Consignment to Checkout.
+     *
      *       * Send a `POST` request to `/consignments` with each shipping address, line item IDs, and quantities. Each address can have its own line item IDs.
      *       * Provide a full valid customer address before placing the order. If provided, the order placement will succeed.
      *       * As part of the request URL make sure to add `include=consignments.availableShippingOptions` to return the available shipping options based on the items, the address, and the shipping location. This will return `availableShippingOptions` in the response.
@@ -144,8 +147,10 @@ export interface paths {
      *
      *   2. Update the Consignment with Shipping Options using the [REST Storefront API](/docs/rest-storefront/checkouts/checkout-consignments#update-a-consignment), the [REST Management API](/docs/rest-management/checkouts/checkout-consignments#update-checkout-consignment) or the [GraphQL Storefront API](/docs/storefront/cart-checkout/guide/graphql-storefront).
      *
-     * ### For **pickup** consignments:
-     *   1. Create a new consignment object.
+     * ### For pickup consignments:
+     *
+     *   Create a new consignment object.
+     *
      *       - Send a `POST` request to `/consignments` with line item IDs and quantities.
      *       - Provide a `pickupMethodId`. This is the `id` of the Pickup Method provided in the response body of the Storefront Pickup Options API.
      *       - Required Fields:
@@ -389,6 +394,8 @@ export interface components {
       consignments?: components["schemas"]["consignment_Full"][];
       /** @description Coupons applied at the checkout level. */
       coupons?: components["schemas"]["CheckoutCoupon"][];
+      /** @description Fees applied at the checkout level. */
+      fees?: components["schemas"]["CheckoutFee"][];
       /** @description Time when the cart was created. */
       createdTime?: string;
       customer?: components["schemas"]["Customer"];
@@ -464,7 +471,7 @@ export interface components {
       id?: number;
       /** @description the coupon code */
       code: string;
-      /** @description The coupon title based on different types provided in control panel section. */
+      /** @description The coupon name displayed on the storefront. */
       displayName?: string;
       /**
        * @description Key name to identify the type of coupon.
@@ -483,7 +490,7 @@ export interface components {
       id?: number;
       /** @description the coupon code */
       code: string;
-      /** @description The coupon title based on different types provided in control panel section. */
+      /** @description The coupon name displayed on the storefront. */
       displayName?: string;
       /**
        * @description |Type `int`|Type Name|
@@ -502,6 +509,45 @@ export interface components {
        */
       discountedAmount?: number;
     };
+    /** Checkout Fee */
+    CheckoutFee: {
+      /**
+       * Format: uuid
+       * @description The fee ID.
+       * @example 497f6eca-6276-4993-bfeb-53cbbbba6f08
+       */
+      id?: string;
+      /**
+       * @description The type of the fee.
+       * @enum {string}
+       */
+      type?: "custom_fee";
+      /**
+       * @description Name of the fee.
+       * @example AAINS
+       */
+      name?: string;
+      /**
+       * @description Display name of the fee targeting customers/shoppers.
+       * @example Package Protection Insurance
+       */
+      displayName?: string;
+      /**
+       * @description Cost of the fee (include or exclude tax dependent on tax settings, same as shipping cost).
+       * @example 10
+       */
+      cost?: number;
+      /**
+       * @description The source of the request.
+       * @example AA
+       */
+      source?: string;
+      /**
+       * @description The tax class ID.
+       * @example 1
+       */
+      taxClassId?: number;
+    };
     /** @description Customer details. */
     Customer: {
       addresses?: {
@@ -910,7 +956,7 @@ export interface components {
         customItems?: {
             /** @description ID of the custom item. */
             id?: string;
-            /** @description Price of the item. With or without tax depending on your store setup. */
+            /** @description The net item price before discounts and coupons. BigCommerce derives an item's list price from the product default price or, if applicable, the sale price configured in the admin panel. */
             listPrice?: string;
             /** @description Item name. */
             name?: string;
@@ -1015,7 +1061,7 @@ export interface components {
       isTaxable?: boolean;
       /**
        * Format: double
-       * @description The item’s list price, as quoted by the manufacturer or distributor.
+       * @description The net item price before discounts and coupons. BigCommerce derives an item's list price from the product default price or, if applicable, the sale price configured in the admin panel.
        */
       listPrice?: number;
       /** @description The itemʼs product name. */
@@ -1408,8 +1454,11 @@ export interface operations {
    * @description Adds a new *Consignment* to *Checkout*.
    *
    * Perform the following two steps to define the fulfillment of the items in the cart.
-   * ### For **shipping** consignments:
+   *
+   * ### For shipping consignments:
+   *
    *   1. Add a new Consignment to Checkout.
+   *
    *       * Send a `POST` request to `/consignments` with each shipping address, line item IDs, and quantities. Each address can have its own line item IDs.
    *       * Provide a full valid customer address before placing the order. If provided, the order placement will succeed.
    *       * As part of the request URL make sure to add `include=consignments.availableShippingOptions` to return the available shipping options based on the items, the address, and the shipping location. This will return `availableShippingOptions` in the response.
@@ -1420,8 +1469,10 @@ export interface operations {
    *
    *   2. Update the Consignment with Shipping Options using the [REST Storefront API](/docs/rest-storefront/checkouts/checkout-consignments#update-a-consignment), the [REST Management API](/docs/rest-management/checkouts/checkout-consignments#update-checkout-consignment) or the [GraphQL Storefront API](/docs/storefront/cart-checkout/guide/graphql-storefront).
    *
-   * ### For **pickup** consignments:
-   *   1. Create a new consignment object.
+   * ### For pickup consignments:
+   *
+   *   Create a new consignment object.
+   *
    *       - Send a `POST` request to `/consignments` with line item IDs and quantities.
    *       - Provide a `pickupMethodId`. This is the `id` of the Pickup Method provided in the response body of the Storefront Pickup Options API.
    *       - Required Fields: