ultracart_rest_api_v2_typescript 3.10.24 → 3.10.27

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.24
1
+ ## ultracart_rest_api_v2_typescript@3.10.27
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.24 --save
39
+ npm install ultracart_rest_api_v2_typescript@3.10.27 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -54,6 +54,9 @@ Not every change is committed to every SDK.
54
54
 
55
55
  | Version | Date | Comments |
56
56
  | --: | :-: | --- |
57
+ | 3.10.27 | 07/28/2022 | conversation message upload keys property |
58
+ | 3.10.26 | 07/26/2022 | conversations - queue statistics |
59
+ | 3.10.25 | 07/25/2022 | conversation development |
57
60
  | 3.10.24 | 07/25/2022 | conversations bug fixes |
58
61
  | 3.10.23 | 07/25/2022 | conversations - add a websocket message model |
59
62
  | 3.10.22 | 07/20/2022 | conversation participant name added |
package/api.ts CHANGED
@@ -6259,6 +6259,12 @@ export interface CityStateZip {
6259
6259
  * @interface Conversation
6260
6260
  */
6261
6261
  export interface Conversation {
6262
+ /**
6263
+ *
6264
+ * @type {boolean}
6265
+ * @memberof Conversation
6266
+ */
6267
+ closed?: boolean;
6262
6268
  /**
6263
6269
  *
6264
6270
  * @type {string}
@@ -6435,6 +6441,12 @@ export interface ConversationMessage {
6435
6441
  * @memberof ConversationMessage
6436
6442
  */
6437
6443
  transport_statuses?: Array<ConversationMessageTransportStatus>;
6444
+ /**
6445
+ *
6446
+ * @type {Array<string>}
6447
+ * @memberof ConversationMessage
6448
+ */
6449
+ upload_keys?: Array<string>;
6438
6450
  }
6439
6451
 
6440
6452
  /**
@@ -6649,6 +6661,12 @@ export interface ConversationStartResponse {
6649
6661
  * @interface ConversationSummary
6650
6662
  */
6651
6663
  export interface ConversationSummary {
6664
+ /**
6665
+ *
6666
+ * @type {boolean}
6667
+ * @memberof ConversationSummary
6668
+ */
6669
+ closed?: boolean;
6652
6670
  /**
6653
6671
  *
6654
6672
  * @type {string}
@@ -6705,6 +6723,226 @@ export interface ConversationSummary {
6705
6723
  unread_messages?: boolean;
6706
6724
  }
6707
6725
 
6726
+ /**
6727
+ *
6728
+ * @export
6729
+ * @interface ConversationWebchatQueueStatus
6730
+ */
6731
+ export interface ConversationWebchatQueueStatus {
6732
+ /**
6733
+ *
6734
+ * @type {number}
6735
+ * @memberof ConversationWebchatQueueStatus
6736
+ */
6737
+ agent_available_count?: number;
6738
+ /**
6739
+ *
6740
+ * @type {number}
6741
+ * @memberof ConversationWebchatQueueStatus
6742
+ */
6743
+ agent_busy_count?: number;
6744
+ /**
6745
+ *
6746
+ * @type {number}
6747
+ * @memberof ConversationWebchatQueueStatus
6748
+ */
6749
+ agent_count?: number;
6750
+ /**
6751
+ *
6752
+ * @type {number}
6753
+ * @memberof ConversationWebchatQueueStatus
6754
+ */
6755
+ agent_unavailable_count?: number;
6756
+ /**
6757
+ *
6758
+ * @type {Array<ConversationWebchatQueueStatusAgent>}
6759
+ * @memberof ConversationWebchatQueueStatus
6760
+ */
6761
+ agents?: Array<ConversationWebchatQueueStatusAgent>;
6762
+ /**
6763
+ *
6764
+ * @type {number}
6765
+ * @memberof ConversationWebchatQueueStatus
6766
+ */
6767
+ customer_abandon_count?: number;
6768
+ /**
6769
+ *
6770
+ * @type {number}
6771
+ * @memberof ConversationWebchatQueueStatus
6772
+ */
6773
+ customer_active_count?: number;
6774
+ /**
6775
+ *
6776
+ * @type {number}
6777
+ * @memberof ConversationWebchatQueueStatus
6778
+ */
6779
+ customer_average_abandon_time_seconds?: number;
6780
+ /**
6781
+ *
6782
+ * @type {number}
6783
+ * @memberof ConversationWebchatQueueStatus
6784
+ */
6785
+ customer_average_chat_time_seconds?: number;
6786
+ /**
6787
+ *
6788
+ * @type {number}
6789
+ * @memberof ConversationWebchatQueueStatus
6790
+ */
6791
+ customer_average_hold_time_seconds?: number;
6792
+ /**
6793
+ *
6794
+ * @type {number}
6795
+ * @memberof ConversationWebchatQueueStatus
6796
+ */
6797
+ customer_waiting_count?: number;
6798
+ /**
6799
+ * Date/time that the oldest person joined the queue
6800
+ * @type {string}
6801
+ * @memberof ConversationWebchatQueueStatus
6802
+ */
6803
+ customer_waiting_join_dts?: string;
6804
+ /**
6805
+ *
6806
+ * @type {Array<ConversationWebchatQueueStatusQueueEntry>}
6807
+ * @memberof ConversationWebchatQueueStatus
6808
+ */
6809
+ queue_entries?: Array<ConversationWebchatQueueStatusQueueEntry>;
6810
+ /**
6811
+ *
6812
+ * @type {string}
6813
+ * @memberof ConversationWebchatQueueStatus
6814
+ */
6815
+ queue_name?: string;
6816
+ }
6817
+
6818
+ /**
6819
+ *
6820
+ * @export
6821
+ * @interface ConversationWebchatQueueStatusAgent
6822
+ */
6823
+ export interface ConversationWebchatQueueStatusAgent {
6824
+ /**
6825
+ *
6826
+ * @type {string}
6827
+ * @memberof ConversationWebchatQueueStatusAgent
6828
+ */
6829
+ agent_status?: string;
6830
+ /**
6831
+ *
6832
+ * @type {string}
6833
+ * @memberof ConversationWebchatQueueStatusAgent
6834
+ */
6835
+ conversation_participant_arn?: string;
6836
+ /**
6837
+ *
6838
+ * @type {string}
6839
+ * @memberof ConversationWebchatQueueStatusAgent
6840
+ */
6841
+ conversation_participant_name?: string;
6842
+ /**
6843
+ * Date/time that this agent took their last chat
6844
+ * @type {string}
6845
+ * @memberof ConversationWebchatQueueStatusAgent
6846
+ */
6847
+ last_chat_dts?: string;
6848
+ /**
6849
+ *
6850
+ * @type {boolean}
6851
+ * @memberof ConversationWebchatQueueStatusAgent
6852
+ */
6853
+ next_round_robin?: boolean;
6854
+ }
6855
+
6856
+ /**
6857
+ *
6858
+ * @export
6859
+ * @interface ConversationWebchatQueueStatusQueueEntry
6860
+ */
6861
+ export interface ConversationWebchatQueueStatusQueueEntry {
6862
+ /**
6863
+ *
6864
+ * @type {string}
6865
+ * @memberof ConversationWebchatQueueStatusQueueEntry
6866
+ */
6867
+ conversation_participant_arn?: string;
6868
+ /**
6869
+ *
6870
+ * @type {string}
6871
+ * @memberof ConversationWebchatQueueStatusQueueEntry
6872
+ */
6873
+ conversation_participant_name?: string;
6874
+ /**
6875
+ *
6876
+ * @type {string}
6877
+ * @memberof ConversationWebchatQueueStatusQueueEntry
6878
+ */
6879
+ conversation_webchat_queue_uuid?: string;
6880
+ /**
6881
+ * Date/time the customer joined the queue
6882
+ * @type {string}
6883
+ * @memberof ConversationWebchatQueueStatusQueueEntry
6884
+ */
6885
+ join_dts?: string;
6886
+ /**
6887
+ *
6888
+ * @type {string}
6889
+ * @memberof ConversationWebchatQueueStatusQueueEntry
6890
+ */
6891
+ question?: string;
6892
+ }
6893
+
6894
+ /**
6895
+ *
6896
+ * @export
6897
+ * @interface ConversationWebchatQueueStatusUpdateRequest
6898
+ */
6899
+ export interface ConversationWebchatQueueStatusUpdateRequest {
6900
+ /**
6901
+ *
6902
+ * @type {string}
6903
+ * @memberof ConversationWebchatQueueStatusUpdateRequest
6904
+ */
6905
+ agent_status?: string;
6906
+ }
6907
+
6908
+ /**
6909
+ *
6910
+ * @export
6911
+ * @interface ConversationWebchatQueueStatusesResponse
6912
+ */
6913
+ export interface ConversationWebchatQueueStatusesResponse {
6914
+ /**
6915
+ *
6916
+ * @type {ModelError}
6917
+ * @memberof ConversationWebchatQueueStatusesResponse
6918
+ */
6919
+ error?: ModelError;
6920
+ /**
6921
+ *
6922
+ * @type {ResponseMetadata}
6923
+ * @memberof ConversationWebchatQueueStatusesResponse
6924
+ */
6925
+ metadata?: ResponseMetadata;
6926
+ /**
6927
+ *
6928
+ * @type {Array<ConversationWebchatQueueStatus>}
6929
+ * @memberof ConversationWebchatQueueStatusesResponse
6930
+ */
6931
+ queue_statuses?: Array<ConversationWebchatQueueStatus>;
6932
+ /**
6933
+ * Indicates if API call was successful
6934
+ * @type {boolean}
6935
+ * @memberof ConversationWebchatQueueStatusesResponse
6936
+ */
6937
+ success?: boolean;
6938
+ /**
6939
+ *
6940
+ * @type {Warning}
6941
+ * @memberof ConversationWebchatQueueStatusesResponse
6942
+ */
6943
+ warning?: Warning;
6944
+ }
6945
+
6708
6946
  /**
6709
6947
  *
6710
6948
  * @export
@@ -6719,28 +6957,34 @@ export interface ConversationWebsocketMessage {
6719
6957
  conversation_uuid?: string;
6720
6958
  /**
6721
6959
  *
6722
- * @type {Conversation}
6960
+ * @type {ConversationSummary}
6723
6961
  * @memberof ConversationWebsocketMessage
6724
6962
  */
6725
- event_conversation_closed?: Conversation;
6963
+ event_conversation_closed?: ConversationSummary;
6726
6964
  /**
6727
6965
  *
6728
- * @type {Conversation}
6966
+ * @type {ConversationSummary}
6729
6967
  * @memberof ConversationWebsocketMessage
6730
6968
  */
6731
- event_new_conversation?: Conversation;
6969
+ event_new_conversation?: ConversationSummary;
6732
6970
  /**
6733
6971
  *
6734
- * @type {Conversation}
6972
+ * @type {ConversationSummary}
6735
6973
  * @memberof ConversationWebsocketMessage
6736
6974
  */
6737
- event_new_message?: Conversation;
6975
+ event_new_message?: ConversationSummary;
6738
6976
  /**
6739
6977
  *
6740
6978
  * @type {ConversationEventQueuePosition}
6741
6979
  * @memberof ConversationWebsocketMessage
6742
6980
  */
6743
6981
  event_queue_position?: ConversationEventQueuePosition;
6982
+ /**
6983
+ *
6984
+ * @type {ConversationWebchatQueueStatus}
6985
+ * @memberof ConversationWebsocketMessage
6986
+ */
6987
+ event_queue_status_update?: ConversationWebchatQueueStatus;
6744
6988
  /**
6745
6989
  * Type of event
6746
6990
  * @type {string}
@@ -6782,7 +7026,8 @@ export namespace ConversationWebsocketMessage {
6782
7026
  ConversationClosed = <any> 'conversation closed',
6783
7027
  NewConversation = <any> 'new conversation',
6784
7028
  NewMessage = <any> 'new message',
6785
- UpdatedMessage = <any> 'updated message'
7029
+ UpdatedMessage = <any> 'updated message',
7030
+ QueueStatusUpdate = <any> 'queue status update'
6786
7031
  }
6787
7032
  /**
6788
7033
  * @export
@@ -38736,6 +38981,52 @@ export const ConversationApiFetchParamCreator = function (configuration?: Config
38736
38981
  options: localVarRequestOptions,
38737
38982
  };
38738
38983
  },
38984
+ /**
38985
+ * Retrieve a conversation webchat queue statuses including agent status and queue entries
38986
+ * @summary Retrieve a conversation webchat queue statuses
38987
+ * @param {*} [options] Override http request option.
38988
+ * @throws {RequiredError}
38989
+ */
38990
+ getConversationWebchatQueueStatuses(options: any = {}): FetchArgs {
38991
+ const localVarPath = `/conversation/conversations/queues/statuses`;
38992
+ const localVarUrlObj = url.parse(localVarPath, true);
38993
+ const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
38994
+ const localVarHeaderParameter = {} as any;
38995
+ const localVarQueryParameter = {} as any;
38996
+
38997
+ if(configuration && configuration.apiVersion) {
38998
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
38999
+ }
39000
+
39001
+
39002
+
39003
+ // authentication ultraCartOauth required
39004
+ // oauth required
39005
+ if (configuration && configuration.accessToken) {
39006
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
39007
+ ? configuration.accessToken("ultraCartOauth", ["conversation_read"])
39008
+ : configuration.accessToken;
39009
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
39010
+ }
39011
+
39012
+ // authentication ultraCartSimpleApiKey required
39013
+ if (configuration && configuration.apiKey) {
39014
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
39015
+ ? configuration.apiKey("x-ultracart-simple-key")
39016
+ : configuration.apiKey;
39017
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
39018
+ }
39019
+
39020
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
39021
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
39022
+ delete localVarUrlObj.search;
39023
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
39024
+
39025
+ return {
39026
+ url: url.format(localVarUrlObj),
39027
+ options: localVarRequestOptions,
39028
+ };
39029
+ },
38739
39030
  /**
38740
39031
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
38741
39032
  * @summary Retrieve a list of conversation summaries newest to oldest
@@ -38946,6 +39237,67 @@ export const ConversationApiFetchParamCreator = function (configuration?: Config
38946
39237
  const needsSerialization = (<any>"ConversationStartRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
38947
39238
  localVarRequestOptions.body = needsSerialization ? JSON.stringify(start_request || {}) : (start_request || "");
38948
39239
 
39240
+ return {
39241
+ url: url.format(localVarUrlObj),
39242
+ options: localVarRequestOptions,
39243
+ };
39244
+ },
39245
+ /**
39246
+ * Update status within the queue
39247
+ * @summary Update status within the queue
39248
+ * @param {string} queue_name
39249
+ * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
39250
+ * @param {*} [options] Override http request option.
39251
+ * @throws {RequiredError}
39252
+ */
39253
+ updateConversationWebchatQueueStatus(queue_name: string, status_request: ConversationWebchatQueueStatusUpdateRequest, options: any = {}): FetchArgs {
39254
+ // verify required parameter 'queue_name' is not null or undefined
39255
+ if (queue_name === null || queue_name === undefined) {
39256
+ throw new RequiredError('queue_name','Required parameter queue_name was null or undefined when calling updateConversationWebchatQueueStatus.');
39257
+ }
39258
+ // verify required parameter 'status_request' is not null or undefined
39259
+ if (status_request === null || status_request === undefined) {
39260
+ throw new RequiredError('status_request','Required parameter status_request was null or undefined when calling updateConversationWebchatQueueStatus.');
39261
+ }
39262
+ const localVarPath = `/conversation/conversations/queues/{queue_name}/status`
39263
+ .replace(`{${"queue_name"}}`, encodeURIComponent(String(queue_name)));
39264
+ const localVarUrlObj = url.parse(localVarPath, true);
39265
+ const localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
39266
+ const localVarHeaderParameter = {} as any;
39267
+ const localVarQueryParameter = {} as any;
39268
+
39269
+ if(configuration && configuration.apiVersion) {
39270
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
39271
+ }
39272
+
39273
+
39274
+
39275
+ // authentication ultraCartOauth required
39276
+ // oauth required
39277
+ if (configuration && configuration.accessToken) {
39278
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
39279
+ ? configuration.accessToken("ultraCartOauth", ["conversation_write"])
39280
+ : configuration.accessToken;
39281
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
39282
+ }
39283
+
39284
+ // authentication ultraCartSimpleApiKey required
39285
+ if (configuration && configuration.apiKey) {
39286
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
39287
+ ? configuration.apiKey("x-ultracart-simple-key")
39288
+ : configuration.apiKey;
39289
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
39290
+ }
39291
+
39292
+ localVarHeaderParameter['Content-Type'] = 'application/json';
39293
+
39294
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
39295
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
39296
+ delete localVarUrlObj.search;
39297
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
39298
+ const needsSerialization = (<any>"ConversationWebchatQueueStatusUpdateRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
39299
+ localVarRequestOptions.body = needsSerialization ? JSON.stringify(status_request || {}) : (status_request || "");
39300
+
38949
39301
  return {
38950
39302
  url: url.format(localVarUrlObj),
38951
39303
  options: localVarRequestOptions,
@@ -39022,6 +39374,26 @@ export const ConversationApiFp = function(configuration?: Configuration) {
39022
39374
  });
39023
39375
  };
39024
39376
  },
39377
+ /**
39378
+ * Retrieve a conversation webchat queue statuses including agent status and queue entries
39379
+ * @summary Retrieve a conversation webchat queue statuses
39380
+ * @param {*} [options] Override http request option.
39381
+ * @throws {RequiredError}
39382
+ */
39383
+ getConversationWebchatQueueStatuses(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationWebchatQueueStatusesResponse> {
39384
+ const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).getConversationWebchatQueueStatuses(options);
39385
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
39386
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
39387
+
39388
+ if (response.status >= 200 && response.status < 300) {
39389
+ return response.json();
39390
+
39391
+ } else {
39392
+ throw response;
39393
+ }
39394
+ });
39395
+ };
39396
+ },
39025
39397
  /**
39026
39398
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
39027
39399
  * @summary Retrieve a list of conversation summaries newest to oldest
@@ -39107,6 +39479,28 @@ export const ConversationApiFp = function(configuration?: Configuration) {
39107
39479
  });
39108
39480
  };
39109
39481
  },
39482
+ /**
39483
+ * Update status within the queue
39484
+ * @summary Update status within the queue
39485
+ * @param {string} queue_name
39486
+ * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
39487
+ * @param {*} [options] Override http request option.
39488
+ * @throws {RequiredError}
39489
+ */
39490
+ updateConversationWebchatQueueStatus(queue_name: string, status_request: ConversationWebchatQueueStatusUpdateRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response> {
39491
+ const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).updateConversationWebchatQueueStatus(queue_name, status_request, options);
39492
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
39493
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
39494
+
39495
+ if (response.status >= 200 && response.status < 300) {
39496
+ return response;
39497
+
39498
+ } else {
39499
+ throw response;
39500
+ }
39501
+ });
39502
+ };
39503
+ },
39110
39504
  }
