ultracart_rest_api_v2_typescript 3.10.186 → 3.10.188

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## ultracart_rest_api_v2_typescript@3.10.186
1
+ ## ultracart_rest_api_v2_typescript@3.10.188
2
2
 
3
3
  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:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install ultracart_rest_api_v2_typescript@3.10.186 --save
39
+ npm install ultracart_rest_api_v2_typescript@3.10.188 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
54
54
 
55
55
  | Version | Date | Comments |
56
56
  | --: | :-: | --- |
57
+ | 3.10.188 | 03/19/2024 | workflow task - method to obtain open task count |
58
+ | 3.10.187 | 03/19/2024 | workflow task - addl status values, expiration_dts, and system task type |
57
59
  | 3.10.186 | 03/15/2024 | workflow - getWorkflowAgentWebsocketAuthorization method added |
58
60
  | 3.10.185 | 03/08/2024 | added getWorkflowTaskTags method |
59
61
  | 3.10.184 | 02/27/2024 | esp - sms statistic layer |
package/api.ts CHANGED
@@ -43329,6 +43329,12 @@ export interface WorkflowTask {
43329
43329
  * @memberof WorkflowTask
43330
43330
  */
43331
43331
  due_dts?: string;
43332
+ /**
43333
+ * Date/time that the workflow task will expire and be closed. This is set by system generated tasks.
43334
+ * @type {string}
43335
+ * @memberof WorkflowTask
43336
+ */
43337
+ expiration_dts?: string;
43332
43338
  /**
43333
43339
  * Array of history records for the task
43334
43340
  * @type {Array<WorkflowTaskHistory>}
@@ -43401,6 +43407,12 @@ export interface WorkflowTask {
43401
43407
  * @memberof WorkflowTask
43402
43408
  */
43403
43409
  status?: WorkflowTask.StatusEnum;
43410
+ /**
43411
+ * Constant for the type of system generated task
43412
+ * @type {string}
43413
+ * @memberof WorkflowTask
43414
+ */
43415
+ system_task_type?: WorkflowTask.SystemTaskTypeEnum;
43404
43416
  /**
43405
43417
  * Tags
43406
43418
  * @type {Array<string>}
@@ -43467,7 +43479,22 @@ export namespace WorkflowTask {
43467
43479
  Open = <any> 'open',
43468
43480
  Closed = <any> 'closed',
43469
43481
  Delayed = <any> 'delayed',
43470
- AwaitingCustomerFeedback = <any> 'awaiting customer feedback'
43482
+ AwaitingCustomerFeedback = <any> 'awaiting customer feedback',
43483
+ ClosedSystem = <any> 'closed - system',
43484
+ ClosedCustomer = <any> 'closed - customer',
43485
+ ClosedExpiration = <any> 'closed - expiration'
43486
+ }
43487
+ /**
43488
+ * @export
43489
+ * @enum {string}
43490
+ */
43491
+ export enum SystemTaskTypeEnum {
43492
+ OrderAccountsReceivable = <any> 'order_accounts_receivable',
43493
+ OrderFraudReview = <any> 'order_fraud_review',
43494
+ AutoOrderCardUpdateIssue = <any> 'auto_order_card_update_issue',
43495
+ AutoOrderCanceledPayment = <any> 'auto_order_canceled_payment',
43496
+ ItemLowStock = <any> 'item_low_stock',
43497
+ ItemOutOfStock = <any> 'item_out_of_stock'
43471
43498
  }
43472
43499
  }
43473
43500
 
@@ -43503,6 +43530,44 @@ export interface WorkflowTaskHistory {
43503
43530
  user?: WorkflowUser;
43504
43531
  }
43505
43532
 
43533
+ /**
43534
+ *
43535
+ * @export
43536
+ * @interface WorkflowTaskOpenCountResponse
43537
+ */
43538
+ export interface WorkflowTaskOpenCountResponse {
43539
+ /**
43540
+ *
43541
+ * @type {ModelError}
43542
+ * @memberof WorkflowTaskOpenCountResponse
43543
+ */
43544
+ error?: ModelError;
43545
+ /**
43546
+ *
43547
+ * @type {ResponseMetadata}
43548
+ * @memberof WorkflowTaskOpenCountResponse
43549
+ */
43550
+ metadata?: ResponseMetadata;
43551
+ /**
43552
+ * Open Task Count
43553
+ * @type {number}
43554
+ * @memberof WorkflowTaskOpenCountResponse
43555
+ */
43556
+ open_count?: number;
43557
+ /**
43558
+ * Indicates if API call was successful
43559
+ * @type {boolean}
43560
+ * @memberof WorkflowTaskOpenCountResponse
43561
+ */
43562
+ success?: boolean;
43563
+ /**
43564
+ *
43565
+ * @type {Warning}
43566
+ * @memberof WorkflowTaskOpenCountResponse
43567
+ */
43568
+ warning?: Warning;
43569
+ }
43570
+
43506
43571
  /**
43507
43572
  *
43508
43573
  * @export
@@ -43858,6 +43923,12 @@ export interface WorkflowUsersResponse {
43858
43923
  * @memberof WorkflowUsersResponse
43859
43924
  */
43860
43925
  metadata?: ResponseMetadata;
