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.
Files changed (116) hide show
  1. package/.github/workflows/test-nightly.yml +53 -53
  2. package/.github/workflows/test-pr.yml +40 -38
  3. package/.openapi-generator/FILES +6 -2
  4. package/README.md +40 -0
  5. package/api/recordings-api.ts +77 -77
  6. package/api/transcriptions-api.ts +320 -0
  7. package/api.ts +1 -0
  8. package/bandwidth.yml +223 -17
  9. package/base.ts +22 -4
  10. package/coverage/clover.xml +543 -451
  11. package/coverage/coverage-final.json +58 -56
  12. package/coverage/lcov-report/index.html +20 -20
  13. package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +105 -105
  14. package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +1 -1
  15. package/coverage/lcov-report/node-sdk/api/index.html +24 -9
  16. package/coverage/lcov-report/node-sdk/api/media-api.ts.html +1 -1
  17. package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +1 -1
  18. package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +1 -1
  19. package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +1 -1
  20. package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +78 -78
  21. package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +1 -1
  22. package/coverage/lcov-report/node-sdk/api/transcriptions-api.ts.html +1045 -0
  23. package/coverage/lcov-report/node-sdk/base.ts.html +72 -18
  24. package/coverage/lcov-report/node-sdk/common.ts.html +32 -32
  25. package/coverage/lcov-report/node-sdk/configuration.ts.html +15 -15
  26. package/coverage/lcov-report/node-sdk/index.html +1 -1
  27. package/coverage/lcov-report/node-sdk/models/bxml/Bxml.ts.html +4 -4
  28. package/coverage/lcov-report/node-sdk/models/bxml/NestableVerb.ts.html +6 -6
  29. package/coverage/lcov-report/node-sdk/models/bxml/Response.ts.html +4 -4
  30. package/coverage/lcov-report/node-sdk/models/bxml/Root.ts.html +8 -8
  31. package/coverage/lcov-report/node-sdk/models/bxml/Verb.ts.html +6 -6
  32. package/coverage/lcov-report/node-sdk/models/bxml/index.html +1 -1
  33. package/coverage/lcov-report/node-sdk/models/bxml/index.ts.html +3 -3
  34. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Bridge.ts.html +4 -4
  35. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Conference.ts.html +4 -4
  36. package/coverage/lcov-report/node-sdk/models/bxml/verbs/CustomParam.ts.html +4 -4
  37. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Forward.ts.html +4 -4
  38. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Gather.ts.html +7 -7
  39. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Hangup.ts.html +4 -4
  40. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Pause.ts.html +4 -4
  41. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PauseRecording.ts.html +4 -4
  42. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PhoneNumber.ts.html +4 -4
  43. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PlayAudio.ts.html +4 -4
  44. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Record.ts.html +4 -4
  45. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Redirect.ts.html +4 -4
  46. package/coverage/lcov-report/node-sdk/models/bxml/verbs/ResumeRecording.ts.html +4 -4
  47. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Ring.ts.html +4 -4
  48. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SendDtmf.ts.html +4 -4
  49. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SipUri.ts.html +4 -4
  50. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SpeakSentence.ts.html +6 -6
  51. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartGather.ts.html +4 -4
  52. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartRecording.ts.html +4 -4
  53. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartStream.ts.html +5 -5
  54. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartTranscription.ts.html +5 -5
  55. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopGather.ts.html +4 -4
  56. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopRecording.ts.html +4 -4
  57. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopStream.ts.html +4 -4
  58. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopTranscription.ts.html +4 -4
  59. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StreamParam.ts.html +4 -4
  60. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Tag.ts.html +4 -4
  61. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Transfer.ts.html +5 -5
  62. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.html +1 -1
  63. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.ts.html +31 -31
  64. package/coverage/lcov-report/node-sdk/models/call-direction-enum.ts.html +2 -2
  65. package/coverage/lcov-report/node-sdk/models/call-state-enum.ts.html +2 -2
  66. package/coverage/lcov-report/node-sdk/models/call-transcription.ts.html +274 -0
  67. package/coverage/lcov-report/node-sdk/models/callback-method-enum.ts.html +2 -2
  68. package/coverage/lcov-report/node-sdk/models/conference-state-enum.ts.html +2 -2
  69. package/coverage/lcov-report/node-sdk/models/file-format-enum.ts.html +2 -2
  70. package/coverage/lcov-report/node-sdk/models/index.html +20 -5
  71. package/coverage/lcov-report/node-sdk/models/index.ts.html +103 -94
  72. package/coverage/lcov-report/node-sdk/models/list-message-direction-enum.ts.html +2 -2
  73. package/coverage/lcov-report/node-sdk/models/lookup-status-enum.ts.html +2 -2
  74. package/coverage/lcov-report/node-sdk/models/machine-detection-mode-enum.ts.html +2 -2
  75. package/coverage/lcov-report/node-sdk/models/message-direction-enum.ts.html +2 -2
  76. package/coverage/lcov-report/node-sdk/models/message-status-enum.ts.html +2 -2
  77. package/coverage/lcov-report/node-sdk/models/message-type-enum.ts.html +2 -2
  78. package/coverage/lcov-report/node-sdk/models/priority-enum.ts.html +2 -2
  79. package/coverage/lcov-report/node-sdk/models/recording-state-enum.ts.html +2 -2
  80. package/coverage/lcov-report/node-sdk/models/redirect-method-enum.ts.html +2 -2
  81. package/coverage/lcov-report/node-sdk/tests/callUtils.js.html +34 -34
  82. package/coverage/lcov-report/node-sdk/tests/index.html +1 -1
  83. package/coverage/lcov.info +866 -637
  84. package/custom_templates/README.mustache +40 -0
  85. package/dist/api/recordings-api.d.ts +45 -45
  86. package/dist/api/recordings-api.js +75 -75
  87. package/dist/api/transcriptions-api.d.ts +161 -0
  88. package/dist/api/transcriptions-api.js +406 -0
  89. package/dist/api.d.ts +1 -0
  90. package/dist/api.js +1 -0
  91. package/dist/base.js +22 -4
  92. package/dist/models/call-recording-metadata.d.ts +3 -3
  93. package/dist/models/call-transcription-metadata.d.ts +30 -0
  94. package/dist/models/call-transcription-metadata.js +15 -0
  95. package/dist/models/call-transcription-response.d.ts +43 -0
  96. package/dist/models/call-transcription-response.js +15 -0
  97. package/dist/models/call-transcription.d.ts +53 -0
  98. package/dist/models/call-transcription.js +25 -0
  99. package/dist/models/index.d.ts +5 -2
  100. package/dist/models/index.js +5 -2
  101. package/dist/models/recording-available-callback.d.ts +3 -3
  102. package/dist/models/recording-transcription-metadata.d.ts +42 -0
  103. package/dist/models/recording-transcription-metadata.js +15 -0
  104. package/dist/models/recording-transcriptions.d.ts +25 -0
  105. package/dist/models/recording-transcriptions.js +15 -0
  106. package/models/call-recording-metadata.ts +3 -3
  107. package/models/call-transcription-metadata.ts +36 -0
  108. package/models/call-transcription-response.ts +51 -0
  109. package/models/call-transcription.ts +63 -0
  110. package/models/index.ts +5 -2
  111. package/models/recording-available-callback.ts +3 -3
  112. package/models/recording-transcription-metadata.ts +48 -0
  113. package/models/recording-transcriptions.ts +33 -0
  114. package/package.json +1 -1
  115. package/tests/integration/recordings-api.test.js +6 -6
  116. package/tests/integration/transcriptions-api.test.js +85 -0
@@ -0,0 +1,406 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Bandwidth
6
+ * Bandwidth\'s Communication APIs
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ * Contact: letstalk@bandwidth.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
+ var __extends = (this && this.__extends) || (function () {
16
+ var extendStatics = function (d, b) {
17
+ extendStatics = Object.setPrototypeOf ||
18
+ ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
19
+ function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
20
+ return extendStatics(d, b);
21
+ };
22
+ return function (d, b) {
23
+ if (typeof b !== "function" && b !== null)
24
+ throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
25
+ extendStatics(d, b);
26
+ function __() { this.constructor = d; }
27
+ d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
28
+ };
29
+ })();
30
+ var __assign = (this && this.__assign) || function () {
31
+ __assign = Object.assign || function(t) {
32
+ for (var s, i = 1, n = arguments.length; i < n; i++) {
33
+ s = arguments[i];
34
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
35
+ t[p] = s[p];
36
+ }
37
+ return t;
38
+ };
39
+ return __assign.apply(this, arguments);
40
+ };
41
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
42
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
43
+ return new (P || (P = Promise))(function (resolve, reject) {
44
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
45
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
46
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
47
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
48
+ });
49
+ };
50
+ var __generator = (this && this.__generator) || function (thisArg, body) {
51
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
52
+ return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
53
+ function verb(n) { return function (v) { return step([n, v]); }; }
54
+ function step(op) {
55
+ if (f) throw new TypeError("Generator is already executing.");
56
+ while (g && (g = 0, op[0] && (_ = 0)), _) try {
57
+ if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
58
+ if (y = 0, t) op = [op[0] & 2, t.value];
59
+ switch (op[0]) {
60
+ case 0: case 1: t = op; break;
61
+ case 4: _.label++; return { value: op[1], done: false };
62
+ case 5: _.label++; y = op[1]; op = [0]; continue;
63
+ case 7: op = _.ops.pop(); _.trys.pop(); continue;
64
+ default:
65
+ if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
66
+ if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
67
+ if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
68
+ if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
69
+ if (t[2]) _.ops.pop();
70
+ _.trys.pop(); continue;
71
+ }
72
+ op = body.call(thisArg, _);
73
+ } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
74
+ if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
75
+ }
76
+ };
77
+ Object.defineProperty(exports, "__esModule", { value: true });
78
+ exports.TranscriptionsApi = exports.TranscriptionsApiFactory = exports.TranscriptionsApiFp = exports.TranscriptionsApiAxiosParamCreator = void 0;
79
+ var axios_1 = require("axios");
80
+ // Some imports not used depending on template conditions
81
+ // @ts-ignore
82
+ var common_1 = require("../common");
83
+ // @ts-ignore
84
+ var base_1 = require("../base");
85
+ /**
86
+ * TranscriptionsApi - axios parameter creator
87
+ * @export
88
+ */
89
+ var TranscriptionsApiAxiosParamCreator = function (configuration) {
90
+ var _this = this;
91
+ return {
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: function (accountId, callId, transcriptionId, options) {
102
+ if (options === void 0) { options = {}; }
103
+ return __awaiter(_this, void 0, void 0, function () {
104
+ var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
105
+ return __generator(this, function (_a) {
106
+ // verify required parameter 'accountId' is not null or undefined
107
+ (0, common_1.assertParamExists)('deleteRealTimeTranscription', 'accountId', accountId);
108
+ // verify required parameter 'callId' is not null or undefined
109
+ (0, common_1.assertParamExists)('deleteRealTimeTranscription', 'callId', callId);
110
+ // verify required parameter 'transcriptionId' is not null or undefined
111
+ (0, common_1.assertParamExists)('deleteRealTimeTranscription', 'transcriptionId', transcriptionId);
112
+ localVarPath = "/accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId}"
113
+ .replace("{".concat("accountId", "}"), encodeURIComponent(String(accountId)))
114
+ .replace("{".concat("callId", "}"), encodeURIComponent(String(callId)))
115
+ .replace("{".concat("transcriptionId", "}"), encodeURIComponent(String(transcriptionId)));
116
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
117
+ if (configuration) {
118
+ baseOptions = configuration.baseOptions;
119
+ }
120
+ localVarRequestOptions = __assign(__assign({ method: 'DELETE' }, baseOptions), options);
121
+ localVarHeaderParameter = {};
122
+ localVarQueryParameter = {};
123
+ // authentication Basic required
124
+ // http basic authentication required
125
+ (0, common_1.setBasicAuthToObject)(localVarRequestOptions, configuration);
126
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
127
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
128
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
129
+ return [2 /*return*/, {
130
+ url: (0, common_1.toPathString)(localVarUrlObj),
131
+ options: localVarRequestOptions,
132
+ }];
133
+ });
134
+ });
135
+ },
136
+ /**
137
+ * Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
138
+ * @summary Retrieve a specific transcription
139
+ * @param {string} accountId Your Bandwidth Account ID.
140
+ * @param {string} callId Programmable Voice API Call ID.
141
+ * @param {string} transcriptionId Programmable Voice API Transcription ID.
142
+ * @param {*} [options] Override http request option.
143
+ * @throws {RequiredError}
144
+ */
145
+ getRealTimeTranscription: function (accountId, callId, transcriptionId, options) {
146
+ if (options === void 0) { options = {}; }
147
+ return __awaiter(_this, void 0, void 0, function () {
148
+ var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
149
+ return __generator(this, function (_a) {
150
+ // verify required parameter 'accountId' is not null or undefined
151
+ (0, common_1.assertParamExists)('getRealTimeTranscription', 'accountId', accountId);
152
+ // verify required parameter 'callId' is not null or undefined
153
+ (0, common_1.assertParamExists)('getRealTimeTranscription', 'callId', callId);
154
+ // verify required parameter 'transcriptionId' is not null or undefined
155
+ (0, common_1.assertParamExists)('getRealTimeTranscription', 'transcriptionId', transcriptionId);
156
+ localVarPath = "/accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId}"
157
+ .replace("{".concat("accountId", "}"), encodeURIComponent(String(accountId)))
158
+ .replace("{".concat("callId", "}"), encodeURIComponent(String(callId)))
159
+ .replace("{".concat("transcriptionId", "}"), encodeURIComponent(String(transcriptionId)));
160
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
161
+ if (configuration) {
162
+ baseOptions = configuration.baseOptions;
163
+ }
164
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
165
+ localVarHeaderParameter = {};
166
+ localVarQueryParameter = {};
167
+ // authentication Basic required
168
+ // http basic authentication required
169
+ (0, common_1.setBasicAuthToObject)(localVarRequestOptions, configuration);
170
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
171
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
172
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
173
+ return [2 /*return*/, {
174
+ url: (0, common_1.toPathString)(localVarUrlObj),
175
+ options: localVarRequestOptions,
176
+ }];
177
+ });
178
+ });
179
+ },
180
+ /**
181
+ * Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
182
+ * @summary Enumerate transcriptions made with StartTranscription
183
+ * @param {string} accountId Your Bandwidth Account ID.
184
+ * @param {string} callId Programmable Voice API Call ID.
185
+ * @param {*} [options] Override http request option.
186
+ * @throws {RequiredError}
187
+ */
188
+ listRealTimeTranscriptions: function (accountId, callId, options) {
189
+ if (options === void 0) { options = {}; }
190
+ return __awaiter(_this, void 0, void 0, function () {
191
+ var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
192
+ return __generator(this, function (_a) {
193
+ // verify required parameter 'accountId' is not null or undefined
194
+ (0, common_1.assertParamExists)('listRealTimeTranscriptions', 'accountId', accountId);
195
+ // verify required parameter 'callId' is not null or undefined
196
+ (0, common_1.assertParamExists)('listRealTimeTranscriptions', 'callId', callId);
197
+ localVarPath = "/accounts/{accountId}/calls/{callId}/transcriptions"
198
+ .replace("{".concat("accountId", "}"), encodeURIComponent(String(accountId)))
199
+ .replace("{".concat("callId", "}"), encodeURIComponent(String(callId)));
200
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
201
+ if (configuration) {
202
+ baseOptions = configuration.baseOptions;
203
+ }
204
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
205
+ localVarHeaderParameter = {};
206
+ localVarQueryParameter = {};
207
+ // authentication Basic required
208
+ // http basic authentication required
209
+ (0, common_1.setBasicAuthToObject)(localVarRequestOptions, configuration);
210
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
211
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
212
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
213
+ return [2 /*return*/, {
214
+ url: (0, common_1.toPathString)(localVarUrlObj),
215
+ options: localVarRequestOptions,
216
+ }];
217
+ });
218
+ });
219
+ },
220
+ };
221
+ };
222
+ exports.TranscriptionsApiAxiosParamCreator = TranscriptionsApiAxiosParamCreator;
223
+ /**
224
+ * TranscriptionsApi - functional programming interface
225
+ * @export
226
+ */
227
+ var TranscriptionsApiFp = function (configuration) {
228
+ var localVarAxiosParamCreator = (0, exports.TranscriptionsApiAxiosParamCreator)(configuration);
229
+ return {
230
+ /**
231
+ * 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.
232
+ * @summary Delete a specific transcription
233
+ * @param {string} accountId Your Bandwidth Account ID.
234
+ * @param {string} callId Programmable Voice API Call ID.
235
+ * @param {string} transcriptionId Programmable Voice API Transcription ID.
236
+ * @param {*} [options] Override http request option.
237
+ * @throws {RequiredError}
238
+ */
239
+ deleteRealTimeTranscription: function (accountId, callId, transcriptionId, options) {
240
+ var _a, _b, _c;
241
+ return __awaiter(this, void 0, void 0, function () {
242
+ var localVarAxiosArgs, index, operationBasePath;
243
+ return __generator(this, function (_d) {
244
+ switch (_d.label) {
245
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.deleteRealTimeTranscription(accountId, callId, transcriptionId, options)];
246
+ case 1:
247
+ localVarAxiosArgs = _d.sent();
248
+ index = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
249
+ operationBasePath = (_c = (_b = base_1.operationServerMap['TranscriptionsApi.deleteRealTimeTranscription']) === null || _b === void 0 ? void 0 : _b[index]) === null || _c === void 0 ? void 0 : _c.url;
250
+ return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, operationBasePath || basePath); }];
251
+ }
252
+ });
253
+ });
254
+ },
255
+ /**
256
+ * Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
257
+ * @summary Retrieve a specific transcription
258
+ * @param {string} accountId Your Bandwidth Account ID.
259
+ * @param {string} callId Programmable Voice API Call ID.
260
+ * @param {string} transcriptionId Programmable Voice API Transcription ID.
261
+ * @param {*} [options] Override http request option.
262
+ * @throws {RequiredError}
263
+ */
264
+ getRealTimeTranscription: function (accountId, callId, transcriptionId, options) {
265
+ var _a, _b, _c;
266
+ return __awaiter(this, void 0, void 0, function () {
267
+ var localVarAxiosArgs, index, operationBasePath;
268
+ return __generator(this, function (_d) {
269
+ switch (_d.label) {
270
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getRealTimeTranscription(accountId, callId, transcriptionId, options)];
271
+ case 1:
272
+ localVarAxiosArgs = _d.sent();
273
+ index = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
274
+ operationBasePath = (_c = (_b = base_1.operationServerMap['TranscriptionsApi.getRealTimeTranscription']) === null || _b === void 0 ? void 0 : _b[index]) === null || _c === void 0 ? void 0 : _c.url;
275
+ return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, operationBasePath || basePath); }];
276
+ }
277
+ });
278
+ });
279
+ },
280
+ /**
281
+ * Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
282
+ * @summary Enumerate transcriptions made with StartTranscription
283
+ * @param {string} accountId Your Bandwidth Account ID.
284
+ * @param {string} callId Programmable Voice API Call ID.
285
+ * @param {*} [options] Override http request option.
286
+ * @throws {RequiredError}
287
+ */
288
+ listRealTimeTranscriptions: function (accountId, callId, options) {
289
+ var _a, _b, _c;
290
+ return __awaiter(this, void 0, void 0, function () {
291
+ var localVarAxiosArgs, index, operationBasePath;
292
+ return __generator(this, function (_d) {
293
+ switch (_d.label) {
294
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.listRealTimeTranscriptions(accountId, callId, options)];
295
+ case 1:
296
+ localVarAxiosArgs = _d.sent();
297
+ index = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
298
+ operationBasePath = (_c = (_b = base_1.operationServerMap['TranscriptionsApi.listRealTimeTranscriptions']) === null || _b === void 0 ? void 0 : _b[index]) === null || _c === void 0 ? void 0 : _c.url;
299
+ return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, operationBasePath || basePath); }];
300
+ }
301
+ });
302
+ });
303
+ },
304
+ };
305
+ };
306
+ exports.TranscriptionsApiFp = TranscriptionsApiFp;
307
+ /**
308
+ * TranscriptionsApi - factory interface
309
+ * @export
310
+ */
311
+ var TranscriptionsApiFactory = function (configuration, basePath, axios) {
312
+ var localVarFp = (0, exports.TranscriptionsApiFp)(configuration);
313
+ return {
314
+ /**
315
+ * 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.
316
+ * @summary Delete a specific transcription
317
+ * @param {string} accountId Your Bandwidth Account ID.
318
+ * @param {string} callId Programmable Voice API Call ID.
319
+ * @param {string} transcriptionId Programmable Voice API Transcription ID.
320
+ * @param {*} [options] Override http request option.
321
+ * @throws {RequiredError}
322
+ */
323
+ deleteRealTimeTranscription: function (accountId, callId, transcriptionId, options) {
324
+ return localVarFp.deleteRealTimeTranscription(accountId, callId, transcriptionId, options).then(function (request) { return request(axios, basePath); });
325
+ },
326
+ /**
327
+ * Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
328
+ * @summary Retrieve a specific transcription
329
+ * @param {string} accountId Your Bandwidth Account ID.
330
+ * @param {string} callId Programmable Voice API Call ID.
331
+ * @param {string} transcriptionId Programmable Voice API Transcription ID.
332
+ * @param {*} [options] Override http request option.
333
+ * @throws {RequiredError}
334
+ */
335
+ getRealTimeTranscription: function (accountId, callId, transcriptionId, options) {
336
+ return localVarFp.getRealTimeTranscription(accountId, callId, transcriptionId, options).then(function (request) { return request(axios, basePath); });
337
+ },
338
+ /**
339
+ * Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
340
+ * @summary Enumerate transcriptions made with StartTranscription
341
+ * @param {string} accountId Your Bandwidth Account ID.
342
+ * @param {string} callId Programmable Voice API Call ID.
343
+ * @param {*} [options] Override http request option.
344
+ * @throws {RequiredError}
345
+ */
346
+ listRealTimeTranscriptions: function (accountId, callId, options) {
347
+ return localVarFp.listRealTimeTranscriptions(accountId, callId, options).then(function (request) { return request(axios, basePath); });
348
+ },
349
+ };
350
+ };
351
+ exports.TranscriptionsApiFactory = TranscriptionsApiFactory;
352
+ /**
353
+ * TranscriptionsApi - object-oriented interface
354
+ * @export
355
+ * @class TranscriptionsApi
356
+ * @extends {BaseAPI}
357
+ */
358
+ var TranscriptionsApi = /** @class */ (function (_super) {
359
+ __extends(TranscriptionsApi, _super);
360
+ function TranscriptionsApi() {
361
+ return _super !== null && _super.apply(this, arguments) || this;
362
+ }
363
+ /**
364
+ * 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.
365
+ * @summary Delete a specific transcription
366
+ * @param {string} accountId Your Bandwidth Account ID.
367
+ * @param {string} callId Programmable Voice API Call ID.
368
+ * @param {string} transcriptionId Programmable Voice API Transcription ID.
369
+ * @param {*} [options] Override http request option.
370
+ * @throws {RequiredError}
371
+ * @memberof TranscriptionsApi
372
+ */
373
+ TranscriptionsApi.prototype.deleteRealTimeTranscription = function (accountId, callId, transcriptionId, options) {
374
+ var _this = this;
375
+ return (0, exports.TranscriptionsApiFp)(this.configuration).deleteRealTimeTranscription(accountId, callId, transcriptionId, options).then(function (request) { return request(_this.axios, _this.basePath); });
376
+ };
377
+ /**
378
+ * Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
379
+ * @summary Retrieve a specific transcription
380
+ * @param {string} accountId Your Bandwidth Account ID.
381
+ * @param {string} callId Programmable Voice API Call ID.
382
+ * @param {string} transcriptionId Programmable Voice API Transcription ID.
383
+ * @param {*} [options] Override http request option.
384
+ * @throws {RequiredError}
385
+ * @memberof TranscriptionsApi
386
+ */
387
+ TranscriptionsApi.prototype.getRealTimeTranscription = function (accountId, callId, transcriptionId, options) {
388
+ var _this = this;
389
+ return (0, exports.TranscriptionsApiFp)(this.configuration).getRealTimeTranscription(accountId, callId, transcriptionId, options).then(function (request) { return request(_this.axios, _this.basePath); });
390
+ };
391
+ /**
392
+ * Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
393
+ * @summary Enumerate transcriptions made with StartTranscription
394
+ * @param {string} accountId Your Bandwidth Account ID.
395
+ * @param {string} callId Programmable Voice API Call ID.
396
+ * @param {*} [options] Override http request option.
397
+ * @throws {RequiredError}
398
+ * @memberof TranscriptionsApi
399
+ */
400
+ TranscriptionsApi.prototype.listRealTimeTranscriptions = function (accountId, callId, options) {
401
+ var _this = this;
402
+ return (0, exports.TranscriptionsApiFp)(this.configuration).listRealTimeTranscriptions(accountId, callId, options).then(function (request) { return request(_this.axios, _this.basePath); });
403
+ };
404
+ return TranscriptionsApi;
405
+ }(base_1.BaseAPI));
406
+ exports.TranscriptionsApi = TranscriptionsApi;
package/dist/api.d.ts CHANGED
@@ -17,3 +17,4 @@ export * from './api/messages-api';
17
17
  export * from './api/phone-number-lookup-api';
18
18
  export * from './api/recordings-api';
19
19
  export * from './api/statistics-api';
20
+ export * from './api/transcriptions-api';
package/dist/api.js CHANGED
@@ -35,3 +35,4 @@ __exportStar(require("./api/messages-api"), exports);
35
35
  __exportStar(require("./api/phone-number-lookup-api"), exports);
36
36
  __exportStar(require("./api/recordings-api"), exports);
37
37
  __exportStar(require("./api/statistics-api"), exports);
38
+ __exportStar(require("./api/transcriptions-api"), exports);
package/dist/base.js CHANGED
@@ -234,19 +234,19 @@ exports.operationServerMap = {
234
234
  description: "Production",
235
235
  }
236
236
  ],
237
- "RecordingsApi.deleteCallTranscription": [
237
+ "RecordingsApi.deleteRecording": [
238
238
  {
239
239
  url: "https://voice.bandwidth.com/api/v2",
240
240
  description: "Production",
241
241
  }
242
242
  ],
243
- "RecordingsApi.deleteRecording": [
243
+ "RecordingsApi.deleteRecordingMedia": [
244
244
  {
245
245
  url: "https://voice.bandwidth.com/api/v2",
246
246
  description: "Production",
247
247
  }
248
248
  ],
249
- "RecordingsApi.deleteRecordingMedia": [
249
+ "RecordingsApi.deleteRecordingTranscription": [
250
250
  {
251
251
  url: "https://voice.bandwidth.com/api/v2",
252
252
  description: "Production",
@@ -264,7 +264,7 @@ exports.operationServerMap = {
264
264
  description: "Production",
265
265
  }
266
266
  ],
267
- "RecordingsApi.getCallTranscription": [
267
+ "RecordingsApi.getRecordingTranscription": [
268
268
  {
269
269
  url: "https://voice.bandwidth.com/api/v2",
270
270
  description: "Production",
@@ -300,4 +300,22 @@ exports.operationServerMap = {
300
300
  description: "Production",
301
301
  }
302
302
  ],
303
+ "TranscriptionsApi.deleteRealTimeTranscription": [
304
+ {
305
+ url: "https://voice.bandwidth.com/api/v2",
306
+ description: "Production",
307
+ }
308
+ ],
309
+ "TranscriptionsApi.getRealTimeTranscription": [
310
+ {
311
+ url: "https://voice.bandwidth.com/api/v2",
312
+ description: "Production",
313
+ }
314
+ ],
315
+ "TranscriptionsApi.listRealTimeTranscriptions": [
316
+ {
317
+ url: "https://voice.bandwidth.com/api/v2",
318
+ description: "Production",
319
+ }
320
+ ],
303
321
  };
@@ -11,7 +11,7 @@
11
11
  */
12
12
  import { CallDirectionEnum } from './call-direction-enum';
13
13
  import { FileFormatEnum } from './file-format-enum';
14
- import { TranscriptionMetadata } from './transcription-metadata';
14
+ import { RecordingTranscriptionMetadata } from './recording-transcription-metadata';
15
15
  /**
16
16
  *
17
17
  * @export
@@ -122,8 +122,8 @@ export interface CallRecordingMetadata {
122
122
  'mediaUrl'?: string | null;
123
123
  /**
124
124
  *
125
- * @type {TranscriptionMetadata}
125
+ * @type {RecordingTranscriptionMetadata}
126
126
  * @memberof CallRecordingMetadata
127
127
  */
128
- 'transcription'?: TranscriptionMetadata | null;
128
+ 'transcription'?: RecordingTranscriptionMetadata | null;
129
129
  }
@@ -0,0 +1,30 @@
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
+ /**
13
+ *
14
+ * @export
15
+ * @interface CallTranscriptionMetadata
16
+ */
17
+ export interface CallTranscriptionMetadata {
18
+ /**
19
+ * The programmable voice API transcription ID.
20
+ * @type {string}
21
+ * @memberof CallTranscriptionMetadata
22
+ */
23
+ 'transcriptionId'?: string;
24
+ /**
25
+ * A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice/#operation/getCallTranscription) endpoint.
26
+ * @type {string}
27
+ * @memberof CallTranscriptionMetadata
28
+ */
29
+ 'transcriptionUrl'?: string;
30
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Bandwidth
6
+ * Bandwidth\'s Communication APIs
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ * Contact: letstalk@bandwidth.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 });
@@ -0,0 +1,43 @@
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 { CallTranscription } from './call-transcription';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface CallTranscriptionResponse
17
+ */
18
+ export interface CallTranscriptionResponse {
19
+ /**
20
+ * The user account associated with the call.
21
+ * @type {string}
22
+ * @memberof CallTranscriptionResponse
23
+ */
24
+ 'accountId'?: string;
25
+ /**
26
+ * The call id associated with the event.
27
+ * @type {string}
28
+ * @memberof CallTranscriptionResponse
29
+ */
30
+ 'callId'?: string;
31
+ /**
32
+ * The programmable voice API transcription ID.
33
+ * @type {string}
34
+ * @memberof CallTranscriptionResponse
35
+ */
36
+ 'transcriptionId'?: string;
37
+ /**
38
+ *
39
+ * @type {Array<CallTranscription>}
40
+ * @memberof CallTranscriptionResponse
41
+ */
42
+ 'tracks'?: Array<CallTranscription>;
43
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Bandwidth
6
+ * Bandwidth\'s Communication APIs
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ * Contact: letstalk@bandwidth.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 });
@@ -0,0 +1,53 @@
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
+ /**
13
+ *
14
+ * @export
15
+ * @interface CallTranscription
16
+ */
17
+ export interface CallTranscription {
18
+ /**
19
+ * The detected language for this transcription.
20
+ * @type {string}
21
+ * @memberof CallTranscription
22
+ */
23
+ 'detectedLanguage'?: CallTranscriptionDetectedLanguageEnum;
24
+ /**
25
+ * Which `track` this transcription is derived from.
26
+ * @type {string}
27
+ * @memberof CallTranscription
28
+ */
29
+ 'track'?: CallTranscriptionTrackEnum;
30
+ /**
31
+ * The transcription itself.
32
+ * @type {string}
33
+ * @memberof CallTranscription
34
+ */
35
+ 'text'?: string;
36
+ /**
37
+ * How confident the transcription engine was in transcribing the associated audio (from `0` to `1`).
38
+ * @type {number}
39
+ * @memberof CallTranscription
40
+ */
41
+ 'confidence'?: number;
42
+ }
43
+ export declare const CallTranscriptionDetectedLanguageEnum: {
44
+ readonly EnUs: "en-US";
45
+ readonly EsUs: "es-US";
46
+ readonly FrFr: "fr-FR";
47
+ };
48
+ export type CallTranscriptionDetectedLanguageEnum = typeof CallTranscriptionDetectedLanguageEnum[keyof typeof CallTranscriptionDetectedLanguageEnum];
49
+ export declare const CallTranscriptionTrackEnum: {
50
+ readonly Inbound: "inbound";
51
+ readonly Outbound: "outbound";
52
+ };
53
+ export type CallTranscriptionTrackEnum = typeof CallTranscriptionTrackEnum[keyof typeof CallTranscriptionTrackEnum];