Release/1.1.0

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aligent/bigcommerce-api",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "type": "module",
   "scripts": {
     "test": "tsd",
@@ -47,24 +47,24 @@
   "author": "Aligent",
   "license": "MIT",
   "devDependencies": {
-    "@aligent/ts-code-standards": "^4.0.0",
-    "@types/node": "^22.13.14",
-    "diff": "^8.0.0-beta",
-    "eslint": "^9.25.1",
-    "openapi-typescript": "^7.6.1",
-    "prettier": "^3.5.3",
+    "@aligent/ts-code-standards": "^4.0.2",
+    "@types/node": "^22.16.5",
+    "diff": "^8.0.2",
+    "eslint": "^9.31.0",
+    "openapi-typescript": "^7.8.0",
+    "prettier": "^3.6.2",
     "rimraf": "^6.0.1",
-    "simple-git": "^3.27.0",
+    "simple-git": "^3.28.0",
     "ts-morph": "^26.0.0",
     "tsd": "^0.32.0",
     "tshy": "^3.0.2",
-    "typescript": "^5.8.2",
+    "typescript": "^5.8.3",
     "uuid": "^11.1.0"
   },
   "dependencies": {
-    "form-data": "^4.0.2",
+    "form-data": "^4.0.4",
     "node-fetch": "^3.3.2",
-    "query-string": "^9.1.1"
+    "query-string": "^9.2.2"
   },
   "packageManager": "yarn@4.9.2"
 }

src/internal/reference/generated/catalog/products_catalog.v3.ts

@@ -4637,8 +4637,11 @@ export interface operations {
     readonly updateProduct: {
         readonly parameters: {
             readonly query?: {
-                /** @description Sub-resources to include on a product, in a comma-separated list. If `options` or `modifiers` is used, results are limited to 10 per page. The ID and the specified fields will be returned. */
-                readonly include_fields?: components["parameters"]["IncludeFieldsEnumParam"];
+                /** @description A comma-separated list of sub-resources to return with a product object.
+                 *     When you specify `options` or `modifiers`, results are limited to 10 per page. */
+                readonly include?: components["parameters"]["IncludeParamGetProducts"];
+                /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */
+                readonly include_fields?: components["parameters"]["IncludeFieldsParam"];
             };
             readonly header?: {
                 /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */

src/internal/reference/generated/checkouts.v3.ts

@@ -270,6 +270,27 @@ export interface paths {
          */
         readonly put: operations["updateCheckoutSettings"];
     };
+    readonly "/checkouts/settings/channels/{channelId}": {
+        readonly parameters: {
+            readonly query?: never;
+            readonly path: {
+                readonly channelId: number;
+            };
+            readonly cookie?: never;
+        };
+        /**
+         * Get Channel-Specific Checkout Settings
+         * @description Returns the checkout settings for a given channel (storefront) by channelId.
+         */
+        readonly get: operations["get-channel-checkout-settings"];
+        /**
+         * Update Channel-Specific Checkout Settings
+         * @description Updates the checkout settings for a given channel (storefront) by channelId.
+         *
+         *     This endpoint will update all settings included in the request body. Any settings excluded will remain unchanged. All non-boolean
+         */
+        readonly put: operations["put-channel-checkout-settings"];
+    };
     readonly "/checkouts/{checkoutId}/token": {
         readonly parameters: {
             readonly query?: never;
@@ -1086,6 +1107,19 @@ export interface components {
             readonly custom_checkout_sri_hash?: string;
             readonly custom_order_confirmation_sri_hash?: string;
         };
+        /** Channel-Specific Checkouts Settings */
+        readonly ChannelCheckoutsSettings: {
+            readonly checkout_type?: string;
+            readonly guest_checkout_type?: string;
+            readonly guest_checkout_for_existing_accounts?: string;
+            readonly policy_consent?: string;
+            readonly order_confirmation_contact_email?: string;
+            readonly is_order_terms_and_conditions_enabled?: boolean;
+            readonly order_terms_and_conditions_type?: string;
+            readonly order_terms_and_conditions_link?: string;
+            readonly order_terms_and_conditions_textarea?: string;
+            readonly should_redirect_to_storefront_for_auth?: boolean;
+        } & components["schemas"]["CheckoutsSettings"];
         /** Checkouts settings request */
         readonly CheckoutsSettingsRequest: {
             /** @description Custom checkout script URL to replace our default checkout. To reset a store to optimized one-page checkout, pass an empty string for `custom_checkout_script_url` and `custom_order_confirmation_script_url`. */
@@ -4162,8 +4196,7 @@ export interface operations {
                  *       "cart": {
                  *         "discounts": [
                  *           {
-                 *             "discounted_amount": 10,
-                 *             "name": "manual-discount"
+                 *             "discounted_amount": 10
                  *           }
                  *         ]
                  *       },
@@ -4174,8 +4207,6 @@ export interface operations {
                         readonly discounts?: readonly {
                             /** @example 10 */
                             readonly discounted_amount: number;
-                            /** @example manual */
-                            readonly name?: string;
                         }[];
                         readonly line_items?: readonly {
                             /** @example 8edef915-8e8e-4ebd-bece-31fbb1191a7e */
@@ -12087,6 +12118,74 @@ export interface operations {
             };
         };
     };
+    readonly "get-channel-checkout-settings": {
+        readonly parameters: {
+            readonly query?: never;
+            readonly header?: never;
+            readonly path: {
+                readonly channelId: number;
+            };
+            readonly cookie?: never;
+        };
+        readonly requestBody?: never;
+        readonly responses: {
+            /** @description Channel checkout settings retrieved successfully */
+            readonly 200: {
+                headers: {
+                    readonly [name: string]: unknown;
+                };
+                content: {
+                    readonly "application/json": {
+                        readonly data?: components["schemas"]["ChannelCheckoutsSettings"];
+                        readonly meta?: components["schemas"]["MetaOpen"];
+                    };
+                };
+            };
+            /** @description Invalid channelId or invalid request */
+            readonly 422: {
+                headers: {
+                    readonly [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    readonly "put-channel-checkout-settings": {
+        readonly parameters: {
+            readonly query?: never;
+            readonly header?: never;
+            readonly path: {
+                readonly channelId: number;
+            };
+            readonly cookie?: never;
+        };
+        readonly requestBody?: {
+            readonly content: {
+                readonly "application/json": components["schemas"]["ChannelCheckoutsSettings"];
+            };
+        };
+        readonly responses: {
+            /** @description Channel checkout settings updated successfully */
+            readonly 200: {
+                headers: {
+                    readonly [name: string]: unknown;
+                };
+                content: {
+                    readonly "application/json": {
+                        readonly data?: components["schemas"]["ChannelCheckoutsSettings"];
+                        readonly meta?: components["schemas"]["MetaOpen"];
+                    };
+                };
+            };
+            /** @description Invalid channelId or invalid request */
+            readonly 422: {
+                headers: {
+                    readonly [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     readonly createCheckoutToken: {
         readonly parameters: {
             readonly query?: never;

src/internal/reference/generated/orders.v2.oas2.ts

@@ -170,6 +170,8 @@ export interface paths {
          *
          *     The V2 Orders API will not trigger the typical [Order Email](https://support.bigcommerce.com/s/article/Customizing-Emails?language=en_US) when creating orders. To create an order that does trigger this email, you can instead [create a cart](/docs/rest-management/carts/carts-single#create-a-cart) and [convert that cart into an order](/docs/rest-management/checkouts/checkout-orders#create-an-order).
          *
+         *     If you are building an app that creates orders, it must include your app's ID in the `external_source` field of new orders to be approved for the App Marketplace. See [App Store Approval Requirements](/docs/integrations/apps/guide/requirements#functionality) to learn more.
+         *
          *     > #### Note
          *     > * If historical orders processed on another eCommerce platform are being migrated to BigCommerce, supply the `external_source` field with the code **M-MIG**. This code will exclude the historical orders from the store’s GMV/order count, which factors into pricing.
          */
@@ -1830,7 +1832,11 @@ export interface components {
             readonly id?: number;
             /** @description A read-only value representing the last modification of the order. Do not attempt to modify or set this value in a POST or PUT request. RFC-2822 */
             readonly date_modified?: string;
-            /** @description A read-only value representing the date of shipment. Do not attempt to modify or set this value in a POST or PUT request. RFC-2822 */
+            /**
+             * @description A read-only value representing the date when the order is fully shipped. Do not attempt to modify or set this value in a POST or PUT request. RFC-2822
+             *
+             * @example Wed, 25 Jun 2025 05:22:10 +0000
+             */
             readonly date_shipped?: string;
             /**
              * @description The cart ID from which this order originated, if applicable. Correlates with the Cart API. This is a read-only field; do not set or modify its value in a POST or PUT request.

src/internal/reference/generated/pages.v3.ts

@@ -154,7 +154,7 @@ export interface components {
          *
          */
         readonly PagesCollectionResponse: {
-            readonly data?: readonly (components["schemas"]["typePage"] | components["schemas"]["typeBlog"] | components["schemas"]["typeContactForm"] | components["schemas"]["typeFeed"] | components["schemas"]["typeRaw"] | components["schemas"]["typeLink"])[];
+            readonly data?: readonly (components["schemas"]["typePage"] | components["schemas"]["typeBlog"] | components["schemas"]["typeContactForm"] | components["schemas"]["typeRaw"] | components["schemas"]["typeLink"])[];
             readonly meta?: components["schemas"]["ResponseMeta"];
         };
         /**
@@ -163,7 +163,7 @@ export interface components {
          *
          */
         readonly SinglePageResponse: {
-            readonly data?: components["schemas"]["typePage"] | components["schemas"]["typeBlog"] | components["schemas"]["typeContactForm"] | components["schemas"]["typeFeed"] | components["schemas"]["typeRaw"] | components["schemas"]["typeLink"];
+            readonly data?: components["schemas"]["typePage"] | components["schemas"]["typeBlog"] | components["schemas"]["typeContactForm"] | components["schemas"]["typeRaw"] | components["schemas"]["typeLink"];
             readonly meta?: components["schemas"]["ResponseMeta"];
         };
         /** @description Properties of the page modification request body. */
@@ -205,7 +205,7 @@ export interface components {
              * @example page
              * @enum {string}
              */
-            readonly type?: "page" | "raw" | "contact_form" | "feed" | "link" | "blog";
+            readonly type?: "page" | "raw" | "contact_form" | "link" | "blog";
             /**
              * @description HTML or variable that populates the element of this page, in default/desktop view. Required in a `POST` request if the page type is `raw`.
              *
@@ -221,9 +221,6 @@ export interface components {
             /** @description Applicable when the page type is `contact_form`: contact email address that receives messages sent via the form. Must be unique. */
             readonly email?: string;
             readonly meta_title?: string | null;
-            /** @description The URL of the RSS feed. Required in a `POST` request if the page type is `feed`.
-             *      */
-            readonly feed?: string;
             /** @description Required in a `POST` request to create a link if the page type is `link`.
              *      */
             readonly link?: string;
@@ -300,7 +297,7 @@ export interface components {
              * @example page
              * @enum {string}
              */
-            readonly type: "page" | "raw" | "contact_form" | "feed" | "link" | "blog";
+            readonly type: "page" | "raw" | "contact_form" | "link" | "blog";
             /**
              * @description Determines whether this page loads at the siteʼs root route. For example, at `https://example.com/`.
              * @default false
@@ -358,15 +355,6 @@ export interface components {
              */
             readonly contact_fields?: string;
         };
-        /**
-         * feed
-         * @description `type: feed`.  Makes RSS-syndicated content feeds available in the menu of other pages that contain markup. No page body.
-         */
-        readonly typeFeed: components["schemas"]["anyTypePage"] & components["schemas"]["pageMeta"] & components["schemas"]["searchKeywords"] & {
-            /** @description The URL of the RSS feed. Required in a `POST` request if the page type is `feed`.
-             *      */
-            readonly feed: string;
-        };
         /**
          * raw
          * @description `type: raw`. A user-defined page with a body that contains HTML markup or other stringified code.
@@ -440,7 +428,7 @@ export interface components {
             };
             content: {
                 readonly "application/json": {
-                    readonly data?: components["schemas"]["typePage"] | components["schemas"]["typeBlog"] | components["schemas"]["typeContactForm"] | components["schemas"]["typeFeed"] | components["schemas"]["typeRaw"] | components["schemas"]["typeLink"];
+                    readonly data?: components["schemas"]["typePage"] | components["schemas"]["typeBlog"] | components["schemas"]["typeContactForm"] | components["schemas"]["typeRaw"] | components["schemas"]["typeLink"];
                     readonly meta?: components["schemas"]["ResponseMeta"];
                 };
             };
@@ -606,7 +594,7 @@ export interface operations {
         };
         readonly requestBody: {
             readonly content: {
-                readonly "application/json": (components["schemas"]["typePage"] | components["schemas"]["typeBlog"] | components["schemas"]["typeContactForm"] | components["schemas"]["typeFeed"] | components["schemas"]["typeRaw"] | components["schemas"]["typeLink"]) | readonly (components["schemas"]["typePage"] | components["schemas"]["typeBlog"] | components["schemas"]["typeContactForm"] | components["schemas"]["typeFeed"] | components["schemas"]["typeRaw"] | components["schemas"]["typeLink"])[];
+                readonly "application/json": (components["schemas"]["typePage"] | components["schemas"]["typeBlog"] | components["schemas"]["typeContactForm"] | components["schemas"]["typeRaw"] | components["schemas"]["typeLink"]) | readonly (components["schemas"]["typePage"] | components["schemas"]["typeBlog"] | components["schemas"]["typeContactForm"] | components["schemas"]["typeRaw"] | components["schemas"]["typeLink"])[];
             };
         };
         readonly responses: {

src/internal/reference/generated/payments/access_tokens_payments.v3.ts

@@ -18,10 +18,6 @@ export interface paths {
          * Create Payment Access Token
          * @description Use this endpoint to create a payment access token. A payment access token is required to process payments with the BigCommerce API.
          *
-         *     You can also generate a payment access token during checkout by using the `completeCheckout` mutation in the [GraphQL Storefront API](/docs/storefront/cart-checkout/guide/graphql-storefront#handling-payments).
-         *
-         *     After the token is created, use the token to [Process a payment](/docs/rest-payments/processing#process-payment). The token is valid for one hour.
-         *
          *     **Required Fields**
          *     * order_id
          */