ultracart_rest_api_v2_typescript 4.0.94-RC → 4.0.96-RC

package/.openapi-generator/FILES

@@ -144,6 +144,10 @@ src/models/CityStateZip.ts
 src/models/Conversation.ts
 src/models/ConversationAgentAuth.ts
 src/models/ConversationAgentAuthResponse.ts
+src/models/ConversationCannedMessage.ts
+src/models/ConversationCannedMessageResponse.ts
+src/models/ConversationCannedMessagesResponse.ts
+src/models/ConversationCannedMessagesSearch.ts
 src/models/ConversationEventAddCoupon.ts
 src/models/ConversationEventAddItem.ts
 src/models/ConversationEventQueuePosition.ts
@@ -152,6 +156,7 @@ src/models/ConversationEventReadMessage.ts
 src/models/ConversationEventTyping.ts
 src/models/ConversationEventWebchatContext.ts
 src/models/ConversationMessage.ts
+src/models/ConversationMessageTranslation.ts
 src/models/ConversationMessageTransportStatus.ts
 src/models/ConversationMessagesResponse.ts
 src/models/ConversationMultimediaUploadUrl.ts

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@4.0.94-RC
+## ultracart_rest_api_v2_typescript@4.0.96-RC
 
 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.94-RC --save
+npm install ultracart_rest_api_v2_typescript@4.0.96-RC --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.96-RC | 12/09/2022 | conversations - message translation |
+| 4.0.95-RC | 12/08/2022 | conversation canned messages |
 | 4.0.94-RC | 12/08/2022 | communications - expose the rebuild percentage |
 | 4.0.93-RC | 12/06/2022 | convo - add session_start_dts to webchat context, cart - add customer_profile.signup_dts |
 | 4.0.92-RC | 12/06/2022 | customer api - expose edi information and editor values |

package/dist/apis/ConversationApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { ConversationAgentAuthResponse, ConversationMessagesResponse, ConversationMultimediaUploadUrlResponse, ConversationResponse, ConversationStartRequest, ConversationStartResponse, ConversationWebchatContext, ConversationWebchatQueueStatusUpdateRequest, ConversationWebchatQueueStatusesResponse, ConversationsResponse } from '../models';
+import { ConversationAgentAuthResponse, ConversationCannedMessage, ConversationCannedMessageResponse, ConversationCannedMessagesResponse, ConversationCannedMessagesSearch, ConversationMessagesResponse, ConversationMultimediaUploadUrlResponse, ConversationResponse, ConversationStartRequest, ConversationStartResponse, ConversationWebchatContext, ConversationWebchatQueueStatusUpdateRequest, ConversationWebchatQueueStatusesResponse, ConversationsResponse } from '../models';
 export interface GetConversationRequest {
     conversationUuid: string;
     limit?: number;
@@ -32,6 +32,9 @@ export interface GetConversationsRequest {
     limit?: number;
     offset?: number;
 }
+export interface InsertConversationCannedMessageRequest {
+    cannedMessage: ConversationCannedMessage;
+}
 export interface JoinConversationRequest {
     conversationUuid: string;
 }
@@ -41,9 +44,16 @@ export interface LeaveConversationRequest {
 export interface MarkReadConversationRequest {
     conversationUuid: string;
 }
+export interface SearchConversationCannedMessagesRequest {
+    searchRequest: ConversationCannedMessagesSearch;
+}
 export interface StartConversationRequest {
     startRequest: ConversationStartRequest;
 }
+export interface UpdateConversationCannedMessageRequest {
+    conversationCannedMessageOid: number;
+    cannedMessage: ConversationCannedMessage;
+}
 export interface UpdateConversationWebchatQueueStatusRequest {
     queueName: string;
     statusRequest: ConversationWebchatQueueStatusUpdateRequest;
@@ -96,6 +106,19 @@ export interface ConversationApiInterface {
      * Retrieve a conversation
      */
     getConversation(requestParameters: GetConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationResponse>;
+    /**
+     * Retrieve a list of canned messages ordered by short_code
+     * @summary Retrieve a list of canned messages ordered by short_code
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getConversationCannedMessagesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationCannedMessagesResponse>>;
+    /**
+     * Retrieve a list of canned messages ordered by short_code
+     * Retrieve a list of canned messages ordered by short_code
+     */
+    getConversationCannedMessages(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationCannedMessagesResponse>;
     /**
      * Get a webchat conversation context
      * @summary Get a webchat conversation context
@@ -170,6 +193,20 @@ export interface ConversationApiInterface {
      * Retrieve a list of conversation summaries newest to oldest
      */
     getConversations(requestParameters: GetConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationsResponse>;
+    /**
+     * Insert a canned message
+     * @summary Insert a canned message
+     * @param {ConversationCannedMessage} cannedMessage Canned message
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    insertConversationCannedMessageRaw(requestParameters: InsertConversationCannedMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationCannedMessageResponse>>;
+    /**
+     * Insert a canned message
+     * Insert a canned message
+     */
+    insertConversationCannedMessage(requestParameters: InsertConversationCannedMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationCannedMessageResponse>;
     /**
      * Join a conversation
      * @summary Join a conversation
@@ -212,6 +249,20 @@ export interface ConversationApiInterface {
      * Mark a conversation as read
      */
     markReadConversation(requestParameters: MarkReadConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Search for canned messages by short_code
+     * @summary Search for canned messages by short_code
+     * @param {ConversationCannedMessagesSearch} searchRequest Search request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    searchConversationCannedMessagesRaw(requestParameters: SearchConversationCannedMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationCannedMessagesResponse>>;
+    /**
+     * Search for canned messages by short_code
+     * Search for canned messages by short_code
+     */
+    searchConversationCannedMessages(requestParameters: SearchConversationCannedMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationCannedMessagesResponse>;
     /**
      * Start a new conversation
      * @summary Start a conversation
@@ -226,6 +277,21 @@ export interface ConversationApiInterface {
      * Start a conversation
      */
     startConversation(requestParameters: StartConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationStartResponse>;
+    /**
+     * Update a canned message
+     * @summary Update a canned message
+     * @param {number} conversationCannedMessageOid
+     * @param {ConversationCannedMessage} cannedMessage Canned message
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    updateConversationCannedMessageRaw(requestParameters: UpdateConversationCannedMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationCannedMessageResponse>>;
+    /**
+     * Update a canned message
+     * Update a canned message
+     */
+    updateConversationCannedMessage(requestParameters: UpdateConversationCannedMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationCannedMessageResponse>;
     /**
      * Update status within the queue
      * @summary Update status within the queue
@@ -276,6 +342,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
      * Retrieve a conversation
      */
     getConversation(requestParameters: GetConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationResponse>;
+    /**
+     * Retrieve a list of canned messages ordered by short_code
+     * Retrieve a list of canned messages ordered by short_code
+     */
+    getConversationCannedMessagesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationCannedMessagesResponse>>;
+    /**
+     * Retrieve a list of canned messages ordered by short_code
+     * Retrieve a list of canned messages ordered by short_code
+     */
+    getConversationCannedMessages(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationCannedMessagesResponse>;
     /**
      * Get a webchat conversation context
      * Get a webchat conversation context
@@ -326,6 +402,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
      * Retrieve a list of conversation summaries newest to oldest
      */
     getConversations(requestParameters?: GetConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationsResponse>;
+    /**
+     * Insert a canned message
+     * Insert a canned message
+     */
+    insertConversationCannedMessageRaw(requestParameters: InsertConversationCannedMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationCannedMessageResponse>>;
+    /**
+     * Insert a canned message
+     * Insert a canned message
+     */
+    insertConversationCannedMessage(requestParameters: InsertConversationCannedMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationCannedMessageResponse>;
     /**
      * Join a conversation
      * Join a conversation
@@ -356,6 +442,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
      * Mark a conversation as read
      */
     markReadConversation(requestParameters: MarkReadConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Search for canned messages by short_code
+     * Search for canned messages by short_code
+     */
+    searchConversationCannedMessagesRaw(requestParameters: SearchConversationCannedMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationCannedMessagesResponse>>;
+    /**
+     * Search for canned messages by short_code
+     * Search for canned messages by short_code
+     */
+    searchConversationCannedMessages(requestParameters: SearchConversationCannedMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationCannedMessagesResponse>;
     /**
      * Start a new conversation
      * Start a conversation
@@ -366,6 +462,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
      * Start a conversation
      */
     startConversation(requestParameters: StartConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationStartResponse>;
+    /**
+     * Update a canned message
+     * Update a canned message
+     */
+    updateConversationCannedMessageRaw(requestParameters: UpdateConversationCannedMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationCannedMessageResponse>>;
+    /**
+     * Update a canned message
+     * Update a canned message
+     */
+    updateConversationCannedMessage(requestParameters: UpdateConversationCannedMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationCannedMessageResponse>;
     /**
      * Update status within the queue
      * Update status within the queue

package/dist/apis/ConversationApi.js

@@ -247,6 +247,62 @@ var ConversationApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Retrieve a list of canned messages ordered by short_code
+     * Retrieve a list of canned messages ordered by short_code
+     */
+    ConversationApi.prototype.getConversationCannedMessagesRaw = 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/canned_messages",
+                                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.ConversationCannedMessagesResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Retrieve a list of canned messages ordered by short_code
+     * Retrieve a list of canned messages ordered by short_code
+     */
+    ConversationApi.prototype.getConversationCannedMessages = 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.getConversationCannedMessagesRaw(initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Get a webchat conversation context
      * Get a webchat conversation context
@@ -555,6 +611,67 @@ var ConversationApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Insert a canned message
+     * Insert a canned message
+     */
+    ConversationApi.prototype.insertConversationCannedMessageRaw = 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.cannedMessage === null || requestParameters.cannedMessage === undefined) {
+                            throw new runtime.RequiredError('cannedMessage', 'Required parameter requestParameters.cannedMessage was null or undefined when calling insertConversationCannedMessage.');
+                        }
+                        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_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/canned_messages",
+                                method: 'POST',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, models_1.ConversationCannedMessageToJSON)(requestParameters.cannedMessage),
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ConversationCannedMessageResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Insert a canned message
+     * Insert a canned message
+     */
+    ConversationApi.prototype.insertConversationCannedMessage = 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.insertConversationCannedMessageRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Join a conversation
      * Join a conversation
@@ -726,6 +843,67 @@ var ConversationApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Search for canned messages by short_code
+     * Search for canned messages by short_code
+     */
+    ConversationApi.prototype.searchConversationCannedMessagesRaw = 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.searchRequest === null || requestParameters.searchRequest === undefined) {
+                            throw new runtime.RequiredError('searchRequest', 'Required parameter requestParameters.searchRequest was null or undefined when calling searchConversationCannedMessages.');
+                        }
+                        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_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/canned_messages/search",
+                                method: 'POST',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, models_1.ConversationCannedMessagesSearchToJSON)(requestParameters.searchRequest),
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ConversationCannedMessagesResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Search for canned messages by short_code
+     * Search for canned messages by short_code
+     */
+    ConversationApi.prototype.searchConversationCannedMessages = 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.searchConversationCannedMessagesRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Start a new conversation
      * Start a conversation
@@ -787,6 +965,70 @@ var ConversationApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Update a canned message
+     * Update a canned message
+     */
+    ConversationApi.prototype.updateConversationCannedMessageRaw = 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.conversationCannedMessageOid === null || requestParameters.conversationCannedMessageOid === undefined) {
+                            throw new runtime.RequiredError('conversationCannedMessageOid', 'Required parameter requestParameters.conversationCannedMessageOid was null or undefined when calling updateConversationCannedMessage.');
+                        }
+                        if (requestParameters.cannedMessage === null || requestParameters.cannedMessage === undefined) {
+                            throw new runtime.RequiredError('cannedMessage', 'Required parameter requestParameters.cannedMessage was null or undefined when calling updateConversationCannedMessage.');
+                        }
+                        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_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/canned_messages/{conversation_canned_message_oid}".replace("{".concat("conversation_canned_message_oid", "}"), encodeURIComponent(String(requestParameters.conversationCannedMessageOid))),
+                                method: 'PUT',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, models_1.ConversationCannedMessageToJSON)(requestParameters.cannedMessage),
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ConversationCannedMessageResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Update a canned message
+     * Update a canned message
+     */
+    ConversationApi.prototype.updateConversationCannedMessage = 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.updateConversationCannedMessageRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Update status within the queue
      * Update status within the queue

package/dist/models/ConversationCannedMessage.d.ts

@@ -0,0 +1,45 @@
+/**
+ * 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 ConversationCannedMessage
+ */
+export interface ConversationCannedMessage {
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationCannedMessage
+     */
+    canned_message?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ConversationCannedMessage
+     */
+    conversation_canned_message_oid?: number;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof ConversationCannedMessage
+     */
+    conversation_department_oids?: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationCannedMessage
+     */
+    short_code?: string;
+}
+export declare function ConversationCannedMessageFromJSON(json: any): ConversationCannedMessage;
+export declare function ConversationCannedMessageFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationCannedMessage;
+export declare function ConversationCannedMessageToJSON(value?: ConversationCannedMessage | null): any;

package/dist/models/ConversationCannedMessage.js

@@ -0,0 +1,48 @@
+"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.ConversationCannedMessageToJSON = exports.ConversationCannedMessageFromJSONTyped = exports.ConversationCannedMessageFromJSON = void 0;
+var runtime_1 = require("../runtime");
+function ConversationCannedMessageFromJSON(json) {
+    return ConversationCannedMessageFromJSONTyped(json, false);
+}
+exports.ConversationCannedMessageFromJSON = ConversationCannedMessageFromJSON;
+function ConversationCannedMessageFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'canned_message': !(0, runtime_1.exists)(json, 'canned_message') ? undefined : json['canned_message'],
+        'conversation_canned_message_oid': !(0, runtime_1.exists)(json, 'conversation_canned_message_oid') ? undefined : json['conversation_canned_message_oid'],
+        'conversation_department_oids': !(0, runtime_1.exists)(json, 'conversation_department_oids') ? undefined : json['conversation_department_oids'],
+        'short_code': !(0, runtime_1.exists)(json, 'short_code') ? undefined : json['short_code'],
+    };
+}
+exports.ConversationCannedMessageFromJSONTyped = ConversationCannedMessageFromJSONTyped;
+function ConversationCannedMessageToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'canned_message': value.canned_message,
+        'conversation_canned_message_oid': value.conversation_canned_message_oid,
+        'conversation_department_oids': value.conversation_department_oids,
+        'short_code': value.short_code,
+    };
+}
+exports.ConversationCannedMessageToJSON = ConversationCannedMessageToJSON;

package/dist/models/ConversationCannedMessageResponse.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 { ConversationCannedMessage } from './ConversationCannedMessage';
+import { ModelError } from './ModelError';
+import { ResponseMetadata } from './ResponseMetadata';
+import { Warning } from './Warning';
+/**
+ *
+ * @export
+ * @interface ConversationCannedMessageResponse
+ */
+export interface ConversationCannedMessageResponse {
+    /**
+     *
+     * @type {ConversationCannedMessage}
+     * @memberof ConversationCannedMessageResponse
+     */
+    conversation_canned_message?: ConversationCannedMessage;
+    /**
+     *
+     * @type {ModelError}
+     * @memberof ConversationCannedMessageResponse
+     */
+    error?: ModelError;
+    /**
+     *
+     * @type {ResponseMetadata}
+     * @memberof ConversationCannedMessageResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof ConversationCannedMessageResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {Warning}
+     * @memberof ConversationCannedMessageResponse
+     */
+    warning?: Warning;
+}
+export declare function ConversationCannedMessageResponseFromJSON(json: any): ConversationCannedMessageResponse;
+export declare function ConversationCannedMessageResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationCannedMessageResponse;
+export declare function ConversationCannedMessageResponseToJSON(value?: ConversationCannedMessageResponse | null): any;