ultracart_rest_api_v2_typescript 3.10.154 → 3.10.156

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.10.154
+## ultracart_rest_api_v2_typescript@3.10.156
 
 This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install ultracart_rest_api_v2_typescript@3.10.154 --save
+npm install ultracart_rest_api_v2_typescript@3.10.156 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.156 | 08/31/2023 | new coupon - free item and free shipping with purchase |
+| 3.10.155 | 08/16/2023 | added validate_original_order query param to auto order update method |
 | 3.10.154 | 08/14/2023 | esp - add require_order_within_last to the settings object |
 | 3.10.153 | 08/14/2023 | esp - expose rate limiter values in settings object |
 | 3.10.152 | 07/27/2023 | dw bi - add settings to the report and page objects |

package/api.ts

@@ -9625,6 +9625,12 @@ export interface Coupon {
      * @memberof Coupon
      */
     free_item_with_item_purchase?: CouponFreeItemWithItemPurchase;
+    /**
+     * 
+     * @type {CouponFreeItemWithItemPurchaseAndFreeShipping}
+     * @memberof Coupon
+     */
+    free_item_with_item_purchase_and_free_shipping?: CouponFreeItemWithItemPurchaseAndFreeShipping;
     /**
      * 
      * @type {CouponFreeItemWithSubtotal}
@@ -10651,6 +10657,38 @@ export interface CouponFreeItemWithItemPurchase {
     required_purchase_items?: Array<string>;
 }
 
+/**
+ * 
+ * @export
+ * @interface CouponFreeItemWithItemPurchaseAndFreeShipping
+ */
+export interface CouponFreeItemWithItemPurchaseAndFreeShipping {
+    /**
+     * A list of free items which will receive a discount if one of the required purchase items is purchased.
+     * @type {Array<string>}
+     * @memberof CouponFreeItemWithItemPurchaseAndFreeShipping
+     */
+    items?: Array<string>;
+    /**
+     * The (optional) maximum quantity of discounted items.  Free shipping will apply to all units of the free item ids though.
+     * @type {number}
+     * @memberof CouponFreeItemWithItemPurchaseAndFreeShipping
+     */
+    limit?: number;
+    /**
+     * If true then the free item is matched 1:1 with the free item in the list.
+     * @type {boolean}
+     * @memberof CouponFreeItemWithItemPurchaseAndFreeShipping
+     */
+    match_required_purchase_item_to_free_item?: boolean;
+    /**
+     * Required items (at least one from the list) that must be purchased for coupon to be valid
+     * @type {Array<string>}
+     * @memberof CouponFreeItemWithItemPurchaseAndFreeShipping
+     */
+    required_purchase_items?: Array<string>;
+}
+
 /**
  * 
  * @export
@@ -12109,6 +12147,12 @@ export interface Customer {
      * @memberof Customer
      */
     privacy?: CustomerPrivacy;
+    /**
+     * Properties for this customer
+     * @type {Array<CustomerProperty>}
+     * @memberof Customer
+     */
+    properties?: Array<CustomerProperty>;
     /**
      * QuickBooks class to import this customer as
      * @type {string}
@@ -13081,6 +13125,32 @@ export interface CustomerPrivacy {
     statistics?: boolean;
 }
 
+/**
+ * 
+ * @export
+ * @interface CustomerProperty
+ */
+export interface CustomerProperty {
+    /**
+     * The date/time that the property expires and is deleted
+     * @type {string}
+     * @memberof CustomerProperty
+     */
+    expiration_dts?: string;
+    /**
+     * Name
+     * @type {string}
+     * @memberof CustomerProperty
+     */
+    name?: string;
+    /**
+     * Value
+     * @type {string}
+     * @memberof CustomerProperty
+     */
+    value?: string;
+}
+
 /**
  * 
  * @export
@@ -41519,11 +41589,12 @@ export const AutoOrderApiFetchParamCreator = function (configuration?: Configura
          * @summary Update an auto order
          * @param {AutoOrder} auto_order Auto order to update
          * @param {number} auto_order_oid The auto order oid to update.
+         * @param {string} [validate_original_order] Validate original order before updating
          * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        updateAutoOrder(auto_order: AutoOrder, auto_order_oid: number, _expand?: string, options: any = {}): FetchArgs {
+        updateAutoOrder(auto_order: AutoOrder, auto_order_oid: number, validate_original_order?: string, _expand?: string, options: any = {}): FetchArgs {
             // verify required parameter 'auto_order' is not null or undefined
             if (auto_order === null || auto_order === undefined) {
                 throw new RequiredError('auto_order','Required parameter auto_order was null or undefined when calling updateAutoOrder.');
@@ -41562,6 +41633,10 @@ export const AutoOrderApiFetchParamCreator = function (configuration?: Configura
                 localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
             }
 
+            if (validate_original_order !== undefined) {
+                localVarQueryParameter['validate_original_order'] = validate_original_order;
+            }
+
             if (_expand !== undefined) {
                 localVarQueryParameter['_expand'] = _expand;
             }
@@ -41842,12 +41917,13 @@ export const AutoOrderApiFp = function(configuration?: Configuration) {
          * @summary Update an auto order
          * @param {AutoOrder} auto_order Auto order to update
          * @param {number} auto_order_oid The auto order oid to update.
+         * @param {string} [validate_original_order] Validate original order before updating
          * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        updateAutoOrder(auto_order: AutoOrder, auto_order_oid: number, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<AutoOrderResponse> {
-            const localVarFetchArgs = AutoOrderApiFetchParamCreator(configuration).updateAutoOrder(auto_order, auto_order_oid, _expand, options);
+        updateAutoOrder(auto_order: AutoOrder, auto_order_oid: number, validate_original_order?: string, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<AutoOrderResponse> {
+            const localVarFetchArgs = AutoOrderApiFetchParamCreator(configuration).updateAutoOrder(auto_order, auto_order_oid, validate_original_order, _expand, options);
             return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
                 return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
 
@@ -41999,12 +42075,13 @@ export const AutoOrderApiFactory = function (configuration?: Configuration, fetc
          * @summary Update an auto order
          * @param {AutoOrder} auto_order Auto order to update
          * @param {number} auto_order_oid The auto order oid to update.
+         * @param {string} [validate_original_order] Validate original order before updating
          * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        updateAutoOrder(auto_order: AutoOrder, auto_order_oid: number, _expand?: string, options?: any) {
-            return AutoOrderApiFp(configuration).updateAutoOrder(auto_order, auto_order_oid, _expand, options)(fetch, basePath);
+        updateAutoOrder(auto_order: AutoOrder, auto_order_oid: number, validate_original_order?: string, _expand?: string, options?: any) {
+            return AutoOrderApiFp(configuration).updateAutoOrder(auto_order, auto_order_oid, validate_original_order, _expand, options)(fetch, basePath);
         },
         /**
          * Update multiple auto orders on the UltraCart account. 
@@ -42134,12 +42211,13 @@ export interface AutoOrderApiInterface {
      * @summary Update an auto order
      * @param {AutoOrder} auto_order Auto order to update
      * @param {number} auto_order_oid The auto order oid to update.
+     * @param {string} [validate_original_order] Validate original order before updating
      * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AutoOrderApiInterface
      */
-    updateAutoOrder(auto_order: AutoOrder, auto_order_oid: number, _expand?: string, options?: any): Promise<AutoOrderResponse>;
+    updateAutoOrder(auto_order: AutoOrder, auto_order_oid: number, validate_original_order?: string, _expand?: string, options?: any): Promise<AutoOrderResponse>;
 
     /**
      * Update multiple auto orders on the UltraCart account. 
@@ -42283,13 +42361,14 @@ export class AutoOrderApi extends BaseAPI implements AutoOrderApiInterface {
      * @summary Update an auto order
      * @param {AutoOrder} auto_order Auto order to update
      * @param {number} auto_order_oid The auto order oid to update.
+     * @param {string} [validate_original_order] Validate original order before updating
      * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AutoOrderApi
      */
-    public updateAutoOrder(auto_order: AutoOrder, auto_order_oid: number, _expand?: string, options?: any) {
-        return AutoOrderApiFp(this.configuration).updateAutoOrder(auto_order, auto_order_oid, _expand, options)(this.fetch, this.basePath);
+    public updateAutoOrder(auto_order: AutoOrder, auto_order_oid: number, validate_original_order?: string, _expand?: string, options?: any) {
+        return AutoOrderApiFp(this.configuration).updateAutoOrder(auto_order, auto_order_oid, validate_original_order, _expand, options)(this.fetch, this.basePath);
     }
 
     /**

package/dist/api.d.ts

@@ -9395,6 +9395,12 @@ export interface Coupon {
      * @memberof Coupon
      */
     free_item_with_item_purchase?: CouponFreeItemWithItemPurchase;
+    /**
+     *
+     * @type {CouponFreeItemWithItemPurchaseAndFreeShipping}
+     * @memberof Coupon
+     */
+    free_item_with_item_purchase_and_free_shipping?: CouponFreeItemWithItemPurchaseAndFreeShipping;
     /**
      *
      * @type {CouponFreeItemWithSubtotal}
@@ -10396,6 +10402,37 @@ export interface CouponFreeItemWithItemPurchase {
      */
     required_purchase_items?: Array<string>;
 }
+/**
+ *
+ * @export
+ * @interface CouponFreeItemWithItemPurchaseAndFreeShipping
+ */
+export interface CouponFreeItemWithItemPurchaseAndFreeShipping {
+    /**
+     * A list of free items which will receive a discount if one of the required purchase items is purchased.
+     * @type {Array<string>}
+     * @memberof CouponFreeItemWithItemPurchaseAndFreeShipping
+     */
+    items?: Array<string>;
+    /**
+     * The (optional) maximum quantity of discounted items.  Free shipping will apply to all units of the free item ids though.
+     * @type {number}
+     * @memberof CouponFreeItemWithItemPurchaseAndFreeShipping
+     */
+    limit?: number;
+    /**
+     * If true then the free item is matched 1:1 with the free item in the list.
+     * @type {boolean}
+     * @memberof CouponFreeItemWithItemPurchaseAndFreeShipping
+     */
+    match_required_purchase_item_to_free_item?: boolean;
+    /**
+     * Required items (at least one from the list) that must be purchased for coupon to be valid
+     * @type {Array<string>}
+     * @memberof CouponFreeItemWithItemPurchaseAndFreeShipping
+     */
+    required_purchase_items?: Array<string>;
+}
 /**
  *
  * @export
@@ -11809,6 +11846,12 @@ export interface Customer {
      * @memberof Customer
      */
     privacy?: CustomerPrivacy;
+    /**
+     * Properties for this customer
+     * @type {Array<CustomerProperty>}
+     * @memberof Customer
+     */
+    properties?: Array<CustomerProperty>;
     /**
      * QuickBooks class to import this customer as
      * @type {string}
@@ -12763,6 +12806,31 @@ export interface CustomerPrivacy {
      */
     statistics?: boolean;
 }
+/**
+ *
+ * @export
+ * @interface CustomerProperty
+ */
+export interface CustomerProperty {
+    /**
+     * The date/time that the property expires and is deleted
+     * @type {string}
+     * @memberof CustomerProperty
+     */
+    expiration_dts?: string;
+    /**
+     * Name
+     * @type {string}
+     * @memberof CustomerProperty
+     */
+    name?: string;
+    /**
+     * Value
+     * @type {string}
+     * @memberof CustomerProperty
+     */
+    value?: string;
+}
 /**
  *
  * @export
@@ -40048,11 +40116,12 @@ export declare const AutoOrderApiFetchParamCreator: (configuration?: Configurati
      * @summary Update an auto order
      * @param {AutoOrder} auto_order Auto order to update
      * @param {number} auto_order_oid The auto order oid to update.
+     * @param {string} [validate_original_order] Validate original order before updating
      * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    updateAutoOrder(auto_order: AutoOrder, auto_order_oid: number, _expand?: string, options?: any): FetchArgs;
+    updateAutoOrder(auto_order: AutoOrder, auto_order_oid: number, validate_original_order?: string, _expand?: string, options?: any): FetchArgs;
     /**
      * Update multiple auto orders on the UltraCart account.
      * @summary Update multiple auto orders
@@ -40162,11 +40231,12 @@ export declare const AutoOrderApiFp: (configuration?: Configuration) => {
      * @summary Update an auto order
      * @param {AutoOrder} auto_order Auto order to update
      * @param {number} auto_order_oid The auto order oid to update.
+     * @param {string} [validate_original_order] Validate original order before updating
      * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    updateAutoOrder(auto_order: AutoOrder, auto_order_oid: number, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<AutoOrderResponse>;
+    updateAutoOrder(auto_order: AutoOrder, auto_order_oid: number, validate_original_order?: string, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<AutoOrderResponse>;
     /**
      * Update multiple auto orders on the UltraCart account.
      * @summary Update multiple auto orders
@@ -40276,11 +40346,12 @@ export declare const AutoOrderApiFactory: (configuration?: Configuration, fetch?
      * @summary Update an auto order
      * @param {AutoOrder} auto_order Auto order to update
      * @param {number} auto_order_oid The auto order oid to update.
+     * @param {string} [validate_original_order] Validate original order before updating
      * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    updateAutoOrder(auto_order: AutoOrder, auto_order_oid: number, _expand?: string, options?: any): Promise<AutoOrderResponse>;
+    updateAutoOrder(auto_order: AutoOrder, auto_order_oid: number, validate_original_order?: string, _expand?: string, options?: any): Promise<AutoOrderResponse>;
     /**
      * Update multiple auto orders on the UltraCart account.
      * @summary Update multiple auto orders
@@ -40398,12 +40469,13 @@ export interface AutoOrderApiInterface {
      * @summary Update an auto order
      * @param {AutoOrder} auto_order Auto order to update
      * @param {number} auto_order_oid The auto order oid to update.
+     * @param {string} [validate_original_order] Validate original order before updating
      * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AutoOrderApiInterface
      */
-    updateAutoOrder(auto_order: AutoOrder, auto_order_oid: number, _expand?: string, options?: any): Promise<AutoOrderResponse>;
+    updateAutoOrder(auto_order: AutoOrder, auto_order_oid: number, validate_original_order?: string, _expand?: string, options?: any): Promise<AutoOrderResponse>;
     /**
      * Update multiple auto orders on the UltraCart account.
      * @summary Update multiple auto orders
@@ -40523,12 +40595,13 @@ export declare class AutoOrderApi extends BaseAPI implements AutoOrderApiInterfa
      * @summary Update an auto order
      * @param {AutoOrder} auto_order Auto order to update
      * @param {number} auto_order_oid The auto order oid to update.
+     * @param {string} [validate_original_order] Validate original order before updating
      * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AutoOrderApi
      */
-    updateAutoOrder(auto_order: AutoOrder, auto_order_oid: number, _expand?: string, options?: any): Promise<AutoOrderResponse>;
+    updateAutoOrder(auto_order: AutoOrder, auto_order_oid: number, validate_original_order?: string, _expand?: string, options?: any): Promise<AutoOrderResponse>;
     /**
      * Update multiple auto orders on the UltraCart account.
      * @summary Update multiple auto orders

package/dist/api.js

@@ -2288,11 +2288,12 @@ var AutoOrderApiFetchParamCreator = function (configuration) {
          * @summary Update an auto order
          * @param {AutoOrder} auto_order Auto order to update
          * @param {number} auto_order_oid The auto order oid to update.
+         * @param {string} [validate_original_order] Validate original order before updating
          * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        updateAutoOrder: function (auto_order, auto_order_oid, _expand, options) {
+        updateAutoOrder: function (auto_order, auto_order_oid, validate_original_order, _expand, options) {
             if (options === void 0) { options = {}; }
             // verify required parameter 'auto_order' is not null or undefined
             if (auto_order === null || auto_order === undefined) {
@@ -2326,6 +2327,9 @@ var AutoOrderApiFetchParamCreator = function (configuration) {
                     : configuration.apiKey;
                 localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
             }
+            if (validate_original_order !== undefined) {
+                localVarQueryParameter['validate_original_order'] = validate_original_order;
+            }
             if (_expand !== undefined) {
                 localVarQueryParameter['_expand'] = _expand;
             }
@@ -2600,12 +2604,13 @@ var AutoOrderApiFp = function (configuration) {
          * @summary Update an auto order
          * @param {AutoOrder} auto_order Auto order to update
          * @param {number} auto_order_oid The auto order oid to update.
+         * @param {string} [validate_original_order] Validate original order before updating
          * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        updateAutoOrder: function (auto_order, auto_order_oid, _expand, options) {
-            var localVarFetchArgs = (0, exports.AutoOrderApiFetchParamCreator)(configuration).updateAutoOrder(auto_order, auto_order_oid, _expand, options);
+        updateAutoOrder: function (auto_order, auto_order_oid, validate_original_order, _expand, options) {
+            var localVarFetchArgs = (0, exports.AutoOrderApiFetchParamCreator)(configuration).updateAutoOrder(auto_order, auto_order_oid, validate_original_order, _expand, options);
             return function (fetch, basePath) {
                 if (fetch === void 0) { fetch = portableFetch; }
                 if (basePath === void 0) { basePath = BASE_PATH; }
@@ -2759,12 +2764,13 @@ var AutoOrderApiFactory = function (configuration, fetch, basePath) {
          * @summary Update an auto order
          * @param {AutoOrder} auto_order Auto order to update
          * @param {number} auto_order_oid The auto order oid to update.
+         * @param {string} [validate_original_order] Validate original order before updating
          * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        updateAutoOrder: function (auto_order, auto_order_oid, _expand, options) {
-            return (0, exports.AutoOrderApiFp)(configuration).updateAutoOrder(auto_order, auto_order_oid, _expand, options)(fetch, basePath);
+        updateAutoOrder: function (auto_order, auto_order_oid, validate_original_order, _expand, options) {
+            return (0, exports.AutoOrderApiFp)(configuration).updateAutoOrder(auto_order, auto_order_oid, validate_original_order, _expand, options)(fetch, basePath);
         },
         /**
          * Update multiple auto orders on the UltraCart account.
@@ -2906,13 +2912,14 @@ var AutoOrderApi = /** @class */ (function (_super) {
      * @summary Update an auto order
      * @param {AutoOrder} auto_order Auto order to update
      * @param {number} auto_order_oid The auto order oid to update.
+     * @param {string} [validate_original_order] Validate original order before updating
      * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AutoOrderApi
      */
-    AutoOrderApi.prototype.updateAutoOrder = function (auto_order, auto_order_oid, _expand, options) {
-        return (0, exports.AutoOrderApiFp)(this.configuration).updateAutoOrder(auto_order, auto_order_oid, _expand, options)(this.fetch, this.basePath);
+    AutoOrderApi.prototype.updateAutoOrder = function (auto_order, auto_order_oid, validate_original_order, _expand, options) {
+        return (0, exports.AutoOrderApiFp)(this.configuration).updateAutoOrder(auto_order, auto_order_oid, validate_original_order, _expand, options)(this.fetch, this.basePath);
     };
     /**
      * Update multiple auto orders on the UltraCart account.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "3.10.154",
+  "version": "3.10.156",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "keywords": [