ultracart_rest_api_v2_typescript 3.10.104 → 3.10.106

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.10.104
+## ultracart_rest_api_v2_typescript@3.10.106
 
 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.104 --save
+npm install ultracart_rest_api_v2_typescript@3.10.106 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.106 | 01/25/2023 | order api method generateInvoice |
+| 3.10.105 | 01/24/2023 | auto order - cancel minimum and change balance options |
 | 3.10.104 | 01/23/2023 | conversation - method to fetch single engagement record |
 | 3.10.103 | 01/19/2023 | added skip_on_rebill field to coupon object |
 | 3.10.102 | 01/19/2023 | convo - getConversationPermissions added |

package/api.ts

@@ -22387,6 +22387,12 @@ export interface ItemAutoOrder {
      * @memberof ItemAutoOrder
      */
     auth_test_amount?: number;
+    /**
+     * If true, the cost of the cancel item will be the remaining balance of the minimum rebill or lifetime value
+     * @type {boolean}
+     * @memberof ItemAutoOrder
+     */
+    auto_order_cancel_charge_minimum_balance?: boolean;
     /**
      * Item id to attempt charging the customer for if they cancel
      * @type {string}
@@ -22399,6 +22405,18 @@ export interface ItemAutoOrder {
      * @memberof ItemAutoOrder
      */
     auto_order_cancel_item_oid?: number;
+    /**
+     * The minimum life time value that must be paid in order to not be charged the cancellation item.
+     * @type {number}
+     * @memberof ItemAutoOrder
+     */
+    auto_order_cancel_minimum_life_time_value?: number;
+    /**
+     * The minimum rebill value that must be paid in order to not be charged the cancellation item.
+     * @type {number}
+     * @memberof ItemAutoOrder
+     */
+    auto_order_cancel_minimum_rebill_value?: number;
     /**
      * List of downgrade items presented to customer service representatives
      * @type {Array<string>}
@@ -29294,6 +29312,44 @@ export interface OrderInternal {
     transactional_merchant_notes?: Array<OrderTransactionalMerchantNote>;
 }
 
+/**
+ * 
+ * @export
+ * @interface OrderInvoiceResponse
+ */
+export interface OrderInvoiceResponse {
+    /**
+     * 
+     * @type {ModelError}
+     * @memberof OrderInvoiceResponse
+     */
+    error?: ModelError;
+    /**
+     * 
+     * @type {ResponseMetadata}
+     * @memberof OrderInvoiceResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * pdf_base64
+     * @type {string}
+     * @memberof OrderInvoiceResponse
+     */
+    pdfBase64?: string;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof OrderInvoiceResponse
+     */
+    success?: boolean;
+    /**
+     * 
+     * @type {Warning}
+     * @memberof OrderInvoiceResponse
+     */
+    warning?: Warning;
+}
+
 /**
  * 
  * @export
@@ -56917,6 +56973,58 @@ export const OrderApiFetchParamCreator = function (configuration?: Configuration
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * The invoice PDF that is returned is base 64 encoded 
+         * @summary Generate an invoice for this order.
+         * @param {string} order_id Order ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        generateInvoice(order_id: string, 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 generateInvoice.');
+            }
+            const localVarPath = `/order/orders/{order_id}/invoice`
+                .replace(`{${"order_id"}}`, encodeURIComponent(String(order_id)));
+            const localVarUrlObj = url.parse(localVarPath, true);
+            const localVarRequestOptions = Object.assign({ method: 'GET' }, 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", ["order_read"])
+					: 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;
+            }
+
+            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);
+
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Retrieves a single order token for a given order id.  The token can be used with the getOrderByToken API. 
          * @summary Generate an order token for a given order id
@@ -58306,6 +58414,27 @@ export const OrderApiFp = function(configuration?: Configuration) {
                 });
             };
         },
+        /**
+         * The invoice PDF that is returned is base 64 encoded 
+         * @summary Generate an invoice for this order.
+         * @param {string} order_id Order ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        generateInvoice(order_id: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderInvoiceResponse> {
+            const localVarFetchArgs = OrderApiFetchParamCreator(configuration).generateInvoice(order_id, 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;
+                    }
+                });
+            };
+        },
         /**
          * Retrieves a single order token for a given order id.  The token can be used with the getOrderByToken API. 
          * @summary Generate an order token for a given order id
@@ -58818,6 +58947,16 @@ export const OrderApiFactory = function (configuration?: Configuration, fetch?:
         format(order_id: string, format_options: OrderFormat, options?: any) {
             return OrderApiFp(configuration).format(order_id, format_options, options)(fetch, basePath);
         },
+        /**
+         * The invoice PDF that is returned is base 64 encoded 
+         * @summary Generate an invoice for this order.
+         * @param {string} order_id Order ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        generateInvoice(order_id: string, options?: any) {
+            return OrderApiFp(configuration).generateInvoice(order_id, options)(fetch, basePath);
+        },
         /**
          * Retrieves a single order token for a given order id.  The token can be used with the getOrderByToken API. 
          * @summary Generate an order token for a given order id
@@ -59121,6 +59260,16 @@ export interface OrderApiInterface {
      */
     format(order_id: string, format_options: OrderFormat, options?: any): Promise<OrderFormatResponse>;
 
+    /**
+     * The invoice PDF that is returned is base 64 encoded 
+     * @summary Generate an invoice for this order.
+     * @param {string} order_id Order ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApiInterface
+     */
+    generateInvoice(order_id: string, options?: any): Promise<OrderInvoiceResponse>;
+
     /**
      * Retrieves a single order token for a given order id.  The token can be used with the getOrderByToken API. 
      * @summary Generate an order token for a given order id
@@ -59434,6 +59583,18 @@ export class OrderApi extends BaseAPI implements OrderApiInterface {
         return OrderApiFp(this.configuration).format(order_id, format_options, options)(this.fetch, this.basePath);
     }
 
+    /**
+     * The invoice PDF that is returned is base 64 encoded 
+     * @summary Generate an invoice for this order.
+     * @param {string} order_id Order ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApi
+     */
+    public generateInvoice(order_id: string, options?: any) {
+        return OrderApiFp(this.configuration).generateInvoice(order_id, options)(this.fetch, this.basePath);
+    }
+
     /**
      * Retrieves a single order token for a given order id.  The token can be used with the getOrderByToken API. 
      * @summary Generate an order token for a given order id

package/dist/api.d.ts

@@ -21900,6 +21900,12 @@ export interface ItemAutoOrder {
      * @memberof ItemAutoOrder
      */
     auth_test_amount?: number;
+    /**
+     * If true, the cost of the cancel item will be the remaining balance of the minimum rebill or lifetime value
+     * @type {boolean}
+     * @memberof ItemAutoOrder
+     */
+    auto_order_cancel_charge_minimum_balance?: boolean;
     /**
      * Item id to attempt charging the customer for if they cancel
      * @type {string}
@@ -21912,6 +21918,18 @@ export interface ItemAutoOrder {
      * @memberof ItemAutoOrder
      */
     auto_order_cancel_item_oid?: number;
+    /**
+     * The minimum life time value that must be paid in order to not be charged the cancellation item.
+     * @type {number}
+     * @memberof ItemAutoOrder
+     */
+    auto_order_cancel_minimum_life_time_value?: number;
+    /**
+     * The minimum rebill value that must be paid in order to not be charged the cancellation item.
+     * @type {number}
+     * @memberof ItemAutoOrder
+     */
+    auto_order_cancel_minimum_rebill_value?: number;
     /**
      * List of downgrade items presented to customer service representatives
      * @type {Array<string>}
@@ -28672,6 +28690,43 @@ export interface OrderInternal {
      */
     transactional_merchant_notes?: Array<OrderTransactionalMerchantNote>;
 }
