ultracart_rest_api_v2_typescript 4.0.161 → 4.0.163

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@4.0.161
+## ultracart_rest_api_v2_typescript@4.0.163
 
 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.161 --save
+npm install ultracart_rest_api_v2_typescript@4.0.163 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.163 | 06/20/2023 | auto order - establishAutoOrderByReferenceOrderId method added |
+| 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 |

package/dist/apis/AutoOrderApi.d.ts

@@ -11,6 +11,10 @@
  */
 import * as runtime from '../runtime';
 import { AutoOrder, AutoOrderQuery, AutoOrderQueryBatch, AutoOrderResponse, AutoOrdersRequest, AutoOrdersResponse } from '../models';
+export interface EstablishAutoOrderByReferenceOrderIdRequest {
+    referenceOrderId: string;
+    expand?: string;
+}
 export interface GetAutoOrderRequest {
     autoOrderOid: number;
     expand?: string;
@@ -77,6 +81,21 @@ export interface UpdateAutoOrdersBatchRequest {
  * @interface AutoOrderApiInterface
  */
 export interface AutoOrderApiInterface {
+    /**
+     * Establish an auto order by referencing a regular order id.  The result will be an auto order without any items.  You should add the items and perform an update call.  Orders must be less than 60 days old and use a credit card payment.
+     * @summary Establish an auto order by referencing a regular order id
+     * @param {string} referenceOrderId The order id to attach this auto order to
+     * @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
+     */
+    establishAutoOrderByReferenceOrderIdRaw(requestParameters: EstablishAutoOrderByReferenceOrderIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderResponse>>;
+    /**
+     * Establish an auto order by referencing a regular order id.  The result will be an auto order without any items.  You should add the items and perform an update call.  Orders must be less than 60 days old and use a credit card payment.
+     * Establish an auto order by referencing a regular order id
+     */
+    establishAutoOrderByReferenceOrderId(requestParameters: EstablishAutoOrderByReferenceOrderIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
     /**
      * Retrieves a single auto order using the specified auto order oid.
      * @summary Retrieve an auto order by oid
@@ -229,6 +248,16 @@ export interface AutoOrderApiInterface {
  *
  */
 export declare class AutoOrderApi extends runtime.BaseAPI implements AutoOrderApiInterface {
+    /**
+     * Establish an auto order by referencing a regular order id.  The result will be an auto order without any items.  You should add the items and perform an update call.  Orders must be less than 60 days old and use a credit card payment.
+     * Establish an auto order by referencing a regular order id
+     */
+    establishAutoOrderByReferenceOrderIdRaw(requestParameters: EstablishAutoOrderByReferenceOrderIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderResponse>>;
+    /**
+     * Establish an auto order by referencing a regular order id.  The result will be an auto order without any items.  You should add the items and perform an update call.  Orders must be less than 60 days old and use a credit card payment.
+     * Establish an auto order by referencing a regular order id
+     */
+    establishAutoOrderByReferenceOrderId(requestParameters: EstablishAutoOrderByReferenceOrderIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
     /**
      * Retrieves a single auto order using the specified auto order oid.
      * Retrieve an auto order by oid

package/dist/apis/AutoOrderApi.js

@@ -75,6 +75,68 @@ var AutoOrderApi = /** @class */ (function (_super) {
     function AutoOrderApi() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
+    /**
+     * Establish an auto order by referencing a regular order id.  The result will be an auto order without any items.  You should add the items and perform an update call.  Orders must be less than 60 days old and use a credit card payment.
+     * Establish an auto order by referencing a regular order id
+     */
+    AutoOrderApi.prototype.establishAutoOrderByReferenceOrderIdRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.referenceOrderId === null || requestParameters.referenceOrderId === undefined) {
+                            throw new runtime.RequiredError('referenceOrderId', 'Required parameter requestParameters.referenceOrderId was null or undefined when calling establishAutoOrderByReferenceOrderId.');
+                        }
+                        queryParameters = {};
+                        if (requestParameters.expand !== undefined) {
+                            queryParameters['_expand'] = requestParameters.expand;
+                        }
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["auto_order_write"])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/auto_order/auto_orders/reference_order_id/{reference_order_id}".replace("{".concat("reference_order_id", "}"), encodeURIComponent(String(requestParameters.referenceOrderId))),
+                                method: 'POST',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.AutoOrderResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Establish an auto order by referencing a regular order id.  The result will be an auto order without any items.  You should add the items and perform an update call.  Orders must be less than 60 days old and use a credit card payment.
+     * Establish an auto order by referencing a regular order id
+     */
+    AutoOrderApi.prototype.establishAutoOrderByReferenceOrderId = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.establishAutoOrderByReferenceOrderIdRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Retrieves a single auto order using the specified auto order oid.
      * Retrieve an auto order by oid

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

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

package/src/apis/AutoOrderApi.ts

@@ -38,6 +38,11 @@ import {
     ErrorResponseToJSON,
 } from '../models';
 
+export interface EstablishAutoOrderByReferenceOrderIdRequest {
+    referenceOrderId: string;
+    expand?: string;
+}
+
 export interface GetAutoOrderRequest {
     autoOrderOid: number;
     expand?: string;
@@ -112,6 +117,23 @@ export interface UpdateAutoOrdersBatchRequest {
  * @interface AutoOrderApiInterface
  */
 export interface AutoOrderApiInterface {
+    /**
+     * Establish an auto order by referencing a regular order id.  The result will be an auto order without any items.  You should add the items and perform an update call.  Orders must be less than 60 days old and use a credit card payment. 
+     * @summary Establish an auto order by referencing a regular order id
+     * @param {string} referenceOrderId The order id to attach this auto order to
+     * @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
+     */
+    establishAutoOrderByReferenceOrderIdRaw(requestParameters: EstablishAutoOrderByReferenceOrderIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderResponse>>;
+
+    /**
+     * Establish an auto order by referencing a regular order id.  The result will be an auto order without any items.  You should add the items and perform an update call.  Orders must be less than 60 days old and use a credit card payment. 
+     * Establish an auto order by referencing a regular order id
+     */
+    establishAutoOrderByReferenceOrderId(requestParameters: EstablishAutoOrderByReferenceOrderIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
+
     /**
      * Retrieves a single auto order using the specified auto order oid. 
      * @summary Retrieve an auto order by oid
@@ -282,6 +304,51 @@ export interface AutoOrderApiInterface {
  */
 export class AutoOrderApi extends runtime.BaseAPI implements AutoOrderApiInterface {
 
+    /**
+     * Establish an auto order by referencing a regular order id.  The result will be an auto order without any items.  You should add the items and perform an update call.  Orders must be less than 60 days old and use a credit card payment. 
+     * Establish an auto order by referencing a regular order id
+     */
+    async establishAutoOrderByReferenceOrderIdRaw(requestParameters: EstablishAutoOrderByReferenceOrderIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderResponse>> {
+        if (requestParameters.referenceOrderId === null || requestParameters.referenceOrderId === undefined) {
+            throw new runtime.RequiredError('referenceOrderId','Required parameter requestParameters.referenceOrderId was null or undefined when calling establishAutoOrderByReferenceOrderId.');
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters.expand !== undefined) {
+            queryParameters['_expand'] = requestParameters.expand;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["auto_order_write"]);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+        }
+
+        const response = await this.request({
+            path: `/auto_order/auto_orders/reference_order_id/{reference_order_id}`.replace(`{${"reference_order_id"}}`, encodeURIComponent(String(requestParameters.referenceOrderId))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AutoOrderResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Establish an auto order by referencing a regular order id.  The result will be an auto order without any items.  You should add the items and perform an update call.  Orders must be less than 60 days old and use a credit card payment. 
+     * Establish an auto order by referencing a regular order id
+     */
+    async establishAutoOrderByReferenceOrderId(requestParameters: EstablishAutoOrderByReferenceOrderIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse> {
+        const response = await this.establishAutoOrderByReferenceOrderIdRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Retrieves a single auto order using the specified auto order oid. 
      * Retrieve an auto order by oid

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);
 }