ultracart_rest_api_v2_typescript 4.0.128 → 4.0.130

package/.openapi-generator/FILES

@@ -149,6 +149,8 @@ src/models/CityStateZip.ts
 src/models/Conversation.ts
 src/models/ConversationAgentAuth.ts
 src/models/ConversationAgentAuthResponse.ts
+src/models/ConversationAgentProfile.ts
+src/models/ConversationAgentProfileResponse.ts
 src/models/ConversationAutocompleteRequest.ts
 src/models/ConversationAutocompleteResponse.ts
 src/models/ConversationAutocompleteValue.ts

package/README.md

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

package/dist/apis/ConversationApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { ConversationAgentAuthResponse, ConversationAutocompleteRequest, ConversationAutocompleteResponse, ConversationCannedMessage, ConversationCannedMessageResponse, ConversationCannedMessagesResponse, ConversationCannedMessagesSearch, ConversationDepartment, ConversationDepartmentMembersResponse, ConversationDepartmentResponse, ConversationDepartmentsResponse, ConversationEngagement, ConversationEngagementResponse, ConversationEngagementsResponse, ConversationJoinRequest, ConversationLocationsResponse, ConversationMessagesResponse, ConversationMultimediaUploadUrlResponse, ConversationPermissionsResponse, ConversationResponse, ConversationSearchRequest, ConversationSearchResponse, ConversationStartRequest, ConversationStartResponse, ConversationWebchatContext, ConversationWebchatQueueStatusUpdateRequest, ConversationWebchatQueueStatusesResponse, ConversationsResponse } from '../models';
+import { ConversationAgentAuthResponse, ConversationAgentProfile, ConversationAgentProfileResponse, ConversationAutocompleteRequest, ConversationAutocompleteResponse, ConversationCannedMessage, ConversationCannedMessageResponse, ConversationCannedMessagesResponse, ConversationCannedMessagesSearch, ConversationDepartment, ConversationDepartmentMembersResponse, ConversationDepartmentResponse, ConversationDepartmentsResponse, ConversationEngagement, ConversationEngagementResponse, ConversationEngagementsResponse, ConversationJoinRequest, ConversationLocationsResponse, ConversationMessagesResponse, ConversationMultimediaUploadUrlResponse, ConversationPermissionsResponse, ConversationResponse, ConversationSearchRequest, ConversationSearchResponse, ConversationStartRequest, ConversationStartResponse, ConversationWebchatContext, ConversationWebchatQueueStatusUpdateRequest, ConversationWebchatQueueStatusesResponse, ConversationsResponse } from '../models';
 export interface DeleteConversationCannedMessageRequest {
     conversationCannedMessageOid: number;
 }
@@ -75,6 +75,9 @@ export interface SearchConversationCannedMessagesRequest {
 export interface StartConversationRequest {
     startRequest: ConversationStartRequest;
 }
+export interface UpdateAgentProfileRequest {
+    profileRequest: ConversationAgentProfile;
+}
 export interface UpdateConversationCannedMessageRequest {
     conversationCannedMessageOid: number;
     cannedMessage: ConversationCannedMessage;
@@ -153,6 +156,19 @@ export interface ConversationApiInterface {
      * Agent keep alive
      */
     getAgentKeepAlive(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Retrieve the agents profile
+     * @summary Get agent profile
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getAgentProfileRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationAgentProfileResponse>>;
+    /**
+     * Retrieve the agents profile
+     * Get agent profile
+     */
+    getAgentProfile(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentProfileResponse>;
     /**
      * Retrieve a JWT to authorize an agent to make a websocket connection.
      * @summary Get agent websocket authorization
@@ -488,6 +504,20 @@ export interface ConversationApiInterface {
      * Start a conversation
      */
     startConversation(requestParameters: StartConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationStartResponse>;
+    /**
+     * Update agent profile
+     * @summary Update agent profile
+     * @param {ConversationAgentProfile} profileRequest Profile request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    updateAgentProfileRaw(requestParameters: UpdateAgentProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationAgentProfileResponse>>;
+    /**
+     * Update agent profile
+     * Update agent profile
+     */
+    updateAgentProfile(requestParameters: UpdateAgentProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentProfileResponse>;
     /**
      * Update a canned message
      * @summary Update a canned message
@@ -593,6 +623,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
      * Agent keep alive
      */
     getAgentKeepAlive(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Retrieve the agents profile
+     * Get agent profile
+     */
+    getAgentProfileRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationAgentProfileResponse>>;
+    /**
+     * Retrieve the agents profile
+     * Get agent profile
+     */
+    getAgentProfile(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentProfileResponse>;
     /**
      * Retrieve a JWT to authorize an agent to make a websocket connection.
      * Get agent websocket authorization
@@ -833,6 +873,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
      * Start a conversation
      */
     startConversation(requestParameters: StartConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationStartResponse>;
+    /**
+     * Update agent profile
+     * Update agent profile
+     */
+    updateAgentProfileRaw(requestParameters: UpdateAgentProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationAgentProfileResponse>>;
+    /**
+     * Update agent profile
+     * Update agent profile
+     */
+    updateAgentProfile(requestParameters: UpdateAgentProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentProfileResponse>;
     /**
      * Update a canned message
      * Update a canned message

package/dist/apis/ConversationApi.js

@@ -300,6 +300,62 @@ var ConversationApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Retrieve the agents profile
+     * Get agent profile
+     */
+    ConversationApi.prototype.getAgentProfileRaw = function (initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["conversation_read"])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/conversation/agent/profile",
+                                method: 'GET',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ConversationAgentProfileResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Retrieve the agents profile
+     * Get agent profile
+     */
+    ConversationApi.prototype.getAgentProfile = function (initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getAgentProfileRaw(initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Retrieve a JWT to authorize an agent to make a websocket connection.
      * Get agent websocket authorization
@@ -1721,6 +1777,67 @@ var ConversationApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Update agent profile
+     * Update agent profile
+     */
+    ConversationApi.prototype.updateAgentProfileRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.profileRequest === null || requestParameters.profileRequest === undefined) {
+                            throw new runtime.RequiredError('profileRequest', 'Required parameter requestParameters.profileRequest was null or undefined when calling updateAgentProfile.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json';
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["conversation_write"])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/conversation/agent/profile",
+                                method: 'PUT',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, models_1.ConversationAgentProfileToJSON)(requestParameters.profileRequest),
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ConversationAgentProfileResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Update agent profile
+     * Update agent profile
+     */
+    ConversationApi.prototype.updateAgentProfile = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.updateAgentProfileRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Update a canned message
      * Update a canned message

package/dist/models/ConversationAgentProfile.d.ts

@@ -0,0 +1,72 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @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?: ConversationAgentProfileDefaultStatusEnum;
+    /**
+     * 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
+ */
+export declare const ConversationAgentProfileDefaultStatusEnum: {
+    readonly Available: "available";
+    readonly Busy: "busy";
+    readonly Unavailable: "unavailable";
+};
+export type ConversationAgentProfileDefaultStatusEnum = typeof ConversationAgentProfileDefaultStatusEnum[keyof typeof ConversationAgentProfileDefaultStatusEnum];
+export declare function ConversationAgentProfileFromJSON(json: any): ConversationAgentProfile;
+export declare function ConversationAgentProfileFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationAgentProfile;
+export declare function ConversationAgentProfileToJSON(value?: ConversationAgentProfile | null): any;

package/dist/models/ConversationAgentProfile.js

@@ -0,0 +1,62 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConversationAgentProfileToJSON = exports.ConversationAgentProfileFromJSONTyped = exports.ConversationAgentProfileFromJSON = exports.ConversationAgentProfileDefaultStatusEnum = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * @export
+ */
+exports.ConversationAgentProfileDefaultStatusEnum = {
+    Available: 'available',
+    Busy: 'busy',
+    Unavailable: 'unavailable'
+};
+function ConversationAgentProfileFromJSON(json) {
+    return ConversationAgentProfileFromJSONTyped(json, false);
+}
+exports.ConversationAgentProfileFromJSON = ConversationAgentProfileFromJSON;
+function ConversationAgentProfileFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'chat_limit': !(0, runtime_1.exists)(json, 'chat_limit') ? undefined : json['chat_limit'],
+        'default_language_iso_code': !(0, runtime_1.exists)(json, 'default_language_iso_code') ? undefined : json['default_language_iso_code'],
+        'default_status': !(0, runtime_1.exists)(json, 'default_status') ? undefined : json['default_status'],
+        'display_name': !(0, runtime_1.exists)(json, 'display_name') ? undefined : json['display_name'],
+        'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
+        'profile_image_upload_key': !(0, runtime_1.exists)(json, 'profile_image_upload_key') ? undefined : json['profile_image_upload_key'],
+        'profile_image_url': !(0, runtime_1.exists)(json, 'profile_image_url') ? undefined : json['profile_image_url'],
+    };
+}
+exports.ConversationAgentProfileFromJSONTyped = ConversationAgentProfileFromJSONTyped;
+function ConversationAgentProfileToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'chat_limit': value.chat_limit,
+        'default_language_iso_code': value.default_language_iso_code,
+        'default_status': value.default_status,
+        'display_name': value.display_name,
+        'name': value.name,
+        'profile_image_upload_key': value.profile_image_upload_key,
+        'profile_image_url': value.profile_image_url,
+    };
+}
+exports.ConversationAgentProfileToJSON = ConversationAgentProfileToJSON;

package/dist/models/ConversationAgentProfileResponse.d.ts

@@ -0,0 +1,55 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ConversationAgentProfile } from './ConversationAgentProfile';
+import { ModelError } from './ModelError';
+import { ResponseMetadata } from './ResponseMetadata';
+import { Warning } from './Warning';
+/**
+ *
+ * @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 declare function ConversationAgentProfileResponseFromJSON(json: any): ConversationAgentProfileResponse;
+export declare function ConversationAgentProfileResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationAgentProfileResponse;
+export declare function ConversationAgentProfileResponseToJSON(value?: ConversationAgentProfileResponse | null): any;

package/dist/models/ConversationAgentProfileResponse.js

@@ -0,0 +1,54 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConversationAgentProfileResponseToJSON = exports.ConversationAgentProfileResponseFromJSONTyped = exports.ConversationAgentProfileResponseFromJSON = void 0;
+var runtime_1 = require("../runtime");
+var ConversationAgentProfile_1 = require("./ConversationAgentProfile");
+var ModelError_1 = require("./ModelError");
+var ResponseMetadata_1 = require("./ResponseMetadata");
+var Warning_1 = require("./Warning");
+function ConversationAgentProfileResponseFromJSON(json) {
+    return ConversationAgentProfileResponseFromJSONTyped(json, false);
+}
+exports.ConversationAgentProfileResponseFromJSON = ConversationAgentProfileResponseFromJSON;
+function ConversationAgentProfileResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'agent_profile': !(0, runtime_1.exists)(json, 'agent_profile') ? undefined : (0, ConversationAgentProfile_1.ConversationAgentProfileFromJSON)(json['agent_profile']),
+        'error': !(0, runtime_1.exists)(json, 'error') ? undefined : (0, ModelError_1.ModelErrorFromJSON)(json['error']),
+        'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : (0, ResponseMetadata_1.ResponseMetadataFromJSON)(json['metadata']),
+        'success': !(0, runtime_1.exists)(json, 'success') ? undefined : json['success'],
+        'warning': !(0, runtime_1.exists)(json, 'warning') ? undefined : (0, Warning_1.WarningFromJSON)(json['warning']),
+    };
+}
+exports.ConversationAgentProfileResponseFromJSONTyped = ConversationAgentProfileResponseFromJSONTyped;
+function ConversationAgentProfileResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'agent_profile': (0, ConversationAgentProfile_1.ConversationAgentProfileToJSON)(value.agent_profile),
+        'error': (0, ModelError_1.ModelErrorToJSON)(value.error),
+        'metadata': (0, ResponseMetadata_1.ResponseMetadataToJSON)(value.metadata),
+        'success': value.success,
+        'warning': (0, Warning_1.WarningToJSON)(value.warning),
+    };
+}
+exports.ConversationAgentProfileResponseToJSON = ConversationAgentProfileResponseToJSON;

package/dist/models/ConversationWebsocketMessage.d.ts

@@ -27,6 +27,12 @@ import { ConversationWebchatQueueStatusQueueEntry } from './ConversationWebchatQ
  * @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}

package/dist/models/ConversationWebsocketMessage.js

@@ -67,6 +67,7 @@ function ConversationWebsocketMessageFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
+        'conversation_arn': !(0, runtime_1.exists)(json, 'conversation_arn') ? undefined : json['conversation_arn'],
         'conversation_uuid': !(0, runtime_1.exists)(json, 'conversation_uuid') ? undefined : json['conversation_uuid'],
         'event_add_coupon': !(0, runtime_1.exists)(json, 'event_add_coupon') ? undefined : (0, ConversationEventAddCoupon_1.ConversationEventAddCouponFromJSON)(json['event_add_coupon']),
         'event_add_item': !(0, runtime_1.exists)(json, 'event_add_item') ? undefined : (0, ConversationEventAddItem_1.ConversationEventAddItemFromJSON)(json['event_add_item']),
@@ -100,6 +101,7 @@ function ConversationWebsocketMessageToJSON(value) {
         return null;
     }
     return {
+        'conversation_arn': value.conversation_arn,
         'conversation_uuid': value.conversation_uuid,
         'event_add_coupon': (0, ConversationEventAddCoupon_1.ConversationEventAddCouponToJSON)(value.event_add_coupon),
         'event_add_item': (0, ConversationEventAddItem_1.ConversationEventAddItemToJSON)(value.event_add_item),

package/dist/models/index.d.ts

@@ -124,6 +124,8 @@ export * from './CityStateZip';
 export * from './Conversation';
 export * from './ConversationAgentAuth';
 export * from './ConversationAgentAuthResponse';
+export * from './ConversationAgentProfile';
+export * from './ConversationAgentProfileResponse';
 export * from './ConversationAutocompleteRequest';
 export * from './ConversationAutocompleteResponse';
 export * from './ConversationAutocompleteValue';

package/dist/models/index.js

@@ -142,6 +142,8 @@ __exportStar(require("./CityStateZip"), exports);
 __exportStar(require("./Conversation"), exports);
 __exportStar(require("./ConversationAgentAuth"), exports);
 __exportStar(require("./ConversationAgentAuthResponse"), exports);
+__exportStar(require("./ConversationAgentProfile"), exports);
+__exportStar(require("./ConversationAgentProfileResponse"), exports);
 __exportStar(require("./ConversationAutocompleteRequest"), exports);
 __exportStar(require("./ConversationAutocompleteResponse"), exports);
 __exportStar(require("./ConversationAutocompleteValue"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "4.0.128",
+  "version": "4.0.130",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "repository": {

package/src/apis/ConversationApi.ts

@@ -18,6 +18,12 @@ import {
     ConversationAgentAuthResponse,
     ConversationAgentAuthResponseFromJSON,
     ConversationAgentAuthResponseToJSON,
+    ConversationAgentProfile,
+    ConversationAgentProfileFromJSON,
+    ConversationAgentProfileToJSON,
+    ConversationAgentProfileResponse,
+    ConversationAgentProfileResponseFromJSON,
+    ConversationAgentProfileResponseToJSON,
     ConversationAutocompleteRequest,
     ConversationAutocompleteRequestFromJSON,
     ConversationAutocompleteRequestToJSON,
@@ -187,6 +193,10 @@ export interface StartConversationRequest {
     startRequest: ConversationStartRequest;
 }
 
+export interface UpdateAgentProfileRequest {
+    profileRequest: ConversationAgentProfile;
+}
+
 export interface UpdateConversationCannedMessageRequest {
     conversationCannedMessageOid: number;
     cannedMessage: ConversationCannedMessage;
@@ -277,6 +287,21 @@ export interface ConversationApiInterface {
      */
     getAgentKeepAlive(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 
+    /**
+     * Retrieve the agents profile 
+     * @summary Get agent profile
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getAgentProfileRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationAgentProfileResponse>>;
+
+    /**
+     * Retrieve the agents profile 
+     * Get agent profile
+     */
+    getAgentProfile(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentProfileResponse>;
+
     /**
      * Retrieve a JWT to authorize an agent to make a websocket connection. 
      * @summary Get agent websocket authorization
@@ -660,6 +685,22 @@ export interface ConversationApiInterface {
      */
     startConversation(requestParameters: StartConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationStartResponse>;
 
+    /**
+     * Update agent profile 
+     * @summary Update agent profile
+     * @param {ConversationAgentProfile} profileRequest Profile request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    updateAgentProfileRaw(requestParameters: UpdateAgentProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationAgentProfileResponse>>;
+
+    /**
+     * Update agent profile 
+     * Update agent profile
+     */
+    updateAgentProfile(requestParameters: UpdateAgentProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentProfileResponse>;
+
     /**
      * Update a canned message 
      * @summary Update a canned message
@@ -891,6 +932,43 @@ export class ConversationApi extends runtime.BaseAPI implements ConversationApiI
         await this.getAgentKeepAliveRaw(initOverrides);
     }
 
+    /**
+     * Retrieve the agents profile 
+     * Get agent profile
+     */
+    async getAgentProfileRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationAgentProfileResponse>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["conversation_read"]);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+        }
+
+        const response = await this.request({
+            path: `/conversation/agent/profile`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ConversationAgentProfileResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieve the agents profile 
+     * Get agent profile
+     */
+    async getAgentProfile(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentProfileResponse> {
+        const response = await this.getAgentProfileRaw(initOverrides);
+        return await response.value();
+    }
+
     /**
      * Retrieve a JWT to authorize an agent to make a websocket connection. 
      * Get agent websocket authorization
@@ -1888,6 +1966,50 @@ export class ConversationApi extends runtime.BaseAPI implements ConversationApiI
         return await response.value();
     }
 
+    /**
+     * Update agent profile 
+     * Update agent profile
+     */
+    async updateAgentProfileRaw(requestParameters: UpdateAgentProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationAgentProfileResponse>> {
+        if (requestParameters.profileRequest === null || requestParameters.profileRequest === undefined) {
+            throw new runtime.RequiredError('profileRequest','Required parameter requestParameters.profileRequest was null or undefined when calling updateAgentProfile.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["conversation_write"]);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+        }
+
+        const response = await this.request({
+            path: `/conversation/agent/profile`,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ConversationAgentProfileToJSON(requestParameters.profileRequest),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ConversationAgentProfileResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Update agent profile 
+     * Update agent profile
+     */
+    async updateAgentProfile(requestParameters: UpdateAgentProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentProfileResponse> {
+        const response = await this.updateAgentProfileRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Update a canned message 
      * Update a canned message

package/src/models/ConversationAgentProfile.ts

@@ -0,0 +1,116 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @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?: ConversationAgentProfileDefaultStatusEnum;
+    /**
+     * 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
+ */
+export const ConversationAgentProfileDefaultStatusEnum = {
+    Available: 'available',
+    Busy: 'busy',
+    Unavailable: 'unavailable'
+} as const;
+export type ConversationAgentProfileDefaultStatusEnum = typeof ConversationAgentProfileDefaultStatusEnum[keyof typeof ConversationAgentProfileDefaultStatusEnum];
+
+
+export function ConversationAgentProfileFromJSON(json: any): ConversationAgentProfile {
+    return ConversationAgentProfileFromJSONTyped(json, false);
+}
+
+export function ConversationAgentProfileFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationAgentProfile {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'chat_limit': !exists(json, 'chat_limit') ? undefined : json['chat_limit'],
+        'default_language_iso_code': !exists(json, 'default_language_iso_code') ? undefined : json['default_language_iso_code'],
+        'default_status': !exists(json, 'default_status') ? undefined : json['default_status'],
+        'display_name': !exists(json, 'display_name') ? undefined : json['display_name'],
+        'name': !exists(json, 'name') ? undefined : json['name'],
+        'profile_image_upload_key': !exists(json, 'profile_image_upload_key') ? undefined : json['profile_image_upload_key'],
+        'profile_image_url': !exists(json, 'profile_image_url') ? undefined : json['profile_image_url'],
+    };
+}
+
+export function ConversationAgentProfileToJSON(value?: ConversationAgentProfile | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'chat_limit': value.chat_limit,
+        'default_language_iso_code': value.default_language_iso_code,
+        'default_status': value.default_status,
+        'display_name': value.display_name,
+        'name': value.name,
+        'profile_image_upload_key': value.profile_image_upload_key,
+        'profile_image_url': value.profile_image_url,
+    };
+}
+

package/src/models/ConversationAgentProfileResponse.ts

@@ -0,0 +1,113 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+import {
+    ConversationAgentProfile,
+    ConversationAgentProfileFromJSON,
+    ConversationAgentProfileFromJSONTyped,
+    ConversationAgentProfileToJSON,
+} from './ConversationAgentProfile';
+import {
+    ModelError,
+    ModelErrorFromJSON,
+    ModelErrorFromJSONTyped,
+    ModelErrorToJSON,
+} from './ModelError';
+import {
+    ResponseMetadata,
+    ResponseMetadataFromJSON,
+    ResponseMetadataFromJSONTyped,
+    ResponseMetadataToJSON,
+} from './ResponseMetadata';
+import {
+    Warning,
+    WarningFromJSON,
+    WarningFromJSONTyped,
+    WarningToJSON,
+} from './Warning';
+
+/**
+ * 
+ * @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 function ConversationAgentProfileResponseFromJSON(json: any): ConversationAgentProfileResponse {
+    return ConversationAgentProfileResponseFromJSONTyped(json, false);
+}
+
+export function ConversationAgentProfileResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationAgentProfileResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'agent_profile': !exists(json, 'agent_profile') ? undefined : ConversationAgentProfileFromJSON(json['agent_profile']),
+        'error': !exists(json, 'error') ? undefined : ModelErrorFromJSON(json['error']),
+        'metadata': !exists(json, 'metadata') ? undefined : ResponseMetadataFromJSON(json['metadata']),
+        'success': !exists(json, 'success') ? undefined : json['success'],
+        'warning': !exists(json, 'warning') ? undefined : WarningFromJSON(json['warning']),
+    };
+}
+
+export function ConversationAgentProfileResponseToJSON(value?: ConversationAgentProfileResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'agent_profile': ConversationAgentProfileToJSON(value.agent_profile),
+        'error': ModelErrorToJSON(value.error),
+        'metadata': ResponseMetadataToJSON(value.metadata),
+        'success': value.success,
+        'warning': WarningToJSON(value.warning),
+    };
+}
+

package/src/models/ConversationWebsocketMessage.ts

@@ -92,6 +92,12 @@ import {
  * @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}
@@ -273,6 +279,7 @@ export function ConversationWebsocketMessageFromJSONTyped(json: any, ignoreDiscr
     }
     return {
         
+        'conversation_arn': !exists(json, 'conversation_arn') ? undefined : json['conversation_arn'],
         'conversation_uuid': !exists(json, 'conversation_uuid') ? undefined : json['conversation_uuid'],
         'event_add_coupon': !exists(json, 'event_add_coupon') ? undefined : ConversationEventAddCouponFromJSON(json['event_add_coupon']),
         'event_add_item': !exists(json, 'event_add_item') ? undefined : ConversationEventAddItemFromJSON(json['event_add_item']),
@@ -307,6 +314,7 @@ export function ConversationWebsocketMessageToJSON(value?: ConversationWebsocket
     }
     return {
         
+        'conversation_arn': value.conversation_arn,
         'conversation_uuid': value.conversation_uuid,
         'event_add_coupon': ConversationEventAddCouponToJSON(value.event_add_coupon),
         'event_add_item': ConversationEventAddItemToJSON(value.event_add_item),

package/src/models/index.ts

@@ -126,6 +126,8 @@ export * from './CityStateZip';
 export * from './Conversation';
 export * from './ConversationAgentAuth';
 export * from './ConversationAgentAuthResponse';
+export * from './ConversationAgentProfile';
+export * from './ConversationAgentProfileResponse';
 export * from './ConversationAutocompleteRequest';
 export * from './ConversationAutocompleteResponse';
 export * from './ConversationAutocompleteValue';