+/**
+ *
+ * @export
+ * @interface OrderInvoiceResponse
+ */
+export interface OrderInvoiceResponse {
+    /**
+     *
+     * @type {ModelError}
+     * @memberof OrderInvoiceResponse
+     */
+    error?: ModelError;
+    /**
+     *
+     * @type {ResponseMetadata}
+     * @memberof OrderInvoiceResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * pdf_base64
+     * @type {string}
+     * @memberof OrderInvoiceResponse
+     */
+    pdfBase64?: string;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof OrderInvoiceResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {Warning}
+     * @memberof OrderInvoiceResponse
+     */
+    warning?: Warning;
+}
 /**
  *
  * @export
@@ -45005,6 +45060,14 @@ export declare const OrderApiFetchParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     format(order_id: string, format_options: OrderFormat, options?: any): FetchArgs;
+    /**
+     * The invoice PDF that is returned is base 64 encoded
+     * @summary Generate an invoice for this order.
+     * @param {string} order_id Order ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    generateInvoice(order_id: string, options?: any): FetchArgs;
     /**
      * Retrieves a single order token for a given order id.  The token can be used with the getOrderByToken API.
      * @summary Generate an order token for a given order id
@@ -45257,6 +45320,14 @@ export declare const OrderApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     format(order_id: string, format_options: OrderFormat, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderFormatResponse>;
+    /**
+     * The invoice PDF that is returned is base 64 encoded
+     * @summary Generate an invoice for this order.
+     * @param {string} order_id Order ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    generateInvoice(order_id: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderInvoiceResponse>;
     /**
      * Retrieves a single order token for a given order id.  The token can be used with the getOrderByToken API.
      * @summary Generate an order token for a given order id
@@ -45509,6 +45580,14 @@ export declare const OrderApiFactory: (configuration?: Configuration, fetch?: Fe
      * @throws {RequiredError}
      */
     format(order_id: string, format_options: OrderFormat, options?: any): Promise<OrderFormatResponse>;
