ultracart_rest_api_v2_typescript 3.10.185 → 3.10.187

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.185
1
+ ## ultracart_rest_api_v2_typescript@3.10.187
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.185 --save
39
+ npm install ultracart_rest_api_v2_typescript@3.10.187 --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.187 | 03/19/2024 | workflow task - addl status values, expiration_dts, and system task type |
58
+ | 3.10.186 | 03/15/2024 | workflow - getWorkflowAgentWebsocketAuthorization method added |
57
59
  | 3.10.185 | 03/08/2024 | added getWorkflowTaskTags method |
58
60
  | 3.10.184 | 02/27/2024 | esp - sms statistic layer |
59
61
  | 3.10.183 | 02/20/2024 | Add tag support to CouponAmountOffItems, CouponBuyOneGetOneLimit, CouponDiscountItemWithItemPurchase, CouponFreeItemWithItemPurchase, CouponPercentOffItemsWithItemsPurchase |
package/api.ts CHANGED
@@ -9323,6 +9323,18 @@ export interface ConversationPbxQueue {
9323
9323
  * @memberof ConversationPbxQueue
9324
9324
  */
9325
9325
  voicemail?: boolean;
9326
+ /**
9327
+ * Wait time in seconds before critical
9328
+ * @type {number}
9329
+ * @memberof ConversationPbxQueue
9330
+ */
9331
+ wait_critical_seconds?: number;
9332
+ /**
9333
+ * Wait time in seconds before warning
9334
+ * @type {number}
9335
+ * @memberof ConversationPbxQueue
9336
+ */
9337
+ wait_warning_seconds?: number;
9326
9338
  }
9327
9339
 
9328
9340
  /**
@@ -42989,6 +43001,70 @@ export namespace Weight {
42989
43001
  }
42990
43002
  }
42991
43003
 
43004
+ /**
43005
+ *
43006
+ * @export
43007
+ * @interface WorkflowAgentAuth
43008
+ */
43009
+ export interface WorkflowAgentAuth {
43010
+ /**
43011
+ *
43012
+ * @type {string}
43013
+ * @memberof WorkflowAgentAuth
43014
+ */
43015
+ jwt?: string;
43016
+ /**
43017
+ *
43018
+ * @type {string}
43019
+ * @memberof WorkflowAgentAuth
43020
+ */
43021
+ merchant_id?: string;
43022
+ /**
43023
+ *
43024
+ * @type {string}
43025
+ * @memberof WorkflowAgentAuth
43026
+ */
43027
+ websocket_url?: string;
43028
+ }
43029
+
43030
+ /**
43031
+ *
43032
+ * @export
43033
+ * @interface WorkflowAgentAuthResponse
43034
+ */
43035
+ export interface WorkflowAgentAuthResponse {
43036
+ /**
43037
+ *
43038
+ * @type {WorkflowAgentAuth}
43039
+ * @memberof WorkflowAgentAuthResponse
43040
+ */
43041
+ agent_auth?: WorkflowAgentAuth;
43042
+ /**
43043
+ *
43044
+ * @type {ModelError}
43045
+ * @memberof WorkflowAgentAuthResponse
43046
+ */
43047
+ error?: ModelError;
43048
+ /**
43049
+ *
43050
+ * @type {ResponseMetadata}
43051
+ * @memberof WorkflowAgentAuthResponse
43052
+ */
43053
+ metadata?: ResponseMetadata;
43054
+ /**
43055
+ * Indicates if API call was successful
43056
+ * @type {boolean}
43057
+ * @memberof WorkflowAgentAuthResponse
43058
+ */
43059
+ success?: boolean;
43060
+ /**
43061
+ *
43062
+ * @type {Warning}
43063
+ * @memberof WorkflowAgentAuthResponse
43064
+ */
43065
+ warning?: Warning;
43066
+ }
43067
+
42992
43068
  /**
42993
43069
  *
42994
43070
  * @export
@@ -43253,6 +43329,12 @@ export interface WorkflowTask {
43253
43329
  * @memberof WorkflowTask
43254
43330
  */
43255
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;
43256
43338
  /**
43257
43339
  * Array of history records for the task
43258
43340
  * @type {Array<WorkflowTaskHistory>}
@@ -43325,6 +43407,12 @@ export interface WorkflowTask {
43325
43407
  * @memberof WorkflowTask
43326
43408
  */
43327
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;
43328
43416
  /**
43329
43417
  * Tags
43330
43418
  * @type {Array<string>}
@@ -43391,7 +43479,22 @@ export namespace WorkflowTask {
43391
43479
  Open = <any> 'open',
43392
43480
  Closed = <any> 'closed',
43393
43481
  Delayed = <any> 'delayed',
43394
- 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'
43395
43498
  }
43396
43499
  }
43397
43500
 
@@ -52852,6 +52955,58 @@ export const ConversationApiFetchParamCreator = function (configuration?: Config
52852
52955
 
52853
52956
 
52854
52957
 
52958
+ // authentication ultraCartOauth required
52959
+ // oauth required
52960
+ if (configuration && configuration.accessToken) {
52961
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
52962
+ ? configuration.accessToken("ultraCartOauth", ["conversation_write"])
52963
+ : configuration.accessToken;
52964
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
52965
+ }
52966
+
52967
+ // authentication ultraCartSimpleApiKey required
52968
+ if (configuration && configuration.apiKey) {
52969
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
52970
+ ? configuration.apiKey("x-ultracart-simple-key")
52971
+ : configuration.apiKey;
52972
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
52973
+ }
52974
+
52975
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
52976
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
52977
+ delete localVarUrlObj.search;
52978
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
52979
+
52980
+ return {
52981
+ url: url.format(localVarUrlObj),
52982
+ options: localVarRequestOptions,
52983
+ };
52984
+ },
52985
+ /**
52986
+ * reset statistics within the queue
52987
+ * @summary reset statistics within the queue
52988
+ * @param {string} queue_uuid
52989
+ * @param {*} [options] Override http request option.
52990
+ * @throws {RequiredError}
52991
+ */
52992
+ resetConversationPbxQueueStatistics(queue_uuid: string, options: any = {}): FetchArgs {
52993
+ // verify required parameter 'queue_uuid' is not null or undefined
52994
+ if (queue_uuid === null || queue_uuid === undefined) {
52995
+ throw new RequiredError('queue_uuid','Required parameter queue_uuid was null or undefined when calling resetConversationPbxQueueStatistics.');
52996
+ }
52997
+ const localVarPath = `/conversation/pbx/queues/{queue_uuid}/reset_statistics`
52998
+ .replace(`{${"queue_uuid"}}`, encodeURIComponent(String(queue_uuid)));
52999
+ const localVarUrlObj = url.parse(localVarPath, true);
53000
+ const localVarRequestOptions = Object.assign({ method: 'POST' }, options);
53001
+ const localVarHeaderParameter = {} as any;
53002
+ const localVarQueryParameter = {} as any;
53003
+
53004
+ if(configuration && configuration.apiVersion) {
53005
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
53006
+ }
53007
+
53008
+
53009
+
52855
53010
  // authentication ultraCartOauth required
52856
53011
  // oauth required
52857
53012
  if (configuration && configuration.accessToken) {
@@ -55107,6 +55262,27 @@ export const ConversationApiFp = function(configuration?: Configuration) {
55107
55262
  });
55108
55263
  };
55109
55264
  },
55265
+ /**
55266
+ * reset statistics within the queue
55267
+ * @summary reset statistics within the queue
55268
+ * @param {string} queue_uuid
55269
+ * @param {*} [options] Override http request option.
55270
+ * @throws {RequiredError}
55271
+ */
55272
+ resetConversationPbxQueueStatistics(queue_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response> {
55273
+ const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).resetConversationPbxQueueStatistics(queue_uuid, options);
55274
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
55275
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
55276
+
55277
+ if (response.status >= 200 && response.status < 300) {
55278
+ return response;
55279
+
55280
+ } else {
55281
+ throw response;
55282
+ }
55283
+ });
55284
+ };
55285
+ },
55110
55286
  /**
55111
55287
  * Search for canned messages by short_code
55112
55288
  * @summary Search for canned messages by short_code
@@ -56063,6 +56239,16 @@ export const ConversationApiFactory = function (configuration?: Configuration, f
56063
56239
  markReadConversation(conversation_uuid: string, options?: any) {
56064
56240
  return ConversationApiFp(configuration).markReadConversation(conversation_uuid, options)(fetch, basePath);
56065
56241
  },
56242
+ /**
56243
+ * reset statistics within the queue
56244
+ * @summary reset statistics within the queue
56245
+ * @param {string} queue_uuid
56246
+ * @param {*} [options] Override http request option.
56247
+ * @throws {RequiredError}
56248
+ */
56249
+ resetConversationPbxQueueStatistics(queue_uuid: string, options?: any) {
56250
+ return ConversationApiFp(configuration).resetConversationPbxQueueStatistics(queue_uuid, options)(fetch, basePath);
56251
+ },
56066
56252
  /**
56067
56253
  * Search for canned messages by short_code
56068
56254
  * @summary Search for canned messages by short_code
@@ -56843,6 +57029,16 @@ export interface ConversationApiInterface {
56843
57029
  */