39111
39505
  };
39112
39506
 
@@ -39145,6 +39539,15 @@ export const ConversationApiFactory = function (configuration?: Configuration, f
39145
39539
  getConversationMultimediaUploadUrl(extension: string, options?: any) {
39146
39540
  return ConversationApiFp(configuration).getConversationMultimediaUploadUrl(extension, options)(fetch, basePath);
39147
39541
  },
39542
+ /**
39543
+ * Retrieve a conversation webchat queue statuses including agent status and queue entries
39544
+ * @summary Retrieve a conversation webchat queue statuses
39545
+ * @param {*} [options] Override http request option.
39546
+ * @throws {RequiredError}
39547
+ */
39548
+ getConversationWebchatQueueStatuses(options?: any) {
39549
+ return ConversationApiFp(configuration).getConversationWebchatQueueStatuses(options)(fetch, basePath);
39550
+ },
39148
39551
  /**
39149
39552
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
39150
39553
  * @summary Retrieve a list of conversation summaries newest to oldest
@@ -39186,6 +39589,17 @@ export const ConversationApiFactory = function (configuration?: Configuration, f
39186
39589
  startConversation(start_request: ConversationStartRequest, options?: any) {
39187
39590
  return ConversationApiFp(configuration).startConversation(start_request, options)(fetch, basePath);
39188
39591
  },
39592
+ /**
39593
+ * Update status within the queue
39594
+ * @summary Update status within the queue
39595
+ * @param {string} queue_name
39596
+ * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
39597
+ * @param {*} [options] Override http request option.
39598
+ * @throws {RequiredError}
39599
+ */
39600
+ updateConversationWebchatQueueStatus(queue_name: string, status_request: ConversationWebchatQueueStatusUpdateRequest, options?: any) {
39601
+ return ConversationApiFp(configuration).updateConversationWebchatQueueStatus(queue_name, status_request, options)(fetch, basePath);
39602
+ },
39189
39603
  };
39190
39604
  };
39191
39605
 
@@ -39224,6 +39638,15 @@ export interface ConversationApiInterface {
39224
39638
  */
39225
39639
  getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<ConversationMultimediaUploadUrlResponse>;
39226
39640
 
39641
+ /**
39642
+ * Retrieve a conversation webchat queue statuses including agent status and queue entries
39643
+ * @summary Retrieve a conversation webchat queue statuses
39644
+ * @param {*} [options] Override http request option.
39645
+ * @throws {RequiredError}
39646
+ * @memberof ConversationApiInterface
39647
+ */
39648
+ getConversationWebchatQueueStatuses(options?: any): Promise<ConversationWebchatQueueStatusesResponse>;
39649
+
39227
39650
  /**
39228
39651
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
39229
39652
  * @summary Retrieve a list of conversation summaries newest to oldest
@@ -39265,6 +39688,17 @@ export interface ConversationApiInterface {
39265
39688
  */
39266
39689
  startConversation(start_request: ConversationStartRequest, options?: any): Promise<ConversationStartResponse>;
39267
39690
 
39691
+ /**
39692
+ * Update status within the queue
39693
+ * @summary Update status within the queue
39694
+ * @param {string} queue_name
39695
+ * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
39696
+ * @param {*} [options] Override http request option.
39697
+ * @throws {RequiredError}
39698
+ * @memberof ConversationApiInterface
39699
+ */
39700
+ updateConversationWebchatQueueStatus(queue_name: string, status_request: ConversationWebchatQueueStatusUpdateRequest, options?: any): Promise<{}>;
39701
+
39268
39702
  }
39269
39703
 
39270
39704
  /**
@@ -39309,6 +39743,17 @@ export class ConversationApi extends BaseAPI implements ConversationApiInterface
39309
39743
  return ConversationApiFp(this.configuration).getConversationMultimediaUploadUrl(extension, options)(this.fetch, this.basePath);
39310
39744
  }
39311
39745
 
39746
+ /**
39747
+ * Retrieve a conversation webchat queue statuses including agent status and queue entries
39748
+ * @summary Retrieve a conversation webchat queue statuses
39749
+ * @param {*} [options] Override http request option.
39750
+ * @throws {RequiredError}
39751
+ * @memberof ConversationApi
39752
+ */
39753
+ public getConversationWebchatQueueStatuses(options?: any) {
39754
+ return ConversationApiFp(this.configuration).getConversationWebchatQueueStatuses(options)(this.fetch, this.basePath);
39755
+ }
39756
+
39312
39757
  /**
39313
39758
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
39314
39759
  * @summary Retrieve a list of conversation summaries newest to oldest
@@ -39358,6 +39803,19 @@ export class ConversationApi extends BaseAPI implements ConversationApiInterface
39358
39803
  return ConversationApiFp(this.configuration).startConversation(start_request, options)(this.fetch, this.basePath);
39359
39804
  }
39360
39805
 
39806
+ /**
39807
+ * Update status within the queue
39808
+ * @summary Update status within the queue
39809
+ * @param {string} queue_name
39810
+ * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
39811
+ * @param {*} [options] Override http request option.
39812
+ * @throws {RequiredError}
39813
+ * @memberof ConversationApi
39814
+ */
39815
+ public updateConversationWebchatQueueStatus(queue_name: string, status_request: ConversationWebchatQueueStatusUpdateRequest, options?: any) {
39816
+ return ConversationApiFp(this.configuration).updateConversationWebchatQueueStatus(queue_name, status_request, options)(this.fetch, this.basePath);
39817
+ }
39818
+
39361
39819
  }
39362
39820
 
39363
39821
  /**
package/dist/api.d.ts CHANGED
@@ -6112,6 +6112,12 @@ export interface CityStateZip {
6112
6112
  * @interface Conversation
6113
6113
  */
6114
6114
  export interface Conversation {
6115
+ /**
6116
+ *
6117
+ * @type {boolean}
6118
+ * @memberof Conversation
6119
+ */
6120
+ closed?: boolean;
6115
6121
  /**
6116
6122
  *
6117
6123
  * @type {string}
@@ -6284,6 +6290,12 @@ export interface ConversationMessage {
6284
6290
  * @memberof ConversationMessage
6285
6291
  */
6286
6292
  transport_statuses?: Array<ConversationMessageTransportStatus>;
6293
+ /**
6294
+ *
6295
+ * @type {Array<string>}
6296
+ * @memberof ConversationMessage
6297
+ */
6298
+ upload_keys?: Array<string>;
6287
6299
  }
6288
6300
  /**
6289
6301
  *
@@ -6490,6 +6502,12 @@ export interface ConversationStartResponse {
6490
6502
  * @interface ConversationSummary
6491
6503
  */
6492
6504
  export interface ConversationSummary {
6505
+ /**
6506
+ *
6507
+ * @type {boolean}
6508
+ * @memberof ConversationSummary
6509
+ */
6510
+ closed?: boolean;
6493
6511
  /**
6494
6512
  *
6495
6513
  * @type {string}
@@ -6545,6 +6563,221 @@ export interface ConversationSummary {
6545
6563
  */
6546
6564
  unread_messages?: boolean;
6547
6565
  }
