ultracart_rest_api_v2_typescript 3.10.143 → 3.10.144

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.10.143
+## ultracart_rest_api_v2_typescript@3.10.144
 
 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.143 --save
+npm install ultracart_rest_api_v2_typescript@3.10.144 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.144 | 06/15/2023 | add pickup_dts to order.shipping object |
 | 3.10.143 | 06/14/2023 | dw bi: add request_dts on the execute queries request and report data set objects |
 | 3.10.142 | 06/09/2023 | distribution center pickup times |
 | 3.10.141 | 06/08/2023 | customer profile qb tax exempt reason code field |

package/api.ts

@@ -32338,6 +32338,12 @@ export interface OrderShipping {
      * @memberof OrderShipping
      */
     lift_gate?: boolean;
+    /**
+     * Date/time the order should be picked up locally.
+     * @type {string}
+     * @memberof OrderShipping
+     */
+    pickup_dts?: string;
     /**
      * Postal code
      * @type {string}
@@ -61337,10 +61343,12 @@ export const OrderApiFetchParamCreator = function (configuration?: Configuration
          * Cancel an order on the UltraCart account.  If the success flag is false, then consult the error message for why it failed. 
          * @summary Cancel an order
          * @param {string} order_id The order id to cancel.
+         * @param {boolean} [lock_self_ship_orders] Flag to prevent a order shipping during a refund process
+         * @param {boolean} [skip_refund_and_hold] Skip refund and move order to Held Orders department
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        cancelOrder(order_id: string, options: any = {}): FetchArgs {
+        cancelOrder(order_id: string, lock_self_ship_orders?: boolean, skip_refund_and_hold?: boolean, options: any = {}): FetchArgs {
             // verify required parameter 'order_id' is not null or undefined
             if (order_id === null || order_id === undefined) {
                 throw new RequiredError('order_id','Required parameter order_id was null or undefined when calling cancelOrder.');
@@ -61375,6 +61383,14 @@ export const OrderApiFetchParamCreator = function (configuration?: Configuration
                 localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
             }
 
+            if (lock_self_ship_orders !== undefined) {
+                localVarQueryParameter['lock_self_ship_orders'] = lock_self_ship_orders;
+            }
+
+            if (skip_refund_and_hold !== undefined) {
+                localVarQueryParameter['skip_refund_and_hold'] = skip_refund_and_hold;
+            }
+
             localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
             // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
             delete localVarUrlObj.search;
@@ -62966,11 +62982,13 @@ export const OrderApiFp = function(configuration?: Configuration) {
          * Cancel an order on the UltraCart account.  If the success flag is false, then consult the error message for why it failed. 
          * @summary Cancel an order
          * @param {string} order_id The order id to cancel.
+         * @param {boolean} [lock_self_ship_orders] Flag to prevent a order shipping during a refund process
+         * @param {boolean} [skip_refund_and_hold] Skip refund and move order to Held Orders department
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        cancelOrder(order_id: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<BaseResponse> {
-            const localVarFetchArgs = OrderApiFetchParamCreator(configuration).cancelOrder(order_id, options);
+        cancelOrder(order_id: string, lock_self_ship_orders?: boolean, skip_refund_and_hold?: boolean, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<BaseResponse> {
+            const localVarFetchArgs = OrderApiFetchParamCreator(configuration).cancelOrder(order_id, lock_self_ship_orders, skip_refund_and_hold, options);
             return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
                 return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
 
@@ -63564,11 +63582,13 @@ export const OrderApiFactory = function (configuration?: Configuration, fetch?:
          * Cancel an order on the UltraCart account.  If the success flag is false, then consult the error message for why it failed. 
          * @summary Cancel an order
          * @param {string} order_id The order id to cancel.
+         * @param {boolean} [lock_self_ship_orders] Flag to prevent a order shipping during a refund process
+         * @param {boolean} [skip_refund_and_hold] Skip refund and move order to Held Orders department
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        cancelOrder(order_id: string, options?: any) {
-            return OrderApiFp(configuration).cancelOrder(order_id, options)(fetch, basePath);
+        cancelOrder(order_id: string, lock_self_ship_orders?: boolean, skip_refund_and_hold?: boolean, options?: any) {
+            return OrderApiFp(configuration).cancelOrder(order_id, lock_self_ship_orders, skip_refund_and_hold, options)(fetch, basePath);
         },
         /**
          * Delete an order on the UltraCart account. 
@@ -63887,11 +63907,13 @@ export interface OrderApiInterface {
      * Cancel an order on the UltraCart account.  If the success flag is false, then consult the error message for why it failed. 
      * @summary Cancel an order
      * @param {string} order_id The order id to cancel.
+     * @param {boolean} [lock_self_ship_orders] Flag to prevent a order shipping during a refund process
+     * @param {boolean} [skip_refund_and_hold] Skip refund and move order to Held Orders department
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof OrderApiInterface
      */
-    cancelOrder(order_id: string, options?: any): Promise<BaseResponse>;
+    cancelOrder(order_id: string, lock_self_ship_orders?: boolean, skip_refund_and_hold?: boolean, options?: any): Promise<BaseResponse>;
 
     /**
      * Delete an order on the UltraCart account. 
@@ -64212,12 +64234,14 @@ export class OrderApi extends BaseAPI implements OrderApiInterface {
      * Cancel an order on the UltraCart account.  If the success flag is false, then consult the error message for why it failed. 
      * @summary Cancel an order
      * @param {string} order_id The order id to cancel.
+     * @param {boolean} [lock_self_ship_orders] Flag to prevent a order shipping during a refund process
+     * @param {boolean} [skip_refund_and_hold] Skip refund and move order to Held Orders department
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof OrderApi
      */
-    public cancelOrder(order_id: string, options?: any) {
-        return OrderApiFp(this.configuration).cancelOrder(order_id, options)(this.fetch, this.basePath);
+    public cancelOrder(order_id: string, lock_self_ship_orders?: boolean, skip_refund_and_hold?: boolean, options?: any) {
+        return OrderApiFp(this.configuration).cancelOrder(order_id, lock_self_ship_orders, skip_refund_and_hold, options)(this.fetch, this.basePath);
     }
 
     /**

package/dist/api.d.ts

@@ -31657,6 +31657,12 @@ export interface OrderShipping {
      * @memberof OrderShipping
      */
     lift_gate?: boolean;
+    /**
+     * Date/time the order should be picked up locally.
+     * @type {string}
+     * @memberof OrderShipping
+     */
+    pickup_dts?: string;
     /**
      * Postal code
      * @type {string}
@@ -48310,10 +48316,12 @@ export declare const OrderApiFetchParamCreator: (configuration?: Configuration)
      * Cancel an order on the UltraCart account.  If the success flag is false, then consult the error message for why it failed.
      * @summary Cancel an order
      * @param {string} order_id The order id to cancel.
+     * @param {boolean} [lock_self_ship_orders] Flag to prevent a order shipping during a refund process
+     * @param {boolean} [skip_refund_and_hold] Skip refund and move order to Held Orders department
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    cancelOrder(order_id: string, options?: any): FetchArgs;
+    cancelOrder(order_id: string, lock_self_ship_orders?: boolean, skip_refund_and_hold?: boolean, options?: any): FetchArgs;
     /**
      * Delete an order on the UltraCart account.
      * @summary Delete an order
@@ -48578,10 +48586,12 @@ export declare const OrderApiFp: (configuration?: Configuration) => {
      * Cancel an order on the UltraCart account.  If the success flag is false, then consult the error message for why it failed.
      * @summary Cancel an order
      * @param {string} order_id The order id to cancel.
+     * @param {boolean} [lock_self_ship_orders] Flag to prevent a order shipping during a refund process
+     * @param {boolean} [skip_refund_and_hold] Skip refund and move order to Held Orders department
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    cancelOrder(order_id: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<BaseResponse>;
+    cancelOrder(order_id: string, lock_self_ship_orders?: boolean, skip_refund_and_hold?: boolean, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<BaseResponse>;
     /**
      * Delete an order on the UltraCart account.
      * @summary Delete an order
@@ -48846,10 +48856,12 @@ export declare const OrderApiFactory: (configuration?: Configuration, fetch?: Fe
      * Cancel an order on the UltraCart account.  If the success flag is false, then consult the error message for why it failed.
      * @summary Cancel an order
      * @param {string} order_id The order id to cancel.
+     * @param {boolean} [lock_self_ship_orders] Flag to prevent a order shipping during a refund process
+     * @param {boolean} [skip_refund_and_hold] Skip refund and move order to Held Orders department
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    cancelOrder(order_id: string, options?: any): Promise<BaseResponse>;
+    cancelOrder(order_id: string, lock_self_ship_orders?: boolean, skip_refund_and_hold?: boolean, options?: any): Promise<BaseResponse>;
     /**
      * Delete an order on the UltraCart account.
      * @summary Delete an order
@@ -49116,11 +49128,13 @@ export interface OrderApiInterface {
      * Cancel an order on the UltraCart account.  If the success flag is false, then consult the error message for why it failed.
      * @summary Cancel an order
      * @param {string} order_id The order id to cancel.
+     * @param {boolean} [lock_self_ship_orders] Flag to prevent a order shipping during a refund process
+     * @param {boolean} [skip_refund_and_hold] Skip refund and move order to Held Orders department
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof OrderApiInterface
      */
-    cancelOrder(order_id: string, options?: any): Promise<BaseResponse>;
+    cancelOrder(order_id: string, lock_self_ship_orders?: boolean, skip_refund_and_hold?: boolean, options?: any): Promise<BaseResponse>;
     /**
      * Delete an order on the UltraCart account.
      * @summary Delete an order
@@ -49412,11 +49426,13 @@ export declare class OrderApi extends BaseAPI implements OrderApiInterface {
      * Cancel an order on the UltraCart account.  If the success flag is false, then consult the error message for why it failed.
      * @summary Cancel an order
      * @param {string} order_id The order id to cancel.
+     * @param {boolean} [lock_self_ship_orders] Flag to prevent a order shipping during a refund process
+     * @param {boolean} [skip_refund_and_hold] Skip refund and move order to Held Orders department
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof OrderApi
      */
-    cancelOrder(order_id: string, options?: any): Promise<BaseResponse>;
+    cancelOrder(order_id: string, lock_self_ship_orders?: boolean, skip_refund_and_hold?: boolean, options?: any): Promise<BaseResponse>;
     /**
      * Delete an order on the UltraCart account.
      * @summary Delete an order

package/dist/api.js

@@ -19072,10 +19072,12 @@ var OrderApiFetchParamCreator = function (configuration) {
          * Cancel an order on the UltraCart account.  If the success flag is false, then consult the error message for why it failed.
          * @summary Cancel an order
          * @param {string} order_id The order id to cancel.
+         * @param {boolean} [lock_self_ship_orders] Flag to prevent a order shipping during a refund process
+         * @param {boolean} [skip_refund_and_hold] Skip refund and move order to Held Orders department
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        cancelOrder: function (order_id, options) {
+        cancelOrder: function (order_id, lock_self_ship_orders, skip_refund_and_hold, options) {
             if (options === void 0) { options = {}; }
             // verify required parameter 'order_id' is not null or undefined
             if (order_id === null || order_id === undefined) {
@@ -19105,6 +19107,12 @@ var OrderApiFetchParamCreator = function (configuration) {
                     : configuration.apiKey;
                 localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
             }
+            if (lock_self_ship_orders !== undefined) {
+                localVarQueryParameter['lock_self_ship_orders'] = lock_self_ship_orders;
+            }
+            if (skip_refund_and_hold !== undefined) {
+                localVarQueryParameter['skip_refund_and_hold'] = skip_refund_and_hold;
+            }
             localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
             // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
             delete localVarUrlObj.search;
@@ -20492,11 +20500,13 @@ var OrderApiFp = function (configuration) {
          * Cancel an order on the UltraCart account.  If the success flag is false, then consult the error message for why it failed.
          * @summary Cancel an order
          * @param {string} order_id The order id to cancel.
+         * @param {boolean} [lock_self_ship_orders] Flag to prevent a order shipping during a refund process
+         * @param {boolean} [skip_refund_and_hold] Skip refund and move order to Held Orders department
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        cancelOrder: function (order_id, options) {
-            var localVarFetchArgs = (0, exports.OrderApiFetchParamCreator)(configuration).cancelOrder(order_id, options);
+        cancelOrder: function (order_id, lock_self_ship_orders, skip_refund_and_hold, options) {
+            var localVarFetchArgs = (0, exports.OrderApiFetchParamCreator)(configuration).cancelOrder(order_id, lock_self_ship_orders, skip_refund_and_hold, options);
             return function (fetch, basePath) {
                 if (fetch === void 0) { fetch = portableFetch; }
                 if (basePath === void 0) { basePath = BASE_PATH; }
@@ -21115,11 +21125,13 @@ var OrderApiFactory = function (configuration, fetch, basePath) {
          * Cancel an order on the UltraCart account.  If the success flag is false, then consult the error message for why it failed.
          * @summary Cancel an order
          * @param {string} order_id The order id to cancel.
+         * @param {boolean} [lock_self_ship_orders] Flag to prevent a order shipping during a refund process
+         * @param {boolean} [skip_refund_and_hold] Skip refund and move order to Held Orders department
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        cancelOrder: function (order_id, options) {
-            return (0, exports.OrderApiFp)(configuration).cancelOrder(order_id, options)(fetch, basePath);
+        cancelOrder: function (order_id, lock_self_ship_orders, skip_refund_and_hold, options) {
+            return (0, exports.OrderApiFp)(configuration).cancelOrder(order_id, lock_self_ship_orders, skip_refund_and_hold, options)(fetch, basePath);
         },
         /**
          * Delete an order on the UltraCart account.
@@ -21444,12 +21456,14 @@ var OrderApi = /** @class */ (function (_super) {
      * Cancel an order on the UltraCart account.  If the success flag is false, then consult the error message for why it failed.
      * @summary Cancel an order
      * @param {string} order_id The order id to cancel.
+     * @param {boolean} [lock_self_ship_orders] Flag to prevent a order shipping during a refund process
+     * @param {boolean} [skip_refund_and_hold] Skip refund and move order to Held Orders department
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof OrderApi
      */
-    OrderApi.prototype.cancelOrder = function (order_id, options) {
-        return (0, exports.OrderApiFp)(this.configuration).cancelOrder(order_id, options)(this.fetch, this.basePath);
+    OrderApi.prototype.cancelOrder = function (order_id, lock_self_ship_orders, skip_refund_and_hold, options) {
+        return (0, exports.OrderApiFp)(this.configuration).cancelOrder(order_id, lock_self_ship_orders, skip_refund_and_hold, options)(this.fetch, this.basePath);
     };
     /**
      * Delete an order on the UltraCart account.

package/package.json

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