ultracart_rest_api_v2_typescript 4.1.71 → 4.1.73

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -226,6 +226,7 @@ src/models/ConversationPbxCall.ts
226
226
  src/models/ConversationPbxCallAgent.ts
227
227
  src/models/ConversationPbxCallAiCost.ts
228
228
  src/models/ConversationPbxCallAiEngagement.ts
229
+ src/models/ConversationPbxCallAiSummary.ts
229
230
  src/models/ConversationPbxCallAiToolCall.ts
230
231
  src/models/ConversationPbxCallAiWhisper.ts
231
232
  src/models/ConversationPbxCallCaller.ts
@@ -275,6 +276,7 @@ src/models/ConversationPbxTimeRange.ts
275
276
  src/models/ConversationPbxTimeRangeConfig.ts
276
277
  src/models/ConversationPbxTimeRangeResponse.ts
277
278
  src/models/ConversationPbxTimeRangesResponse.ts
279
+ src/models/ConversationPbxVoicemailCapabilitiesResponse.ts
278
280
  src/models/ConversationPbxVoicemailMailbox.ts
279
281
  src/models/ConversationPbxVoicemailMailboxResponse.ts
280
282
  src/models/ConversationPbxVoicemailMailboxesResponse.ts
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # UltraCart Typescript SDK
2
- ## ultracart_rest_api_v2_typescript@4.1.71
2
+ ## ultracart_rest_api_v2_typescript@4.1.73
3
3
 
4
4
  Every API method call has a sample for every language SDK. See https://github.com/UltraCart/sdk_samples
5
5
 
6
6
  Installation
7
7
 
8
8
  ```
9
- npm install ultracart_rest_api_v2_typescript@4.1.71 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.73 --save
10
10
  ```
11
11
 
12
12
  ```typescript
@@ -85,6 +85,8 @@ Not every change is committed to every SDK.
85
85
 
86
86
  | Version | Date | Comments |
87
87
  | --: | :-: | --- |
88
+ | 4.1.73 | 04/13/2026 | conversation pbx - queue configuration for ai summary and call record zoho desk |
89
+ | 4.1.72 | 04/11/2026 | conversation pbx - voicemail notification channels |
88
90
  | 4.1.71 | 04/06/2026 | coupons - new percent_off_items_with_minimum_item_amount |
89
91
  | 4.1.70 | 04/03/2026 | conversation pbx - queue callback settings |
90
92
  | 4.1.69 | 03/31/2026 | conversations - user specific audio methods |
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import { BaseResponse, 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, ConversationPbxClassOfService, ConversationPbxClassOfServiceResponse, ConversationPbxClassOfServicesResponse, ConversationPbxCosAuditLogsResponse, 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, ItemResponse } from '../models';
13
+ import { BaseResponse, 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, ConversationPbxClassOfService, ConversationPbxClassOfServiceResponse, ConversationPbxClassOfServicesResponse, ConversationPbxCosAuditLogsResponse, ConversationPbxCustomerSnapshotRequest, ConversationPbxCustomerSnapshotResponse, ConversationPbxHardwarePhone, ConversationPbxHardwarePhoneResponse, ConversationPbxHardwarePhonesResponse, ConversationPbxMenu, ConversationPbxMenuResponse, ConversationPbxMenusResponse, ConversationPbxPhoneManufacturersResponse, ConversationPbxPhoneNumber, ConversationPbxPhoneNumberPurchaseRequest, ConversationPbxPhoneNumberResponse, ConversationPbxPhoneNumbersResponse, ConversationPbxQueue, ConversationPbxQueueResponse, ConversationPbxQueuesResponse, ConversationPbxTimeBased, ConversationPbxTimeBasedResponse, ConversationPbxTimeBasedsResponse, ConversationPbxTimeRange, ConversationPbxTimeRangeResponse, ConversationPbxTimeRangesResponse, ConversationPbxVoicemailCapabilitiesResponse, ConversationPbxVoicemailMailbox, ConversationPbxVoicemailMailboxResponse, ConversationPbxVoicemailMailboxesResponse, ConversationPbxVoicemailMessageResponse, ConversationPbxVoicemailMessageSummariesResponse, ConversationPermissionsResponse, ConversationResponse, ConversationSearchRequest, ConversationSearchResponse, ConversationStartRequest, ConversationStartResponse, ConversationVirtualAgentBudget, ConversationVirtualAgentBudgetResponse, ConversationVirtualAgentCapabilities, ConversationVirtualAgentCapabilitiesResponse, ConversationWebchatContext, ConversationWebchatQueueStatusUpdateRequest, ConversationWebchatQueueStatusesResponse, ConversationsResponse, ItemResponse } from '../models';
14
14
  export interface DeleteAgentProfileKnowledgeBaseDocumentRequest {
15
15
  userId: number;
16
16
  documentUuid: string;
@@ -1384,6 +1384,19 @@ export interface ConversationApiInterface {
1384
1384
  * Get pbx timeRanges
1385
1385
  */
1386
1386
  getPbxTimeRanges(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxTimeRangesResponse>;
1387
+ /**
1388
+ * Retrieve voicemail notification capabilities including available channels
1389
+ * @summary Get pbx voicemail capabilities
1390
+ * @param {*} [options] Override http request option.
1391
+ * @throws {RequiredError}
1392
+ * @memberof ConversationApiInterface
1393
+ */
1394
+ getPbxVoicemailCapabilitiesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxVoicemailCapabilitiesResponse>>;
1395
+ /**
1396
+ * Retrieve voicemail notification capabilities including available channels
1397
+ * Get pbx voicemail capabilities
1398
+ */
1399
+ getPbxVoicemailCapabilities(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxVoicemailCapabilitiesResponse>;
1387
1400
  /**
1388
1401
  * Retrieve a pbx voicemailMailbox
1389
1402
  * @summary Get pbx voicemailMailbox
@@ -2917,6 +2930,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
2917
2930
  * Get pbx timeRanges
2918
2931
  */
2919
2932
  getPbxTimeRanges(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxTimeRangesResponse>;
2933
+ /**
2934
+ * Retrieve voicemail notification capabilities including available channels
2935
+ * Get pbx voicemail capabilities
2936
+ */
2937
+ getPbxVoicemailCapabilitiesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxVoicemailCapabilitiesResponse>>;
2938
+ /**
2939
+ * Retrieve voicemail notification capabilities including available channels
2940
+ * Get pbx voicemail capabilities
2941
+ */
2942
+ getPbxVoicemailCapabilities(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxVoicemailCapabilitiesResponse>;
2920
2943
  /**
2921
2944
  * Retrieve a pbx voicemailMailbox
2922
2945
  * Get pbx voicemailMailbox
@@ -4353,6 +4353,62 @@ var ConversationApi = /** @class */ (function (_super) {
4353
4353
  });
4354
4354
  });
4355
4355
  };
4356
+ /**
4357
+ * Retrieve voicemail notification capabilities including available channels
4358
+ * Get pbx voicemail capabilities
4359
+ */
4360
+ ConversationApi.prototype.getPbxVoicemailCapabilitiesRaw = function (initOverrides) {
4361
+ return __awaiter(this, void 0, void 0, function () {
4362
+ var queryParameters, headerParameters, _a, _b, response;
4363
+ return __generator(this, function (_c) {
4364
+ switch (_c.label) {
4365
+ case 0:
4366
+ queryParameters = {};
4367
+ headerParameters = {};
4368
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
4369
+ // oauth required
4370
+ _a = headerParameters;
4371
+ _b = "Authorization";
4372
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["conversation_read"])];
4373
+ case 1:
4374
+ // oauth required
4375
+ _a[_b] = _c.sent();
4376
+ _c.label = 2;
4377
+ case 2:
4378
+ if (this.configuration && this.configuration.apiKey) {
4379
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
4380
+ }
4381
+ return [4 /*yield*/, this.request({
4382
+ path: "/conversation/pbx/voicemail/capabilities",
4383
+ method: 'GET',
4384
+ headers: headerParameters,
4385
+ query: queryParameters,
4386
+ }, initOverrides)];
4387
+ case 3:
4388
+ response = _c.sent();
4389
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ConversationPbxVoicemailCapabilitiesResponseFromJSON)(jsonValue); })];
4390
+ }
4391
+ });
4392
+ });
4393
+ };
4394
+ /**
4395
+ * Retrieve voicemail notification capabilities including available channels
4396
+ * Get pbx voicemail capabilities
4397
+ */
4398
+ ConversationApi.prototype.getPbxVoicemailCapabilities = function (initOverrides) {
4399
+ return __awaiter(this, void 0, void 0, function () {
4400
+ var response;
4401
+ return __generator(this, function (_a) {
4402
+ switch (_a.label) {
4403
+ case 0: return [4 /*yield*/, this.getPbxVoicemailCapabilitiesRaw(initOverrides)];
4404
+ case 1:
4405
+ response = _a.sent();
4406
+ return [4 /*yield*/, response.value()];
4407
+ case 2: return [2 /*return*/, _a.sent()];
4408
+ }
4409
+ });
4410
+ });
4411
+ };
4356
4412
  /**
4357
4413
  * Retrieve a pbx voicemailMailbox
4358
4414
  * Get pbx voicemailMailbox
@@ -11,6 +11,7 @@
11
11
  */
12
12
  import { ConversationPbxCallAgent } from './ConversationPbxCallAgent';
13
13
  import { ConversationPbxCallAiEngagement } from './ConversationPbxCallAiEngagement';
14
+ import { ConversationPbxCallAiSummary } from './ConversationPbxCallAiSummary';
14
15
  import { ConversationPbxCallCaller } from './ConversationPbxCallCaller';
15
16
  import { ConversationPbxCallFinancial } from './ConversationPbxCallFinancial';
16
17
  import { ConversationPbxCallHold } from './ConversationPbxCallHold';
@@ -42,6 +43,12 @@ export interface ConversationPbxCall {
42
43
  * @memberof ConversationPbxCall
43
44
  */
44
45
  ai_agent_engagements?: Array<ConversationPbxCallAiEngagement>;
46
+ /**
47
+ *
48
+ * @type {ConversationPbxCallAiSummary}
49
+ * @memberof ConversationPbxCall
50
+ */
51
+ ai_summary?: ConversationPbxCallAiSummary;
45
52
  /**
46
53
  * Twilio call SID for the primary (customer) call leg
47
54
  * @type {string}
@@ -156,6 +163,18 @@ export interface ConversationPbxCall {
156
163
  * @memberof ConversationPbxCall
157
164
  */
158
165
  updated_at_dts?: string;
166
+ /**
167
+ * Zoho Desk ticket ID if a ticket was created for this call
168
+ * @type {string}
169
+ * @memberof ConversationPbxCall
170
+ */
171
+ zoho_desk_ticket_id?: string;
172
+ /**
173
+ * URL to the Zoho Desk ticket if a ticket was created for this call
174
+ * @type {string}
175
+ * @memberof ConversationPbxCall
176
+ */
177
+ zoho_desk_ticket_url?: string;
159
178
  }
160
179
  /**
161
180
  * Check if a given object implements the ConversationPbxCall interface.
@@ -17,6 +17,7 @@ exports.ConversationPbxCallToJSON = exports.ConversationPbxCallFromJSONTyped = e
17
17
  var runtime_1 = require("../runtime");
18
18
  var ConversationPbxCallAgent_1 = require("./ConversationPbxCallAgent");
19
19
  var ConversationPbxCallAiEngagement_1 = require("./ConversationPbxCallAiEngagement");
20
+ var ConversationPbxCallAiSummary_1 = require("./ConversationPbxCallAiSummary");
20
21
  var ConversationPbxCallCaller_1 = require("./ConversationPbxCallCaller");
21
22
  var ConversationPbxCallFinancial_1 = require("./ConversationPbxCallFinancial");
22
23
  var ConversationPbxCallHold_1 = require("./ConversationPbxCallHold");
@@ -44,6 +45,7 @@ function ConversationPbxCallFromJSONTyped(json, ignoreDiscriminator) {
44
45
  'account_sid': !(0, runtime_1.exists)(json, 'account_sid') ? undefined : json['account_sid'],
45
46
  'agents': !(0, runtime_1.exists)(json, 'agents') ? undefined : (json['agents'].map(ConversationPbxCallAgent_1.ConversationPbxCallAgentFromJSON)),
46
47
  'ai_agent_engagements': !(0, runtime_1.exists)(json, 'ai_agent_engagements') ? undefined : (json['ai_agent_engagements'].map(ConversationPbxCallAiEngagement_1.ConversationPbxCallAiEngagementFromJSON)),
48
+ 'ai_summary': !(0, runtime_1.exists)(json, 'ai_summary') ? undefined : (0, ConversationPbxCallAiSummary_1.ConversationPbxCallAiSummaryFromJSON)(json['ai_summary']),
47
49
  'call_sid': !(0, runtime_1.exists)(json, 'call_sid') ? undefined : json['call_sid'],
48
50
  'call_uuid': !(0, runtime_1.exists)(json, 'call_uuid') ? undefined : json['call_uuid'],
49
51
  'caller': !(0, runtime_1.exists)(json, 'caller') ? undefined : (0, ConversationPbxCallCaller_1.ConversationPbxCallCallerFromJSON)(json['caller']),
@@ -63,6 +65,8 @@ function ConversationPbxCallFromJSONTyped(json, ignoreDiscriminator) {
63
65
  'timeline': !(0, runtime_1.exists)(json, 'timeline') ? undefined : (0, ConversationPbxCallTimeline_1.ConversationPbxCallTimelineFromJSON)(json['timeline']),
64
66
  'transfers': !(0, runtime_1.exists)(json, 'transfers') ? undefined : (json['transfers'].map(ConversationPbxCallTransfer_1.ConversationPbxCallTransferFromJSON)),
65
67
  'updated_at_dts': !(0, runtime_1.exists)(json, 'updated_at_dts') ? undefined : json['updated_at_dts'],
68
+ 'zoho_desk_ticket_id': !(0, runtime_1.exists)(json, 'zoho_desk_ticket_id') ? undefined : json['zoho_desk_ticket_id'],
69
+ 'zoho_desk_ticket_url': !(0, runtime_1.exists)(json, 'zoho_desk_ticket_url') ? undefined : json['zoho_desk_ticket_url'],
66
70
  };
67
71
  }
68
72
  exports.ConversationPbxCallFromJSONTyped = ConversationPbxCallFromJSONTyped;
@@ -77,6 +81,7 @@ function ConversationPbxCallToJSON(value) {
77
81
  'account_sid': value.account_sid,
78
82
  'agents': value.agents === undefined ? undefined : (value.agents.map(ConversationPbxCallAgent_1.ConversationPbxCallAgentToJSON)),
79
83
  'ai_agent_engagements': value.ai_agent_engagements === undefined ? undefined : (value.ai_agent_engagements.map(ConversationPbxCallAiEngagement_1.ConversationPbxCallAiEngagementToJSON)),
84
+ 'ai_summary': (0, ConversationPbxCallAiSummary_1.ConversationPbxCallAiSummaryToJSON)(value.ai_summary),
80
85
  'call_sid': value.call_sid,
81
86
  'call_uuid': value.call_uuid,
82
87
  'caller': (0, ConversationPbxCallCaller_1.ConversationPbxCallCallerToJSON)(value.caller),
@@ -96,6 +101,8 @@ function ConversationPbxCallToJSON(value) {
96
101
  'timeline': (0, ConversationPbxCallTimeline_1.ConversationPbxCallTimelineToJSON)(value.timeline),
97
102
  'transfers': value.transfers === undefined ? undefined : (value.transfers.map(ConversationPbxCallTransfer_1.ConversationPbxCallTransferToJSON)),
98
103
  'updated_at_dts': value.updated_at_dts,
104
+ 'zoho_desk_ticket_id': value.zoho_desk_ticket_id,
105
+ 'zoho_desk_ticket_url': value.zoho_desk_ticket_url,
99
106
  };
100
107
  }
101
108
  exports.ConversationPbxCallToJSON = ConversationPbxCallToJSON;
@@ -0,0 +1,100 @@
1
+ /**
2
+ * UltraCart Rest API V2
3
+ * UltraCart REST API Version 2
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@ultracart.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface ConversationPbxCallAiSummary
16
+ */
17
+ export interface ConversationPbxCallAiSummary {
18
+ /**
19
+ * Action items identified during the call
20
+ * @type {Array<string>}
21
+ * @memberof ConversationPbxCallAiSummary
22
+ */
23
+ action_items?: Array<string>;
24
+ /**
25
+ * Category of the call (e.g. support, sales, billing)
26
+ * @type {string}
27
+ * @memberof ConversationPbxCallAiSummary
28
+ */
29
+ call_category?: string;
30
+ /**
31
+ * Number of output tokens used to generate the summary
32
+ * @type {number}
33
+ * @memberof ConversationPbxCallAiSummary
34
+ */
35
+ completion_tokens?: number;
36
+ /**
37
+ * Cost of generating the summary in the specified currency
38
+ * @type {number}
39
+ * @memberof ConversationPbxCallAiSummary
40
+ */
41
+ cost?: number;
42
+ /**
43
+ * Currency code for the summary cost (always USD)
44
+ * @type {string}
45
+ * @memberof ConversationPbxCallAiSummary
46
+ */
47
+ cost_currency?: string;
48
+ /**
49
+ * Timestamp when the summary was generated
50
+ * @type {string}
51
+ * @memberof ConversationPbxCallAiSummary
52
+ */
53
+ generated_at_dts?: string;
54
+ /**
55
+ * Key topics discussed during the call
56
+ * @type {Array<string>}
57
+ * @memberof ConversationPbxCallAiSummary
58
+ */
59
+ key_topics?: Array<string>;
60
+ /**
61
+ * AI model used to generate the summary (e.g. grok-4.1-fast)
62
+ * @type {string}
63
+ * @memberof ConversationPbxCallAiSummary
64
+ */
65
+ model?: string;
66
+ /**
67
+ * Number of input tokens used to generate the summary
68
+ * @type {number}
69
+ * @memberof ConversationPbxCallAiSummary
70
+ */
71
+ prompt_tokens?: number;
72
+ /**
73
+ * Overall sentiment of the call
74
+ * @type {string}
75
+ * @memberof ConversationPbxCallAiSummary
76
+ */
77
+ sentiment?: ConversationPbxCallAiSummarySentimentEnum;
78
+ /**
79
+ * 2-3 sentence synopsis of the call
80
+ * @type {string}
81
+ * @memberof ConversationPbxCallAiSummary
82
+ */
83
+ summary?: string;
84
+ }
85
+ /**
86
+ * @export
87
+ */
88
+ export declare const ConversationPbxCallAiSummarySentimentEnum: {
89
+ readonly Positive: "positive";
90
+ readonly Neutral: "neutral";
91
+ readonly Negative: "negative";
92
+ };
93
+ export type ConversationPbxCallAiSummarySentimentEnum = typeof ConversationPbxCallAiSummarySentimentEnum[keyof typeof ConversationPbxCallAiSummarySentimentEnum];
94
+ /**
95
+ * Check if a given object implements the ConversationPbxCallAiSummary interface.
96
+ */
97
+ export declare function instanceOfConversationPbxCallAiSummary(value: object): boolean;
98
+ export declare function ConversationPbxCallAiSummaryFromJSON(json: any): ConversationPbxCallAiSummary;
99
+ export declare function ConversationPbxCallAiSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationPbxCallAiSummary;
100
+ export declare function ConversationPbxCallAiSummaryToJSON(value?: ConversationPbxCallAiSummary | null): any;
@@ -0,0 +1,78 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * UltraCart Rest API V2
6
+ * UltraCart REST API Version 2
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ * Contact: support@ultracart.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.ConversationPbxCallAiSummaryToJSON = exports.ConversationPbxCallAiSummaryFromJSONTyped = exports.ConversationPbxCallAiSummaryFromJSON = exports.instanceOfConversationPbxCallAiSummary = exports.ConversationPbxCallAiSummarySentimentEnum = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ /**
19
+ * @export
20
+ */
21
+ exports.ConversationPbxCallAiSummarySentimentEnum = {
22
+ Positive: 'positive',
23
+ Neutral: 'neutral',
24
+ Negative: 'negative'
25
+ };
26
+ /**
27
+ * Check if a given object implements the ConversationPbxCallAiSummary interface.
28
+ */
29
+ function instanceOfConversationPbxCallAiSummary(value) {
30
+ var isInstance = true;
31
+ return isInstance;
32
+ }
33
+ exports.instanceOfConversationPbxCallAiSummary = instanceOfConversationPbxCallAiSummary;
34
+ function ConversationPbxCallAiSummaryFromJSON(json) {
35
+ return ConversationPbxCallAiSummaryFromJSONTyped(json, false);
36
+ }
37
+ exports.ConversationPbxCallAiSummaryFromJSON = ConversationPbxCallAiSummaryFromJSON;
38
+ function ConversationPbxCallAiSummaryFromJSONTyped(json, ignoreDiscriminator) {
39
+ if ((json === undefined) || (json === null)) {
40
+ return json;
41
+ }
42
+ return {
43
+ 'action_items': !(0, runtime_1.exists)(json, 'action_items') ? undefined : json['action_items'],
44
+ 'call_category': !(0, runtime_1.exists)(json, 'call_category') ? undefined : json['call_category'],
45
+ 'completion_tokens': !(0, runtime_1.exists)(json, 'completion_tokens') ? undefined : json['completion_tokens'],
46
+ 'cost': !(0, runtime_1.exists)(json, 'cost') ? undefined : json['cost'],
47
+ 'cost_currency': !(0, runtime_1.exists)(json, 'cost_currency') ? undefined : json['cost_currency'],
48
+ 'generated_at_dts': !(0, runtime_1.exists)(json, 'generated_at_dts') ? undefined : json['generated_at_dts'],
49
+ 'key_topics': !(0, runtime_1.exists)(json, 'key_topics') ? undefined : json['key_topics'],
50
+ 'model': !(0, runtime_1.exists)(json, 'model') ? undefined : json['model'],
51
+ 'prompt_tokens': !(0, runtime_1.exists)(json, 'prompt_tokens') ? undefined : json['prompt_tokens'],
52
+ 'sentiment': !(0, runtime_1.exists)(json, 'sentiment') ? undefined : json['sentiment'],
53
+ 'summary': !(0, runtime_1.exists)(json, 'summary') ? undefined : json['summary'],
54
+ };
55
+ }
56
+ exports.ConversationPbxCallAiSummaryFromJSONTyped = ConversationPbxCallAiSummaryFromJSONTyped;
57
+ function ConversationPbxCallAiSummaryToJSON(value) {
58
+ if (value === undefined) {
59
+ return undefined;
60
+ }
61
+ if (value === null) {
62
+ return null;
63
+ }
64
+ return {
65
+ 'action_items': value.action_items,
66
+ 'call_category': value.call_category,
67
+ 'completion_tokens': value.completion_tokens,
68
+ 'cost': value.cost,
69
+ 'cost_currency': value.cost_currency,
70
+ 'generated_at_dts': value.generated_at_dts,
71
+ 'key_topics': value.key_topics,
72
+ 'model': value.model,
73
+ 'prompt_tokens': value.prompt_tokens,
74
+ 'sentiment': value.sentiment,
75
+ 'summary': value.summary,
76
+ };
77
+ }
78
+ exports.ConversationPbxCallAiSummaryToJSON = ConversationPbxCallAiSummaryToJSON;
@@ -33,6 +33,12 @@ export interface ConversationPbxCallFinancial {
33
33
  * @memberof ConversationPbxCallFinancial
34
34
  */
35
35
  ai_agent_cost_currency?: string;
36
+ /**
37
+ * AI summary generation cost (LLM call made by pbx-transcript-formatter after the call ends)
38
+ * @type {number}
39
+ * @memberof ConversationPbxCallFinancial
40
+ */
41
+ ai_summary_cost?: number;
36
42
  /**
37
43
  * Currency for call price (default USD)
38
44
  * @type {string}
@@ -35,6 +35,7 @@ function ConversationPbxCallFinancialFromJSONTyped(json, ignoreDiscriminator) {
35
35
  'ai_agent_billed_minutes': !(0, runtime_1.exists)(json, 'ai_agent_billed_minutes') ? undefined : json['ai_agent_billed_minutes'],
36
36
  'ai_agent_cost': !(0, runtime_1.exists)(json, 'ai_agent_cost') ? undefined : json['ai_agent_cost'],
37
37
  'ai_agent_cost_currency': !(0, runtime_1.exists)(json, 'ai_agent_cost_currency') ? undefined : json['ai_agent_cost_currency'],
38
+ 'ai_summary_cost': !(0, runtime_1.exists)(json, 'ai_summary_cost') ? undefined : json['ai_summary_cost'],
38
39
  'call_currency': !(0, runtime_1.exists)(json, 'call_currency') ? undefined : json['call_currency'],
39
40
  'call_price': !(0, runtime_1.exists)(json, 'call_price') ? undefined : json['call_price'],
40
41
  'call_price_estimated': !(0, runtime_1.exists)(json, 'call_price_estimated') ? undefined : json['call_price_estimated'],
@@ -53,6 +54,7 @@ function ConversationPbxCallFinancialToJSON(value) {
53
54
  'ai_agent_billed_minutes': value.ai_agent_billed_minutes,
54
55
  'ai_agent_cost': value.ai_agent_cost,
55
56
  'ai_agent_cost_currency': value.ai_agent_cost_currency,
57
+ 'ai_summary_cost': value.ai_summary_cost,
56
58
  'call_currency': value.call_currency,
57
59
  'call_price': value.call_price,
58
60
  'call_price_estimated': value.call_price_estimated,
@@ -22,6 +22,18 @@ export interface ConversationPbxQueue {
22
22
  * @memberof ConversationPbxQueue
23
23
  */
24
24
  ai_priority?: ConversationPbxQueueAiPriorityEnum;
25
+ /**
26
+ * If true, AI summaries are generated for answered calls in this queue
27
+ * @type {boolean}
28
+ * @memberof ConversationPbxQueue
29
+ */
30
+ ai_summary_enabled?: boolean;
31
+ /**
32
+ * Custom instructions injected into the AI summary system prompt for this queue
33
+ * @type {string}
34
+ * @memberof ConversationPbxQueue
35
+ */
36
+ ai_summary_instructions?: string;
25
37
  /**
26
38
  * AI timeout seconds
27
39
  * @type {number}
@@ -232,6 +244,18 @@ export interface ConversationPbxQueue {
232
244
  * @memberof ConversationPbxQueue
233
245
  */
234
246
  wrap_up_seconds?: number;
247
+ /**
248
+ * Zoho Desk department ID to create tickets in
249
+ * @type {string}
250
+ * @memberof ConversationPbxQueue
251
+ */
252
+ zoho_desk_department_id?: string;
253
+ /**
254
+ * If true, a Zoho Desk ticket is automatically created for answered calls in this queue
255
+ * @type {boolean}
256
+ * @memberof ConversationPbxQueue
257
+ */
258
+ zoho_desk_ticket_enabled?: boolean;
235
259
  }
236
260
  /**
237
261
  * @export
@@ -56,6 +56,8 @@ function ConversationPbxQueueFromJSONTyped(json, ignoreDiscriminator) {
56
56
  }
57
57
  return {
58
58
  'ai_priority': !(0, runtime_1.exists)(json, 'ai_priority') ? undefined : json['ai_priority'],
59
+ 'ai_summary_enabled': !(0, runtime_1.exists)(json, 'ai_summary_enabled') ? undefined : json['ai_summary_enabled'],
60
+ 'ai_summary_instructions': !(0, runtime_1.exists)(json, 'ai_summary_instructions') ? undefined : json['ai_summary_instructions'],
59
61
  'ai_timeout_seconds': !(0, runtime_1.exists)(json, 'ai_timeout_seconds') ? undefined : json['ai_timeout_seconds'],
60
62
  'announce_queue_position': !(0, runtime_1.exists)(json, 'announce_queue_position') ? undefined : json['announce_queue_position'],
61
63
  'automatic_coach_agent_uuid': !(0, runtime_1.exists)(json, 'automatic_coach_agent_uuid') ? undefined : json['automatic_coach_agent_uuid'],
@@ -91,6 +93,8 @@ function ConversationPbxQueueFromJSONTyped(json, ignoreDiscriminator) {
91
93
  'wait_critical_seconds': !(0, runtime_1.exists)(json, 'wait_critical_seconds') ? undefined : json['wait_critical_seconds'],
92
94
  'wait_warning_seconds': !(0, runtime_1.exists)(json, 'wait_warning_seconds') ? undefined : json['wait_warning_seconds'],
93
95
  'wrap_up_seconds': !(0, runtime_1.exists)(json, 'wrap_up_seconds') ? undefined : json['wrap_up_seconds'],
96
+ 'zoho_desk_department_id': !(0, runtime_1.exists)(json, 'zoho_desk_department_id') ? undefined : json['zoho_desk_department_id'],
97
+ 'zoho_desk_ticket_enabled': !(0, runtime_1.exists)(json, 'zoho_desk_ticket_enabled') ? undefined : json['zoho_desk_ticket_enabled'],
94
98
  };
95
99
  }
96
100
  exports.ConversationPbxQueueFromJSONTyped = ConversationPbxQueueFromJSONTyped;
@@ -103,6 +107,8 @@ function ConversationPbxQueueToJSON(value) {
103
107
  }
104
108
  return {
105
109
  'ai_priority': value.ai_priority,
110
+ 'ai_summary_enabled': value.ai_summary_enabled,
111
+ 'ai_summary_instructions': value.ai_summary_instructions,
106
112
  'ai_timeout_seconds': value.ai_timeout_seconds,
107
113
  'announce_queue_position': value.announce_queue_position,
108
114
  'automatic_coach_agent_uuid': value.automatic_coach_agent_uuid,
@@ -138,6 +144,8 @@ function ConversationPbxQueueToJSON(value) {
138
144
  'wait_critical_seconds': value.wait_critical_seconds,
139
145
  'wait_warning_seconds': value.wait_warning_seconds,
140
146
  'wrap_up_seconds': value.wrap_up_seconds,
147
+ 'zoho_desk_department_id': value.zoho_desk_department_id,
148
+ 'zoho_desk_ticket_enabled': value.zoho_desk_ticket_enabled,
141
149
  };
142
150
  }
143
151
  exports.ConversationPbxQueueToJSON = ConversationPbxQueueToJSON;
@@ -0,0 +1,65 @@
1
+ /**
2
+ * UltraCart Rest API V2
3
+ * UltraCart REST API Version 2
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@ultracart.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { ConversationVirtualAgentCapabilityZohoDeskDepartment } from './ConversationVirtualAgentCapabilityZohoDeskDepartment';
13
+ import { ModelError } from './ModelError';
14
+ import { ResponseMetadata } from './ResponseMetadata';
15
+ import { Warning } from './Warning';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface ConversationPbxVoicemailCapabilitiesResponse
20
+ */
21
+ export interface ConversationPbxVoicemailCapabilitiesResponse {
22
+ /**
23
+ *
24
+ * @type {ModelError}
25
+ * @memberof ConversationPbxVoicemailCapabilitiesResponse
26
+ */
27
+ error?: ModelError;
28
+ /**
29
+ *
30
+ * @type {ResponseMetadata}
31
+ * @memberof ConversationPbxVoicemailCapabilitiesResponse
32
+ */
33
+ metadata?: ResponseMetadata;
34
+ /**
35
+ * Indicates if API call was successful
36
+ * @type {boolean}
37
+ * @memberof ConversationPbxVoicemailCapabilitiesResponse
38
+ */
39
+ success?: boolean;
40
+ /**
41
+ *
42
+ * @type {Warning}
43
+ * @memberof ConversationPbxVoicemailCapabilitiesResponse
44
+ */
45
+ warning?: Warning;
46
+ /**
47
+ * True if Zoho Desk is connected to UltraCart
48
+ * @type {boolean}
49
+ * @memberof ConversationPbxVoicemailCapabilitiesResponse
50
+ */
51
+ zoho_desk_available?: boolean;
52
+ /**
53
+ * Array of Zoho Desk Departments if Zoho Desk is connected to UltraCart
54
+ * @type {Array<ConversationVirtualAgentCapabilityZohoDeskDepartment>}
55
+ * @memberof ConversationPbxVoicemailCapabilitiesResponse
56
+ */
57
+ zoho_desk_departments?: Array<ConversationVirtualAgentCapabilityZohoDeskDepartment>;
58
+ }
59
+ /**
60
+ * Check if a given object implements the ConversationPbxVoicemailCapabilitiesResponse interface.
61
+ */
62
+ export declare function instanceOfConversationPbxVoicemailCapabilitiesResponse(value: object): boolean;
63
+ export declare function ConversationPbxVoicemailCapabilitiesResponseFromJSON(json: any): ConversationPbxVoicemailCapabilitiesResponse;
64
+ export declare function ConversationPbxVoicemailCapabilitiesResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationPbxVoicemailCapabilitiesResponse;
65
+ export declare function ConversationPbxVoicemailCapabilitiesResponseToJSON(value?: ConversationPbxVoicemailCapabilitiesResponse | null): any;
@@ -0,0 +1,64 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * UltraCart Rest API V2
6
+ * UltraCart REST API Version 2
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ * Contact: support@ultracart.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.ConversationPbxVoicemailCapabilitiesResponseToJSON = exports.ConversationPbxVoicemailCapabilitiesResponseFromJSONTyped = exports.ConversationPbxVoicemailCapabilitiesResponseFromJSON = exports.instanceOfConversationPbxVoicemailCapabilitiesResponse = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ var ConversationVirtualAgentCapabilityZohoDeskDepartment_1 = require("./ConversationVirtualAgentCapabilityZohoDeskDepartment");
19
+ var ModelError_1 = require("./ModelError");
20
+ var ResponseMetadata_1 = require("./ResponseMetadata");
21
+ var Warning_1 = require("./Warning");
22
+ /**
23
+ * Check if a given object implements the ConversationPbxVoicemailCapabilitiesResponse interface.
24
+ */
25
+ function instanceOfConversationPbxVoicemailCapabilitiesResponse(value) {
26
+ var isInstance = true;
27
+ return isInstance;
28
+ }
29
+ exports.instanceOfConversationPbxVoicemailCapabilitiesResponse = instanceOfConversationPbxVoicemailCapabilitiesResponse;
30
+ function ConversationPbxVoicemailCapabilitiesResponseFromJSON(json) {
31
+ return ConversationPbxVoicemailCapabilitiesResponseFromJSONTyped(json, false);
32
+ }
33
+ exports.ConversationPbxVoicemailCapabilitiesResponseFromJSON = ConversationPbxVoicemailCapabilitiesResponseFromJSON;
34
+ function ConversationPbxVoicemailCapabilitiesResponseFromJSONTyped(json, ignoreDiscriminator) {
35
+ if ((json === undefined) || (json === null)) {
36
+ return json;
37
+ }
38
+ return {
39
+ 'error': !(0, runtime_1.exists)(json, 'error') ? undefined : (0, ModelError_1.ModelErrorFromJSON)(json['error']),
40
+ 'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : (0, ResponseMetadata_1.ResponseMetadataFromJSON)(json['metadata']),
41
+ 'success': !(0, runtime_1.exists)(json, 'success') ? undefined : json['success'],
42
+ 'warning': !(0, runtime_1.exists)(json, 'warning') ? undefined : (0, Warning_1.WarningFromJSON)(json['warning']),
43
+ 'zoho_desk_available': !(0, runtime_1.exists)(json, 'zoho_desk_available') ? undefined : json['zoho_desk_available'],
44
+ 'zoho_desk_departments': !(0, runtime_1.exists)(json, 'zoho_desk_departments') ? undefined : (json['zoho_desk_departments'].map(ConversationVirtualAgentCapabilityZohoDeskDepartment_1.ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSON)),
45
+ };
46
+ }
47
+ exports.ConversationPbxVoicemailCapabilitiesResponseFromJSONTyped = ConversationPbxVoicemailCapabilitiesResponseFromJSONTyped;
48
+ function ConversationPbxVoicemailCapabilitiesResponseToJSON(value) {
49
+ if (value === undefined) {
50
+ return undefined;
51
+ }
52
+ if (value === null) {
53
+ return null;
54
+ }
55
+ return {
56
+ 'error': (0, ModelError_1.ModelErrorToJSON)(value.error),
57
+ 'metadata': (0, ResponseMetadata_1.ResponseMetadataToJSON)(value.metadata),
58
+ 'success': value.success,
59
+ 'warning': (0, Warning_1.WarningToJSON)(value.warning),
60
+ 'zoho_desk_available': value.zoho_desk_available,
61
+ 'zoho_desk_departments': value.zoho_desk_departments === undefined ? undefined : (value.zoho_desk_departments.map(ConversationVirtualAgentCapabilityZohoDeskDepartment_1.ConversationVirtualAgentCapabilityZohoDeskDepartmentToJSON)),
62
+ };
63
+ }
64
+ exports.ConversationPbxVoicemailCapabilitiesResponseToJSON = ConversationPbxVoicemailCapabilitiesResponseToJSON;