ultracart_rest_api_v2_typescript 3.10.111 → 3.10.113

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.10.111
+## ultracart_rest_api_v2_typescript@3.10.113
 
 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.111 --save
+npm install ultracart_rest_api_v2_typescript@3.10.113 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.113 | 02/06/2023 | convo - add conversation_arn to ConversationWebsocketMessage |
+| 3.10.112 | 02/01/2023 | convo - agent profile get/update methods |
 | 3.10.111 | 01/27/2023 | convo - added event_engage_customer property to message |
 | 3.10.110 | 01/27/2023 | conversations - getLocationsForEngagement method |
 | 3.10.109 | 01/26/2023 | typo in ConversationWebsocketMessage |

package/api.ts

@@ -6754,6 +6754,110 @@ export interface ConversationAgentAuthResponse {
     warning?: Warning;
 }
 
+/**
+ * 
+ * @export
+ * @interface ConversationAgentProfile
+ */
+export interface ConversationAgentProfile {
+    /**
+     * The number of engagement chats that can be pushed on them at any given time.
+     * @type {number}
+     * @memberof ConversationAgentProfile
+     */
+    chat_limit?: number;
+    /**
+     * The default language the agent is chatting in
+     * @type {string}
+     * @memberof ConversationAgentProfile
+     */
+    default_language_iso_code?: string;
+    /**
+     * Default status when the agent loads conversations app.
+     * @type {string}
+     * @memberof ConversationAgentProfile
+     */
+    default_status?: ConversationAgentProfile.DefaultStatusEnum;
+    /**
+     * An alternate name that the agent wants to use in chat.
+     * @type {string}
+     * @memberof ConversationAgentProfile
+     */
+    display_name?: string;
+    /**
+     * Their actual user name for profile settings display as placeholder test
+     * @type {string}
+     * @memberof ConversationAgentProfile
+     */
+    name?: string;
+    /**
+     * An upload key used to update the profile image.
+     * @type {string}
+     * @memberof ConversationAgentProfile
+     */
+    profile_image_upload_key?: string;
+    /**
+     * Their current profile image URL
+     * @type {string}
+     * @memberof ConversationAgentProfile
+     */
+    profile_image_url?: string;
+}
+
+/**
+ * @export
+ * @namespace ConversationAgentProfile
+ */
+export namespace ConversationAgentProfile {
+    /**
+     * @export
+     * @enum {string}
+     */
+    export enum DefaultStatusEnum {
+        Available = <any> 'available',
+        Busy = <any> 'busy',
+        Unavailable = <any> 'unavailable'
+    }
+}
+
+/**
+ * 
+ * @export
+ * @interface ConversationAgentProfileResponse
+ */
+export interface ConversationAgentProfileResponse {
+    /**
+     * 
+     * @type {ConversationAgentProfile}
+     * @memberof ConversationAgentProfileResponse
+     */
+    agent_profile?: ConversationAgentProfile;
+    /**
+     * 
+     * @type {ModelError}
+     * @memberof ConversationAgentProfileResponse
+     */
+    error?: ModelError;
+    /**
+     * 
+     * @type {ResponseMetadata}
+     * @memberof ConversationAgentProfileResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof ConversationAgentProfileResponse
+     */
+    success?: boolean;
+    /**
+     * 
+     * @type {Warning}
+     * @memberof ConversationAgentProfileResponse
+     */
+    warning?: Warning;
+}
+
 /**
  * 
  * @export
@@ -8895,6 +8999,12 @@ export interface ConversationWebchatQueueStatusesResponse {
  * @interface ConversationWebsocketMessage
  */
 export interface ConversationWebsocketMessage {
+    /**
+     * Conversation ARN
+     * @type {string}
+     * @memberof ConversationWebsocketMessage
+     */
+    conversation_arn?: string;
     /**
      * Conversation UUID if the websocket message is tied to a specific conversation
      * @type {string}
@@ -44153,6 +44263,52 @@ export const ConversationApiFetchParamCreator = function (configuration?: Config
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Retrieve the agents profile 
+         * @summary Get agent profile
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getAgentProfile(options: any = {}): FetchArgs {
+            const localVarPath = `/conversation/agent/profile`;
+            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 JWT to authorize an agent to make a websocket connection. 
          * @summary Get agent websocket authorization
@@ -45409,6 +45565,61 @@ export const ConversationApiFetchParamCreator = function (configuration?: Config
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Update agent profile 
+         * @summary Update agent profile
+         * @param {ConversationAgentProfile} profile_request Profile request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateAgentProfile(profile_request: ConversationAgentProfile, options: any = {}): FetchArgs {
+            // verify required parameter 'profile_request' is not null or undefined
+            if (profile_request === null || profile_request === undefined) {
+                throw new RequiredError('profile_request','Required parameter profile_request was null or undefined when calling updateAgentProfile.');
+            }
+            const localVarPath = `/conversation/agent/profile`;
+            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>"ConversationAgentProfile" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
+            localVarRequestOptions.body =  needsSerialization ? JSON.stringify(profile_request || {}) : (profile_request || "");
+
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Update a canned message 
          * @summary Update a canned message
@@ -45745,6 +45956,26 @@ export const ConversationApiFp = function(configuration?: Configuration) {
                 });
             };
         },
+        /**
+         * Retrieve the agents profile 
+         * @summary Get agent profile
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getAgentProfile(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationAgentProfileResponse> {
+            const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).getAgentProfile(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 JWT to authorize an agent to make a websocket connection. 
          * @summary Get agent websocket authorization
@@ -46248,6 +46479,27 @@ export const ConversationApiFp = function(configuration?: Configuration) {
                 });
             };
         },
+        /**
+         * Update agent profile 
+         * @summary Update agent profile
+         * @param {ConversationAgentProfile} profile_request Profile request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateAgentProfile(profile_request: ConversationAgentProfile, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationAgentProfileResponse> {
+            const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).updateAgentProfile(profile_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.json();
+                      
+                    } else {
+                        throw response;
+                    }
+                });
+            };
+        },
         /**
          * Update a canned message 
          * @summary Update a canned message
@@ -46384,6 +46636,15 @@ export const ConversationApiFactory = function (configuration?: Configuration, f
         getAgentKeepAlive(options?: any) {
             return ConversationApiFp(configuration).getAgentKeepAlive(options)(fetch, basePath);
         },
+        /**
+         * Retrieve the agents profile 
+         * @summary Get agent profile
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getAgentProfile(options?: any) {
+            return ConversationApiFp(configuration).getAgentProfile(options)(fetch, basePath);
+        },
         /**
          * Retrieve a JWT to authorize an agent to make a websocket connection. 
          * @summary Get agent websocket authorization
@@ -46623,6 +46884,16 @@ export const ConversationApiFactory = function (configuration?: Configuration, f
         startConversation(start_request: ConversationStartRequest, options?: any) {
             return ConversationApiFp(configuration).startConversation(start_request, options)(fetch, basePath);
         },
+        /**
+         * Update agent profile 
+         * @summary Update agent profile
+         * @param {ConversationAgentProfile} profile_request Profile request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateAgentProfile(profile_request: ConversationAgentProfile, options?: any) {
+            return ConversationApiFp(configuration).updateAgentProfile(profile_request, options)(fetch, basePath);
+        },
         /**
          * Update a canned message 
          * @summary Update a canned message
@@ -46715,6 +46986,15 @@ export interface ConversationApiInterface {
      */
     getAgentKeepAlive(options?: any): Promise<{}>;
 
+    /**
+     * Retrieve the agents profile 
+     * @summary Get agent profile
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getAgentProfile(options?: any): Promise<ConversationAgentProfileResponse>;
+
     /**
      * Retrieve a JWT to authorize an agent to make a websocket connection. 
      * @summary Get agent websocket authorization
@@ -46954,6 +47234,16 @@ export interface ConversationApiInterface {
      */
     startConversation(start_request: ConversationStartRequest, options?: any): Promise<ConversationStartResponse>;
 
+    /**
+     * Update agent profile 
+     * @summary Update agent profile
+     * @param {ConversationAgentProfile} profile_request Profile request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    updateAgentProfile(profile_request: ConversationAgentProfile, options?: any): Promise<ConversationAgentProfileResponse>;
+
     /**
      * Update a canned message 
      * @summary Update a canned message
@@ -47054,6 +47344,17 @@ export class ConversationApi extends BaseAPI implements ConversationApiInterface
         return ConversationApiFp(this.configuration).getAgentKeepAlive(options)(this.fetch, this.basePath);
     }
 
+    /**
+     * Retrieve the agents profile 
+     * @summary Get agent profile
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    public getAgentProfile(options?: any) {
+        return ConversationApiFp(this.configuration).getAgentProfile(options)(this.fetch, this.basePath);
+    }
+
     /**
      * Retrieve a JWT to authorize an agent to make a websocket connection. 
      * @summary Get agent websocket authorization
@@ -47341,6 +47642,18 @@ export class ConversationApi extends BaseAPI implements ConversationApiInterface
         return ConversationApiFp(this.configuration).startConversation(start_request, options)(this.fetch, this.basePath);
     }
 
+    /**
+     * Update agent profile 
+     * @summary Update agent profile
+     * @param {ConversationAgentProfile} profile_request Profile request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    public updateAgentProfile(profile_request: ConversationAgentProfile, options?: any) {
+        return ConversationApiFp(this.configuration).updateAgentProfile(profile_request, options)(this.fetch, this.basePath);
+    }
+
     /**
      * Update a canned message 
      * @summary Update a canned message

package/dist/api.d.ts

@@ -6597,6 +6597,107 @@ export interface ConversationAgentAuthResponse {
      */
     warning?: Warning;
 }
+/**
+ *
+ * @export
+ * @interface ConversationAgentProfile
+ */
+export interface ConversationAgentProfile {
+    /**
+     * The number of engagement chats that can be pushed on them at any given time.
+     * @type {number}
+     * @memberof ConversationAgentProfile
+     */
+    chat_limit?: number;
+    /**
+     * The default language the agent is chatting in
+     * @type {string}
+     * @memberof ConversationAgentProfile
+     */
+    default_language_iso_code?: string;
+    /**
+     * Default status when the agent loads conversations app.
+     * @type {string}
+     * @memberof ConversationAgentProfile
+     */
+    default_status?: ConversationAgentProfile.DefaultStatusEnum;
+    /**
+     * An alternate name that the agent wants to use in chat.
+     * @type {string}
+     * @memberof ConversationAgentProfile
+     */
+    display_name?: string;
+    /**
+     * Their actual user name for profile settings display as placeholder test
+     * @type {string}
+     * @memberof ConversationAgentProfile
+     */
+    name?: string;
+    /**
+     * An upload key used to update the profile image.
+     * @type {string}
+     * @memberof ConversationAgentProfile
+     */
+    profile_image_upload_key?: string;
+    /**
+     * Their current profile image URL
+     * @type {string}
+     * @memberof ConversationAgentProfile
+     */
+    profile_image_url?: string;
+}
+/**
+ * @export
+ * @namespace ConversationAgentProfile
+ */
+export declare namespace ConversationAgentProfile {
+    /**
+     * @export
+     * @enum {string}
+     */
+    enum DefaultStatusEnum {
+        Available,
+        Busy,
+        Unavailable
+    }
+}
+/**
+ *
+ * @export
+ * @interface ConversationAgentProfileResponse
+ */
+export interface ConversationAgentProfileResponse {
+    /**
+     *
+     * @type {ConversationAgentProfile}
+     * @memberof ConversationAgentProfileResponse
+     */
+    agent_profile?: ConversationAgentProfile;
+    /**
+     *
+     * @type {ModelError}
+     * @memberof ConversationAgentProfileResponse
+     */
+    error?: ModelError;
+    /**
+     *
+     * @type {ResponseMetadata}
+     * @memberof ConversationAgentProfileResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof ConversationAgentProfileResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {Warning}
+     * @memberof ConversationAgentProfileResponse
+     */
+    warning?: Warning;
+}
 /**
  *
  * @export
@@ -8678,6 +8779,12 @@ export interface ConversationWebchatQueueStatusesResponse {
  * @interface ConversationWebsocketMessage
  */
 export interface ConversationWebsocketMessage {
+    /**
+     * Conversation ARN
+     * @type {string}
+     * @memberof ConversationWebsocketMessage
+     */
+    conversation_arn?: string;
     /**
      * Conversation UUID if the websocket message is tied to a specific conversation
      * @type {string}
@@ -39782,6 +39889,13 @@ export declare const ConversationApiFetchParamCreator: (configuration?: Configur
      * @throws {RequiredError}
      */
     getAgentKeepAlive(options?: any): FetchArgs;
+    /**
+     * Retrieve the agents profile
+     * @summary Get agent profile
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAgentProfile(options?: any): FetchArgs;
     /**
      * Retrieve a JWT to authorize an agent to make a websocket connection.
      * @summary Get agent websocket authorization
@@ -39973,6 +40087,14 @@ export declare const ConversationApiFetchParamCreator: (configuration?: Configur
      * @throws {RequiredError}
      */
     startConversation(start_request: ConversationStartRequest, options?: any): FetchArgs;
+    /**
+     * Update agent profile
+     * @summary Update agent profile
+     * @param {ConversationAgentProfile} profile_request Profile request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateAgentProfile(profile_request: ConversationAgentProfile, options?: any): FetchArgs;
     /**
      * Update a canned message
      * @summary Update a canned message
@@ -40046,6 +40168,13 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getAgentKeepAlive(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
+    /**
+     * Retrieve the agents profile
+     * @summary Get agent profile
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAgentProfile(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationAgentProfileResponse>;
     /**
      * Retrieve a JWT to authorize an agent to make a websocket connection.
      * @summary Get agent websocket authorization
@@ -40237,6 +40366,14 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     startConversation(start_request: ConversationStartRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationStartResponse>;
+    /**
+     * Update agent profile
+     * @summary Update agent profile
+     * @param {ConversationAgentProfile} profile_request Profile request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateAgentProfile(profile_request: ConversationAgentProfile, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationAgentProfileResponse>;
     /**
      * Update a canned message
      * @summary Update a canned message
@@ -40310,6 +40447,13 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
      * @throws {RequiredError}
      */
     getAgentKeepAlive(options?: any): Promise<Response>;
+    /**
+     * Retrieve the agents profile
+     * @summary Get agent profile
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAgentProfile(options?: any): Promise<ConversationAgentProfileResponse>;
     /**
      * Retrieve a JWT to authorize an agent to make a websocket connection.
      * @summary Get agent websocket authorization
@@ -40501,6 +40645,14 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
      * @throws {RequiredError}
      */
     startConversation(start_request: ConversationStartRequest, options?: any): Promise<ConversationStartResponse>;
+    /**
+     * Update agent profile
+     * @summary Update agent profile
+     * @param {ConversationAgentProfile} profile_request Profile request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateAgentProfile(profile_request: ConversationAgentProfile, options?: any): Promise<ConversationAgentProfileResponse>;
     /**
      * Update a canned message
      * @summary Update a canned message
@@ -40579,6 +40731,14 @@ export interface ConversationApiInterface {
      * @memberof ConversationApiInterface
      */
     getAgentKeepAlive(options?: any): Promise<{}>;
+    /**
+     * Retrieve the agents profile
+     * @summary Get agent profile
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getAgentProfile(options?: any): Promise<ConversationAgentProfileResponse>;
     /**
      * Retrieve a JWT to authorize an agent to make a websocket connection.
      * @summary Get agent websocket authorization
@@ -40794,6 +40954,15 @@ export interface ConversationApiInterface {
      * @memberof ConversationApiInterface
      */
     startConversation(start_request: ConversationStartRequest, options?: any): Promise<ConversationStartResponse>;
+    /**
+     * Update agent profile
+     * @summary Update agent profile
+     * @param {ConversationAgentProfile} profile_request Profile request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    updateAgentProfile(profile_request: ConversationAgentProfile, options?: any): Promise<ConversationAgentProfileResponse>;
     /**
      * Update a canned message
      * @summary Update a canned message
@@ -40877,6 +41046,14 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
      * @memberof ConversationApi
      */
     getAgentKeepAlive(options?: any): Promise<Response>;
+    /**
+     * Retrieve the agents profile
+     * @summary Get agent profile
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    getAgentProfile(options?: any): Promise<ConversationAgentProfileResponse>;
     /**
      * Retrieve a JWT to authorize an agent to make a websocket connection.
      * @summary Get agent websocket authorization
@@ -41092,6 +41269,15 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
      * @memberof ConversationApi
      */
     startConversation(start_request: ConversationStartRequest, options?: any): Promise<ConversationStartResponse>;
+    /**
+     * Update agent profile
+     * @summary Update agent profile
+     * @param {ConversationAgentProfile} profile_request Profile request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    updateAgentProfile(profile_request: ConversationAgentProfile, options?: any): Promise<ConversationAgentProfileResponse>;
     /**
      * Update a canned message
      * @summary Update a canned message

package/dist/api.js

@@ -28,9 +28,9 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OrderPaymentCreditCard = exports.OrderPayment = exports.OrderItemOption = exports.OrderItem = exports.OrderFraudScore = exports.OrderFormat = exports.OrderAutoOrder = exports.OrderAffiliateLedger = exports.Order = exports.OauthTokenResponse = exports.ItemThirdPartyEmailMarketing = exports.ItemTax = exports.ItemTag = exports.ItemShippingMethod = exports.ItemShippingDestinationRestriction = exports.ItemRestrictionItem = exports.ItemRelatedItem = exports.ItemOptionValue = exports.ItemOption = exports.ItemContentMultimedia = exports.ItemAutoOrderStep = exports.Experiment = exports.EmailPerformance = exports.EmailCommseqStep = exports.Distance = exports.ConversationWebsocketMessage = exports.ConversationWebchatQueueStatusUpdateRequest = exports.ConversationWebchatQueueStatusAgent = exports.ConversationSummary = exports.ConversationMessageTransportStatus = exports.ConversationMessage = exports.ConversationEventRRWeb = exports.ConversationEngagementEquationFunction = exports.ConversationEngagement = exports.Conversation = exports.CheckoutHandoffRequest = exports.ChannelPartnerOrderItem = exports.ChannelPartnerOrder = exports.CartKitComponentOption = exports.CartItemOption = exports.CartItemMultimedia = exports.CartCustomerProfileCreditCard = exports.AutoOrderItemSimpleSchedule = exports.AutoOrderItem = exports.AutoOrder = exports.AffiliateLink = exports.AffiliateLedger = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = void 0;
-exports.IntegrationLogApi = exports.IntegrationLogApiFactory = exports.IntegrationLogApiFp = exports.IntegrationLogApiFetchParamCreator = exports.GiftCertificateApi = exports.GiftCertificateApiFactory = exports.GiftCertificateApiFp = exports.GiftCertificateApiFetchParamCreator = exports.FulfillmentApi = exports.FulfillmentApiFactory = exports.FulfillmentApiFp = exports.FulfillmentApiFetchParamCreator = exports.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiFetchParamCreator = exports.CouponApi = exports.CouponApiFactory = exports.CouponApiFp = exports.CouponApiFetchParamCreator = exports.ConversationApi = exports.ConversationApiFactory = exports.ConversationApiFp = exports.ConversationApiFetchParamCreator = exports.CheckoutApi = exports.CheckoutApiFactory = exports.CheckoutApiFp = exports.CheckoutApiFetchParamCreator = exports.ChargebackApi = exports.ChargebackApiFactory = exports.ChargebackApiFp = exports.ChargebackApiFetchParamCreator = exports.ChannelPartnerApi = exports.ChannelPartnerApiFactory = exports.ChannelPartnerApiFp = exports.ChannelPartnerApiFetchParamCreator = exports.AutoOrderApi = exports.AutoOrderApiFactory = exports.AutoOrderApiFp = exports.AutoOrderApiFetchParamCreator = exports.AffiliateApi = exports.AffiliateApiFactory = exports.AffiliateApiFp = exports.AffiliateApiFetchParamCreator = exports.Weight = exports.Webhook = exports.TempMultimedia = exports.PointOfSaleReader = exports.OrderQuery = exports.OrderPaymentECheck = void 0;
-exports.WebhookApi = exports.WebhookApiFactory = exports.WebhookApiFp = exports.WebhookApiFetchParamCreator = exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiFetchParamCreator = exports.TaxApi = exports.TaxApiFactory = exports.TaxApiFp = exports.TaxApiFetchParamCreator = exports.StorefrontApi = exports.StorefrontApiFactory = exports.StorefrontApiFp = exports.StorefrontApiFetchParamCreator = exports.SsoApi = exports.SsoApiFactory = exports.SsoApiFp = exports.SsoApiFetchParamCreator = exports.OrderApi = exports.OrderApiFactory = exports.OrderApiFp = exports.OrderApiFetchParamCreator = exports.OauthApi = exports.OauthApiFactory = exports.OauthApiFp = exports.OauthApiFetchParamCreator = exports.ItemApi = exports.ItemApiFactory = exports.ItemApiFp = exports.ItemApiFetchParamCreator = void 0;
+exports.OrderPayment = exports.OrderItemOption = exports.OrderItem = exports.OrderFraudScore = exports.OrderFormat = exports.OrderAutoOrder = exports.OrderAffiliateLedger = exports.Order = exports.OauthTokenResponse = exports.ItemThirdPartyEmailMarketing = exports.ItemTax = exports.ItemTag = exports.ItemShippingMethod = exports.ItemShippingDestinationRestriction = exports.ItemRestrictionItem = exports.ItemRelatedItem = exports.ItemOptionValue = exports.ItemOption = exports.ItemContentMultimedia = exports.ItemAutoOrderStep = exports.Experiment = exports.EmailPerformance = exports.EmailCommseqStep = exports.Distance = exports.ConversationWebsocketMessage = exports.ConversationWebchatQueueStatusUpdateRequest = exports.ConversationWebchatQueueStatusAgent = exports.ConversationSummary = exports.ConversationMessageTransportStatus = exports.ConversationMessage = exports.ConversationEventRRWeb = exports.ConversationEngagementEquationFunction = exports.ConversationEngagement = exports.ConversationAgentProfile = exports.Conversation = exports.CheckoutHandoffRequest = exports.ChannelPartnerOrderItem = exports.ChannelPartnerOrder = exports.CartKitComponentOption = exports.CartItemOption = exports.CartItemMultimedia = exports.CartCustomerProfileCreditCard = exports.AutoOrderItemSimpleSchedule = exports.AutoOrderItem = exports.AutoOrder = exports.AffiliateLink = exports.AffiliateLedger = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = void 0;
+exports.IntegrationLogApiFactory = exports.IntegrationLogApiFp = exports.IntegrationLogApiFetchParamCreator = exports.GiftCertificateApi = exports.GiftCertificateApiFactory = exports.GiftCertificateApiFp = exports.GiftCertificateApiFetchParamCreator = exports.FulfillmentApi = exports.FulfillmentApiFactory = exports.FulfillmentApiFp = exports.FulfillmentApiFetchParamCreator = exports.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiFetchParamCreator = exports.CouponApi = exports.CouponApiFactory = exports.CouponApiFp = exports.CouponApiFetchParamCreator = exports.ConversationApi = exports.ConversationApiFactory = exports.ConversationApiFp = exports.ConversationApiFetchParamCreator = exports.CheckoutApi = exports.CheckoutApiFactory = exports.CheckoutApiFp = exports.CheckoutApiFetchParamCreator = exports.ChargebackApi = exports.ChargebackApiFactory = exports.ChargebackApiFp = exports.ChargebackApiFetchParamCreator = exports.ChannelPartnerApi = exports.ChannelPartnerApiFactory = exports.ChannelPartnerApiFp = exports.ChannelPartnerApiFetchParamCreator = exports.AutoOrderApi = exports.AutoOrderApiFactory = exports.AutoOrderApiFp = exports.AutoOrderApiFetchParamCreator = exports.AffiliateApi = exports.AffiliateApiFactory = exports.AffiliateApiFp = exports.AffiliateApiFetchParamCreator = exports.Weight = exports.Webhook = exports.TempMultimedia = exports.PointOfSaleReader = exports.OrderQuery = exports.OrderPaymentECheck = exports.OrderPaymentCreditCard = void 0;
+exports.WebhookApi = exports.WebhookApiFactory = exports.WebhookApiFp = exports.WebhookApiFetchParamCreator = exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiFetchParamCreator = exports.TaxApi = exports.TaxApiFactory = exports.TaxApiFp = exports.TaxApiFetchParamCreator = exports.StorefrontApi = exports.StorefrontApiFactory = exports.StorefrontApiFp = exports.StorefrontApiFetchParamCreator = exports.SsoApi = exports.SsoApiFactory = exports.SsoApiFp = exports.SsoApiFetchParamCreator = exports.OrderApi = exports.OrderApiFactory = exports.OrderApiFp = exports.OrderApiFetchParamCreator = exports.OauthApi = exports.OauthApiFactory = exports.OauthApiFp = exports.OauthApiFetchParamCreator = exports.ItemApi = exports.ItemApiFactory = exports.ItemApiFp = exports.ItemApiFetchParamCreator = exports.IntegrationLogApi = void 0;
 var url = require("url");
 var portableFetch = require("portable-fetch");
 var BASE_PATH = "https://secure.ultracart.com/rest/v2".replace(/\/+$/, "");
@@ -375,6 +375,23 @@ var Conversation;
         MediumEnum[MediumEnum["Websocket"] = 'websocket'] = "Websocket";
     })(MediumEnum = Conversation.MediumEnum || (Conversation.MediumEnum = {}));
 })(Conversation = exports.Conversation || (exports.Conversation = {}));
+/**
+ * @export
+ * @namespace ConversationAgentProfile
+ */
+var ConversationAgentProfile;
+(function (ConversationAgentProfile) {
+    /**
+     * @export
+     * @enum {string}
+     */
+    var DefaultStatusEnum;
+    (function (DefaultStatusEnum) {
+        DefaultStatusEnum[DefaultStatusEnum["Available"] = 'available'] = "Available";
+        DefaultStatusEnum[DefaultStatusEnum["Busy"] = 'busy'] = "Busy";
+        DefaultStatusEnum[DefaultStatusEnum["Unavailable"] = 'unavailable'] = "Unavailable";
+    })(DefaultStatusEnum = ConversationAgentProfile.DefaultStatusEnum || (ConversationAgentProfile.DefaultStatusEnum = {}));
+})(ConversationAgentProfile = exports.ConversationAgentProfile || (exports.ConversationAgentProfile = {}));
 /**
  * @export
  * @namespace ConversationEngagement
@@ -6333,6 +6350,46 @@ var ConversationApiFetchParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Retrieve the agents profile
+         * @summary Get agent profile
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getAgentProfile: function (options) {
+            if (options === void 0) { options = {}; }
+            var localVarPath = "/conversation/agent/profile";
+            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 JWT to authorize an agent to make a websocket connection.
          * @summary Get agent websocket authorization
@@ -7431,6 +7488,54 @@ var ConversationApiFetchParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Update agent profile
+         * @summary Update agent profile
+         * @param {ConversationAgentProfile} profile_request Profile request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateAgentProfile: function (profile_request, options) {
+            if (options === void 0) { options = {}; }
+            // verify required parameter 'profile_request' is not null or undefined
+            if (profile_request === null || profile_request === undefined) {
+                throw new RequiredError('profile_request', 'Required parameter profile_request was null or undefined when calling updateAgentProfile.');
+            }
+            var localVarPath = "/conversation/agent/profile";
+            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 = ("ConversationAgentProfile" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
+            localVarRequestOptions.body = needsSerialization ? JSON.stringify(profile_request || {}) : (profile_request || "");
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Update a canned message
          * @summary Update a canned message
@@ -7743,6 +7848,27 @@ var ConversationApiFp = function (configuration) {
                 });
             };
         },
+        /**
+         * Retrieve the agents profile
+         * @summary Get agent profile
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getAgentProfile: function (options) {
+            var localVarFetchArgs = (0, exports.ConversationApiFetchParamCreator)(configuration).getAgentProfile(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 JWT to authorize an agent to make a websocket connection.
          * @summary Get agent websocket authorization
@@ -8270,6 +8396,28 @@ var ConversationApiFp = function (configuration) {
                 });
             };
         },
+        /**
+         * Update agent profile
+         * @summary Update agent profile
+         * @param {ConversationAgentProfile} profile_request Profile request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateAgentProfile: function (profile_request, options) {
+            var localVarFetchArgs = (0, exports.ConversationApiFetchParamCreator)(configuration).updateAgentProfile(profile_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.json();
+                    }
+                    else {
+                        throw response;
+                    }
+                });
+            };
+        },
         /**
          * Update a canned message
          * @summary Update a canned message
@@ -8410,6 +8558,15 @@ var ConversationApiFactory = function (configuration, fetch, basePath) {
         getAgentKeepAlive: function (options) {
             return (0, exports.ConversationApiFp)(configuration).getAgentKeepAlive(options)(fetch, basePath);
         },
+        /**
+         * Retrieve the agents profile
+         * @summary Get agent profile
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getAgentProfile: function (options) {
+            return (0, exports.ConversationApiFp)(configuration).getAgentProfile(options)(fetch, basePath);
+        },
         /**
          * Retrieve a JWT to authorize an agent to make a websocket connection.
          * @summary Get agent websocket authorization
@@ -8649,6 +8806,16 @@ var ConversationApiFactory = function (configuration, fetch, basePath) {
         startConversation: function (start_request, options) {
             return (0, exports.ConversationApiFp)(configuration).startConversation(start_request, options)(fetch, basePath);
         },
+        /**
+         * Update agent profile
+         * @summary Update agent profile
+         * @param {ConversationAgentProfile} profile_request Profile request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateAgentProfile: function (profile_request, options) {
+            return (0, exports.ConversationApiFp)(configuration).updateAgentProfile(profile_request, options)(fetch, basePath);
+        },
         /**
          * Update a canned message
          * @summary Update a canned message
@@ -8750,6 +8917,16 @@ var ConversationApi = /** @class */ (function (_super) {
     ConversationApi.prototype.getAgentKeepAlive = function (options) {
         return (0, exports.ConversationApiFp)(this.configuration).getAgentKeepAlive(options)(this.fetch, this.basePath);
     };
+    /**
+     * Retrieve the agents profile
+     * @summary Get agent profile
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    ConversationApi.prototype.getAgentProfile = function (options) {
+        return (0, exports.ConversationApiFp)(this.configuration).getAgentProfile(options)(this.fetch, this.basePath);
+    };
     /**
      * Retrieve a JWT to authorize an agent to make a websocket connection.
      * @summary Get agent websocket authorization
@@ -9013,6 +9190,17 @@ 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 agent profile
+     * @summary Update agent profile
+     * @param {ConversationAgentProfile} profile_request Profile request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    ConversationApi.prototype.updateAgentProfile = function (profile_request, options) {
+        return (0, exports.ConversationApiFp)(this.configuration).updateAgentProfile(profile_request, options)(this.fetch, this.basePath);
+    };
     /**
      * Update a canned message
      * @summary Update a canned message

package/package.json

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