ultracart_rest_api_v2_typescript 4.1.72 → 4.1.74

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.
@@ -52,6 +52,7 @@ src/models/AutoOrderAddonItemOption.ts
52
52
  src/models/AutoOrderAddonItemsUpdateRequest.ts
53
53
  src/models/AutoOrderConsolidate.ts
54
54
  src/models/AutoOrderItem.ts
55
+ src/models/AutoOrderItemCancelRequest.ts
55
56
  src/models/AutoOrderItemFutureSchedule.ts
56
57
  src/models/AutoOrderItemOption.ts
57
58
  src/models/AutoOrderItemSimpleSchedule.ts
@@ -226,6 +227,7 @@ src/models/ConversationPbxCall.ts
226
227
  src/models/ConversationPbxCallAgent.ts
227
228
  src/models/ConversationPbxCallAiCost.ts
228
229
  src/models/ConversationPbxCallAiEngagement.ts
230
+ src/models/ConversationPbxCallAiSummary.ts
229
231
  src/models/ConversationPbxCallAiToolCall.ts
230
232
  src/models/ConversationPbxCallAiWhisper.ts
231
233
  src/models/ConversationPbxCallCaller.ts
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # UltraCart Typescript SDK
2
- ## ultracart_rest_api_v2_typescript@4.1.72
2
+ ## ultracart_rest_api_v2_typescript@4.1.74
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.72 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.74 --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.74 | 04/15/2026 | auto order - new method cancelAutoOrderItemByReferenceOrderId |
89
+ | 4.1.73 | 04/13/2026 | conversation pbx - queue configuration for ai summary and call record zoho desk |
88
90
  | 4.1.72 | 04/11/2026 | conversation pbx - voicemail notification channels |
89
91
  | 4.1.71 | 04/06/2026 | coupons - new percent_off_items_with_minimum_item_amount |
90
92
  | 4.1.70 | 04/03/2026 | conversation pbx - queue callback settings |
@@ -10,7 +10,13 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import { AutoOrder, AutoOrderAddonItemsUpdateRequest, AutoOrderConsolidate, AutoOrderPropertiesUpdateRequest, AutoOrderQuery, AutoOrderQueryBatch, AutoOrderResponse, AutoOrdersRequest, AutoOrdersResponse } from '../models';
13
+ import { AutoOrder, AutoOrderAddonItemsUpdateRequest, AutoOrderConsolidate, AutoOrderItemCancelRequest, AutoOrderPropertiesUpdateRequest, AutoOrderQuery, AutoOrderQueryBatch, AutoOrderResponse, AutoOrdersRequest, AutoOrdersResponse } from '../models';
14
+ export interface CancelAutoOrderItemByReferenceOrderIdRequest {
15
+ referenceOrderId: string;
16
+ originalItemId: string;
17
+ expand?: string;
18
+ autoOrderItemCancelRequest?: AutoOrderItemCancelRequest;
19
+ }
14
20
  export interface ConsolidateAutoOrdersRequest {
15
21
  autoOrderOid: number;
16
22
  autoOrderConsolidate: AutoOrderConsolidate;
@@ -109,6 +115,23 @@ export interface UpdateAutoOrdersBatchRequest {
109
115
  * @interface AutoOrderApiInterface
110
116
  */
111
117
  export interface AutoOrderApiInterface {
118
+ /**
119
+ * Cancels a single item on an auto order identified by the original order id and the item\'s original_item_id. The request body may specify mode=end (soft cancel by setting no_order_after_dts to the current time, preserving the row for reporting; this is the default when the body is omitted) or mode=remove (hard delete). Returns the updated auto order based upon expansion.
120
+ * @summary Cancel a single item on an auto order
121
+ * @param {string} referenceOrderId The reference order id (original_order_id) of the auto order.
122
+ * @param {string} originalItemId The original_item_id (SKU) of the item to cancel.
123
+ * @param {string} [expand] The object expansion to perform on the result. See documentation for examples
124
+ * @param {AutoOrderItemCancelRequest} [autoOrderItemCancelRequest] Cancel request. Body is optional; omit for default mode=end.
125
+ * @param {*} [options] Override http request option.
126
+ * @throws {RequiredError}
127
+ * @memberof AutoOrderApiInterface
128
+ */
129
+ cancelAutoOrderItemByReferenceOrderIdRaw(requestParameters: CancelAutoOrderItemByReferenceOrderIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderResponse>>;
130
+ /**
131
+ * Cancels a single item on an auto order identified by the original order id and the item\'s original_item_id. The request body may specify mode=end (soft cancel by setting no_order_after_dts to the current time, preserving the row for reporting; this is the default when the body is omitted) or mode=remove (hard delete). Returns the updated auto order based upon expansion.
132
+ * Cancel a single item on an auto order
133
+ */
134
+ cancelAutoOrderItemByReferenceOrderId(requestParameters: CancelAutoOrderItemByReferenceOrderIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
112
135
  /**
113
136
  * Consolidates mutliple auto orders on the UltraCart account.
114
137
  * @summary Consolidates multiple auto orders
@@ -359,6 +382,16 @@ export interface AutoOrderApiInterface {
359
382
  *
360
383
  */
361
384
  export declare class AutoOrderApi extends runtime.BaseAPI implements AutoOrderApiInterface {
385
+ /**
386
+ * Cancels a single item on an auto order identified by the original order id and the item\'s original_item_id. The request body may specify mode=end (soft cancel by setting no_order_after_dts to the current time, preserving the row for reporting; this is the default when the body is omitted) or mode=remove (hard delete). Returns the updated auto order based upon expansion.
387
+ * Cancel a single item on an auto order
388
+ */
389
+ cancelAutoOrderItemByReferenceOrderIdRaw(requestParameters: CancelAutoOrderItemByReferenceOrderIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderResponse>>;
390
+ /**
391
+ * Cancels a single item on an auto order identified by the original order id and the item\'s original_item_id. The request body may specify mode=end (soft cancel by setting no_order_after_dts to the current time, preserving the row for reporting; this is the default when the body is omitted) or mode=remove (hard delete). Returns the updated auto order based upon expansion.
392
+ * Cancel a single item on an auto order
393
+ */
394
+ cancelAutoOrderItemByReferenceOrderId(requestParameters: CancelAutoOrderItemByReferenceOrderIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
362
395
  /**
363
396
  * Consolidates mutliple auto orders on the UltraCart account.
364
397
  * Consolidates multiple auto orders
@@ -75,6 +75,73 @@ var AutoOrderApi = /** @class */ (function (_super) {
75
75
  function AutoOrderApi() {
76
76
  return _super !== null && _super.apply(this, arguments) || this;
77
77
  }
78
+ /**
79
+ * Cancels a single item on an auto order identified by the original order id and the item\'s original_item_id. The request body may specify mode=end (soft cancel by setting no_order_after_dts to the current time, preserving the row for reporting; this is the default when the body is omitted) or mode=remove (hard delete). Returns the updated auto order based upon expansion.
80
+ * Cancel a single item on an auto order
81
+ */
82
+ AutoOrderApi.prototype.cancelAutoOrderItemByReferenceOrderIdRaw = function (requestParameters, initOverrides) {
83
+ return __awaiter(this, void 0, void 0, function () {
84
+ var queryParameters, headerParameters, _a, _b, response;
85
+ return __generator(this, function (_c) {
86
+ switch (_c.label) {
87
+ case 0:
88
+ if (requestParameters.referenceOrderId === null || requestParameters.referenceOrderId === undefined) {
89
+ throw new runtime.RequiredError('referenceOrderId', 'Required parameter requestParameters.referenceOrderId was null or undefined when calling cancelAutoOrderItemByReferenceOrderId.');
90
+ }
91
+ if (requestParameters.originalItemId === null || requestParameters.originalItemId === undefined) {
92
+ throw new runtime.RequiredError('originalItemId', 'Required parameter requestParameters.originalItemId was null or undefined when calling cancelAutoOrderItemByReferenceOrderId.');
93
+ }
94
+ queryParameters = {};
95
+ if (requestParameters.expand !== undefined) {
96
+ queryParameters['_expand'] = requestParameters.expand;
97
+ }
98
+ headerParameters = {};
99
+ headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
100
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
101
+ // oauth required
102
+ _a = headerParameters;
103
+ _b = "Authorization";
104
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["auto_order_write"])];
105
+ case 1:
106
+ // oauth required
107
+ _a[_b] = _c.sent();
108
+ _c.label = 2;
109
+ case 2:
110
+ if (this.configuration && this.configuration.apiKey) {
111
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
112
+ }
113
+ return [4 /*yield*/, this.request({
114
+ path: "/auto_order/auto_orders/reference_order_id/{reference_order_id}/items/original/{original_item_id}/cancel".replace("{".concat("reference_order_id", "}"), encodeURIComponent(String(requestParameters.referenceOrderId))).replace("{".concat("original_item_id", "}"), encodeURIComponent(String(requestParameters.originalItemId))),
115
+ method: 'POST',
116
+ headers: headerParameters,
117
+ query: queryParameters,
118
+ body: (0, models_1.AutoOrderItemCancelRequestToJSON)(requestParameters.autoOrderItemCancelRequest),
119
+ }, initOverrides)];
120
+ case 3:
121
+ response = _c.sent();
122
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.AutoOrderResponseFromJSON)(jsonValue); })];
123
+ }
124
+ });
125
+ });
126
+ };
127
+ /**
128
+ * Cancels a single item on an auto order identified by the original order id and the item\'s original_item_id. The request body may specify mode=end (soft cancel by setting no_order_after_dts to the current time, preserving the row for reporting; this is the default when the body is omitted) or mode=remove (hard delete). Returns the updated auto order based upon expansion.
129
+ * Cancel a single item on an auto order
130
+ */
131
+ AutoOrderApi.prototype.cancelAutoOrderItemByReferenceOrderId = function (requestParameters, initOverrides) {
132
+ return __awaiter(this, void 0, void 0, function () {
133
+ var response;
134
+ return __generator(this, function (_a) {
135
+ switch (_a.label) {
136
+ case 0: return [4 /*yield*/, this.cancelAutoOrderItemByReferenceOrderIdRaw(requestParameters, initOverrides)];
137
+ case 1:
138
+ response = _a.sent();
139
+ return [4 /*yield*/, response.value()];
140
+ case 2: return [2 /*return*/, _a.sent()];
141
+ }
142
+ });
143
+ });
144
+ };
78
145
  /**
79
146
  * Consolidates mutliple auto orders on the UltraCart account.
80
147
  * Consolidates multiple auto orders
@@ -0,0 +1,45 @@
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 AutoOrderItemCancelRequest
16
+ */
17
+ export interface AutoOrderItemCancelRequest {
18
+ /**
19
+ * Optional tiebreaker when more than one item on the auto order shares the same original_item_id. When present, the item with this oid is targeted and its original_item_id must match the URL path parameter (safety check). Leave unset for the common case of a unique original_item_id.
20
+ * @type {number}
21
+ * @memberof AutoOrderItemCancelRequest
22
+ */
23
+ auto_order_item_oid?: number;
24
+ /**
25
+ * Cancellation mode. 'end' soft-cancels the item by setting no_order_after_dts to the current time, preserving the row for reporting. 'remove' hard-deletes the item from the auto order. Defaults to 'end' (the less destructive option) when omitted.
26
+ * @type {string}
27
+ * @memberof AutoOrderItemCancelRequest
28
+ */
29
+ mode?: AutoOrderItemCancelRequestModeEnum;
30
+ }
31
+ /**
32
+ * @export
33
+ */
34
+ export declare const AutoOrderItemCancelRequestModeEnum: {
35
+ readonly End: "end";
36
+ readonly Remove: "remove";
37
+ };
38
+ export type AutoOrderItemCancelRequestModeEnum = typeof AutoOrderItemCancelRequestModeEnum[keyof typeof AutoOrderItemCancelRequestModeEnum];
39
+ /**
40
+ * Check if a given object implements the AutoOrderItemCancelRequest interface.
41
+ */
42
+ export declare function instanceOfAutoOrderItemCancelRequest(value: object): boolean;
43
+ export declare function AutoOrderItemCancelRequestFromJSON(json: any): AutoOrderItemCancelRequest;
44
+ export declare function AutoOrderItemCancelRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AutoOrderItemCancelRequest;
45
+ export declare function AutoOrderItemCancelRequestToJSON(value?: AutoOrderItemCancelRequest | null): any;
@@ -0,0 +1,59 @@
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.AutoOrderItemCancelRequestToJSON = exports.AutoOrderItemCancelRequestFromJSONTyped = exports.AutoOrderItemCancelRequestFromJSON = exports.instanceOfAutoOrderItemCancelRequest = exports.AutoOrderItemCancelRequestModeEnum = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ /**
19
+ * @export
20
+ */
21
+ exports.AutoOrderItemCancelRequestModeEnum = {
22
+ End: 'end',
23
+ Remove: 'remove'
24
+ };
25
+ /**
26
+ * Check if a given object implements the AutoOrderItemCancelRequest interface.
27
+ */
28
+ function instanceOfAutoOrderItemCancelRequest(value) {
29
+ var isInstance = true;
30
+ return isInstance;
31
+ }
32
+ exports.instanceOfAutoOrderItemCancelRequest = instanceOfAutoOrderItemCancelRequest;
33
+ function AutoOrderItemCancelRequestFromJSON(json) {
34
+ return AutoOrderItemCancelRequestFromJSONTyped(json, false);
35
+ }
36
+ exports.AutoOrderItemCancelRequestFromJSON = AutoOrderItemCancelRequestFromJSON;
37
+ function AutoOrderItemCancelRequestFromJSONTyped(json, ignoreDiscriminator) {
38
+ if ((json === undefined) || (json === null)) {
39
+ return json;
40
+ }
41
+ return {
42
+ 'auto_order_item_oid': !(0, runtime_1.exists)(json, 'auto_order_item_oid') ? undefined : json['auto_order_item_oid'],
43
+ 'mode': !(0, runtime_1.exists)(json, 'mode') ? undefined : json['mode'],
44
+ };
45
+ }
46
+ exports.AutoOrderItemCancelRequestFromJSONTyped = AutoOrderItemCancelRequestFromJSONTyped;
47
+ function AutoOrderItemCancelRequestToJSON(value) {
48
+ if (value === undefined) {
49
+ return undefined;
50
+ }
51
+ if (value === null) {
52
+ return null;
53
+ }
54
+ return {
55
+ 'auto_order_item_oid': value.auto_order_item_oid,
56
+ 'mode': value.mode,
57
+ };
58
+ }
59
+ exports.AutoOrderItemCancelRequestToJSON = AutoOrderItemCancelRequestToJSON;
@@ -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;
@@ -111,6 +111,12 @@ export interface OrderFormat {
111
111
  * @memberof OrderFormat
112
112
  */
113
113
  translate?: boolean;
114
+ /**
115
+ * True to render phone numbers as <phone-number-format> web components in the HTML output. Only honored by the div format. Default false preserves legacy scalar rendering for receipts and unauthenticated consumers.
116
+ * @type {boolean}
117
+ * @memberof OrderFormat
118
+ */
119
+ use_phone_number_web_component?: boolean;
114
120
  }
115
121
  /**
116
122
  * @export