bandwidth-sdk 2.1.0 → 3.0.1

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 (137) hide show
  1. package/.github/workflows/deploy.yml +4 -2
  2. package/.github/workflows/test-pr.yml +4 -2
  3. package/.github/workflows/{test-nightly.yml → test-smoke.yml} +6 -5
  4. package/.openapi-generator/FILES +2 -0
  5. package/README.md +22 -5
  6. package/api/transcriptions-api.ts +4 -4
  7. package/bandwidth.yml +70 -41
  8. package/coverage/clover.xml +1501 -138
  9. package/coverage/coverage-final.json +65 -47
  10. package/coverage/lcov-report/index.html +51 -21
  11. package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +1702 -0
  12. package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +2725 -0
  13. package/coverage/lcov-report/node-sdk/api/index.html +236 -0
  14. package/coverage/lcov-report/node-sdk/api/media-api.ts.html +1315 -0
  15. package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +1138 -0
  16. package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +1051 -0
  17. package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +775 -0
  18. package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +2971 -0
  19. package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +496 -0
  20. package/coverage/lcov-report/node-sdk/api/transcriptions-api.ts.html +1045 -0
  21. package/coverage/lcov-report/node-sdk/api.ts.html +163 -0
  22. package/coverage/lcov-report/node-sdk/base.ts.html +1045 -0
  23. package/coverage/lcov-report/node-sdk/common.ts.html +535 -0
  24. package/coverage/lcov-report/node-sdk/configuration.ts.html +415 -0
  25. package/coverage/lcov-report/node-sdk/index.html +161 -0
  26. package/coverage/lcov-report/{models → node-sdk/models}/bxml/Bxml.ts.html +13 -13
  27. package/coverage/lcov-report/{models → node-sdk/models}/bxml/NestableVerb.ts.html +15 -15
  28. package/coverage/lcov-report/{models → node-sdk/models}/bxml/Response.ts.html +13 -13
  29. package/coverage/lcov-report/{models → node-sdk/models}/bxml/Root.ts.html +17 -17
  30. package/coverage/lcov-report/{models → node-sdk/models}/bxml/Verb.ts.html +15 -15
  31. package/coverage/lcov-report/{models → node-sdk/models}/bxml/index.html +29 -14
  32. package/coverage/lcov-report/node-sdk/models/bxml/index.ts.html +94 -0
  33. package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/Bridge.ts.html +13 -13
  34. package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/Conference.ts.html +13 -13
  35. package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/CustomParam.ts.html +13 -13
  36. package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/Forward.ts.html +13 -13
  37. package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/Gather.ts.html +16 -16
  38. package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/Hangup.ts.html +13 -13
  39. package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/Pause.ts.html +13 -13
  40. package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/PauseRecording.ts.html +13 -13
  41. package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/PhoneNumber.ts.html +13 -13
  42. package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/PlayAudio.ts.html +13 -13
  43. package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/Record.ts.html +13 -13
  44. package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/Redirect.ts.html +13 -13
  45. package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/ResumeRecording.ts.html +13 -13
  46. package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/Ring.ts.html +13 -13
  47. package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/SendDtmf.ts.html +13 -13
  48. package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/SipUri.ts.html +13 -13
  49. package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/SpeakSentence.ts.html +15 -15
  50. package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/StartGather.ts.html +13 -13
  51. package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/StartRecording.ts.html +13 -13
  52. package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/StartStream.ts.html +14 -14
  53. package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/StartTranscription.ts.html +14 -14
  54. package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/StopGather.ts.html +13 -13
  55. package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/StopRecording.ts.html +13 -13
  56. package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/StopStream.ts.html +13 -13
  57. package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/StopTranscription.ts.html +13 -13
  58. package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/StreamParam.ts.html +13 -13
  59. package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/Tag.ts.html +13 -13
  60. package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/Transfer.ts.html +14 -14
  61. package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/index.html +27 -12
  62. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.ts.html +175 -0
  63. package/coverage/lcov-report/{models → node-sdk/models}/call-direction-enum.ts.html +11 -11
  64. package/coverage/lcov-report/{models → node-sdk/models}/call-state-enum.ts.html +11 -11
  65. package/coverage/lcov-report/node-sdk/models/call-transcription-detected-language-enum.ts.html +181 -0
  66. package/coverage/lcov-report/node-sdk/models/call-transcription-track-enum.ts.html +178 -0
  67. package/coverage/lcov-report/{models → node-sdk/models}/callback-method-enum.ts.html +11 -11
  68. package/coverage/lcov-report/{models → node-sdk/models}/conference-state-enum.ts.html +11 -11
  69. package/coverage/lcov-report/{models → node-sdk/models}/file-format-enum.ts.html +11 -11
  70. package/coverage/lcov-report/{models → node-sdk/models}/index.html +57 -12
  71. package/coverage/lcov-report/node-sdk/models/index.ts.html +367 -0
  72. package/coverage/lcov-report/{models → node-sdk/models}/list-message-direction-enum.ts.html +11 -11
  73. package/coverage/lcov-report/{models → node-sdk/models}/lookup-status-enum.ts.html +11 -11
  74. package/coverage/lcov-report/{models → node-sdk/models}/machine-detection-mode-enum.ts.html +11 -11
  75. package/coverage/lcov-report/{models → node-sdk/models}/message-direction-enum.ts.html +11 -11
  76. package/coverage/lcov-report/{models → node-sdk/models}/message-status-enum.ts.html +11 -11
  77. package/coverage/lcov-report/{models → node-sdk/models}/message-type-enum.ts.html +11 -11
  78. package/coverage/lcov-report/{models → node-sdk/models}/priority-enum.ts.html +11 -11
  79. package/coverage/lcov-report/{models → node-sdk/models}/recording-state-enum.ts.html +11 -11
  80. package/coverage/lcov-report/{models → node-sdk/models}/redirect-method-enum.ts.html +11 -11
  81. package/coverage/lcov.info +3366 -162
  82. package/custom_templates/README.mustache +22 -5
  83. package/custom_templates/package.mustache +2 -1
  84. package/custom_templates/tsconfig.mustache +2 -1
  85. package/dist/api/calls-api.js +2 -2
  86. package/dist/api/conferences-api.js +2 -2
  87. package/dist/api/media-api.js +2 -2
  88. package/dist/api/messages-api.js +2 -2
  89. package/dist/api/mfaapi.js +2 -2
  90. package/dist/api/phone-number-lookup-api.js +2 -2
  91. package/dist/api/recordings-api.js +2 -2
  92. package/dist/api/statistics-api.js +2 -2
  93. package/dist/api/transcriptions-api.d.ts +4 -4
  94. package/dist/api/transcriptions-api.js +6 -6
  95. package/dist/common.js +2 -2
  96. package/dist/models/call-recording-metadata.d.ts +6 -0
  97. package/dist/models/call-transcription-detected-language-enum.d.ts +22 -0
  98. package/dist/models/call-transcription-detected-language-enum.js +26 -0
  99. package/dist/models/call-transcription-metadata.d.ts +6 -0
  100. package/dist/models/call-transcription-track-enum.d.ts +21 -0
  101. package/dist/models/call-transcription-track-enum.js +25 -0
  102. package/dist/models/call-transcription.d.ts +7 -16
  103. package/dist/models/call-transcription.js +0 -10
  104. package/dist/models/conference-recording-metadata.d.ts +6 -0
  105. package/dist/models/index.d.ts +2 -0
  106. package/dist/models/index.js +2 -0
  107. package/jest.config.js +1 -0
  108. package/models/call-recording-metadata.ts +6 -0
  109. package/models/call-transcription-detected-language-enum.ts +32 -0
  110. package/models/call-transcription-metadata.ts +6 -0
  111. package/models/call-transcription-track-enum.ts +31 -0
  112. package/models/call-transcription.ts +11 -18
  113. package/models/conference-recording-metadata.ts +6 -0
  114. package/models/index.ts +2 -0
  115. package/package.json +3 -2
  116. package/tests/callUtils.ts +11 -11
  117. package/tests/smoke/bxml.test.ts +17 -17
  118. package/tests/smoke/calls-api.test.ts +38 -38
  119. package/tests/smoke/conferences-api.test.ts +19 -19
  120. package/tests/smoke/media-api.test.ts +11 -11
  121. package/tests/smoke/messages-api.test.ts +26 -26
  122. package/tests/smoke/mfaapi.test.ts +18 -18
  123. package/tests/smoke/phone-number-lookup-api.test.ts +16 -6
  124. package/tests/smoke/recordings-api.test.ts +31 -31
  125. package/tests/smoke/statistics-api.test.ts +7 -7
  126. package/tests/smoke/transcriptions-api.test.ts +16 -15
  127. package/tests/unit/api/calls-api.test.ts +180 -0
  128. package/tests/unit/api/conferences-api.test.ts +160 -0
  129. package/tests/unit/api/media-api.test.ts +59 -0
  130. package/tests/unit/api/messages-api.test.ts +122 -0
  131. package/tests/unit/api/mfaapi.test.ts +76 -0
  132. package/tests/unit/api/phone-number-lookup-api.test.ts +96 -0
  133. package/tests/unit/api/recordings-api.test.ts +179 -0
  134. package/tests/unit/api/statistics-api.test.ts +35 -0
  135. package/tests/unit/api/transcriptions-api.test.ts +61 -0
  136. package/tests/unit/models/call-transcription-detected-language-enum.test.ts +9 -0
  137. package/tests/unit/models/call-transcription-track-enum.test.ts +8 -0
@@ -1,20 +1,37 @@
1
1
  ## {{npmName}}
2
2
 
3
- [![Tests](https://github.com/Bandwidth/node-sdk/actions/workflows/test-nightly.yml/badge.svg)](https://github.com/Bandwidth/node-sdk/actions/workflows/test-nightly.yml)
3
+ [![Deploy](https://github.com/Bandwidth/node-sdk/actions/workflows/deploy.yml/badge.svg)](https://github.com/Bandwidth/node-sdk/actions/workflows/deploy.yml)
4
4
 
5
5
  ### Test Matrix
6
6
  | **OS** | **Node** |
7
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 |
8
+ | Windows 2019 | 18, 20, 22 |
9
+ | Windows 2022 | 18, 20, 22 |
10
+ | Ubuntu 20.04 | 18, 20, 22 |
11
+ | Ubuntu 22.04 | 18, 20, 22 |
12
12
 
13
13
  #### Available on NPM
14
14
  ```
15
15
  npm install {{npmName}}
16
16
  ```
17
17
 
18
+
19
+ #### To Run Unit Tests Locally
20
+
21
+ 1. Install Prism
22
+ ```bash
23
+ npm install -g @stoplight/prism-cli
24
+ ```
25
+ 2. Start Prism Mock Server with the OpenAPI Spec
26
+ ```bash
27
+ prism mock bandwidth.yml
28
+ ```
29
+ 3. Run Tests
30
+ ```bash
31
+ npm run test-unit
32
+ ```
33
+
34
+
18
35
  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:
19
36
 
20
37
  Environment
@@ -33,9 +33,10 @@
33
33
  "xmlbuilder2": "^3.1.1"
34
34
  },
35
35
  "devDependencies": {
36
- "@types/node": "^12.11.5",
37
36
  "@types/jest": "^29.5.12",
37
+ "@types/node": "^12.11.5",
38
38
  "jest": "^29.7.0",
39
+ "jest-extended": "^4.0.2",
39
40
  "ts-jest": "^29.1.1",
40
41
  "typescript": "^5.0"
41
42
  }{{#npmRepository}},{{/npmRepository}}
@@ -23,5 +23,6 @@
23
23
  "dist",
24
24
  "tests",
25
25
  "node_modules"
26
- ]
26
+ ],
27
+ "include": ["global.d.ts"]
27
28
  }
@@ -48,8 +48,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
48
48
  });
49
49
  };
50
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;
51
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
52
+ return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
53
53
  function verb(n) { return function (v) { return step([n, v]); }; }
54
54
  function step(op) {
55
55
  if (f) throw new TypeError("Generator is already executing.");
@@ -48,8 +48,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
48
48
  });
49
49
  };
50
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;
51
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
52
+ return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
53
53
  function verb(n) { return function (v) { return step([n, v]); }; }
54
54
  function step(op) {
55
55
  if (f) throw new TypeError("Generator is already executing.");
@@ -48,8 +48,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
48
48
  });
49
49
  };
50
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;
51
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
52
+ return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
53
53
  function verb(n) { return function (v) { return step([n, v]); }; }
54
54
  function step(op) {
55
55
  if (f) throw new TypeError("Generator is already executing.");
@@ -48,8 +48,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
48
48
  });
49
49
  };
50
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;
51
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
52
+ return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
53
53
  function verb(n) { return function (v) { return step([n, v]); }; }
54
54
  function step(op) {
55
55
  if (f) throw new TypeError("Generator is already executing.");
@@ -48,8 +48,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
48
48
  });
49
49
  };
50
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;
51
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
52
+ return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
53
53
  function verb(n) { return function (v) { return step([n, v]); }; }
54
54
  function step(op) {
55
55
  if (f) throw new TypeError("Generator is already executing.");
@@ -48,8 +48,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
48
48
  });
49
49
  };
50
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;
51
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
52
+ return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
53
53
  function verb(n) { return function (v) { return step([n, v]); }; }
54
54
  function step(op) {
55
55
  if (f) throw new TypeError("Generator is already executing.");
@@ -48,8 +48,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
48
48
  });
49
49
  };
50
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;
51
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
52
+ return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
53
53
  function verb(n) { return function (v) { return step([n, v]); }; }
54
54
  function step(op) {
55
55
  if (f) throw new TypeError("Generator is already executing.");
@@ -48,8 +48,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
48
48
  });
49
49
  };
50
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;
51
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
52
+ return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
53
53
  function verb(n) { return function (v) { return step([n, v]); }; }
54
54
  function step(op) {
55
55
  if (f) throw new TypeError("Generator is already executing.");
@@ -20,7 +20,7 @@ import type { CallTranscriptionResponse } from '../models';
20
20
  */
21
21
  export declare const TranscriptionsApiAxiosParamCreator: (configuration?: Configuration) => {
22
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.
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 `200` 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
24
  * @summary Delete a specific transcription
25
25
  * @param {string} accountId Your Bandwidth Account ID.
26
26
  * @param {string} callId Programmable Voice API Call ID.
@@ -55,7 +55,7 @@ export declare const TranscriptionsApiAxiosParamCreator: (configuration?: Config
55
55
  */
56
56
  export declare const TranscriptionsApiFp: (configuration?: Configuration) => {
57
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.
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 `200` 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
59
  * @summary Delete a specific transcription
60
60
  * @param {string} accountId Your Bandwidth Account ID.
61
61
  * @param {string} callId Programmable Voice API Call ID.
@@ -90,7 +90,7 @@ export declare const TranscriptionsApiFp: (configuration?: Configuration) => {
90
90
  */
91
91
  export declare const TranscriptionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
92
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.
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 `200` 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
94
  * @summary Delete a specific transcription
95
95
  * @param {string} accountId Your Bandwidth Account ID.
96
96
  * @param {string} callId Programmable Voice API Call ID.
@@ -127,7 +127,7 @@ export declare const TranscriptionsApiFactory: (configuration?: Configuration, b
127
127
  */
128
128
  export declare class TranscriptionsApi extends BaseAPI {
129
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.
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 `200` 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
131
  * @summary Delete a specific transcription
132
132
  * @param {string} accountId Your Bandwidth Account ID.
133
133
  * @param {string} callId Programmable Voice API Call ID.
@@ -48,8 +48,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
48
48
  });
49
49
  };
50
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;
51
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
52
+ return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
53
53
  function verb(n) { return function (v) { return step([n, v]); }; }
54
54
  function step(op) {
55
55
  if (f) throw new TypeError("Generator is already executing.");
@@ -99,7 +99,7 @@ var TranscriptionsApiAxiosParamCreator = function (configuration) {
99
99
  var _this = this;
100
100
  return {
101
101
  /**
102
- * 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.
102
+ * Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `200` 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.
103
103
  * @summary Delete a specific transcription
104
104
  * @param {string} accountId Your Bandwidth Account ID.
105
105
  * @param {string} callId Programmable Voice API Call ID.
@@ -249,7 +249,7 @@ var TranscriptionsApiFp = function (configuration) {
249
249
  var localVarAxiosParamCreator = (0, exports.TranscriptionsApiAxiosParamCreator)(configuration);
250
250
  return {
251
251
  /**
252
- * 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.
252
+ * Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `200` 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.
253
253
  * @summary Delete a specific transcription
254
254
  * @param {string} accountId Your Bandwidth Account ID.
255
255
  * @param {string} callId Programmable Voice API Call ID.
@@ -333,7 +333,7 @@ var TranscriptionsApiFactory = function (configuration, basePath, axios) {
333
333
  var localVarFp = (0, exports.TranscriptionsApiFp)(configuration);
334
334
  return {
335
335
  /**
336
- * 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.
336
+ * Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `200` 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.
337
337
  * @summary Delete a specific transcription
338
338
  * @param {string} accountId Your Bandwidth Account ID.
339
339
  * @param {string} callId Programmable Voice API Call ID.
@@ -382,7 +382,7 @@ var TranscriptionsApi = /** @class */ (function (_super) {
382
382
  return _super !== null && _super.apply(this, arguments) || this;
383
383
  }
384
384
  /**
385
- * 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.
385
+ * Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `200` 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.
386
386
  * @summary Delete a specific transcription
387
387
  * @param {string} accountId Your Bandwidth Account ID.
388
388
  * @param {string} callId Programmable Voice API Call ID.
package/dist/common.js CHANGED
@@ -33,8 +33,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
33
33
  });
34
34
  };
35
35
  var __generator = (this && this.__generator) || function (thisArg, body) {
36
- var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
37
- return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
36
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
37
+ return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
38
38
  function verb(n) { return function (v) { return step([n, v]); }; }
39
39
  function step(op) {
40
40
  if (f) throw new TypeError("Generator is already executing.");
@@ -126,4 +126,10 @@ export interface CallRecordingMetadata {
126
126
  * @memberof CallRecordingMetadata
127
127
  */
128
128
  'transcription'?: RecordingTranscriptionMetadata | null;
129
+ /**
130
+ * A name to identify this recording.
131
+ * @type {string}
132
+ * @memberof CallRecordingMetadata
133
+ */
134
+ 'recordingName'?: string;
129
135
  }
@@ -0,0 +1,22 @@
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
+ * The detected language for this transcription.
14
+ * @export
15
+ * @enum {string}
16
+ */
17
+ export declare const CallTranscriptionDetectedLanguageEnum: {
18
+ readonly EnUs: "en-US";
19
+ readonly EsUs: "es-US";
20
+ readonly FrFr: "fr-FR";
21
+ };
22
+ export type CallTranscriptionDetectedLanguageEnum = typeof CallTranscriptionDetectedLanguageEnum[keyof typeof CallTranscriptionDetectedLanguageEnum];
@@ -0,0 +1,26 @@
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 });
16
+ exports.CallTranscriptionDetectedLanguageEnum = void 0;
17
+ /**
18
+ * The detected language for this transcription.
19
+ * @export
20
+ * @enum {string}
21
+ */
22
+ exports.CallTranscriptionDetectedLanguageEnum = {
23
+ EnUs: 'en-US',
24
+ EsUs: 'es-US',
25
+ FrFr: 'fr-FR'
26
+ };
@@ -21,6 +21,12 @@ export interface CallTranscriptionMetadata {
21
21
  * @memberof CallTranscriptionMetadata
22
22
  */
23
23
  'transcriptionId'?: string;
24
+ /**
25
+ * The programmable voice API transcription name. This name could be provided by the user when creating the transcription.
26
+ * @type {string}
27
+ * @memberof CallTranscriptionMetadata
28
+ */
29
+ 'transcriptionName'?: string;
24
30
  /**
25
31
  * A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice/#operation/getCallTranscription) endpoint.
26
32
  * @type {string}
@@ -0,0 +1,21 @@
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
+ * Which `track` this transcription is derived from.
14
+ * @export
15
+ * @enum {string}
16
+ */
17
+ export declare const CallTranscriptionTrackEnum: {
18
+ readonly Inbound: "inbound";
19
+ readonly Outbound: "outbound";
20
+ };
21
+ export type CallTranscriptionTrackEnum = typeof CallTranscriptionTrackEnum[keyof typeof CallTranscriptionTrackEnum];
@@ -0,0 +1,25 @@
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 });
16
+ exports.CallTranscriptionTrackEnum = void 0;
17
+ /**
18
+ * Which `track` this transcription is derived from.
19
+ * @export
20
+ * @enum {string}
21
+ */
22
+ exports.CallTranscriptionTrackEnum = {
23
+ Inbound: 'inbound',
24
+ Outbound: 'outbound'
25
+ };
@@ -9,6 +9,8 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import type { CallTranscriptionDetectedLanguageEnum } from './call-transcription-detected-language-enum';
13
+ import type { CallTranscriptionTrackEnum } from './call-transcription-track-enum';
12
14
  /**
13
15
  *
14
16
  * @export
@@ -16,14 +18,14 @@
16
18
  */
17
19
  export interface CallTranscription {
18
20
  /**
19
- * The detected language for this transcription.
20
- * @type {string}
21
+ *
22
+ * @type {CallTranscriptionDetectedLanguageEnum}
21
23
  * @memberof CallTranscription
22
24
  */
23
25
  'detectedLanguage'?: CallTranscriptionDetectedLanguageEnum;
24
26
  /**
25
- * Which `track` this transcription is derived from.
26
- * @type {string}
27
+ *
28
+ * @type {CallTranscriptionTrackEnum}
27
29
  * @memberof CallTranscription
28
30
  */
29
31
  'track'?: CallTranscriptionTrackEnum;
@@ -32,7 +34,7 @@ export interface CallTranscription {
32
34
  * @type {string}
33
35
  * @memberof CallTranscription
34
36
  */
35
- 'text'?: string;
37
+ 'transcript'?: string;
36
38
  /**
37
39
  * How confident the transcription engine was in transcribing the associated audio (from `0` to `1`).
38
40
  * @type {number}
@@ -40,14 +42,3 @@ export interface CallTranscription {
40
42
  */
41
43
  'confidence'?: number;
42
44
  }
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];
@@ -13,13 +13,3 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.CallTranscriptionTrackEnum = exports.CallTranscriptionDetectedLanguageEnum = void 0;
17
- exports.CallTranscriptionDetectedLanguageEnum = {
18
- EnUs: 'en-US',
19
- EsUs: 'es-US',
20
- FrFr: 'fr-FR'
21
- };
22
- exports.CallTranscriptionTrackEnum = {
23
- Inbound: 'inbound',
24
- Outbound: 'outbound'
25
- };
@@ -82,4 +82,10 @@ export interface ConferenceRecordingMetadata {
82
82
  * @memberof ConferenceRecordingMetadata
83
83
  */
84
84
  'mediaUrl'?: string | null;
85
+ /**
86
+ * A name to identify this recording.
87
+ * @type {string}
88
+ * @memberof ConferenceRecordingMetadata
89
+ */
90
+ 'recordingName'?: string;
85
91
  }
@@ -7,8 +7,10 @@ export * from './call-recording-metadata';
7
7
  export * from './call-state';
8
8
  export * from './call-state-enum';
9
9
  export * from './call-transcription';
10
+ export * from './call-transcription-detected-language-enum';
10
11
  export * from './call-transcription-metadata';
11
12
  export * from './call-transcription-response';
13
+ export * from './call-transcription-track-enum';
12
14
  export * from './callback-method-enum';
13
15
  export * from './code-request';
14
16
  export * from './conference';
@@ -23,8 +23,10 @@ __exportStar(require("./call-recording-metadata"), exports);
23
23
  __exportStar(require("./call-state"), exports);
24
24
  __exportStar(require("./call-state-enum"), exports);
25
25
  __exportStar(require("./call-transcription"), exports);
26
+ __exportStar(require("./call-transcription-detected-language-enum"), exports);
26
27
  __exportStar(require("./call-transcription-metadata"), exports);
27
28
  __exportStar(require("./call-transcription-response"), exports);
29
+ __exportStar(require("./call-transcription-track-enum"), exports);
28
30
  __exportStar(require("./callback-method-enum"), exports);
29
31
  __exportStar(require("./code-request"), exports);
30
32
  __exportStar(require("./conference"), exports);
package/jest.config.js CHANGED
@@ -2,6 +2,7 @@
2
2
  module.exports = {
3
3
  preset: 'ts-jest',
4
4
  testEnvironment: 'node',
5
+ setupFilesAfterEnv: ["jest-extended/all"],
5
6
  globals: {
6
7
  'BW_USERNAME': process.env.BW_USERNAME,
7
8
  'BW_PASSWORD': process.env.BW_PASSWORD,
@@ -137,6 +137,12 @@ export interface CallRecordingMetadata {
137
137
  * @memberof CallRecordingMetadata
138
138
  */
139
139
  'transcription'?: RecordingTranscriptionMetadata | null;
140
+ /**
141
+ * A name to identify this recording.
142
+ * @type {string}
143
+ * @memberof CallRecordingMetadata
144
+ */
145
+ 'recordingName'?: string;
140
146
  }
141
147
 
142
148
 
@@ -0,0 +1,32 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Bandwidth
5
+ * Bandwidth\'s Communication APIs
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: letstalk@bandwidth.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ * The detected language for this transcription.
19
+ * @export
20
+ * @enum {string}
21
+ */
22
+
23
+ export const CallTranscriptionDetectedLanguageEnum = {
24
+ EnUs: 'en-US',
25
+ EsUs: 'es-US',
26
+ FrFr: 'fr-FR'
27
+ } as const;
28
+
29
+ export type CallTranscriptionDetectedLanguageEnum = typeof CallTranscriptionDetectedLanguageEnum[keyof typeof CallTranscriptionDetectedLanguageEnum];
30
+
31
+
32
+
@@ -26,6 +26,12 @@ export interface CallTranscriptionMetadata {
26
26
  * @memberof CallTranscriptionMetadata
27
27
  */
28
28
  'transcriptionId'?: string;
29
+ /**
30
+ * The programmable voice API transcription name. This name could be provided by the user when creating the transcription.
31
+ * @type {string}
32
+ * @memberof CallTranscriptionMetadata
33
+ */
34
+ 'transcriptionName'?: string;
29
35
  /**
30
36
  * A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice/#operation/getCallTranscription) endpoint.
31
37
  * @type {string}
@@ -0,0 +1,31 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Bandwidth
5
+ * Bandwidth\'s Communication APIs
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: letstalk@bandwidth.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ * Which `track` this transcription is derived from.
19
+ * @export
20
+ * @enum {string}
21
+ */
22
+
23
+ export const CallTranscriptionTrackEnum = {
24
+ Inbound: 'inbound',
25
+ Outbound: 'outbound'
26
+ } as const;
27
+
28
+ export type CallTranscriptionTrackEnum = typeof CallTranscriptionTrackEnum[keyof typeof CallTranscriptionTrackEnum];
29
+
30
+
31
+