ultracart_rest_api_v2_typescript 3.10.103 → 3.10.105

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.10.103
+## ultracart_rest_api_v2_typescript@3.10.105
 
 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.103 --save
+npm install ultracart_rest_api_v2_typescript@3.10.105 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 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 |
 | 3.10.101 | 01/18/2023 | conversation get dept member list method 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>}
@@ -29263,7 +29281,7 @@ export interface OrderInternal {
      */
     exported_to_accounting?: boolean;
     /**
-     * Merchant notes
+     * Merchant notes.  Full notes in non-transactional mode.  Just used to write a new merchant note when transaction merchant notes enabled.
      * @type {string}
      * @memberof OrderInternal
      */
@@ -29286,6 +29304,12 @@ export interface OrderInternal {
      * @memberof OrderInternal
      */
     sales_rep_code?: string;
+    /**
+     * Transactional merchant notes
+     * @type {Array<OrderTransactionalMerchantNote>}
+     * @memberof OrderInternal
+     */
+    transactional_merchant_notes?: Array<OrderTransactionalMerchantNote>;
 }
 
 /**
@@ -31848,6 +31872,38 @@ export interface OrderTrackingNumberDetails {
     tracking_url?: string;
 }
 
+/**
+ * 
+ * @export
+ * @interface OrderTransactionalMerchantNote
+ */
+export interface OrderTransactionalMerchantNote {
+    /**
+     * IP Address
+     * @type {string}
+     * @memberof OrderTransactionalMerchantNote
+     */
+    ip_address?: string;
+    /**
+     * note
+     * @type {string}
+     * @memberof OrderTransactionalMerchantNote
+     */
+    note?: string;
+    /**
+     * Timestamp when the note was added
+     * @type {string}
+     * @memberof OrderTransactionalMerchantNote
+     */
+    note_dts?: string;
+    /**
+     * User that wrote the merchant note
+     * @type {string}
+     * @memberof OrderTransactionalMerchantNote
+     */
+    user?: string;
+}
+
 /**
  * 
  * @export
@@ -44227,6 +44283,58 @@ export const ConversationApiFetchParamCreator = function (configuration?: Config
 
 
 
+            // authentication ultraCartOauth required
+            // oauth required
+            if (configuration && configuration.accessToken) {
+				const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+					? configuration.accessToken("ultraCartOauth", ["conversation_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,
+            };
+        },
+        /**
+         * Retrieve an engagement 
+         * @summary Retrieve an engagement
+         * @param {number} conversation_engagement_oid 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getConversationEngagement(conversation_engagement_oid: number, options: any = {}): FetchArgs {
+            // verify required parameter 'conversation_engagement_oid' is not null or undefined
+            if (conversation_engagement_oid === null || conversation_engagement_oid === undefined) {
+                throw new RequiredError('conversation_engagement_oid','Required parameter conversation_engagement_oid was null or undefined when calling getConversationEngagement.');
+            }
+            const localVarPath = `/conversation/engagements/{conversation_engagement_oid}`
+                .replace(`{${"conversation_engagement_oid"}}`, encodeURIComponent(String(conversation_engagement_oid)));
+            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) {
@@ -45578,6 +45686,27 @@ export const ConversationApiFp = function(configuration?: Configuration) {
                 });
             };
         },
+        /**
+         * Retrieve an engagement 
+         * @summary Retrieve an engagement
+         * @param {number} conversation_engagement_oid 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getConversationEngagement(conversation_engagement_oid: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationEngagementResponse> {
+            const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).getConversationEngagement(conversation_engagement_oid, 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;
+                    }
+                });
+            };
+        },
         /**
          * Retrieve a list of engagements ordered by name 
          * @summary Retrieve a list of engagements ordered by name
@@ -46110,6 +46239,16 @@ export const ConversationApiFactory = function (configuration?: Configuration, f
         getConversationDepartments(options?: any) {
             return ConversationApiFp(configuration).getConversationDepartments(options)(fetch, basePath);
         },
+        /**
+         * Retrieve an engagement 
+         * @summary Retrieve an engagement
+         * @param {number} conversation_engagement_oid 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getConversationEngagement(conversation_engagement_oid: number, options?: any) {
+            return ConversationApiFp(configuration).getConversationEngagement(conversation_engagement_oid, options)(fetch, basePath);
+        },
         /**
          * Retrieve a list of engagements ordered by name 
          * @summary Retrieve a list of engagements ordered by name
@@ -46422,6 +46561,16 @@ export interface ConversationApiInterface {
      */
     getConversationDepartments(options?: any): Promise<ConversationDepartmentsResponse>;
 
+    /**
+     * Retrieve an engagement 
+     * @summary Retrieve an engagement
+     * @param {number} conversation_engagement_oid 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getConversationEngagement(conversation_engagement_oid: number, options?: any): Promise<ConversationEngagementResponse>;
+
     /**
      * Retrieve a list of engagements ordered by name 
      * @summary Retrieve a list of engagements ordered by name
@@ -46754,6 +46903,18 @@ export class ConversationApi extends BaseAPI implements ConversationApiInterface
         return ConversationApiFp(this.configuration).getConversationDepartments(options)(this.fetch, this.basePath);
     }
 
+    /**
+     * Retrieve an engagement 
+     * @summary Retrieve an engagement
+     * @param {number} conversation_engagement_oid 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    public getConversationEngagement(conversation_engagement_oid: number, options?: any) {
+        return ConversationApiFp(this.configuration).getConversationEngagement(conversation_engagement_oid, options)(this.fetch, this.basePath);
+    }
+
     /**
      * Retrieve a list of engagements ordered by name 
      * @summary Retrieve a list of engagements ordered by name

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>}
@@ -28642,7 +28660,7 @@ export interface OrderInternal {
      */
     exported_to_accounting?: boolean;
     /**
-     * Merchant notes
+     * Merchant notes.  Full notes in non-transactional mode.  Just used to write a new merchant note when transaction merchant notes enabled.
      * @type {string}
      * @memberof OrderInternal
      */
@@ -28665,6 +28683,12 @@ export interface OrderInternal {
      * @memberof OrderInternal
      */
     sales_rep_code?: string;
+    /**
+     * Transactional merchant notes
+     * @type {Array<OrderTransactionalMerchantNote>}
+     * @memberof OrderInternal
+     */
+    transactional_merchant_notes?: Array<OrderTransactionalMerchantNote>;
 }
 /**
  *
@@ -31181,6 +31205,37 @@ export interface OrderTrackingNumberDetails {
      */
     tracking_url?: string;
 }
+/**
+ *
+ * @export
+ * @interface OrderTransactionalMerchantNote
+ */
+export interface OrderTransactionalMerchantNote {
+    /**
+     * IP Address
+     * @type {string}
+     * @memberof OrderTransactionalMerchantNote
+     */
+    ip_address?: string;
+    /**
+     * note
+     * @type {string}
+     * @memberof OrderTransactionalMerchantNote
+     */
+    note?: string;
+    /**
+     * Timestamp when the note was added
+     * @type {string}
+     * @memberof OrderTransactionalMerchantNote
+     */
+    note_dts?: string;
+    /**
+     * User that wrote the merchant note
+     * @type {string}
+     * @memberof OrderTransactionalMerchantNote
+     */
+    user?: string;
+}
 /**
  *
  * @export
@@ -39640,6 +39695,14 @@ export declare const ConversationApiFetchParamCreator: (configuration?: Configur
      * @throws {RequiredError}
      */
     getConversationDepartments(options?: any): FetchArgs;
+    /**
+     * Retrieve an engagement
+     * @summary Retrieve an engagement
+     * @param {number} conversation_engagement_oid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getConversationEngagement(conversation_engagement_oid: number, options?: any): FetchArgs;
     /**
      * Retrieve a list of engagements ordered by name
      * @summary Retrieve a list of engagements ordered by name
@@ -39889,6 +39952,14 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getConversationDepartments(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationDepartmentsResponse>;
+    /**
+     * Retrieve an engagement
+     * @summary Retrieve an engagement
+     * @param {number} conversation_engagement_oid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getConversationEngagement(conversation_engagement_oid: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationEngagementResponse>;
     /**
      * Retrieve a list of engagements ordered by name
      * @summary Retrieve a list of engagements ordered by name
@@ -40138,6 +40209,14 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
      * @throws {RequiredError}
      */
     getConversationDepartments(options?: any): Promise<ConversationDepartmentsResponse>;
