ultracart_rest_api_v2_typescript 4.1.100 → 4.1.101

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.
@@ -267,6 +267,7 @@ src/models/ConversationPbxCallTimeline.ts
267
267
  src/models/ConversationPbxCallTranscript.ts
268
268
  src/models/ConversationPbxCallTranscriptSegment.ts
269
269
  src/models/ConversationPbxCallTransfer.ts
270
+ src/models/ConversationPbxCallUpdateRequest.ts
270
271
  src/models/ConversationPbxClassOfService.ts
271
272
  src/models/ConversationPbxClassOfServiceResponse.ts
272
273
  src/models/ConversationPbxClassOfServicesResponse.ts
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # UltraCart Typescript SDK
2
- ## ultracart_rest_api_v2_typescript@4.1.100
2
+ ## ultracart_rest_api_v2_typescript@4.1.101
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.100 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.101 --save
10
10
  ```
11
11
 
12
12
  ```typescript
@@ -85,6 +85,7 @@ Not every change is committed to every SDK.
85
85
 
86
86
  | Version | Date | Comments |
87
87
  | --: | :-: | --- |
88
+ | 4.1.101 | 06/10/2026 | conversation pbx call notes fields |
88
89
  | 4.1.100 | 06/05/2026 | webhook log summary filtering |
89
90
  | 4.1.99 | 06/05/2026 | added webhook name and merchant_comments |
90
91
  | 4.1.98 | 06/04/2026 | coupon - new coupon type for amount off items with free shipping |