+    /**
+     * The invoice PDF that is returned is base 64 encoded
+     * @summary Generate an invoice for this order.
+     * @param {string} order_id Order ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    generateInvoice(order_id: string, options?: any): Promise<OrderInvoiceResponse>;
     /**
      * Retrieves a single order token for a given order id.  The token can be used with the getOrderByToken API.
      * @summary Generate an order token for a given order id
@@ -45767,6 +45846,15 @@ export interface OrderApiInterface {
      * @memberof OrderApiInterface
      */
     format(order_id: string, format_options: OrderFormat, options?: any): Promise<OrderFormatResponse>;
+    /**
+     * The invoice PDF that is returned is base 64 encoded
+     * @summary Generate an invoice for this order.
+     * @param {string} order_id Order ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApiInterface
+     */
+    generateInvoice(order_id: string, options?: any): Promise<OrderInvoiceResponse>;
     /**
      * Retrieves a single order token for a given order id.  The token can be used with the getOrderByToken API.
      * @summary Generate an order token for a given order id
@@ -46045,6 +46133,15 @@ export declare class OrderApi extends BaseAPI implements OrderApiInterface {
      * @memberof OrderApi
      */
     format(order_id: string, format_options: OrderFormat, options?: any): Promise<OrderFormatResponse>;
+    /**
+     * The invoice PDF that is returned is base 64 encoded
+     * @summary Generate an invoice for this order.
+     * @param {string} order_id Order ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApi
+     */
+    generateInvoice(order_id: string, options?: any): Promise<OrderInvoiceResponse>;
     /**
      * Retrieves a single order token for a given order id.  The token can be used with the getOrderByToken API.
      * @summary Generate an order token for a given order id

package/dist/api.js

@@ -17214,6 +17214,52 @@ var OrderApiFetchParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * The invoice PDF that is returned is base 64 encoded
+         * @summary Generate an invoice for this order.
+         * @param {string} order_id Order ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        generateInvoice: function (order_id, options) {
+            if (options === void 0) { options = {}; }
+            // 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 generateInvoice.');
+            }
+            var localVarPath = "/order/orders/{order_id}/invoice"
+                .replace("{".concat("order_id", "}"), encodeURIComponent(String(order_id)));
+            var localVarUrlObj = url.parse(localVarPath, true);
+            var localVarRequestOptions = Object.assign({ method: 'GET' }, 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", ["order_read"])
+                    : 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;
+            }
+            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);
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Retrieves a single order token for a given order id.  The token can be used with the getOrderByToken API.
          * @summary Generate an order token for a given order id
@@ -18436,6 +18482,28 @@ var OrderApiFp = function (configuration) {
                 });
             };
         },
+        /**
+         * The invoice PDF that is returned is base 64 encoded
+         * @summary Generate an invoice for this order.
+         * @param {string} order_id Order ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        generateInvoice: function (order_id, options) {
+            var localVarFetchArgs = (0, exports.OrderApiFetchParamCreator)(configuration).generateInvoice(order_id, 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;
+                    }
+                });
+            };
+        },
         /**
          * Retrieves a single order token for a given order id.  The token can be used with the getOrderByToken API.
          * @summary Generate an order token for a given order id
@@ -18967,6 +19035,16 @@ var OrderApiFactory = function (configuration, fetch, basePath) {
         format: function (order_id, format_options, options) {
             return (0, exports.OrderApiFp)(configuration).format(order_id, format_options, options)(fetch, basePath);
         },
+        /**
+         * The invoice PDF that is returned is base 64 encoded
+         * @summary Generate an invoice for this order.
+         * @param {string} order_id Order ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        generateInvoice: function (order_id, options) {
+            return (0, exports.OrderApiFp)(configuration).generateInvoice(order_id, options)(fetch, basePath);
+        },
         /**
          * Retrieves a single order token for a given order id.  The token can be used with the getOrderByToken API.
          * @summary Generate an order token for a given order id
@@ -19280,6 +19358,17 @@ var OrderApi = /** @class */ (function (_super) {
     OrderApi.prototype.format = function (order_id, format_options, options) {
         return (0, exports.OrderApiFp)(this.configuration).format(order_id, format_options, options)(this.fetch, this.basePath);
     };
+    /**
+     * The invoice PDF that is returned is base 64 encoded
+     * @summary Generate an invoice for this order.
+     * @param {string} order_id Order ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApi
+     */
+    OrderApi.prototype.generateInvoice = function (order_id, options) {
+        return (0, exports.OrderApiFp)(this.configuration).generateInvoice(order_id, options)(this.fetch, this.basePath);
+    };
     /**
      * Retrieves a single order token for a given order id.  The token can be used with the getOrderByToken API.
      * @summary Generate an order token for a given order id

package/package.json

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