+    /**
+     * Retrieve an engagement
+     * @summary Retrieve an engagement
+     * @param {number} conversation_engagement_oid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getConversationEngagement(conversation_engagement_oid: number, options?: any): Promise<ConversationEngagementResponse>;
     /**
      * Retrieve a list of engagements ordered by name
      * @summary Retrieve a list of engagements ordered by name
@@ -40398,6 +40477,15 @@ export interface ConversationApiInterface {
      * @memberof ConversationApiInterface
      */
     getConversationDepartments(options?: any): Promise<ConversationDepartmentsResponse>;
+    /**
+     * Retrieve an engagement
+     * @summary Retrieve an engagement
+     * @param {number} conversation_engagement_oid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getConversationEngagement(conversation_engagement_oid: number, options?: any): Promise<ConversationEngagementResponse>;
     /**
      * Retrieve a list of engagements ordered by name
      * @summary Retrieve a list of engagements ordered by name
@@ -40679,6 +40767,15 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
      * @memberof ConversationApi
      */
     getConversationDepartments(options?: any): Promise<ConversationDepartmentsResponse>;
+    /**
+     * Retrieve an engagement
+     * @summary Retrieve an engagement
+     * @param {number} conversation_engagement_oid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    getConversationEngagement(conversation_engagement_oid: number, options?: any): Promise<ConversationEngagementResponse>;
     /**
      * Retrieve a list of engagements ordered by name
      * @summary Retrieve a list of engagements ordered by name

package/dist/api.js

@@ -6587,6 +6587,52 @@ var ConversationApiFetchParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Retrieve an engagement
+         * @summary Retrieve an engagement
+         * @param {number} conversation_engagement_oid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getConversationEngagement: function (conversation_engagement_oid, options) {
+            if (options === void 0) { options = {}; }
+            // verify required parameter 'conversation_engagement_oid' is not null or undefined
+            if (conversation_engagement_oid === null || conversation_engagement_oid === undefined) {
+                throw new RequiredError('conversation_engagement_oid', 'Required parameter conversation_engagement_oid was null or undefined when calling getConversationEngagement.');
+            }
+            var localVarPath = "/conversation/engagements/{conversation_engagement_oid}"
+                .replace("{".concat("conversation_engagement_oid", "}"), encodeURIComponent(String(conversation_engagement_oid)));
+            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", ["conversation_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,
+            };
+        },
         /**
          * Retrieve a list of engagements ordered by name
          * @summary Retrieve a list of engagements ordered by name
@@ -7784,6 +7830,28 @@ var ConversationApiFp = function (configuration) {
                 });
             };
         },
+        /**
+         * Retrieve an engagement
+         * @summary Retrieve an engagement
+         * @param {number} conversation_engagement_oid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getConversationEngagement: function (conversation_engagement_oid, options) {
+            var localVarFetchArgs = (0, exports.ConversationApiFetchParamCreator)(configuration).getConversationEngagement(conversation_engagement_oid, 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;
+                    }
+                });
+            };
+        },
         /**
          * Retrieve a list of engagements ordered by name
          * @summary Retrieve a list of engagements ordered by name
@@ -8336,6 +8404,16 @@ var ConversationApiFactory = function (configuration, fetch, basePath) {
         getConversationDepartments: function (options) {
             return (0, exports.ConversationApiFp)(configuration).getConversationDepartments(options)(fetch, basePath);
         },
+        /**
+         * Retrieve an engagement
+         * @summary Retrieve an engagement
+         * @param {number} conversation_engagement_oid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getConversationEngagement: function (conversation_engagement_oid, options) {
+            return (0, exports.ConversationApiFp)(configuration).getConversationEngagement(conversation_engagement_oid, options)(fetch, basePath);
+        },
         /**
          * Retrieve a list of engagements ordered by name
          * @summary Retrieve a list of engagements ordered by name
@@ -8663,6 +8741,17 @@ var ConversationApi = /** @class */ (function (_super) {
     ConversationApi.prototype.getConversationDepartments = function (options) {
         return (0, exports.ConversationApiFp)(this.configuration).getConversationDepartments(options)(this.fetch, this.basePath);
     };
+    /**
+     * Retrieve an engagement
+     * @summary Retrieve an engagement
+     * @param {number} conversation_engagement_oid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    ConversationApi.prototype.getConversationEngagement = function (conversation_engagement_oid, options) {
+        return (0, exports.ConversationApiFp)(this.configuration).getConversationEngagement(conversation_engagement_oid, options)(this.fetch, this.basePath);
+    };
     /**
      * Retrieve a list of engagements ordered by name
      * @summary Retrieve a list of engagements ordered by name

package/package.json

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