6566
+ /**
6567
+ *
6568
+ * @export
6569
+ * @interface ConversationWebchatQueueStatus
6570
+ */
6571
+ export interface ConversationWebchatQueueStatus {
6572
+ /**
6573
+ *
6574
+ * @type {number}
6575
+ * @memberof ConversationWebchatQueueStatus
6576
+ */
6577
+ agent_available_count?: number;
6578
+ /**
6579
+ *
6580
+ * @type {number}
6581
+ * @memberof ConversationWebchatQueueStatus
6582
+ */
6583
+ agent_busy_count?: number;
6584
+ /**
6585
+ *
6586
+ * @type {number}
6587
+ * @memberof ConversationWebchatQueueStatus
6588
+ */
6589
+ agent_count?: number;
6590
+ /**
6591
+ *
6592
+ * @type {number}
6593
+ * @memberof ConversationWebchatQueueStatus
6594
+ */
6595
+ agent_unavailable_count?: number;
6596
+ /**
6597
+ *
6598
+ * @type {Array<ConversationWebchatQueueStatusAgent>}
6599
+ * @memberof ConversationWebchatQueueStatus
6600
+ */
6601
+ agents?: Array<ConversationWebchatQueueStatusAgent>;
6602
+ /**
6603
+ *
6604
+ * @type {number}
6605
+ * @memberof ConversationWebchatQueueStatus
6606
+ */
6607
+ customer_abandon_count?: number;
6608
+ /**
6609
+ *
6610
+ * @type {number}
6611
+ * @memberof ConversationWebchatQueueStatus
6612
+ */
6613
+ customer_active_count?: number;
6614
+ /**
6615
+ *
6616
+ * @type {number}
6617
+ * @memberof ConversationWebchatQueueStatus
6618
+ */
6619
+ customer_average_abandon_time_seconds?: number;
6620
+ /**
6621
+ *
6622
+ * @type {number}
6623
+ * @memberof ConversationWebchatQueueStatus
6624
+ */
6625
+ customer_average_chat_time_seconds?: number;
6626
+ /**
6627
+ *
6628
+ * @type {number}
6629
+ * @memberof ConversationWebchatQueueStatus
6630
+ */
6631
+ customer_average_hold_time_seconds?: number;
6632
+ /**
6633
+ *
6634
+ * @type {number}
6635
+ * @memberof ConversationWebchatQueueStatus
6636
+ */
6637
+ customer_waiting_count?: number;
6638
+ /**
6639
+ * Date/time that the oldest person joined the queue
6640
+ * @type {string}
6641
+ * @memberof ConversationWebchatQueueStatus
6642
+ */
6643
+ customer_waiting_join_dts?: string;
6644
+ /**
6645
+ *
6646
+ * @type {Array<ConversationWebchatQueueStatusQueueEntry>}
6647
+ * @memberof ConversationWebchatQueueStatus
6648
+ */
6649
+ queue_entries?: Array<ConversationWebchatQueueStatusQueueEntry>;
6650
+ /**
6651
+ *
6652
+ * @type {string}
6653
+ * @memberof ConversationWebchatQueueStatus
6654
+ */
6655
+ queue_name?: string;
6656
+ }
6657
+ /**
6658
+ *
6659
+ * @export
6660
+ * @interface ConversationWebchatQueueStatusAgent
6661
+ */
6662
+ export interface ConversationWebchatQueueStatusAgent {
6663
+ /**
6664
+ *
6665
+ * @type {string}
6666
+ * @memberof ConversationWebchatQueueStatusAgent
6667
+ */
6668
+ agent_status?: string;
6669
+ /**
6670
+ *
6671
+ * @type {string}
6672
+ * @memberof ConversationWebchatQueueStatusAgent
6673
+ */
6674
+ conversation_participant_arn?: string;
6675
+ /**
6676
+ *
6677
+ * @type {string}
6678
+ * @memberof ConversationWebchatQueueStatusAgent
6679
+ */
6680
+ conversation_participant_name?: string;
6681
+ /**
6682
+ * Date/time that this agent took their last chat
6683
+ * @type {string}
6684
+ * @memberof ConversationWebchatQueueStatusAgent
6685
+ */
6686
+ last_chat_dts?: string;
6687
+ /**
6688
+ *
6689
+ * @type {boolean}
6690
+ * @memberof ConversationWebchatQueueStatusAgent
6691
+ */
6692
+ next_round_robin?: boolean;
6693
+ }
6694
+ /**
6695
+ *
6696
+ * @export
6697
+ * @interface ConversationWebchatQueueStatusQueueEntry
6698
+ */
6699
+ export interface ConversationWebchatQueueStatusQueueEntry {
6700
+ /**
6701
+ *
6702
+ * @type {string}
6703
+ * @memberof ConversationWebchatQueueStatusQueueEntry
6704
+ */
6705
+ conversation_participant_arn?: string;
6706
+ /**
6707
+ *
6708
+ * @type {string}
6709
+ * @memberof ConversationWebchatQueueStatusQueueEntry
6710
+ */
6711
+ conversation_participant_name?: string;
6712
+ /**
6713
+ *
6714
+ * @type {string}
6715
+ * @memberof ConversationWebchatQueueStatusQueueEntry
6716
+ */
6717
+ conversation_webchat_queue_uuid?: string;
6718
+ /**
6719
+ * Date/time the customer joined the queue
6720
+ * @type {string}
6721
+ * @memberof ConversationWebchatQueueStatusQueueEntry
6722
+ */
6723
+ join_dts?: string;
6724
+ /**
6725
+ *
6726
+ * @type {string}
6727
+ * @memberof ConversationWebchatQueueStatusQueueEntry
6728
+ */
6729
+ question?: string;
6730
+ }
6731
+ /**
6732
+ *
6733
+ * @export
6734
+ * @interface ConversationWebchatQueueStatusUpdateRequest
6735
+ */
6736
+ export interface ConversationWebchatQueueStatusUpdateRequest {
6737
+ /**
6738
+ *
6739
+ * @type {string}
6740
+ * @memberof ConversationWebchatQueueStatusUpdateRequest
6741
+ */
6742
+ agent_status?: string;
6743
+ }
6744
+ /**
6745
+ *
6746
+ * @export
6747
+ * @interface ConversationWebchatQueueStatusesResponse
6748
+ */
6749
+ export interface ConversationWebchatQueueStatusesResponse {
6750
+ /**
6751
+ *
6752
+ * @type {ModelError}
6753
+ * @memberof ConversationWebchatQueueStatusesResponse
6754
+ */
6755
+ error?: ModelError;
6756
+ /**
6757
+ *
6758
+ * @type {ResponseMetadata}
6759
+ * @memberof ConversationWebchatQueueStatusesResponse
6760
+ */
6761
+ metadata?: ResponseMetadata;
6762
+ /**
6763
+ *
6764
+ * @type {Array<ConversationWebchatQueueStatus>}
6765
+ * @memberof ConversationWebchatQueueStatusesResponse
6766
+ */
6767
+ queue_statuses?: Array<ConversationWebchatQueueStatus>;
6768
+ /**
6769
+ * Indicates if API call was successful
6770
+ * @type {boolean}
6771
+ * @memberof ConversationWebchatQueueStatusesResponse
6772
+ */
6773
+ success?: boolean;
6774
+ /**
6775
+ *
6776
+ * @type {Warning}
6777
+ * @memberof ConversationWebchatQueueStatusesResponse
6778
+ */
6779
+ warning?: Warning;
6780
+ }
6548
6781
  /**
6549
6782
  *
6550
6783
  * @export
@@ -6559,28 +6792,34 @@ export interface ConversationWebsocketMessage {
6559
6792
  conversation_uuid?: string;
6560
6793
  /**
6561
6794
  *
6562
- * @type {Conversation}
6795
+ * @type {ConversationSummary}
6563
6796
  * @memberof ConversationWebsocketMessage
6564
6797
  */
6565
- event_conversation_closed?: Conversation;
6798
+ event_conversation_closed?: ConversationSummary;
6566
6799
  /**
6567
6800
  *
6568
- * @type {Conversation}
6801
+ * @type {ConversationSummary}
6569
6802
  * @memberof ConversationWebsocketMessage
6570
6803
  */
6571
- event_new_conversation?: Conversation;
6804
+ event_new_conversation?: ConversationSummary;
6572
6805
  /**
6573
6806
  *
6574
- * @type {Conversation}
6807
+ * @type {ConversationSummary}
6575
6808
  * @memberof ConversationWebsocketMessage
6576
6809
  */
6577
- event_new_message?: Conversation;
6810
+ event_new_message?: ConversationSummary;
6578
6811
  /**
6579
6812
  *
6580
6813
  * @type {ConversationEventQueuePosition}
6581
6814
  * @memberof ConversationWebsocketMessage
6582
6815
  */
6583
6816
  event_queue_position?: ConversationEventQueuePosition;
6817
+ /**
6818
+ *
6819
+ * @type {ConversationWebchatQueueStatus}
6820
+ * @memberof ConversationWebsocketMessage
6821
+ */
6822
+ event_queue_status_update?: ConversationWebchatQueueStatus;
6584
6823
  /**
6585
6824
  * Type of event
6586
6825
  * @type {string}
@@ -6621,7 +6860,8 @@ export declare namespace ConversationWebsocketMessage {
6621
6860
  ConversationClosed,
6622
6861
  NewConversation,
6623
6862
  NewMessage,
6624
- UpdatedMessage
6863
+ UpdatedMessage,
6864
+ QueueStatusUpdate
6625
6865
  }
6626
6866
  /**
6627
6867
  * @export
@@ -34909,6 +35149,13 @@ export declare const ConversationApiFetchParamCreator: (configuration?: Configur
34909
35149
  * @throws {RequiredError}
34910
35150
  */
34911
35151
  getConversationMultimediaUploadUrl(extension: string, options?: any): FetchArgs;
35152
+ /**
35153
+ * Retrieve a conversation webchat queue statuses including agent status and queue entries
35154
+ * @summary Retrieve a conversation webchat queue statuses
35155
+ * @param {*} [options] Override http request option.
35156
+ * @throws {RequiredError}
35157
+ */
35158
+ getConversationWebchatQueueStatuses(options?: any): FetchArgs;
34912
35159
  /**
34913
35160
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
34914
35161
  * @summary Retrieve a list of conversation summaries newest to oldest
@@ -34942,6 +35189,15 @@ export declare const ConversationApiFetchParamCreator: (configuration?: Configur
34942
35189
  * @throws {RequiredError}
34943
35190
  */
34944
35191
  startConversation(start_request: ConversationStartRequest, options?: any): FetchArgs;
35192
+ /**
35193
+ * Update status within the queue
35194
+ * @summary Update status within the queue
35195
+ * @param {string} queue_name
35196
+ * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
35197
+ * @param {*} [options] Override http request option.
35198
+ * @throws {RequiredError}
35199
+ */
35200
+ updateConversationWebchatQueueStatus(queue_name: string, status_request: ConversationWebchatQueueStatusUpdateRequest, options?: any): FetchArgs;
34945
35201
  };
34946
35202
  /**
34947
35203
  * ConversationApi - functional programming interface
@@ -34971,6 +35227,13 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
34971
35227
  * @throws {RequiredError}
34972
35228
  */
34973
35229
  getConversationMultimediaUploadUrl(extension: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationMultimediaUploadUrlResponse>;
35230
+ /**
35231
+ * Retrieve a conversation webchat queue statuses including agent status and queue entries
35232
+ * @summary Retrieve a conversation webchat queue statuses
35233
+ * @param {*} [options] Override http request option.
35234
+ * @throws {RequiredError}
35235
+ */
35236
+ getConversationWebchatQueueStatuses(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationWebchatQueueStatusesResponse>;
34974
35237
  /**
34975
35238
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
34976
35239
  * @summary Retrieve a list of conversation summaries newest to oldest
@@ -35004,6 +35267,15 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
35004
35267
  * @throws {RequiredError}
35005
35268
  */
35006
35269
  startConversation(start_request: ConversationStartRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationStartResponse>;
35270
+ /**
35271
+ * Update status within the queue
35272
+ * @summary Update status within the queue
35273
+ * @param {string} queue_name
35274
+ * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
35275
+ * @param {*} [options] Override http request option.
35276
+ * @throws {RequiredError}
35277
+ */
35278
+ updateConversationWebchatQueueStatus(queue_name: string, status_request: ConversationWebchatQueueStatusUpdateRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
35007
35279
  };
35008
35280
  /**
35009
35281
  * ConversationApi - factory interface
@@ -35033,6 +35305,13 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
35033
35305
  * @throws {RequiredError}
35034
35306
  */
35035
35307
  getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<ConversationMultimediaUploadUrlResponse>;
35308
+ /**
35309
+ * Retrieve a conversation webchat queue statuses including agent status and queue entries
35310
+ * @summary Retrieve a conversation webchat queue statuses
35311
+ * @param {*} [options] Override http request option.
35312
+ * @throws {RequiredError}
35313
+ */
35314
+ getConversationWebchatQueueStatuses(options?: any): Promise<ConversationWebchatQueueStatusesResponse>;
35036
35315
  /**
35037
35316
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
35038
35317
  * @summary Retrieve a list of conversation summaries newest to oldest
@@ -35066,6 +35345,15 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
35066
35345
  * @throws {RequiredError}
35067
35346
  */
35068
35347
  startConversation(start_request: ConversationStartRequest, options?: any): Promise<ConversationStartResponse>;
35348
+ /**
35349
+ * Update status within the queue
35350
+ * @summary Update status within the queue
35351
+ * @param {string} queue_name
35352
+ * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
35353
+ * @param {*} [options] Override http request option.
35354
+ * @throws {RequiredError}
35355
+ */
35356
+ updateConversationWebchatQueueStatus(queue_name: string, status_request: ConversationWebchatQueueStatusUpdateRequest, options?: any): Promise<Response>;
35069
35357
  };
35070
35358
  /**
35071
35359
  * ConversationApi - interface
@@ -35099,6 +35387,14 @@ export interface ConversationApiInterface {
35099
35387
  * @memberof ConversationApiInterface
35100
35388
  */
35101
35389
  getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<ConversationMultimediaUploadUrlResponse>;
35390
+ /**
35391
+ * Retrieve a conversation webchat queue statuses including agent status and queue entries
35392
+ * @summary Retrieve a conversation webchat queue statuses
35393
+ * @param {*} [options] Override http request option.
35394
+ * @throws {RequiredError}
35395
+ * @memberof ConversationApiInterface
35396
+ */
35397
+ getConversationWebchatQueueStatuses(options?: any): Promise<ConversationWebchatQueueStatusesResponse>;
35102
35398
  /**
35103
35399
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
35104
35400
  * @summary Retrieve a list of conversation summaries newest to oldest
@@ -35136,6 +35432,16 @@ export interface ConversationApiInterface {
35136
35432
  * @memberof ConversationApiInterface
35137
35433
  */
35138
35434
  startConversation(start_request: ConversationStartRequest, options?: any): Promise<ConversationStartResponse>;
35435
+ /**
35436
+ * Update status within the queue
35437
+ * @summary Update status within the queue
35438
+ * @param {string} queue_name
35439
+ * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
35440
+ * @param {*} [options] Override http request option.
35441
+ * @throws {RequiredError}
35442
+ * @memberof ConversationApiInterface
35443
+ */
35444
+ updateConversationWebchatQueueStatus(queue_name: string, status_request: ConversationWebchatQueueStatusUpdateRequest, options?: any): Promise<{}>;
35139
35445
  }
35140
35446
  /**
35141
35447
  * ConversationApi - object-oriented interface
@@ -35170,6 +35476,14 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
35170
35476
  * @memberof ConversationApi
35171
35477
  */
35172
35478
  getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<ConversationMultimediaUploadUrlResponse>;
35479
+ /**
35480
+ * Retrieve a conversation webchat queue statuses including agent status and queue entries
35481
+ * @summary Retrieve a conversation webchat queue statuses
35482
+ * @param {*} [options] Override http request option.
35483
+ * @throws {RequiredError}
35484
+ * @memberof ConversationApi
35485
+ */
35486
+ getConversationWebchatQueueStatuses(options?: any): Promise<ConversationWebchatQueueStatusesResponse>;
35173
35487
  /**
35174
35488
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
35175
35489
  * @summary Retrieve a list of conversation summaries newest to oldest
@@ -35207,6 +35521,16 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
35207
35521
  * @memberof ConversationApi
35208
35522
  */
35209
35523
  startConversation(start_request: ConversationStartRequest, options?: any): Promise<ConversationStartResponse>;
35524
+ /**
35525
+ * Update status within the queue
35526
+ * @summary Update status within the queue
35527
+ * @param {string} queue_name
35528
+ * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
35529
+ * @param {*} [options] Override http request option.
35530
+ * @throws {RequiredError}
35531
+ * @memberof ConversationApi
35532
+ */
35533
+ updateConversationWebchatQueueStatus(queue_name: string, status_request: ConversationWebchatQueueStatusUpdateRequest, options?: any): Promise<Response>;
35210
35534
  }
35211
35535
  /**
35212
35536
  * CouponApi - fetch parameter creator
package/dist/api.js CHANGED
@@ -377,6 +377,7 @@ var ConversationWebsocketMessage;
377
377
  EventTypeEnum[EventTypeEnum["NewConversation"] = 'new conversation'] = "NewConversation";
378
378
  EventTypeEnum[EventTypeEnum["NewMessage"] = 'new message'] = "NewMessage";
379
379
  EventTypeEnum[EventTypeEnum["UpdatedMessage"] = 'updated message'] = "UpdatedMessage";
380
+ EventTypeEnum[EventTypeEnum["QueueStatusUpdate"] = 'queue status update'] = "QueueStatusUpdate";
380
381
  })(EventTypeEnum = ConversationWebsocketMessage.EventTypeEnum || (ConversationWebsocketMessage.EventTypeEnum = {}));
381
382
  /**
382
383
  * @export
@@ -5458,6 +5459,46 @@ var ConversationApiFetchParamCreator = function (configuration) {
5458
5459
  options: localVarRequestOptions,
5459
5460
  };
5460
5461
  },
5462
+ /**
5463
+ * Retrieve a conversation webchat queue statuses including agent status and queue entries
5464
+ * @summary Retrieve a conversation webchat queue statuses
5465
+ * @param {*} [options] Override http request option.
5466
+ * @throws {RequiredError}
5467
+ */
5468
+ getConversationWebchatQueueStatuses: function (options) {
5469
+ if (options === void 0) { options = {}; }
5470
+ var localVarPath = "/conversation/conversations/queues/statuses";
5471
+ var localVarUrlObj = url.parse(localVarPath, true);
5472
+ var localVarRequestOptions = Object.assign({ method: 'GET' }, options);
5473
+ var localVarHeaderParameter = {};
5474
+ var localVarQueryParameter = {};
5475
+ if (configuration && configuration.apiVersion) {
5476
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
5477
+ }
5478
+ // authentication ultraCartOauth required
5479
+ // oauth required
5480
+ if (configuration && configuration.accessToken) {
5481
+ var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
5482
+ ? configuration.accessToken("ultraCartOauth", ["conversation_read"])
5483
+ : configuration.accessToken;
5484
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
5485
+ }
5486
+ // authentication ultraCartSimpleApiKey required
5487
+ if (configuration && configuration.apiKey) {
5488
+ var localVarApiKeyValue = typeof configuration.apiKey === 'function'
5489
+ ? configuration.apiKey("x-ultracart-simple-key")
5490
+ : configuration.apiKey;
5491
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
5492
+ }
5493
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
5494
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
5495
+ delete localVarUrlObj.search;
5496
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
5497
+ return {
5498
+ url: url.format(localVarUrlObj),
5499
+ options: localVarRequestOptions,
5500
+ };
5501
+ },
5461
5502
  /**
5462
5503
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
5463
5504
  * @summary Retrieve a list of conversation summaries newest to oldest
@@ -5646,6 +5687,60 @@ var ConversationApiFetchParamCreator = function (configuration) {
5646
5687
  options: localVarRequestOptions,
5647
5688
  };
5648
5689
  },
5690
+ /**
5691
+ * Update status within the queue
5692
+ * @summary Update status within the queue
5693
+ * @param {string} queue_name
5694
+ * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
5695
+ * @param {*} [options] Override http request option.
5696
+ * @throws {RequiredError}
5697
+ */
5698
+ updateConversationWebchatQueueStatus: function (queue_name, status_request, options) {
5699
+ if (options === void 0) { options = {}; }
5700
+ // verify required parameter 'queue_name' is not null or undefined
5701
+ if (queue_name === null || queue_name === undefined) {
5702
+ throw new RequiredError('queue_name', 'Required parameter queue_name was null or undefined when calling updateConversationWebchatQueueStatus.');
5703
+ }
5704
+ // verify required parameter 'status_request' is not null or undefined
5705
+ if (status_request === null || status_request === undefined) {
5706
+ throw new RequiredError('status_request', 'Required parameter status_request was null or undefined when calling updateConversationWebchatQueueStatus.');
5707
+ }
5708
+ var localVarPath = "/conversation/conversations/queues/{queue_name}/status"
5709
+ .replace("{".concat("queue_name", "}"), encodeURIComponent(String(queue_name)));
5710
+ var localVarUrlObj = url.parse(localVarPath, true);
5711
+ var localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
5712
+ var localVarHeaderParameter = {};
5713
+ var localVarQueryParameter = {};
5714
+ if (configuration && configuration.apiVersion) {
5715
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
5716
+ }
5717
+ // authentication ultraCartOauth required
5718
+ // oauth required
5719
+ if (configuration && configuration.accessToken) {
5720
+ var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
5721
+ ? configuration.accessToken("ultraCartOauth", ["conversation_write"])
5722
+ : configuration.accessToken;
5723
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
5724
+ }
5725
+ // authentication ultraCartSimpleApiKey required
5726
+ if (configuration && configuration.apiKey) {
5727
+ var localVarApiKeyValue = typeof configuration.apiKey === 'function'
5728
+ ? configuration.apiKey("x-ultracart-simple-key")
5729
+ : configuration.apiKey;
5730
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
5731
+ }
5732
+ localVarHeaderParameter['Content-Type'] = 'application/json';
5733
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
5734
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
5735
+ delete localVarUrlObj.search;
5736
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
5737
+ var needsSerialization = ("ConversationWebchatQueueStatusUpdateRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
5738
+ localVarRequestOptions.body = needsSerialization ? JSON.stringify(status_request || {}) : (status_request || "");
5739
+ return {
5740
+ url: url.format(localVarUrlObj),
5741
+ options: localVarRequestOptions,
5742
+ };
5743
+ },
5649
5744
  };
