ultracart_rest_api_v2_typescript 4.0.96-RC → 4.0.98-RC

package/.openapi-generator/FILES

@@ -144,10 +144,18 @@ src/models/CityStateZip.ts
 src/models/Conversation.ts
 src/models/ConversationAgentAuth.ts
 src/models/ConversationAgentAuthResponse.ts
+src/models/ConversationAutocompleteRequest.ts
+src/models/ConversationAutocompleteResponse.ts
 src/models/ConversationCannedMessage.ts
 src/models/ConversationCannedMessageResponse.ts
 src/models/ConversationCannedMessagesResponse.ts
 src/models/ConversationCannedMessagesSearch.ts
+src/models/ConversationDepartment.ts
+src/models/ConversationDepartmentResponse.ts
+src/models/ConversationDepartmentsResponse.ts
+src/models/ConversationEngagement.ts
+src/models/ConversationEngagementResponse.ts
+src/models/ConversationEngagementsResponse.ts
 src/models/ConversationEventAddCoupon.ts
 src/models/ConversationEventAddItem.ts
 src/models/ConversationEventQueuePosition.ts
@@ -155,6 +163,7 @@ src/models/ConversationEventRRWeb.ts
 src/models/ConversationEventReadMessage.ts
 src/models/ConversationEventTyping.ts
 src/models/ConversationEventWebchatContext.ts
+src/models/ConversationJoinRequest.ts
 src/models/ConversationMessage.ts
 src/models/ConversationMessageTranslation.ts
 src/models/ConversationMessageTransportStatus.ts
@@ -163,6 +172,8 @@ src/models/ConversationMultimediaUploadUrl.ts
 src/models/ConversationMultimediaUploadUrlResponse.ts
 src/models/ConversationParticipant.ts
 src/models/ConversationResponse.ts
+src/models/ConversationSearchRequest.ts
+src/models/ConversationSearchResponse.ts
 src/models/ConversationStartRequest.ts
 src/models/ConversationStartResponse.ts
 src/models/ConversationSummary.ts

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@4.0.96-RC
+## ultracart_rest_api_v2_typescript@4.0.98-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.96-RC --save
+npm install ultracart_rest_api_v2_typescript@4.0.98-RC --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.98-RC | 12/15/2022 | conversation searching |
+| 4.0.97-RC | 12/13/2022 | conversations - add email and sms_phone to participant object |
 | 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 |

package/dist/apis/ConversationApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { ConversationAgentAuthResponse, ConversationCannedMessage, ConversationCannedMessageResponse, ConversationCannedMessagesResponse, ConversationCannedMessagesSearch, ConversationMessagesResponse, ConversationMultimediaUploadUrlResponse, ConversationResponse, ConversationStartRequest, ConversationStartResponse, ConversationWebchatContext, ConversationWebchatQueueStatusUpdateRequest, ConversationWebchatQueueStatusesResponse, ConversationsResponse } from '../models';
+import { ConversationAgentAuthResponse, ConversationAutocompleteRequest, ConversationAutocompleteResponse, ConversationCannedMessage, ConversationCannedMessageResponse, ConversationCannedMessagesResponse, ConversationCannedMessagesSearch, ConversationDepartment, ConversationDepartmentResponse, ConversationDepartmentsResponse, ConversationEngagement, ConversationEngagementResponse, ConversationEngagementsResponse, ConversationJoinRequest, ConversationMessagesResponse, ConversationMultimediaUploadUrlResponse, ConversationResponse, ConversationSearchRequest, ConversationSearchResponse, ConversationStartRequest, ConversationStartResponse, ConversationWebchatContext, ConversationWebchatQueueStatusUpdateRequest, ConversationWebchatQueueStatusesResponse, ConversationsResponse } from '../models';
 export interface GetConversationRequest {
     conversationUuid: string;
     limit?: number;
@@ -32,11 +32,24 @@ export interface GetConversationsRequest {
     limit?: number;
     offset?: number;
 }
+export interface GetConversationsAutocompleteRequest {
+    autocompleteRequest: ConversationAutocompleteRequest;
+}
+export interface GetConversationsSearchRequest {
+    searchRequest: ConversationSearchRequest;
+}
 export interface InsertConversationCannedMessageRequest {
     cannedMessage: ConversationCannedMessage;
 }
+export interface InsertConversationDepartmentRequest {
+    department: ConversationDepartment;
+}
+export interface InsertConversationEngagementRequest {
+    engagement: ConversationEngagement;
+}
 export interface JoinConversationRequest {
     conversationUuid: string;
+    joinRequest?: ConversationJoinRequest;
 }
 export interface LeaveConversationRequest {
     conversationUuid: string;
@@ -54,6 +67,14 @@ export interface UpdateConversationCannedMessageRequest {
     conversationCannedMessageOid: number;
     cannedMessage: ConversationCannedMessage;
 }
+export interface UpdateConversationDepartmentRequest {
+    conversationDepartmentOid: number;
+    department: ConversationDepartment;
+}
+export interface UpdateConversationEngagementRequest {
+    conversationEngagementOid: number;
+    engagement: ConversationEngagement;
+}
 export interface UpdateConversationWebchatQueueStatusRequest {
     queueName: string;
     statusRequest: ConversationWebchatQueueStatusUpdateRequest;
@@ -133,6 +154,32 @@ export interface ConversationApiInterface {
      * Get a webchat conversation context
      */
     getConversationContext(requestParameters: GetConversationContextRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationWebchatContext>;
+    /**
+     * Retrieve a list of departments ordered by name
+     * @summary Retrieve a list of departments ordered by name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getConversationDepartmentsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationDepartmentsResponse>>;
+    /**
+     * Retrieve a list of departments ordered by name
+     * Retrieve a list of departments ordered by name
+     */
+    getConversationDepartments(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationDepartmentsResponse>;
+    /**
+     * Retrieve a list of engagements ordered by name
+     * @summary Retrieve a list of engagements ordered by name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getConversationEngagementsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationEngagementsResponse>>;
+    /**
+     * Retrieve a list of engagements ordered by name
+     * Retrieve a list of engagements ordered by name
+     */
+    getConversationEngagements(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationEngagementsResponse>;
     /**
      * Retrieve conversation messages since a particular time
      * @summary Retrieve conversation messages
@@ -193,6 +240,34 @@ export interface ConversationApiInterface {
      * Retrieve a list of conversation summaries newest to oldest
      */
     getConversations(requestParameters: GetConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationsResponse>;
+    /**
+     * Retrieve a list of matching terms for a search field
+     * @summary Retrieve a list of matching terms for a search field
+     * @param {ConversationAutocompleteRequest} autocompleteRequest Autocomplete Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getConversationsAutocompleteRaw(requestParameters: GetConversationsAutocompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationAutocompleteResponse>>;
+    /**
+     * Retrieve a list of matching terms for a search field
+     * Retrieve a list of matching terms for a search field
+     */
+    getConversationsAutocomplete(requestParameters: GetConversationsAutocompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAutocompleteResponse>;
+    /**
+     * Search conversations
+     * @summary Search conversations
+     * @param {ConversationSearchRequest} searchRequest Search Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getConversationsSearchRaw(requestParameters: GetConversationsSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationSearchResponse>>;
+    /**
+     * Search conversations
+     * Search conversations
+     */
+    getConversationsSearch(requestParameters: GetConversationsSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationSearchResponse>;
     /**
      * Insert a canned message
      * @summary Insert a canned message
@@ -207,10 +282,39 @@ export interface ConversationApiInterface {
      * Insert a canned message
      */
     insertConversationCannedMessage(requestParameters: InsertConversationCannedMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationCannedMessageResponse>;
+    /**
+     * Insert a department
+     * @summary Insert a department
+     * @param {ConversationDepartment} department Department
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    insertConversationDepartmentRaw(requestParameters: InsertConversationDepartmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationDepartmentResponse>>;
+    /**
+     * Insert a department
+     * Insert a department
+     */
+    insertConversationDepartment(requestParameters: InsertConversationDepartmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationDepartmentResponse>;
+    /**
+     * Insert a engagement
+     * @summary Insert a engagement
+     * @param {ConversationEngagement} engagement Engagement
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    insertConversationEngagementRaw(requestParameters: InsertConversationEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationEngagementResponse>>;
+    /**
+     * Insert a engagement
+     * Insert a engagement
+     */
+    insertConversationEngagement(requestParameters: InsertConversationEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationEngagementResponse>;
     /**
      * Join a conversation
      * @summary Join a conversation
      * @param {string} conversationUuid
+     * @param {ConversationJoinRequest} [joinRequest] Join request
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ConversationApiInterface
@@ -292,6 +396,36 @@ export interface ConversationApiInterface {
      * Update a canned message
      */
     updateConversationCannedMessage(requestParameters: UpdateConversationCannedMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationCannedMessageResponse>;
+    /**
+     * Update a department
+     * @summary Update a department
+     * @param {number} conversationDepartmentOid
+     * @param {ConversationDepartment} department Department
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    updateConversationDepartmentRaw(requestParameters: UpdateConversationDepartmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationDepartmentResponse>>;
+    /**
+     * Update a department
+     * Update a department
+     */
+    updateConversationDepartment(requestParameters: UpdateConversationDepartmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationDepartmentResponse>;
+    /**
+     * Update a engagement
+     * @summary Update a engagement
+     * @param {number} conversationEngagementOid
+     * @param {ConversationEngagement} engagement Engagement
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    updateConversationEngagementRaw(requestParameters: UpdateConversationEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationEngagementResponse>>;
+    /**
+     * Update a engagement
+     * Update a engagement
+     */
+    updateConversationEngagement(requestParameters: UpdateConversationEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationEngagementResponse>;
     /**
      * Update status within the queue
      * @summary Update status within the queue
@@ -362,6 +496,26 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
      * Get a webchat conversation context
      */
     getConversationContext(requestParameters: GetConversationContextRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationWebchatContext>;
+    /**
+     * Retrieve a list of departments ordered by name
+     * Retrieve a list of departments ordered by name
+     */
+    getConversationDepartmentsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationDepartmentsResponse>>;
+    /**
+     * Retrieve a list of departments ordered by name
+     * Retrieve a list of departments ordered by name
+     */
+    getConversationDepartments(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationDepartmentsResponse>;
+    /**
+     * Retrieve a list of engagements ordered by name
+     * Retrieve a list of engagements ordered by name
+     */
+    getConversationEngagementsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationEngagementsResponse>>;
+    /**
+     * Retrieve a list of engagements ordered by name
+     * Retrieve a list of engagements ordered by name
+     */
+    getConversationEngagements(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationEngagementsResponse>;
     /**
      * Retrieve conversation messages since a particular time
      * Retrieve conversation messages
@@ -402,6 +556,26 @@ 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>;
+    /**
+     * Retrieve a list of matching terms for a search field
+     * Retrieve a list of matching terms for a search field
+     */
+    getConversationsAutocompleteRaw(requestParameters: GetConversationsAutocompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationAutocompleteResponse>>;
+    /**
+     * Retrieve a list of matching terms for a search field
+     * Retrieve a list of matching terms for a search field
+     */
+    getConversationsAutocomplete(requestParameters: GetConversationsAutocompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAutocompleteResponse>;
+    /**
+     * Search conversations
+     * Search conversations
+     */
+    getConversationsSearchRaw(requestParameters: GetConversationsSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationSearchResponse>>;
+    /**
+     * Search conversations
+     * Search conversations
+     */
+    getConversationsSearch(requestParameters: GetConversationsSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationSearchResponse>;
     /**
      * Insert a canned message
      * Insert a canned message
@@ -412,6 +586,26 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
      * Insert a canned message
      */
     insertConversationCannedMessage(requestParameters: InsertConversationCannedMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationCannedMessageResponse>;
+    /**
+     * Insert a department
+     * Insert a department
+     */
+    insertConversationDepartmentRaw(requestParameters: InsertConversationDepartmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationDepartmentResponse>>;
+    /**
+     * Insert a department
+     * Insert a department
+     */
+    insertConversationDepartment(requestParameters: InsertConversationDepartmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationDepartmentResponse>;
+    /**
+     * Insert a engagement
+     * Insert a engagement
+     */
+    insertConversationEngagementRaw(requestParameters: InsertConversationEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationEngagementResponse>>;
+    /**
+     * Insert a engagement
+     * Insert a engagement
+     */
+    insertConversationEngagement(requestParameters: InsertConversationEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationEngagementResponse>;
     /**
      * Join a conversation
      * Join a conversation
@@ -472,6 +666,26 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
      * Update a canned message
      */
     updateConversationCannedMessage(requestParameters: UpdateConversationCannedMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationCannedMessageResponse>;
+    /**
+     * Update a department
+     * Update a department
+     */
+    updateConversationDepartmentRaw(requestParameters: UpdateConversationDepartmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationDepartmentResponse>>;
+    /**
+     * Update a department
+     * Update a department
+     */
+    updateConversationDepartment(requestParameters: UpdateConversationDepartmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationDepartmentResponse>;
+    /**
+     * Update a engagement
+     * Update a engagement
+     */
+    updateConversationEngagementRaw(requestParameters: UpdateConversationEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationEngagementResponse>>;
+    /**
+     * Update a engagement
+     * Update a engagement
+     */
+    updateConversationEngagement(requestParameters: UpdateConversationEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationEngagementResponse>;
     /**
      * Update status within the queue
      * Update status within the queue