ultracart_rest_api_v2_typescript 4.1.51 → 4.1.55

package/.openapi-generator/FILES

@@ -219,6 +219,25 @@ src/models/ConversationPbxAudioUsageResponse.ts
 src/models/ConversationPbxAudiosResponse.ts
 src/models/ConversationPbxAvailablePhoneNumber.ts
 src/models/ConversationPbxAvailablePhoneNumbersResponse.ts
+src/models/ConversationPbxCall.ts
+src/models/ConversationPbxCallAgent.ts
+src/models/ConversationPbxCallAiCost.ts
+src/models/ConversationPbxCallAiEngagement.ts
+src/models/ConversationPbxCallAiToolCall.ts
+src/models/ConversationPbxCallAiWhisper.ts
+src/models/ConversationPbxCallCaller.ts
+src/models/ConversationPbxCallFinancial.ts
+src/models/ConversationPbxCallHold.ts
+src/models/ConversationPbxCallQueue.ts
+src/models/ConversationPbxCallRecording.ts
+src/models/ConversationPbxCallResponse.ts
+src/models/ConversationPbxCallRouting.ts
+src/models/ConversationPbxCallSearchRequest.ts
+src/models/ConversationPbxCallSearchResponse.ts
+src/models/ConversationPbxCallTimeline.ts
+src/models/ConversationPbxCallTranscript.ts
+src/models/ConversationPbxCallTranscriptSegment.ts
+src/models/ConversationPbxCallTransfer.ts
 src/models/ConversationPbxCustomerSnapshotRequest.ts
 src/models/ConversationPbxCustomerSnapshotResponse.ts
 src/models/ConversationPbxHardwarePhone.ts

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.51
+## ultracart_rest_api_v2_typescript@4.1.55
 
 Every API method call has a sample for every language SDK.  See https://github.com/UltraCart/sdk_samples
 
 Installation
 
 ```
-npm install ultracart_rest_api_v2_typescript@4.1.51 --save
+npm install ultracart_rest_api_v2_typescript@4.1.55 --save
 ```
 
 ```typescript
@@ -85,6 +85,10 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.55 | 02/02/2026 | conversations - add enumerated values for say voice on queue and agent |
+| 4.1.54 | 02/02/2026 | build error fix |
+| 4.1.53 | 02/02/2026 | conversations default pricing phone number settings |
+| 4.1.52 | 01/31/2026 | conversation - pbx call log objects |
 | 4.1.51 | 01/30/2026 | conversations queue setting for automatic AI coaching |
 | 4.1.50 | 01/27/2026 | conversations - refinements to support hardware phones |
 | 4.1.49 | 01/26/2026 | no changes - testing changes to build automation |

package/dist/apis/ConversationApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { ConversationAgentAuthResponse, ConversationAgentProfile, ConversationAgentProfileResponse, ConversationAgentProfilesResponse, ConversationAutocompleteRequest, ConversationAutocompleteResponse, ConversationCannedMessage, ConversationCannedMessageResponse, ConversationCannedMessagesResponse, ConversationCannedMessagesSearch, ConversationDeleteKnowledgeBaseDocumentResponse, ConversationDepartment, ConversationDepartmentMembersResponse, ConversationDepartmentResponse, ConversationDepartmentsResponse, ConversationEngagement, ConversationEngagementResponse, ConversationEngagementsResponse, ConversationInsertKnowledgeBaseDocumentRequest, ConversationInsertKnowledgeBaseDocumentResponse, ConversationJoinRequest, ConversationKnowledgeBaseDocumentUploadUrlResponse, ConversationKnowledgeBaseDocumentsResponse, ConversationLocationsResponse, ConversationMcpServer, ConversationMcpServerResponse, ConversationMcpServerToolsResponse, ConversationMcpServersResponse, ConversationMessagesResponse, ConversationMultimediaUploadUrlResponse, ConversationPbxAddress, ConversationPbxAddressResponse, ConversationPbxAddressesResponse, ConversationPbxAgent, ConversationPbxAgentResponse, ConversationPbxAgentsResponse, ConversationPbxAudio, ConversationPbxAudioResponse, ConversationPbxAudioUploadUrlResponse, ConversationPbxAudioUsageResponse, ConversationPbxAudiosResponse, ConversationPbxAvailablePhoneNumbersResponse, ConversationPbxCustomerSnapshotRequest, ConversationPbxCustomerSnapshotResponse, ConversationPbxHardwarePhone, ConversationPbxHardwarePhoneResponse, ConversationPbxHardwarePhonesResponse, ConversationPbxMenu, ConversationPbxMenuResponse, ConversationPbxMenusResponse, ConversationPbxPhoneManufacturersResponse, ConversationPbxPhoneNumber, ConversationPbxPhoneNumberPurchaseRequest, ConversationPbxPhoneNumberResponse, ConversationPbxPhoneNumbersResponse, ConversationPbxQueue, ConversationPbxQueueResponse, ConversationPbxQueuesResponse, ConversationPbxTimeBased, ConversationPbxTimeBasedResponse, ConversationPbxTimeBasedsResponse, ConversationPbxTimeRange, ConversationPbxTimeRangeResponse, ConversationPbxTimeRangesResponse, ConversationPbxVoicemailMailbox, ConversationPbxVoicemailMailboxResponse, ConversationPbxVoicemailMailboxesResponse, ConversationPbxVoicemailMessageResponse, ConversationPbxVoicemailMessageSummariesResponse, ConversationPermissionsResponse, ConversationResponse, ConversationSearchRequest, ConversationSearchResponse, ConversationStartRequest, ConversationStartResponse, ConversationVirtualAgentBudget, ConversationVirtualAgentBudgetResponse, ConversationVirtualAgentCapabilities, ConversationVirtualAgentCapabilitiesResponse, ConversationWebchatContext, ConversationWebchatQueueStatusUpdateRequest, ConversationWebchatQueueStatusesResponse, ConversationsResponse } from '../models';
+import { ConversationAgentAuthResponse, ConversationAgentProfile, ConversationAgentProfileResponse, ConversationAgentProfilesResponse, ConversationAutocompleteRequest, ConversationAutocompleteResponse, ConversationCannedMessage, ConversationCannedMessageResponse, ConversationCannedMessagesResponse, ConversationCannedMessagesSearch, ConversationDeleteKnowledgeBaseDocumentResponse, ConversationDepartment, ConversationDepartmentMembersResponse, ConversationDepartmentResponse, ConversationDepartmentsResponse, ConversationEngagement, ConversationEngagementResponse, ConversationEngagementsResponse, ConversationInsertKnowledgeBaseDocumentRequest, ConversationInsertKnowledgeBaseDocumentResponse, ConversationJoinRequest, ConversationKnowledgeBaseDocumentUploadUrlResponse, ConversationKnowledgeBaseDocumentsResponse, ConversationLocationsResponse, ConversationMcpServer, ConversationMcpServerResponse, ConversationMcpServerToolsResponse, ConversationMcpServersResponse, ConversationMessagesResponse, ConversationMultimediaUploadUrlResponse, ConversationPbxAddress, ConversationPbxAddressResponse, ConversationPbxAddressesResponse, ConversationPbxAgent, ConversationPbxAgentResponse, ConversationPbxAgentsResponse, ConversationPbxAudio, ConversationPbxAudioResponse, ConversationPbxAudioUploadUrlResponse, ConversationPbxAudioUsageResponse, ConversationPbxAudiosResponse, ConversationPbxAvailablePhoneNumbersResponse, ConversationPbxCallResponse, ConversationPbxCallSearchRequest, ConversationPbxCallSearchResponse, ConversationPbxCustomerSnapshotRequest, ConversationPbxCustomerSnapshotResponse, ConversationPbxHardwarePhone, ConversationPbxHardwarePhoneResponse, ConversationPbxHardwarePhonesResponse, ConversationPbxMenu, ConversationPbxMenuResponse, ConversationPbxMenusResponse, ConversationPbxPhoneManufacturersResponse, ConversationPbxPhoneNumber, ConversationPbxPhoneNumberPurchaseRequest, ConversationPbxPhoneNumberResponse, ConversationPbxPhoneNumbersResponse, ConversationPbxQueue, ConversationPbxQueueResponse, ConversationPbxQueuesResponse, ConversationPbxTimeBased, ConversationPbxTimeBasedResponse, ConversationPbxTimeBasedsResponse, ConversationPbxTimeRange, ConversationPbxTimeRangeResponse, ConversationPbxTimeRangesResponse, ConversationPbxVoicemailMailbox, ConversationPbxVoicemailMailboxResponse, ConversationPbxVoicemailMailboxesResponse, ConversationPbxVoicemailMessageResponse, ConversationPbxVoicemailMessageSummariesResponse, ConversationPermissionsResponse, ConversationResponse, ConversationSearchRequest, ConversationSearchResponse, ConversationStartRequest, ConversationStartResponse, ConversationVirtualAgentBudget, ConversationVirtualAgentBudgetResponse, ConversationVirtualAgentCapabilities, ConversationVirtualAgentCapabilitiesResponse, ConversationWebchatContext, ConversationWebchatQueueStatusUpdateRequest, ConversationWebchatQueueStatusesResponse, ConversationsResponse } from '../models';
 export interface DeleteAgentProfileKnowledgeBaseDocumentRequest {
     userId: number;
     documentUuid: string;
@@ -131,6 +131,9 @@ export interface GetPbxAudioRequest {
 export interface GetPbxAudioUsageRequest {
     conversationPbxAudioUuid: string;
 }
+export interface GetPbxCallRequest {
+    callUuid: string;
+}
 export interface GetPbxHardwarePhoneRequest {
     conversationPbxHardwarePhoneUuid: string;
 }
@@ -242,6 +245,12 @@ export interface SearchPbxAvailablePhoneNumbersRequest {
     type?: string;
     limit?: number;
 }
+export interface SearchPbxCallsRequest {
+    searchRequest: ConversationPbxCallSearchRequest;
+    limit?: number;
+    offset?: number;
+    sort?: string;
+}
 export interface SmsUnsubscribeConversationRequest {
     conversationUuid: string;
 }
@@ -1036,6 +1045,20 @@ export interface ConversationApiInterface {
      * Get pbx audios
      */
     getPbxAudios(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxAudiosResponse>;
+    /**
+     * Retrieve a single PBX call record with full details
+     * @summary Get pbx call record
+     * @param {string} callUuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getPbxCallRaw(requestParameters: GetPbxCallRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxCallResponse>>;
+    /**
+     * Retrieve a single PBX call record with full details
+     * Get pbx call record
+     */
+    getPbxCall(requestParameters: GetPbxCallRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxCallResponse>;
     /**
      * Retrieve a pbx hardware phone
      * @summary Get pbx hardware phone
@@ -1640,6 +1663,23 @@ export interface ConversationApiInterface {
      * Search for available phone numbers
      */
     searchPbxAvailablePhoneNumbers(requestParameters: SearchPbxAvailablePhoneNumbersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxAvailablePhoneNumbersResponse>;
+    /**
+     * Search and list PBX call records with filtering, sorting, and pagination
+     * @summary Search pbx call records
+     * @param {ConversationPbxCallSearchRequest} searchRequest Search Request
+     * @param {number} [limit] The maximum number of records to return on this one API call. (Maximum 200)
+     * @param {number} [offset] Pagination of the record set.  Offset is a zero based index.
+     * @param {string} [sort] The sort order of the calls.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    searchPbxCallsRaw(requestParameters: SearchPbxCallsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxCallSearchResponse>>;
+    /**
+     * Search and list PBX call records with filtering, sorting, and pagination
+     * Search pbx call records
+     */
+    searchPbxCalls(requestParameters: SearchPbxCallsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxCallSearchResponse>;
     /**
      * Unsubscribe any SMS participants in this conversation
      * @summary Unsubscribe any SMS participants in this conversation
@@ -2451,6 +2491,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
      * Get pbx audios
      */
     getPbxAudios(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxAudiosResponse>;
+    /**
+     * Retrieve a single PBX call record with full details
+     * Get pbx call record
+     */
+    getPbxCallRaw(requestParameters: GetPbxCallRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxCallResponse>>;
+    /**
+     * Retrieve a single PBX call record with full details
+     * Get pbx call record
+     */
+    getPbxCall(requestParameters: GetPbxCallRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxCallResponse>;
     /**
      * Retrieve a pbx hardware phone
      * Get pbx hardware phone
@@ -2881,6 +2931,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
      * Search for available phone numbers
      */
     searchPbxAvailablePhoneNumbers(requestParameters: SearchPbxAvailablePhoneNumbersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxAvailablePhoneNumbersResponse>;
+    /**
+     * Search and list PBX call records with filtering, sorting, and pagination
+     * Search pbx call records
+     */
+    searchPbxCallsRaw(requestParameters: SearchPbxCallsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxCallSearchResponse>>;
+    /**
+     * Search and list PBX call records with filtering, sorting, and pagination
+     * Search pbx call records
+     */
+    searchPbxCalls(requestParameters: SearchPbxCallsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxCallSearchResponse>;
     /**
      * Unsubscribe any SMS participants in this conversation
      * Unsubscribe any SMS participants in this conversation

package/dist/apis/ConversationApi.js

@@ -3066,6 +3066,65 @@ var ConversationApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Retrieve a single PBX call record with full details
+     * Get pbx call record
+     */
+    ConversationApi.prototype.getPbxCallRaw = 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.callUuid === null || requestParameters.callUuid === undefined) {
+                            throw new runtime.RequiredError('callUuid', 'Required parameter requestParameters.callUuid was null or undefined when calling getPbxCall.');
+                        }
+                        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/pbx/call/{callUuid}".replace("{".concat("callUuid", "}"), encodeURIComponent(String(requestParameters.callUuid))),
+                                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.ConversationPbxCallResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Retrieve a single PBX call record with full details
+     * Get pbx call record
+     */
+    ConversationApi.prototype.getPbxCall = 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.getPbxCallRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Retrieve a pbx hardware phone
      * Get pbx hardware phone
@@ -5631,6 +5690,76 @@ var ConversationApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Search and list PBX call records with filtering, sorting, and pagination
+     * Search pbx call records
+     */
+    ConversationApi.prototype.searchPbxCallsRaw = 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 searchPbxCalls.');
+                        }
+                        queryParameters = {};
+                        if (requestParameters.limit !== undefined) {
+                            queryParameters['_limit'] = requestParameters.limit;
+                        }
+                        if (requestParameters.offset !== undefined) {
+                            queryParameters['_offset'] = requestParameters.offset;
+                        }
+                        if (requestParameters.sort !== undefined) {
+                            queryParameters['_sort'] = requestParameters.sort;
+                        }
+                        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/pbx/call/search",
+                                method: 'POST',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, models_1.ConversationPbxCallSearchRequestToJSON)(requestParameters.searchRequest),
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ConversationPbxCallSearchResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Search and list PBX call records with filtering, sorting, and pagination
+     * Search pbx call records
+     */
+    ConversationApi.prototype.searchPbxCalls = 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.searchPbxCallsRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Unsubscribe any SMS participants in this conversation
      * Unsubscribe any SMS participants in this conversation

package/dist/models/ConversationPbxAgent.d.ts

@@ -39,6 +39,12 @@ export interface ConversationPbxAgent {
      * @memberof ConversationPbxAgent
      */
     conversation_pbx_agent_uuid?: string;
+    /**
+     * The default phone number that this agent should dial out to the PSTN with.
+     * @type {string}
+     * @memberof ConversationPbxAgent
+     */
+    default_phone_number_uuid?: string;
     /**
      * Extension
      * @type {number}

package/dist/models/ConversationPbxAgent.js

@@ -44,6 +44,7 @@ function ConversationPbxAgentFromJSONTyped(json, ignoreDiscriminator) {
         'call_routing_preference': !(0, runtime_1.exists)(json, 'call_routing_preference') ? undefined : json['call_routing_preference'],
         'cellphone': !(0, runtime_1.exists)(json, 'cellphone') ? undefined : json['cellphone'],
         'conversation_pbx_agent_uuid': !(0, runtime_1.exists)(json, 'conversation_pbx_agent_uuid') ? undefined : json['conversation_pbx_agent_uuid'],
+        'default_phone_number_uuid': !(0, runtime_1.exists)(json, 'default_phone_number_uuid') ? undefined : json['default_phone_number_uuid'],
         'extension': !(0, runtime_1.exists)(json, 'extension') ? undefined : json['extension'],
         'full_name': !(0, runtime_1.exists)(json, 'full_name') ? undefined : json['full_name'],
         'hardware_phone_uuids': !(0, runtime_1.exists)(json, 'hardware_phone_uuids') ? undefined : json['hardware_phone_uuids'],
@@ -74,6 +75,7 @@ function ConversationPbxAgentToJSON(value) {
         'call_routing_preference': value.call_routing_preference,
         'cellphone': value.cellphone,
         'conversation_pbx_agent_uuid': value.conversation_pbx_agent_uuid,
+        'default_phone_number_uuid': value.default_phone_number_uuid,
         'extension': value.extension,
         'full_name': value.full_name,
         'hardware_phone_uuids': value.hardware_phone_uuids,

package/dist/models/ConversationPbxCall.d.ts

@@ -0,0 +1,166 @@
+/**
+ * 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 { ConversationPbxCallAgent } from './ConversationPbxCallAgent';
+import { ConversationPbxCallAiEngagement } from './ConversationPbxCallAiEngagement';
+import { ConversationPbxCallCaller } from './ConversationPbxCallCaller';
+import { ConversationPbxCallFinancial } from './ConversationPbxCallFinancial';
+import { ConversationPbxCallHold } from './ConversationPbxCallHold';
+import { ConversationPbxCallRecording } from './ConversationPbxCallRecording';
+import { ConversationPbxCallRouting } from './ConversationPbxCallRouting';
+import { ConversationPbxCallTimeline } from './ConversationPbxCallTimeline';
+import { ConversationPbxCallTransfer } from './ConversationPbxCallTransfer';
+/**
+ *
+ * @export
+ * @interface ConversationPbxCall
+ */
+export interface ConversationPbxCall {
+    /**
+     * Twilio account SID
+     * @type {string}
+     * @memberof ConversationPbxCall
+     */
+    account_sid?: string;
+    /**
+     * List of agents who participated in this call
+     * @type {Array<ConversationPbxCallAgent>}
+     * @memberof ConversationPbxCall
+     */
+    agents?: Array<ConversationPbxCallAgent>;
+    /**
+     * List of AI agent engagements during the call
+     * @type {Array<ConversationPbxCallAiEngagement>}
+     * @memberof ConversationPbxCall
+     */
+    ai_agent_engagements?: Array<ConversationPbxCallAiEngagement>;
+    /**
+     * Twilio call SID for the primary (customer) call leg
+     * @type {string}
+     * @memberof ConversationPbxCall
+     */
+    call_sid?: string;
+    /**
+     * Unique identifier for this call record
+     * @type {string}
+     * @memberof ConversationPbxCall
+     */
+    call_uuid?: string;
+    /**
+     *
+     * @type {ConversationPbxCallCaller}
+     * @memberof ConversationPbxCall
+     */
+    caller?: ConversationPbxCallCaller;
+    /**
+     * Twilio conference SID if this call used conferencing
+     * @type {string}
+     * @memberof ConversationPbxCall
+     */
+    conference_sid?: string;
+    /**
+     * Timestamp when the call record was created
+     * @type {string}
+     * @memberof ConversationPbxCall
+     */
+    created_at_dts?: string;
+    /**
+     * Customer name associated with this call
+     * @type {string}
+     * @memberof ConversationPbxCall
+     */
+    customer_name?: string;
+    /**
+     * UltraCart customer profile OID if the caller was matched to a customer
+     * @type {string}
+     * @memberof ConversationPbxCall
+     */
+    customer_profile_oid?: string;
+    /**
+     * Call disposition describing how the call ended
+     * @type {string}
+     * @memberof ConversationPbxCall
+     */
+    disposition?: string;
+    /**
+     * Email address of the caller if known
+     * @type {string}
+     * @memberof ConversationPbxCall
+     */
+    email?: string;
+    /**
+     *
+     * @type {ConversationPbxCallFinancial}
+     * @memberof ConversationPbxCall
+     */
+    financial?: ConversationPbxCallFinancial;
+    /**
+     * List of hold events during the call
+     * @type {Array<ConversationPbxCallHold>}
+     * @memberof ConversationPbxCall
+     */
+    holds?: Array<ConversationPbxCallHold>;
+    /**
+     * Merchant identifier
+     * @type {string}
+     * @memberof ConversationPbxCall
+     */
+    merchant_id?: string;
+    /**
+     * List of all Twilio recording SIDs associated with this call
+     * @type {Array<string>}
+     * @memberof ConversationPbxCall
+     */
+    recording_sids?: Array<string>;
+    /**
+     * List of recordings made during the call
+     * @type {Array<ConversationPbxCallRecording>}
+     * @memberof ConversationPbxCall
+     */
+    recordings?: Array<ConversationPbxCallRecording>;
+    /**
+     *
+     * @type {ConversationPbxCallRouting}
+     * @memberof ConversationPbxCall
+     */
+    routing?: ConversationPbxCallRouting;
+    /**
+     * Final status of the call
+     * @type {string}
+     * @memberof ConversationPbxCall
+     */
+    status?: string;
+    /**
+     *
+     * @type {ConversationPbxCallTimeline}
+     * @memberof ConversationPbxCall
+     */
+    timeline?: ConversationPbxCallTimeline;
+    /**
+     * List of transfer events during the call
+     * @type {Array<ConversationPbxCallTransfer>}
+     * @memberof ConversationPbxCall
+     */
+    transfers?: Array<ConversationPbxCallTransfer>;
+    /**
+     * Timestamp when the call record was last updated
+     * @type {string}
+     * @memberof ConversationPbxCall
+     */
+    updated_at_dts?: string;
+}
+/**
+ * Check if a given object implements the ConversationPbxCall interface.
+ */
+export declare function instanceOfConversationPbxCall(value: object): boolean;
+export declare function ConversationPbxCallFromJSON(json: any): ConversationPbxCall;
+export declare function ConversationPbxCallFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationPbxCall;
+export declare function ConversationPbxCallToJSON(value?: ConversationPbxCall | null): any;

package/dist/models/ConversationPbxCall.js

@@ -0,0 +1,101 @@
+"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.ConversationPbxCallToJSON = exports.ConversationPbxCallFromJSONTyped = exports.ConversationPbxCallFromJSON = exports.instanceOfConversationPbxCall = void 0;
+var runtime_1 = require("../runtime");
+var ConversationPbxCallAgent_1 = require("./ConversationPbxCallAgent");
+var ConversationPbxCallAiEngagement_1 = require("./ConversationPbxCallAiEngagement");
+var ConversationPbxCallCaller_1 = require("./ConversationPbxCallCaller");
+var ConversationPbxCallFinancial_1 = require("./ConversationPbxCallFinancial");
+var ConversationPbxCallHold_1 = require("./ConversationPbxCallHold");
+var ConversationPbxCallRecording_1 = require("./ConversationPbxCallRecording");
+var ConversationPbxCallRouting_1 = require("./ConversationPbxCallRouting");
+var ConversationPbxCallTimeline_1 = require("./ConversationPbxCallTimeline");
+var ConversationPbxCallTransfer_1 = require("./ConversationPbxCallTransfer");
+/**
+ * Check if a given object implements the ConversationPbxCall interface.
+ */
+function instanceOfConversationPbxCall(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfConversationPbxCall = instanceOfConversationPbxCall;
+function ConversationPbxCallFromJSON(json) {
+    return ConversationPbxCallFromJSONTyped(json, false);
+}
+exports.ConversationPbxCallFromJSON = ConversationPbxCallFromJSON;
+function ConversationPbxCallFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'account_sid': !(0, runtime_1.exists)(json, 'account_sid') ? undefined : json['account_sid'],
+        'agents': !(0, runtime_1.exists)(json, 'agents') ? undefined : (json['agents'].map(ConversationPbxCallAgent_1.ConversationPbxCallAgentFromJSON)),
+        'ai_agent_engagements': !(0, runtime_1.exists)(json, 'ai_agent_engagements') ? undefined : (json['ai_agent_engagements'].map(ConversationPbxCallAiEngagement_1.ConversationPbxCallAiEngagementFromJSON)),
+        'call_sid': !(0, runtime_1.exists)(json, 'call_sid') ? undefined : json['call_sid'],
+        'call_uuid': !(0, runtime_1.exists)(json, 'call_uuid') ? undefined : json['call_uuid'],
+        'caller': !(0, runtime_1.exists)(json, 'caller') ? undefined : (0, ConversationPbxCallCaller_1.ConversationPbxCallCallerFromJSON)(json['caller']),
+        'conference_sid': !(0, runtime_1.exists)(json, 'conference_sid') ? undefined : json['conference_sid'],
+        'created_at_dts': !(0, runtime_1.exists)(json, 'created_at_dts') ? undefined : json['created_at_dts'],
+        'customer_name': !(0, runtime_1.exists)(json, 'customer_name') ? undefined : json['customer_name'],
+        'customer_profile_oid': !(0, runtime_1.exists)(json, 'customer_profile_oid') ? undefined : json['customer_profile_oid'],
+        'disposition': !(0, runtime_1.exists)(json, 'disposition') ? undefined : json['disposition'],
+        'email': !(0, runtime_1.exists)(json, 'email') ? undefined : json['email'],
+        'financial': !(0, runtime_1.exists)(json, 'financial') ? undefined : (0, ConversationPbxCallFinancial_1.ConversationPbxCallFinancialFromJSON)(json['financial']),
+        'holds': !(0, runtime_1.exists)(json, 'holds') ? undefined : (json['holds'].map(ConversationPbxCallHold_1.ConversationPbxCallHoldFromJSON)),
+        'merchant_id': !(0, runtime_1.exists)(json, 'merchant_id') ? undefined : json['merchant_id'],
+        'recording_sids': !(0, runtime_1.exists)(json, 'recording_sids') ? undefined : json['recording_sids'],
+        'recordings': !(0, runtime_1.exists)(json, 'recordings') ? undefined : (json['recordings'].map(ConversationPbxCallRecording_1.ConversationPbxCallRecordingFromJSON)),
+        'routing': !(0, runtime_1.exists)(json, 'routing') ? undefined : (0, ConversationPbxCallRouting_1.ConversationPbxCallRoutingFromJSON)(json['routing']),
+        'status': !(0, runtime_1.exists)(json, 'status') ? undefined : json['status'],
+        'timeline': !(0, runtime_1.exists)(json, 'timeline') ? undefined : (0, ConversationPbxCallTimeline_1.ConversationPbxCallTimelineFromJSON)(json['timeline']),
+        'transfers': !(0, runtime_1.exists)(json, 'transfers') ? undefined : (json['transfers'].map(ConversationPbxCallTransfer_1.ConversationPbxCallTransferFromJSON)),
+        'updated_at_dts': !(0, runtime_1.exists)(json, 'updated_at_dts') ? undefined : json['updated_at_dts'],
+    };
+}
+exports.ConversationPbxCallFromJSONTyped = ConversationPbxCallFromJSONTyped;
+function ConversationPbxCallToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'account_sid': value.account_sid,
+        'agents': value.agents === undefined ? undefined : (value.agents.map(ConversationPbxCallAgent_1.ConversationPbxCallAgentToJSON)),
+        'ai_agent_engagements': value.ai_agent_engagements === undefined ? undefined : (value.ai_agent_engagements.map(ConversationPbxCallAiEngagement_1.ConversationPbxCallAiEngagementToJSON)),
+        'call_sid': value.call_sid,
+        'call_uuid': value.call_uuid,
+        'caller': (0, ConversationPbxCallCaller_1.ConversationPbxCallCallerToJSON)(value.caller),
+        'conference_sid': value.conference_sid,
+        'created_at_dts': value.created_at_dts,
+        'customer_name': value.customer_name,
+        'customer_profile_oid': value.customer_profile_oid,
+        'disposition': value.disposition,
+        'email': value.email,
+        'financial': (0, ConversationPbxCallFinancial_1.ConversationPbxCallFinancialToJSON)(value.financial),
+        'holds': value.holds === undefined ? undefined : (value.holds.map(ConversationPbxCallHold_1.ConversationPbxCallHoldToJSON)),
+        'merchant_id': value.merchant_id,
+        'recording_sids': value.recording_sids,
+        'recordings': value.recordings === undefined ? undefined : (value.recordings.map(ConversationPbxCallRecording_1.ConversationPbxCallRecordingToJSON)),
+        'routing': (0, ConversationPbxCallRouting_1.ConversationPbxCallRoutingToJSON)(value.routing),
+        'status': value.status,
+        'timeline': (0, ConversationPbxCallTimeline_1.ConversationPbxCallTimelineToJSON)(value.timeline),
+        'transfers': value.transfers === undefined ? undefined : (value.transfers.map(ConversationPbxCallTransfer_1.ConversationPbxCallTransferToJSON)),
+        'updated_at_dts': value.updated_at_dts,
+    };
+}
+exports.ConversationPbxCallToJSON = ConversationPbxCallToJSON;