bandwidth-sdk 3.0.0 → 3.1.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 (83) hide show
  1. package/bandwidth.yml +15 -0
  2. package/coverage/clover.xml +47 -47
  3. package/coverage/coverage-final.json +2 -2
  4. package/coverage/lcov-report/index.html +19 -19
  5. package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +1 -1
  6. package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +1 -1
  7. package/coverage/lcov-report/node-sdk/api/index.html +19 -19
  8. package/coverage/lcov-report/node-sdk/api/media-api.ts.html +1 -1
  9. package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +1 -1
  10. package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +1 -1
  11. package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +1 -1
  12. package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +57 -57
  13. package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +1 -1
  14. package/coverage/lcov-report/node-sdk/api/transcriptions-api.ts.html +1 -1
  15. package/coverage/lcov-report/node-sdk/api.ts.html +1 -1
  16. package/coverage/lcov-report/node-sdk/base.ts.html +1 -1
  17. package/coverage/lcov-report/node-sdk/common.ts.html +18 -18
  18. package/coverage/lcov-report/node-sdk/configuration.ts.html +1 -1
  19. package/coverage/lcov-report/node-sdk/index.html +1 -1
  20. package/coverage/lcov-report/node-sdk/models/bxml/Bxml.ts.html +1 -1
  21. package/coverage/lcov-report/node-sdk/models/bxml/NestableVerb.ts.html +1 -1
  22. package/coverage/lcov-report/node-sdk/models/bxml/Response.ts.html +1 -1
  23. package/coverage/lcov-report/node-sdk/models/bxml/Root.ts.html +1 -1
  24. package/coverage/lcov-report/node-sdk/models/bxml/Verb.ts.html +1 -1
  25. package/coverage/lcov-report/node-sdk/models/bxml/index.html +1 -1
  26. package/coverage/lcov-report/node-sdk/models/bxml/index.ts.html +1 -1
  27. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Bridge.ts.html +1 -1
  28. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Conference.ts.html +1 -1
  29. package/coverage/lcov-report/node-sdk/models/bxml/verbs/CustomParam.ts.html +1 -1
  30. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Forward.ts.html +1 -1
  31. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Gather.ts.html +1 -1
  32. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Hangup.ts.html +1 -1
  33. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Pause.ts.html +1 -1
  34. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PauseRecording.ts.html +1 -1
  35. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PhoneNumber.ts.html +1 -1
  36. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PlayAudio.ts.html +1 -1
  37. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Record.ts.html +1 -1
  38. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Redirect.ts.html +1 -1
  39. package/coverage/lcov-report/node-sdk/models/bxml/verbs/ResumeRecording.ts.html +1 -1
  40. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Ring.ts.html +1 -1
  41. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SendDtmf.ts.html +1 -1
  42. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SipUri.ts.html +1 -1
  43. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SpeakSentence.ts.html +1 -1
  44. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartGather.ts.html +1 -1
  45. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartRecording.ts.html +1 -1
  46. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartStream.ts.html +1 -1
  47. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartTranscription.ts.html +1 -1
  48. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopGather.ts.html +1 -1
  49. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopRecording.ts.html +1 -1
  50. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopStream.ts.html +1 -1
  51. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopTranscription.ts.html +1 -1
  52. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StreamParam.ts.html +1 -1
  53. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Tag.ts.html +1 -1
  54. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Transfer.ts.html +1 -1
  55. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.html +1 -1
  56. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.ts.html +1 -1
  57. package/coverage/lcov-report/node-sdk/models/call-direction-enum.ts.html +1 -1
  58. package/coverage/lcov-report/node-sdk/models/call-state-enum.ts.html +1 -1
  59. package/coverage/lcov-report/node-sdk/models/call-transcription-detected-language-enum.ts.html +1 -1
  60. package/coverage/lcov-report/node-sdk/models/call-transcription-track-enum.ts.html +1 -1
  61. package/coverage/lcov-report/node-sdk/models/callback-method-enum.ts.html +1 -1
  62. package/coverage/lcov-report/node-sdk/models/conference-state-enum.ts.html +1 -1
  63. package/coverage/lcov-report/node-sdk/models/file-format-enum.ts.html +1 -1
  64. package/coverage/lcov-report/node-sdk/models/index.html +1 -1
  65. package/coverage/lcov-report/node-sdk/models/index.ts.html +1 -1
  66. package/coverage/lcov-report/node-sdk/models/list-message-direction-enum.ts.html +1 -1
  67. package/coverage/lcov-report/node-sdk/models/lookup-status-enum.ts.html +1 -1
  68. package/coverage/lcov-report/node-sdk/models/machine-detection-mode-enum.ts.html +1 -1
  69. package/coverage/lcov-report/node-sdk/models/message-direction-enum.ts.html +1 -1
  70. package/coverage/lcov-report/node-sdk/models/message-status-enum.ts.html +1 -1
  71. package/coverage/lcov-report/node-sdk/models/message-type-enum.ts.html +1 -1
  72. package/coverage/lcov-report/node-sdk/models/priority-enum.ts.html +1 -1
  73. package/coverage/lcov-report/node-sdk/models/recording-state-enum.ts.html +1 -1
  74. package/coverage/lcov-report/node-sdk/models/redirect-method-enum.ts.html +1 -1
  75. package/coverage/lcov.info +94 -94
  76. package/models/call-recording-metadata.ts +6 -0
  77. package/models/call-transcription-metadata.ts +6 -0
  78. package/models/conference-recording-metadata.ts +6 -0
  79. package/package.json +1 -1
  80. package/tests/smoke/transcriptions-api.test.ts +1 -0
  81. package/tests/unit/api/messages-api.test.ts +1 -1
  82. package/tests/unit/api/recordings-api.test.ts +5 -1
  83. package/tests/unit/api/transcriptions-api.test.ts +1 -0
package/bandwidth.yml CHANGED
@@ -2802,6 +2802,8 @@ components:
2802
2802
  $ref: '#/components/schemas/mediaUrl'
2803
2803
  transcription:
2804
2804
  $ref: '#/components/schemas/recordingTranscriptionMetadata'
2805
+ recordingName:
2806
+ $ref: '#/components/schemas/recordingName'
2805
2807
  conference:
2806
2808
  type: object
2807
2809
  properties:
@@ -3041,6 +3043,8 @@ components:
3041
3043
  $ref: '#/components/schemas/status'
3042
3044
  mediaUrl:
3043
3045
  $ref: '#/components/schemas/mediaUrl'
3046
+ recordingName:
3047
+ $ref: '#/components/schemas/recordingName'
3044
3048
  machineDetectionConfiguration:
3045
3049
  type: object
3046
3050
  description: >-
@@ -3254,6 +3258,7 @@ components:
3254
3258
  $ref: '#/components/schemas/callTranscriptionMetadata'
3255
3259
  example:
3256
3260
  - transcriptionId: t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b
3261
+ transcriptionName: live_transcription
3257
3262
  transcriptionUrl: >-
3258
3263
  https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-fef240ff-5cfc9091-8069-4863-a8c0-a4dcbbf1f1a4/transcriptions/t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b
3259
3264
  callTranscriptionMetadata:
@@ -3263,6 +3268,12 @@ components:
3263
3268
  type: string
3264
3269
  description: The programmable voice API transcription ID.
3265
3270
  example: t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b
3271
+ transcriptionName:
3272
+ type: string
3273
+ description: >-
3274
+ The programmable voice API transcription name. This name could be
3275
+ provided by the user when creating the transcription.
3276
+ example: live_transcription
3266
3277
  transcriptionUrl:
3267
3278
  type: string
3268
3279
  description: >-
@@ -4259,6 +4270,10 @@ components:
4259
4270
  type: string
4260
4271
  description: The call id associated with the event.
4261
4272
  example: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
4273
+ recordingName:
4274
+ type: string
4275
+ description: A name to identify this recording.
4276
+ example: my-recording-name
4262
4277
  callUrl:
4263
4278
  type: string
4264
4279
  description: The URL of the call associated with the event.
@@ -1,7 +1,7 @@
1
1
  <?xml version="1.0" encoding="UTF-8"?>
2
- <coverage generated="1721141610865" clover="3.2.0">
3
- <project timestamp="1721141610865" name="All files">
4
- <metrics statements="1494" coveredstatements="1383" conditionals="1157" coveredconditionals="812" methods="410" coveredmethods="319" elements="3061" coveredelements="2514" complexity="0" loc="1494" ncloc="1494" packages="5" files="65" classes="65"/>
2
+ <coverage generated="1723581548798" clover="3.2.0">
3
+ <project timestamp="1723581548798" name="All files">
4
+ <metrics statements="1494" coveredstatements="1362" conditionals="1157" coveredconditionals="794" methods="410" coveredmethods="314" elements="3061" coveredelements="2470" complexity="0" loc="1494" ncloc="1494" packages="5" files="65" classes="65"/>
5
5
  <package name="node-sdk">
6
6
  <metrics statements="89" coveredstatements="69" conditionals="70" coveredconditionals="39" methods="21" coveredmethods="17"/>
7
7
  <file name="api.ts" path="/home/runner/work/node-sdk/node-sdk/api.ts">
@@ -39,7 +39,7 @@
39
39
  <line num="19" count="9" type="stmt"/>
40
40
  <line num="25" count="9" type="stmt"/>
41
41
  <line num="32" count="9" type="stmt"/>
42
- <line num="33" count="107" type="cond" truecount="2" falsecount="1"/>
42
+ <line num="33" count="104" type="cond" truecount="2" falsecount="1"/>
43
43
  <line num="34" count="0" type="stmt"/>
44
44
  <line num="42" count="9" type="stmt"/>
45
45
  <line num="43" count="0" type="cond" truecount="0" falsecount="3"/>
@@ -48,8 +48,8 @@
48
48
  <line num="46" count="0" type="cond" truecount="0" falsecount="1"/>
49
49
  <line num="47" count="0" type="stmt"/>
50
50
  <line num="55" count="9" type="stmt"/>
51
- <line num="56" count="47" type="cond" truecount="4" falsecount="0"/>
52
- <line num="57" count="43" type="stmt"/>
51
+ <line num="56" count="46" type="cond" truecount="4" falsecount="0"/>
52
+ <line num="57" count="42" type="stmt"/>
53
53
  <line num="65" count="9" type="stmt"/>
54
54
  <line num="66" count="0" type="cond" truecount="0" falsecount="3"/>
55
55
  <line num="67" count="0" type="cond" truecount="0" falsecount="1"/>
@@ -62,31 +62,31 @@
62
62
  <line num="81" count="0" type="stmt"/>
63
63
  <line num="82" count="0" type="cond" truecount="0" falsecount="1"/>
64
64
  <line num="83" count="0" type="stmt"/>
65
- <line num="87" count="142" type="cond" truecount="1" falsecount="0"/>
66
- <line num="88" count="95" type="cond" truecount="0" falsecount="1"/>
67
- <line num="89" count="95" type="cond" truecount="2" falsecount="0"/>
68
- <line num="90" count="94" type="cond" truecount="2" falsecount="0"/>
69
- <line num="91" count="47" type="stmt"/>
70
- <line num="94" count="47" type="stmt"/>
65
+ <line num="87" count="139" type="cond" truecount="1" falsecount="0"/>
66
+ <line num="88" count="93" type="cond" truecount="0" falsecount="1"/>
67
+ <line num="89" count="93" type="cond" truecount="2" falsecount="0"/>
68
+ <line num="90" count="92" type="cond" truecount="2" falsecount="0"/>
69
+ <line num="91" count="46" type="stmt"/>
70
+ <line num="94" count="46" type="stmt"/>
71
71
  <line num="95" count="1" type="cond" truecount="1" falsecount="1"/>
72
72
  <line num="100" count="1" type="cond" truecount="1" falsecount="1"/>
73
73
  <line num="101" count="0" type="stmt"/>
74
74
  <line num="104" count="1" type="stmt"/>
75
- <line num="113" count="141" type="stmt"/>
76
- <line num="114" count="47" type="stmt"/>
77
- <line num="115" count="47" type="stmt"/>
78
- <line num="116" count="47" type="stmt"/>
75
+ <line num="113" count="138" type="stmt"/>
76
+ <line num="114" count="46" type="stmt"/>
77
+ <line num="115" count="46" type="stmt"/>
78
+ <line num="116" count="46" type="stmt"/>
79
79
  <line num="123" count="9" type="stmt"/>
80
80
  <line num="124" count="18" type="stmt"/>
81
81
  <line num="125" count="18" type="cond" truecount="5" falsecount="0"/>
82
82
  <line num="128" count="18" type="cond" truecount="2" falsecount="0"/>
83
83
  <line num="129" count="74" type="cond" truecount="3" falsecount="1"/>
84
84
  <line num="137" count="9" type="stmt"/>
85
- <line num="138" count="47" type="stmt"/>
85
+ <line num="138" count="46" type="stmt"/>
86
86
  <line num="145" count="9" type="stmt"/>
87
- <line num="146" count="47" type="cond" truecount="0" falsecount="2"/>
88
- <line num="147" count="47" type="cond" truecount="7" falsecount="3"/>
89
- <line num="148" count="47" type="stmt"/>
87
+ <line num="146" count="46" type="cond" truecount="0" falsecount="2"/>
88
+ <line num="147" count="46" type="cond" truecount="7" falsecount="3"/>
89
+ <line num="148" count="46" type="stmt"/>
90
90
  </file>
91
91
  <file name="configuration.ts" path="/home/runner/work/node-sdk/node-sdk/configuration.ts">
92
92
  <metrics statements="14" coveredstatements="14" conditionals="4" coveredconditionals="2" methods="3" coveredmethods="3"/>
@@ -107,7 +107,7 @@
107
107
  </file>
108
108
  </package>
109
109
  <package name="node-sdk.api">
110
- <metrics statements="1086" coveredstatements="996" conditionals="1009" coveredconditionals="702" methods="309" coveredmethods="222"/>
110
+ <metrics statements="1086" coveredstatements="975" conditionals="1009" coveredconditionals="684" methods="309" coveredmethods="217"/>
111
111
  <file name="calls-api.ts" path="/home/runner/work/node-sdk/node-sdk/api/calls-api.ts">
112
112
  <metrics statements="144" coveredstatements="130" conditionals="132" coveredconditionals="90" methods="39" coveredmethods="28"/>
113
113
  <line num="18" count="9" type="stmt"/>
@@ -845,12 +845,12 @@
845
845
  <line num="229" count="9" type="stmt"/>
846
846
  </file>
847
847
  <file name="recordings-api.ts" path="/home/runner/work/node-sdk/node-sdk/api/recordings-api.ts">
848
- <metrics statements="253" coveredstatements="237" conditionals="254" coveredconditionals="180" methods="74" coveredmethods="53"/>
848
+ <metrics statements="253" coveredstatements="216" conditionals="254" coveredconditionals="162" methods="74" coveredmethods="48"/>
849
849
  <line num="18" count="9" type="stmt"/>
850
850
  <line num="21" count="9" type="stmt"/>
851
851
  <line num="23" count="9" type="stmt"/>
852
- <line num="38" count="10" type="stmt"/>
853
- <line num="39" count="10" type="stmt"/>
852
+ <line num="38" count="9" type="stmt"/>
853
+ <line num="39" count="9" type="stmt"/>
854
854
  <line num="49" count="2" type="cond" truecount="1" falsecount="0"/>
855
855
  <line num="51" count="1" type="stmt"/>
856
856
  <line num="53" count="1" type="stmt"/>
@@ -915,22 +915,22 @@
915
915
  <line num="216" count="1" type="cond" truecount="2" falsecount="2"/>
916
916
  <line num="217" count="1" type="stmt"/>
917
917
  <line num="219" count="1" type="stmt"/>
918
- <line num="233" count="2" type="cond" truecount="1" falsecount="0"/>
919
- <line num="235" count="1" type="stmt"/>
920
- <line num="237" count="1" type="stmt"/>
921
- <line num="239" count="1" type="stmt"/>
922
- <line num="240" count="1" type="stmt"/>
923
- <line num="245" count="1" type="stmt"/>
924
- <line num="247" count="1" type="cond" truecount="1" falsecount="0"/>
925
- <line num="248" count="1" type="stmt"/>
926
- <line num="251" count="1" type="stmt"/>
927
- <line num="252" count="1" type="stmt"/>
928
- <line num="253" count="1" type="stmt"/>
929
- <line num="257" count="1" type="stmt"/>
930
- <line num="261" count="1" type="stmt"/>
931
- <line num="262" count="1" type="cond" truecount="2" falsecount="2"/>
932
- <line num="263" count="1" type="stmt"/>
933
- <line num="265" count="1" type="stmt"/>
918
+ <line num="233" count="0" type="cond" truecount="0" falsecount="1"/>
919
+ <line num="235" count="0" type="stmt"/>
920
+ <line num="237" count="0" type="stmt"/>
921
+ <line num="239" count="0" type="stmt"/>
922
+ <line num="240" count="0" type="stmt"/>
923
+ <line num="245" count="0" type="stmt"/>
924
+ <line num="247" count="0" type="cond" truecount="0" falsecount="1"/>
925
+ <line num="248" count="0" type="stmt"/>
926
+ <line num="251" count="0" type="stmt"/>
927
+ <line num="252" count="0" type="stmt"/>
928
+ <line num="253" count="0" type="stmt"/>
929
+ <line num="257" count="0" type="stmt"/>
930
+ <line num="261" count="0" type="stmt"/>
931
+ <line num="262" count="0" type="cond" truecount="0" falsecount="4"/>
932
+ <line num="263" count="0" type="stmt"/>
933
+ <line num="265" count="0" type="stmt"/>
934
934
  <line num="279" count="2" type="cond" truecount="1" falsecount="0"/>
935
935
  <line num="281" count="1" type="stmt"/>
936
936
  <line num="283" count="1" type="stmt"/>
@@ -1022,8 +1022,8 @@
1022
1022
  <line num="509" count="1" type="stmt"/>
1023
1023
  <line num="511" count="1" type="stmt"/>
1024
1024
  <line num="523" count="9" type="stmt"/>
1025
- <line num="524" count="10" type="stmt"/>
1026
- <line num="525" count="10" type="stmt"/>
1025
+ <line num="524" count="9" type="stmt"/>
1026
+ <line num="525" count="9" type="stmt"/>
1027
1027
  <line num="536" count="1" type="cond" truecount="1" falsecount="0"/>
1028
1028
  <line num="537" count="1" type="cond" truecount="6" falsecount="2"/>
1029
1029
  <line num="538" count="1" type="cond" truecount="6" falsecount="2"/>
@@ -1040,10 +1040,10 @@
1040
1040
  <line num="582" count="1" type="cond" truecount="6" falsecount="2"/>
1041
1041
  <line num="583" count="1" type="cond" truecount="6" falsecount="2"/>
1042
1042
  <line num="584" count="1" type="cond" truecount="1" falsecount="1"/>
1043
- <line num="596" count="1" type="cond" truecount="1" falsecount="0"/>
1044
- <line num="597" count="1" type="cond" truecount="6" falsecount="2"/>
1045
- <line num="598" count="1" type="cond" truecount="6" falsecount="2"/>
1046
- <line num="599" count="1" type="cond" truecount="1" falsecount="1"/>
1043
+ <line num="596" count="0" type="cond" truecount="0" falsecount="1"/>
1044
+ <line num="597" count="0" type="cond" truecount="0" falsecount="8"/>
1045
+ <line num="598" count="0" type="cond" truecount="0" falsecount="8"/>
1046
+ <line num="599" count="0" type="cond" truecount="0" falsecount="2"/>
1047
1047
  <line num="611" count="1" type="cond" truecount="1" falsecount="0"/>
1048
1048
  <line num="612" count="1" type="cond" truecount="6" falsecount="2"/>
1049
1049
  <line num="613" count="1" type="cond" truecount="6" falsecount="2"/>
@@ -1087,7 +1087,7 @@
1087
1087
  <line num="872" count="9" type="stmt"/>
1088
1088
  <line num="873" count="1" type="stmt"/>
1089
1089
  <line num="886" count="9" type="stmt"/>
1090
- <line num="887" count="1" type="stmt"/>
1090
+ <line num="887" count="0" type="stmt"/>
1091
1091
  <line num="900" count="9" type="stmt"/>
1092
1092
  <line num="901" count="1" type="stmt"/>
1093
1093
  <line num="916" count="9" type="stmt"/>