ultracart_rest_api_v2_typescript 3.10.186 → 3.10.187

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.10.186
+## ultracart_rest_api_v2_typescript@3.10.187
 
 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.186 --save
+npm install ultracart_rest_api_v2_typescript@3.10.187 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.187 | 03/19/2024 | workflow task - addl status values, expiration_dts, and system task type |
 | 3.10.186 | 03/15/2024 | workflow - getWorkflowAgentWebsocketAuthorization method added |
 | 3.10.185 | 03/08/2024 | added getWorkflowTaskTags method |
 | 3.10.184 | 02/27/2024 | esp - sms statistic layer |

package/api.ts

@@ -43329,6 +43329,12 @@ export interface WorkflowTask {
      * @memberof WorkflowTask
      */
     due_dts?: string;
+    /**
+     * Date/time that the workflow task will expire and be closed.  This is set by system generated tasks.
+     * @type {string}
+     * @memberof WorkflowTask
+     */
+    expiration_dts?: string;
     /**
      * Array of history records for the task
      * @type {Array<WorkflowTaskHistory>}
@@ -43401,6 +43407,12 @@ export interface WorkflowTask {
      * @memberof WorkflowTask
      */
     status?: WorkflowTask.StatusEnum;
+    /**
+     * Constant for the type of system generated task
+     * @type {string}
+     * @memberof WorkflowTask
+     */
+    system_task_type?: WorkflowTask.SystemTaskTypeEnum;
     /**
      * Tags
      * @type {Array<string>}
@@ -43467,7 +43479,22 @@ export namespace WorkflowTask {
         Open = <any> 'open',
         Closed = <any> 'closed',
         Delayed = <any> 'delayed',
-        AwaitingCustomerFeedback = <any> 'awaiting customer feedback'
+        AwaitingCustomerFeedback = <any> 'awaiting customer feedback',
+        ClosedSystem = <any> 'closed - system',
+        ClosedCustomer = <any> 'closed - customer',
+        ClosedExpiration = <any> 'closed - expiration'
+    }
+    /**
+     * @export
+     * @enum {string}
+     */
+    export enum SystemTaskTypeEnum {
+        OrderAccountsReceivable = <any> 'order_accounts_receivable',
+        OrderFraudReview = <any> 'order_fraud_review',
+        AutoOrderCardUpdateIssue = <any> 'auto_order_card_update_issue',
+        AutoOrderCanceledPayment = <any> 'auto_order_canceled_payment',
+        ItemLowStock = <any> 'item_low_stock',
+        ItemOutOfStock = <any> 'item_out_of_stock'
     }
 }
 
@@ -52928,6 +52955,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_write"])
+					: 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,
+            };
+        },
+        /**
+         * reset statistics within the queue 
+         * @summary reset statistics within the queue
+         * @param {string} queue_uuid 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        resetConversationPbxQueueStatistics(queue_uuid: string, options: any = {}): FetchArgs {
+            // verify required parameter 'queue_uuid' is not null or undefined
+            if (queue_uuid === null || queue_uuid === undefined) {
+                throw new RequiredError('queue_uuid','Required parameter queue_uuid was null or undefined when calling resetConversationPbxQueueStatistics.');
+            }
+            const localVarPath = `/conversation/pbx/queues/{queue_uuid}/reset_statistics`
+                .replace(`{${"queue_uuid"}}`, encodeURIComponent(String(queue_uuid)));
+            const localVarUrlObj = url.parse(localVarPath, true);
+            const localVarRequestOptions = Object.assign({ method: 'POST' }, 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) {
@@ -55183,6 +55262,27 @@ export const ConversationApiFp = function(configuration?: Configuration) {
                 });
             };
         },
+        /**
+         * reset statistics within the queue 
+         * @summary reset statistics within the queue
+         * @param {string} queue_uuid 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        resetConversationPbxQueueStatistics(queue_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response> {
+            const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).resetConversationPbxQueueStatistics(queue_uuid, 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;
+                      
+                    } else {
+                        throw response;
+                    }
+                });
+            };
+        },
         /**
          * Search for canned messages by short_code 
          * @summary Search for canned messages by short_code
@@ -56139,6 +56239,16 @@ export const ConversationApiFactory = function (configuration?: Configuration, f
         markReadConversation(conversation_uuid: string, options?: any) {
             return ConversationApiFp(configuration).markReadConversation(conversation_uuid, options)(fetch, basePath);
         },
+        /**
+         * reset statistics within the queue 
+         * @summary reset statistics within the queue
+         * @param {string} queue_uuid 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        resetConversationPbxQueueStatistics(queue_uuid: string, options?: any) {
+            return ConversationApiFp(configuration).resetConversationPbxQueueStatistics(queue_uuid, options)(fetch, basePath);
+        },
         /**
          * Search for canned messages by short_code 
          * @summary Search for canned messages by short_code
@@ -56919,6 +57029,16 @@ export interface ConversationApiInterface {
      */
     markReadConversation(conversation_uuid: string, options?: any): Promise<{}>;
 
+    /**
+     * reset statistics within the queue 
+     * @summary reset statistics within the queue
+     * @param {string} queue_uuid 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    resetConversationPbxQueueStatistics(queue_uuid: string, options?: any): Promise<{}>;
+
     /**
      * Search for canned messages by short_code 
      * @summary Search for canned messages by short_code
@@ -57821,6 +57941,18 @@ export class ConversationApi extends BaseAPI implements ConversationApiInterface
         return ConversationApiFp(this.configuration).markReadConversation(conversation_uuid, options)(this.fetch, this.basePath);
     }
 
+    /**
+     * reset statistics within the queue 
+     * @summary reset statistics within the queue
+     * @param {string} queue_uuid 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    public resetConversationPbxQueueStatistics(queue_uuid: string, options?: any) {
+        return ConversationApiFp(this.configuration).resetConversationPbxQueueStatistics(queue_uuid, options)(this.fetch, this.basePath);
+    }
+
     /**
      * Search for canned messages by short_code 
      * @summary Search for canned messages by short_code

package/dist/api.d.ts

@@ -42412,6 +42412,12 @@ export interface WorkflowTask {
      * @memberof WorkflowTask
      */
     due_dts?: string;
+    /**
+     * Date/time that the workflow task will expire and be closed.  This is set by system generated tasks.
+     * @type {string}
+     * @memberof WorkflowTask
+     */
+    expiration_dts?: string;
     /**
      * Array of history records for the task
      * @type {Array<WorkflowTaskHistory>}
@@ -42484,6 +42490,12 @@ export interface WorkflowTask {
      * @memberof WorkflowTask
      */
     status?: WorkflowTask.StatusEnum;
+    /**
+     * Constant for the type of system generated task
+     * @type {string}
+     * @memberof WorkflowTask
+     */
+    system_task_type?: WorkflowTask.SystemTaskTypeEnum;
     /**
      * Tags
      * @type {Array<string>}
@@ -42549,7 +42561,22 @@ export declare namespace WorkflowTask {
         Open,
         Closed,
         Delayed,
-        AwaitingCustomerFeedback
+        AwaitingCustomerFeedback,
+        ClosedSystem,
+        ClosedCustomer,
+        ClosedExpiration
+    }
+    /**
+     * @export
+     * @enum {string}
+     */
+    enum SystemTaskTypeEnum {
+        OrderAccountsReceivable,
+        OrderFraudReview,
+        AutoOrderCardUpdateIssue,
+        AutoOrderCanceledPayment,
+        ItemLowStock,
+        ItemOutOfStock
     }
 }
 /**
@@ -45899,6 +45926,14 @@ export declare const ConversationApiFetchParamCreator: (configuration?: Configur
      * @throws {RequiredError}
      */
     markReadConversation(conversation_uuid: string, options?: any): FetchArgs;
+    /**
+     * reset statistics within the queue
+     * @summary reset statistics within the queue
+     * @param {string} queue_uuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    resetConversationPbxQueueStatistics(queue_uuid: string, options?: any): FetchArgs;
     /**
      * Search for canned messages by short_code
      * @summary Search for canned messages by short_code
@@ -46522,6 +46557,14 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     markReadConversation(conversation_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
+    /**
+     * reset statistics within the queue
+     * @summary reset statistics within the queue
+     * @param {string} queue_uuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    resetConversationPbxQueueStatistics(queue_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
     /**
      * Search for canned messages by short_code
      * @summary Search for canned messages by short_code
@@ -47145,6 +47188,14 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
      * @throws {RequiredError}
      */
     markReadConversation(conversation_uuid: string, options?: any): Promise<Response>;
+    /**
+     * reset statistics within the queue
+     * @summary reset statistics within the queue
+     * @param {string} queue_uuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    resetConversationPbxQueueStatistics(queue_uuid: string, options?: any): Promise<Response>;
     /**
      * Search for canned messages by short_code
      * @summary Search for canned messages by short_code
@@ -47830,6 +47881,15 @@ export interface ConversationApiInterface {
      * @memberof ConversationApiInterface
      */
     markReadConversation(conversation_uuid: string, options?: any): Promise<{}>;
+    /**
+     * reset statistics within the queue
+     * @summary reset statistics within the queue
+     * @param {string} queue_uuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    resetConversationPbxQueueStatistics(queue_uuid: string, options?: any): Promise<{}>;
     /**
      * Search for canned messages by short_code
      * @summary Search for canned messages by short_code
@@ -48532,6 +48592,15 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
      * @memberof ConversationApi
      */
     markReadConversation(conversation_uuid: string, options?: any): Promise<Response>;
+    /**
+     * reset statistics within the queue
+     * @summary reset statistics within the queue
+     * @param {string} queue_uuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    resetConversationPbxQueueStatistics(queue_uuid: string, options?: any): Promise<Response>;
     /**
      * Search for canned messages by short_code
      * @summary Search for canned messages by short_code

package/dist/api.js

@@ -1615,7 +1615,23 @@ var WorkflowTask;
         StatusEnum[StatusEnum["Closed"] = 'closed'] = "Closed";
         StatusEnum[StatusEnum["Delayed"] = 'delayed'] = "Delayed";
         StatusEnum[StatusEnum["AwaitingCustomerFeedback"] = 'awaiting customer feedback'] = "AwaitingCustomerFeedback";
+        StatusEnum[StatusEnum["ClosedSystem"] = 'closed - system'] = "ClosedSystem";
+        StatusEnum[StatusEnum["ClosedCustomer"] = 'closed - customer'] = "ClosedCustomer";
+        StatusEnum[StatusEnum["ClosedExpiration"] = 'closed - expiration'] = "ClosedExpiration";
     })(StatusEnum = WorkflowTask.StatusEnum || (WorkflowTask.StatusEnum = {}));
+    /**
+     * @export
+     * @enum {string}
+     */
+    var SystemTaskTypeEnum;
+    (function (SystemTaskTypeEnum) {
+        SystemTaskTypeEnum[SystemTaskTypeEnum["OrderAccountsReceivable"] = 'order_accounts_receivable'] = "OrderAccountsReceivable";
+        SystemTaskTypeEnum[SystemTaskTypeEnum["OrderFraudReview"] = 'order_fraud_review'] = "OrderFraudReview";
+        SystemTaskTypeEnum[SystemTaskTypeEnum["AutoOrderCardUpdateIssue"] = 'auto_order_card_update_issue'] = "AutoOrderCardUpdateIssue";
+        SystemTaskTypeEnum[SystemTaskTypeEnum["AutoOrderCanceledPayment"] = 'auto_order_canceled_payment'] = "AutoOrderCanceledPayment";
+        SystemTaskTypeEnum[SystemTaskTypeEnum["ItemLowStock"] = 'item_low_stock'] = "ItemLowStock";
+        SystemTaskTypeEnum[SystemTaskTypeEnum["ItemOutOfStock"] = 'item_out_of_stock'] = "ItemOutOfStock";
+    })(SystemTaskTypeEnum = WorkflowTask.SystemTaskTypeEnum || (WorkflowTask.SystemTaskTypeEnum = {}));
 })(WorkflowTask = exports.WorkflowTask || (exports.WorkflowTask = {}));
 /**
  * @export
@@ -9407,6 +9423,52 @@ var ConversationApiFetchParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * reset statistics within the queue
+         * @summary reset statistics within the queue
+         * @param {string} queue_uuid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        resetConversationPbxQueueStatistics: function (queue_uuid, options) {
+            if (options === void 0) { options = {}; }
+            // verify required parameter 'queue_uuid' is not null or undefined
+            if (queue_uuid === null || queue_uuid === undefined) {
+                throw new RequiredError('queue_uuid', 'Required parameter queue_uuid was null or undefined when calling resetConversationPbxQueueStatistics.');
+            }
+            var localVarPath = "/conversation/pbx/queues/{queue_uuid}/reset_statistics"
+                .replace("{".concat("queue_uuid", "}"), encodeURIComponent(String(queue_uuid)));
+            var localVarUrlObj = url.parse(localVarPath, true);
+            var localVarRequestOptions = Object.assign({ method: 'POST' }, 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_write"])
+                    : 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,
+            };
+        },
         /**
          * Search for canned messages by short_code
          * @summary Search for canned messages by short_code
@@ -11585,6 +11647,28 @@ var ConversationApiFp = function (configuration) {
                 });
             };
         },
+        /**
+         * reset statistics within the queue
+         * @summary reset statistics within the queue
+         * @param {string} queue_uuid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        resetConversationPbxQueueStatistics: function (queue_uuid, options) {
+            var localVarFetchArgs = (0, exports.ConversationApiFetchParamCreator)(configuration).resetConversationPbxQueueStatistics(queue_uuid, 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;
+                    }
+                    else {
+                        throw response;
+                    }
+                });
+            };
+        },
         /**
          * Search for canned messages by short_code
          * @summary Search for canned messages by short_code
@@ -12557,6 +12641,16 @@ var ConversationApiFactory = function (configuration, fetch, basePath) {
         markReadConversation: function (conversation_uuid, options) {
             return (0, exports.ConversationApiFp)(configuration).markReadConversation(conversation_uuid, options)(fetch, basePath);
         },
+        /**
+         * reset statistics within the queue
+         * @summary reset statistics within the queue
+         * @param {string} queue_uuid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        resetConversationPbxQueueStatistics: function (queue_uuid, options) {
+            return (0, exports.ConversationApiFp)(configuration).resetConversationPbxQueueStatistics(queue_uuid, options)(fetch, basePath);
+        },
         /**
          * Search for canned messages by short_code
          * @summary Search for canned messages by short_code
@@ -13403,6 +13497,17 @@ var ConversationApi = /** @class */ (function (_super) {
     ConversationApi.prototype.markReadConversation = function (conversation_uuid, options) {
         return (0, exports.ConversationApiFp)(this.configuration).markReadConversation(conversation_uuid, options)(this.fetch, this.basePath);
     };
+    /**
+     * reset statistics within the queue
+     * @summary reset statistics within the queue
+     * @param {string} queue_uuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    ConversationApi.prototype.resetConversationPbxQueueStatistics = function (queue_uuid, options) {
+        return (0, exports.ConversationApiFp)(this.configuration).resetConversationPbxQueueStatistics(queue_uuid, options)(this.fetch, this.basePath);
+    };
     /**
      * Search for canned messages by short_code
      * @summary Search for canned messages by short_code

package/package.json

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