5650
5745
  };
5651
5746
  exports.ConversationApiFetchParamCreator = ConversationApiFetchParamCreator;
@@ -5720,6 +5815,27 @@ var ConversationApiFp = function (configuration) {
5720
5815
  });
5721
5816
  };
5722
5817
  },
5818
+ /**
5819
+ * Retrieve a conversation webchat queue statuses including agent status and queue entries
5820
+ * @summary Retrieve a conversation webchat queue statuses
5821
+ * @param {*} [options] Override http request option.
5822
+ * @throws {RequiredError}
5823
+ */
5824
+ getConversationWebchatQueueStatuses: function (options) {
5825
+ var localVarFetchArgs = (0, exports.ConversationApiFetchParamCreator)(configuration).getConversationWebchatQueueStatuses(options);
5826
+ return function (fetch, basePath) {
5827
+ if (fetch === void 0) { fetch = portableFetch; }
5828
+ if (basePath === void 0) { basePath = BASE_PATH; }
5829
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
5830
+ if (response.status >= 200 && response.status < 300) {
5831
+ return response.json();
5832
+ }
5833
+ else {
5834
+ throw response;
5835
+ }
5836
+ });
5837
+ };
5838
+ },
5723
5839
  /**
5724
5840
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
5725
5841
  * @summary Retrieve a list of conversation summaries newest to oldest
@@ -5809,6 +5925,29 @@ var ConversationApiFp = function (configuration) {
5809
5925
  });
5810
5926
  };
5811
5927
  },
5928
+ /**
5929
+ * Update status within the queue
5930
+ * @summary Update status within the queue
5931
+ * @param {string} queue_name
5932
+ * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
5933
+ * @param {*} [options] Override http request option.
5934
+ * @throws {RequiredError}
5935
+ */
5936
+ updateConversationWebchatQueueStatus: function (queue_name, status_request, options) {
5937
+ var localVarFetchArgs = (0, exports.ConversationApiFetchParamCreator)(configuration).updateConversationWebchatQueueStatus(queue_name, status_request, options);
5938
+ return function (fetch, basePath) {
5939
+ if (fetch === void 0) { fetch = portableFetch; }
5940
+ if (basePath === void 0) { basePath = BASE_PATH; }
5941
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
5942
+ if (response.status >= 200 && response.status < 300) {
5943
+ return response;
5944
+ }
5945
+ else {
5946
+ throw response;
5947
+ }
5948
+ });
5949
+ };
5950
+ },
5812
5951
  };
5813
5952
  };
5814
5953
  exports.ConversationApiFp = ConversationApiFp;
@@ -5847,6 +5986,15 @@ var ConversationApiFactory = function (configuration, fetch, basePath) {
5847
5986
  getConversationMultimediaUploadUrl: function (extension, options) {
5848
5987
  return (0, exports.ConversationApiFp)(configuration).getConversationMultimediaUploadUrl(extension, options)(fetch, basePath);
5849
5988
  },
5989
+ /**
5990
+ * Retrieve a conversation webchat queue statuses including agent status and queue entries
5991
+ * @summary Retrieve a conversation webchat queue statuses
5992
+ * @param {*} [options] Override http request option.
5993
+ * @throws {RequiredError}
5994
+ */
5995
+ getConversationWebchatQueueStatuses: function (options) {
5996
+ return (0, exports.ConversationApiFp)(configuration).getConversationWebchatQueueStatuses(options)(fetch, basePath);
5997
+ },
5850
5998
  /**
5851
5999
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
5852
6000
  * @summary Retrieve a list of conversation summaries newest to oldest
@@ -5888,6 +6036,17 @@ var ConversationApiFactory = function (configuration, fetch, basePath) {
5888
6036
  startConversation: function (start_request, options) {
5889
6037
  return (0, exports.ConversationApiFp)(configuration).startConversation(start_request, options)(fetch, basePath);
5890
6038
  },
6039
+ /**
6040
+ * Update status within the queue
6041
+ * @summary Update status within the queue
6042
+ * @param {string} queue_name
6043
+ * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
6044
+ * @param {*} [options] Override http request option.
6045
+ * @throws {RequiredError}
6046
+ */
6047
+ updateConversationWebchatQueueStatus: function (queue_name, status_request, options) {
6048
+ return (0, exports.ConversationApiFp)(configuration).updateConversationWebchatQueueStatus(queue_name, status_request, options)(fetch, basePath);
6049
+ },
5891
6050
  };
5892
6051
  };
5893
6052
  exports.ConversationApiFactory = ConversationApiFactory;
@@ -5934,6 +6093,16 @@ var ConversationApi = /** @class */ (function (_super) {
5934
6093
  ConversationApi.prototype.getConversationMultimediaUploadUrl = function (extension, options) {
5935
6094
  return (0, exports.ConversationApiFp)(this.configuration).getConversationMultimediaUploadUrl(extension, options)(this.fetch, this.basePath);
5936
6095
  };
6096
+ /**
6097
+ * Retrieve a conversation webchat queue statuses including agent status and queue entries
6098
+ * @summary Retrieve a conversation webchat queue statuses
6099
+ * @param {*} [options] Override http request option.
6100
+ * @throws {RequiredError}
6101
+ * @memberof ConversationApi
6102
+ */
6103
+ ConversationApi.prototype.getConversationWebchatQueueStatuses = function (options) {
6104
+ return (0, exports.ConversationApiFp)(this.configuration).getConversationWebchatQueueStatuses(options)(this.fetch, this.basePath);
6105
+ };
5937
6106
  /**
5938
6107
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
5939
6108
  * @summary Retrieve a list of conversation summaries newest to oldest
@@ -5979,6 +6148,18 @@ var ConversationApi = /** @class */ (function (_super) {
5979
6148
  ConversationApi.prototype.startConversation = function (start_request, options) {
5980
6149
  return (0, exports.ConversationApiFp)(this.configuration).startConversation(start_request, options)(this.fetch, this.basePath);
5981
6150
  };
6151
+ /**
6152
+ * Update status within the queue
6153
+ * @summary Update status within the queue
6154
+ * @param {string} queue_name
6155
+ * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
6156
+ * @param {*} [options] Override http request option.
6157
+ * @throws {RequiredError}
6158
+ * @memberof ConversationApi
6159
+ */
6160
+ ConversationApi.prototype.updateConversationWebchatQueueStatus = function (queue_name, status_request, options) {
6161
+ return (0, exports.ConversationApiFp)(this.configuration).updateConversationWebchatQueueStatus(queue_name, status_request, options)(this.fetch, this.basePath);
6162
+ };
5982
6163
  return ConversationApi;
5983
6164
  }(BaseAPI));
5984
6165
  exports.ConversationApi = ConversationApi;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "3.10.24",
3
+ "version": "3.10.27",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [