ultracart_rest_api_v2_typescript 4.0.203 → 4.0.204

package/README.md

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

package/dist/apis/ConversationApi.d.ts

@@ -147,6 +147,9 @@ export interface LeaveConversationRequest {
 export interface MarkReadConversationRequest {
     conversationUuid: string;
 }
+export interface ResetConversationPbxQueueStatisticsRequest {
+    queueUuid: string;
+}
 export interface SearchConversationCannedMessagesRequest {
     searchRequest: ConversationCannedMessagesSearch;
 }
@@ -1057,6 +1060,20 @@ export interface ConversationApiInterface {
      * Mark a conversation as read
      */
     markReadConversation(requestParameters: MarkReadConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * reset statistics within the queue
+     * @summary reset statistics within the queue
+     * @param {string} queueUuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    resetConversationPbxQueueStatisticsRaw(requestParameters: ResetConversationPbxQueueStatisticsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * reset statistics within the queue
+     * reset statistics within the queue
+     */
+    resetConversationPbxQueueStatistics(requestParameters: ResetConversationPbxQueueStatisticsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Search for canned messages by short_code
      * @summary Search for canned messages by short_code
@@ -1908,6 +1925,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
      * Mark a conversation as read
      */
     markReadConversation(requestParameters: MarkReadConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * reset statistics within the queue
+     * reset statistics within the queue
+     */
+    resetConversationPbxQueueStatisticsRaw(requestParameters: ResetConversationPbxQueueStatisticsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * reset statistics within the queue
+     * reset statistics within the queue
+     */
+    resetConversationPbxQueueStatistics(requestParameters: ResetConversationPbxQueueStatisticsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Search for canned messages by short_code
      * Search for canned messages by short_code

package/dist/apis/ConversationApi.js

@@ -3655,6 +3655,63 @@ var ConversationApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * reset statistics within the queue
+     * reset statistics within the queue
+     */
+    ConversationApi.prototype.resetConversationPbxQueueStatisticsRaw = 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.queueUuid === null || requestParameters.queueUuid === undefined) {
+                            throw new runtime.RequiredError('queueUuid', 'Required parameter requestParameters.queueUuid was null or undefined when calling resetConversationPbxQueueStatistics.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["conversation_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: "/conversation/pbx/queues/{queue_uuid}/reset_statistics".replace("{".concat("queue_uuid", "}"), encodeURIComponent(String(requestParameters.queueUuid))),
+                                method: 'POST',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.VoidApiResponse(response)];
+                }
+            });
+        });
+    };
+    /**
+     * reset statistics within the queue
+     * reset statistics within the queue
+     */
+    ConversationApi.prototype.resetConversationPbxQueueStatistics = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.resetConversationPbxQueueStatisticsRaw(requestParameters, initOverrides)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
     /**
      * Search for canned messages by short_code
      * Search for canned messages by short_code

package/dist/models/WorkflowTask.d.ts

@@ -80,6 +80,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>}
@@ -152,6 +158,12 @@ export interface WorkflowTask {
      * @memberof WorkflowTask
      */
     status?: WorkflowTaskStatusEnum;
+    /**
+     * Constant for the type of system generated task
+     * @type {string}
+     * @memberof WorkflowTask
+     */
+    system_task_type?: WorkflowTaskSystemTaskTypeEnum;
     /**
      * Tags
      * @type {Array<string>}
@@ -212,8 +224,23 @@ export declare const WorkflowTaskStatusEnum: {
     readonly Closed: "closed";
     readonly Delayed: "delayed";
     readonly AwaitingCustomerFeedback: "awaiting customer feedback";
+    readonly ClosedSystem: "closed - system";
+    readonly ClosedCustomer: "closed - customer";
+    readonly ClosedExpiration: "closed - expiration";
 };
 export type WorkflowTaskStatusEnum = typeof WorkflowTaskStatusEnum[keyof typeof WorkflowTaskStatusEnum];
+/**
+ * @export
+ */
+export declare const WorkflowTaskSystemTaskTypeEnum: {
+    readonly OrderAccountsReceivable: "order_accounts_receivable";
+    readonly OrderFraudReview: "order_fraud_review";
+    readonly AutoOrderCardUpdateIssue: "auto_order_card_update_issue";
+    readonly AutoOrderCanceledPayment: "auto_order_canceled_payment";
+    readonly ItemLowStock: "item_low_stock";
+    readonly ItemOutOfStock: "item_out_of_stock";
+};
+export type WorkflowTaskSystemTaskTypeEnum = typeof WorkflowTaskSystemTaskTypeEnum[keyof typeof WorkflowTaskSystemTaskTypeEnum];
 export declare function WorkflowTaskFromJSON(json: any): WorkflowTask;
 export declare function WorkflowTaskFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowTask;
 export declare function WorkflowTaskToJSON(value?: WorkflowTask | null): any;

package/dist/models/WorkflowTask.js

@@ -13,7 +13,7 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WorkflowTaskToJSON = exports.WorkflowTaskFromJSONTyped = exports.WorkflowTaskFromJSON = exports.WorkflowTaskStatusEnum = exports.WorkflowTaskPriorityEnum = exports.WorkflowTaskObjectTypeEnum = void 0;
+exports.WorkflowTaskToJSON = exports.WorkflowTaskFromJSONTyped = exports.WorkflowTaskFromJSON = exports.WorkflowTaskSystemTaskTypeEnum = exports.WorkflowTaskStatusEnum = exports.WorkflowTaskPriorityEnum = exports.WorkflowTaskObjectTypeEnum = void 0;
 var runtime_1 = require("../runtime");
 var Property_1 = require("./Property");
 var WorkflowAttachment_1 = require("./WorkflowAttachment");
@@ -46,7 +46,21 @@ exports.WorkflowTaskStatusEnum = {
     Open: 'open',
     Closed: 'closed',
     Delayed: 'delayed',
-    AwaitingCustomerFeedback: 'awaiting customer feedback'
+    AwaitingCustomerFeedback: 'awaiting customer feedback',
+    ClosedSystem: 'closed - system',
+    ClosedCustomer: 'closed - customer',
+    ClosedExpiration: 'closed - expiration'
+};
+/**
+ * @export
+ */
+exports.WorkflowTaskSystemTaskTypeEnum = {
+    OrderAccountsReceivable: 'order_accounts_receivable',
+    OrderFraudReview: 'order_fraud_review',
+    AutoOrderCardUpdateIssue: 'auto_order_card_update_issue',
+    AutoOrderCanceledPayment: 'auto_order_canceled_payment',
+    ItemLowStock: 'item_low_stock',
+    ItemOutOfStock: 'item_out_of_stock'
 };
 function WorkflowTaskFromJSON(json) {
     return WorkflowTaskFromJSONTyped(json, false);
@@ -67,6 +81,7 @@ function WorkflowTaskFromJSONTyped(json, ignoreDiscriminator) {
         'delay_until_dts': !(0, runtime_1.exists)(json, 'delay_until_dts') ? undefined : json['delay_until_dts'],
         'dependant_workflow_task_uuid': !(0, runtime_1.exists)(json, 'dependant_workflow_task_uuid') ? undefined : json['dependant_workflow_task_uuid'],
         'due_dts': !(0, runtime_1.exists)(json, 'due_dts') ? undefined : json['due_dts'],
+        'expiration_dts': !(0, runtime_1.exists)(json, 'expiration_dts') ? undefined : json['expiration_dts'],
         'histories': !(0, runtime_1.exists)(json, 'histories') ? undefined : (json['histories'].map(WorkflowTaskHistory_1.WorkflowTaskHistoryFromJSON)),
         'last_update_dts': !(0, runtime_1.exists)(json, 'last_update_dts') ? undefined : json['last_update_dts'],
         'merchant_id': !(0, runtime_1.exists)(json, 'merchant_id') ? undefined : json['merchant_id'],
@@ -79,6 +94,7 @@ function WorkflowTaskFromJSONTyped(json, ignoreDiscriminator) {
         'properties': !(0, runtime_1.exists)(json, 'properties') ? undefined : (json['properties'].map(Property_1.PropertyFromJSON)),
         'related_workflow_task_uuid': !(0, runtime_1.exists)(json, 'related_workflow_task_uuid') ? undefined : json['related_workflow_task_uuid'],
         'status': !(0, runtime_1.exists)(json, 'status') ? undefined : json['status'],
+        'system_task_type': !(0, runtime_1.exists)(json, 'system_task_type') ? undefined : json['system_task_type'],
         'tags': !(0, runtime_1.exists)(json, 'tags') ? undefined : json['tags'],
         'task_context': !(0, runtime_1.exists)(json, 'task_context') ? undefined : json['task_context'],
         'task_details': !(0, runtime_1.exists)(json, 'task_details') ? undefined : json['task_details'],
@@ -105,6 +121,7 @@ function WorkflowTaskToJSON(value) {
         'delay_until_dts': value.delay_until_dts,
         'dependant_workflow_task_uuid': value.dependant_workflow_task_uuid,
         'due_dts': value.due_dts,
+        'expiration_dts': value.expiration_dts,
         'histories': value.histories === undefined ? undefined : (value.histories.map(WorkflowTaskHistory_1.WorkflowTaskHistoryToJSON)),
         'last_update_dts': value.last_update_dts,
         'merchant_id': value.merchant_id,
@@ -117,6 +134,7 @@ function WorkflowTaskToJSON(value) {
         'properties': value.properties === undefined ? undefined : (value.properties.map(Property_1.PropertyToJSON)),
         'related_workflow_task_uuid': value.related_workflow_task_uuid,
         'status': value.status,
+        'system_task_type': value.system_task_type,
         'tags': value.tags,
         'task_context': value.task_context,
         'task_details': value.task_details,

package/package.json

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

package/src/apis/ConversationApi.ts

@@ -367,6 +367,10 @@ export interface MarkReadConversationRequest {
     conversationUuid: string;
 }
 
+export interface ResetConversationPbxQueueStatisticsRequest {
+    queueUuid: string;
+}
+
 export interface SearchConversationCannedMessagesRequest {
     searchRequest: ConversationCannedMessagesSearch;
 }
@@ -1415,6 +1419,22 @@ export interface ConversationApiInterface {
      */
     markReadConversation(requestParameters: MarkReadConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 
+    /**
+     * reset statistics within the queue 
+     * @summary reset statistics within the queue
+     * @param {string} queueUuid 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    resetConversationPbxQueueStatisticsRaw(requestParameters: ResetConversationPbxQueueStatisticsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * reset statistics within the queue 
+     * reset statistics within the queue
+     */
+    resetConversationPbxQueueStatistics(requestParameters: ResetConversationPbxQueueStatisticsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
     /**
      * Search for canned messages by short_code 
      * @summary Search for canned messages by short_code
@@ -4181,6 +4201,46 @@ export class ConversationApi extends runtime.BaseAPI implements ConversationApiI
         await this.markReadConversationRaw(requestParameters, initOverrides);
     }
 
+    /**
+     * reset statistics within the queue 
+     * reset statistics within the queue
+     */
+    async resetConversationPbxQueueStatisticsRaw(requestParameters: ResetConversationPbxQueueStatisticsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters.queueUuid === null || requestParameters.queueUuid === undefined) {
+            throw new runtime.RequiredError('queueUuid','Required parameter requestParameters.queueUuid was null or undefined when calling resetConversationPbxQueueStatistics.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["conversation_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: `/conversation/pbx/queues/{queue_uuid}/reset_statistics`.replace(`{${"queue_uuid"}}`, encodeURIComponent(String(requestParameters.queueUuid))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * reset statistics within the queue 
+     * reset statistics within the queue
+     */
+    async resetConversationPbxQueueStatistics(requestParameters: ResetConversationPbxQueueStatisticsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.resetConversationPbxQueueStatisticsRaw(requestParameters, initOverrides);
+    }
+
     /**
      * Search for canned messages by short_code 
      * Search for canned messages by short_code

package/src/models/WorkflowTask.ts

@@ -110,6 +110,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>}
@@ -182,6 +188,12 @@ export interface WorkflowTask {
      * @memberof WorkflowTask
      */
     status?: WorkflowTaskStatusEnum;
+    /**
+     * Constant for the type of system generated task
+     * @type {string}
+     * @memberof WorkflowTask
+     */
+    system_task_type?: WorkflowTaskSystemTaskTypeEnum;
     /**
      * Tags
      * @type {Array<string>}
@@ -245,10 +257,26 @@ export const WorkflowTaskStatusEnum = {
     Open: 'open',
     Closed: 'closed',
     Delayed: 'delayed',
-    AwaitingCustomerFeedback: 'awaiting customer feedback'
+    AwaitingCustomerFeedback: 'awaiting customer feedback',
+    ClosedSystem: 'closed - system',
+    ClosedCustomer: 'closed - customer',
+    ClosedExpiration: 'closed - expiration'
 } as const;
 export type WorkflowTaskStatusEnum = typeof WorkflowTaskStatusEnum[keyof typeof WorkflowTaskStatusEnum];
 
+/**
+ * @export
+ */
+export const WorkflowTaskSystemTaskTypeEnum = {
+    OrderAccountsReceivable: 'order_accounts_receivable',
+    OrderFraudReview: 'order_fraud_review',
+    AutoOrderCardUpdateIssue: 'auto_order_card_update_issue',
+    AutoOrderCanceledPayment: 'auto_order_canceled_payment',
+    ItemLowStock: 'item_low_stock',
+    ItemOutOfStock: 'item_out_of_stock'
+} as const;
+export type WorkflowTaskSystemTaskTypeEnum = typeof WorkflowTaskSystemTaskTypeEnum[keyof typeof WorkflowTaskSystemTaskTypeEnum];
+
 
 export function WorkflowTaskFromJSON(json: any): WorkflowTask {
     return WorkflowTaskFromJSONTyped(json, false);
@@ -270,6 +298,7 @@ export function WorkflowTaskFromJSONTyped(json: any, ignoreDiscriminator: boolea
         'delay_until_dts': !exists(json, 'delay_until_dts') ? undefined : json['delay_until_dts'],
         'dependant_workflow_task_uuid': !exists(json, 'dependant_workflow_task_uuid') ? undefined : json['dependant_workflow_task_uuid'],
         'due_dts': !exists(json, 'due_dts') ? undefined : json['due_dts'],
+        'expiration_dts': !exists(json, 'expiration_dts') ? undefined : json['expiration_dts'],
         'histories': !exists(json, 'histories') ? undefined : ((json['histories'] as Array<any>).map(WorkflowTaskHistoryFromJSON)),
         'last_update_dts': !exists(json, 'last_update_dts') ? undefined : json['last_update_dts'],
         'merchant_id': !exists(json, 'merchant_id') ? undefined : json['merchant_id'],
@@ -282,6 +311,7 @@ export function WorkflowTaskFromJSONTyped(json: any, ignoreDiscriminator: boolea
         'properties': !exists(json, 'properties') ? undefined : ((json['properties'] as Array<any>).map(PropertyFromJSON)),
         'related_workflow_task_uuid': !exists(json, 'related_workflow_task_uuid') ? undefined : json['related_workflow_task_uuid'],
         'status': !exists(json, 'status') ? undefined : json['status'],
+        'system_task_type': !exists(json, 'system_task_type') ? undefined : json['system_task_type'],
         'tags': !exists(json, 'tags') ? undefined : json['tags'],
         'task_context': !exists(json, 'task_context') ? undefined : json['task_context'],
         'task_details': !exists(json, 'task_details') ? undefined : json['task_details'],
@@ -309,6 +339,7 @@ export function WorkflowTaskToJSON(value?: WorkflowTask | null): any {
         'delay_until_dts': value.delay_until_dts,
         'dependant_workflow_task_uuid': value.dependant_workflow_task_uuid,
         'due_dts': value.due_dts,
+        'expiration_dts': value.expiration_dts,
         'histories': value.histories === undefined ? undefined : ((value.histories as Array<any>).map(WorkflowTaskHistoryToJSON)),
         'last_update_dts': value.last_update_dts,
         'merchant_id': value.merchant_id,
@@ -321,6 +352,7 @@ export function WorkflowTaskToJSON(value?: WorkflowTask | null): any {
         'properties': value.properties === undefined ? undefined : ((value.properties as Array<any>).map(PropertyToJSON)),
         'related_workflow_task_uuid': value.related_workflow_task_uuid,
         'status': value.status,
+        'system_task_type': value.system_task_type,
         'tags': value.tags,
         'task_context': value.task_context,
         'task_details': value.task_details,