ultracart_rest_api_v2_typescript 3.10.23 → 3.10.26

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.23
1
+ ## ultracart_rest_api_v2_typescript@3.10.26
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.23 --save
39
+ npm install ultracart_rest_api_v2_typescript@3.10.26 --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.26 | 07/26/2022 | conversations - queue statistics |
58
+ | 3.10.25 | 07/25/2022 | conversation development |
59
+ | 3.10.24 | 07/25/2022 | conversations bug fixes |
57
60
  | 3.10.23 | 07/25/2022 | conversations - add a websocket message model |
58
61
  | 3.10.22 | 07/20/2022 | conversation participant name added |
59
62
  | 3.10.21 | 07/18/2022 | twilio dev |
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}
@@ -6379,6 +6385,18 @@ export interface ConversationAgentAuthResponse {
6379
6385
  * @interface ConversationEventQueuePosition
6380
6386
  */
6381
6387
  export interface ConversationEventQueuePosition {
6388
+ /**
6389
+ * True if agents are logged into the queue
6390
+ * @type {boolean}
6391
+ * @memberof ConversationEventQueuePosition
6392
+ */
6393
+ available?: boolean;
6394
+ /**
6395
+ * Position in the queue. Value will be -1 if they cant be found in the queue.
6396
+ * @type {number}
6397
+ * @memberof ConversationEventQueuePosition
6398
+ */
6399
+ position?: number;
6382
6400
  }
6383
6401
 
6384
6402
  /**
@@ -6637,6 +6655,12 @@ export interface ConversationStartResponse {
6637
6655
  * @interface ConversationSummary
6638
6656
  */
6639
6657
  export interface ConversationSummary {
6658
+ /**
6659
+ *
6660
+ * @type {boolean}
6661
+ * @memberof ConversationSummary
6662
+ */
6663
+ closed?: boolean;
6640
6664
  /**
6641
6665
  *
6642
6666
  * @type {string}
@@ -6693,6 +6717,202 @@ export interface ConversationSummary {
6693
6717
  unread_messages?: boolean;
6694
6718
  }
6695
6719
 
6720
+ /**
6721
+ *
6722
+ * @export
6723
+ * @interface ConversationWebchatQueueStatus
6724
+ */
6725
+ export interface ConversationWebchatQueueStatus {
6726
+ /**
6727
+ *
6728
+ * @type {number}
6729
+ * @memberof ConversationWebchatQueueStatus
6730
+ */
6731
+ agent_available_count?: number;
6732
+ /**
6733
+ *
6734
+ * @type {number}
6735
+ * @memberof ConversationWebchatQueueStatus
6736
+ */
6737
+ agent_busy_count?: number;
6738
+ /**
6739
+ *
6740
+ * @type {number}
6741
+ * @memberof ConversationWebchatQueueStatus
6742
+ */
6743
+ agent_count?: number;
6744
+ /**
6745
+ *
6746
+ * @type {number}
6747
+ * @memberof ConversationWebchatQueueStatus
6748
+ */
6749
+ agent_unavailable_count?: number;
6750
+ /**
6751
+ *
6752
+ * @type {Array<ConversationWebchatQueueStatusAgent>}
6753
+ * @memberof ConversationWebchatQueueStatus
6754
+ */
6755
+ agents?: Array<ConversationWebchatQueueStatusAgent>;
6756
+ /**
6757
+ *
6758
+ * @type {number}
6759
+ * @memberof ConversationWebchatQueueStatus
6760
+ */
6761
+ customer_abandon_count?: number;
6762
+ /**
6763
+ *
6764
+ * @type {number}
6765
+ * @memberof ConversationWebchatQueueStatus
6766
+ */
6767
+ customer_active_count?: number;
6768
+ /**
6769
+ *
6770
+ * @type {number}
6771
+ * @memberof ConversationWebchatQueueStatus
6772
+ */
6773
+ customer_waiting_count?: number;
6774
+ /**
6775
+ * Date/time that the oldest person joined the queue
6776
+ * @type {string}
6777
+ * @memberof ConversationWebchatQueueStatus
6778
+ */
6779
+ customer_waiting_join_dts?: string;
6780
+ /**
6781
+ *
6782
+ * @type {Array<ConversationWebchatQueueStatusQueueEntry>}
6783
+ * @memberof ConversationWebchatQueueStatus
6784
+ */
6785
+ queue_entries?: Array<ConversationWebchatQueueStatusQueueEntry>;
6786
+ /**
6787
+ *
6788
+ * @type {string}
6789
+ * @memberof ConversationWebchatQueueStatus
6790
+ */
6791
+ queue_name?: string;
6792
+ }
6793
+
6794
+ /**
6795
+ *
6796
+ * @export
6797
+ * @interface ConversationWebchatQueueStatusAgent
6798
+ */
6799
+ export interface ConversationWebchatQueueStatusAgent {
6800
+ /**
6801
+ *
6802
+ * @type {string}
6803
+ * @memberof ConversationWebchatQueueStatusAgent
6804
+ */
6805
+ agent_status?: string;
6806
+ /**
6807
+ *
6808
+ * @type {string}
6809
+ * @memberof ConversationWebchatQueueStatusAgent
6810
+ */
6811
+ conversation_participant_arn?: string;
6812
+ /**
6813
+ *
6814
+ * @type {string}
6815
+ * @memberof ConversationWebchatQueueStatusAgent
6816
+ */
6817
+ conversation_participant_name?: string;
6818
+ /**
6819
+ * Date/time that this agent took their last chat
6820
+ * @type {string}
6821
+ * @memberof ConversationWebchatQueueStatusAgent
6822
+ */
6823
+ last_chat_dts?: string;
6824
+ /**
6825
+ *
6826
+ * @type {boolean}
6827
+ * @memberof ConversationWebchatQueueStatusAgent
6828
+ */
6829
+ next_round_robin?: boolean;
6830
+ }
6831
+
6832
+ /**
6833
+ *
6834
+ * @export
6835
+ * @interface ConversationWebchatQueueStatusQueueEntry
6836
+ */
6837
+ export interface ConversationWebchatQueueStatusQueueEntry {
6838
+ /**
6839
+ *
6840
+ * @type {string}
6841
+ * @memberof ConversationWebchatQueueStatusQueueEntry
6842
+ */
6843
+ conversation_participant_arn?: string;
6844
+ /**
6845
+ *
6846
+ * @type {string}
6847
+ * @memberof ConversationWebchatQueueStatusQueueEntry
6848
+ */
6849
+ conversation_participant_name?: string;
6850
+ /**
6851
+ *
6852
+ * @type {string}
6853
+ * @memberof ConversationWebchatQueueStatusQueueEntry
6854
+ */
6855
+ conversation_webchat_queue_uuid?: string;
6856
+ /**
6857
+ * Date/time the customer joined the queue
6858
+ * @type {string}
6859
+ * @memberof ConversationWebchatQueueStatusQueueEntry
6860
+ */
6861
+ join_dts?: string;
6862
+ }
6863
+
6864
+ /**
6865
+ *
6866
+ * @export
6867
+ * @interface ConversationWebchatQueueStatusUpdateRequest
6868
+ */
6869
+ export interface ConversationWebchatQueueStatusUpdateRequest {
6870
+ /**
6871
+ *
6872
+ * @type {string}
6873
+ * @memberof ConversationWebchatQueueStatusUpdateRequest
6874
+ */
6875
+ agent_status?: string;
6876
+ }
6877
+
6878
+ /**
6879
+ *
6880
+ * @export
6881
+ * @interface ConversationWebchatQueueStatusesResponse
6882
+ */
6883
+ export interface ConversationWebchatQueueStatusesResponse {
6884
+ /**
6885
+ *
6886
+ * @type {ModelError}
6887
+ * @memberof ConversationWebchatQueueStatusesResponse
6888
+ */
6889
+ error?: ModelError;
6890
+ /**
6891
+ *
6892
+ * @type {ResponseMetadata}
6893
+ * @memberof ConversationWebchatQueueStatusesResponse
6894
+ */
6895
+ metadata?: ResponseMetadata;
6896
+ /**
6897
+ *
6898
+ * @type {Array<ConversationWebchatQueueStatus>}
6899
+ * @memberof ConversationWebchatQueueStatusesResponse
6900
+ */
6901
+ queue_statuses?: Array<ConversationWebchatQueueStatus>;
6902
+ /**
6903
+ * Indicates if API call was successful
6904
+ * @type {boolean}
6905
+ * @memberof ConversationWebchatQueueStatusesResponse
6906
+ */
6907
+ success?: boolean;
6908
+ /**
6909
+ *
6910
+ * @type {Warning}
6911
+ * @memberof ConversationWebchatQueueStatusesResponse
6912
+ */
6913
+ warning?: Warning;
6914
+ }
6915
+
6696
6916
  /**
6697
6917
  *
6698
6918
  * @export
@@ -6707,28 +6927,34 @@ export interface ConversationWebsocketMessage {
6707
6927
  conversation_uuid?: string;
6708
6928
  /**
6709
6929
  *
6710
- * @type {Conversation}
6930
+ * @type {ConversationSummary}
6711
6931
  * @memberof ConversationWebsocketMessage
6712
6932
  */
6713
- event_conversation_closed?: Conversation;
6933
+ event_conversation_closed?: ConversationSummary;
6714
6934
  /**
6715
6935
  *
6716
- * @type {Conversation}
6936
+ * @type {ConversationSummary}
6717
6937
  * @memberof ConversationWebsocketMessage
6718
6938
  */
6719
- event_new_conversation?: Conversation;
6939
+ event_new_conversation?: ConversationSummary;
6720
6940
  /**
6721
6941
  *
6722
- * @type {ConversationMessage}
6942
+ * @type {ConversationSummary}
6723
6943
  * @memberof ConversationWebsocketMessage
6724
6944
  */
6725
- event_new_message?: ConversationMessage;
6945
+ event_new_message?: ConversationSummary;
6726
6946
  /**
6727
6947
  *
6728
6948
  * @type {ConversationEventQueuePosition}
6729
6949
  * @memberof ConversationWebsocketMessage
6730
6950
  */
6731
6951
  event_queue_position?: ConversationEventQueuePosition;
6952
+ /**
6953
+ *
6954
+ * @type {ConversationWebchatQueueStatus}
6955
+ * @memberof ConversationWebsocketMessage
6956
+ */
6957
+ event_queue_status_update?: ConversationWebchatQueueStatus;
6732
6958
  /**
6733
6959
  * Type of event
6734
6960
  * @type {string}
@@ -6770,7 +6996,8 @@ export namespace ConversationWebsocketMessage {
6770
6996
  ConversationClosed = <any> 'conversation closed',
6771
6997
  NewConversation = <any> 'new conversation',
6772
6998
  NewMessage = <any> 'new message',
6773
- UpdatedMessage = <any> 'updated message'
6999
+ UpdatedMessage = <any> 'updated message',
7000
+ QueueStatusUpdate = <any> 'queue status update'
6774
7001
  }
6775
7002
  /**
6776
7003
  * @export
@@ -38724,6 +38951,52 @@ export const ConversationApiFetchParamCreator = function (configuration?: Config
38724
38951
  options: localVarRequestOptions,
38725
38952
  };
38726
38953
  },
38954
+ /**
38955
+ * Retrieve a conversation webchat queue statuses including agent status and queue entries
38956
+ * @summary Retrieve a conversation webchat queue statuses
38957
+ * @param {*} [options] Override http request option.
38958
+ * @throws {RequiredError}
38959
+ */
38960
+ getConversationWebchatQueueStatuses(options: any = {}): FetchArgs {
38961
+ const localVarPath = `/conversation/conversations/queues/statuses`;
38962
+ const localVarUrlObj = url.parse(localVarPath, true);
38963
+ const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
38964
+ const localVarHeaderParameter = {} as any;
38965
+ const localVarQueryParameter = {} as any;
38966
+
38967
+ if(configuration && configuration.apiVersion) {
38968
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
38969
+ }
38970
+
38971
+
38972
+
38973
+ // authentication ultraCartOauth required
38974
+ // oauth required
38975
+ if (configuration && configuration.accessToken) {
38976
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
38977
+ ? configuration.accessToken("ultraCartOauth", ["conversation_read"])
38978
+ : configuration.accessToken;
38979
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
38980
+ }
38981
+
38982
+ // authentication ultraCartSimpleApiKey required
38983
+ if (configuration && configuration.apiKey) {
38984
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
38985
+ ? configuration.apiKey("x-ultracart-simple-key")
38986
+ : configuration.apiKey;
38987
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
38988
+ }
38989
+
38990
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
38991
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
38992
+ delete localVarUrlObj.search;
38993
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
38994
+
38995
+ return {
38996
+ url: url.format(localVarUrlObj),
38997
+ options: localVarRequestOptions,
38998
+ };
38999
+ },
38727
39000
  /**
38728
39001
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
38729
39002
  * @summary Retrieve a list of conversation summaries newest to oldest
@@ -38934,6 +39207,67 @@ export const ConversationApiFetchParamCreator = function (configuration?: Config
38934
39207
  const needsSerialization = (<any>"ConversationStartRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
38935
39208
  localVarRequestOptions.body = needsSerialization ? JSON.stringify(start_request || {}) : (start_request || "");
38936
39209
 
39210
+ return {
39211
+ url: url.format(localVarUrlObj),
39212
+ options: localVarRequestOptions,
39213
+ };
39214
+ },
39215
+ /**
39216
+ * Update status within the queue
39217
+ * @summary Update status within the queue
39218
+ * @param {string} queue_name
39219
+ * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
39220
+ * @param {*} [options] Override http request option.
39221
+ * @throws {RequiredError}
39222
+ */
39223
+ updateConversationWebchatQueueStatus(queue_name: string, status_request: ConversationWebchatQueueStatusUpdateRequest, options: any = {}): FetchArgs {
39224
+ // verify required parameter 'queue_name' is not null or undefined
39225
+ if (queue_name === null || queue_name === undefined) {
39226
+ throw new RequiredError('queue_name','Required parameter queue_name was null or undefined when calling updateConversationWebchatQueueStatus.');
39227
+ }
39228
+ // verify required parameter 'status_request' is not null or undefined
39229
+ if (status_request === null || status_request === undefined) {
39230
+ throw new RequiredError('status_request','Required parameter status_request was null or undefined when calling updateConversationWebchatQueueStatus.');
39231
+ }
39232
+ const localVarPath = `/conversation/conversations/queues/{queue_name}/status`
39233
+ .replace(`{${"queue_name"}}`, encodeURIComponent(String(queue_name)));
39234
+ const localVarUrlObj = url.parse(localVarPath, true);
39235
+ const localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
39236
+ const localVarHeaderParameter = {} as any;
39237
+ const localVarQueryParameter = {} as any;
39238
+
39239
+ if(configuration && configuration.apiVersion) {
39240
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
39241
+ }
39242
+
39243
+
39244
+
39245
+ // authentication ultraCartOauth required
39246
+ // oauth required
39247
+ if (configuration && configuration.accessToken) {
39248
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
39249
+ ? configuration.accessToken("ultraCartOauth", ["conversation_write"])
39250
+ : configuration.accessToken;
39251
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
39252
+ }
39253
+
39254
+ // authentication ultraCartSimpleApiKey required
39255
+ if (configuration && configuration.apiKey) {
39256
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
39257
+ ? configuration.apiKey("x-ultracart-simple-key")
39258
+ : configuration.apiKey;
39259
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
39260
+ }
39261
+
39262
+ localVarHeaderParameter['Content-Type'] = 'application/json';
39263
+
39264
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
39265
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
39266
+ delete localVarUrlObj.search;
39267
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
39268
+ const needsSerialization = (<any>"ConversationWebchatQueueStatusUpdateRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
39269
+ localVarRequestOptions.body = needsSerialization ? JSON.stringify(status_request || {}) : (status_request || "");
39270
+
38937
39271
  return {
38938
39272
  url: url.format(localVarUrlObj),
38939
39273
  options: localVarRequestOptions,
@@ -39010,6 +39344,26 @@ export const ConversationApiFp = function(configuration?: Configuration) {
39010
39344
  });
39011
39345
  };
39012
39346
  },
39347
+ /**
39348
+ * Retrieve a conversation webchat queue statuses including agent status and queue entries
39349
+ * @summary Retrieve a conversation webchat queue statuses
39350
+ * @param {*} [options] Override http request option.
39351
+ * @throws {RequiredError}
39352
+ */
39353
+ getConversationWebchatQueueStatuses(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationWebchatQueueStatusesResponse> {
39354
+ const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).getConversationWebchatQueueStatuses(options);
39355
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
39356
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
39357
+
39358
+ if (response.status >= 200 && response.status < 300) {
39359
+ return response.json();
39360
+
39361
+ } else {
39362
+ throw response;
39363
+ }
39364
+ });
39365
+ };
39366
+ },
39013
39367
  /**
39014
39368
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
39015
39369
  * @summary Retrieve a list of conversation summaries newest to oldest
@@ -39095,6 +39449,28 @@ export const ConversationApiFp = function(configuration?: Configuration) {
39095
39449
  });
39096
39450
  };
39097
39451
  },
39452
+ /**
39453
+ * Update status within the queue
39454
+ * @summary Update status within the queue
39455
+ * @param {string} queue_name
39456
+ * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
39457
+ * @param {*} [options] Override http request option.
39458
+ * @throws {RequiredError}
39459
+ */
39460
+ updateConversationWebchatQueueStatus(queue_name: string, status_request: ConversationWebchatQueueStatusUpdateRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response> {
39461
+ const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).updateConversationWebchatQueueStatus(queue_name, status_request, options);
39462
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
39463
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
39464
+
39465
+ if (response.status >= 200 && response.status < 300) {
39466
+ return response;
39467
+
39468
+ } else {
39469
+ throw response;
39470
+ }
39471
+ });
39472
+ };
39473
+ },
39098
39474
  }
39099
39475
  };
39100
39476
 
@@ -39133,6 +39509,15 @@ export const ConversationApiFactory = function (configuration?: Configuration, f
39133
39509
  getConversationMultimediaUploadUrl(extension: string, options?: any) {
39134
39510
  return ConversationApiFp(configuration).getConversationMultimediaUploadUrl(extension, options)(fetch, basePath);
39135
39511
  },
39512
+ /**
39513
+ * Retrieve a conversation webchat queue statuses including agent status and queue entries
39514
+ * @summary Retrieve a conversation webchat queue statuses
39515
+ * @param {*} [options] Override http request option.
39516
+ * @throws {RequiredError}
39517
+ */
39518
+ getConversationWebchatQueueStatuses(options?: any) {
39519
+ return ConversationApiFp(configuration).getConversationWebchatQueueStatuses(options)(fetch, basePath);
39520
+ },
39136
39521
  /**
39137
39522
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
39138
39523
  * @summary Retrieve a list of conversation summaries newest to oldest
@@ -39174,6 +39559,17 @@ export const ConversationApiFactory = function (configuration?: Configuration, f
39174
39559
  startConversation(start_request: ConversationStartRequest, options?: any) {
39175
39560
  return ConversationApiFp(configuration).startConversation(start_request, options)(fetch, basePath);
39176
39561
  },
39562
+ /**
39563
+ * Update status within the queue
39564
+ * @summary Update status within the queue
39565
+ * @param {string} queue_name
39566
+ * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
39567
+ * @param {*} [options] Override http request option.
39568
+ * @throws {RequiredError}
39569
+ */
39570
+ updateConversationWebchatQueueStatus(queue_name: string, status_request: ConversationWebchatQueueStatusUpdateRequest, options?: any) {
39571
+ return ConversationApiFp(configuration).updateConversationWebchatQueueStatus(queue_name, status_request, options)(fetch, basePath);
39572
+ },
39177
39573
  };
39178
39574
  };
39179
39575
 
@@ -39212,6 +39608,15 @@ export interface ConversationApiInterface {
39212
39608
  */
39213
39609
  getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<ConversationMultimediaUploadUrlResponse>;
39214
39610
 
39611
+ /**
39612
+ * Retrieve a conversation webchat queue statuses including agent status and queue entries
39613
+ * @summary Retrieve a conversation webchat queue statuses
39614
+ * @param {*} [options] Override http request option.
39615
+ * @throws {RequiredError}
39616
+ * @memberof ConversationApiInterface
39617
+ */
39618
+ getConversationWebchatQueueStatuses(options?: any): Promise<ConversationWebchatQueueStatusesResponse>;
39619
+
39215
39620
  /**
39216
39621
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
39217
39622
  * @summary Retrieve a list of conversation summaries newest to oldest
@@ -39253,6 +39658,17 @@ export interface ConversationApiInterface {
39253
39658
  */
39254
39659
  startConversation(start_request: ConversationStartRequest, options?: any): Promise<ConversationStartResponse>;
39255
39660
 
39661
+ /**
39662
+ * Update status within the queue
39663
+ * @summary Update status within the queue
39664
+ * @param {string} queue_name
39665
+ * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
39666
+ * @param {*} [options] Override http request option.
39667
+ * @throws {RequiredError}
39668
+ * @memberof ConversationApiInterface
39669
+ */
39670
+ updateConversationWebchatQueueStatus(queue_name: string, status_request: ConversationWebchatQueueStatusUpdateRequest, options?: any): Promise<{}>;
39671
+
39256
39672
  }
39257
39673
 
39258
39674
  /**
@@ -39297,6 +39713,17 @@ export class ConversationApi extends BaseAPI implements ConversationApiInterface
39297
39713
  return ConversationApiFp(this.configuration).getConversationMultimediaUploadUrl(extension, options)(this.fetch, this.basePath);
39298
39714
  }
39299
39715
 
39716
+ /**
39717
+ * Retrieve a conversation webchat queue statuses including agent status and queue entries
39718
+ * @summary Retrieve a conversation webchat queue statuses
39719
+ * @param {*} [options] Override http request option.
39720
+ * @throws {RequiredError}
39721
+ * @memberof ConversationApi
39722
+ */
39723
+ public getConversationWebchatQueueStatuses(options?: any) {
39724
+ return ConversationApiFp(this.configuration).getConversationWebchatQueueStatuses(options)(this.fetch, this.basePath);
39725
+ }
39726
+
39300
39727
  /**
39301
39728
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
39302
39729
  * @summary Retrieve a list of conversation summaries newest to oldest
@@ -39346,6 +39773,19 @@ export class ConversationApi extends BaseAPI implements ConversationApiInterface
39346
39773
  return ConversationApiFp(this.configuration).startConversation(start_request, options)(this.fetch, this.basePath);
39347
39774
  }
39348
39775
 
39776
+ /**
39777
+ * Update status within the queue
39778
+ * @summary Update status within the queue
39779
+ * @param {string} queue_name
39780
+ * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
39781
+ * @param {*} [options] Override http request option.
39782
+ * @throws {RequiredError}
39783
+ * @memberof ConversationApi
39784
+ */
39785
+ public updateConversationWebchatQueueStatus(queue_name: string, status_request: ConversationWebchatQueueStatusUpdateRequest, options?: any) {
39786
+ return ConversationApiFp(this.configuration).updateConversationWebchatQueueStatus(queue_name, status_request, options)(this.fetch, this.basePath);
39787
+ }
39788
+
39349
39789
  }
39350
39790
 
39351
39791
  /**
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}
@@ -6229,6 +6235,18 @@ export interface ConversationAgentAuthResponse {
6229
6235
  * @interface ConversationEventQueuePosition
6230
6236
  */
6231
6237
  export interface ConversationEventQueuePosition {
6238
+ /**
6239
+ * True if agents are logged into the queue
6240
+ * @type {boolean}
6241
+ * @memberof ConversationEventQueuePosition
6242
+ */
6243
+ available?: boolean;
6244
+ /**
6245
+ * Position in the queue. Value will be -1 if they cant be found in the queue.
6246
+ * @type {number}
6247
+ * @memberof ConversationEventQueuePosition
6248
+ */
6249
+ position?: number;
6232
6250
  }
6233
6251
  /**
6234
6252
  *
@@ -6478,6 +6496,12 @@ export interface ConversationStartResponse {
6478
6496
  * @interface ConversationSummary
6479
6497
  */
6480
6498
  export interface ConversationSummary {
6499
+ /**
6500
+ *
6501
+ * @type {boolean}
6502
+ * @memberof ConversationSummary
6503
+ */
6504
+ closed?: boolean;
6481
6505
  /**
6482
6506
  *
6483
6507
  * @type {string}
@@ -6533,6 +6557,197 @@ export interface ConversationSummary {
6533
6557
  */
6534
6558
  unread_messages?: boolean;
6535
6559
  }
6560
+ /**
6561
+ *
6562
+ * @export
6563
+ * @interface ConversationWebchatQueueStatus
6564
+ */
6565
+ export interface ConversationWebchatQueueStatus {
6566
+ /**
6567
+ *
6568
+ * @type {number}
6569
+ * @memberof ConversationWebchatQueueStatus
6570
+ */
6571
+ agent_available_count?: number;
6572
+ /**
6573
+ *
6574
+ * @type {number}
6575
+ * @memberof ConversationWebchatQueueStatus
6576
+ */
6577
+ agent_busy_count?: number;
6578
+ /**
6579
+ *
6580
+ * @type {number}
6581
+ * @memberof ConversationWebchatQueueStatus
6582
+ */
6583
+ agent_count?: number;
6584
+ /**
6585
+ *
6586
+ * @type {number}
6587
+ * @memberof ConversationWebchatQueueStatus
6588
+ */
6589
+ agent_unavailable_count?: number;
6590
+ /**
6591
+ *
6592
+ * @type {Array<ConversationWebchatQueueStatusAgent>}
6593
+ * @memberof ConversationWebchatQueueStatus
6594
+ */
6595
+ agents?: Array<ConversationWebchatQueueStatusAgent>;
6596
+ /**
6597
+ *
6598
+ * @type {number}
6599
+ * @memberof ConversationWebchatQueueStatus
6600
+ */
6601
+ customer_abandon_count?: number;
6602
+ /**
6603
+ *
6604
+ * @type {number}
6605
+ * @memberof ConversationWebchatQueueStatus
6606
+ */
6607
+ customer_active_count?: number;
6608
+ /**
6609
+ *
6610
+ * @type {number}
6611
+ * @memberof ConversationWebchatQueueStatus
6612
+ */
6613
+ customer_waiting_count?: number;
6614
+ /**
6615
+ * Date/time that the oldest person joined the queue
6616
+ * @type {string}
6617
+ * @memberof ConversationWebchatQueueStatus
6618
+ */
6619
+ customer_waiting_join_dts?: string;
6620
+ /**
6621
+ *
6622
+ * @type {Array<ConversationWebchatQueueStatusQueueEntry>}
6623
+ * @memberof ConversationWebchatQueueStatus
6624
+ */
6625
+ queue_entries?: Array<ConversationWebchatQueueStatusQueueEntry>;
6626
+ /**
6627
+ *
6628
+ * @type {string}
6629
+ * @memberof ConversationWebchatQueueStatus
6630
+ */
6631
+ queue_name?: string;
6632
+ }
6633
+ /**
6634
+ *
6635
+ * @export
6636
+ * @interface ConversationWebchatQueueStatusAgent
6637
+ */
6638
+ export interface ConversationWebchatQueueStatusAgent {
6639
+ /**
6640
+ *
6641
+ * @type {string}
6642
+ * @memberof ConversationWebchatQueueStatusAgent
6643
+ */
6644
+ agent_status?: string;
6645
+ /**
6646
+ *
6647
+ * @type {string}
6648
+ * @memberof ConversationWebchatQueueStatusAgent
6649
+ */
6650
+ conversation_participant_arn?: string;
6651
+ /**
6652
+ *
6653
+ * @type {string}
6654
+ * @memberof ConversationWebchatQueueStatusAgent
6655
+ */
6656
+ conversation_participant_name?: string;
6657
+ /**
6658
+ * Date/time that this agent took their last chat
6659
+ * @type {string}
6660
+ * @memberof ConversationWebchatQueueStatusAgent
6661
+ */
6662
+ last_chat_dts?: string;
6663
+ /**
6664
+ *
6665
+ * @type {boolean}
6666
+ * @memberof ConversationWebchatQueueStatusAgent
6667
+ */
6668
+ next_round_robin?: boolean;
6669
+ }
6670
+ /**
6671
+ *
6672
+ * @export
6673
+ * @interface ConversationWebchatQueueStatusQueueEntry
6674
+ */
6675
+ export interface ConversationWebchatQueueStatusQueueEntry {
6676
+ /**
6677
+ *
6678
+ * @type {string}
6679
+ * @memberof ConversationWebchatQueueStatusQueueEntry
6680
+ */
6681
+ conversation_participant_arn?: string;
6682
+ /**
6683
+ *
6684
+ * @type {string}
6685
+ * @memberof ConversationWebchatQueueStatusQueueEntry
6686
+ */
6687
+ conversation_participant_name?: string;
6688
+ /**
6689
+ *
6690
+ * @type {string}
6691
+ * @memberof ConversationWebchatQueueStatusQueueEntry
6692
+ */
6693
+ conversation_webchat_queue_uuid?: string;
6694
+ /**
6695
+ * Date/time the customer joined the queue
6696
+ * @type {string}
6697
+ * @memberof ConversationWebchatQueueStatusQueueEntry
6698
+ */
6699
+ join_dts?: string;
6700
+ }
6701
+ /**
6702
+ *
6703
+ * @export
6704
+ * @interface ConversationWebchatQueueStatusUpdateRequest
6705
+ */
6706
+ export interface ConversationWebchatQueueStatusUpdateRequest {
6707
+ /**
6708
+ *
6709
+ * @type {string}
6710
+ * @memberof ConversationWebchatQueueStatusUpdateRequest
6711
+ */
6712
+ agent_status?: string;
6713
+ }
6714
+ /**
6715
+ *
6716
+ * @export
6717
+ * @interface ConversationWebchatQueueStatusesResponse
6718
+ */
6719
+ export interface ConversationWebchatQueueStatusesResponse {
6720
+ /**
6721
+ *
6722
+ * @type {ModelError}
6723
+ * @memberof ConversationWebchatQueueStatusesResponse
6724
+ */
6725
+ error?: ModelError;
6726
+ /**
6727
+ *
6728
+ * @type {ResponseMetadata}
6729
+ * @memberof ConversationWebchatQueueStatusesResponse
6730
+ */
6731
+ metadata?: ResponseMetadata;
6732
+ /**
6733
+ *
6734
+ * @type {Array<ConversationWebchatQueueStatus>}
6735
+ * @memberof ConversationWebchatQueueStatusesResponse
6736
+ */
6737
+ queue_statuses?: Array<ConversationWebchatQueueStatus>;
6738
+ /**
6739
+ * Indicates if API call was successful
6740
+ * @type {boolean}
6741
+ * @memberof ConversationWebchatQueueStatusesResponse
6742
+ */
6743
+ success?: boolean;
6744
+ /**
6745
+ *
6746
+ * @type {Warning}
6747
+ * @memberof ConversationWebchatQueueStatusesResponse
6748
+ */
6749
+ warning?: Warning;
6750
+ }
6536
6751
  /**
6537
6752
  *
6538
6753
  * @export
@@ -6547,28 +6762,34 @@ export interface ConversationWebsocketMessage {
6547
6762
  conversation_uuid?: string;
6548
6763
  /**
6549
6764
  *
6550
- * @type {Conversation}
6765
+ * @type {ConversationSummary}
6551
6766
  * @memberof ConversationWebsocketMessage
6552
6767
  */
6553
- event_conversation_closed?: Conversation;
6768
+ event_conversation_closed?: ConversationSummary;
6554
6769
  /**
6555
6770
  *
6556
- * @type {Conversation}
6771
+ * @type {ConversationSummary}
6557
6772
  * @memberof ConversationWebsocketMessage
6558
6773
  */
6559
- event_new_conversation?: Conversation;
6774
+ event_new_conversation?: ConversationSummary;
6560
6775
  /**
6561
6776
  *
6562
- * @type {ConversationMessage}
6777
+ * @type {ConversationSummary}
6563
6778
  * @memberof ConversationWebsocketMessage
6564
6779
  */
6565
- event_new_message?: ConversationMessage;
6780
+ event_new_message?: ConversationSummary;
6566
6781
  /**
6567
6782
  *
6568
6783
  * @type {ConversationEventQueuePosition}
6569
6784
  * @memberof ConversationWebsocketMessage
6570
6785
  */
6571
6786
  event_queue_position?: ConversationEventQueuePosition;
6787
+ /**
6788
+ *
6789
+ * @type {ConversationWebchatQueueStatus}
6790
+ * @memberof ConversationWebsocketMessage
6791
+ */
6792
+ event_queue_status_update?: ConversationWebchatQueueStatus;
6572
6793
  /**
6573
6794
  * Type of event
6574
6795
  * @type {string}
@@ -6609,7 +6830,8 @@ export declare namespace ConversationWebsocketMessage {
6609
6830
  ConversationClosed,
6610
6831
  NewConversation,
6611
6832
  NewMessage,
6612
- UpdatedMessage
6833
+ UpdatedMessage,
6834
+ QueueStatusUpdate
6613
6835
  }
6614
6836
  /**
6615
6837
  * @export
@@ -34897,6 +35119,13 @@ export declare const ConversationApiFetchParamCreator: (configuration?: Configur
34897
35119
  * @throws {RequiredError}
34898
35120
  */
34899
35121
  getConversationMultimediaUploadUrl(extension: string, options?: any): FetchArgs;
35122
+ /**
35123
+ * Retrieve a conversation webchat queue statuses including agent status and queue entries
35124
+ * @summary Retrieve a conversation webchat queue statuses
35125
+ * @param {*} [options] Override http request option.
35126
+ * @throws {RequiredError}
35127
+ */
35128
+ getConversationWebchatQueueStatuses(options?: any): FetchArgs;
34900
35129
  /**
34901
35130
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
34902
35131
  * @summary Retrieve a list of conversation summaries newest to oldest
@@ -34930,6 +35159,15 @@ export declare const ConversationApiFetchParamCreator: (configuration?: Configur
34930
35159
  * @throws {RequiredError}
34931
35160
  */
34932
35161
  startConversation(start_request: ConversationStartRequest, options?: any): FetchArgs;
35162
+ /**
35163
+ * Update status within the queue
35164
+ * @summary Update status within the queue
35165
+ * @param {string} queue_name
35166
+ * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
35167
+ * @param {*} [options] Override http request option.
35168
+ * @throws {RequiredError}
35169
+ */
35170
+ updateConversationWebchatQueueStatus(queue_name: string, status_request: ConversationWebchatQueueStatusUpdateRequest, options?: any): FetchArgs;
34933
35171
  };
34934
35172
  /**
34935
35173
  * ConversationApi - functional programming interface
@@ -34959,6 +35197,13 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
34959
35197
  * @throws {RequiredError}
34960
35198
  */
