ultracart_rest_api_v2_typescript 4.1.97 → 4.1.98

package/.openapi-generator/FILES

@@ -338,6 +338,7 @@ src/models/CountriesResponse.ts
 src/models/Country.ts
 src/models/Coupon.ts
 src/models/CouponAmountOffItems.ts
+src/models/CouponAmountOffItemsAndFreeShipping.ts
 src/models/CouponAmountOffShipping.ts
 src/models/CouponAmountOffShippingWithItemsPurchase.ts
 src/models/CouponAmountOffSubtotal.ts

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.97
+## ultracart_rest_api_v2_typescript@4.1.98
 
 Every API method call has a sample for every language SDK.  See https://github.com/UltraCart/sdk_samples
 
 Installation
 
 ```
-npm install ultracart_rest_api_v2_typescript@4.1.97 --save
+npm install ultracart_rest_api_v2_typescript@4.1.98 --save
 ```
 
 ```typescript
@@ -85,6 +85,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.98 | 06/04/2026 | coupon - new coupon type for amount off items with free shipping |
 | 4.1.97 | 06/03/2026 | fraud api alpha version |
 | 4.1.96 | 06/03/2026 | fraud api alpha build |
 | 4.1.95 | 06/02/2026 | fraud api alpha version |

package/dist/models/Coupon.d.ts

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import { CouponAmountOffItems } from './CouponAmountOffItems';
+import { CouponAmountOffItemsAndFreeShipping } from './CouponAmountOffItemsAndFreeShipping';
 import { CouponAmountOffShipping } from './CouponAmountOffShipping';
 import { CouponAmountOffShippingWithItemsPurchase } from './CouponAmountOffShippingWithItemsPurchase';
 import { CouponAmountOffSubtotal } from './CouponAmountOffSubtotal';
@@ -83,6 +84,12 @@ export interface Coupon {
      * @memberof Coupon
      */
     amount_off_items?: CouponAmountOffItems;
+    /**
+     *
+     * @type {CouponAmountOffItemsAndFreeShipping}
+     * @memberof Coupon
+     */
+    amount_off_items_and_free_shipping?: CouponAmountOffItemsAndFreeShipping;
     /**
      *
      * @type {CouponAmountOffShipping}

package/dist/models/Coupon.js

@@ -16,6 +16,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CouponToJSON = exports.CouponFromJSONTyped = exports.CouponFromJSON = exports.instanceOfCoupon = exports.CouponUsableByEnum = void 0;
 var runtime_1 = require("../runtime");
 var CouponAmountOffItems_1 = require("./CouponAmountOffItems");
+var CouponAmountOffItemsAndFreeShipping_1 = require("./CouponAmountOffItemsAndFreeShipping");
 var CouponAmountOffShipping_1 = require("./CouponAmountOffShipping");
 var CouponAmountOffShippingWithItemsPurchase_1 = require("./CouponAmountOffShippingWithItemsPurchase");
 var CouponAmountOffSubtotal_1 = require("./CouponAmountOffSubtotal");
@@ -95,6 +96,7 @@ function CouponFromJSONTyped(json, ignoreDiscriminator) {
         'affiliate_oid': !(0, runtime_1.exists)(json, 'affiliate_oid') ? undefined : json['affiliate_oid'],
         'allow_multiple_one_time_codes': !(0, runtime_1.exists)(json, 'allow_multiple_one_time_codes') ? undefined : json['allow_multiple_one_time_codes'],
         'amount_off_items': !(0, runtime_1.exists)(json, 'amount_off_items') ? undefined : (0, CouponAmountOffItems_1.CouponAmountOffItemsFromJSON)(json['amount_off_items']),
+        'amount_off_items_and_free_shipping': !(0, runtime_1.exists)(json, 'amount_off_items_and_free_shipping') ? undefined : (0, CouponAmountOffItemsAndFreeShipping_1.CouponAmountOffItemsAndFreeShippingFromJSON)(json['amount_off_items_and_free_shipping']),
         'amount_off_shipping': !(0, runtime_1.exists)(json, 'amount_off_shipping') ? undefined : (0, CouponAmountOffShipping_1.CouponAmountOffShippingFromJSON)(json['amount_off_shipping']),
         'amount_off_shipping_with_items_purchase': !(0, runtime_1.exists)(json, 'amount_off_shipping_with_items_purchase') ? undefined : (0, CouponAmountOffShippingWithItemsPurchase_1.CouponAmountOffShippingWithItemsPurchaseFromJSON)(json['amount_off_shipping_with_items_purchase']),
         'amount_off_subtotal': !(0, runtime_1.exists)(json, 'amount_off_subtotal') ? undefined : (0, CouponAmountOffSubtotal_1.CouponAmountOffSubtotalFromJSON)(json['amount_off_subtotal']),
@@ -174,6 +176,7 @@ function CouponToJSON(value) {
         'affiliate_oid': value.affiliate_oid,
         'allow_multiple_one_time_codes': value.allow_multiple_one_time_codes,
         'amount_off_items': (0, CouponAmountOffItems_1.CouponAmountOffItemsToJSON)(value.amount_off_items),
+        'amount_off_items_and_free_shipping': (0, CouponAmountOffItemsAndFreeShipping_1.CouponAmountOffItemsAndFreeShippingToJSON)(value.amount_off_items_and_free_shipping),
         'amount_off_shipping': (0, CouponAmountOffShipping_1.CouponAmountOffShippingToJSON)(value.amount_off_shipping),
         'amount_off_shipping_with_items_purchase': (0, CouponAmountOffShippingWithItemsPurchase_1.CouponAmountOffShippingWithItemsPurchaseToJSON)(value.amount_off_shipping_with_items_purchase),
         'amount_off_subtotal': (0, CouponAmountOffSubtotal_1.CouponAmountOffSubtotalToJSON)(value.amount_off_subtotal),

package/dist/models/CouponAmountOffItemsAndFreeShipping.d.ts

@@ -0,0 +1,61 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CouponAmountOffItemsAndFreeShipping
+ */
+export interface CouponAmountOffItemsAndFreeShipping {
+    /**
+     * The ISO-4217 three letter currency code the customer is viewing prices in
+     * @type {string}
+     * @memberof CouponAmountOffItemsAndFreeShipping
+     */
+    currency_code?: string;
+    /**
+     * The amount of discount
+     * @type {number}
+     * @memberof CouponAmountOffItemsAndFreeShipping
+     */
+    discount_amount?: number;
+    /**
+     * An optional list of item tags which will receive a discount.
+     * @type {Array<string>}
+     * @memberof CouponAmountOffItemsAndFreeShipping
+     */
+    item_tags?: Array<string>;
+    /**
+     * A list of items which are eligible for the discount amount.
+     * @type {Array<string>}
+     * @memberof CouponAmountOffItemsAndFreeShipping
+     */
+    items?: Array<string>;
+    /**
+     * The limit of items which are eligible for the discount amount.
+     * @type {number}
+     * @memberof CouponAmountOffItemsAndFreeShipping
+     */
+    limit?: number;
+    /**
+     * One or more shipping methods that may be used with this coupon.  If not specified or empty, methods that are marked as qualifies for free shipping will be the only free methods
+     * @type {Array<string>}
+     * @memberof CouponAmountOffItemsAndFreeShipping
+     */
+    shipping_methods?: Array<string>;
+}
+/**
+ * Check if a given object implements the CouponAmountOffItemsAndFreeShipping interface.
+ */
+export declare function instanceOfCouponAmountOffItemsAndFreeShipping(value: object): boolean;
+export declare function CouponAmountOffItemsAndFreeShippingFromJSON(json: any): CouponAmountOffItemsAndFreeShipping;
+export declare function CouponAmountOffItemsAndFreeShippingFromJSONTyped(json: any, ignoreDiscriminator: boolean): CouponAmountOffItemsAndFreeShipping;
+export declare function CouponAmountOffItemsAndFreeShippingToJSON(value?: CouponAmountOffItemsAndFreeShipping | null): any;

package/dist/models/CouponAmountOffItemsAndFreeShipping.js

@@ -0,0 +1,60 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CouponAmountOffItemsAndFreeShippingToJSON = exports.CouponAmountOffItemsAndFreeShippingFromJSONTyped = exports.CouponAmountOffItemsAndFreeShippingFromJSON = exports.instanceOfCouponAmountOffItemsAndFreeShipping = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * Check if a given object implements the CouponAmountOffItemsAndFreeShipping interface.
+ */
+function instanceOfCouponAmountOffItemsAndFreeShipping(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfCouponAmountOffItemsAndFreeShipping = instanceOfCouponAmountOffItemsAndFreeShipping;
+function CouponAmountOffItemsAndFreeShippingFromJSON(json) {
+    return CouponAmountOffItemsAndFreeShippingFromJSONTyped(json, false);
+}
+exports.CouponAmountOffItemsAndFreeShippingFromJSON = CouponAmountOffItemsAndFreeShippingFromJSON;
+function CouponAmountOffItemsAndFreeShippingFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'currency_code': !(0, runtime_1.exists)(json, 'currency_code') ? undefined : json['currency_code'],
+        'discount_amount': !(0, runtime_1.exists)(json, 'discount_amount') ? undefined : json['discount_amount'],
+        'item_tags': !(0, runtime_1.exists)(json, 'item_tags') ? undefined : json['item_tags'],
+        'items': !(0, runtime_1.exists)(json, 'items') ? undefined : json['items'],
+        'limit': !(0, runtime_1.exists)(json, 'limit') ? undefined : json['limit'],
+        'shipping_methods': !(0, runtime_1.exists)(json, 'shipping_methods') ? undefined : json['shipping_methods'],
+    };
+}
+exports.CouponAmountOffItemsAndFreeShippingFromJSONTyped = CouponAmountOffItemsAndFreeShippingFromJSONTyped;
+function CouponAmountOffItemsAndFreeShippingToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'currency_code': value.currency_code,
+        'discount_amount': value.discount_amount,
+        'item_tags': value.item_tags,
+        'items': value.items,
+        'limit': value.limit,
+        'shipping_methods': value.shipping_methods,
+    };
+}
+exports.CouponAmountOffItemsAndFreeShippingToJSON = CouponAmountOffItemsAndFreeShippingToJSON;

package/dist/models/index.d.ts

@@ -310,6 +310,7 @@ export * from './CountriesResponse';
 export * from './Country';
 export * from './Coupon';
 export * from './CouponAmountOffItems';
+export * from './CouponAmountOffItemsAndFreeShipping';
 export * from './CouponAmountOffShipping';
 export * from './CouponAmountOffShippingWithItemsPurchase';
 export * from './CouponAmountOffSubtotal';

package/dist/models/index.js

@@ -328,6 +328,7 @@ __exportStar(require("./CountriesResponse"), exports);
 __exportStar(require("./Country"), exports);
 __exportStar(require("./Coupon"), exports);
 __exportStar(require("./CouponAmountOffItems"), exports);
+__exportStar(require("./CouponAmountOffItemsAndFreeShipping"), exports);
 __exportStar(require("./CouponAmountOffShipping"), exports);
 __exportStar(require("./CouponAmountOffShippingWithItemsPurchase"), exports);
 __exportStar(require("./CouponAmountOffSubtotal"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "4.1.97",
+  "version": "4.1.98",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "repository": {

package/src/models/Coupon.ts

@@ -19,6 +19,12 @@ import {
     CouponAmountOffItemsFromJSONTyped,
     CouponAmountOffItemsToJSON,
 } from './CouponAmountOffItems';
+import {
+    CouponAmountOffItemsAndFreeShipping,
+    CouponAmountOffItemsAndFreeShippingFromJSON,
+    CouponAmountOffItemsAndFreeShippingFromJSONTyped,
+    CouponAmountOffItemsAndFreeShippingToJSON,
+} from './CouponAmountOffItemsAndFreeShipping';
 import {
     CouponAmountOffShipping,
     CouponAmountOffShippingFromJSON,
@@ -338,6 +344,12 @@ export interface Coupon {
      * @memberof Coupon
      */
     amount_off_items?: CouponAmountOffItems;
+    /**
+     * 
+     * @type {CouponAmountOffItemsAndFreeShipping}
+     * @memberof Coupon
+     */
+    amount_off_items_and_free_shipping?: CouponAmountOffItemsAndFreeShipping;
     /**
      * 
      * @type {CouponAmountOffShipping}
@@ -767,6 +779,7 @@ export function CouponFromJSONTyped(json: any, ignoreDiscriminator: boolean): Co
         'affiliate_oid': !exists(json, 'affiliate_oid') ? undefined : json['affiliate_oid'],
         'allow_multiple_one_time_codes': !exists(json, 'allow_multiple_one_time_codes') ? undefined : json['allow_multiple_one_time_codes'],
         'amount_off_items': !exists(json, 'amount_off_items') ? undefined : CouponAmountOffItemsFromJSON(json['amount_off_items']),
+        'amount_off_items_and_free_shipping': !exists(json, 'amount_off_items_and_free_shipping') ? undefined : CouponAmountOffItemsAndFreeShippingFromJSON(json['amount_off_items_and_free_shipping']),
         'amount_off_shipping': !exists(json, 'amount_off_shipping') ? undefined : CouponAmountOffShippingFromJSON(json['amount_off_shipping']),
         'amount_off_shipping_with_items_purchase': !exists(json, 'amount_off_shipping_with_items_purchase') ? undefined : CouponAmountOffShippingWithItemsPurchaseFromJSON(json['amount_off_shipping_with_items_purchase']),
         'amount_off_subtotal': !exists(json, 'amount_off_subtotal') ? undefined : CouponAmountOffSubtotalFromJSON(json['amount_off_subtotal']),
@@ -847,6 +860,7 @@ export function CouponToJSON(value?: Coupon | null): any {
         'affiliate_oid': value.affiliate_oid,
         'allow_multiple_one_time_codes': value.allow_multiple_one_time_codes,
         'amount_off_items': CouponAmountOffItemsToJSON(value.amount_off_items),
+        'amount_off_items_and_free_shipping': CouponAmountOffItemsAndFreeShippingToJSON(value.amount_off_items_and_free_shipping),
         'amount_off_shipping': CouponAmountOffShippingToJSON(value.amount_off_shipping),
         'amount_off_shipping_with_items_purchase': CouponAmountOffShippingWithItemsPurchaseToJSON(value.amount_off_shipping_with_items_purchase),
         'amount_off_subtotal': CouponAmountOffSubtotalToJSON(value.amount_off_subtotal),

package/src/models/CouponAmountOffItemsAndFreeShipping.ts

@@ -0,0 +1,107 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface CouponAmountOffItemsAndFreeShipping
+ */
+export interface CouponAmountOffItemsAndFreeShipping {
+    /**
+     * The ISO-4217 three letter currency code the customer is viewing prices in
+     * @type {string}
+     * @memberof CouponAmountOffItemsAndFreeShipping
+     */
+    currency_code?: string;
+    /**
+     * The amount of discount
+     * @type {number}
+     * @memberof CouponAmountOffItemsAndFreeShipping
+     */
+    discount_amount?: number;
+    /**
+     * An optional list of item tags which will receive a discount.
+     * @type {Array<string>}
+     * @memberof CouponAmountOffItemsAndFreeShipping
+     */
+    item_tags?: Array<string>;
+    /**
+     * A list of items which are eligible for the discount amount.
+     * @type {Array<string>}
+     * @memberof CouponAmountOffItemsAndFreeShipping
+     */
+    items?: Array<string>;
+    /**
+     * The limit of items which are eligible for the discount amount.
+     * @type {number}
+     * @memberof CouponAmountOffItemsAndFreeShipping
+     */
+    limit?: number;
+    /**
+     * One or more shipping methods that may be used with this coupon.  If not specified or empty, methods that are marked as qualifies for free shipping will be the only free methods
+     * @type {Array<string>}
+     * @memberof CouponAmountOffItemsAndFreeShipping
+     */
+    shipping_methods?: Array<string>;
+}
+
+
+
+/**
+ * Check if a given object implements the CouponAmountOffItemsAndFreeShipping interface.
+ */
+export function instanceOfCouponAmountOffItemsAndFreeShipping(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function CouponAmountOffItemsAndFreeShippingFromJSON(json: any): CouponAmountOffItemsAndFreeShipping {
+    return CouponAmountOffItemsAndFreeShippingFromJSONTyped(json, false);
+}
+
+export function CouponAmountOffItemsAndFreeShippingFromJSONTyped(json: any, ignoreDiscriminator: boolean): CouponAmountOffItemsAndFreeShipping {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'currency_code': !exists(json, 'currency_code') ? undefined : json['currency_code'],
+        'discount_amount': !exists(json, 'discount_amount') ? undefined : json['discount_amount'],
+        'item_tags': !exists(json, 'item_tags') ? undefined : json['item_tags'],
+        'items': !exists(json, 'items') ? undefined : json['items'],
+        'limit': !exists(json, 'limit') ? undefined : json['limit'],
+        'shipping_methods': !exists(json, 'shipping_methods') ? undefined : json['shipping_methods'],
+    };
+}
+
+export function CouponAmountOffItemsAndFreeShippingToJSON(value?: CouponAmountOffItemsAndFreeShipping | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'currency_code': value.currency_code,
+        'discount_amount': value.discount_amount,
+        'item_tags': value.item_tags,
+        'items': value.items,
+        'limit': value.limit,
+        'shipping_methods': value.shipping_methods,
+    };
+}
+

package/src/models/index.ts

@@ -312,6 +312,7 @@ export * from './CountriesResponse';
 export * from './Country';
 export * from './Coupon';
 export * from './CouponAmountOffItems';
+export * from './CouponAmountOffItemsAndFreeShipping';
 export * from './CouponAmountOffShipping';
 export * from './CouponAmountOffShippingWithItemsPurchase';
 export * from './CouponAmountOffSubtotal';