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
|
@@ -1,5 +1,20 @@
|
|
|
1
1
|
## {{npmName}}
|
|
2
2
|
|
|
3
|
+
[](https://github.com/Bandwidth/node-sdk/actions/workflows/test-nightly.yml)
|
|
4
|
+
|
|
5
|
+
### Test Matrix
|
|
6
|
+
| **OS** | **Node** |
|
|
7
|
+
|:---:|:---:|
|
|
8
|
+
| Windows 2019 | 16, 18, 20, 22 |
|
|
9
|
+
| Windows 2022 | 16, 18, 20, 22 |
|
|
10
|
+
| Ubuntu 20.04 | 16, 18, 20, 22 |
|
|
11
|
+
| Ubuntu 22.04 | 16, 18, 20, 22 |
|
|
12
|
+
|
|
13
|
+
#### Available on NPM
|
|
14
|
+
```
|
|
15
|
+
npm install {{npmName}}
|
|
16
|
+
```
|
|
17
|
+
|
|
3
18
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
19
|
|
|
5
20
|
Environment
|
|
@@ -43,3 +58,28 @@ _unPublished (not recommended):_
|
|
|
43
58
|
|
|
44
59
|
```
|
|
45
60
|
npm install PATH_TO_GENERATED_PACKAGE --save
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### Getting Started
|
|
64
|
+
|
|
65
|
+
The following is a simple example of how to use this module:
|
|
66
|
+
|
|
67
|
+
```javascript
|
|
68
|
+
import { CallsApi, Configuration } from '{{npmName}}';
|
|
69
|
+
|
|
70
|
+
const config = new Configuration({
|
|
71
|
+
username: BW_USERNAME,
|
|
72
|
+
password: BW_PASSWORD
|
|
73
|
+
});
|
|
74
|
+
const callsApi = new CallsApi(config);
|
|
75
|
+
|
|
76
|
+
const body = {
|
|
77
|
+
applicationId: BW_VOICE_APPLICATION_ID,
|
|
78
|
+
to: TO_NUMBER,
|
|
79
|
+
from: BW_NUMBER
|
|
80
|
+
};
|
|
81
|
+
|
|
82
|
+
await callsApi.createCall(BW_ACCOUNT_ID, body);
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
More samples can be found in the [Bandwidth Samples](https://github.com/orgs/Bandwidth-Samples/repositories?q=lang%3Ajavascript&type=all) GitHub Organization.
|
|
@@ -13,8 +13,8 @@ import type { Configuration } from '../configuration';
|
|
|
13
13
|
import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
15
|
import { CallRecordingMetadata } from '../models';
|
|
16
|
+
import { RecordingTranscriptions } from '../models';
|
|
16
17
|
import { TranscribeRecording } from '../models';
|
|
17
|
-
import { TranscriptionList } from '../models';
|
|
18
18
|
import { UpdateCallRecording } from '../models';
|
|
19
19
|
/**
|
|
20
20
|
* RecordingsApi - axios parameter creator
|
|
@@ -22,35 +22,35 @@ import { UpdateCallRecording } from '../models';
|
|
|
22
22
|
*/
|
|
23
23
|
export declare const RecordingsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
26
|
-
* @summary Delete
|
|
25
|
+
* 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.
|
|
26
|
+
* @summary Delete Recording
|
|
27
27
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
28
28
|
* @param {string} callId Programmable Voice API Call ID.
|
|
29
29
|
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
30
30
|
* @param {*} [options] Override http request option.
|
|
31
31
|
* @throws {RequiredError}
|
|
32
32
|
*/
|
|
33
|
-
|
|
33
|
+
deleteRecording: (accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34
34
|
/**
|
|
35
|
-
*
|
|
36
|
-
* @summary Delete Recording
|
|
35
|
+
* Deletes the specified recording\'s media.
|
|
36
|
+
* @summary Delete Recording Media
|
|
37
37
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
38
38
|
* @param {string} callId Programmable Voice API Call ID.
|
|
39
39
|
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
40
40
|
* @param {*} [options] Override http request option.
|
|
41
41
|
* @throws {RequiredError}
|
|
42
42
|
*/
|
|
43
|
-
|
|
43
|
+
deleteRecordingMedia: (accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44
44
|
/**
|
|
45
|
-
* Deletes the specified recording\'s
|
|
46
|
-
* @summary Delete
|
|
45
|
+
* 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.
|
|
46
|
+
* @summary Delete Transcription
|
|
47
47
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
48
48
|
* @param {string} callId Programmable Voice API Call ID.
|
|
49
49
|
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
50
50
|
* @param {*} [options] Override http request option.
|
|
51
51
|
* @throws {RequiredError}
|
|
52
52
|
*/
|
|
53
|
-
|
|
53
|
+
deleteRecordingTranscription: (accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54
54
|
/**
|
|
55
55
|
* Downloads the specified recording.
|
|
56
56
|
* @summary Download Recording
|
|
@@ -72,7 +72,7 @@ export declare const RecordingsApiAxiosParamCreator: (configuration?: Configurat
|
|
|
72
72
|
*/
|
|
73
73
|
getCallRecording: (accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
74
74
|
/**
|
|
75
|
-
* Downloads the specified transcription.
|
|
75
|
+
* 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.
|
|
76
76
|
* @summary Get Transcription
|
|
77
77
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
78
78
|
* @param {string} callId Programmable Voice API Call ID.
|
|
@@ -80,7 +80,7 @@ export declare const RecordingsApiAxiosParamCreator: (configuration?: Configurat
|
|
|
80
80
|
* @param {*} [options] Override http request option.
|
|
81
81
|
* @throws {RequiredError}
|
|
82
82
|
*/
|
|
83
|
-
|
|
83
|
+
getRecordingTranscription: (accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
84
84
|
/**
|
|
85
85
|
* 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.
|
|
86
86
|
* @summary Get Call Recordings
|
|
@@ -130,35 +130,35 @@ export declare const RecordingsApiAxiosParamCreator: (configuration?: Configurat
|
|
|
130
130
|
*/
|
|
131
131
|
export declare const RecordingsApiFp: (configuration?: Configuration) => {
|
|
132
132
|
/**
|
|
133
|
-
*
|
|
134
|
-
* @summary Delete
|
|
133
|
+
* 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.
|
|
134
|
+
* @summary Delete Recording
|
|
135
135
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
136
136
|
* @param {string} callId Programmable Voice API Call ID.
|
|
137
137
|
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
138
138
|
* @param {*} [options] Override http request option.
|
|
139
139
|
* @throws {RequiredError}
|
|
140
140
|
*/
|
|
141
|
-
|
|
141
|
+
deleteRecording(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
142
142
|
/**
|
|
143
|
-
*
|
|
144
|
-
* @summary Delete Recording
|
|
143
|
+
* Deletes the specified recording\'s media.
|
|
144
|
+
* @summary Delete Recording Media
|
|
145
145
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
146
146
|
* @param {string} callId Programmable Voice API Call ID.
|
|
147
147
|
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
148
148
|
* @param {*} [options] Override http request option.
|
|
149
149
|
* @throws {RequiredError}
|
|
150
150
|
*/
|
|
151
|
-
|
|
151
|
+
deleteRecordingMedia(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
152
152
|
/**
|
|
153
|
-
* Deletes the specified recording\'s
|
|
154
|
-
* @summary Delete
|
|
153
|
+
* 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.
|
|
154
|
+
* @summary Delete Transcription
|
|
155
155
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
156
156
|
* @param {string} callId Programmable Voice API Call ID.
|
|
157
157
|
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
158
158
|
* @param {*} [options] Override http request option.
|
|
159
159
|
* @throws {RequiredError}
|
|
160
160
|
*/
|
|
161
|
-
|
|
161
|
+
deleteRecordingTranscription(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
162
162
|
/**
|
|
163
163
|
* Downloads the specified recording.
|
|
164
164
|
* @summary Download Recording
|
|
@@ -180,7 +180,7 @@ export declare const RecordingsApiFp: (configuration?: Configuration) => {
|
|
|
180
180
|
*/
|
|
181
181
|
getCallRecording(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CallRecordingMetadata>>;
|
|
182
182
|
/**
|
|
183
|
-
* Downloads the specified transcription.
|
|
183
|
+
* 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.
|
|
184
184
|
* @summary Get Transcription
|
|
185
185
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
186
186
|
* @param {string} callId Programmable Voice API Call ID.
|
|
@@ -188,7 +188,7 @@ export declare const RecordingsApiFp: (configuration?: Configuration) => {
|
|
|
188
188
|
* @param {*} [options] Override http request option.
|
|
189
189
|
* @throws {RequiredError}
|
|
190
190
|
*/
|
|
191
|
-
|
|
191
|
+
getRecordingTranscription(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RecordingTranscriptions>>;
|
|
192
192
|
/**
|
|
193
193
|
* 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.
|
|
194
194
|
* @summary Get Call Recordings
|
|
@@ -238,35 +238,35 @@ export declare const RecordingsApiFp: (configuration?: Configuration) => {
|
|
|
238
238
|
*/
|
|
239
239
|
export declare const RecordingsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
240
240
|
/**
|
|
241
|
-
*
|
|
242
|
-
* @summary Delete
|
|
241
|
+
* 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.
|
|
242
|
+
* @summary Delete Recording
|
|
243
243
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
244
244
|
* @param {string} callId Programmable Voice API Call ID.
|
|
245
245
|
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
246
246
|
* @param {*} [options] Override http request option.
|
|
247
247
|
* @throws {RequiredError}
|
|
248
248
|
*/
|
|
249
|
-
|
|
249
|
+
deleteRecording(accountId: string, callId: string, recordingId: string, options?: any): AxiosPromise<void>;
|
|
250
250
|
/**
|
|
251
|
-
*
|
|
252
|
-
* @summary Delete Recording
|
|
251
|
+
* Deletes the specified recording\'s media.
|
|
252
|
+
* @summary Delete Recording Media
|
|
253
253
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
254
254
|
* @param {string} callId Programmable Voice API Call ID.
|
|
255
255
|
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
256
256
|
* @param {*} [options] Override http request option.
|
|
257
257
|
* @throws {RequiredError}
|
|
258
258
|
*/
|
|
259
|
-
|
|
259
|
+
deleteRecordingMedia(accountId: string, callId: string, recordingId: string, options?: any): AxiosPromise<void>;
|
|
260
260
|
/**
|
|
261
|
-
* Deletes the specified recording\'s
|
|
262
|
-
* @summary Delete
|
|
261
|
+
* 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.
|
|
262
|
+
* @summary Delete Transcription
|
|
263
263
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
264
264
|
* @param {string} callId Programmable Voice API Call ID.
|
|
265
265
|
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
266
266
|
* @param {*} [options] Override http request option.
|
|
267
267
|
* @throws {RequiredError}
|
|
268
268
|
*/
|
|
269
|
-
|
|
269
|
+
deleteRecordingTranscription(accountId: string, callId: string, recordingId: string, options?: any): AxiosPromise<void>;
|
|
270
270
|
/**
|
|
271
271
|
* Downloads the specified recording.
|
|
272
272
|
* @summary Download Recording
|
|
@@ -288,7 +288,7 @@ export declare const RecordingsApiFactory: (configuration?: Configuration, baseP
|
|
|
288
288
|
*/
|
|
289
289
|
getCallRecording(accountId: string, callId: string, recordingId: string, options?: any): AxiosPromise<CallRecordingMetadata>;
|
|
290
290
|
/**
|
|
291
|
-
* Downloads the specified transcription.
|
|
291
|
+
* 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.
|
|
292
292
|
* @summary Get Transcription
|
|
293
293
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
294
294
|
* @param {string} callId Programmable Voice API Call ID.
|
|
@@ -296,7 +296,7 @@ export declare const RecordingsApiFactory: (configuration?: Configuration, baseP
|
|
|
296
296
|
* @param {*} [options] Override http request option.
|
|
297
297
|
* @throws {RequiredError}
|
|
298
298
|
*/
|
|
299
|
-
|
|
299
|
+
getRecordingTranscription(accountId: string, callId: string, recordingId: string, options?: any): AxiosPromise<RecordingTranscriptions>;
|
|
300
300
|
/**
|
|
301
301
|
* 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.
|
|
302
302
|
* @summary Get Call Recordings
|
|
@@ -348,8 +348,8 @@ export declare const RecordingsApiFactory: (configuration?: Configuration, baseP
|
|
|
348
348
|
*/
|
|
349
349
|
export declare class RecordingsApi extends BaseAPI {
|
|
350
350
|
/**
|
|
351
|
-
*
|
|
352
|
-
* @summary Delete
|
|
351
|
+
* 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.
|
|
352
|
+
* @summary Delete Recording
|
|
353
353
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
354
354
|
* @param {string} callId Programmable Voice API Call ID.
|
|
355
355
|
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
@@ -357,10 +357,10 @@ export declare class RecordingsApi extends BaseAPI {
|
|
|
357
357
|
* @throws {RequiredError}
|
|
358
358
|
* @memberof RecordingsApi
|
|
359
359
|
*/
|
|
360
|
-
|
|
360
|
+
deleteRecording(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
361
361
|
/**
|
|
362
|
-
*
|
|
363
|
-
* @summary Delete Recording
|
|
362
|
+
* Deletes the specified recording\'s media.
|
|
363
|
+
* @summary Delete Recording Media
|
|
364
364
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
365
365
|
* @param {string} callId Programmable Voice API Call ID.
|
|
366
366
|
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
@@ -368,10 +368,10 @@ export declare class RecordingsApi extends BaseAPI {
|
|
|
368
368
|
* @throws {RequiredError}
|
|
369
369
|
* @memberof RecordingsApi
|
|
370
370
|
*/
|
|
371
|
-
|
|
371
|
+
deleteRecordingMedia(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
372
372
|
/**
|
|
373
|
-
* Deletes the specified recording\'s
|
|
374
|
-
* @summary Delete
|
|
373
|
+
* 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.
|
|
374
|
+
* @summary Delete Transcription
|
|
375
375
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
376
376
|
* @param {string} callId Programmable Voice API Call ID.
|
|
377
377
|
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
@@ -379,7 +379,7 @@ export declare class RecordingsApi extends BaseAPI {
|
|
|
379
379
|
* @throws {RequiredError}
|
|
380
380
|
* @memberof RecordingsApi
|
|
381
381
|
*/
|
|
382
|
-
|
|
382
|
+
deleteRecordingTranscription(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
383
383
|
/**
|
|
384
384
|
* Downloads the specified recording.
|
|
385
385
|
* @summary Download Recording
|
|
@@ -403,7 +403,7 @@ export declare class RecordingsApi extends BaseAPI {
|
|
|
403
403
|
*/
|
|
404
404
|
getCallRecording(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CallRecordingMetadata, any>>;
|
|
405
405
|
/**
|
|
406
|
-
* Downloads the specified transcription.
|
|
406
|
+
* 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.
|
|
407
407
|
* @summary Get Transcription
|
|
408
408
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
409
409
|
* @param {string} callId Programmable Voice API Call ID.
|
|
@@ -412,7 +412,7 @@ export declare class RecordingsApi extends BaseAPI {
|
|
|
412
412
|
* @throws {RequiredError}
|
|
413
413
|
* @memberof RecordingsApi
|
|
414
414
|
*/
|
|
415
|
-
|
|
415
|
+
getRecordingTranscription(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RecordingTranscriptions, any>>;
|
|
416
416
|
/**
|
|
417
417
|
* 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.
|
|
418
418
|
* @summary Get Call Recordings
|