43926
+ /**
43927
+ * User ID of myself
43928
+ * @type {number}
43929
+ * @memberof WorkflowUsersResponse
43930
+ */
43931
+ my_user_id?: number;
43861
43932
  /**
43862
43933
  * Indicates if API call was successful
43863
43934
  * @type {boolean}
@@ -52928,6 +52999,58 @@ export const ConversationApiFetchParamCreator = function (configuration?: Config
52928
52999
 
52929
53000
 
52930
53001
 
53002
+ // authentication ultraCartOauth required
53003
+ // oauth required
53004
+ if (configuration && configuration.accessToken) {
53005
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
53006
+ ? configuration.accessToken("ultraCartOauth", ["conversation_write"])
53007
+ : configuration.accessToken;
53008
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
53009
+ }
53010
+
53011
+ // authentication ultraCartSimpleApiKey required
53012
+ if (configuration && configuration.apiKey) {
53013
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
53014
+ ? configuration.apiKey("x-ultracart-simple-key")
53015
+ : configuration.apiKey;
53016
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
53017
+ }
53018
+
53019
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
53020
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
53021
+ delete localVarUrlObj.search;
53022
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
53023
+
53024
+ return {
53025
+ url: url.format(localVarUrlObj),
53026
+ options: localVarRequestOptions,
53027
+ };
53028
+ },
53029
+ /**
53030
+ * reset statistics within the queue
53031
+ * @summary reset statistics within the queue
53032
+ * @param {string} queue_uuid
53033
+ * @param {*} [options] Override http request option.
53034
+ * @throws {RequiredError}
53035
+ */
53036
+ resetConversationPbxQueueStatistics(queue_uuid: string, options: any = {}): FetchArgs {
53037
+ // verify required parameter 'queue_uuid' is not null or undefined
53038
+ if (queue_uuid === null || queue_uuid === undefined) {
53039
+ throw new RequiredError('queue_uuid','Required parameter queue_uuid was null or undefined when calling resetConversationPbxQueueStatistics.');
53040
+ }
53041
+ const localVarPath = `/conversation/pbx/queues/{queue_uuid}/reset_statistics`
53042
+ .replace(`{${"queue_uuid"}}`, encodeURIComponent(String(queue_uuid)));
53043
+ const localVarUrlObj = url.parse(localVarPath, true);
53044
+ const localVarRequestOptions = Object.assign({ method: 'POST' }, options);
53045
+ const localVarHeaderParameter = {} as any;
53046
+ const localVarQueryParameter = {} as any;
53047
+
53048
+ if(configuration && configuration.apiVersion) {
53049
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
53050
+ }
53051
+
53052
+
53053
+
52931
53054
  // authentication ultraCartOauth required
52932
53055
  // oauth required
52933
53056
  if (configuration && configuration.accessToken) {
@@ -55183,6 +55306,27 @@ export const ConversationApiFp = function(configuration?: Configuration) {
55183
55306
  });
55184
55307
  };
55185
55308
  },
55309
+ /**
55310
+ * reset statistics within the queue
55311
+ * @summary reset statistics within the queue
55312
+ * @param {string} queue_uuid
55313
+ * @param {*} [options] Override http request option.
55314
+ * @throws {RequiredError}
55315
+ */
55316
+ resetConversationPbxQueueStatistics(queue_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response> {
55317
+ const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).resetConversationPbxQueueStatistics(queue_uuid, options);
55318
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
55319
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
55320
+
55321
+ if (response.status >= 200 && response.status < 300) {
55322
+ return response;
55323
+
55324
+ } else {
55325
+ throw response;
55326
+ }
55327
+ });
55328
+ };
55329
+ },
55186
55330
  /**
55187
55331
  * Search for canned messages by short_code
55188
55332
  * @summary Search for canned messages by short_code
@@ -56139,6 +56283,16 @@ export const ConversationApiFactory = function (configuration?: Configuration, f
56139
56283
  markReadConversation(conversation_uuid: string, options?: any) {
56140
56284
  return ConversationApiFp(configuration).markReadConversation(conversation_uuid, options)(fetch, basePath);
56141
56285
  },
56286
+ /**
56287
+ * reset statistics within the queue
56288
+ * @summary reset statistics within the queue
56289
+ * @param {string} queue_uuid
56290
+ * @param {*} [options] Override http request option.
56291
+ * @throws {RequiredError}
56292
+ */
56293
+ resetConversationPbxQueueStatistics(queue_uuid: string, options?: any) {
56294
+ return ConversationApiFp(configuration).resetConversationPbxQueueStatistics(queue_uuid, options)(fetch, basePath);
56295
+ },
56142
56296
  /**
56143
56297
  * Search for canned messages by short_code
56144
56298
  * @summary Search for canned messages by short_code
@@ -56919,6 +57073,16 @@ export interface ConversationApiInterface {
56919
57073
  */
56920
57074
  markReadConversation(conversation_uuid: string, options?: any): Promise<{}>;
56921
57075
 
57076
+ /**
57077
+ * reset statistics within the queue
57078
+ * @summary reset statistics within the queue
57079
+ * @param {string} queue_uuid
57080
+ * @param {*} [options] Override http request option.
57081
+ * @throws {RequiredError}
57082
+ * @memberof ConversationApiInterface
57083
+ */
57084
+ resetConversationPbxQueueStatistics(queue_uuid: string, options?: any): Promise<{}>;
57085
+
56922
57086
  /**
56923
57087
  * Search for canned messages by short_code
56924
57088
  * @summary Search for canned messages by short_code
@@ -57821,6 +57985,18 @@ export class ConversationApi extends BaseAPI implements ConversationApiInterface
57821
57985
  return ConversationApiFp(this.configuration).markReadConversation(conversation_uuid, options)(this.fetch, this.basePath);
57822
57986
  }
57823
57987
 
57988
+ /**
57989
+ * reset statistics within the queue
57990
+ * @summary reset statistics within the queue
57991
+ * @param {string} queue_uuid
57992
+ * @param {*} [options] Override http request option.
57993
+ * @throws {RequiredError}
57994
+ * @memberof ConversationApi
57995
+ */
57996
+ public resetConversationPbxQueueStatistics(queue_uuid: string, options?: any) {
57997
+ return ConversationApiFp(this.configuration).resetConversationPbxQueueStatistics(queue_uuid, options)(this.fetch, this.basePath);
57998
+ }
57999
+
57824
58000
  /**
57825
58001
  * Search for canned messages by short_code
57826
58002
  * @summary Search for canned messages by short_code
@@ -101010,6 +101186,52 @@ export const WorkflowApiFetchParamCreator = function (configuration?: Configurat
101010
101186
 
101011
101187
 
101012
101188
 
101189
+ // authentication ultraCartOauth required
101190
+ // oauth required
101191
+ if (configuration && configuration.accessToken) {
101192
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
101193
+ ? configuration.accessToken("ultraCartOauth", ["workflow_read"])
101194
+ : configuration.accessToken;
101195
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
101196
+ }
101197
+
101198
+ // authentication ultraCartSimpleApiKey required
101199
+ if (configuration && configuration.apiKey) {
101200
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
101201
+ ? configuration.apiKey("x-ultracart-simple-key")
101202
+ : configuration.apiKey;
101203
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
101204
+ }
101205
+
101206
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
101207
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
101208
+ delete localVarUrlObj.search;
101209
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
101210
+
101211
+ return {
101212
+ url: url.format(localVarUrlObj),
101213
+ options: localVarRequestOptions,
101214
+ };
101215
+ },
101216
+ /**
101217
+ * Retrieve workflow task open count
101218
+ * @summary Retrieve workflow task open count
101219
+ * @param {*} [options] Override http request option.
101220
+ * @throws {RequiredError}
101221
+ */
101222
+ getWorkflowTaskOpenCount(options: any = {}): FetchArgs {
101223
+ const localVarPath = `/workflow/tasks/open_count`;
101224
+ const localVarUrlObj = url.parse(localVarPath, true);
101225
+ const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
101226
+ const localVarHeaderParameter = {} as any;
101227
+ const localVarQueryParameter = {} as any;
101228
+
101229
+ if(configuration && configuration.apiVersion) {
101230
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
101231
+ }
101232
+
101233
+
101234
+
101013
101235
  // authentication ultraCartOauth required
101014
101236
  // oauth required
101015
101237
  if (configuration && configuration.accessToken) {
@@ -101426,6 +101648,26 @@ export const WorkflowApiFp = function(configuration?: Configuration) {
101426
101648
  });
101427
101649
  };
101428
101650
  },
101651
+ /**
101652
+ * Retrieve workflow task open count
101653
+ * @summary Retrieve workflow task open count
101654
+ * @param {*} [options] Override http request option.
101655
+ * @throws {RequiredError}
101656
+ */
101657
+ getWorkflowTaskOpenCount(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<WorkflowTaskOpenCountResponse> {
101658
+ const localVarFetchArgs = WorkflowApiFetchParamCreator(configuration).getWorkflowTaskOpenCount(options);
101659
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
101660
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
101661
+
101662
+ if (response.status >= 200 && response.status < 300) {
101663
+ return response.json();
101664
+
101665
+ } else {
101666
+ throw response;
101667
+ }
101668
+ });
101669
+ };
101670
+ },
101429
101671
  /**
101430
101672
  * Retrieves a unique list of all the existing workflow task tags.
101431
101673
  * @summary Get a list of existing workflow task tags
@@ -101593,6 +101835,15 @@ export const WorkflowApiFactory = function (configuration?: Configuration, fetch
101593
101835
  getWorkflowTaskByObjectType(object_type: string, object_id: string, options?: any) {
101594
101836
  return WorkflowApiFp(configuration).getWorkflowTaskByObjectType(object_type, object_id, options)(fetch, basePath);
101595
101837
  },
101838
+ /**
101839
+ * Retrieve workflow task open count
101840
+ * @summary Retrieve workflow task open count
101841
+ * @param {*} [options] Override http request option.
101842
+ * @throws {RequiredError}
101843
+ */
101844
+ getWorkflowTaskOpenCount(options?: any) {
101845
+ return WorkflowApiFp(configuration).getWorkflowTaskOpenCount(options)(fetch, basePath);
101846
+ },
101596
101847
  /**
101597
101848
  * Retrieves a unique list of all the existing workflow task tags.
101598
101849
  * @summary Get a list of existing workflow task tags
@@ -101716,6 +101967,15 @@ export interface WorkflowApiInterface {
101716
101967
  */
101717
101968
  getWorkflowTaskByObjectType(object_type: string, object_id: string, options?: any): Promise<WorkflowTasksResponse>;
101718
101969
 
101970
+ /**
101971
+ * Retrieve workflow task open count
101972
+ * @summary Retrieve workflow task open count
101973
+ * @param {*} [options] Override http request option.
101974
+ * @throws {RequiredError}
101975
+ * @memberof WorkflowApiInterface
101976
+ */
101977
+ getWorkflowTaskOpenCount(options?: any): Promise<WorkflowTaskOpenCountResponse>;
101978
+
101719
101979
  /**
101720
101980
  * Retrieves a unique list of all the existing workflow task tags.
101721
101981
  * @summary Get a list of existing workflow task tags
@@ -101853,6 +102113,17 @@ export class WorkflowApi extends BaseAPI implements WorkflowApiInterface {
101853
102113
  return WorkflowApiFp(this.configuration).getWorkflowTaskByObjectType(object_type, object_id, options)(this.fetch, this.basePath);
101854
102114
  }
101855
102115
 
102116
+ /**
102117
+ * Retrieve workflow task open count
102118
+ * @summary Retrieve workflow task open count
102119
+ * @param {*} [options] Override http request option.
102120
+ * @throws {RequiredError}
102121
+ * @memberof WorkflowApi
102122
+ */
102123
+ public getWorkflowTaskOpenCount(options?: any) {
102124
+ return WorkflowApiFp(this.configuration).getWorkflowTaskOpenCount(options)(this.fetch, this.basePath);
102125
+ }
102126
+
101856
102127
  /**
101857
102128
  * Retrieves a unique list of all the existing workflow task tags.
101858
102129
  * @summary Get a list of existing workflow task tags
package/dist/api.d.ts CHANGED
@@ -42412,6 +42412,12 @@ export interface WorkflowTask {
42412
42412
  * @memberof WorkflowTask
42413
42413
  */
42414
42414
  due_dts?: string;
42415
+ /**
42416
+ * Date/time that the workflow task will expire and be closed. This is set by system generated tasks.
42417
+ * @type {string}
42418
+ * @memberof WorkflowTask
42419
+ */
42420
+ expiration_dts?: string;
42415
42421
  /**
42416
42422
  * Array of history records for the task
42417
42423
  * @type {Array<WorkflowTaskHistory>}
@@ -42484,6 +42490,12 @@ export interface WorkflowTask {
42484
42490
  * @memberof WorkflowTask
42485
42491
  */
42486
42492
  status?: WorkflowTask.StatusEnum;
42493
+ /**
42494
+ * Constant for the type of system generated task
42495
+ * @type {string}
42496
+ * @memberof WorkflowTask
42497
+ */
42498
+ system_task_type?: WorkflowTask.SystemTaskTypeEnum;
42487
42499
  /**
42488
42500
  * Tags
42489
42501
  * @type {Array<string>}
@@ -42549,7 +42561,22 @@ export declare namespace WorkflowTask {
42549
42561
  Open,
42550
42562
  Closed,
42551
42563
  Delayed,
42552
- AwaitingCustomerFeedback
42564
+ AwaitingCustomerFeedback,
42565
+ ClosedSystem,
42566
+ ClosedCustomer,
42567
+ ClosedExpiration
42568
+ }
42569
+ /**
42570
+ * @export
42571
+ * @enum {string}
42572
+ */
42573
+ enum SystemTaskTypeEnum {
42574
+ OrderAccountsReceivable,
42575
+ OrderFraudReview,
42576
+ AutoOrderCardUpdateIssue,
42577
+ AutoOrderCanceledPayment,
42578
+ ItemLowStock,
42579
+ ItemOutOfStock
42553
42580
  }
42554
42581
  }
42555
42582
  /**
@@ -42583,6 +42610,43 @@ export interface WorkflowTaskHistory {
42583
42610
  */
42584
42611
  user?: WorkflowUser;
42585
42612
  }
42613
+ /**
42614
+ *
42615
+ * @export
42616
+ * @interface WorkflowTaskOpenCountResponse
42617
+ */
42618
+ export interface WorkflowTaskOpenCountResponse {
42619
+ /**
42620
+ *
42621
+ * @type {ModelError}
42622
+ * @memberof WorkflowTaskOpenCountResponse
42623
+ */
42624
+ error?: ModelError;
42625
+ /**
42626
+ *
42627
+ * @type {ResponseMetadata}
42628
+ * @memberof WorkflowTaskOpenCountResponse
42629
+ */
42630
+ metadata?: ResponseMetadata;
42631
+ /**
42632
+ * Open Task Count
42633
+ * @type {number}
42634
+ * @memberof WorkflowTaskOpenCountResponse
42635
+ */
42636
+ open_count?: number;
42637
+ /**
42638
+ * Indicates if API call was successful
42639
+ * @type {boolean}
42640
+ * @memberof WorkflowTaskOpenCountResponse
42641
+ */
42642
+ success?: boolean;
42643
+ /**
42644
+ *
42645
+ * @type {Warning}
42646
+ * @memberof WorkflowTaskOpenCountResponse
42647
+ */
42648
+ warning?: Warning;
42649
+ }
42586
42650
  /**
42587
42651
  *
42588
42652
  * @export
@@ -42931,6 +42995,12 @@ export interface WorkflowUsersResponse {
42931
42995
  * @memberof WorkflowUsersResponse
42932
42996
  */
42933
42997
  metadata?: ResponseMetadata;
42998
+ /**
42999
+ * User ID of myself
43000
+ * @type {number}
43001
+ * @memberof WorkflowUsersResponse
43002
+ */
43003
+ my_user_id?: number;
42934
43004
  /**
42935
43005
  * Indicates if API call was successful
42936
43006
  * @type {boolean}
@@ -45899,6 +45969,14 @@ export declare const ConversationApiFetchParamCreator: (configuration?: Configur
45899
45969
  * @throws {RequiredError}
45900
45970
  */
45901
45971
  markReadConversation(conversation_uuid: string, options?: any): FetchArgs;
45972
+ /**
45973
+ * reset statistics within the queue
45974
+ * @summary reset statistics within the queue
45975
+ * @param {string} queue_uuid
45976
+ * @param {*} [options] Override http request option.
45977
+ * @throws {RequiredError}
45978
+ */
45979
+ resetConversationPbxQueueStatistics(queue_uuid: string, options?: any): FetchArgs;
45902
45980
  /**
45903
45981
  * Search for canned messages by short_code
45904
45982
  * @summary Search for canned messages by short_code
@@ -46522,6 +46600,14 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
46522
46600
  * @throws {RequiredError}
46523
46601
  */
46524
46602
  markReadConversation(conversation_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
46603
+ /**
46604
+ * reset statistics within the queue
46605
+ * @summary reset statistics within the queue
46606
+ * @param {string} queue_uuid
46607
+ * @param {*} [options] Override http request option.
46608
+ * @throws {RequiredError}
46609
+ */
46610
+ resetConversationPbxQueueStatistics(queue_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
46525
46611
  /**
46526
46612
  * Search for canned messages by short_code
46527
46613
  * @summary Search for canned messages by short_code
@@ -47145,6 +47231,14 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
47145
47231
  * @throws {RequiredError}
47146
47232
  */
47147
47233
  markReadConversation(conversation_uuid: string, options?: any): Promise<Response>;
47234
+ /**
47235
+ * reset statistics within the queue
47236
+ * @summary reset statistics within the queue
47237
+ * @param {string} queue_uuid
47238
+ * @param {*} [options] Override http request option.
47239
+ * @throws {RequiredError}
47240
+ */
47241
+ resetConversationPbxQueueStatistics(queue_uuid: string, options?: any): Promise<Response>;
47148
47242
  /**
47149
47243
  * Search for canned messages by short_code
47150
47244
  * @summary Search for canned messages by short_code
@@ -47830,6 +47924,15 @@ export interface ConversationApiInterface {
47830
47924
  * @memberof ConversationApiInterface
47831
47925
  */
47832
47926
  markReadConversation(conversation_uuid: string, options?: any): Promise<{}>;
47927
+ /**
47928
+ * reset statistics within the queue
47929
+ * @summary reset statistics within the queue
47930
+ * @param {string} queue_uuid
47931
+ * @param {*} [options] Override http request option.
47932
+ * @throws {RequiredError}
47933
+ * @memberof ConversationApiInterface
47934
+ */
47935
+ resetConversationPbxQueueStatistics(queue_uuid: string, options?: any): Promise<{}>;
47833
47936
  /**
47834
47937
  * Search for canned messages by short_code
47835
47938
  * @summary Search for canned messages by short_code
@@ -48532,6 +48635,15 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
48532
48635
  * @memberof ConversationApi
48533
48636
  */
48534
48637
  markReadConversation(conversation_uuid: string, options?: any): Promise<Response>;
48638
+ /**
48639
+ * reset statistics within the queue
48640
+ * @summary reset statistics within the queue
48641
+ * @param {string} queue_uuid
48642
+ * @param {*} [options] Override http request option.
48643
+ * @throws {RequiredError}
48644
+ * @memberof ConversationApi
48645
+ */
48646
+ resetConversationPbxQueueStatistics(queue_uuid: string, options?: any): Promise<Response>;
48535
48647
  /**
48536
48648
  * Search for canned messages by short_code
48537
48649
  * @summary Search for canned messages by short_code
@@ -65822,6 +65934,13 @@ export declare const WorkflowApiFetchParamCreator: (configuration?: Configuratio
65822
65934
  * @throws {RequiredError}
65823
65935
  */
65824
65936
  getWorkflowTaskByObjectType(object_type: string, object_id: string, options?: any): FetchArgs;
65937
+ /**
65938
+ * Retrieve workflow task open count
65939
+ * @summary Retrieve workflow task open count
65940
+ * @param {*} [options] Override http request option.
65941
+ * @throws {RequiredError}
65942
+ */
65943
+ getWorkflowTaskOpenCount(options?: any): FetchArgs;
65825
65944
  /**
65826
65945
  * Retrieves a unique list of all the existing workflow task tags.
65827
65946
  * @summary Get a list of existing workflow task tags
@@ -65920,6 +66039,13 @@ export declare const WorkflowApiFp: (configuration?: Configuration) => {
65920
66039
  * @throws {RequiredError}
65921
66040
  */
65922
66041
  getWorkflowTaskByObjectType(object_type: string, object_id: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<WorkflowTasksResponse>;
66042
+ /**
66043
+ * Retrieve workflow task open count
66044
+ * @summary Retrieve workflow task open count
66045
+ * @param {*} [options] Override http request option.
66046
+ * @throws {RequiredError}
66047
+ */
66048
+ getWorkflowTaskOpenCount(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<WorkflowTaskOpenCountResponse>;
65923
66049
  /**
65924
66050
  * Retrieves a unique list of all the existing workflow task tags.
65925
66051
  * @summary Get a list of existing workflow task tags
@@ -66018,6 +66144,13 @@ export declare const WorkflowApiFactory: (configuration?: Configuration, fetch?:
66018
66144
  * @throws {RequiredError}
66019
66145
  */
66020
66146
  getWorkflowTaskByObjectType(object_type: string, object_id: string, options?: any): Promise<WorkflowTasksResponse>;
66147
+ /**
66148
+ * Retrieve workflow task open count
66149
+ * @summary Retrieve workflow task open count
66150
+ * @param {*} [options] Override http request option.
66151
+ * @throws {RequiredError}
66152
+ */
66153
+ getWorkflowTaskOpenCount(options?: any): Promise<WorkflowTaskOpenCountResponse>;
66021
66154
  /**
66022
66155
  * Retrieves a unique list of all the existing workflow task tags.
66023
66156
  * @summary Get a list of existing workflow task tags
@@ -66124,6 +66257,14 @@ export interface WorkflowApiInterface {
66124
66257
  * @memberof WorkflowApiInterface
66125
66258
  */
66126
66259
  getWorkflowTaskByObjectType(object_type: string, object_id: string, options?: any): Promise<WorkflowTasksResponse>;
66260
+ /**
66261
+ * Retrieve workflow task open count
66262
+ * @summary Retrieve workflow task open count
66263
+ * @param {*} [options] Override http request option.
66264
+ * @throws {RequiredError}
66265
+ * @memberof WorkflowApiInterface
66266
+ */
66267
+ getWorkflowTaskOpenCount(options?: any): Promise<WorkflowTaskOpenCountResponse>;
66127
66268
  /**
66128
66269
  * Retrieves a unique list of all the existing workflow task tags.
66129
66270
  * @summary Get a list of existing workflow task tags
@@ -66235,6 +66376,14 @@ export declare class WorkflowApi extends BaseAPI implements WorkflowApiInterface
66235
66376
  * @memberof WorkflowApi
66236
66377
  */
66237
66378
  getWorkflowTaskByObjectType(object_type: string, object_id: string, options?: any): Promise<WorkflowTasksResponse>;
66379
+ /**
66380
+ * Retrieve workflow task open count
66381
+ * @summary Retrieve workflow task open count
66382
+ * @param {*} [options] Override http request option.
66383
+ * @throws {RequiredError}
66384
+ * @memberof WorkflowApi
66385
+ */
66386
+ getWorkflowTaskOpenCount(options?: any): Promise<WorkflowTaskOpenCountResponse>;
66238
66387
  /**
66239
66388
  * Retrieves a unique list of all the existing workflow task tags.
66240
66389
  * @summary Get a list of existing workflow task tags
package/dist/api.js CHANGED
@@ -1615,7 +1615,23 @@ var WorkflowTask;
1615
1615
  StatusEnum[StatusEnum["Closed"] = 'closed'] = "Closed";
1616
1616
  StatusEnum[StatusEnum["Delayed"] = 'delayed'] = "Delayed";
1617
1617
  StatusEnum[StatusEnum["AwaitingCustomerFeedback"] = 'awaiting customer feedback'] = "AwaitingCustomerFeedback";
1618
+ StatusEnum[StatusEnum["ClosedSystem"] = 'closed - system'] = "ClosedSystem";
1619
+ StatusEnum[StatusEnum["ClosedCustomer"] = 'closed - customer'] = "ClosedCustomer";
1620
+ StatusEnum[StatusEnum["ClosedExpiration"] = 'closed - expiration'] = "ClosedExpiration";
1618
1621
  })(StatusEnum = WorkflowTask.StatusEnum || (WorkflowTask.StatusEnum = {}));
1622
+ /**
1623
+ * @export
1624
+ * @enum {string}
1625
+ */
1626
+ var SystemTaskTypeEnum;
1627
+ (function (SystemTaskTypeEnum) {
1628
+ SystemTaskTypeEnum[SystemTaskTypeEnum["OrderAccountsReceivable"] = 'order_accounts_receivable'] = "OrderAccountsReceivable";
1629
+ SystemTaskTypeEnum[SystemTaskTypeEnum["OrderFraudReview"] = 'order_fraud_review'] = "OrderFraudReview";
1630
+ SystemTaskTypeEnum[SystemTaskTypeEnum["AutoOrderCardUpdateIssue"] = 'auto_order_card_update_issue'] = "AutoOrderCardUpdateIssue";
1631
+ SystemTaskTypeEnum[SystemTaskTypeEnum["AutoOrderCanceledPayment"] = 'auto_order_canceled_payment'] = "AutoOrderCanceledPayment";
1632
+ SystemTaskTypeEnum[SystemTaskTypeEnum["ItemLowStock"] = 'item_low_stock'] = "ItemLowStock";
1633
+ SystemTaskTypeEnum[SystemTaskTypeEnum["ItemOutOfStock"] = 'item_out_of_stock'] = "ItemOutOfStock";
1634
+ })(SystemTaskTypeEnum = WorkflowTask.SystemTaskTypeEnum || (WorkflowTask.SystemTaskTypeEnum = {}));
1619
1635
  })(WorkflowTask = exports.WorkflowTask || (exports.WorkflowTask = {}));
1620
1636
  /**
1621
1637
  * @export
@@ -9407,6 +9423,52 @@ var ConversationApiFetchParamCreator = function (configuration) {
9407
9423
  options: localVarRequestOptions,
9408
9424
  };
9409
9425
  },
9426
+ /**
9427
+ * reset statistics within the queue
9428
+ * @summary reset statistics within the queue
9429
+ * @param {string} queue_uuid
9430
+ * @param {*} [options] Override http request option.
9431
+ * @throws {RequiredError}
9432
+ */
9433
+ resetConversationPbxQueueStatistics: function (queue_uuid, options) {
9434
+ if (options === void 0) { options = {}; }
9435
+ // verify required parameter 'queue_uuid' is not null or undefined
9436
+ if (queue_uuid === null || queue_uuid === undefined) {
9437
+ throw new RequiredError('queue_uuid', 'Required parameter queue_uuid was null or undefined when calling resetConversationPbxQueueStatistics.');
9438
+ }
9439
+ var localVarPath = "/conversation/pbx/queues/{queue_uuid}/reset_statistics"
9440
+ .replace("{".concat("queue_uuid", "}"), encodeURIComponent(String(queue_uuid)));
9441
+ var localVarUrlObj = url.parse(localVarPath, true);
9442
+ var localVarRequestOptions = Object.assign({ method: 'POST' }, options);
9443
+ var localVarHeaderParameter = {};
9444
+ var localVarQueryParameter = {};
9445
+ if (configuration && configuration.apiVersion) {
9446
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
9447
+ }
9448
+ // authentication ultraCartOauth required
9449
+ // oauth required
9450
+ if (configuration && configuration.accessToken) {
9451
+ var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
9452
+ ? configuration.accessToken("ultraCartOauth", ["conversation_write"])
9453
+ : configuration.accessToken;
9454
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
9455
+ }
9456
+ // authentication ultraCartSimpleApiKey required
9457
+ if (configuration && configuration.apiKey) {
9458
+ var localVarApiKeyValue = typeof configuration.apiKey === 'function'
9459
+ ? configuration.apiKey("x-ultracart-simple-key")
9460
+ : configuration.apiKey;
9461
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
9462
+ }
9463
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
9464
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
9465
+ delete localVarUrlObj.search;
9466
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
9467
+ return {
9468
+ url: url.format(localVarUrlObj),
9469
+ options: localVarRequestOptions,
9470
+ };
9471
+ },
9410
9472
  /**
9411
9473
  * Search for canned messages by short_code
9412
9474
  * @summary Search for canned messages by short_code
@@ -11585,6 +11647,28 @@ var ConversationApiFp = function (configuration) {
11585
11647
  });
11586
11648
  };
11587
11649
  },
11650
+ /**
11651
+ * reset statistics within the queue
11652
+ * @summary reset statistics within the queue
11653
+ * @param {string} queue_uuid
11654
+ * @param {*} [options] Override http request option.
11655
+ * @throws {RequiredError}
11656
+ */
11657
+ resetConversationPbxQueueStatistics: function (queue_uuid, options) {
11658
+ var localVarFetchArgs = (0, exports.ConversationApiFetchParamCreator)(configuration).resetConversationPbxQueueStatistics(queue_uuid, options);
11659
+ return function (fetch, basePath) {
11660
+ if (fetch === void 0) { fetch = portableFetch; }
11661
+ if (basePath === void 0) { basePath = BASE_PATH; }
11662
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
11663
+ if (response.status >= 200 && response.status < 300) {
11664
+ return response;
11665
+ }
11666
+ else {
11667
+ throw response;
11668
+ }
11669
+ });
11670
+ };
11671
+ },
11588
11672
  /**
11589
11673
  * Search for canned messages by short_code
11590
11674
  * @summary Search for canned messages by short_code
@@ -12557,6 +12641,16 @@ var ConversationApiFactory = function (configuration, fetch, basePath) {
12557
12641
  markReadConversation: function (conversation_uuid, options) {
12558
12642
  return (0, exports.ConversationApiFp)(configuration).markReadConversation(conversation_uuid, options)(fetch, basePath);
12559
12643
  },
12644
+ /**
12645
+ * reset statistics within the queue
12646
+ * @summary reset statistics within the queue
12647
+ * @param {string} queue_uuid
12648
+ * @param {*} [options] Override http request option.
12649
+ * @throws {RequiredError}
12650
+ */
12651
+ resetConversationPbxQueueStatistics: function (queue_uuid, options) {
12652
+ return (0, exports.ConversationApiFp)(configuration).resetConversationPbxQueueStatistics(queue_uuid, options)(fetch, basePath);
12653
+ },
12560
12654
  /**
12561
12655
  * Search for canned messages by short_code
12562
12656
  * @summary Search for canned messages by short_code
@@ -13403,6 +13497,17 @@ var ConversationApi = /** @class */ (function (_super) {
13403
13497
  ConversationApi.prototype.markReadConversation = function (conversation_uuid, options) {
13404
13498
  return (0, exports.ConversationApiFp)(this.configuration).markReadConversation(conversation_uuid, options)(this.fetch, this.basePath);
13405
13499
  };
13500
+ /**
13501
+ * reset statistics within the queue
13502
+ * @summary reset statistics within the queue
13503
+ * @param {string} queue_uuid
13504
+ * @param {*} [options] Override http request option.
13505
+ * @throws {RequiredError}
13506
+ * @memberof ConversationApi
13507
+ */
13508
+ ConversationApi.prototype.resetConversationPbxQueueStatistics = function (queue_uuid, options) {
13509
+ return (0, exports.ConversationApiFp)(this.configuration).resetConversationPbxQueueStatistics(queue_uuid, options)(this.fetch, this.basePath);
13510
+ };
13406
13511
  /**
13407
13512
  * Search for canned messages by short_code
13408
13513
  * @summary Search for canned messages by short_code
@@ -50007,6 +50112,46 @@ var WorkflowApiFetchParamCreator = function (configuration) {
50007
50112
  options: localVarRequestOptions,
50008
50113
  };
50009
50114
  },
50115
+ /**
50116
+ * Retrieve workflow task open count
50117
+ * @summary Retrieve workflow task open count
50118
+ * @param {*} [options] Override http request option.
50119
+ * @throws {RequiredError}
50120
+ */
50121
+ getWorkflowTaskOpenCount: function (options) {
50122
+ if (options === void 0) { options = {}; }
50123
+ var localVarPath = "/workflow/tasks/open_count";
50124
+ var localVarUrlObj = url.parse(localVarPath, true);
50125
+ var localVarRequestOptions = Object.assign({ method: 'GET' }, options);
50126
+ var localVarHeaderParameter = {};
50127
+ var localVarQueryParameter = {};
50128
+ if (configuration && configuration.apiVersion) {
50129
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
50130
+ }
50131
+ // authentication ultraCartOauth required
50132
+ // oauth required
50133
+ if (configuration && configuration.accessToken) {
50134
+ var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
50135
+ ? configuration.accessToken("ultraCartOauth", ["workflow_read"])
50136
+ : configuration.accessToken;
50137
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
50138
+ }
50139
+ // authentication ultraCartSimpleApiKey required
50140
+ if (configuration && configuration.apiKey) {
50141
+ var localVarApiKeyValue = typeof configuration.apiKey === 'function'
50142
+ ? configuration.apiKey("x-ultracart-simple-key")
50143
+ : configuration.apiKey;
50144
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
50145
+ }
50146
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
50147
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
50148
+ delete localVarUrlObj.search;
50149
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
50150
+ return {
50151
+ url: url.format(localVarUrlObj),
50152
+ options: localVarRequestOptions,
50153
+ };
50154
+ },
50010
50155
  /**
50011
50156
  * Retrieves a unique list of all the existing workflow task tags.
50012
50157
  * @summary Get a list of existing workflow task tags
@@ -50373,6 +50518,27 @@ var WorkflowApiFp = function (configuration) {
50373
50518
  });
50374
50519
  };
50375
50520
  },
50521
+ /**
50522
+ * Retrieve workflow task open count
50523
+ * @summary Retrieve workflow task open count
50524
+ * @param {*} [options] Override http request option.
50525
+ * @throws {RequiredError}
50526
+ */
50527
+ getWorkflowTaskOpenCount: function (options) {
50528
+ var localVarFetchArgs = (0, exports.WorkflowApiFetchParamCreator)(configuration).getWorkflowTaskOpenCount(options);
50529
+ return function (fetch, basePath) {
50530
+ if (fetch === void 0) { fetch = portableFetch; }
50531
+ if (basePath === void 0) { basePath = BASE_PATH; }
50532
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
50533
+ if (response.status >= 200 && response.status < 300) {
50534
+ return response.json();
50535
+ }
50536
+ else {
50537
+ throw response;
50538
+ }
50539
+ });
50540
+ };
50541
+ },
50376
50542
  /**
50377
50543
  * Retrieves a unique list of all the existing workflow task tags.
50378
50544
  * @summary Get a list of existing workflow task tags
@@ -50544,6 +50710,15 @@ var WorkflowApiFactory = function (configuration, fetch, basePath) {
50544
50710
  getWorkflowTaskByObjectType: function (object_type, object_id, options) {
50545
50711
  return (0, exports.WorkflowApiFp)(configuration).getWorkflowTaskByObjectType(object_type, object_id, options)(fetch, basePath);
50546
50712
  },
50713
+ /**
50714
+ * Retrieve workflow task open count
50715
+ * @summary Retrieve workflow task open count
50716
+ * @param {*} [options] Override http request option.
50717
+ * @throws {RequiredError}
50718
+ */
50719
+ getWorkflowTaskOpenCount: function (options) {
50720
+ return (0, exports.WorkflowApiFp)(configuration).getWorkflowTaskOpenCount(options)(fetch, basePath);
50721
+ },
50547
50722
  /**
50548
50723
  * Retrieves a unique list of all the existing workflow task tags.
50549
50724
  * @summary Get a list of existing workflow task tags
@@ -50679,6 +50854,16 @@ var WorkflowApi = /** @class */ (function (_super) {
50679
50854
  WorkflowApi.prototype.getWorkflowTaskByObjectType = function (object_type, object_id, options) {
50680
50855
  return (0, exports.WorkflowApiFp)(this.configuration).getWorkflowTaskByObjectType(object_type, object_id, options)(this.fetch, this.basePath);
50681
50856
  };
50857
+ /**
50858
+ * Retrieve workflow task open count
50859
+ * @summary Retrieve workflow task open count
50860
+ * @param {*} [options] Override http request option.
50861
+ * @throws {RequiredError}
50862
+ * @memberof WorkflowApi
50863
+ */
50864
+ WorkflowApi.prototype.getWorkflowTaskOpenCount = function (options) {
50865
+ return (0, exports.WorkflowApiFp)(this.configuration).getWorkflowTaskOpenCount(options)(this.fetch, this.basePath);
50866
+ };
50682
50867
  /**
50683
50868
  * Retrieves a unique list of all the existing workflow task tags.
50684
50869
  * @summary Get a list of existing workflow task tags
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "3.10.186",
3
+ "version": "3.10.188",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [