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
@@ -46,13 +46,15 @@ jobs:
46
46
  - name: Setup Node
47
47
  uses: actions/setup-node@v4
48
48
  with:
49
- node-version: 18
49
+ node-version: 22
50
50
  registry-url: "https://registry.npmjs.org"
51
51
 
52
52
  - name: Install Packages and Test
53
53
  run: |
54
54
  yarn
55
- yarn test-unit
55
+ npm install -g @stoplight/prism-cli
56
+ prism mock ./bandwidth.yml & yarn test-unit
57
+ shell: bash
56
58
 
57
59
  - name: Publish npm Package
58
60
  run: |
@@ -32,7 +32,7 @@ jobs:
32
32
  strategy:
33
33
  matrix:
34
34
  os: [windows-2022, windows-2019, ubuntu-20.04, ubuntu-22.04]
35
- node-version: [16, 18, 20, 22]
35
+ node-version: [18, 20, 22]
36
36
  fail-fast: false
37
37
  steps:
38
38
  - name: Checkout
@@ -46,6 +46,8 @@ jobs:
46
46
  - name: Install Packages and Test
47
47
  run: |
48
48
  yarn
49
- yarn test-unit
49
+ npm install -g @stoplight/prism-cli
50
+ prism mock ./bandwidth.yml & yarn test-unit
50
51
  env:
51
52
  OPERATING_SYSTEM: ${{ matrix.os }}
53
+ shell: bash
@@ -1,8 +1,11 @@
1
- name: Nightly Smoke Tests
1
+ name: Smoke Tests
2
2
 
3
3
  on:
4
4
  schedule:
5
5
  - cron: "0 4 * * *"
6
+ pull_request:
7
+ paths:
8
+ - "tests/smoke/**"
6
9
 
7
10
  concurrency:
8
11
  group: ${{ github.workflow }}-${{ github.head_ref }}
@@ -26,18 +29,16 @@ env:
26
29
 
27
30
  jobs:
28
31
  test_main:
29
- name: Nightly Smoke Test
32
+ name: Smoke Test
30
33
  runs-on: ubuntu-latest
31
34
  steps:
32
35
  - name: Checkout
33
36
  uses: actions/checkout@v4
34
- with:
35
- ref: "main"
36
37
 
37
38
  - name: Setup Node
38
39
  uses: actions/setup-node@v4
39
40
  with:
40
- node-version: 20
41
+ node-version: 22
41
42
 
42
43
  - name: Install Packages and Test
43
44
  run: |
@@ -23,8 +23,10 @@ models/call-direction-enum.ts
23
23
  models/call-recording-metadata.ts
24
24
  models/call-state-enum.ts
25
25
  models/call-state.ts
26
+ models/call-transcription-detected-language-enum.ts
26
27
  models/call-transcription-metadata.ts
27
28
  models/call-transcription-response.ts
29
+ models/call-transcription-track-enum.ts
28
30
  models/call-transcription.ts
29
31
  models/callback-method-enum.ts
30
32
  models/code-request.ts
package/README.md CHANGED
@@ -1,20 +1,37 @@
1
1
  ## bandwidth-sdk
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 bandwidth-sdk
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
@@ -34,7 +34,7 @@ import type { VoiceApiError } from '../models';
34
34
  export const TranscriptionsApiAxiosParamCreator = function (configuration?: Configuration) {
35
35
  return {
36
36
  /**
37
- * 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.
37
+ * 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.
38
38
  * @summary Delete a specific transcription
39
39
  * @param {string} accountId Your Bandwidth Account ID.
40
40
  * @param {string} callId Programmable Voice API Call ID.
@@ -178,7 +178,7 @@ export const TranscriptionsApiFp = function(configuration?: Configuration) {
178
178
  const localVarAxiosParamCreator = TranscriptionsApiAxiosParamCreator(configuration)
179
179
  return {
180
180
  /**
181
- * 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.
181
+ * 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.
182
182
  * @summary Delete a specific transcription
183
183
  * @param {string} accountId Your Bandwidth Account ID.
184
184
  * @param {string} callId Programmable Voice API Call ID.
@@ -232,7 +232,7 @@ export const TranscriptionsApiFactory = function (configuration?: Configuration,
232
232
  const localVarFp = TranscriptionsApiFp(configuration)
233
233
  return {
234
234
  /**
235
- * 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.
235
+ * 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.
236
236
  * @summary Delete a specific transcription
237
237
  * @param {string} accountId Your Bandwidth Account ID.
238
238
  * @param {string} callId Programmable Voice API Call ID.
@@ -277,7 +277,7 @@ export const TranscriptionsApiFactory = function (configuration?: Configuration,
277
277
  */
278
278
  export class TranscriptionsApi extends BaseAPI {
279
279
  /**
280
- * 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.
280
+ * 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.
281
281
  * @summary Delete a specific transcription
282
282
  * @param {string} accountId Your Bandwidth Account ID.
283
283
  * @param {string} callId Programmable Voice API Call ID.
package/bandwidth.yml CHANGED
@@ -377,7 +377,7 @@ paths:
377
377
  $ref: '#/components/requestBodies/updateCallRequest'
378
378
  responses:
379
379
  '200':
380
- description: Call was successfully modified.
380
+ $ref: '#/components/responses/updateCallResponse'
381
381
  '400':
382
382
  $ref: '#/components/responses/voiceBadRequestError'
383
383
  '401':
@@ -777,7 +777,7 @@ paths:
777
777
  $ref: '#/components/requestBodies/updateCallRecordingRequest'
778
778
  responses:
779
779
  '200':
780
- description: Recording state was successfully modified.
780
+ $ref: '#/components/responses/updateRecordingResponse'
781
781
  '400':
782
782
  $ref: '#/components/responses/voiceBadRequestError'
783
783
  '401':
@@ -1173,7 +1173,7 @@ paths:
1173
1173
  [startTranscription](/docs/voice/bxml/startTranscription).
1174
1174
 
1175
1175
 
1176
- Note: After the deletion is requested and a `204` is returned, the
1176
+ Note: After the deletion is requested and a `200` is returned, the
1177
1177
  transcription will not be accessible anymore. However, it is not deleted
1178
1178
  immediately. This deletion process, while transparent and irreversible,
1179
1179
  can take an additional 24 to 48 hours.
@@ -1183,7 +1183,7 @@ paths:
1183
1183
  - $ref: '#/components/parameters/callId'
1184
1184
  - $ref: '#/components/parameters/transcriptionId'
1185
1185
  responses:
1186
- '204':
1186
+ '200':
1187
1187
  $ref: '#/components/responses/deleteCallTranscriptionResponse'
1188
1188
  '400':
1189
1189
  $ref: '#/components/responses/voiceBadRequestError'
@@ -1324,7 +1324,7 @@ paths:
1324
1324
  '403':
1325
1325
  $ref: '#/components/responses/tnLookupForbiddenError'
1326
1326
  '404':
1327
- description: Not Found
1327
+ $ref: '#/components/responses/tnLookupNotFoundError'
1328
1328
  '429':
1329
1329
  $ref: '#/components/responses/tnLookupTooManyRequestsError'
1330
1330
  '500':
@@ -2131,6 +2131,21 @@ components:
2131
2131
 
2132
2132
  and will include its result.
2133
2133
  example: async
2134
+ callTranscriptionDetectedLanguageEnum:
2135
+ type: string
2136
+ enum:
2137
+ - en-US
2138
+ - es-US
2139
+ - fr-FR
2140
+ description: The detected language for this transcription.
2141
+ example: en-US
2142
+ callTranscriptionTrackEnum:
2143
+ type: string
2144
+ enum:
2145
+ - inbound
2146
+ - outbound
2147
+ description: Which `track` this transcription is derived from.
2148
+ example: inbound
2134
2149
  createCall:
2135
2150
  type: object
2136
2151
  required:
@@ -2496,7 +2511,7 @@ components:
2496
2511
  description: >-
2497
2512
  The phone number that made the call, in E.164 format (e.g.
2498
2513
  +15555555555).
2499
- example: '19195554321'
2514
+ example: '+19195554321'
2500
2515
  direction:
2501
2516
  $ref: '#/components/schemas/callDirectionEnum'
2502
2517
  state:
@@ -2787,6 +2802,8 @@ components:
2787
2802
  $ref: '#/components/schemas/mediaUrl'
2788
2803
  transcription:
2789
2804
  $ref: '#/components/schemas/recordingTranscriptionMetadata'
2805
+ recordingName:
2806
+ $ref: '#/components/schemas/recordingName'
2790
2807
  conference:
2791
2808
  type: object
2792
2809
  properties:
@@ -2902,6 +2919,7 @@ components:
2902
2919
  $ref: '#/components/schemas/conferenceId'
2903
2920
  memberUrl:
2904
2921
  type: string
2922
+ format: uri
2905
2923
  description: >-
2906
2924
  A URL that may be used to retrieve information about or update
2907
2925
 
@@ -3026,6 +3044,8 @@ components:
3026
3044
  $ref: '#/components/schemas/status'
3027
3045
  mediaUrl:
3028
3046
  $ref: '#/components/schemas/mediaUrl'
3047
+ recordingName:
3048
+ $ref: '#/components/schemas/recordingName'
3029
3049
  machineDetectionConfiguration:
3030
3050
  type: object
3031
3051
  description: >-
@@ -3239,6 +3259,7 @@ components:
3239
3259
  $ref: '#/components/schemas/callTranscriptionMetadata'
3240
3260
  example:
3241
3261
  - transcriptionId: t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b
3262
+ transcriptionName: live_transcription
3242
3263
  transcriptionUrl: >-
3243
3264
  https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-fef240ff-5cfc9091-8069-4863-a8c0-a4dcbbf1f1a4/transcriptions/t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b
3244
3265
  callTranscriptionMetadata:
@@ -3248,6 +3269,12 @@ components:
3248
3269
  type: string
3249
3270
  description: The programmable voice API transcription ID.
3250
3271
  example: t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b
3272
+ transcriptionName:
3273
+ type: string
3274
+ description: >-
3275
+ The programmable voice API transcription name. This name could be
3276
+ provided by the user when creating the transcription.
3277
+ example: live_transcription
3251
3278
  transcriptionUrl:
3252
3279
  type: string
3253
3280
  description: >-
@@ -3265,7 +3292,7 @@ components:
3265
3292
  accountId:
3266
3293
  type: string
3267
3294
  description: The user account associated with the call.
3268
- example: '920012'
3295
+ example: '9900000'
3269
3296
  callId:
3270
3297
  type: string
3271
3298
  description: The call id associated with the event.
@@ -3281,27 +3308,16 @@ components:
3281
3308
  example:
3282
3309
  - detectedLanguage: en-US
3283
3310
  track: inbound
3284
- text: Hello World! This is an example.
3311
+ transcript: Hello World! This is an example.
3285
3312
  confidence: 0.9
3286
3313
  callTranscription:
3287
3314
  type: object
3288
3315
  properties:
3289
3316
  detectedLanguage:
3290
- type: string
3291
- enum:
3292
- - en-US
3293
- - es-US
3294
- - fr-FR
3295
- description: The detected language for this transcription.
3296
- example: en-US
3317
+ $ref: '#/components/schemas/callTranscriptionDetectedLanguageEnum'
3297
3318
  track:
3298
- type: string
3299
- enum:
3300
- - inbound
3301
- - outbound
3302
- description: Which `track` this transcription is derived from.
3303
- example: inbound
3304
- text:
3319
+ $ref: '#/components/schemas/callTranscriptionTrackEnum'
3320
+ transcript:
3305
3321
  type: string
3306
3322
  description: The transcription itself.
3307
3323
  example: Hello World! This is an example.
@@ -3327,6 +3343,7 @@ components:
3327
3343
  $ref: '#/components/schemas/status'
3328
3344
  completedTime:
3329
3345
  type: string
3346
+ format: date-time
3330
3347
  description: The time that the transcription was completed
3331
3348
  example: '2022-06-13T18:46:29.715Z'
3332
3349
  url:
@@ -4139,7 +4156,7 @@ components:
4139
4156
  accountId:
4140
4157
  type: string
4141
4158
  description: The user account associated with the call.
4142
- example: '920012'
4159
+ example: '9900000'
4143
4160
  applicationId:
4144
4161
  type: string
4145
4162
  description: The id of the application associated with the call.
@@ -4240,7 +4257,7 @@ components:
4240
4257
  description: >-
4241
4258
  The phone number used as the to field of the B-leg call, in E.164 format
4242
4259
  (e.g. +15555555555).
4243
- example: +15555555555)
4260
+ example: '+15555555555'
4244
4261
  mediaUrl:
4245
4262
  nullable: true
4246
4263
  type: string
@@ -4254,8 +4271,13 @@ components:
4254
4271
  type: string
4255
4272
  description: The call id associated with the event.
4256
4273
  example: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
4274
+ recordingName:
4275
+ type: string
4276
+ description: A name to identify this recording.
4277
+ example: my-recording-name
4257
4278
  callUrl:
4258
4279
  type: string
4280
+ format: uri
4259
4281
  description: The URL of the call associated with the event.
4260
4282
  example: >-
4261
4283
  https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
@@ -4451,7 +4473,7 @@ components:
4451
4473
  messageId:
4452
4474
  type: string
4453
4475
  description: Messaging API Message ID.
4454
- example: 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6
4476
+ example: 1589228074636lm4k2je7j7jklbn2
4455
4477
  verifyCodeRequest:
4456
4478
  type: object
4457
4479
  properties:
@@ -4715,7 +4737,7 @@ components:
4715
4737
  schema:
4716
4738
  $ref: '#/components/schemas/messagingRequestError'
4717
4739
  createCallResponse:
4718
- description: Call Successfully Created
4740
+ description: Created
4719
4741
  headers:
4720
4742
  Location:
4721
4743
  description: The URL for further interactions with this call
@@ -4729,13 +4751,15 @@ components:
4729
4751
  createCall Response:
4730
4752
  $ref: '#/components/examples/createCallResponseExample'
4731
4753
  getCallStateResponse:
4732
- description: Call found
4754
+ description: OK
4733
4755
  content:
4734
4756
  application/json:
4735
4757
  schema:
4736
4758
  $ref: '#/components/schemas/callState'
4759
+ updateCallResponse:
4760
+ description: OK
4737
4761
  listCallsResponse:
4738
- description: Calls retrieved successfully
4762
+ description: OK
4739
4763
  content:
4740
4764
  application/json:
4741
4765
  schema:
@@ -4743,13 +4767,15 @@ components:
4743
4767
  items:
4744
4768
  $ref: '#/components/schemas/callState'
4745
4769
  getStatisticsResponse:
4746
- description: Statistics Found
4770
+ description: OK
4747
4771
  content:
4748
4772
  application/json:
4749
4773
  schema:
4750
4774
  $ref: '#/components/schemas/accountStatistics'
4775
+ updateRecordingResponse:
4776
+ description: OK
4751
4777
  listCallRecordingsResponse:
4752
- description: Recordings retrieved successfully
4778
+ description: OK
4753
4779
  content:
4754
4780
  application/json:
4755
4781
  schema:
@@ -4757,13 +4783,13 @@ components:
4757
4783
  items:
4758
4784
  $ref: '#/components/schemas/callRecordingMetadata'
4759
4785
  getCallRecordingResponse:
4760
- description: Recording found
4786
+ description: OK
4761
4787
  content:
4762
4788
  application/json:
4763
4789
  schema:
4764
4790
  $ref: '#/components/schemas/callRecordingMetadata'
4765
4791
  downloadRecordingMediaResponse:
4766
- description: Media found
4792
+ description: OK
4767
4793
  content:
4768
4794
  audio/vnd.wave:
4769
4795
  schema:
@@ -4774,27 +4800,27 @@ components:
4774
4800
  type: string
4775
4801
  format: binary
4776
4802
  getRecordingTranscriptionResponse:
4777
- description: Transcription found.
4803
+ description: OK
4778
4804
  content:
4779
4805
  application/json:
4780
4806
  schema:
4781
4807
  $ref: '#/components/schemas/recordingTranscriptions'
4782
4808
  listTranscriptionsResponse:
4783
- description: Transcription found.
4809
+ description: OK
4784
4810
  content:
4785
4811
  application/json:
4786
4812
  schema:
4787
4813
  $ref: '#/components/schemas/callTranscriptionMetadataList'
4788
4814
  getCallTranscriptionResponse:
4789
- description: Transcription found.
4815
+ description: OK
4790
4816
  content:
4791
4817
  application/json:
4792
4818
  schema:
4793
4819
  $ref: '#/components/schemas/callTranscriptionResponse'
4794
4820
  deleteCallTranscriptionResponse:
4795
- description: Transcription data was deleted.
4821
+ description: No Content
4796
4822
  listConferencesResponse:
4797
- description: Conferences retrieved successfully
4823
+ description: OK
4798
4824
  content:
4799
4825
  application/json:
4800
4826
  schema:
@@ -4805,19 +4831,19 @@ components:
4805
4831
  listConferences Response:
4806
4832
  $ref: '#/components/examples/listConferencesResponseExample'
4807
4833
  getConferenceResponse:
4808
- description: Conferences retrieved successfully
4834
+ description: OK
4809
4835
  content:
4810
4836
  application/json:
4811
4837
  schema:
4812
4838
  $ref: '#/components/schemas/conference'
4813
4839
  getConferenceMemberResponse:
4814
- description: Conference member found
4840
+ description: OK
4815
4841
  content:
4816
4842
  application/json:
4817
4843
  schema:
4818
4844
  $ref: '#/components/schemas/conferenceMember'
4819
4845
  listConferenceRecordingsResponse:
4820
- description: Conference recordings retrieved successfully
4846
+ description: OK
4821
4847
  content:
4822
4848
  application/json:
4823
4849
  schema:
@@ -4825,7 +4851,7 @@ components:
4825
4851
  items:
4826
4852
  $ref: '#/components/schemas/conferenceRecordingMetadata'
4827
4853
  getConferenceRecordingResponse:
4828
- description: Conference recording found
4854
+ description: OK
4829
4855
  content:
4830
4856
  application/json:
4831
4857
  schema:
@@ -5048,6 +5074,8 @@ components:
5048
5074
  summary: Example Unsupported Media Type Error
5049
5075
  value:
5050
5076
  message: Content-Type must be application/json.
5077
+ tnLookupNotFoundError:
5078
+ description: Not Found
5051
5079
  tnLookupTooManyRequestsError:
5052
5080
  description: Too Many Requests
5053
5081
  content:
@@ -5787,6 +5815,7 @@ components:
5787
5815
  answerMethod: POST
5788
5816
  answerUrl: https://myServer.example/bandwidth/webhooks/answer
5789
5817
  answerFallbackMethod: POST
5818
+ answerFallbackUrl: https://myServer.example/bandwidth/webhooks/answerFallback
5790
5819
  disconnectMethod: POST
5791
5820
  disconnectUrl: https://myServer.example/bandwidth/webhooks/disconnect
5792
5821
  username: mySecretUsername