@@ -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, ConversationAgentStatusConfig, ConversationAgentStatusConfigResponse, ConversationAgentStatusConfigsResponse, ConversationAgentStatusHeatmapRequest, ConversationAgentStatusHeatmapResponse, ConversationAgentStatusHistorySearchRequest, ConversationAgentStatusHistorySearchResponse, ConversationAgentStatusRollupSearchRequest, ConversationAgentStatusRollupSearchResponse, ConversationAgentStatusSummaryResponse, ConversationAgentStatusTimelineResponse, 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, ConversationPbxDefaultTimezoneResponse, ConversationPbxDefaultTimezoneUpdateRequest, 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';
13
+ import { BaseResponse, ConversationAgentAuthResponse, ConversationAgentProfile, ConversationAgentProfileResponse, ConversationAgentProfilesResponse, ConversationAgentStatusConfig, ConversationAgentStatusConfigResponse, ConversationAgentStatusConfigsResponse, ConversationAgentStatusHeatmapRequest, ConversationAgentStatusHeatmapResponse, ConversationAgentStatusHistorySearchRequest, ConversationAgentStatusHistorySearchResponse, ConversationAgentStatusRollupSearchRequest, ConversationAgentStatusRollupSearchResponse, ConversationAgentStatusSummaryResponse, ConversationAgentStatusTimelineResponse, 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, ConversationPbxCallUpdateRequest, ConversationPbxClassOfService, ConversationPbxClassOfServiceResponse, ConversationPbxClassOfServicesResponse, ConversationPbxCosAuditLogsResponse, ConversationPbxCustomerSnapshotRequest, ConversationPbxCustomerSnapshotResponse, ConversationPbxDefaultTimezoneResponse, ConversationPbxDefaultTimezoneUpdateRequest, 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;
@@ -354,6 +354,10 @@ export interface UpdatePbxAudioRequest {
354
354
  conversationPbxAudioUuid: string;
355
355
  pbxAudio: ConversationPbxAudio;
356
356
  }
357
+ export interface UpdatePbxCallRequest {
358
+ callUuid: string;
359
+ updateRequest: ConversationPbxCallUpdateRequest;
360
+ }
357
361
  export interface UpdatePbxClassOfServiceRequest {
358
362
  classOfServiceUuid: string;
359
363
  classOfService: ConversationPbxClassOfService;
@@ -2217,6 +2221,21 @@ export interface ConversationApiInterface {
2217
2221
  * Update pbx audio
2218
2222
  */
2219
2223
  updatePbxAudio(requestParameters: UpdatePbxAudioRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxAudioResponse>;
2224
+ /**
2225
+ * Update the agent-authored fields (notes, finalize) on a PBX call record
2226
+ * @summary Update pbx call record
2227
+ * @param {string} callUuid
2228
+ * @param {ConversationPbxCallUpdateRequest} updateRequest Update Request
2229
+ * @param {*} [options] Override http request option.
2230
+ * @throws {RequiredError}
2231
+ * @memberof ConversationApiInterface
2232
+ */
2233
+ updatePbxCallRaw(requestParameters: UpdatePbxCallRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxCallResponse>>;
2234
+ /**
2235
+ * Update the agent-authored fields (notes, finalize) on a PBX call record
2236
+ * Update pbx call record
2237
+ */
2238
+ updatePbxCall(requestParameters: UpdatePbxCallRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxCallResponse>;
2220
2239
  /**
2221
2240
  * Update an existing class of service
2222
2241
  * @summary Update pbx class of service
@@ -3679,6 +3698,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
3679
3698
  * Update pbx audio
3680
3699
  */
3681
3700
  updatePbxAudio(requestParameters: UpdatePbxAudioRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxAudioResponse>;
3701
+ /**
3702
+ * Update the agent-authored fields (notes, finalize) on a PBX call record
3703
+ * Update pbx call record
3704
+ */
3705
+ updatePbxCallRaw(requestParameters: UpdatePbxCallRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxCallResponse>>;
3706
+ /**
3707
+ * Update the agent-authored fields (notes, finalize) on a PBX call record
3708
+ * Update pbx call record
3709
+ */
3710
+ updatePbxCall(requestParameters: UpdatePbxCallRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxCallResponse>;
3682
3711
  /**
3683
3712
  * Update an existing class of service
3684
3713
  * Update pbx class of service
@@ -7737,6 +7737,70 @@ var ConversationApi = /** @class */ (function (_super) {
7737
7737
  });
7738
7738
  });
7739
7739
  };
7740
+ /**
7741
+ * Update the agent-authored fields (notes, finalize) on a PBX call record
7742
+ * Update pbx call record
7743
+ */
7744
+ ConversationApi.prototype.updatePbxCallRaw = function (requestParameters, initOverrides) {
7745
+ return __awaiter(this, void 0, void 0, function () {
7746
+ var queryParameters, headerParameters, _a, _b, response;
7747
+ return __generator(this, function (_c) {
7748
+ switch (_c.label) {
7749
+ case 0:
7750
+ if (requestParameters.callUuid === null || requestParameters.callUuid === undefined) {
7751
+ throw new runtime.RequiredError('callUuid', 'Required parameter requestParameters.callUuid was null or undefined when calling updatePbxCall.');
7752
+ }
7753
+ if (requestParameters.updateRequest === null || requestParameters.updateRequest === undefined) {
7754
+ throw new runtime.RequiredError('updateRequest', 'Required parameter requestParameters.updateRequest was null or undefined when calling updatePbxCall.');
7755
+ }
7756
+ queryParameters = {};
7757
+ headerParameters = {};
7758
+ headerParameters['Content-Type'] = 'application/json';
7759
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
7760
+ // oauth required
7761
+ _a = headerParameters;
7762
+ _b = "Authorization";
7763
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["conversation_write"])];
7764
+ case 1:
7765
+ // oauth required
7766
+ _a[_b] = _c.sent();
7767
+ _c.label = 2;
7768
+ case 2:
7769
+ if (this.configuration && this.configuration.apiKey) {
7770
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
7771
+ }
7772
+ return [4 /*yield*/, this.request({
7773
+ path: "/conversation/pbx/call/{callUuid}".replace("{".concat("callUuid", "}"), encodeURIComponent(String(requestParameters.callUuid))),
7774
+ method: 'PUT',
7775
+ headers: headerParameters,
7776
+ query: queryParameters,
7777
+ body: (0, models_1.ConversationPbxCallUpdateRequestToJSON)(requestParameters.updateRequest),
7778
+ }, initOverrides)];
7779
+ case 3:
7780
+ response = _c.sent();
7781
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ConversationPbxCallResponseFromJSON)(jsonValue); })];
7782
+ }
7783
+ });
7784
+ });
7785
+ };
7786
+ /**
7787
+ * Update the agent-authored fields (notes, finalize) on a PBX call record
7788
+ * Update pbx call record
7789
+ */
7790
+ ConversationApi.prototype.updatePbxCall = function (requestParameters, initOverrides) {
7791
+ return __awaiter(this, void 0, void 0, function () {
7792
+ var response;
7793
+ return __generator(this, function (_a) {
7794
+ switch (_a.label) {
7795
+ case 0: return [4 /*yield*/, this.updatePbxCallRaw(requestParameters, initOverrides)];
7796
+ case 1:
7797
+ response = _a.sent();
7798
+ return [4 /*yield*/, response.value()];
7799
+ case 2: return [2 /*return*/, _a.sent()];
7800
+ }
7801
+ });
7802
+ });
7803
+ };
7740
7804
  /**
7741
7805
  * Update an existing class of service
7742
7806
  * Update pbx class of service
@@ -127,6 +127,18 @@ export interface ConversationPbxCall {
127
127
  * @memberof ConversationPbxCall
128
128
  */
129
129
  merchant_id?: string;
130
+ /**
131
+ * Agent-authored notes for this call, captured during the call and after-call work
132
+ * @type {string}
133
+ * @memberof ConversationPbxCall
134
+ */
135
+ notes?: string;
136
+ /**
137
+ * Timestamp when the agent finalized notes via Save & finish; gates Zoho Desk ticket creation
138
+ * @type {string}
139
+ * @memberof ConversationPbxCall
140
+ */
141
+ notes_finalized_dts?: string;
130
142
  /**
131
143
  * List of all Twilio recording SIDs associated with this call
132
144
  * @type {Array<string>}
@@ -59,6 +59,8 @@ function ConversationPbxCallFromJSONTyped(json, ignoreDiscriminator) {
59
59
  'financial': !(0, runtime_1.exists)(json, 'financial') ? undefined : (0, ConversationPbxCallFinancial_1.ConversationPbxCallFinancialFromJSON)(json['financial']),
60
60
  'holds': !(0, runtime_1.exists)(json, 'holds') ? undefined : (json['holds'].map(ConversationPbxCallHold_1.ConversationPbxCallHoldFromJSON)),
61
61
  'merchant_id': !(0, runtime_1.exists)(json, 'merchant_id') ? undefined : json['merchant_id'],
62
+ 'notes': !(0, runtime_1.exists)(json, 'notes') ? undefined : json['notes'],
63
+ 'notes_finalized_dts': !(0, runtime_1.exists)(json, 'notes_finalized_dts') ? undefined : json['notes_finalized_dts'],
62
64
  'recording_sids': !(0, runtime_1.exists)(json, 'recording_sids') ? undefined : json['recording_sids'],
63
65
  'recordings': !(0, runtime_1.exists)(json, 'recordings') ? undefined : (json['recordings'].map(ConversationPbxCallRecording_1.ConversationPbxCallRecordingFromJSON)),
64
66
  'routing': !(0, runtime_1.exists)(json, 'routing') ? undefined : (0, ConversationPbxCallRouting_1.ConversationPbxCallRoutingFromJSON)(json['routing']),
@@ -96,6 +98,8 @@ function ConversationPbxCallToJSON(value) {
96
98
  'financial': (0, ConversationPbxCallFinancial_1.ConversationPbxCallFinancialToJSON)(value.financial),
97
99
  'holds': value.holds === undefined ? undefined : (value.holds.map(ConversationPbxCallHold_1.ConversationPbxCallHoldToJSON)),
98
100
  'merchant_id': value.merchant_id,
101
+ 'notes': value.notes,
102
+ 'notes_finalized_dts': value.notes_finalized_dts,
99
103
  'recording_sids': value.recording_sids,
100
104
  'recordings': value.recordings === undefined ? undefined : (value.recordings.map(ConversationPbxCallRecording_1.ConversationPbxCallRecordingToJSON)),
101
105
  'routing': (0, ConversationPbxCallRouting_1.ConversationPbxCallRoutingToJSON)(value.routing),
@@ -0,0 +1,37 @@
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 ConversationPbxCallUpdateRequest
16
+ */
17
+ export interface ConversationPbxCallUpdateRequest {
18
+ /**
19
+ * True when the agent has finished after-call work (Save & finish). Stamps notes_finalized_dts, which together with transcript availability gates Zoho Desk ticket creation.
20
+ * @type {boolean}
21
+ * @memberof ConversationPbxCallUpdateRequest
22
+ */
23
+ finalize?: boolean;
24
+ /**
25
+ * Agent-authored notes for the call. Card-like values are scrubbed server-side for PCI compliance.
26
+ * @type {string}
27
+ * @memberof ConversationPbxCallUpdateRequest
28
+ */
29
+ notes?: string;
30
+ }
31
+ /**
32
+ * Check if a given object implements the ConversationPbxCallUpdateRequest interface.
33
+ */
34
+ export declare function instanceOfConversationPbxCallUpdateRequest(value: object): boolean;
35
+ export declare function ConversationPbxCallUpdateRequestFromJSON(json: any): ConversationPbxCallUpdateRequest;
36
+ export declare function ConversationPbxCallUpdateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationPbxCallUpdateRequest;
37
+ export declare function ConversationPbxCallUpdateRequestToJSON(value?: ConversationPbxCallUpdateRequest | null): any;
@@ -0,0 +1,52 @@
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.ConversationPbxCallUpdateRequestToJSON = exports.ConversationPbxCallUpdateRequestFromJSONTyped = exports.ConversationPbxCallUpdateRequestFromJSON = exports.instanceOfConversationPbxCallUpdateRequest = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ /**
19
+ * Check if a given object implements the ConversationPbxCallUpdateRequest interface.
20
+ */
21
+ function instanceOfConversationPbxCallUpdateRequest(value) {
22
+ var isInstance = true;
23
+ return isInstance;
24
+ }
25
+ exports.instanceOfConversationPbxCallUpdateRequest = instanceOfConversationPbxCallUpdateRequest;
26
+ function ConversationPbxCallUpdateRequestFromJSON(json) {
27
+ return ConversationPbxCallUpdateRequestFromJSONTyped(json, false);
28
+ }
29
+ exports.ConversationPbxCallUpdateRequestFromJSON = ConversationPbxCallUpdateRequestFromJSON;
30
+ function ConversationPbxCallUpdateRequestFromJSONTyped(json, ignoreDiscriminator) {
31
+ if ((json === undefined) || (json === null)) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'finalize': !(0, runtime_1.exists)(json, 'finalize') ? undefined : json['finalize'],
36
+ 'notes': !(0, runtime_1.exists)(json, 'notes') ? undefined : json['notes'],
37
+ };
38
+ }
39
+ exports.ConversationPbxCallUpdateRequestFromJSONTyped = ConversationPbxCallUpdateRequestFromJSONTyped;
40
+ function ConversationPbxCallUpdateRequestToJSON(value) {
41
+ if (value === undefined) {
42
+ return undefined;
43
+ }
44
+ if (value === null) {
45
+ return null;
46
+ }
47
+ return {
48
+ 'finalize': value.finalize,
49
+ 'notes': value.notes,
50
+ };
51
+ }
52
+ exports.ConversationPbxCallUpdateRequestToJSON = ConversationPbxCallUpdateRequestToJSON;
@@ -239,6 +239,7 @@ export * from './ConversationPbxCallTimeline';
239
239
  export * from './ConversationPbxCallTranscript';
240
240
  export * from './ConversationPbxCallTranscriptSegment';
241
241
  export * from './ConversationPbxCallTransfer';
242
+ export * from './ConversationPbxCallUpdateRequest';
242
243
  export * from './ConversationPbxClassOfService';
243
244
  export * from './ConversationPbxClassOfServiceResponse';
244
245
  export * from './ConversationPbxClassOfServicesResponse';
@@ -257,6 +257,7 @@ __exportStar(require("./ConversationPbxCallTimeline"), exports);
257
257
  __exportStar(require("./ConversationPbxCallTranscript"), exports);
258
258
  __exportStar(require("./ConversationPbxCallTranscriptSegment"), exports);
259
259
  __exportStar(require("./ConversationPbxCallTransfer"), exports);
260
+ __exportStar(require("./ConversationPbxCallUpdateRequest"), exports);
260
261
  __exportStar(require("./ConversationPbxClassOfService"), exports);
261
262
  __exportStar(require("./ConversationPbxClassOfServiceResponse"), exports);
262
263
  __exportStar(require("./ConversationPbxClassOfServicesResponse"), exports);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "4.1.100",
3
+ "version": "4.1.101",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "repository": {
@@ -186,6 +186,9 @@ import {
186
186
  ConversationPbxCallSearchResponse,
187
187
  ConversationPbxCallSearchResponseFromJSON,
188
188
  ConversationPbxCallSearchResponseToJSON,
189
+ ConversationPbxCallUpdateRequest,
190
+ ConversationPbxCallUpdateRequestFromJSON,
191
+ ConversationPbxCallUpdateRequestToJSON,
189
192
  ConversationPbxClassOfService,
190
193
  ConversationPbxClassOfServiceFromJSON,
191
194
  ConversationPbxClassOfServiceToJSON,
@@ -779,6 +782,11 @@ export interface UpdatePbxAudioRequest {
779
782
  pbxAudio: ConversationPbxAudio;
780
783
  }
781
784
 
785
+ export interface UpdatePbxCallRequest {
786
+ callUuid: string;
787
+ updateRequest: ConversationPbxCallUpdateRequest;
788
+ }
789
+
782
790
  export interface UpdatePbxClassOfServiceRequest {
783
791
  classOfServiceUuid: string;
784
792
  classOfService: ConversationPbxClassOfService;
@@ -2910,6 +2918,23 @@ export interface ConversationApiInterface {
2910
2918
  */
2911
2919
  updatePbxAudio(requestParameters: UpdatePbxAudioRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxAudioResponse>;
2912
2920
 
2921
+ /**
2922
+ * Update the agent-authored fields (notes, finalize) on a PBX call record
2923
+ * @summary Update pbx call record
2924
+ * @param {string} callUuid
2925
+ * @param {ConversationPbxCallUpdateRequest} updateRequest Update Request
2926
+ * @param {*} [options] Override http request option.
2927
+ * @throws {RequiredError}
2928
+ * @memberof ConversationApiInterface
2929
+ */
2930
+ updatePbxCallRaw(requestParameters: UpdatePbxCallRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxCallResponse>>;
2931
+
2932
+ /**
2933
+ * Update the agent-authored fields (notes, finalize) on a PBX call record
2934
+ * Update pbx call record
2935
+ */
2936
+ updatePbxCall(requestParameters: UpdatePbxCallRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxCallResponse>;
2937
+
2913
2938
  /**
2914
2939
  * Update an existing class of service
2915
2940
  * @summary Update pbx class of service
@@ -8551,6 +8576,54 @@ export class ConversationApi extends runtime.BaseAPI implements ConversationApiI
8551
8576
  return await response.value();
8552
8577
  }
8553
8578
 
8579
+ /**
8580
+ * Update the agent-authored fields (notes, finalize) on a PBX call record
8581
+ * Update pbx call record
8582
+ */
8583
+ async updatePbxCallRaw(requestParameters: UpdatePbxCallRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxCallResponse>> {
8584
+ if (requestParameters.callUuid === null || requestParameters.callUuid === undefined) {
8585
+ throw new runtime.RequiredError('callUuid','Required parameter requestParameters.callUuid was null or undefined when calling updatePbxCall.');
8586
+ }
8587
+
8588
+ if (requestParameters.updateRequest === null || requestParameters.updateRequest === undefined) {
8589
+ throw new runtime.RequiredError('updateRequest','Required parameter requestParameters.updateRequest was null or undefined when calling updatePbxCall.');
8590
+ }
8591
+
8592
+ const queryParameters: any = {};
8593
+
8594
+ const headerParameters: runtime.HTTPHeaders = {};
8595
+
8596
+ headerParameters['Content-Type'] = 'application/json';
8597
+
8598
+ if (this.configuration && this.configuration.accessToken) {
8599
+ // oauth required
8600
+ headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["conversation_write"]);
8601
+ }
8602
+
8603
+ if (this.configuration && this.configuration.apiKey) {
8604
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
8605
+ }
8606
+
8607
+ const response = await this.request({
8608
+ path: `/conversation/pbx/call/{callUuid}`.replace(`{${"callUuid"}}`, encodeURIComponent(String(requestParameters.callUuid))),
8609
+ method: 'PUT',
8610
+ headers: headerParameters,
8611
+ query: queryParameters,
8612
+ body: ConversationPbxCallUpdateRequestToJSON(requestParameters.updateRequest),
8613
+ }, initOverrides);
8614
+
8615
+ return new runtime.JSONApiResponse(response, (jsonValue) => ConversationPbxCallResponseFromJSON(jsonValue));
8616
+ }
8617
+
8618
+ /**
8619
+ * Update the agent-authored fields (notes, finalize) on a PBX call record
8620
+ * Update pbx call record
8621
+ */
8622
+ async updatePbxCall(requestParameters: UpdatePbxCallRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxCallResponse> {
8623
+ const response = await this.updatePbxCallRaw(requestParameters, initOverrides);
8624
+ return await response.value();
8625
+ }
8626
+
8554
8627
  /**
8555
8628
  * Update an existing class of service
8556
8629
  * Update pbx class of service
@@ -182,6 +182,18 @@ export interface ConversationPbxCall {
182
182
  * @memberof ConversationPbxCall
183
183
  */
184
184
  merchant_id?: string;
185
+ /**
186
+ * Agent-authored notes for this call, captured during the call and after-call work
187
+ * @type {string}
188
+ * @memberof ConversationPbxCall
189
+ */
190
+ notes?: string;
191
+ /**
192
+ * Timestamp when the agent finalized notes via Save & finish; gates Zoho Desk ticket creation
193
+ * @type {string}
194
+ * @memberof ConversationPbxCall
195
+ */
196
+ notes_finalized_dts?: string;
185
197
  /**
186
198
  * List of all Twilio recording SIDs associated with this call
187
199
  * @type {Array<string>}
@@ -276,6 +288,8 @@ export function ConversationPbxCallFromJSONTyped(json: any, ignoreDiscriminator:
276
288
  'financial': !exists(json, 'financial') ? undefined : ConversationPbxCallFinancialFromJSON(json['financial']),
277
289
  'holds': !exists(json, 'holds') ? undefined : ((json['holds'] as Array<any>).map(ConversationPbxCallHoldFromJSON)),
278
290
  'merchant_id': !exists(json, 'merchant_id') ? undefined : json['merchant_id'],
291
+ 'notes': !exists(json, 'notes') ? undefined : json['notes'],
292
+ 'notes_finalized_dts': !exists(json, 'notes_finalized_dts') ? undefined : json['notes_finalized_dts'],
279
293
  'recording_sids': !exists(json, 'recording_sids') ? undefined : json['recording_sids'],
280
294
  'recordings': !exists(json, 'recordings') ? undefined : ((json['recordings'] as Array<any>).map(ConversationPbxCallRecordingFromJSON)),
281
295
  'routing': !exists(json, 'routing') ? undefined : ConversationPbxCallRoutingFromJSON(json['routing']),
@@ -314,6 +328,8 @@ export function ConversationPbxCallToJSON(value?: ConversationPbxCall | null): a
314
328
  'financial': ConversationPbxCallFinancialToJSON(value.financial),
315
329
  'holds': value.holds === undefined ? undefined : ((value.holds as Array<any>).map(ConversationPbxCallHoldToJSON)),
316
330
  'merchant_id': value.merchant_id,
331
+ 'notes': value.notes,
332
+ 'notes_finalized_dts': value.notes_finalized_dts,
317
333
  'recording_sids': value.recording_sids,
318
334
  'recordings': value.recordings === undefined ? undefined : ((value.recordings as Array<any>).map(ConversationPbxCallRecordingToJSON)),
319
335
  'routing': ConversationPbxCallRoutingToJSON(value.routing),
@@ -0,0 +1,75 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * UltraCart Rest API V2
5
+ * UltraCart REST API Version 2
6
+ *
7
+ * The version of the OpenAPI document: 2.0.0
8
+ * Contact: support@ultracart.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { exists, mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface ConversationPbxCallUpdateRequest
20
+ */
21
+ export interface ConversationPbxCallUpdateRequest {
22
+ /**
23
+ * True when the agent has finished after-call work (Save & finish). Stamps notes_finalized_dts, which together with transcript availability gates Zoho Desk ticket creation.
24
+ * @type {boolean}
25
+ * @memberof ConversationPbxCallUpdateRequest
26
+ */
27
+ finalize?: boolean;
28
+ /**
29
+ * Agent-authored notes for the call. Card-like values are scrubbed server-side for PCI compliance.
30
+ * @type {string}
31
+ * @memberof ConversationPbxCallUpdateRequest
32
+ */
33
+ notes?: string;
34
+ }
35
+
36
+
37
+
38
+ /**
39
+ * Check if a given object implements the ConversationPbxCallUpdateRequest interface.
40
+ */
41
+ export function instanceOfConversationPbxCallUpdateRequest(value: object): boolean {
42
+ let isInstance = true;
43
+
44
+ return isInstance;
45
+ }
46
+
47
+ export function ConversationPbxCallUpdateRequestFromJSON(json: any): ConversationPbxCallUpdateRequest {
48
+ return ConversationPbxCallUpdateRequestFromJSONTyped(json, false);
49
+ }
50
+
51
+ export function ConversationPbxCallUpdateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationPbxCallUpdateRequest {
52
+ if ((json === undefined) || (json === null)) {
53
+ return json;
54
+ }
55
+ return {
56
+
57
+ 'finalize': !exists(json, 'finalize') ? undefined : json['finalize'],
58
+ 'notes': !exists(json, 'notes') ? undefined : json['notes'],
59
+ };
60
+ }
61
+
62
+ export function ConversationPbxCallUpdateRequestToJSON(value?: ConversationPbxCallUpdateRequest | null): any {
63
+ if (value === undefined) {
64
+ return undefined;
65
+ }
66
+ if (value === null) {
67
+ return null;
68
+ }
69
+ return {
70
+
71
+ 'finalize': value.finalize,
72
+ 'notes': value.notes,
73
+ };
74
+ }
75
+
@@ -241,6 +241,7 @@ export * from './ConversationPbxCallTimeline';
241
241
  export * from './ConversationPbxCallTranscript';
242
242
  export * from './ConversationPbxCallTranscriptSegment';
243
243
  export * from './ConversationPbxCallTransfer';
244
+ export * from './ConversationPbxCallUpdateRequest';
244
245
  export * from './ConversationPbxClassOfService';
245
246
  export * from './ConversationPbxClassOfServiceResponse';
246
247
  export * from './ConversationPbxClassOfServicesResponse';