bandwidth-sdk 1.0.2 → 2.0.0
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.
- package/.github/workflows/test-nightly.yml +53 -53
- package/.github/workflows/test-pr.yml +40 -38
- package/.openapi-generator/FILES +6 -2
- package/README.md +40 -0
- package/api/recordings-api.ts +77 -77
- package/api/transcriptions-api.ts +320 -0
- package/api.ts +1 -0
- package/bandwidth.yml +223 -17
- package/base.ts +22 -4
- package/coverage/clover.xml +543 -451
- package/coverage/coverage-final.json +58 -56
- package/coverage/lcov-report/index.html +20 -20
- package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +105 -105
- package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/index.html +24 -9
- package/coverage/lcov-report/node-sdk/api/media-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +78 -78
- package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/transcriptions-api.ts.html +1045 -0
- package/coverage/lcov-report/node-sdk/base.ts.html +72 -18
- package/coverage/lcov-report/node-sdk/common.ts.html +32 -32
- package/coverage/lcov-report/node-sdk/configuration.ts.html +15 -15
- package/coverage/lcov-report/node-sdk/index.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/Bxml.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/NestableVerb.ts.html +6 -6
- package/coverage/lcov-report/node-sdk/models/bxml/Response.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/Root.ts.html +8 -8
- package/coverage/lcov-report/node-sdk/models/bxml/Verb.ts.html +6 -6
- package/coverage/lcov-report/node-sdk/models/bxml/index.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/index.ts.html +3 -3
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Bridge.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Conference.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/CustomParam.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Forward.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Gather.ts.html +7 -7
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Hangup.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Pause.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PauseRecording.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PhoneNumber.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PlayAudio.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Record.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Redirect.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/ResumeRecording.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Ring.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SendDtmf.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SipUri.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SpeakSentence.ts.html +6 -6
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartGather.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartRecording.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartStream.ts.html +5 -5
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartTranscription.ts.html +5 -5
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopGather.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopRecording.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopStream.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopTranscription.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StreamParam.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Tag.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Transfer.ts.html +5 -5
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.ts.html +31 -31
- package/coverage/lcov-report/node-sdk/models/call-direction-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/call-state-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/call-transcription.ts.html +274 -0
- package/coverage/lcov-report/node-sdk/models/callback-method-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/conference-state-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/file-format-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/index.html +20 -5
- package/coverage/lcov-report/node-sdk/models/index.ts.html +103 -94
- package/coverage/lcov-report/node-sdk/models/list-message-direction-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/lookup-status-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/machine-detection-mode-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/message-direction-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/message-status-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/message-type-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/priority-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/recording-state-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/redirect-method-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/tests/callUtils.js.html +34 -34
- package/coverage/lcov-report/node-sdk/tests/index.html +1 -1
- package/coverage/lcov.info +866 -637
- package/custom_templates/README.mustache +40 -0
- package/dist/api/recordings-api.d.ts +45 -45
- package/dist/api/recordings-api.js +75 -75
- package/dist/api/transcriptions-api.d.ts +161 -0
- package/dist/api/transcriptions-api.js +406 -0
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/base.js +22 -4
- package/dist/models/call-recording-metadata.d.ts +3 -3
- package/dist/models/call-transcription-metadata.d.ts +30 -0
- package/dist/models/call-transcription-metadata.js +15 -0
- package/dist/models/call-transcription-response.d.ts +43 -0
- package/dist/models/call-transcription-response.js +15 -0
- package/dist/models/call-transcription.d.ts +53 -0
- package/dist/models/call-transcription.js +25 -0
- package/dist/models/index.d.ts +5 -2
- package/dist/models/index.js +5 -2
- package/dist/models/recording-available-callback.d.ts +3 -3
- package/dist/models/recording-transcription-metadata.d.ts +42 -0
- package/dist/models/recording-transcription-metadata.js +15 -0
- package/dist/models/recording-transcriptions.d.ts +25 -0
- package/dist/models/recording-transcriptions.js +15 -0
- package/models/call-recording-metadata.ts +3 -3
- package/models/call-transcription-metadata.ts +36 -0
- package/models/call-transcription-response.ts +51 -0
- package/models/call-transcription.ts +63 -0
- package/models/index.ts +5 -2
- package/models/recording-available-callback.ts +3 -3
- package/models/recording-transcription-metadata.ts +48 -0
- package/models/recording-transcriptions.ts +33 -0
- package/package.json +1 -1
- package/tests/integration/recordings-api.test.js +6 -6
- package/tests/integration/transcriptions-api.test.js +85 -0
|
@@ -90,26 +90,26 @@ var RecordingsApiAxiosParamCreator = function (configuration) {
|
|
|
90
90
|
var _this = this;
|
|
91
91
|
return {
|
|
92
92
|
/**
|
|
93
|
-
*
|
|
94
|
-
* @summary Delete
|
|
93
|
+
* Delete the recording information, media and transcription. Note: After the deletion is requested and a `204` is returned, neither the recording metadata nor the actual media nor its transcription will be accessible anymore. However, the media of the specified recording is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
|
|
94
|
+
* @summary Delete Recording
|
|
95
95
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
96
96
|
* @param {string} callId Programmable Voice API Call ID.
|
|
97
97
|
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
98
98
|
* @param {*} [options] Override http request option.
|
|
99
99
|
* @throws {RequiredError}
|
|
100
100
|
*/
|
|
101
|
-
|
|
101
|
+
deleteRecording: function (accountId, callId, recordingId, options) {
|
|
102
102
|
if (options === void 0) { options = {}; }
|
|
103
103
|
return __awaiter(_this, void 0, void 0, function () {
|
|
104
104
|
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
105
105
|
return __generator(this, function (_a) {
|
|
106
106
|
// verify required parameter 'accountId' is not null or undefined
|
|
107
|
-
(0, common_1.assertParamExists)('
|
|
107
|
+
(0, common_1.assertParamExists)('deleteRecording', 'accountId', accountId);
|
|
108
108
|
// verify required parameter 'callId' is not null or undefined
|
|
109
|
-
(0, common_1.assertParamExists)('
|
|
109
|
+
(0, common_1.assertParamExists)('deleteRecording', 'callId', callId);
|
|
110
110
|
// verify required parameter 'recordingId' is not null or undefined
|
|
111
|
-
(0, common_1.assertParamExists)('
|
|
112
|
-
localVarPath = "/accounts/{accountId}/calls/{callId}/recordings/{recordingId}
|
|
111
|
+
(0, common_1.assertParamExists)('deleteRecording', 'recordingId', recordingId);
|
|
112
|
+
localVarPath = "/accounts/{accountId}/calls/{callId}/recordings/{recordingId}"
|
|
113
113
|
.replace("{".concat("accountId", "}"), encodeURIComponent(String(accountId)))
|
|
114
114
|
.replace("{".concat("callId", "}"), encodeURIComponent(String(callId)))
|
|
115
115
|
.replace("{".concat("recordingId", "}"), encodeURIComponent(String(recordingId)));
|
|
@@ -134,26 +134,26 @@ var RecordingsApiAxiosParamCreator = function (configuration) {
|
|
|
134
134
|
});
|
|
135
135
|
},
|
|
136
136
|
/**
|
|
137
|
-
*
|
|
138
|
-
* @summary Delete Recording
|
|
137
|
+
* Deletes the specified recording\'s media.
|
|
138
|
+
* @summary Delete Recording Media
|
|
139
139
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
140
140
|
* @param {string} callId Programmable Voice API Call ID.
|
|
141
141
|
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
142
142
|
* @param {*} [options] Override http request option.
|
|
143
143
|
* @throws {RequiredError}
|
|
144
144
|
*/
|
|
145
|
-
|
|
145
|
+
deleteRecordingMedia: function (accountId, callId, recordingId, options) {
|
|
146
146
|
if (options === void 0) { options = {}; }
|
|
147
147
|
return __awaiter(_this, void 0, void 0, function () {
|
|
148
148
|
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
149
149
|
return __generator(this, function (_a) {
|
|
150
150
|
// verify required parameter 'accountId' is not null or undefined
|
|
151
|
-
(0, common_1.assertParamExists)('
|
|
151
|
+
(0, common_1.assertParamExists)('deleteRecordingMedia', 'accountId', accountId);
|
|
152
152
|
// verify required parameter 'callId' is not null or undefined
|
|
153
|
-
(0, common_1.assertParamExists)('
|
|
153
|
+
(0, common_1.assertParamExists)('deleteRecordingMedia', 'callId', callId);
|
|
154
154
|
// verify required parameter 'recordingId' is not null or undefined
|
|
155
|
-
(0, common_1.assertParamExists)('
|
|
156
|
-
localVarPath = "/accounts/{accountId}/calls/{callId}/recordings/{recordingId}"
|
|
155
|
+
(0, common_1.assertParamExists)('deleteRecordingMedia', 'recordingId', recordingId);
|
|
156
|
+
localVarPath = "/accounts/{accountId}/calls/{callId}/recordings/{recordingId}/media"
|
|
157
157
|
.replace("{".concat("accountId", "}"), encodeURIComponent(String(accountId)))
|
|
158
158
|
.replace("{".concat("callId", "}"), encodeURIComponent(String(callId)))
|
|
159
159
|
.replace("{".concat("recordingId", "}"), encodeURIComponent(String(recordingId)));
|
|
@@ -178,26 +178,26 @@ var RecordingsApiAxiosParamCreator = function (configuration) {
|
|
|
178
178
|
});
|
|
179
179
|
},
|
|
180
180
|
/**
|
|
181
|
-
* Deletes the specified recording\'s
|
|
182
|
-
* @summary Delete
|
|
181
|
+
* Deletes the specified recording\'s transcription. Note: After the deletion is requested and a `204` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
|
|
182
|
+
* @summary Delete Transcription
|
|
183
183
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
184
184
|
* @param {string} callId Programmable Voice API Call ID.
|
|
185
185
|
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
186
186
|
* @param {*} [options] Override http request option.
|
|
187
187
|
* @throws {RequiredError}
|
|
188
188
|
*/
|
|
189
|
-
|
|
189
|
+
deleteRecordingTranscription: function (accountId, callId, recordingId, options) {
|
|
190
190
|
if (options === void 0) { options = {}; }
|
|
191
191
|
return __awaiter(_this, void 0, void 0, function () {
|
|
192
192
|
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
193
193
|
return __generator(this, function (_a) {
|
|
194
194
|
// verify required parameter 'accountId' is not null or undefined
|
|
195
|
-
(0, common_1.assertParamExists)('
|
|
195
|
+
(0, common_1.assertParamExists)('deleteRecordingTranscription', 'accountId', accountId);
|
|
196
196
|
// verify required parameter 'callId' is not null or undefined
|
|
197
|
-
(0, common_1.assertParamExists)('
|
|
197
|
+
(0, common_1.assertParamExists)('deleteRecordingTranscription', 'callId', callId);
|
|
198
198
|
// verify required parameter 'recordingId' is not null or undefined
|
|
199
|
-
(0, common_1.assertParamExists)('
|
|
200
|
-
localVarPath = "/accounts/{accountId}/calls/{callId}/recordings/{recordingId}/
|
|
199
|
+
(0, common_1.assertParamExists)('deleteRecordingTranscription', 'recordingId', recordingId);
|
|
200
|
+
localVarPath = "/accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription"
|
|
201
201
|
.replace("{".concat("accountId", "}"), encodeURIComponent(String(accountId)))
|
|
202
202
|
.replace("{".concat("callId", "}"), encodeURIComponent(String(callId)))
|
|
203
203
|
.replace("{".concat("recordingId", "}"), encodeURIComponent(String(recordingId)));
|
|
@@ -310,7 +310,7 @@ var RecordingsApiAxiosParamCreator = function (configuration) {
|
|
|
310
310
|
});
|
|
311
311
|
},
|
|
312
312
|
/**
|
|
313
|
-
* Downloads the specified transcription.
|
|
313
|
+
* Downloads the specified transcription. If the recording was multi-channel, then there will be 2 transcripts. The caller/called party transcript will be the first item while [`<PlayAudio>`](/docs/voice/bxml/playAudio) and [`<SpeakSentence>`](/docs/voice/bxml/speakSentence) transcript will be the second item. During a [`<Transfer>`](/docs/voice/bxml/transfer) the A-leg transcript will be the first item while the B-leg transcript will be the second item.
|
|
314
314
|
* @summary Get Transcription
|
|
315
315
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
316
316
|
* @param {string} callId Programmable Voice API Call ID.
|
|
@@ -318,17 +318,17 @@ var RecordingsApiAxiosParamCreator = function (configuration) {
|
|
|
318
318
|
* @param {*} [options] Override http request option.
|
|
319
319
|
* @throws {RequiredError}
|
|
320
320
|
*/
|
|
321
|
-
|
|
321
|
+
getRecordingTranscription: function (accountId, callId, recordingId, options) {
|
|
322
322
|
if (options === void 0) { options = {}; }
|
|
323
323
|
return __awaiter(_this, void 0, void 0, function () {
|
|
324
324
|
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
325
325
|
return __generator(this, function (_a) {
|
|
326
326
|
// verify required parameter 'accountId' is not null or undefined
|
|
327
|
-
(0, common_1.assertParamExists)('
|
|
327
|
+
(0, common_1.assertParamExists)('getRecordingTranscription', 'accountId', accountId);
|
|
328
328
|
// verify required parameter 'callId' is not null or undefined
|
|
329
|
-
(0, common_1.assertParamExists)('
|
|
329
|
+
(0, common_1.assertParamExists)('getRecordingTranscription', 'callId', callId);
|
|
330
330
|
// verify required parameter 'recordingId' is not null or undefined
|
|
331
|
-
(0, common_1.assertParamExists)('
|
|
331
|
+
(0, common_1.assertParamExists)('getRecordingTranscription', 'recordingId', recordingId);
|
|
332
332
|
localVarPath = "/accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription"
|
|
333
333
|
.replace("{".concat("accountId", "}"), encodeURIComponent(String(accountId)))
|
|
334
334
|
.replace("{".concat("callId", "}"), encodeURIComponent(String(callId)))
|
|
@@ -550,75 +550,75 @@ var RecordingsApiFp = function (configuration) {
|
|
|
550
550
|
var localVarAxiosParamCreator = (0, exports.RecordingsApiAxiosParamCreator)(configuration);
|
|
551
551
|
return {
|
|
552
552
|
/**
|
|
553
|
-
*
|
|
554
|
-
* @summary Delete
|
|
553
|
+
* Delete the recording information, media and transcription. Note: After the deletion is requested and a `204` is returned, neither the recording metadata nor the actual media nor its transcription will be accessible anymore. However, the media of the specified recording is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
|
|
554
|
+
* @summary Delete Recording
|
|
555
555
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
556
556
|
* @param {string} callId Programmable Voice API Call ID.
|
|
557
557
|
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
558
558
|
* @param {*} [options] Override http request option.
|
|
559
559
|
* @throws {RequiredError}
|
|
560
560
|
*/
|
|
561
|
-
|
|
561
|
+
deleteRecording: function (accountId, callId, recordingId, options) {
|
|
562
562
|
var _a, _b, _c;
|
|
563
563
|
return __awaiter(this, void 0, void 0, function () {
|
|
564
564
|
var localVarAxiosArgs, index, operationBasePath;
|
|
565
565
|
return __generator(this, function (_d) {
|
|
566
566
|
switch (_d.label) {
|
|
567
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.
|
|
567
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.deleteRecording(accountId, callId, recordingId, options)];
|
|
568
568
|
case 1:
|
|
569
569
|
localVarAxiosArgs = _d.sent();
|
|
570
570
|
index = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
571
|
-
operationBasePath = (_c = (_b = base_1.operationServerMap['RecordingsApi.
|
|
571
|
+
operationBasePath = (_c = (_b = base_1.operationServerMap['RecordingsApi.deleteRecording']) === null || _b === void 0 ? void 0 : _b[index]) === null || _c === void 0 ? void 0 : _c.url;
|
|
572
572
|
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, operationBasePath || basePath); }];
|
|
573
573
|
}
|
|
574
574
|
});
|
|
575
575
|
});
|
|
576
576
|
},
|
|
577
577
|
/**
|
|
578
|
-
*
|
|
579
|
-
* @summary Delete Recording
|
|
578
|
+
* Deletes the specified recording\'s media.
|
|
579
|
+
* @summary Delete Recording Media
|
|
580
580
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
581
581
|
* @param {string} callId Programmable Voice API Call ID.
|
|
582
582
|
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
583
583
|
* @param {*} [options] Override http request option.
|
|
584
584
|
* @throws {RequiredError}
|
|
585
585
|
*/
|
|
586
|
-
|
|
586
|
+
deleteRecordingMedia: function (accountId, callId, recordingId, options) {
|
|
587
587
|
var _a, _b, _c;
|
|
588
588
|
return __awaiter(this, void 0, void 0, function () {
|
|
589
589
|
var localVarAxiosArgs, index, operationBasePath;
|
|
590
590
|
return __generator(this, function (_d) {
|
|
591
591
|
switch (_d.label) {
|
|
592
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.
|
|
592
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.deleteRecordingMedia(accountId, callId, recordingId, options)];
|
|
593
593
|
case 1:
|
|
594
594
|
localVarAxiosArgs = _d.sent();
|
|
595
595
|
index = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
596
|
-
operationBasePath = (_c = (_b = base_1.operationServerMap['RecordingsApi.
|
|
596
|
+
operationBasePath = (_c = (_b = base_1.operationServerMap['RecordingsApi.deleteRecordingMedia']) === null || _b === void 0 ? void 0 : _b[index]) === null || _c === void 0 ? void 0 : _c.url;
|
|
597
597
|
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, operationBasePath || basePath); }];
|
|
598
598
|
}
|
|
599
599
|
});
|
|
600
600
|
});
|
|
601
601
|
},
|
|
602
602
|
/**
|
|
603
|
-
* Deletes the specified recording\'s
|
|
604
|
-
* @summary Delete
|
|
603
|
+
* Deletes the specified recording\'s transcription. Note: After the deletion is requested and a `204` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
|
|
604
|
+
* @summary Delete Transcription
|
|
605
605
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
606
606
|
* @param {string} callId Programmable Voice API Call ID.
|
|
607
607
|
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
608
608
|
* @param {*} [options] Override http request option.
|
|
609
609
|
* @throws {RequiredError}
|
|
610
610
|
*/
|
|
611
|
-
|
|
611
|
+
deleteRecordingTranscription: function (accountId, callId, recordingId, options) {
|
|
612
612
|
var _a, _b, _c;
|
|
613
613
|
return __awaiter(this, void 0, void 0, function () {
|
|
614
614
|
var localVarAxiosArgs, index, operationBasePath;
|
|
615
615
|
return __generator(this, function (_d) {
|
|
616
616
|
switch (_d.label) {
|
|
617
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.
|
|
617
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.deleteRecordingTranscription(accountId, callId, recordingId, options)];
|
|
618
618
|
case 1:
|
|
619
619
|
localVarAxiosArgs = _d.sent();
|
|
620
620
|
index = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
621
|
-
operationBasePath = (_c = (_b = base_1.operationServerMap['RecordingsApi.
|
|
621
|
+
operationBasePath = (_c = (_b = base_1.operationServerMap['RecordingsApi.deleteRecordingTranscription']) === null || _b === void 0 ? void 0 : _b[index]) === null || _c === void 0 ? void 0 : _c.url;
|
|
622
622
|
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, operationBasePath || basePath); }];
|
|
623
623
|
}
|
|
624
624
|
});
|
|
@@ -675,7 +675,7 @@ var RecordingsApiFp = function (configuration) {
|
|
|
675
675
|
});
|
|
676
676
|
},
|
|
677
677
|
/**
|
|
678
|
-
* Downloads the specified transcription.
|
|
678
|
+
* Downloads the specified transcription. If the recording was multi-channel, then there will be 2 transcripts. The caller/called party transcript will be the first item while [`<PlayAudio>`](/docs/voice/bxml/playAudio) and [`<SpeakSentence>`](/docs/voice/bxml/speakSentence) transcript will be the second item. During a [`<Transfer>`](/docs/voice/bxml/transfer) the A-leg transcript will be the first item while the B-leg transcript will be the second item.
|
|
679
679
|
* @summary Get Transcription
|
|
680
680
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
681
681
|
* @param {string} callId Programmable Voice API Call ID.
|
|
@@ -683,17 +683,17 @@ var RecordingsApiFp = function (configuration) {
|
|
|
683
683
|
* @param {*} [options] Override http request option.
|
|
684
684
|
* @throws {RequiredError}
|
|
685
685
|
*/
|
|
686
|
-
|
|
686
|
+
getRecordingTranscription: function (accountId, callId, recordingId, options) {
|
|
687
687
|
var _a, _b, _c;
|
|
688
688
|
return __awaiter(this, void 0, void 0, function () {
|
|
689
689
|
var localVarAxiosArgs, index, operationBasePath;
|
|
690
690
|
return __generator(this, function (_d) {
|
|
691
691
|
switch (_d.label) {
|
|
692
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.
|
|
692
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getRecordingTranscription(accountId, callId, recordingId, options)];
|
|
693
693
|
case 1:
|
|
694
694
|
localVarAxiosArgs = _d.sent();
|
|
695
695
|
index = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
696
|
-
operationBasePath = (_c = (_b = base_1.operationServerMap['RecordingsApi.
|
|
696
|
+
operationBasePath = (_c = (_b = base_1.operationServerMap['RecordingsApi.getRecordingTranscription']) === null || _b === void 0 ? void 0 : _b[index]) === null || _c === void 0 ? void 0 : _c.url;
|
|
697
697
|
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, operationBasePath || basePath); }];
|
|
698
698
|
}
|
|
699
699
|
});
|
|
@@ -811,18 +811,6 @@ exports.RecordingsApiFp = RecordingsApiFp;
|
|
|
811
811
|
var RecordingsApiFactory = function (configuration, basePath, axios) {
|
|
812
812
|
var localVarFp = (0, exports.RecordingsApiFp)(configuration);
|
|
813
813
|
return {
|
|
814
|
-
/**
|
|
815
|
-
* Deletes the specified recording\'s transcription. Note: After the deletion is requested and a `204` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
|
|
816
|
-
* @summary Delete Transcription
|
|
817
|
-
* @param {string} accountId Your Bandwidth Account ID.
|
|
818
|
-
* @param {string} callId Programmable Voice API Call ID.
|
|
819
|
-
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
820
|
-
* @param {*} [options] Override http request option.
|
|
821
|
-
* @throws {RequiredError}
|
|
822
|
-
*/
|
|
823
|
-
deleteCallTranscription: function (accountId, callId, recordingId, options) {
|
|
824
|
-
return localVarFp.deleteCallTranscription(accountId, callId, recordingId, options).then(function (request) { return request(axios, basePath); });
|
|
825
|
-
},
|
|
826
814
|
/**
|
|
827
815
|
* Delete the recording information, media and transcription. Note: After the deletion is requested and a `204` is returned, neither the recording metadata nor the actual media nor its transcription will be accessible anymore. However, the media of the specified recording is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
|
|
828
816
|
* @summary Delete Recording
|
|
@@ -847,6 +835,18 @@ var RecordingsApiFactory = function (configuration, basePath, axios) {
|
|
|
847
835
|
deleteRecordingMedia: function (accountId, callId, recordingId, options) {
|
|
848
836
|
return localVarFp.deleteRecordingMedia(accountId, callId, recordingId, options).then(function (request) { return request(axios, basePath); });
|
|
849
837
|
},
|
|
838
|
+
/**
|
|
839
|
+
* Deletes the specified recording\'s transcription. Note: After the deletion is requested and a `204` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
|
|
840
|
+
* @summary Delete Transcription
|
|
841
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
842
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
843
|
+
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
844
|
+
* @param {*} [options] Override http request option.
|
|
845
|
+
* @throws {RequiredError}
|
|
846
|
+
*/
|
|
847
|
+
deleteRecordingTranscription: function (accountId, callId, recordingId, options) {
|
|
848
|
+
return localVarFp.deleteRecordingTranscription(accountId, callId, recordingId, options).then(function (request) { return request(axios, basePath); });
|
|
849
|
+
},
|
|
850
850
|
/**
|
|
851
851
|
* Downloads the specified recording.
|
|
852
852
|
* @summary Download Recording
|
|
@@ -872,7 +872,7 @@ var RecordingsApiFactory = function (configuration, basePath, axios) {
|
|
|
872
872
|
return localVarFp.getCallRecording(accountId, callId, recordingId, options).then(function (request) { return request(axios, basePath); });
|
|
873
873
|
},
|
|
874
874
|
/**
|
|
875
|
-
* Downloads the specified transcription.
|
|
875
|
+
* Downloads the specified transcription. If the recording was multi-channel, then there will be 2 transcripts. The caller/called party transcript will be the first item while [`<PlayAudio>`](/docs/voice/bxml/playAudio) and [`<SpeakSentence>`](/docs/voice/bxml/speakSentence) transcript will be the second item. During a [`<Transfer>`](/docs/voice/bxml/transfer) the A-leg transcript will be the first item while the B-leg transcript will be the second item.
|
|
876
876
|
* @summary Get Transcription
|
|
877
877
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
878
878
|
* @param {string} callId Programmable Voice API Call ID.
|
|
@@ -880,8 +880,8 @@ var RecordingsApiFactory = function (configuration, basePath, axios) {
|
|
|
880
880
|
* @param {*} [options] Override http request option.
|
|
881
881
|
* @throws {RequiredError}
|
|
882
882
|
*/
|
|
883
|
-
|
|
884
|
-
return localVarFp.
|
|
883
|
+
getRecordingTranscription: function (accountId, callId, recordingId, options) {
|
|
884
|
+
return localVarFp.getRecordingTranscription(accountId, callId, recordingId, options).then(function (request) { return request(axios, basePath); });
|
|
885
885
|
},
|
|
886
886
|
/**
|
|
887
887
|
* Returns a list of metadata for the recordings associated with the specified account. The list can be filtered by the optional from, to, minStartTime, and maxStartTime arguments. The list is capped at 1000 entries and may be empty if no recordings match the specified criteria.
|
|
@@ -948,8 +948,8 @@ var RecordingsApi = /** @class */ (function (_super) {
|
|
|
948
948
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
949
949
|
}
|
|
950
950
|
/**
|
|
951
|
-
*
|
|
952
|
-
* @summary Delete
|
|
951
|
+
* Delete the recording information, media and transcription. Note: After the deletion is requested and a `204` is returned, neither the recording metadata nor the actual media nor its transcription will be accessible anymore. However, the media of the specified recording is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
|
|
952
|
+
* @summary Delete Recording
|
|
953
953
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
954
954
|
* @param {string} callId Programmable Voice API Call ID.
|
|
955
955
|
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
@@ -957,13 +957,13 @@ var RecordingsApi = /** @class */ (function (_super) {
|
|
|
957
957
|
* @throws {RequiredError}
|
|
958
958
|
* @memberof RecordingsApi
|
|
959
959
|
*/
|
|
960
|
-
RecordingsApi.prototype.
|
|
960
|
+
RecordingsApi.prototype.deleteRecording = function (accountId, callId, recordingId, options) {
|
|
961
961
|
var _this = this;
|
|
962
|
-
return (0, exports.RecordingsApiFp)(this.configuration).
|
|
962
|
+
return (0, exports.RecordingsApiFp)(this.configuration).deleteRecording(accountId, callId, recordingId, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
963
963
|
};
|
|
964
964
|
/**
|
|
965
|
-
*
|
|
966
|
-
* @summary Delete Recording
|
|
965
|
+
* Deletes the specified recording\'s media.
|
|
966
|
+
* @summary Delete Recording Media
|
|
967
967
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
968
968
|
* @param {string} callId Programmable Voice API Call ID.
|
|
969
969
|
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
@@ -971,13 +971,13 @@ var RecordingsApi = /** @class */ (function (_super) {
|
|
|
971
971
|
* @throws {RequiredError}
|
|
972
972
|
* @memberof RecordingsApi
|
|
973
973
|
*/
|
|
974
|
-
RecordingsApi.prototype.
|
|
974
|
+
RecordingsApi.prototype.deleteRecordingMedia = function (accountId, callId, recordingId, options) {
|
|
975
975
|
var _this = this;
|
|
976
|
-
return (0, exports.RecordingsApiFp)(this.configuration).
|
|
976
|
+
return (0, exports.RecordingsApiFp)(this.configuration).deleteRecordingMedia(accountId, callId, recordingId, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
977
977
|
};
|
|
978
978
|
/**
|
|
979
|
-
* Deletes the specified recording\'s
|
|
980
|
-
* @summary Delete
|
|
979
|
+
* Deletes the specified recording\'s transcription. Note: After the deletion is requested and a `204` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
|
|
980
|
+
* @summary Delete Transcription
|
|
981
981
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
982
982
|
* @param {string} callId Programmable Voice API Call ID.
|
|
983
983
|
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
@@ -985,9 +985,9 @@ var RecordingsApi = /** @class */ (function (_super) {
|
|
|
985
985
|
* @throws {RequiredError}
|
|
986
986
|
* @memberof RecordingsApi
|
|
987
987
|
*/
|
|
988
|
-
RecordingsApi.prototype.
|
|
988
|
+
RecordingsApi.prototype.deleteRecordingTranscription = function (accountId, callId, recordingId, options) {
|
|
989
989
|
var _this = this;
|
|
990
|
-
return (0, exports.RecordingsApiFp)(this.configuration).
|
|
990
|
+
return (0, exports.RecordingsApiFp)(this.configuration).deleteRecordingTranscription(accountId, callId, recordingId, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
991
991
|
};
|
|
992
992
|
/**
|
|
993
993
|
* Downloads the specified recording.
|
|
@@ -1018,7 +1018,7 @@ var RecordingsApi = /** @class */ (function (_super) {
|
|
|
1018
1018
|
return (0, exports.RecordingsApiFp)(this.configuration).getCallRecording(accountId, callId, recordingId, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1019
1019
|
};
|
|
1020
1020
|
/**
|
|
1021
|
-
* Downloads the specified transcription.
|
|
1021
|
+
* Downloads the specified transcription. If the recording was multi-channel, then there will be 2 transcripts. The caller/called party transcript will be the first item while [`<PlayAudio>`](/docs/voice/bxml/playAudio) and [`<SpeakSentence>`](/docs/voice/bxml/speakSentence) transcript will be the second item. During a [`<Transfer>`](/docs/voice/bxml/transfer) the A-leg transcript will be the first item while the B-leg transcript will be the second item.
|
|
1022
1022
|
* @summary Get Transcription
|
|
1023
1023
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
1024
1024
|
* @param {string} callId Programmable Voice API Call ID.
|
|
@@ -1027,9 +1027,9 @@ var RecordingsApi = /** @class */ (function (_super) {
|
|
|
1027
1027
|
* @throws {RequiredError}
|
|
1028
1028
|
* @memberof RecordingsApi
|
|
1029
1029
|
*/
|
|
1030
|
-
RecordingsApi.prototype.
|
|
1030
|
+
RecordingsApi.prototype.getRecordingTranscription = function (accountId, callId, recordingId, options) {
|
|
1031
1031
|
var _this = this;
|
|
1032
|
-
return (0, exports.RecordingsApiFp)(this.configuration).
|
|
1032
|
+
return (0, exports.RecordingsApiFp)(this.configuration).getRecordingTranscription(accountId, callId, recordingId, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1033
1033
|
};
|
|
1034
1034
|
/**
|
|
1035
1035
|
* Returns a list of metadata for the recordings associated with the specified account. The list can be filtered by the optional from, to, minStartTime, and maxStartTime arguments. The list is capped at 1000 entries and may be empty if no recordings match the specified criteria.
|
|
@@ -0,0 +1,161 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Bandwidth
|
|
3
|
+
* Bandwidth\'s Communication APIs
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
* Contact: letstalk@bandwidth.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 type { Configuration } from '../configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
14
|
+
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { CallTranscriptionMetadata } from '../models';
|
|
16
|
+
import { CallTranscriptionResponse } from '../models';
|
|
17
|
+
/**
|
|
18
|
+
* TranscriptionsApi - axios parameter creator
|
|
19
|
+
* @export
|
|
20
|
+
*/
|
|
21
|
+
export declare const TranscriptionsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
22
|
+
/**
|
|
23
|
+
* Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `204` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
|
|
24
|
+
* @summary Delete a specific transcription
|
|
25
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
26
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
27
|
+
* @param {string} transcriptionId Programmable Voice API Transcription ID.
|
|
28
|
+
* @param {*} [options] Override http request option.
|
|
29
|
+
* @throws {RequiredError}
|
|
30
|
+
*/
|
|
31
|
+
deleteRealTimeTranscription: (accountId: string, callId: string, transcriptionId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
32
|
+
/**
|
|
33
|
+
* Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
|
|
34
|
+
* @summary Retrieve a specific transcription
|
|
35
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
36
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
37
|
+
* @param {string} transcriptionId Programmable Voice API Transcription ID.
|
|
38
|
+
* @param {*} [options] Override http request option.
|
|
39
|
+
* @throws {RequiredError}
|
|
40
|
+
*/
|
|
41
|
+
getRealTimeTranscription: (accountId: string, callId: string, transcriptionId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
42
|
+
/**
|
|
43
|
+
* Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
|
|
44
|
+
* @summary Enumerate transcriptions made with StartTranscription
|
|
45
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
46
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
47
|
+
* @param {*} [options] Override http request option.
|
|
48
|
+
* @throws {RequiredError}
|
|
49
|
+
*/
|
|
50
|
+
listRealTimeTranscriptions: (accountId: string, callId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
51
|
+
};
|
|
52
|
+
/**
|
|
53
|
+
* TranscriptionsApi - functional programming interface
|
|
54
|
+
* @export
|
|
55
|
+
*/
|
|
56
|
+
export declare const TranscriptionsApiFp: (configuration?: Configuration) => {
|
|
57
|
+
/**
|
|
58
|
+
* Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `204` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
|
|
59
|
+
* @summary Delete a specific transcription
|
|
60
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
61
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
62
|
+
* @param {string} transcriptionId Programmable Voice API Transcription ID.
|
|
63
|
+
* @param {*} [options] Override http request option.
|
|
64
|
+
* @throws {RequiredError}
|
|
65
|
+
*/
|
|
66
|
+
deleteRealTimeTranscription(accountId: string, callId: string, transcriptionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
67
|
+
/**
|
|
68
|
+
* Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
|
|
69
|
+
* @summary Retrieve a specific transcription
|
|
70
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
71
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
72
|
+
* @param {string} transcriptionId Programmable Voice API Transcription ID.
|
|
73
|
+
* @param {*} [options] Override http request option.
|
|
74
|
+
* @throws {RequiredError}
|
|
75
|
+
*/
|
|
76
|
+
getRealTimeTranscription(accountId: string, callId: string, transcriptionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CallTranscriptionResponse>>;
|
|
77
|
+
/**
|
|
78
|
+
* Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
|
|
79
|
+
* @summary Enumerate transcriptions made with StartTranscription
|
|
80
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
81
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
82
|
+
* @param {*} [options] Override http request option.
|
|
83
|
+
* @throws {RequiredError}
|
|
84
|
+
*/
|
|
85
|
+
listRealTimeTranscriptions(accountId: string, callId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CallTranscriptionMetadata>>>;
|
|
86
|
+
};
|
|
87
|
+
/**
|
|
88
|
+
* TranscriptionsApi - factory interface
|
|
89
|
+
* @export
|
|
90
|
+
*/
|
|
91
|
+
export declare const TranscriptionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
92
|
+
/**
|
|
93
|
+
* Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `204` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
|
|
94
|
+
* @summary Delete a specific transcription
|
|
95
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
96
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
97
|
+
* @param {string} transcriptionId Programmable Voice API Transcription ID.
|
|
98
|
+
* @param {*} [options] Override http request option.
|
|
99
|
+
* @throws {RequiredError}
|
|
100
|
+
*/
|
|
101
|
+
deleteRealTimeTranscription(accountId: string, callId: string, transcriptionId: string, options?: any): AxiosPromise<void>;
|
|
102
|
+
/**
|
|
103
|
+
* Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
|
|
104
|
+
* @summary Retrieve a specific transcription
|
|
105
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
106
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
107
|
+
* @param {string} transcriptionId Programmable Voice API Transcription ID.
|
|
108
|
+
* @param {*} [options] Override http request option.
|
|
109
|
+
* @throws {RequiredError}
|
|
110
|
+
*/
|
|
111
|
+
getRealTimeTranscription(accountId: string, callId: string, transcriptionId: string, options?: any): AxiosPromise<CallTranscriptionResponse>;
|
|
112
|
+
/**
|
|
113
|
+
* Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
|
|
114
|
+
* @summary Enumerate transcriptions made with StartTranscription
|
|
115
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
116
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
117
|
+
* @param {*} [options] Override http request option.
|
|
118
|
+
* @throws {RequiredError}
|
|
119
|
+
*/
|
|
120
|
+
listRealTimeTranscriptions(accountId: string, callId: string, options?: any): AxiosPromise<Array<CallTranscriptionMetadata>>;
|
|
121
|
+
};
|
|
122
|
+
/**
|
|
123
|
+
* TranscriptionsApi - object-oriented interface
|
|
124
|
+
* @export
|
|
125
|
+
* @class TranscriptionsApi
|
|
126
|
+
* @extends {BaseAPI}
|
|
127
|
+
*/
|
|
128
|
+
export declare class TranscriptionsApi extends BaseAPI {
|
|
129
|
+
/**
|
|
130
|
+
* Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `204` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
|
|
131
|
+
* @summary Delete a specific transcription
|
|
132
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
133
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
134
|
+
* @param {string} transcriptionId Programmable Voice API Transcription ID.
|
|
135
|
+
* @param {*} [options] Override http request option.
|
|
136
|
+
* @throws {RequiredError}
|
|
137
|
+
* @memberof TranscriptionsApi
|
|
138
|
+
*/
|
|
139
|
+
deleteRealTimeTranscription(accountId: string, callId: string, transcriptionId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
140
|
+
/**
|
|
141
|
+
* Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
|
|
142
|
+
* @summary Retrieve a specific transcription
|
|
143
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
144
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
145
|
+
* @param {string} transcriptionId Programmable Voice API Transcription ID.
|
|
146
|
+
* @param {*} [options] Override http request option.
|
|
147
|
+
* @throws {RequiredError}
|
|
148
|
+
* @memberof TranscriptionsApi
|
|
149
|
+
*/
|
|
150
|
+
getRealTimeTranscription(accountId: string, callId: string, transcriptionId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CallTranscriptionResponse, any>>;
|
|
151
|
+
/**
|
|
152
|
+
* Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
|
|
153
|
+
* @summary Enumerate transcriptions made with StartTranscription
|
|
154
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
155
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
156
|
+
* @param {*} [options] Override http request option.
|
|
157
|
+
* @throws {RequiredError}
|
|
158
|
+
* @memberof TranscriptionsApi
|
|
159
|
+
*/
|
|
160
|
+
listRealTimeTranscriptions(accountId: string, callId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CallTranscriptionMetadata[], any>>;
|
|
161
|
+
}
|