56844
57030
  markReadConversation(conversation_uuid: string, options?: any): Promise<{}>;
56845
57031
 
57032
+ /**
57033
+ * reset statistics within the queue
57034
+ * @summary reset statistics within the queue
57035
+ * @param {string} queue_uuid
57036
+ * @param {*} [options] Override http request option.
57037
+ * @throws {RequiredError}
57038
+ * @memberof ConversationApiInterface
57039
+ */
57040
+ resetConversationPbxQueueStatistics(queue_uuid: string, options?: any): Promise<{}>;
57041
+
56846
57042
  /**
56847
57043
  * Search for canned messages by short_code
56848
57044
  * @summary Search for canned messages by short_code
@@ -57745,6 +57941,18 @@ export class ConversationApi extends BaseAPI implements ConversationApiInterface
57745
57941
  return ConversationApiFp(this.configuration).markReadConversation(conversation_uuid, options)(this.fetch, this.basePath);
57746
57942
  }
57747
57943
 
57944
+ /**
57945
+ * reset statistics within the queue
57946
+ * @summary reset statistics within the queue
57947
+ * @param {string} queue_uuid
57948
+ * @param {*} [options] Override http request option.
57949
+ * @throws {RequiredError}
57950
+ * @memberof ConversationApi
57951
+ */
57952
+ public resetConversationPbxQueueStatistics(queue_uuid: string, options?: any) {
57953
+ return ConversationApiFp(this.configuration).resetConversationPbxQueueStatistics(queue_uuid, options)(this.fetch, this.basePath);
57954
+ }
57955
+
57748
57956
  /**
57749
57957
  * Search for canned messages by short_code
57750
57958
  * @summary Search for canned messages by short_code
@@ -100595,6 +100803,52 @@ export class WebhookApi extends BaseAPI implements WebhookApiInterface {
100595
100803
  */
100596
100804
  export const WorkflowApiFetchParamCreator = function (configuration?: Configuration) {
100597
100805
  return {
100806
+ /**
100807
+ * Retrieve a JWT to authorize an agent to make a websocket connection.
100808
+ * @summary Get agent websocket authorization
100809
+ * @param {*} [options] Override http request option.
100810
+ * @throws {RequiredError}
100811
+ */
100812
+ getWorkflowAgentWebsocketAuthorization(options: any = {}): FetchArgs {
100813
+ const localVarPath = `/workflow/agent/auth`;
100814
+ const localVarUrlObj = url.parse(localVarPath, true);
100815
+ const localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
100816
+ const localVarHeaderParameter = {} as any;
100817
+ const localVarQueryParameter = {} as any;
100818
+
100819
+ if(configuration && configuration.apiVersion) {
100820
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
100821
+ }
100822
+
100823
+
100824
+
100825
+ // authentication ultraCartOauth required
100826
+ // oauth required
100827
+ if (configuration && configuration.accessToken) {
100828
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
100829
+ ? configuration.accessToken("ultraCartOauth", ["workflow_write"])
100830
+ : configuration.accessToken;
100831
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
100832
+ }
100833
+
100834
+ // authentication ultraCartSimpleApiKey required
100835
+ if (configuration && configuration.apiKey) {
100836
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
100837
+ ? configuration.apiKey("x-ultracart-simple-key")
100838
+ : configuration.apiKey;
100839
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
100840
+ }
100841
+
100842
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
100843
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
100844
+ delete localVarUrlObj.search;
100845
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
100846
+
100847
+ return {
100848
+ url: url.format(localVarUrlObj),
100849
+ options: localVarRequestOptions,
100850
+ };
100851
+ },
100598
100852
  /**
100599
100853
  * Retrieve a list of groups that workflow tasks can be assigned to
100600
100854
  * @summary Retrieve a list of groups that workflow tasks can be assigned to
@@ -101156,6 +101410,26 @@ export const WorkflowApiFetchParamCreator = function (configuration?: Configurat
101156
101410
  */
101157
101411
  export const WorkflowApiFp = function(configuration?: Configuration) {
101158
101412
  return {
101413
+ /**
101414
+ * Retrieve a JWT to authorize an agent to make a websocket connection.
101415
+ * @summary Get agent websocket authorization
101416
+ * @param {*} [options] Override http request option.
101417
+ * @throws {RequiredError}
101418
+ */
101419
+ getWorkflowAgentWebsocketAuthorization(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<WorkflowAgentAuthResponse> {
101420
+ const localVarFetchArgs = WorkflowApiFetchParamCreator(configuration).getWorkflowAgentWebsocketAuthorization(options);
101421
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
101422
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
101423
+
101424
+ if (response.status >= 200 && response.status < 300) {
101425
+ return response.json();
101426
+
101427
+ } else {
101428
+ throw response;
101429
+ }
101430
+ });
101431
+ };
101432
+ },
101159
101433
  /**
101160
101434
  * Retrieve a list of groups that workflow tasks can be assigned to
101161
101435
  * @summary Retrieve a list of groups that workflow tasks can be assigned to
@@ -101380,6 +101654,15 @@ export const WorkflowApiFp = function(configuration?: Configuration) {
101380
101654
  */
101381
101655
  export const WorkflowApiFactory = function (configuration?: Configuration, fetch?: FetchAPI, basePath?: string) {
101382
101656
  return {
101657
+ /**
101658
+ * Retrieve a JWT to authorize an agent to make a websocket connection.
101659
+ * @summary Get agent websocket authorization
101660
+ * @param {*} [options] Override http request option.
101661
+ * @throws {RequiredError}
101662
+ */
101663
+ getWorkflowAgentWebsocketAuthorization(options?: any) {
101664
+ return WorkflowApiFp(configuration).getWorkflowAgentWebsocketAuthorization(options)(fetch, basePath);
101665
+ },
101383
101666
  /**
101384
101667
  * Retrieve a list of groups that workflow tasks can be assigned to
101385
101668
  * @summary Retrieve a list of groups that workflow tasks can be assigned to
@@ -101494,6 +101777,15 @@ export const WorkflowApiFactory = function (configuration?: Configuration, fetch
101494
101777
  * @interface WorkflowApi
101495
101778
  */
101496
101779
  export interface WorkflowApiInterface {
101780
+ /**
101781
+ * Retrieve a JWT to authorize an agent to make a websocket connection.
101782
+ * @summary Get agent websocket authorization
101783
+ * @param {*} [options] Override http request option.
101784
+ * @throws {RequiredError}
101785
+ * @memberof WorkflowApiInterface
101786
+ */
101787
+ getWorkflowAgentWebsocketAuthorization(options?: any): Promise<WorkflowAgentAuthResponse>;
101788
+
101497
101789
  /**
101498
101790
  * Retrieve a list of groups that workflow tasks can be assigned to
101499
101791
  * @summary Retrieve a list of groups that workflow tasks can be assigned to
@@ -101608,6 +101900,17 @@ export interface WorkflowApiInterface {
101608
101900
  * @extends {BaseAPI}
101609
101901
  */
101610
101902
  export class WorkflowApi extends BaseAPI implements WorkflowApiInterface {
101903
+ /**
101904
+ * Retrieve a JWT to authorize an agent to make a websocket connection.
101905
+ * @summary Get agent websocket authorization
101906
+ * @param {*} [options] Override http request option.
101907
+ * @throws {RequiredError}
101908
+ * @memberof WorkflowApi
101909
+ */
101910
+ public getWorkflowAgentWebsocketAuthorization(options?: any) {
101911
+ return WorkflowApiFp(this.configuration).getWorkflowAgentWebsocketAuthorization(options)(this.fetch, this.basePath);
101912
+ }
101913
+
101611
101914
  /**
101612
101915
  * Retrieve a list of groups that workflow tasks can be assigned to
101613
101916
  * @summary Retrieve a list of groups that workflow tasks can be assigned to
package/dist/api.d.ts CHANGED
@@ -9102,6 +9102,18 @@ export interface ConversationPbxQueue {
9102
9102
  * @memberof ConversationPbxQueue
9103
9103
  */
9104
9104
  voicemail?: boolean;
9105
+ /**
9106
+ * Wait time in seconds before critical
9107
+ * @type {number}
9108
+ * @memberof ConversationPbxQueue
9109
+ */
9110
+ wait_critical_seconds?: number;
9111
+ /**
9112
+ * Wait time in seconds before warning
9113
+ * @type {number}
9114
+ * @memberof ConversationPbxQueue
9115
+ */
9116
+ wait_warning_seconds?: number;
9105
9117
  }
9106
9118
  /**
9107
9119
  *
@@ -42080,6 +42092,68 @@ export declare namespace Weight {
42080
42092
  OZ
42081
42093
  }
42082
42094
  }
42095
+ /**
42096
+ *
42097
+ * @export
42098
+ * @interface WorkflowAgentAuth
42099
+ */
42100
+ export interface WorkflowAgentAuth {
42101
+ /**
42102
+ *
42103
+ * @type {string}
42104
+ * @memberof WorkflowAgentAuth
42105
+ */
42106
+ jwt?: string;
42107
+ /**
42108
+ *
42109
+ * @type {string}
42110
+ * @memberof WorkflowAgentAuth
42111
+ */
42112
+ merchant_id?: string;
42113
+ /**
42114
+ *
42115
+ * @type {string}
42116
+ * @memberof WorkflowAgentAuth
42117
+ */
42118
+ websocket_url?: string;
42119
+ }
42120
+ /**
42121
+ *
42122
+ * @export
42123
+ * @interface WorkflowAgentAuthResponse
42124
+ */
42125
+ export interface WorkflowAgentAuthResponse {
42126
+ /**
42127
+ *
42128
+ * @type {WorkflowAgentAuth}
42129
+ * @memberof WorkflowAgentAuthResponse
42130
+ */
42131
+ agent_auth?: WorkflowAgentAuth;
42132
+ /**
42133
+ *
42134
+ * @type {ModelError}
42135
+ * @memberof WorkflowAgentAuthResponse
42136
+ */
42137
+ error?: ModelError;
42138
+ /**
42139
+ *
42140
+ * @type {ResponseMetadata}
42141
+ * @memberof WorkflowAgentAuthResponse
42142
+ */
42143
+ metadata?: ResponseMetadata;
42144
+ /**
42145
+ * Indicates if API call was successful
42146
+ * @type {boolean}
42147
+ * @memberof WorkflowAgentAuthResponse
42148
+ */
42149
+ success?: boolean;
42150
+ /**
42151
+ *
42152
+ * @type {Warning}
42153
+ * @memberof WorkflowAgentAuthResponse
42154
+ */
42155
+ warning?: Warning;
42156
+ }
42083
42157
  /**
42084
42158
  *
42085
42159
  * @export
@@ -42338,6 +42412,12 @@ export interface WorkflowTask {
42338
42412
  * @memberof WorkflowTask
42339
42413
  */
42340
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;
42341
42421
  /**
42342
42422
  * Array of history records for the task
42343
42423
  * @type {Array<WorkflowTaskHistory>}
@@ -42410,6 +42490,12 @@ export interface WorkflowTask {
42410
42490
  * @memberof WorkflowTask
42411
42491
  */
42412
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;
42413
42499
  /**
42414
42500
  * Tags
42415
42501
  * @type {Array<string>}
@@ -42475,7 +42561,22 @@ export declare namespace WorkflowTask {
42475
42561
  Open,
42476
42562
  Closed,
42477
42563
  Delayed,
42478
- 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
42479
42580
  }
42480
42581
  }
42481
42582
  /**
@@ -45825,6 +45926,14 @@ export declare const ConversationApiFetchParamCreator: (configuration?: Configur
45825
45926
  * @throws {RequiredError}
45826
45927
  */
45827
45928
  markReadConversation(conversation_uuid: string, options?: any): FetchArgs;
45929
+ /**
45930
+ * reset statistics within the queue
45931
+ * @summary reset statistics within the queue
45932
+ * @param {string} queue_uuid
45933
+ * @param {*} [options] Override http request option.
45934
+ * @throws {RequiredError}
45935
+ */
45936
+ resetConversationPbxQueueStatistics(queue_uuid: string, options?: any): FetchArgs;
45828
45937
  /**
45829
45938
  * Search for canned messages by short_code
45830
45939
  * @summary Search for canned messages by short_code
@@ -46448,6 +46557,14 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
46448
46557
  * @throws {RequiredError}
46449
46558
  */
46450
46559
  markReadConversation(conversation_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
46560
+ /**
46561
+ * reset statistics within the queue
46562
+ * @summary reset statistics within the queue
46563
+ * @param {string} queue_uuid
46564
+ * @param {*} [options] Override http request option.
46565
+ * @throws {RequiredError}
46566
+ */
46567
+ resetConversationPbxQueueStatistics(queue_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
46451
46568
  /**
46452
46569
  * Search for canned messages by short_code
46453
46570
  * @summary Search for canned messages by short_code
@@ -47071,6 +47188,14 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
47071
47188
  * @throws {RequiredError}
47072
47189
  */
47073
47190
  markReadConversation(conversation_uuid: string, options?: any): Promise<Response>;
47191
+ /**
47192
+ * reset statistics within the queue
47193
+ * @summary reset statistics within the queue
47194
+ * @param {string} queue_uuid
47195
+ * @param {*} [options] Override http request option.
47196
+ * @throws {RequiredError}
47197
+ */
47198
+ resetConversationPbxQueueStatistics(queue_uuid: string, options?: any): Promise<Response>;
47074
47199
  /**
47075
47200
  * Search for canned messages by short_code
47076
47201
  * @summary Search for canned messages by short_code
@@ -47756,6 +47881,15 @@ export interface ConversationApiInterface {
47756
47881
  * @memberof ConversationApiInterface
47757
47882
  */
47758
47883
  markReadConversation(conversation_uuid: string, options?: any): Promise<{}>;
47884
+ /**
47885
+ * reset statistics within the queue
47886
+ * @summary reset statistics within the queue
47887
+ * @param {string} queue_uuid
47888
+ * @param {*} [options] Override http request option.
47889
+ * @throws {RequiredError}
47890
+ * @memberof ConversationApiInterface
47891
+ */
47892
+ resetConversationPbxQueueStatistics(queue_uuid: string, options?: any): Promise<{}>;
47759
47893
  /**
47760
47894
  * Search for canned messages by short_code
47761
47895
  * @summary Search for canned messages by short_code
@@ -48458,6 +48592,15 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
48458
48592
  * @memberof ConversationApi
48459
48593
  */
48460
48594
  markReadConversation(conversation_uuid: string, options?: any): Promise<Response>;
48595
+ /**
48596
+ * reset statistics within the queue
48597
+ * @summary reset statistics within the queue
48598
+ * @param {string} queue_uuid
48599
+ * @param {*} [options] Override http request option.
48600
+ * @throws {RequiredError}
48601
+ * @memberof ConversationApi
48602
+ */
48603
+ resetConversationPbxQueueStatistics(queue_uuid: string, options?: any): Promise<Response>;
48461
48604
  /**
48462
48605
  * Search for canned messages by short_code
48463
48606
  * @summary Search for canned messages by short_code
@@ -65691,6 +65834,13 @@ export declare class WebhookApi extends BaseAPI implements WebhookApiInterface {
65691
65834
  * @export
65692
65835
  */
65693
65836
  export declare const WorkflowApiFetchParamCreator: (configuration?: Configuration) => {
65837
+ /**
65838
+ * Retrieve a JWT to authorize an agent to make a websocket connection.
65839
+ * @summary Get agent websocket authorization
65840
+ * @param {*} [options] Override http request option.
65841
+ * @throws {RequiredError}
65842
+ */
65843
+ getWorkflowAgentWebsocketAuthorization(options?: any): FetchArgs;
65694
65844
  /**
65695
65845
  * Retrieve a list of groups that workflow tasks can be assigned to
65696
65846
  * @summary Retrieve a list of groups that workflow tasks can be assigned to
@@ -65782,6 +65932,13 @@ export declare const WorkflowApiFetchParamCreator: (configuration?: Configuratio
65782
65932
  * @export
65783
65933
  */
65784
65934
  export declare const WorkflowApiFp: (configuration?: Configuration) => {
65935
+ /**
65936
+ * Retrieve a JWT to authorize an agent to make a websocket connection.
65937
+ * @summary Get agent websocket authorization
65938
+ * @param {*} [options] Override http request option.
65939
+ * @throws {RequiredError}
65940
+ */
65941
+ getWorkflowAgentWebsocketAuthorization(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<WorkflowAgentAuthResponse>;
65785
65942
  /**
65786
65943
  * Retrieve a list of groups that workflow tasks can be assigned to
65787
65944
  * @summary Retrieve a list of groups that workflow tasks can be assigned to
@@ -65873,6 +66030,13 @@ export declare const WorkflowApiFp: (configuration?: Configuration) => {
65873
66030
  * @export
65874
66031
  */
65875
66032
  export declare const WorkflowApiFactory: (configuration?: Configuration, fetch?: FetchAPI, basePath?: string) => {
66033
+ /**
66034
+ * Retrieve a JWT to authorize an agent to make a websocket connection.
66035
+ * @summary Get agent websocket authorization
66036
+ * @param {*} [options] Override http request option.
66037
+ * @throws {RequiredError}
66038
+ */
66039
+ getWorkflowAgentWebsocketAuthorization(options?: any): Promise<WorkflowAgentAuthResponse>;
65876
66040
  /**
65877
66041
  * Retrieve a list of groups that workflow tasks can be assigned to
65878
66042
  * @summary Retrieve a list of groups that workflow tasks can be assigned to
@@ -65965,6 +66129,14 @@ export declare const WorkflowApiFactory: (configuration?: Configuration, fetch?:
65965
66129
  * @interface WorkflowApi
65966
66130
  */
65967
66131
  export interface WorkflowApiInterface {
66132
+ /**
66133
+ * Retrieve a JWT to authorize an agent to make a websocket connection.
66134
+ * @summary Get agent websocket authorization
66135
+ * @param {*} [options] Override http request option.
66136
+ * @throws {RequiredError}
66137
+ * @memberof WorkflowApiInterface
66138
+ */
66139
+ getWorkflowAgentWebsocketAuthorization(options?: any): Promise<WorkflowAgentAuthResponse>;
65968
66140
  /**
65969
66141
  * Retrieve a list of groups that workflow tasks can be assigned to
65970
66142
  * @summary Retrieve a list of groups that workflow tasks can be assigned to
@@ -66068,6 +66240,14 @@ export interface WorkflowApiInterface {
66068
66240
  * @extends {BaseAPI}
66069
66241
  */
66070
66242
  export declare class WorkflowApi extends BaseAPI implements WorkflowApiInterface {
66243
+ /**
66244
+ * Retrieve a JWT to authorize an agent to make a websocket connection.
66245
+ * @summary Get agent websocket authorization
66246
+ * @param {*} [options] Override http request option.
66247
+ * @throws {RequiredError}
66248
+ * @memberof WorkflowApi
66249
+ */
66250
+ getWorkflowAgentWebsocketAuthorization(options?: any): Promise<WorkflowAgentAuthResponse>;
66071
66251
  /**
66072
66252
  * Retrieve a list of groups that workflow tasks can be assigned to
66073
66253
  * @summary Retrieve a list of groups that workflow tasks can be assigned to
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
@@ -49687,6 +49792,46 @@ exports.WebhookApi = WebhookApi;
49687
49792
  */
49688
49793
  var WorkflowApiFetchParamCreator = function (configuration) {
49689
49794
  return {
49795
+ /**
49796
+ * Retrieve a JWT to authorize an agent to make a websocket connection.
49797
+ * @summary Get agent websocket authorization
49798
+ * @param {*} [options] Override http request option.
49799
+ * @throws {RequiredError}
49800
+ */
49801
+ getWorkflowAgentWebsocketAuthorization: function (options) {
49802
+ if (options === void 0) { options = {}; }
49803
+ var localVarPath = "/workflow/agent/auth";
49804
+ var localVarUrlObj = url.parse(localVarPath, true);
49805
+ var localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
49806
+ var localVarHeaderParameter = {};
49807
+ var localVarQueryParameter = {};
49808
+ if (configuration && configuration.apiVersion) {
49809
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
49810
+ }
49811
+ // authentication ultraCartOauth required
49812
+ // oauth required
49813
+ if (configuration && configuration.accessToken) {
49814
+ var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
49815
+ ? configuration.accessToken("ultraCartOauth", ["workflow_write"])
49816
+ : configuration.accessToken;
49817
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
49818
+ }
49819
+ // authentication ultraCartSimpleApiKey required
49820
+ if (configuration && configuration.apiKey) {
49821
+ var localVarApiKeyValue = typeof configuration.apiKey === 'function'
49822
+ ? configuration.apiKey("x-ultracart-simple-key")
49823
+ : configuration.apiKey;
49824
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
49825
+ }
49826
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
49827
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
49828
+ delete localVarUrlObj.search;
49829
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
49830
+ return {
49831
+ url: url.format(localVarUrlObj),
49832
+ options: localVarRequestOptions,
49833
+ };
49834
+ },
49690
49835
  /**
49691
49836
  * Retrieve a list of groups that workflow tasks can be assigned to
49692
49837
  * @summary Retrieve a list of groups that workflow tasks can be assigned to
@@ -50178,6 +50323,27 @@ exports.WorkflowApiFetchParamCreator = WorkflowApiFetchParamCreator;
50178
50323
  */
50179
50324
  var WorkflowApiFp = function (configuration) {
50180
50325
  return {
50326
+ /**
50327
+ * Retrieve a JWT to authorize an agent to make a websocket connection.
50328
+ * @summary Get agent websocket authorization
50329
+ * @param {*} [options] Override http request option.
50330
+ * @throws {RequiredError}
50331
+ */
50332
+ getWorkflowAgentWebsocketAuthorization: function (options) {
50333
+ var localVarFetchArgs = (0, exports.WorkflowApiFetchParamCreator)(configuration).getWorkflowAgentWebsocketAuthorization(options);
50334
+ return function (fetch, basePath) {
50335
+ if (fetch === void 0) { fetch = portableFetch; }
50336
+ if (basePath === void 0) { basePath = BASE_PATH; }
50337
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
50338
+ if (response.status >= 200 && response.status < 300) {
50339
+ return response.json();
50340
+ }
50341
+ else {
50342
+ throw response;
50343
+ }
50344
+ });
50345
+ };
50346
+ },
50181
50347
  /**
50182
50348
  * Retrieve a list of groups that workflow tasks can be assigned to
50183
50349
  * @summary Retrieve a list of groups that workflow tasks can be assigned to
@@ -50412,6 +50578,15 @@ exports.WorkflowApiFp = WorkflowApiFp;
50412
50578
  */
50413
50579
  var WorkflowApiFactory = function (configuration, fetch, basePath) {
50414
50580
  return {
50581
+ /**
50582
+ * Retrieve a JWT to authorize an agent to make a websocket connection.
50583
+ * @summary Get agent websocket authorization
50584
+ * @param {*} [options] Override http request option.
50585
+ * @throws {RequiredError}
50586
+ */
50587
+ getWorkflowAgentWebsocketAuthorization: function (options) {
50588
+ return (0, exports.WorkflowApiFp)(configuration).getWorkflowAgentWebsocketAuthorization(options)(fetch, basePath);
50589
+ },
50415
50590
  /**
50416
50591
  * Retrieve a list of groups that workflow tasks can be assigned to
50417
50592
  * @summary Retrieve a list of groups that workflow tasks can be assigned to
@@ -50531,6 +50706,16 @@ var WorkflowApi = /** @class */ (function (_super) {
50531
50706
  function WorkflowApi() {
50532
50707
  return _super !== null && _super.apply(this, arguments) || this;
50533
50708
  }
50709
+ /**
50710
+ * Retrieve a JWT to authorize an agent to make a websocket connection.
50711
+ * @summary Get agent websocket authorization
50712
+ * @param {*} [options] Override http request option.
50713
+ * @throws {RequiredError}
50714
+ * @memberof WorkflowApi
50715
+ */
50716
+ WorkflowApi.prototype.getWorkflowAgentWebsocketAuthorization = function (options) {
50717
+ return (0, exports.WorkflowApiFp)(this.configuration).getWorkflowAgentWebsocketAuthorization(options)(this.fetch, this.basePath);
50718
+ };
50534
50719
  /**
50535
50720
  * Retrieve a list of groups that workflow tasks can be assigned to
50536
50721
  * @summary Retrieve a list of groups that workflow tasks can be assigned to
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "3.10.185",
3
+ "version": "3.10.187",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [