ultracart_rest_api_v2_typescript 3.10.25 → 3.10.26

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.10.25
+## ultracart_rest_api_v2_typescript@3.10.26
 
 This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install ultracart_rest_api_v2_typescript@3.10.25 --save
+npm install ultracart_rest_api_v2_typescript@3.10.26 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.26 | 07/26/2022 | conversations - queue statistics |
 | 3.10.25 | 07/25/2022 | conversation development |
 | 3.10.24 | 07/25/2022 | conversations bug fixes |
 | 3.10.23 | 07/25/2022 | conversations - add a websocket message model |

package/api.ts

@@ -6717,6 +6717,202 @@ export interface ConversationSummary {
     unread_messages?: boolean;
 }
 
+/**
+ * 
+ * @export
+ * @interface ConversationWebchatQueueStatus
+ */
+export interface ConversationWebchatQueueStatus {
+    /**
+     * 
+     * @type {number}
+     * @memberof ConversationWebchatQueueStatus
+     */
+    agent_available_count?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ConversationWebchatQueueStatus
+     */
+    agent_busy_count?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ConversationWebchatQueueStatus
+     */
+    agent_count?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ConversationWebchatQueueStatus
+     */
+    agent_unavailable_count?: number;
+    /**
+     * 
+     * @type {Array<ConversationWebchatQueueStatusAgent>}
+     * @memberof ConversationWebchatQueueStatus
+     */
+    agents?: Array<ConversationWebchatQueueStatusAgent>;
+    /**
+     * 
+     * @type {number}
+     * @memberof ConversationWebchatQueueStatus
+     */
+    customer_abandon_count?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ConversationWebchatQueueStatus
+     */
+    customer_active_count?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ConversationWebchatQueueStatus
+     */
+    customer_waiting_count?: number;
+    /**
+     * Date/time that the oldest person joined the queue
+     * @type {string}
+     * @memberof ConversationWebchatQueueStatus
+     */
+    customer_waiting_join_dts?: string;
+    /**
+     * 
+     * @type {Array<ConversationWebchatQueueStatusQueueEntry>}
+     * @memberof ConversationWebchatQueueStatus
+     */
+    queue_entries?: Array<ConversationWebchatQueueStatusQueueEntry>;
+    /**
+     * 
+     * @type {string}
+     * @memberof ConversationWebchatQueueStatus
+     */
+    queue_name?: string;
+}
+
+/**
+ * 
+ * @export
+ * @interface ConversationWebchatQueueStatusAgent
+ */
+export interface ConversationWebchatQueueStatusAgent {
+    /**
+     * 
+     * @type {string}
+     * @memberof ConversationWebchatQueueStatusAgent
+     */
+    agent_status?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ConversationWebchatQueueStatusAgent
+     */
+    conversation_participant_arn?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ConversationWebchatQueueStatusAgent
+     */
+    conversation_participant_name?: string;
+    /**
+     * Date/time that this agent took their last chat
+     * @type {string}
+     * @memberof ConversationWebchatQueueStatusAgent
+     */
+    last_chat_dts?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ConversationWebchatQueueStatusAgent
+     */
+    next_round_robin?: boolean;
+}
+
+/**
+ * 
+ * @export
+ * @interface ConversationWebchatQueueStatusQueueEntry
+ */
+export interface ConversationWebchatQueueStatusQueueEntry {
+    /**
+     * 
+     * @type {string}
+     * @memberof ConversationWebchatQueueStatusQueueEntry
+     */
+    conversation_participant_arn?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ConversationWebchatQueueStatusQueueEntry
+     */
+    conversation_participant_name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ConversationWebchatQueueStatusQueueEntry
+     */
+    conversation_webchat_queue_uuid?: string;
+    /**
+     * Date/time the customer joined the queue
+     * @type {string}
+     * @memberof ConversationWebchatQueueStatusQueueEntry
+     */
+    join_dts?: string;
+}
+
+/**
+ * 
+ * @export
+ * @interface ConversationWebchatQueueStatusUpdateRequest
+ */
+export interface ConversationWebchatQueueStatusUpdateRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof ConversationWebchatQueueStatusUpdateRequest
+     */
+    agent_status?: string;
+}
+
+/**
+ * 
+ * @export
+ * @interface ConversationWebchatQueueStatusesResponse
+ */
+export interface ConversationWebchatQueueStatusesResponse {
+    /**
+     * 
+     * @type {ModelError}
+     * @memberof ConversationWebchatQueueStatusesResponse
+     */
+    error?: ModelError;
+    /**
+     * 
+     * @type {ResponseMetadata}
+     * @memberof ConversationWebchatQueueStatusesResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * 
+     * @type {Array<ConversationWebchatQueueStatus>}
+     * @memberof ConversationWebchatQueueStatusesResponse
+     */
+    queue_statuses?: Array<ConversationWebchatQueueStatus>;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof ConversationWebchatQueueStatusesResponse
+     */
+    success?: boolean;
+    /**
+     * 
+     * @type {Warning}
+     * @memberof ConversationWebchatQueueStatusesResponse
+     */
+    warning?: Warning;
+}
+
 /**
  * 
  * @export
@@ -6753,6 +6949,12 @@ export interface ConversationWebsocketMessage {
      * @memberof ConversationWebsocketMessage
      */
     event_queue_position?: ConversationEventQueuePosition;
+    /**
+     * 
+     * @type {ConversationWebchatQueueStatus}
+     * @memberof ConversationWebsocketMessage
+     */
+    event_queue_status_update?: ConversationWebchatQueueStatus;
     /**
      * Type of event
      * @type {string}
@@ -6794,7 +6996,8 @@ export namespace ConversationWebsocketMessage {
         ConversationClosed = <any> 'conversation closed',
         NewConversation = <any> 'new conversation',
         NewMessage = <any> 'new message',
-        UpdatedMessage = <any> 'updated message'
+        UpdatedMessage = <any> 'updated message',
+        QueueStatusUpdate = <any> 'queue status update'
     }
     /**
      * @export
@@ -38748,6 +38951,52 @@ export const ConversationApiFetchParamCreator = function (configuration?: Config
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Retrieve a conversation webchat queue statuses including agent status and queue entries 
+         * @summary Retrieve a conversation webchat queue statuses
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getConversationWebchatQueueStatuses(options: any = {}): FetchArgs {
+            const localVarPath = `/conversation/conversations/queues/statuses`;
+            const localVarUrlObj = url.parse(localVarPath, true);
+            const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+    if(configuration && configuration.apiVersion) {
+      localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
+    }
+
+
+
+            // authentication ultraCartOauth required
+            // oauth required
+            if (configuration && configuration.accessToken) {
+				const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+					? configuration.accessToken("ultraCartOauth", ["conversation_read"])
+					: configuration.accessToken;
+                localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
+            }
+
+            // authentication ultraCartSimpleApiKey required
+            if (configuration && configuration.apiKey) {
+                const localVarApiKeyValue = typeof configuration.apiKey === 'function'
+					? configuration.apiKey("x-ultracart-simple-key")
+					: configuration.apiKey;
+                localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
+            }
+
+            localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
+            // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
+            delete localVarUrlObj.search;
+            localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
+
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read. 
          * @summary Retrieve a list of conversation summaries newest to oldest
@@ -38958,6 +39207,67 @@ export const ConversationApiFetchParamCreator = function (configuration?: Config
             const needsSerialization = (<any>"ConversationStartRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
             localVarRequestOptions.body =  needsSerialization ? JSON.stringify(start_request || {}) : (start_request || "");
 
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Update status within the queue 
+         * @summary Update status within the queue
+         * @param {string} queue_name 
+         * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateConversationWebchatQueueStatus(queue_name: string, status_request: ConversationWebchatQueueStatusUpdateRequest, options: any = {}): FetchArgs {
+            // verify required parameter 'queue_name' is not null or undefined
+            if (queue_name === null || queue_name === undefined) {
+                throw new RequiredError('queue_name','Required parameter queue_name was null or undefined when calling updateConversationWebchatQueueStatus.');
+            }
+            // verify required parameter 'status_request' is not null or undefined
+            if (status_request === null || status_request === undefined) {
+                throw new RequiredError('status_request','Required parameter status_request was null or undefined when calling updateConversationWebchatQueueStatus.');
+            }
+            const localVarPath = `/conversation/conversations/queues/{queue_name}/status`
+                .replace(`{${"queue_name"}}`, encodeURIComponent(String(queue_name)));
+            const localVarUrlObj = url.parse(localVarPath, true);
+            const localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+    if(configuration && configuration.apiVersion) {
+      localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
+    }
+
+
+
+            // authentication ultraCartOauth required
+            // oauth required
+            if (configuration && configuration.accessToken) {
+				const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+					? configuration.accessToken("ultraCartOauth", ["conversation_write"])
+					: configuration.accessToken;
+                localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
+            }
+
+            // authentication ultraCartSimpleApiKey required
+            if (configuration && configuration.apiKey) {
+                const localVarApiKeyValue = typeof configuration.apiKey === 'function'
+					? configuration.apiKey("x-ultracart-simple-key")
+					: configuration.apiKey;
+                localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
+            }
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
+            // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
+            delete localVarUrlObj.search;
+            localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
+            const needsSerialization = (<any>"ConversationWebchatQueueStatusUpdateRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
+            localVarRequestOptions.body =  needsSerialization ? JSON.stringify(status_request || {}) : (status_request || "");
+
             return {
                 url: url.format(localVarUrlObj),
                 options: localVarRequestOptions,
@@ -39034,6 +39344,26 @@ export const ConversationApiFp = function(configuration?: Configuration) {
                 });
             };
         },
+        /**
+         * Retrieve a conversation webchat queue statuses including agent status and queue entries 
+         * @summary Retrieve a conversation webchat queue statuses
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getConversationWebchatQueueStatuses(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationWebchatQueueStatusesResponse> {
+            const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).getConversationWebchatQueueStatuses(options);
+            return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
+                return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
+
+                    if (response.status >= 200 && response.status < 300) {
+                      return response.json();
+                      
+                    } else {
+                        throw response;
+                    }
+                });
+            };
+        },
         /**
          * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read. 
          * @summary Retrieve a list of conversation summaries newest to oldest
@@ -39119,6 +39449,28 @@ export const ConversationApiFp = function(configuration?: Configuration) {
                 });
             };
         },
+        /**
+         * Update status within the queue 
+         * @summary Update status within the queue
+         * @param {string} queue_name 
+         * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateConversationWebchatQueueStatus(queue_name: string, status_request: ConversationWebchatQueueStatusUpdateRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response> {
+            const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).updateConversationWebchatQueueStatus(queue_name, status_request, options);
+            return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
+                return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
+
+                    if (response.status >= 200 && response.status < 300) {
+                      return response;
+                      
+                    } else {
+                        throw response;
+                    }
+                });
+            };
+        },
     }
 };
 
@@ -39157,6 +39509,15 @@ export const ConversationApiFactory = function (configuration?: Configuration, f
         getConversationMultimediaUploadUrl(extension: string, options?: any) {
             return ConversationApiFp(configuration).getConversationMultimediaUploadUrl(extension, options)(fetch, basePath);
         },
+        /**
+         * Retrieve a conversation webchat queue statuses including agent status and queue entries 
+         * @summary Retrieve a conversation webchat queue statuses
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getConversationWebchatQueueStatuses(options?: any) {
+            return ConversationApiFp(configuration).getConversationWebchatQueueStatuses(options)(fetch, basePath);
+        },
         /**
          * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read. 
          * @summary Retrieve a list of conversation summaries newest to oldest
@@ -39198,6 +39559,17 @@ export const ConversationApiFactory = function (configuration?: Configuration, f
         startConversation(start_request: ConversationStartRequest, options?: any) {
             return ConversationApiFp(configuration).startConversation(start_request, options)(fetch, basePath);
         },
+        /**
+         * Update status within the queue 
+         * @summary Update status within the queue
+         * @param {string} queue_name 
+         * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateConversationWebchatQueueStatus(queue_name: string, status_request: ConversationWebchatQueueStatusUpdateRequest, options?: any) {
+            return ConversationApiFp(configuration).updateConversationWebchatQueueStatus(queue_name, status_request, options)(fetch, basePath);
+        },
     };
 };
 
@@ -39236,6 +39608,15 @@ export interface ConversationApiInterface {
      */
     getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<ConversationMultimediaUploadUrlResponse>;
 
+    /**
+     * Retrieve a conversation webchat queue statuses including agent status and queue entries 
+     * @summary Retrieve a conversation webchat queue statuses
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getConversationWebchatQueueStatuses(options?: any): Promise<ConversationWebchatQueueStatusesResponse>;
+
     /**
      * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read. 
      * @summary Retrieve a list of conversation summaries newest to oldest
@@ -39277,6 +39658,17 @@ export interface ConversationApiInterface {
      */
     startConversation(start_request: ConversationStartRequest, options?: any): Promise<ConversationStartResponse>;
 
+    /**
+     * Update status within the queue 
+     * @summary Update status within the queue
+     * @param {string} queue_name 
+     * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    updateConversationWebchatQueueStatus(queue_name: string, status_request: ConversationWebchatQueueStatusUpdateRequest, options?: any): Promise<{}>;
+
 }
 
 /**
@@ -39321,6 +39713,17 @@ export class ConversationApi extends BaseAPI implements ConversationApiInterface
         return ConversationApiFp(this.configuration).getConversationMultimediaUploadUrl(extension, options)(this.fetch, this.basePath);
     }
 
+    /**
+     * Retrieve a conversation webchat queue statuses including agent status and queue entries 
+     * @summary Retrieve a conversation webchat queue statuses
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    public getConversationWebchatQueueStatuses(options?: any) {
+        return ConversationApiFp(this.configuration).getConversationWebchatQueueStatuses(options)(this.fetch, this.basePath);
+    }
+
     /**
      * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read. 
      * @summary Retrieve a list of conversation summaries newest to oldest
@@ -39370,6 +39773,19 @@ export class ConversationApi extends BaseAPI implements ConversationApiInterface
         return ConversationApiFp(this.configuration).startConversation(start_request, options)(this.fetch, this.basePath);
     }
 
+    /**
+     * Update status within the queue 
+     * @summary Update status within the queue
+     * @param {string} queue_name 
+     * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    public updateConversationWebchatQueueStatus(queue_name: string, status_request: ConversationWebchatQueueStatusUpdateRequest, options?: any) {
+        return ConversationApiFp(this.configuration).updateConversationWebchatQueueStatus(queue_name, status_request, options)(this.fetch, this.basePath);
+    }
+
 }
 
 /**

package/dist/api.d.ts

@@ -6557,6 +6557,197 @@ export interface ConversationSummary {
      */
     unread_messages?: boolean;
 }
+/**
+ *
+ * @export
+ * @interface ConversationWebchatQueueStatus
+ */
+export interface ConversationWebchatQueueStatus {
+    /**
+     *
+     * @type {number}
+     * @memberof ConversationWebchatQueueStatus
+     */
+    agent_available_count?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ConversationWebchatQueueStatus
+     */
+    agent_busy_count?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ConversationWebchatQueueStatus
+     */
+    agent_count?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ConversationWebchatQueueStatus
+     */
+    agent_unavailable_count?: number;
+    /**
+     *
+     * @type {Array<ConversationWebchatQueueStatusAgent>}
+     * @memberof ConversationWebchatQueueStatus
+     */
+    agents?: Array<ConversationWebchatQueueStatusAgent>;
+    /**
+     *
+     * @type {number}
+     * @memberof ConversationWebchatQueueStatus
+     */
+    customer_abandon_count?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ConversationWebchatQueueStatus
+     */
+    customer_active_count?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ConversationWebchatQueueStatus
+     */
+    customer_waiting_count?: number;
+    /**
+     * Date/time that the oldest person joined the queue
+     * @type {string}
+     * @memberof ConversationWebchatQueueStatus
+     */
+    customer_waiting_join_dts?: string;
+    /**
+     *
+     * @type {Array<ConversationWebchatQueueStatusQueueEntry>}
+     * @memberof ConversationWebchatQueueStatus
+     */
+    queue_entries?: Array<ConversationWebchatQueueStatusQueueEntry>;
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationWebchatQueueStatus
+     */
+    queue_name?: string;
+}
+/**
+ *
+ * @export
+ * @interface ConversationWebchatQueueStatusAgent
+ */
+export interface ConversationWebchatQueueStatusAgent {
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationWebchatQueueStatusAgent
+     */
+    agent_status?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationWebchatQueueStatusAgent
+     */
+    conversation_participant_arn?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationWebchatQueueStatusAgent
+     */
+    conversation_participant_name?: string;
+    /**
+     * Date/time that this agent took their last chat
+     * @type {string}
+     * @memberof ConversationWebchatQueueStatusAgent
+     */
+    last_chat_dts?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ConversationWebchatQueueStatusAgent
+     */
+    next_round_robin?: boolean;
+}
+/**
+ *
+ * @export
+ * @interface ConversationWebchatQueueStatusQueueEntry
+ */
+export interface ConversationWebchatQueueStatusQueueEntry {
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationWebchatQueueStatusQueueEntry
+     */
+    conversation_participant_arn?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationWebchatQueueStatusQueueEntry
+     */
+    conversation_participant_name?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationWebchatQueueStatusQueueEntry
+     */
+    conversation_webchat_queue_uuid?: string;
+    /**
+     * Date/time the customer joined the queue
+     * @type {string}
+     * @memberof ConversationWebchatQueueStatusQueueEntry
+     */
+    join_dts?: string;
+}
+/**
+ *
+ * @export
+ * @interface ConversationWebchatQueueStatusUpdateRequest
+ */
+export interface ConversationWebchatQueueStatusUpdateRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationWebchatQueueStatusUpdateRequest
+     */
+    agent_status?: string;
+}
+/**
+ *
+ * @export
+ * @interface ConversationWebchatQueueStatusesResponse
+ */
+export interface ConversationWebchatQueueStatusesResponse {
+    /**
+     *
+     * @type {ModelError}
+     * @memberof ConversationWebchatQueueStatusesResponse
+     */
+    error?: ModelError;
+    /**
+     *
+     * @type {ResponseMetadata}
+     * @memberof ConversationWebchatQueueStatusesResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     *
+     * @type {Array<ConversationWebchatQueueStatus>}
+     * @memberof ConversationWebchatQueueStatusesResponse
+     */
+    queue_statuses?: Array<ConversationWebchatQueueStatus>;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof ConversationWebchatQueueStatusesResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {Warning}
+     * @memberof ConversationWebchatQueueStatusesResponse
+     */
+    warning?: Warning;
+}
 /**
  *
  * @export
@@ -6593,6 +6784,12 @@ export interface ConversationWebsocketMessage {
      * @memberof ConversationWebsocketMessage
      */
     event_queue_position?: ConversationEventQueuePosition;
+    /**
+     *
+     * @type {ConversationWebchatQueueStatus}
+     * @memberof ConversationWebsocketMessage
+     */
+    event_queue_status_update?: ConversationWebchatQueueStatus;
     /**
      * Type of event
      * @type {string}
@@ -6633,7 +6830,8 @@ export declare namespace ConversationWebsocketMessage {
         ConversationClosed,
         NewConversation,
         NewMessage,
-        UpdatedMessage
+        UpdatedMessage,
+        QueueStatusUpdate
     }
     /**
      * @export
@@ -34921,6 +35119,13 @@ export declare const ConversationApiFetchParamCreator: (configuration?: Configur
      * @throws {RequiredError}
      */
     getConversationMultimediaUploadUrl(extension: string, options?: any): FetchArgs;
+    /**
+     * Retrieve a conversation webchat queue statuses including agent status and queue entries
+     * @summary Retrieve a conversation webchat queue statuses
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getConversationWebchatQueueStatuses(options?: any): FetchArgs;
     /**
      * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
      * @summary Retrieve a list of conversation summaries newest to oldest
@@ -34954,6 +35159,15 @@ export declare const ConversationApiFetchParamCreator: (configuration?: Configur
      * @throws {RequiredError}
      */
     startConversation(start_request: ConversationStartRequest, options?: any): FetchArgs;
+    /**
+     * Update status within the queue
+     * @summary Update status within the queue
+     * @param {string} queue_name
+     * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateConversationWebchatQueueStatus(queue_name: string, status_request: ConversationWebchatQueueStatusUpdateRequest, options?: any): FetchArgs;
 };
 /**
  * ConversationApi - functional programming interface
@@ -34983,6 +35197,13 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getConversationMultimediaUploadUrl(extension: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationMultimediaUploadUrlResponse>;
+    /**
+     * Retrieve a conversation webchat queue statuses including agent status and queue entries
+     * @summary Retrieve a conversation webchat queue statuses
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getConversationWebchatQueueStatuses(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationWebchatQueueStatusesResponse>;
     /**
      * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
      * @summary Retrieve a list of conversation summaries newest to oldest
@@ -35016,6 +35237,15 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     startConversation(start_request: ConversationStartRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationStartResponse>;
+    /**
+     * Update status within the queue
+     * @summary Update status within the queue
+     * @param {string} queue_name
+     * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateConversationWebchatQueueStatus(queue_name: string, status_request: ConversationWebchatQueueStatusUpdateRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
 };
 /**
  * ConversationApi - factory interface
@@ -35045,6 +35275,13 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
      * @throws {RequiredError}
      */
     getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<ConversationMultimediaUploadUrlResponse>;
+    /**
+     * Retrieve a conversation webchat queue statuses including agent status and queue entries
+     * @summary Retrieve a conversation webchat queue statuses
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getConversationWebchatQueueStatuses(options?: any): Promise<ConversationWebchatQueueStatusesResponse>;
     /**
      * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
      * @summary Retrieve a list of conversation summaries newest to oldest
@@ -35078,6 +35315,15 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
      * @throws {RequiredError}
      */
     startConversation(start_request: ConversationStartRequest, options?: any): Promise<ConversationStartResponse>;
+    /**
+     * Update status within the queue
+     * @summary Update status within the queue
+     * @param {string} queue_name
+     * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateConversationWebchatQueueStatus(queue_name: string, status_request: ConversationWebchatQueueStatusUpdateRequest, options?: any): Promise<Response>;
 };
 /**
  * ConversationApi - interface
@@ -35111,6 +35357,14 @@ export interface ConversationApiInterface {
      * @memberof ConversationApiInterface
      */
     getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<ConversationMultimediaUploadUrlResponse>;
+    /**
+     * Retrieve a conversation webchat queue statuses including agent status and queue entries
+     * @summary Retrieve a conversation webchat queue statuses
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getConversationWebchatQueueStatuses(options?: any): Promise<ConversationWebchatQueueStatusesResponse>;
     /**
      * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
      * @summary Retrieve a list of conversation summaries newest to oldest
@@ -35148,6 +35402,16 @@ export interface ConversationApiInterface {
      * @memberof ConversationApiInterface
      */
     startConversation(start_request: ConversationStartRequest, options?: any): Promise<ConversationStartResponse>;
+    /**
+     * Update status within the queue
+     * @summary Update status within the queue
+     * @param {string} queue_name
+     * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    updateConversationWebchatQueueStatus(queue_name: string, status_request: ConversationWebchatQueueStatusUpdateRequest, options?: any): Promise<{}>;
 }
 /**
  * ConversationApi - object-oriented interface
@@ -35182,6 +35446,14 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
      * @memberof ConversationApi
      */
     getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<ConversationMultimediaUploadUrlResponse>;
+    /**
+     * Retrieve a conversation webchat queue statuses including agent status and queue entries
+     * @summary Retrieve a conversation webchat queue statuses
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    getConversationWebchatQueueStatuses(options?: any): Promise<ConversationWebchatQueueStatusesResponse>;
     /**
      * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
      * @summary Retrieve a list of conversation summaries newest to oldest
@@ -35219,6 +35491,16 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
      * @memberof ConversationApi
      */
     startConversation(start_request: ConversationStartRequest, options?: any): Promise<ConversationStartResponse>;
+    /**
+     * Update status within the queue
+     * @summary Update status within the queue
+     * @param {string} queue_name
+     * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    updateConversationWebchatQueueStatus(queue_name: string, status_request: ConversationWebchatQueueStatusUpdateRequest, options?: any): Promise<Response>;
 }
 /**
  * CouponApi - fetch parameter creator

package/dist/api.js

@@ -377,6 +377,7 @@ var ConversationWebsocketMessage;
         EventTypeEnum[EventTypeEnum["NewConversation"] = 'new conversation'] = "NewConversation";
         EventTypeEnum[EventTypeEnum["NewMessage"] = 'new message'] = "NewMessage";
         EventTypeEnum[EventTypeEnum["UpdatedMessage"] = 'updated message'] = "UpdatedMessage";
+        EventTypeEnum[EventTypeEnum["QueueStatusUpdate"] = 'queue status update'] = "QueueStatusUpdate";
     })(EventTypeEnum = ConversationWebsocketMessage.EventTypeEnum || (ConversationWebsocketMessage.EventTypeEnum = {}));
     /**
      * @export
@@ -5458,6 +5459,46 @@ var ConversationApiFetchParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Retrieve a conversation webchat queue statuses including agent status and queue entries
+         * @summary Retrieve a conversation webchat queue statuses
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getConversationWebchatQueueStatuses: function (options) {
+            if (options === void 0) { options = {}; }
+            var localVarPath = "/conversation/conversations/queues/statuses";
+            var localVarUrlObj = url.parse(localVarPath, true);
+            var localVarRequestOptions = Object.assign({ method: 'GET' }, options);
+            var localVarHeaderParameter = {};
+            var localVarQueryParameter = {};
+            if (configuration && configuration.apiVersion) {
+                localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
+            }
+            // authentication ultraCartOauth required
+            // oauth required
+            if (configuration && configuration.accessToken) {
+                var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+                    ? configuration.accessToken("ultraCartOauth", ["conversation_read"])
+                    : configuration.accessToken;
+                localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
+            }
+            // authentication ultraCartSimpleApiKey required
+            if (configuration && configuration.apiKey) {
+                var localVarApiKeyValue = typeof configuration.apiKey === 'function'
+                    ? configuration.apiKey("x-ultracart-simple-key")
+                    : configuration.apiKey;
+                localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
+            }
+            localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
+            // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
+            delete localVarUrlObj.search;
+            localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
          * @summary Retrieve a list of conversation summaries newest to oldest
@@ -5646,6 +5687,60 @@ var ConversationApiFetchParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Update status within the queue
+         * @summary Update status within the queue
+         * @param {string} queue_name
+         * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateConversationWebchatQueueStatus: function (queue_name, status_request, options) {
+            if (options === void 0) { options = {}; }
+            // verify required parameter 'queue_name' is not null or undefined
+            if (queue_name === null || queue_name === undefined) {
+                throw new RequiredError('queue_name', 'Required parameter queue_name was null or undefined when calling updateConversationWebchatQueueStatus.');
+            }
+            // verify required parameter 'status_request' is not null or undefined
+            if (status_request === null || status_request === undefined) {
+                throw new RequiredError('status_request', 'Required parameter status_request was null or undefined when calling updateConversationWebchatQueueStatus.');
+            }
+            var localVarPath = "/conversation/conversations/queues/{queue_name}/status"
+                .replace("{".concat("queue_name", "}"), encodeURIComponent(String(queue_name)));
+            var localVarUrlObj = url.parse(localVarPath, true);
+            var localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
+            var localVarHeaderParameter = {};
+            var localVarQueryParameter = {};
+            if (configuration && configuration.apiVersion) {
+                localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
+            }
+            // authentication ultraCartOauth required
+            // oauth required
+            if (configuration && configuration.accessToken) {
+                var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+                    ? configuration.accessToken("ultraCartOauth", ["conversation_write"])
+                    : configuration.accessToken;
+                localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
+            }
+            // authentication ultraCartSimpleApiKey required
+            if (configuration && configuration.apiKey) {
+                var localVarApiKeyValue = typeof configuration.apiKey === 'function'
+                    ? configuration.apiKey("x-ultracart-simple-key")
+                    : configuration.apiKey;
+                localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
+            }
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
+            // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
+            delete localVarUrlObj.search;
+            localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
+            var needsSerialization = ("ConversationWebchatQueueStatusUpdateRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
+            localVarRequestOptions.body = needsSerialization ? JSON.stringify(status_request || {}) : (status_request || "");
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
     };
 };
 exports.ConversationApiFetchParamCreator = ConversationApiFetchParamCreator;
@@ -5720,6 +5815,27 @@ var ConversationApiFp = function (configuration) {
                 });
             };
         },
+        /**
+         * Retrieve a conversation webchat queue statuses including agent status and queue entries
+         * @summary Retrieve a conversation webchat queue statuses
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getConversationWebchatQueueStatuses: function (options) {
+            var localVarFetchArgs = (0, exports.ConversationApiFetchParamCreator)(configuration).getConversationWebchatQueueStatuses(options);
+            return function (fetch, basePath) {
+                if (fetch === void 0) { fetch = portableFetch; }
+                if (basePath === void 0) { basePath = BASE_PATH; }
+                return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
+                    if (response.status >= 200 && response.status < 300) {
+                        return response.json();
+                    }
+                    else {
+                        throw response;
+                    }
+                });
+            };
+        },
         /**
          * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
          * @summary Retrieve a list of conversation summaries newest to oldest
@@ -5809,6 +5925,29 @@ var ConversationApiFp = function (configuration) {
                 });
             };
         },
+        /**
+         * Update status within the queue
+         * @summary Update status within the queue
+         * @param {string} queue_name
+         * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateConversationWebchatQueueStatus: function (queue_name, status_request, options) {
+            var localVarFetchArgs = (0, exports.ConversationApiFetchParamCreator)(configuration).updateConversationWebchatQueueStatus(queue_name, status_request, options);
+            return function (fetch, basePath) {
+                if (fetch === void 0) { fetch = portableFetch; }
+                if (basePath === void 0) { basePath = BASE_PATH; }
+                return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
+                    if (response.status >= 200 && response.status < 300) {
+                        return response;
+                    }
+                    else {
+                        throw response;
+                    }
+                });
+            };
+        },
     };
 };
 exports.ConversationApiFp = ConversationApiFp;
@@ -5847,6 +5986,15 @@ var ConversationApiFactory = function (configuration, fetch, basePath) {
         getConversationMultimediaUploadUrl: function (extension, options) {
             return (0, exports.ConversationApiFp)(configuration).getConversationMultimediaUploadUrl(extension, options)(fetch, basePath);
         },
+        /**
+         * Retrieve a conversation webchat queue statuses including agent status and queue entries
+         * @summary Retrieve a conversation webchat queue statuses
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getConversationWebchatQueueStatuses: function (options) {
+            return (0, exports.ConversationApiFp)(configuration).getConversationWebchatQueueStatuses(options)(fetch, basePath);
+        },
         /**
          * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
          * @summary Retrieve a list of conversation summaries newest to oldest
@@ -5888,6 +6036,17 @@ var ConversationApiFactory = function (configuration, fetch, basePath) {
         startConversation: function (start_request, options) {
             return (0, exports.ConversationApiFp)(configuration).startConversation(start_request, options)(fetch, basePath);
         },
+        /**
+         * Update status within the queue
+         * @summary Update status within the queue
+         * @param {string} queue_name
+         * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateConversationWebchatQueueStatus: function (queue_name, status_request, options) {
+            return (0, exports.ConversationApiFp)(configuration).updateConversationWebchatQueueStatus(queue_name, status_request, options)(fetch, basePath);
+        },
     };
 };
 exports.ConversationApiFactory = ConversationApiFactory;
@@ -5934,6 +6093,16 @@ var ConversationApi = /** @class */ (function (_super) {
     ConversationApi.prototype.getConversationMultimediaUploadUrl = function (extension, options) {
         return (0, exports.ConversationApiFp)(this.configuration).getConversationMultimediaUploadUrl(extension, options)(this.fetch, this.basePath);
     };
+    /**
+     * Retrieve a conversation webchat queue statuses including agent status and queue entries
+     * @summary Retrieve a conversation webchat queue statuses
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    ConversationApi.prototype.getConversationWebchatQueueStatuses = function (options) {
+        return (0, exports.ConversationApiFp)(this.configuration).getConversationWebchatQueueStatuses(options)(this.fetch, this.basePath);
+    };
     /**
      * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
      * @summary Retrieve a list of conversation summaries newest to oldest
@@ -5979,6 +6148,18 @@ var ConversationApi = /** @class */ (function (_super) {
     ConversationApi.prototype.startConversation = function (start_request, options) {
         return (0, exports.ConversationApiFp)(this.configuration).startConversation(start_request, options)(this.fetch, this.basePath);
     };
+    /**
+     * Update status within the queue
+     * @summary Update status within the queue
+     * @param {string} queue_name
+     * @param {ConversationWebchatQueueStatusUpdateRequest} status_request Status request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    ConversationApi.prototype.updateConversationWebchatQueueStatus = function (queue_name, status_request, options) {
+        return (0, exports.ConversationApiFp)(this.configuration).updateConversationWebchatQueueStatus(queue_name, status_request, options)(this.fetch, this.basePath);
+    };
     return ConversationApi;
 }(BaseAPI));
 exports.ConversationApi = ConversationApi;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "3.10.25",
+  "version": "3.10.26",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "keywords": [