34961
35199
  getConversationMultimediaUploadUrl(extension: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationMultimediaUploadUrlResponse>;
35200
+ /**
35201
+ * Retrieve a conversation webchat queue statuses including agent status and queue entries
35202
+ * @summary Retrieve a conversation webchat queue statuses
35203
+ * @param {*} [options] Override http request option.
35204
+ * @throws {RequiredError}
35205
+ */
35206
+ getConversationWebchatQueueStatuses(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationWebchatQueueStatusesResponse>;
34962
35207
  /**
34963
35208
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
34964
35209
  * @summary Retrieve a list of conversation summaries newest to oldest
@@ -34992,6 +35237,15 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
34992
35237
  * @throws {RequiredError}
34993
35238
  */
34994
35239
  startConversation(start_request: ConversationStartRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationStartResponse>;
35240
+ /**
35241
+ * Update status within the queue
35242
+ * @summary Update status within the queue
35243
+ * @param {string} queue_name
35244
+ * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
35245
+ * @param {*} [options] Override http request option.
35246
+ * @throws {RequiredError}
35247
+ */
35248
+ updateConversationWebchatQueueStatus(queue_name: string, status_request: ConversationWebchatQueueStatusUpdateRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
34995
35249
  };
34996
35250
  /**
34997
35251
  * ConversationApi - factory interface
@@ -35021,6 +35275,13 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
35021
35275
  * @throws {RequiredError}
35022
35276
  */
35023
35277
  getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<ConversationMultimediaUploadUrlResponse>;
35278
+ /**
35279
+ * Retrieve a conversation webchat queue statuses including agent status and queue entries
35280
+ * @summary Retrieve a conversation webchat queue statuses
35281
+ * @param {*} [options] Override http request option.
35282
+ * @throws {RequiredError}
35283
+ */
35284
+ getConversationWebchatQueueStatuses(options?: any): Promise<ConversationWebchatQueueStatusesResponse>;
35024
35285
  /**
35025
35286
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
35026
35287
  * @summary Retrieve a list of conversation summaries newest to oldest
@@ -35054,6 +35315,15 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
35054
35315
  * @throws {RequiredError}
35055
35316
  */
35056
35317
  startConversation(start_request: ConversationStartRequest, options?: any): Promise<ConversationStartResponse>;
35318
+ /**
35319
+ * Update status within the queue
35320
+ * @summary Update status within the queue
35321
+ * @param {string} queue_name
35322
+ * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
35323
+ * @param {*} [options] Override http request option.
35324
+ * @throws {RequiredError}
35325
+ */
35326
+ updateConversationWebchatQueueStatus(queue_name: string, status_request: ConversationWebchatQueueStatusUpdateRequest, options?: any): Promise<Response>;
35057
35327
  };
35058
35328
  /**
35059
35329
  * ConversationApi - interface
@@ -35087,6 +35357,14 @@ export interface ConversationApiInterface {
35087
35357
  * @memberof ConversationApiInterface
35088
35358
  */
35089
35359
  getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<ConversationMultimediaUploadUrlResponse>;
35360
+ /**
35361
+ * Retrieve a conversation webchat queue statuses including agent status and queue entries
35362
+ * @summary Retrieve a conversation webchat queue statuses
35363
+ * @param {*} [options] Override http request option.
35364
+ * @throws {RequiredError}
35365
+ * @memberof ConversationApiInterface
35366
+ */
35367
+ getConversationWebchatQueueStatuses(options?: any): Promise<ConversationWebchatQueueStatusesResponse>;
35090
35368
  /**
35091
35369
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
35092
35370
  * @summary Retrieve a list of conversation summaries newest to oldest
@@ -35124,6 +35402,16 @@ export interface ConversationApiInterface {
35124
35402
  * @memberof ConversationApiInterface
35125
35403
  */
35126
35404
  startConversation(start_request: ConversationStartRequest, options?: any): Promise<ConversationStartResponse>;
35405
+ /**
35406
+ * Update status within the queue
35407
+ * @summary Update status within the queue
35408
+ * @param {string} queue_name
35409
+ * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
35410
+ * @param {*} [options] Override http request option.
35411
+ * @throws {RequiredError}
35412
+ * @memberof ConversationApiInterface
35413
+ */
35414
+ updateConversationWebchatQueueStatus(queue_name: string, status_request: ConversationWebchatQueueStatusUpdateRequest, options?: any): Promise<{}>;
35127
35415
  }
35128
35416
  /**
35129
35417
  * ConversationApi - object-oriented interface
@@ -35158,6 +35446,14 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
35158
35446
  * @memberof ConversationApi
35159
35447
  */
35160
35448
  getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<ConversationMultimediaUploadUrlResponse>;
35449
+ /**
35450
+ * Retrieve a conversation webchat queue statuses including agent status and queue entries
35451
+ * @summary Retrieve a conversation webchat queue statuses
35452
+ * @param {*} [options] Override http request option.
35453
+ * @throws {RequiredError}
35454
+ * @memberof ConversationApi
35455
+ */
35456
+ getConversationWebchatQueueStatuses(options?: any): Promise<ConversationWebchatQueueStatusesResponse>;
35161
35457
  /**
35162
35458
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
35163
35459
  * @summary Retrieve a list of conversation summaries newest to oldest
@@ -35195,6 +35491,16 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
35195
35491
  * @memberof ConversationApi
35196
35492
  */
35197
35493
  startConversation(start_request: ConversationStartRequest, options?: any): Promise<ConversationStartResponse>;
35494
+ /**
35495
+ * Update status within the queue
35496
+ * @summary Update status within the queue
35497
+ * @param {string} queue_name
35498
+ * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
35499
+ * @param {*} [options] Override http request option.
35500
+ * @throws {RequiredError}
35501
+ * @memberof ConversationApi
35502
+ */
35503
+ updateConversationWebchatQueueStatus(queue_name: string, status_request: ConversationWebchatQueueStatusUpdateRequest, options?: any): Promise<Response>;
35198
35504
  }
35199
35505
  /**
35200
35506
  * 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.23",
3
+ "version": "3.10.26",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [