Merge pull request #25 from aligent/release/1.1.2

Release/1.1.2

Author: kai-nguyen-aligent

docs/changelog/1.1.1.md

@@ -0,0 +1,200 @@
+# Interface Change Summary: 1.1.1
+
+## Modified files
+### `carts.v3.ts`
+
+components.schemas.cart_PostCustomItem:
+```diff
++             readonly image_url?: string;
+```
+
+### `catalog/product_variants_catalog.v3.ts`
+
+components.parameters:
+```diff
++         readonly MetafieldResourceParam: string;
+```
+
+operations.getProductVariantMetafields.parameters.query:
+```diff
++                 readonly "resource_id:in"?: components["parameters"]["MetafieldResourceParam"];
+```
+
+### `catalog/products_catalog.v3.ts`
+
+components.parameters:
+```diff
++         readonly MetafieldResourceParam: string;
++         readonly CustomFieldsIncludeFieldsParam: readonly ("name" | "value")[];
++         readonly CustomFieldsExcludeFieldsParam: readonly ("name" | "value")[];
+```
+
+operations.getProductCustomFields.parameters.query:
+```diff
+-                 readonly include_fields?: components["parameters"]["IncludeFieldsParam"];
++                 readonly include_fields?: components["parameters"]["CustomFieldsIncludeFieldsParam"];
+-                 readonly exclude_fields?: components["parameters"]["ExcludeFieldsParam"];
++                 readonly exclude_fields?: components["parameters"]["CustomFieldsExcludeFieldsParam"];
+```
+
+operations.getProductCustomField.parameters.query:
+```diff
+-                 readonly include_fields?: components["parameters"]["IncludeFieldsParam"];
++                 readonly include_fields?: components["parameters"]["CustomFieldsIncludeFieldsParam"];
+-                 readonly exclude_fields?: components["parameters"]["ExcludeFieldsParam"];
++                 readonly exclude_fields?: components["parameters"]["CustomFieldsExcludeFieldsParam"];
+```
+
+operations.getProductMetafields.parameters.query:
+```diff
++                 readonly "resource_id:in"?: components["parameters"]["MetafieldResourceParam"];
+```
+
+### `marketing.v2.ts`
+
+operations.getGiftCertificates.parameters.query:
+```diff
++                 readonly sort?: "id";
++                 readonly direction?: "asc" | "desc";
+```
+
+### `orders.sf.ts`
+
+components.schemas.Order:
+```diff
++             readonly comparisonShippingCost?: number;
+```
+
+components.schemas.ShippingConsignment:
+```diff
++             readonly shippingCostBeforeDiscount?: number;
++             readonly comparisonShippingCost?: number;
+```
+
+### `orders.v2.oas2.ts`
+
+components.schemas.orderTaxes_Base:
+```diff
++             readonly sales_tax_id?: string;
+```
+
+components.schemas.order_RespOnly:
+```diff
+-             readonly consignments?: components["schemas"]["orderConsignments_Resource"];
++             readonly consignments?: components["schemas"]["orderConsignments_Resource"] | components["schemas"]["orderConsignment_Get"];
+```
+
+components.schemas.giftCertificateConsignment_Get:
+```diff
+-             readonly line_items?: readonly components["schemas"]["products_Resource"][];
++             readonly line_items?: readonly components["schemas"]["products_Resource"][] | readonly components["schemas"]["orderProducts"][];
+```
+
+components.schemas.pickupConsignment_Get:
+```diff
+-             readonly line_items?: readonly components["schemas"]["products_Resource"][];
++             readonly line_items?: readonly components["schemas"]["products_Resource"][] | readonly components["schemas"]["orderProducts"][];
+```
+
+components.schemas.shippingConsignment_Get:
+```diff
+-             readonly line_items?: readonly components["schemas"]["products_Resource"][];
++             readonly line_items?: readonly components["schemas"]["products_Resource"][] | readonly components["schemas"]["orderProducts"][];
+```
+
+components.schemas.digitalConsignment_Get:
+```diff
+-             readonly line_items?: readonly components["schemas"]["products_Resource"][];
++             readonly line_items?: readonly components["schemas"]["products_Resource"][] | readonly components["schemas"]["orderProducts"][];
+```
+
+### `orders.v3.ts`
+
+components.schemas.MerchantOverride:
+```diff
+-             readonly total_amount: components["schemas"]["Amount"];
++             readonly total_amount: number;
+```
+
+components.schemas.RefundQuote_ItemsRefund:
+```diff
+-             readonly merchant_calculated_override?: components["schemas"]["MerchantOverride"];
+```
+
+components.schemas.RefundQuote_TaxAdjustmentAmount:
+```diff
+-             readonly merchant_calculated_override?: components["schemas"]["MerchantOverride"];
+```
+
+### `promotions.v3.ts`
+
+components.schemas.PatchCouponPromotion:
+```diff
++             readonly coupon_type?: "SINGLE" | "BULK";
+```
+
+components.schemas.DraftCouponPromotion:
+```diff
++             readonly coupon_type: "SINGLE" | "BULK";
+```
+
+components.schemas.SavedCouponPromotion:
+```diff
++             readonly coupon_type: "SINGLE" | "BULK";
+```
+
+components.schemas:
+```diff
++         readonly ErrorResponse405: {
++             readonly status?: string;
++             readonly title?: string;
++             readonly error?: string;
++         };
+```
+
+operations.createPromotionCode.responses:
+```diff
+-             readonly 200: components["responses"]["PromotionCodeResponse"];
++             readonly 201: components["responses"]["PromotionCodeResponse"];
+```
+
+operations.generatePromotionCodesBatch.responses:
+```diff
++             readonly 405: {
++                 headers: {
++                     readonly [name: string]: unknown;
++                 };
++                 content: {
++                     readonly "application/json": components["schemas"]["ErrorResponse405"];
++                 };
++             };
+```
+
+### `store_logs.v3.ts`
+
+operations.getStoreSystemLogs.parameters.query:
+```diff
++                 readonly sort?: "date_created" | "type";
++                 readonly direction?: "asc" | "desc";
+```
+
+### `storefront_tokens.v3.ts`
+
+components.schemas:
+```diff
+-         } & (components["schemas"]["Channels"] | components["schemas"]["Channel"]);
++         } & components["schemas"]["Channels"] & components["schemas"]["Channel"];
+```
+
+components.schemas.Channel:
+```diff
+-             readonly channel_id: number;
++             readonly channel_id?: number;
+```
+
+components.schemas.Channels:
+```diff
+-             readonly channel_ids: readonly number[];
++             readonly channel_ids?: readonly number[];
+```
+

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aligent/bigcommerce-api",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "type": "module",
   "scripts": {
     "test": "tsd",

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

@@ -51,9 +51,11 @@ export interface paths {
                 readonly Accept: components["parameters"]["Accept"];
             };
             readonly path: {
-                /** @description Unique cart `UUID`.
+                /**
+                 * @description Unique cart `UUID`.
                  *
-                 *     Unique cart `UUID` token that is generated for abandoned cart emails. */
+                 *     Unique cart `UUID` token that is generated for abandoned cart emails.
+                 */
                 readonly token: string;
             };
             readonly cookie?: never;
@@ -83,11 +85,9 @@ export interface components {
             /**
              * Format: int32
              * @description The HTTP status code
-             *
              */
             readonly status?: number;
-            /** @description The error title describing the particular error
-             *      */
+            /** @description The error title describing the particular error */
             readonly title?: string;
             readonly type?: string;
         };
@@ -202,8 +202,10 @@ export interface components {
                 readonly "application/json": components["schemas"]["errorDetailed_Full"];
             };
         };
-        /** @description Malformed request syntax. Typically need to fix the JSON
-         *     Body to resend successfully. */
+        /**
+         * @description Malformed request syntax. Typically need to fix the JSON
+         *     Body to resend successfully.
+         */
         readonly "400_BadRequest": {
             headers: {
                 readonly [name: string]: unknown;
@@ -433,9 +435,11 @@ export interface operations {
                 readonly Accept?: components["parameters"]["Accept"];
             };
             readonly path: {
-                /** @description Unique cart `UUID`.
+                /**
+                 * @description Unique cart `UUID`.
                  *
-                 *     Unique cart `UUID` token that is generated for abandoned cart emails. */
+                 *     Unique cart `UUID` token that is generated for abandoned cart emails.
+                 */
                 readonly token: string;
             };
             readonly cookie?: never;