ultracart_rest_api_v2_typescript 3.11.0 → 3.11.2

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.11.0
+## ultracart_rest_api_v2_typescript@3.11.2
 
 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.11.0 --save
+npm install ultracart_rest_api_v2_typescript@3.11.2 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.11.2 | 03/05/2025 | added ChannelPartnerOrder.use_prior_payment_information_from_order_id |
+| 3.11.1 | 02/28/2025 | auto order pause method |
 | 3.11.0 | 02/21/2025 | ItemApi.getInventorySnapshot had bad nickname causing bad sdk method name |
 | 3.10.228 | 02/20/2025 | automation fix |
 | 3.10.227 | 02/20/2025 | no change, revving sdk to troubleshoot java deployment automation |

package/api.ts

@@ -6122,6 +6122,12 @@ export interface ChannelPartnerOrder {
      * @memberof ChannelPartnerOrder
      */
     treat_warnings_as_errors?: boolean;
+    /**
+     * An Order Id from a prior purchase of this customer which is used to retrieve vaulted payment information in order to pay for this current order.
+     * @type {string}
+     * @memberof ChannelPartnerOrder
+     */
+    use_prior_payment_information_from_order_id?: string;
 }
 
 /**
@@ -28593,7 +28599,7 @@ export interface ItemPaymentProcessing {
      */
     block_prepaid?: boolean;
     /**
-     * True if this item should block any refund attempts
+     * True if this item should block any refund attempts, set to false otherwise, null value will not update the field
      * @type {boolean}
      * @memberof ItemPaymentProcessing
      */
@@ -32661,7 +32667,7 @@ export interface OrderCoupon {
      */
     coupon_code?: string;
     /**
-     * True if this coupon is hidde from the customer
+     * True if this coupon is hide from the customer
      * @type {boolean}
      * @memberof OrderCoupon
      */
@@ -46139,6 +46145,72 @@ export const AutoOrderApiFetchParamCreator = function (configuration?: Configura
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Completely pause an auto order 
+         * @summary Pause auto order
+         * @param {AutoOrder} auto_order Auto orders to pause
+         * @param {number} auto_order_oid The auto order oid to pause.
+         * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        pauseAutoOrder(auto_order: AutoOrder, auto_order_oid: number, _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 pauseAutoOrder.');
+            }
+            // verify required parameter 'auto_order_oid' is not null or undefined
+            if (auto_order_oid === null || auto_order_oid === undefined) {
+                throw new RequiredError('auto_order_oid','Required parameter auto_order_oid was null or undefined when calling pauseAutoOrder.');
+            }
+            const localVarPath = `/auto_order/auto_orders/{auto_order_oid}/pause`
+                .replace(`{${"auto_order_oid"}}`, encodeURIComponent(String(auto_order_oid)));
+            const localVarUrlObj = url.parse(localVarPath, true);
+            const localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+    if(configuration && configuration.apiVersion) {
+      localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
+    }
+
+
+
+            // authentication ultraCartOauth required
+            // oauth required
+            if (configuration && configuration.accessToken) {
+				const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+					? configuration.accessToken("ultraCartOauth", ["auto_order_write"])
+					: configuration.accessToken;
+                localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
+            }
+
+            // authentication ultraCartSimpleApiKey required
+            if (configuration && configuration.apiKey) {
+                const localVarApiKeyValue = typeof configuration.apiKey === 'function'
+					? configuration.apiKey("x-ultracart-simple-key")
+					: configuration.apiKey;
+                localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
+            }
+
+            if (_expand !== undefined) {
+                localVarQueryParameter['_expand'] = _expand;
+            }
+
+            localVarHeaderParameter['Content-Type'] = 'application/json; charset=UTF-8';
+
+            localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
+            // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
+            delete localVarUrlObj.search;
+            localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
+            const needsSerialization = (<any>"AutoOrder" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
+            localVarRequestOptions.body =  needsSerialization ? JSON.stringify(auto_order || {}) : (auto_order || "");
+
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Update an auto order on the UltraCart account. 
          * @summary Update an auto order
@@ -46490,6 +46562,29 @@ export const AutoOrderApiFp = function(configuration?: Configuration) {
                 });
             };
         },
+        /**
+         * Completely pause an auto order 
+         * @summary Pause auto order
+         * @param {AutoOrder} auto_order Auto orders to pause
+         * @param {number} auto_order_oid The auto order oid to pause.
+         * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        pauseAutoOrder(auto_order: AutoOrder, auto_order_oid: number, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<AutoOrderResponse> {
+            const localVarFetchArgs = AutoOrderApiFetchParamCreator(configuration).pauseAutoOrder(auto_order, auto_order_oid, _expand, options);
+            return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
+                return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
+
+                    if (response.status >= 200 && response.status < 300) {
+                      return response.json();
+                      
+                    } else {
+                        throw response;
+                    }
+                });
+            };
+        },
         /**
          * Update an auto order on the UltraCart account. 
          * @summary Update an auto order
@@ -46660,6 +46755,18 @@ export const AutoOrderApiFactory = function (configuration?: Configuration, fetc
         getAutoOrdersByQuery(auto_order_query: AutoOrderQuery, _limit?: number, _offset?: number, _sort?: string, _expand?: string, options?: any) {
             return AutoOrderApiFp(configuration).getAutoOrdersByQuery(auto_order_query, _limit, _offset, _sort, _expand, options)(fetch, basePath);
         },
+        /**
+         * Completely pause an auto order 
+         * @summary Pause auto order
+         * @param {AutoOrder} auto_order Auto orders to pause
+         * @param {number} auto_order_oid The auto order oid to pause.
+         * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        pauseAutoOrder(auto_order: AutoOrder, auto_order_oid: number, _expand?: string, options?: any) {
+            return AutoOrderApiFp(configuration).pauseAutoOrder(auto_order, auto_order_oid, _expand, options)(fetch, basePath);
+        },
         /**
          * Update an auto order on the UltraCart account. 
          * @summary Update an auto order
@@ -46808,6 +46915,18 @@ export interface AutoOrderApiInterface {
      */
     getAutoOrdersByQuery(auto_order_query: AutoOrderQuery, _limit?: number, _offset?: number, _sort?: string, _expand?: string, options?: any): Promise<AutoOrdersResponse>;
 
+    /**
+     * Completely pause an auto order 
+     * @summary Pause auto order
+     * @param {AutoOrder} auto_order Auto orders to pause
+     * @param {number} auto_order_oid The auto order oid to pause.
+     * @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
+     */
+    pauseAutoOrder(auto_order: AutoOrder, auto_order_oid: number, _expand?: string, options?: any): Promise<AutoOrderResponse>;
+
     /**
      * Update an auto order on the UltraCart account. 
      * @summary Update an auto order
@@ -46972,6 +47091,20 @@ export class AutoOrderApi extends BaseAPI implements AutoOrderApiInterface {
         return AutoOrderApiFp(this.configuration).getAutoOrdersByQuery(auto_order_query, _limit, _offset, _sort, _expand, options)(this.fetch, this.basePath);
     }
 
+    /**
+     * Completely pause an auto order 
+     * @summary Pause auto order
+     * @param {AutoOrder} auto_order Auto orders to pause
+     * @param {number} auto_order_oid The auto order oid to pause.
+     * @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 pauseAutoOrder(auto_order: AutoOrder, auto_order_oid: number, _expand?: string, options?: any) {
+        return AutoOrderApiFp(this.configuration).pauseAutoOrder(auto_order, auto_order_oid, _expand, options)(this.fetch, this.basePath);
+    }
+
     /**
      * Update an auto order on the UltraCart account. 
      * @summary Update an auto order

package/dist/api.d.ts

@@ -5987,6 +5987,12 @@ export interface ChannelPartnerOrder {
      * @memberof ChannelPartnerOrder
      */
     treat_warnings_as_errors?: boolean;
+    /**
+     * An Order Id from a prior purchase of this customer which is used to retrieve vaulted payment information in order to pay for this current order.
+     * @type {string}
+     * @memberof ChannelPartnerOrder
+     */
+    use_prior_payment_information_from_order_id?: string;
 }
 /**
  * @export
@@ -27989,7 +27995,7 @@ export interface ItemPaymentProcessing {
      */
     block_prepaid?: boolean;
     /**
-     * True if this item should block any refund attempts
+     * True if this item should block any refund attempts, set to false otherwise, null value will not update the field
      * @type {boolean}
      * @memberof ItemPaymentProcessing
      */
