ultracart_rest_api_v2_typescript 4.0.160 → 4.0.162

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@4.0.160
+## ultracart_rest_api_v2_typescript@4.0.162
 
 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.160 --save
+npm install ultracart_rest_api_v2_typescript@4.0.162 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.162 | 06/20/2023 | coupon add allowed values for usable_by and new OncePerNewCustomerForItem flag |
+| 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 |

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/Coupon.d.ts

@@ -458,8 +458,19 @@ export interface Coupon {
      * @type {string}
      * @memberof Coupon
      */
-    usable_by?: string;
+    usable_by?: CouponUsableByEnum;
 }
+/**
+ * @export
+ */
+export declare const CouponUsableByEnum: {
+    readonly Anyone: "Anyone";
+    readonly UniqueCode: "UniqueCode";
+    readonly OncePerCustomer: "OncePerCustomer";
+    readonly OncePerNewCustomer: "OncePerNewCustomer";
+    readonly OncePerNewCustomerForItem: "OncePerNewCustomerForItem";
+};
+export type CouponUsableByEnum = typeof CouponUsableByEnum[keyof typeof CouponUsableByEnum];
 export declare function CouponFromJSON(json: any): Coupon;
 export declare function CouponFromJSONTyped(json: any, ignoreDiscriminator: boolean): Coupon;
 export declare function CouponToJSON(value?: Coupon | null): any;

package/dist/models/Coupon.js

@@ -13,7 +13,7 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CouponToJSON = exports.CouponFromJSONTyped = exports.CouponFromJSON = void 0;
+exports.CouponToJSON = exports.CouponFromJSONTyped = exports.CouponFromJSON = exports.CouponUsableByEnum = void 0;
 var runtime_1 = require("../runtime");
 var CouponAmountOffItems_1 = require("./CouponAmountOffItems");
 var CouponAmountOffShipping_1 = require("./CouponAmountOffShipping");
@@ -63,6 +63,16 @@ var CouponTieredPercentOffItems_1 = require("./CouponTieredPercentOffItems");
 var CouponTieredPercentOffShipping_1 = require("./CouponTieredPercentOffShipping");
 var CouponTieredPercentOffSubtotal_1 = require("./CouponTieredPercentOffSubtotal");
 var CouponTieredPercentOffSubtotalBasedOnMSRP_1 = require("./CouponTieredPercentOffSubtotalBasedOnMSRP");
+/**
+ * @export
+ */
+exports.CouponUsableByEnum = {
+    Anyone: 'Anyone',
+    UniqueCode: 'UniqueCode',
+    OncePerCustomer: 'OncePerCustomer',
+    OncePerNewCustomer: 'OncePerNewCustomer',
+    OncePerNewCustomerForItem: 'OncePerNewCustomerForItem'
+};
 function CouponFromJSON(json) {
     return CouponFromJSONTyped(json, false);
 }

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "4.0.160",
+  "version": "4.0.162",
   "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/Coupon.ts

@@ -703,9 +703,23 @@ export interface Coupon {
      * @type {string}
      * @memberof Coupon
      */
-    usable_by?: string;
+    usable_by?: CouponUsableByEnum;
 }
 
+
+/**
+ * @export
+ */
+export const CouponUsableByEnum = {
+    Anyone: 'Anyone',
+    UniqueCode: 'UniqueCode',
+    OncePerCustomer: 'OncePerCustomer',
+    OncePerNewCustomer: 'OncePerNewCustomer',
+    OncePerNewCustomerForItem: 'OncePerNewCustomerForItem'
+} as const;
+export type CouponUsableByEnum = typeof CouponUsableByEnum[keyof typeof CouponUsableByEnum];
+
+
 export function CouponFromJSON(json: any): Coupon {
     return CouponFromJSONTyped(json, false);
 }

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,