ultracart_rest_api_v2_typescript 4.0.159 → 4.0.161

package/README.md

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

package/dist/apis/OrderApi.d.ts

@@ -17,6 +17,8 @@ export interface AdjustOrderTotalRequest {
 }
 export interface CancelOrderRequest {
     orderId: string;
+    lockSelfShipOrders?: boolean;
+    skipRefundAndHold?: boolean;
 }
 export interface DeleteOrderRequest {
     orderId: string;
@@ -167,6 +169,8 @@ 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} orderId The order id to cancel.
+     * @param {boolean} [lockSelfShipOrders] Flag to prevent a order shipping during a refund process
+     * @param {boolean} [skipRefundAndHold] Skip refund and move order to Held Orders department
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof OrderApiInterface

package/dist/apis/OrderApi.js

@@ -151,6 +151,12 @@ var OrderApi = /** @class */ (function (_super) {
                             throw new runtime.RequiredError('orderId', 'Required parameter requestParameters.orderId was null or undefined when calling cancelOrder.');
                         }
                         queryParameters = {};
+                        if (requestParameters.lockSelfShipOrders !== undefined) {
+                            queryParameters['lock_self_ship_orders'] = requestParameters.lockSelfShipOrders;
+                        }
+                        if (requestParameters.skipRefundAndHold !== undefined) {
+                            queryParameters['skip_refund_and_hold'] = requestParameters.skipRefundAndHold;
+                        }
                         headerParameters = {};
                         if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
                         // oauth required

package/dist/models/OrderShipping.d.ts

@@ -107,6 +107,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}

package/dist/models/OrderShipping.js

@@ -41,6 +41,7 @@ function OrderShippingFromJSONTyped(json, ignoreDiscriminator) {
         'least_cost_route': !(0, runtime_1.exists)(json, 'least_cost_route') ? undefined : json['least_cost_route'],
         'least_cost_route_shipping_methods': !(0, runtime_1.exists)(json, 'least_cost_route_shipping_methods') ? undefined : json['least_cost_route_shipping_methods'],
         'lift_gate': !(0, runtime_1.exists)(json, 'lift_gate') ? undefined : json['lift_gate'],
+        'pickup_dts': !(0, runtime_1.exists)(json, 'pickup_dts') ? undefined : json['pickup_dts'],
         'postal_code': !(0, runtime_1.exists)(json, 'postal_code') ? undefined : json['postal_code'],
         'rma': !(0, runtime_1.exists)(json, 'rma') ? undefined : json['rma'],
         'ship_on_date': !(0, runtime_1.exists)(json, 'ship_on_date') ? undefined : json['ship_on_date'],
@@ -82,6 +83,7 @@ function OrderShippingToJSON(value) {
         'least_cost_route': value.least_cost_route,
         'least_cost_route_shipping_methods': value.least_cost_route_shipping_methods,
         'lift_gate': value.lift_gate,
+        'pickup_dts': value.pickup_dts,
         'postal_code': value.postal_code,
         'rma': value.rma,
         'ship_on_date': value.ship_on_date,

package/dist/models/ReportDataSet.d.ts

@@ -89,6 +89,12 @@ export interface ReportDataSet {
      * @memberof ReportDataSet
      */
     page_size?: number;
+    /**
+     * Date/Time of the client submitted the request.  Can be used to resolve out of order query completion results
+     * @type {string}
+     * @memberof ReportDataSet
+     */
+    request_dts?: string;
     /**
      * The schema associated with the data set.
      * @type {Array<ReportDataSetSchema>}

package/dist/models/ReportDataSet.js

@@ -46,6 +46,7 @@ function ReportDataSetFromJSONTyped(json, ignoreDiscriminator) {
         'merchant_id': !(0, runtime_1.exists)(json, 'merchant_id') ? undefined : json['merchant_id'],
         'page_count': !(0, runtime_1.exists)(json, 'page_count') ? undefined : json['page_count'],
         'page_size': !(0, runtime_1.exists)(json, 'page_size') ? undefined : json['page_size'],
+        'request_dts': !(0, runtime_1.exists)(json, 'request_dts') ? undefined : json['request_dts'],
         'schema': !(0, runtime_1.exists)(json, 'schema') ? undefined : (json['schema'].map(ReportDataSetSchema_1.ReportDataSetSchemaFromJSON)),
         'security_level': !(0, runtime_1.exists)(json, 'security_level') ? undefined : json['security_level'],
         'timezone': !(0, runtime_1.exists)(json, 'timezone') ? undefined : json['timezone'],
@@ -73,6 +74,7 @@ function ReportDataSetToJSON(value) {
         'merchant_id': value.merchant_id,
         'page_count': value.page_count,
         'page_size': value.page_size,
+        'request_dts': value.request_dts,
         'schema': value.schema === undefined ? undefined : (value.schema.map(ReportDataSetSchema_1.ReportDataSetSchemaToJSON)),
         'security_level': value.security_level,
         'timezone': value.timezone,

package/dist/models/ReportExecuteQueriesRequest.d.ts

@@ -52,6 +52,12 @@ export interface ReportExecuteQueriesRequest {
      * @memberof ReportExecuteQueriesRequest
      */
     queries?: Array<ReportDataSetQuery>;
+    /**
+     * Date/Time of the client submitted the request.  Can be used to resolve out of order query completion results
+     * @type {string}
+     * @memberof ReportExecuteQueriesRequest
+     */
+    request_dts?: string;
     /**
      * Security level to execute report under
      * @type {string}

package/dist/models/ReportExecuteQueriesRequest.js

@@ -40,6 +40,7 @@ function ReportExecuteQueriesRequestFromJSONTyped(json, ignoreDiscriminator) {
         'default_project_id': !(0, runtime_1.exists)(json, 'default_project_id') ? undefined : json['default_project_id'],
         'merchant_id': !(0, runtime_1.exists)(json, 'merchant_id') ? undefined : json['merchant_id'],
         'queries': !(0, runtime_1.exists)(json, 'queries') ? undefined : (json['queries'].map(ReportDataSetQuery_1.ReportDataSetQueryFromJSON)),
+        'request_dts': !(0, runtime_1.exists)(json, 'request_dts') ? undefined : json['request_dts'],
         'security_level': !(0, runtime_1.exists)(json, 'security_level') ? undefined : json['security_level'],
     };
 }
@@ -58,6 +59,7 @@ function ReportExecuteQueriesRequestToJSON(value) {
         'default_project_id': value.default_project_id,
         'merchant_id': value.merchant_id,
         'queries': value.queries === undefined ? undefined : (value.queries.map(ReportDataSetQuery_1.ReportDataSetQueryToJSON)),
+        'request_dts': value.request_dts,
         'security_level': value.security_level,
     };
 }

package/package.json

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

package/src/apis/OrderApi.ts

@@ -90,6 +90,8 @@ export interface AdjustOrderTotalRequest {
 
 export interface CancelOrderRequest {
     orderId: string;
+    lockSelfShipOrders?: boolean;
+    skipRefundAndHold?: boolean;
 }
 
 export interface DeleteOrderRequest {
@@ -266,6 +268,8 @@ 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} orderId The order id to cancel.
+     * @param {boolean} [lockSelfShipOrders] Flag to prevent a order shipping during a refund process
+     * @param {boolean} [skipRefundAndHold] Skip refund and move order to Held Orders department
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof OrderApiInterface
@@ -778,6 +782,14 @@ export class OrderApi extends runtime.BaseAPI implements OrderApiInterface {
 
         const queryParameters: any = {};
 
+        if (requestParameters.lockSelfShipOrders !== undefined) {
+            queryParameters['lock_self_ship_orders'] = requestParameters.lockSelfShipOrders;
+        }
+
+        if (requestParameters.skipRefundAndHold !== undefined) {
+            queryParameters['skip_refund_and_hold'] = requestParameters.skipRefundAndHold;
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
         if (this.configuration && this.configuration.accessToken) {

package/src/models/OrderShipping.ts

@@ -122,6 +122,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}
@@ -239,6 +245,7 @@ export function OrderShippingFromJSONTyped(json: any, ignoreDiscriminator: boole
         'least_cost_route': !exists(json, 'least_cost_route') ? undefined : json['least_cost_route'],
         'least_cost_route_shipping_methods': !exists(json, 'least_cost_route_shipping_methods') ? undefined : json['least_cost_route_shipping_methods'],
         'lift_gate': !exists(json, 'lift_gate') ? undefined : json['lift_gate'],
+        'pickup_dts': !exists(json, 'pickup_dts') ? undefined : json['pickup_dts'],
         'postal_code': !exists(json, 'postal_code') ? undefined : json['postal_code'],
         'rma': !exists(json, 'rma') ? undefined : json['rma'],
         'ship_on_date': !exists(json, 'ship_on_date') ? undefined : json['ship_on_date'],
@@ -281,6 +288,7 @@ export function OrderShippingToJSON(value?: OrderShipping | null): any {
         'least_cost_route': value.least_cost_route,
         'least_cost_route_shipping_methods': value.least_cost_route_shipping_methods,
         'lift_gate': value.lift_gate,
+        'pickup_dts': value.pickup_dts,
         'postal_code': value.postal_code,
         'rma': value.rma,
         'ship_on_date': value.ship_on_date,

package/src/models/ReportDataSet.ts

@@ -104,6 +104,12 @@ export interface ReportDataSet {
      * @memberof ReportDataSet
      */
     page_size?: number;
+    /**
+     * Date/Time of the client submitted the request.  Can be used to resolve out of order query completion results
+     * @type {string}
+     * @memberof ReportDataSet
+     */
+    request_dts?: string;
     /**
      * The schema associated with the data set.
      * @type {Array<ReportDataSetSchema>}
@@ -164,6 +170,7 @@ export function ReportDataSetFromJSONTyped(json: any, ignoreDiscriminator: boole
         'merchant_id': !exists(json, 'merchant_id') ? undefined : json['merchant_id'],
         'page_count': !exists(json, 'page_count') ? undefined : json['page_count'],
         'page_size': !exists(json, 'page_size') ? undefined : json['page_size'],
+        'request_dts': !exists(json, 'request_dts') ? undefined : json['request_dts'],
         'schema': !exists(json, 'schema') ? undefined : ((json['schema'] as Array<any>).map(ReportDataSetSchemaFromJSON)),
         'security_level': !exists(json, 'security_level') ? undefined : json['security_level'],
         'timezone': !exists(json, 'timezone') ? undefined : json['timezone'],
@@ -192,6 +199,7 @@ export function ReportDataSetToJSON(value?: ReportDataSet | null): any {
         'merchant_id': value.merchant_id,
         'page_count': value.page_count,
         'page_size': value.page_size,
+        'request_dts': value.request_dts,
         'schema': value.schema === undefined ? undefined : ((value.schema as Array<any>).map(ReportDataSetSchemaToJSON)),
         'security_level': value.security_level,
         'timezone': value.timezone,

package/src/models/ReportExecuteQueriesRequest.ts

@@ -62,6 +62,12 @@ export interface ReportExecuteQueriesRequest {
      * @memberof ReportExecuteQueriesRequest
      */
     queries?: Array<ReportDataSetQuery>;
+    /**
+     * Date/Time of the client submitted the request.  Can be used to resolve out of order query completion results
+     * @type {string}
+     * @memberof ReportExecuteQueriesRequest
+     */
+    request_dts?: string;
     /**
      * Security level to execute report under
      * @type {string}
@@ -99,6 +105,7 @@ export function ReportExecuteQueriesRequestFromJSONTyped(json: any, ignoreDiscri
         'default_project_id': !exists(json, 'default_project_id') ? undefined : json['default_project_id'],
         'merchant_id': !exists(json, 'merchant_id') ? undefined : json['merchant_id'],
         'queries': !exists(json, 'queries') ? undefined : ((json['queries'] as Array<any>).map(ReportDataSetQueryFromJSON)),
+        'request_dts': !exists(json, 'request_dts') ? undefined : json['request_dts'],
         'security_level': !exists(json, 'security_level') ? undefined : json['security_level'],
     };
 }
@@ -118,6 +125,7 @@ export function ReportExecuteQueriesRequestToJSON(value?: ReportExecuteQueriesRe
         'default_project_id': value.default_project_id,
         'merchant_id': value.merchant_id,
         'queries': value.queries === undefined ? undefined : ((value.queries as Array<any>).map(ReportDataSetQueryToJSON)),
+        'request_dts': value.request_dts,
         'security_level': value.security_level,
     };
 }