@@ -31974,7 +31980,7 @@ export interface OrderCoupon {
      */
     coupon_code?: string;
     /**
-     * True if this coupon is hidde from the customer
+     * True if this coupon is hide from the customer
      * @type {boolean}
      * @memberof OrderCoupon
      */
@@ -44523,6 +44529,16 @@ export declare const AutoOrderApiFetchParamCreator: (configuration?: Configurati
      * @throws {RequiredError}
      */
     getAutoOrdersByQuery(auto_order_query: AutoOrderQuery, _limit?: number, _offset?: number, _sort?: string, _expand?: string, options?: any): FetchArgs;
+    /**
+     * Completely pause an auto order
+     * @summary Pause auto order
+     * @param {AutoOrder} auto_order Auto orders to pause
+     * @param {number} auto_order_oid The auto order oid to pause.
+     * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    pauseAutoOrder(auto_order: AutoOrder, auto_order_oid: number, _expand?: string, options?: any): FetchArgs;
     /**
      * Update an auto order on the UltraCart account.
      * @summary Update an auto order
@@ -44648,6 +44664,16 @@ export declare const AutoOrderApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getAutoOrdersByQuery(auto_order_query: AutoOrderQuery, _limit?: number, _offset?: number, _sort?: string, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<AutoOrdersResponse>;
+    /**
+     * Completely pause an auto order
+     * @summary Pause auto order
+     * @param {AutoOrder} auto_order Auto orders to pause
+     * @param {number} auto_order_oid The auto order oid to pause.
+     * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    pauseAutoOrder(auto_order: AutoOrder, auto_order_oid: number, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<AutoOrderResponse>;
     /**
      * Update an auto order on the UltraCart account.
      * @summary Update an auto order
@@ -44773,6 +44799,16 @@ export declare const AutoOrderApiFactory: (configuration?: Configuration, fetch?
      * @throws {RequiredError}
      */
     getAutoOrdersByQuery(auto_order_query: AutoOrderQuery, _limit?: number, _offset?: number, _sort?: string, _expand?: string, options?: any): Promise<AutoOrdersResponse>;
+    /**
+     * Completely pause an auto order
+     * @summary Pause auto order
+     * @param {AutoOrder} auto_order Auto orders to pause
+     * @param {number} auto_order_oid The auto order oid to pause.
+     * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    pauseAutoOrder(auto_order: AutoOrder, auto_order_oid: number, _expand?: string, options?: any): Promise<AutoOrderResponse>;
     /**
      * Update an auto order on the UltraCart account.
      * @summary Update an auto order
@@ -44907,6 +44943,17 @@ export interface AutoOrderApiInterface {
      * @memberof AutoOrderApiInterface
      */
     getAutoOrdersByQuery(auto_order_query: AutoOrderQuery, _limit?: number, _offset?: number, _sort?: string, _expand?: string, options?: any): Promise<AutoOrdersResponse>;
+    /**
+     * Completely pause an auto order
+     * @summary Pause auto order
+     * @param {AutoOrder} auto_order Auto orders to pause
+     * @param {number} auto_order_oid The auto order oid to pause.
+     * @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
+     */
+    pauseAutoOrder(auto_order: AutoOrder, auto_order_oid: number, _expand?: string, options?: any): Promise<AutoOrderResponse>;
     /**
      * Update an auto order on the UltraCart account.
      * @summary Update an auto order
@@ -45044,6 +45091,17 @@ export declare class AutoOrderApi extends BaseAPI implements AutoOrderApiInterfa
      * @memberof AutoOrderApi
      */
     getAutoOrdersByQuery(auto_order_query: AutoOrderQuery, _limit?: number, _offset?: number, _sort?: string, _expand?: string, options?: any): Promise<AutoOrdersResponse>;
+    /**
+     * Completely pause an auto order
+     * @summary Pause auto order
+     * @param {AutoOrder} auto_order Auto orders to pause
+     * @param {number} auto_order_oid The auto order oid to pause.
+     * @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
+     */
+    pauseAutoOrder(auto_order: AutoOrder, auto_order_oid: number, _expand?: string, options?: any): Promise<AutoOrderResponse>;
     /**
      * Update an auto order on the UltraCart account.
      * @summary Update an auto order

package/dist/api.js

@@ -2686,6 +2686,64 @@ var AutoOrderApiFetchParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Completely pause an auto order
+         * @summary Pause auto order
+         * @param {AutoOrder} auto_order Auto orders to pause
+         * @param {number} auto_order_oid The auto order oid to pause.
+         * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        pauseAutoOrder: function (auto_order, auto_order_oid, _expand, options) {
+            if (options === void 0) { options = {}; }
+            // 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 pauseAutoOrder.');
+            }
+            // verify required parameter 'auto_order_oid' is not null or undefined
+            if (auto_order_oid === null || auto_order_oid === undefined) {
+                throw new RequiredError('auto_order_oid', 'Required parameter auto_order_oid was null or undefined when calling pauseAutoOrder.');
+            }
+            var localVarPath = "/auto_order/auto_orders/{auto_order_oid}/pause"
+                .replace("{".concat("auto_order_oid", "}"), encodeURIComponent(String(auto_order_oid)));
+            var localVarUrlObj = url.parse(localVarPath, true);
+            var localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
+            var localVarHeaderParameter = {};
+            var localVarQueryParameter = {};
+            if (configuration && configuration.apiVersion) {
+                localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
+            }
+            // authentication ultraCartOauth required
+            // oauth required
+            if (configuration && configuration.accessToken) {
+                var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+                    ? configuration.accessToken("ultraCartOauth", ["auto_order_write"])
+                    : configuration.accessToken;
+                localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
+            }
+            // authentication ultraCartSimpleApiKey required
+            if (configuration && configuration.apiKey) {
+                var localVarApiKeyValue = typeof configuration.apiKey === 'function'
+                    ? configuration.apiKey("x-ultracart-simple-key")
+                    : configuration.apiKey;
+                localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
+            }
+            if (_expand !== undefined) {
+                localVarQueryParameter['_expand'] = _expand;
+            }
+            localVarHeaderParameter['Content-Type'] = 'application/json; charset=UTF-8';
+            localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
+            // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
+            delete localVarUrlObj.search;
+            localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
+            var needsSerialization = ("AutoOrder" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
+            localVarRequestOptions.body = needsSerialization ? JSON.stringify(auto_order || {}) : (auto_order || "");
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Update an auto order on the UltraCart account.
          * @summary Update an auto order
@@ -3026,6 +3084,30 @@ var AutoOrderApiFp = function (configuration) {
                 });
             };
         },
+        /**
+         * Completely pause an auto order
+         * @summary Pause auto order
+         * @param {AutoOrder} auto_order Auto orders to pause
+         * @param {number} auto_order_oid The auto order oid to pause.
+         * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        pauseAutoOrder: function (auto_order, auto_order_oid, _expand, options) {
+            var localVarFetchArgs = (0, exports.AutoOrderApiFetchParamCreator)(configuration).pauseAutoOrder(auto_order, auto_order_oid, _expand, options);
+            return function (fetch, basePath) {
+                if (fetch === void 0) { fetch = portableFetch; }
+                if (basePath === void 0) { basePath = BASE_PATH; }
+                return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
+                    if (response.status >= 200 && response.status < 300) {
+                        return response.json();
+                    }
+                    else {
+                        throw response;
+                    }
+                });
+            };
+        },
         /**
          * Update an auto order on the UltraCart account.
          * @summary Update an auto order
@@ -3198,6 +3280,18 @@ var AutoOrderApiFactory = function (configuration, fetch, basePath) {
         getAutoOrdersByQuery: function (auto_order_query, _limit, _offset, _sort, _expand, options) {
             return (0, exports.AutoOrderApiFp)(configuration).getAutoOrdersByQuery(auto_order_query, _limit, _offset, _sort, _expand, options)(fetch, basePath);
         },
+        /**
+         * Completely pause an auto order
+         * @summary Pause auto order
+         * @param {AutoOrder} auto_order Auto orders to pause
+         * @param {number} auto_order_oid The auto order oid to pause.
+         * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        pauseAutoOrder: function (auto_order, auto_order_oid, _expand, options) {
+            return (0, exports.AutoOrderApiFp)(configuration).pauseAutoOrder(auto_order, auto_order_oid, _expand, options)(fetch, basePath);
+        },
         /**
          * Update an auto order on the UltraCart account.
          * @summary Update an auto order
@@ -3359,6 +3453,19 @@ var AutoOrderApi = /** @class */ (function (_super) {
     AutoOrderApi.prototype.getAutoOrdersByQuery = function (auto_order_query, _limit, _offset, _sort, _expand, options) {
         return (0, exports.AutoOrderApiFp)(this.configuration).getAutoOrdersByQuery(auto_order_query, _limit, _offset, _sort, _expand, options)(this.fetch, this.basePath);
     };
+    /**
+     * Completely pause an auto order
+     * @summary Pause auto order
+     * @param {AutoOrder} auto_order Auto orders to pause
+     * @param {number} auto_order_oid The auto order oid to pause.
+     * @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.pauseAutoOrder = function (auto_order, auto_order_oid, _expand, options) {
+        return (0, exports.AutoOrderApiFp)(this.configuration).pauseAutoOrder(auto_order, auto_order_oid, _expand, options)(this.fetch, this.basePath);
+    };
     /**
      * Update an auto order on the UltraCart account.
      * @summary Update an auto order

package/package.json

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