bandwidth-sdk 8.1.5 → 8.3.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 (236) hide show
  1. package/.github/workflows/deploy.yml +1 -1
  2. package/.openapi-generator/FILES +4 -0
  3. package/README.md +2 -0
  4. package/api/media-api.ts +12 -12
  5. package/bandwidth.yml +65 -4
  6. package/configuration.ts +8 -2
  7. package/coverage/clover.xml +121 -104
  8. package/coverage/coverage-final.json +17 -15
  9. package/coverage/lcov-report/index.html +24 -24
  10. package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +1 -1
  11. package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +1 -1
  12. package/coverage/lcov-report/node-sdk/api/endpoints-api.ts.html +1 -1
  13. package/coverage/lcov-report/node-sdk/api/index.html +1 -1
  14. package/coverage/lcov-report/node-sdk/api/media-api.ts.html +13 -13
  15. package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +1 -1
  16. package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +1 -1
  17. package/coverage/lcov-report/node-sdk/api/multi-channel-api.ts.html +1 -1
  18. package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +1 -1
  19. package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +1 -1
  20. package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +1 -1
  21. package/coverage/lcov-report/node-sdk/api/toll-free-verification-api.ts.html +1 -1
  22. package/coverage/lcov-report/node-sdk/api/transcriptions-api.ts.html +1 -1
  23. package/coverage/lcov-report/node-sdk/api.ts.html +1 -1
  24. package/coverage/lcov-report/node-sdk/base.ts.html +1 -1
  25. package/coverage/lcov-report/node-sdk/common.ts.html +18 -18
  26. package/coverage/lcov-report/node-sdk/configuration.ts.html +31 -13
  27. package/coverage/lcov-report/node-sdk/index.html +19 -19
  28. package/coverage/lcov-report/node-sdk/models/business-entity-type-enum.ts.html +1 -1
  29. package/coverage/lcov-report/node-sdk/models/business-registration-type-enum.ts.html +1 -1
  30. package/coverage/lcov-report/node-sdk/models/bxml/Bxml.ts.html +1 -1
  31. package/coverage/lcov-report/node-sdk/models/bxml/NestableVerb.ts.html +14 -14
  32. package/coverage/lcov-report/node-sdk/models/bxml/Response.ts.html +1 -1
  33. package/coverage/lcov-report/node-sdk/models/bxml/Root.ts.html +1 -1
  34. package/coverage/lcov-report/node-sdk/models/bxml/Verb.ts.html +13 -13
  35. package/coverage/lcov-report/node-sdk/models/bxml/index.html +1 -1
  36. package/coverage/lcov-report/node-sdk/models/bxml/index.ts.html +1 -1
  37. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Bridge.ts.html +1 -1
  38. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Conference.ts.html +1 -1
  39. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Connect.ts.html +5 -2
  40. package/coverage/lcov-report/node-sdk/models/bxml/verbs/CustomParam.ts.html +1 -1
  41. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Endpoint.ts.html +1 -1
  42. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Forward.ts.html +8 -2
  43. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Gather.ts.html +26 -2
  44. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Hangup.ts.html +1 -1
  45. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Pause.ts.html +1 -1
  46. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PauseRecording.ts.html +1 -1
  47. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PhoneNumber.ts.html +1 -1
  48. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PlayAudio.ts.html +1 -1
  49. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Record.ts.html +8 -2
  50. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Redirect.ts.html +1 -1
  51. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Refer.ts.html +190 -0
  52. package/coverage/lcov-report/node-sdk/models/bxml/verbs/ResumeRecording.ts.html +1 -1
  53. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Ring.ts.html +1 -1
  54. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SendDtmf.ts.html +1 -1
  55. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SipUri.ts.html +5 -5
  56. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SpeakSentence.ts.html +1 -1
  57. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartGather.ts.html +1 -1
  58. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartRecording.ts.html +8 -2
  59. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartStream.ts.html +1 -1
  60. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartTranscription.ts.html +8 -2
  61. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopGather.ts.html +1 -1
  62. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopRecording.ts.html +1 -1
  63. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopStream.ts.html +1 -1
  64. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopTranscription.ts.html +1 -1
  65. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StreamParam.ts.html +1 -1
  66. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Tag.ts.html +1 -1
  67. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Transfer.ts.html +5 -2
  68. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.html +23 -8
  69. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.ts.html +7 -4
  70. package/coverage/lcov-report/node-sdk/models/call-direction-enum.ts.html +2 -2
  71. package/coverage/lcov-report/node-sdk/models/call-state-enum.ts.html +1 -1
  72. package/coverage/lcov-report/node-sdk/models/call-transcription-detected-language-enum.ts.html +1 -1
  73. package/coverage/lcov-report/node-sdk/models/call-transcription-track-enum.ts.html +1 -1
  74. package/coverage/lcov-report/node-sdk/models/callback-method-enum.ts.html +1 -1
  75. package/coverage/lcov-report/node-sdk/models/card-width-enum.ts.html +1 -1
  76. package/coverage/lcov-report/node-sdk/models/completed-lookup-status-enum.ts.html +1 -1
  77. package/coverage/lcov-report/node-sdk/models/conference-state-enum.ts.html +1 -1
  78. package/coverage/lcov-report/node-sdk/models/deactivation-event-enum.ts.html +1 -1
  79. package/coverage/lcov-report/node-sdk/models/device-status-enum.ts.html +1 -1
  80. package/coverage/lcov-report/node-sdk/models/endpoint-direction-enum.ts.html +1 -1
  81. package/coverage/lcov-report/node-sdk/models/endpoint-event-type-enum.ts.html +1 -1
  82. package/coverage/lcov-report/node-sdk/models/endpoint-status-enum.ts.html +1 -1
  83. package/coverage/lcov-report/node-sdk/models/endpoint-type-enum.ts.html +1 -1
  84. package/coverage/lcov-report/node-sdk/models/file-format-enum.ts.html +1 -1
  85. package/coverage/lcov-report/node-sdk/models/in-progress-lookup-status-enum.ts.html +1 -1
  86. package/coverage/lcov-report/node-sdk/models/inbound-callback-type-enum.ts.html +1 -1
  87. package/coverage/lcov-report/node-sdk/models/index.html +20 -5
  88. package/coverage/lcov-report/node-sdk/models/index.ts.html +10 -4
  89. package/coverage/lcov-report/node-sdk/models/latest-message-delivery-status-enum.ts.html +1 -1
  90. package/coverage/lcov-report/node-sdk/models/line-type-enum.ts.html +1 -1
  91. package/coverage/lcov-report/node-sdk/models/list-message-direction-enum.ts.html +1 -1
  92. package/coverage/lcov-report/node-sdk/models/machine-detection-mode-enum.ts.html +1 -1
  93. package/coverage/lcov-report/node-sdk/models/message-direction-enum.ts.html +1 -1
  94. package/coverage/lcov-report/node-sdk/models/message-status-enum.ts.html +1 -1
  95. package/coverage/lcov-report/node-sdk/models/message-type-enum.ts.html +1 -1
  96. package/coverage/lcov-report/node-sdk/models/multi-channel-message-channel-enum.ts.html +1 -1
  97. package/coverage/lcov-report/node-sdk/models/priority-enum.ts.html +1 -1
  98. package/coverage/lcov-report/node-sdk/models/product-type-enum.ts.html +1 -1
  99. package/coverage/lcov-report/node-sdk/models/rbm-action-type-enum.ts.html +1 -1
  100. package/coverage/lcov-report/node-sdk/models/rbm-media-height-enum.ts.html +1 -1
  101. package/coverage/lcov-report/node-sdk/models/rbm-open-url-enum.ts.html +1 -1
  102. package/coverage/lcov-report/node-sdk/models/rbm-web-view-enum.ts.html +1 -1
  103. package/coverage/lcov-report/node-sdk/models/recording-state-enum.ts.html +1 -1
  104. package/coverage/lcov-report/node-sdk/models/redirect-method-enum.ts.html +1 -1
  105. package/coverage/lcov-report/node-sdk/models/refer-call-status-enum.ts.html +172 -0
  106. package/coverage/lcov-report/node-sdk/models/standalone-card-orientation-enum.ts.html +1 -1
  107. package/coverage/lcov-report/node-sdk/models/status-callback-type-enum.ts.html +1 -1
  108. package/coverage/lcov-report/node-sdk/models/tfv-callback-status-enum.ts.html +1 -1
  109. package/coverage/lcov-report/node-sdk/models/tfv-status-enum.ts.html +1 -1
  110. package/coverage/lcov-report/node-sdk/models/thumbnail-alignment-enum.ts.html +1 -1
  111. package/coverage/lcov-report/node-sdk/models/webhook-subscription-type-enum.ts.html +1 -1
  112. package/coverage/lcov.info +232 -191
  113. package/custom_templates/configuration.mustache +7 -1
  114. package/dist/api/media-api.d.ts +12 -12
  115. package/dist/api/media-api.js +12 -12
  116. package/dist/configuration.d.ts +5 -0
  117. package/dist/configuration.js +5 -4
  118. package/dist/models/answer-callback.d.ts +1 -1
  119. package/dist/models/bridge-complete-callback.d.ts +1 -1
  120. package/dist/models/bridge-target-complete-callback.d.ts +1 -1
  121. package/dist/models/bxml/verbs/Connect.d.ts +1 -0
  122. package/dist/models/bxml/verbs/Forward.d.ts +2 -0
  123. package/dist/models/bxml/verbs/Gather.d.ts +8 -0
  124. package/dist/models/bxml/verbs/Record.d.ts +2 -0
  125. package/dist/models/bxml/verbs/Refer.d.ts +27 -0
  126. package/dist/models/bxml/verbs/Refer.js +45 -0
  127. package/dist/models/bxml/verbs/StartRecording.d.ts +2 -0
  128. package/dist/models/bxml/verbs/StartTranscription.d.ts +2 -0
  129. package/dist/models/bxml/verbs/Transfer.d.ts +1 -0
  130. package/dist/models/bxml/verbs/index.d.ts +1 -0
  131. package/dist/models/bxml/verbs/index.js +1 -0
  132. package/dist/models/conference-completed-callback.d.ts +1 -1
  133. package/dist/models/conference-created-callback.d.ts +1 -1
  134. package/dist/models/conference-member-exit-callback.d.ts +1 -1
  135. package/dist/models/conference-member-join-callback.d.ts +1 -1
  136. package/dist/models/conference-recording-available-callback.d.ts +1 -1
  137. package/dist/models/conference-redirect-callback.d.ts +1 -1
  138. package/dist/models/disconnect-callback.d.ts +1 -1
  139. package/dist/models/dtmf-callback.d.ts +1 -1
  140. package/dist/models/gather-callback.d.ts +1 -1
  141. package/dist/models/index.d.ts +2 -0
  142. package/dist/models/index.js +2 -0
  143. package/dist/models/initiate-callback.d.ts +1 -1
  144. package/dist/models/machine-detection-complete-callback.d.ts +1 -1
  145. package/dist/models/recording-available-callback.d.ts +1 -1
  146. package/dist/models/recording-complete-callback.d.ts +1 -1
  147. package/dist/models/redirect-callback.d.ts +1 -1
  148. package/dist/models/refer-call-status-enum.d.ts +19 -0
  149. package/dist/models/refer-call-status-enum.js +23 -0
  150. package/dist/models/refer-complete-callback.d.ts +72 -0
  151. package/dist/models/refer-complete-callback.js +15 -0
  152. package/dist/models/transcription-available-callback.d.ts +1 -1
  153. package/dist/models/transfer-answer-callback.d.ts +1 -1
  154. package/dist/models/transfer-complete-callback.d.ts +1 -1
  155. package/dist/models/transfer-disconnect-callback.d.ts +1 -1
  156. package/docs/AnswerCallback.md +1 -1
  157. package/docs/BridgeCompleteCallback.md +1 -1
  158. package/docs/BridgeTargetCompleteCallback.md +1 -1
  159. package/docs/ConferenceCompletedCallback.md +1 -1
  160. package/docs/ConferenceCreatedCallback.md +1 -1
  161. package/docs/ConferenceMemberExitCallback.md +1 -1
  162. package/docs/ConferenceMemberJoinCallback.md +1 -1
  163. package/docs/ConferenceRecordingAvailableCallback.md +1 -1
  164. package/docs/ConferenceRedirectCallback.md +1 -1
  165. package/docs/DisconnectCallback.md +1 -1
  166. package/docs/DtmfCallback.md +1 -1
  167. package/docs/GatherCallback.md +1 -1
  168. package/docs/InitiateCallback.md +1 -1
  169. package/docs/MachineDetectionCompleteCallback.md +1 -1
  170. package/docs/MediaApi.md +6 -6
  171. package/docs/RecordingAvailableCallback.md +1 -1
  172. package/docs/RecordingCompleteCallback.md +1 -1
  173. package/docs/RedirectCallback.md +1 -1
  174. package/docs/ReferCallStatusEnum.md +11 -0
  175. package/docs/ReferCompleteCallback.md +49 -0
  176. package/docs/TranscriptionAvailableCallback.md +1 -1
  177. package/docs/TransferAnswerCallback.md +1 -1
  178. package/docs/TransferCompleteCallback.md +1 -1
  179. package/docs/TransferDisconnectCallback.md +1 -1
  180. package/models/answer-callback.ts +1 -1
  181. package/models/bridge-complete-callback.ts +1 -1
  182. package/models/bridge-target-complete-callback.ts +1 -1
  183. package/models/bxml/verbs/Connect.ts +1 -0
  184. package/models/bxml/verbs/Forward.ts +2 -0
  185. package/models/bxml/verbs/Gather.ts +8 -0
  186. package/models/bxml/verbs/Record.ts +2 -0
  187. package/models/bxml/verbs/Refer.ts +35 -0
  188. package/models/bxml/verbs/StartRecording.ts +2 -0
  189. package/models/bxml/verbs/StartTranscription.ts +2 -0
  190. package/models/bxml/verbs/Transfer.ts +1 -0
  191. package/models/bxml/verbs/index.ts +1 -0
  192. package/models/conference-completed-callback.ts +1 -1
  193. package/models/conference-created-callback.ts +1 -1
  194. package/models/conference-member-exit-callback.ts +1 -1
  195. package/models/conference-member-join-callback.ts +1 -1
  196. package/models/conference-recording-available-callback.ts +1 -1
  197. package/models/conference-redirect-callback.ts +1 -1
  198. package/models/disconnect-callback.ts +1 -1
  199. package/models/dtmf-callback.ts +1 -1
  200. package/models/gather-callback.ts +1 -1
  201. package/models/index.ts +2 -0
  202. package/models/initiate-callback.ts +1 -1
  203. package/models/machine-detection-complete-callback.ts +1 -1
  204. package/models/recording-available-callback.ts +1 -1
  205. package/models/recording-complete-callback.ts +1 -1
  206. package/models/redirect-callback.ts +1 -1
  207. package/models/refer-call-status-enum.ts +29 -0
  208. package/models/refer-complete-callback.ts +84 -0
  209. package/models/transcription-available-callback.ts +1 -1
  210. package/models/transfer-answer-callback.ts +1 -1
  211. package/models/transfer-complete-callback.ts +1 -1
  212. package/models/transfer-disconnect-callback.ts +1 -1
  213. package/package.json +1 -1
  214. package/tests/smoke/bxml.test.ts +24 -7
  215. package/tests/unit/api/calls-api.test.ts +1 -2
  216. package/tests/unit/api/conferences-api.test.ts +1 -2
  217. package/tests/unit/api/endpoints-api.test.ts +1 -2
  218. package/tests/unit/api/media-api.test.ts +1 -2
  219. package/tests/unit/api/messages-api.test.ts +1 -2
  220. package/tests/unit/api/mfaapi.test.ts +1 -2
  221. package/tests/unit/api/multi-channel-api.test.ts +1 -2
  222. package/tests/unit/api/phone-number-lookup-api.test.ts +1 -2
  223. package/tests/unit/api/recordings-api.test.ts +1 -2
  224. package/tests/unit/api/statistics-api.test.ts +1 -2
  225. package/tests/unit/api/toll-free-verification-api.test.ts +1 -2
  226. package/tests/unit/api/transcriptions-api.test.ts +1 -2
  227. package/tests/unit/models/bxml/verbs/Connect.test.ts +6 -5
  228. package/tests/unit/models/bxml/verbs/Forward.test.ts +4 -2
  229. package/tests/unit/models/bxml/verbs/Gather.test.ts +14 -6
  230. package/tests/unit/models/bxml/verbs/Record.test.ts +4 -2
  231. package/tests/unit/models/bxml/verbs/Refer.test.ts +40 -0
  232. package/tests/unit/models/bxml/verbs/StartRecording.test.ts +4 -2
  233. package/tests/unit/models/bxml/verbs/StartTranscription.test.ts +8 -6
  234. package/tests/unit/models/bxml/verbs/Transfer.test.ts +7 -6
  235. package/tests/unit/models/refer-call-status-enum.test.ts +12 -0
  236. package/tests/unit/models/refer-complete-callback.test.ts +41 -0
@@ -58,7 +58,7 @@ jobs:
58
58
  shell: bash
59
59
 
60
60
  - name: Generate SDK with Updated Version
61
- uses: Bandwidth/generate-sdk-action@v4.0.0
61
+ uses: Bandwidth/generate-sdk-action@v4.1.0
62
62
  with:
63
63
  openapi-generator-version: ${{ env.OPENAPI_GENERATOR_VERSION }}
64
64
  language: typescript-axios
@@ -182,6 +182,8 @@ docs/RecordingTranscriptions.md
182
182
  docs/RecordingsApi.md
183
183
  docs/RedirectCallback.md
184
184
  docs/RedirectMethodEnum.md
185
+ docs/ReferCallStatusEnum.md
186
+ docs/ReferCompleteCallback.md
185
187
  docs/SipConnectionMetadata.md
186
188
  docs/SipCredentials.md
187
189
  docs/SmsMessageContent.md
@@ -387,6 +389,8 @@ models/recording-transcription-metadata.ts
387
389
  models/recording-transcriptions.ts
388
390
  models/redirect-callback.ts
389
391
  models/redirect-method-enum.ts
392
+ models/refer-call-status-enum.ts
393
+ models/refer-complete-callback.ts
390
394
  models/sip-connection-metadata.ts
391
395
  models/sip-credentials.ts
392
396
  models/sms-message-content.ts
package/README.md CHANGED
@@ -322,6 +322,8 @@ Class | Method | HTTP request | Description
322
322
  - [RecordingTranscriptions](docs/RecordingTranscriptions.md)
323
323
  - [RedirectCallback](docs/RedirectCallback.md)
324
324
  - [RedirectMethodEnum](docs/RedirectMethodEnum.md)
325
+ - [ReferCallStatusEnum](docs/ReferCallStatusEnum.md)
326
+ - [ReferCompleteCallback](docs/ReferCompleteCallback.md)
325
327
  - [SipConnectionMetadata](docs/SipConnectionMetadata.md)
326
328
  - [SipCredentials](docs/SipCredentials.md)
327
329
  - [SmsMessageContent](docs/SmsMessageContent.md)
package/api/media-api.ts CHANGED
@@ -34,7 +34,7 @@ export const MediaApiAxiosParamCreator = function (configuration?: Configuration
34
34
  * Deletes a media file from Bandwidth API server. Make sure you don\'t have any application scripts still using the media before you delete. If you accidentally delete a media file you can immediately upload a new file with the same name.
35
35
  * @summary Delete Media
36
36
  * @param {string} accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
37
- * @param {string} mediaId Media ID to retrieve.
37
+ * @param {string} mediaId The ID of the media file.
38
38
  * @param {*} [options] Override http request option.
39
39
  * @throws {RequiredError}
40
40
  */
@@ -80,7 +80,7 @@ export const MediaApiAxiosParamCreator = function (configuration?: Configuration
80
80
  * Downloads a media file you previously uploaded.
81
81
  * @summary Get Media
82
82
  * @param {string} accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
83
- * @param {string} mediaId Media ID to retrieve.
83
+ * @param {string} mediaId The ID of the media file.
84
84
  * @param {*} [options] Override http request option.
85
85
  * @throws {RequiredError}
86
86
  */
@@ -172,7 +172,7 @@ export const MediaApiAxiosParamCreator = function (configuration?: Configuration
172
172
  * Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
173
173
  * @summary Upload Media
174
174
  * @param {string} accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
175
- * @param {string} mediaId Media ID to retrieve.
175
+ * @param {string} mediaId The ID of the media file.
176
176
  * @param {File} body
177
177
  * @param {string} [contentType] The media type of the entity-body.
178
178
  * @param {string} [cacheControl] General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.
@@ -240,7 +240,7 @@ export const MediaApiFp = function(configuration?: Configuration) {
240
240
  * Deletes a media file from Bandwidth API server. Make sure you don\'t have any application scripts still using the media before you delete. If you accidentally delete a media file you can immediately upload a new file with the same name.
241
241
  * @summary Delete Media
242
242
  * @param {string} accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
243
- * @param {string} mediaId Media ID to retrieve.
243
+ * @param {string} mediaId The ID of the media file.
244
244
  * @param {*} [options] Override http request option.
245
245
  * @throws {RequiredError}
246
246
  */
@@ -254,7 +254,7 @@ export const MediaApiFp = function(configuration?: Configuration) {
254
254
  * Downloads a media file you previously uploaded.
255
255
  * @summary Get Media
256
256
  * @param {string} accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
257
- * @param {string} mediaId Media ID to retrieve.
257
+ * @param {string} mediaId The ID of the media file.
258
258
  * @param {*} [options] Override http request option.
259
259
  * @throws {RequiredError}
260
260
  */
@@ -282,7 +282,7 @@ export const MediaApiFp = function(configuration?: Configuration) {
282
282
  * Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
283
283
  * @summary Upload Media
284
284
  * @param {string} accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
285
- * @param {string} mediaId Media ID to retrieve.
285
+ * @param {string} mediaId The ID of the media file.
286
286
  * @param {File} body
287
287
  * @param {string} [contentType] The media type of the entity-body.
288
288
  * @param {string} [cacheControl] General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.
@@ -308,7 +308,7 @@ export const MediaApiFactory = function (configuration?: Configuration, basePath
308
308
  * Deletes a media file from Bandwidth API server. Make sure you don\'t have any application scripts still using the media before you delete. If you accidentally delete a media file you can immediately upload a new file with the same name.
309
309
  * @summary Delete Media
310
310
  * @param {string} accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
311
- * @param {string} mediaId Media ID to retrieve.
311
+ * @param {string} mediaId The ID of the media file.
312
312
  * @param {*} [options] Override http request option.
313
313
  * @throws {RequiredError}
314
314
  */
@@ -319,7 +319,7 @@ export const MediaApiFactory = function (configuration?: Configuration, basePath
319
319
  * Downloads a media file you previously uploaded.
320
320
  * @summary Get Media
321
321
  * @param {string} accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
322
- * @param {string} mediaId Media ID to retrieve.
322
+ * @param {string} mediaId The ID of the media file.
323
323
  * @param {*} [options] Override http request option.
324
324
  * @throws {RequiredError}
325
325
  */
@@ -341,7 +341,7 @@ export const MediaApiFactory = function (configuration?: Configuration, basePath
341
341
  * Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
342
342
  * @summary Upload Media
343
343
  * @param {string} accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
344
- * @param {string} mediaId Media ID to retrieve.
344
+ * @param {string} mediaId The ID of the media file.
345
345
  * @param {File} body
346
346
  * @param {string} [contentType] The media type of the entity-body.
347
347
  * @param {string} [cacheControl] General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.
@@ -362,7 +362,7 @@ export class MediaApi extends BaseAPI {
362
362
  * Deletes a media file from Bandwidth API server. Make sure you don\'t have any application scripts still using the media before you delete. If you accidentally delete a media file you can immediately upload a new file with the same name.
363
363
  * @summary Delete Media
364
364
  * @param {string} accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
365
- * @param {string} mediaId Media ID to retrieve.
365
+ * @param {string} mediaId The ID of the media file.
366
366
  * @param {*} [options] Override http request option.
367
367
  * @throws {RequiredError}
368
368
  */
@@ -374,7 +374,7 @@ export class MediaApi extends BaseAPI {
374
374
  * Downloads a media file you previously uploaded.
375
375
  * @summary Get Media
376
376
  * @param {string} accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
377
- * @param {string} mediaId Media ID to retrieve.
377
+ * @param {string} mediaId The ID of the media file.
378
378
  * @param {*} [options] Override http request option.
379
379
  * @throws {RequiredError}
380
380
  */
@@ -398,7 +398,7 @@ export class MediaApi extends BaseAPI {
398
398
  * Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
399
399
  * @summary Upload Media
400
400
  * @param {string} accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
401
- * @param {string} mediaId Media ID to retrieve.
401
+ * @param {string} mediaId The ID of the media file.
402
402
  * @param {File} body
403
403
  * @param {string} [contentType] The media type of the entity-body.
404
404
  * @param {string} [cacheControl] General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.
package/bandwidth.yml CHANGED
@@ -3184,6 +3184,13 @@ components:
3184
3184
  - outbound
3185
3185
  description: The direction of the call.
3186
3186
  example: inbound
3187
+ referCallStatusEnum:
3188
+ type: string
3189
+ enum:
3190
+ - success
3191
+ - failure
3192
+ description: The outcome of the REFER operation.
3193
+ example: success
3187
3194
  fileFormatEnum:
3188
3195
  type: string
3189
3196
  enum:
@@ -5134,6 +5141,45 @@ components:
5134
5141
  $ref: '#/components/schemas/transferCallerId'
5135
5142
  transferTo:
5136
5143
  $ref: '#/components/schemas/transferTo'
5144
+ referCompleteCallback:
5145
+ type: object
5146
+ description: >-
5147
+ This event is sent to the referCompleteUrl of a call's <Refer> verb when
5148
+ the SIP REFER flow completes. On success, the call has been torn down
5149
+ and the BXML returned from this callback is ignored. On failure, the
5150
+ call remains active and the BXML returned from this callback is executed
5151
+ on the call.
5152
+ properties:
5153
+ eventType:
5154
+ $ref: '#/components/schemas/eventType'
5155
+ eventTime:
5156
+ $ref: '#/components/schemas/eventTime'
5157
+ accountId:
5158
+ $ref: '#/components/schemas/accountId'
5159
+ applicationId:
5160
+ $ref: '#/components/schemas/applicationId1'
5161
+ from:
5162
+ $ref: '#/components/schemas/from'
5163
+ to:
5164
+ $ref: '#/components/schemas/to'
5165
+ direction:
5166
+ $ref: '#/components/schemas/callDirectionEnum'
5167
+ callId:
5168
+ $ref: '#/components/schemas/callId'
5169
+ callUrl:
5170
+ $ref: '#/components/schemas/callUrl'
5171
+ startTime:
5172
+ $ref: '#/components/schemas/startTime'
5173
+ answerTime:
5174
+ $ref: '#/components/schemas/answerTime'
5175
+ tag:
5176
+ $ref: '#/components/schemas/tag1'
5177
+ referCallStatus:
5178
+ $ref: '#/components/schemas/referCallStatusEnum'
5179
+ referSipResponseCode:
5180
+ $ref: '#/components/schemas/referSipResponseCode'
5181
+ notifySipResponseCode:
5182
+ $ref: '#/components/schemas/notifySipResponseCode'
5137
5183
  transcriptionAvailableCallback:
5138
5184
  type: object
5139
5185
  description: >-
@@ -5326,8 +5372,8 @@ components:
5326
5372
  conferenceRedirect, conferenceMemberJoin, conferenceMemberExit,
5327
5373
  conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf,
5328
5374
  gather, initiate, machineDetectionComplete, recordingComplete,
5329
- recordingAvailable, redirect, transcriptionAvailable, transferAnswer,
5330
- transferComplete, transferDisconnect.
5375
+ recordingAvailable, redirect, referComplete, transcriptionAvailable,
5376
+ transferAnswer, transferComplete, transferDisconnect.
5331
5377
  example: bridgeComplete
5332
5378
  eventTime:
5333
5379
  type: string
@@ -5479,6 +5525,21 @@ components:
5479
5525
  or it was previously cleared, this field will not be present.
5480
5526
  example: exampleTag
5481
5527
  nullable: true
5528
+ referSipResponseCode:
5529
+ type: integer
5530
+ description: >-
5531
+ (optional) The SIP response code returned for the REFER request itself
5532
+ (e.g. 202, 405, 603). Present when a SIP response was received for the
5533
+ REFER.
5534
+ example: 202
5535
+ notifySipResponseCode:
5536
+ type: integer
5537
+ description: >-
5538
+ (optional) The final SIP response code reported via NOTIFY
5539
+ (message/sipfrag body). Present only when the caller's endpoint sent a
5540
+ final NOTIFY (e.g. 200, 404, 486, 503). Not present on NOTIFY timeout or
5541
+ when the REFER was rejected before a subscription was established.
5542
+ example: 200
5482
5543
  cause:
5483
5544
  type: string
5484
5545
  description: >-
@@ -8176,8 +8237,8 @@ components:
8176
8237
  in: path
8177
8238
  name: mediaId
8178
8239
  required: true
8179
- description: Media ID to retrieve.
8180
- example: 14762070468292kw2fuqty55yp2b2/0/bw.png
8240
+ description: The ID of the media file.
8241
+ example: bw.png
8181
8242
  schema:
8182
8243
  type: string
8183
8244
  contentType:
package/configuration.ts CHANGED
@@ -32,6 +32,7 @@ export interface ConfigurationParameters {
32
32
  clientId?: string;
33
33
  clientSecret?: string;
34
34
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
35
+ accessTokenUrl?: string;
35
36
  awsv4?: AWSv4Configuration;
36
37
  basePath?: string;
37
38
  serverIndex?: number;
@@ -67,6 +68,10 @@ export class Configuration {
67
68
  * @param scopes oauth2 scope
68
69
  */
69
70
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
71
+ /**
72
+ * oauth2 token url
73
+ */
74
+ accessTokenUrl?: string;
70
75
  /**
71
76
  * temporary access token storage
72
77
  */
@@ -115,6 +120,7 @@ export class Configuration {
115
120
  this.clientSecret = param.clientSecret;
116
121
  this.tempAccessToken;
117
122
  this.tempAccessTokenExpiration;
123
+ this.accessTokenUrl = param.accessTokenUrl ?? 'https://api.bandwidth.com/api/v1/oauth2/token';
118
124
  this.accessToken = param.accessToken ?? (async (name, scopes) => {
119
125
  const now = Math.floor(Date.now() / 1000);
120
126
  if (this.tempAccessToken && (!this.tempAccessTokenExpiration || this.tempAccessTokenExpiration > now + 60)) {
@@ -125,7 +131,7 @@ export class Configuration {
125
131
  headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
126
132
  auth: { username: this.clientId || '', password: this.clientSecret || '' },
127
133
  data: 'grant_type=client_credentials',
128
- url: 'https://api.bandwidth.com/api/v1/oauth2/token'
134
+ url: this.accessTokenUrl
129
135
  };
130
136
  const response = await globalAxios.request(tokenRequestArgs);
131
137
  this.tempAccessToken = response.data.access_token;
@@ -141,7 +147,7 @@ export class Configuration {
141
147
  ...param.baseOptions,
142
148
  headers: {
143
149
  ...param.baseOptions?.headers,
144
- 'User-Agent': "OpenAPI-Generator/8.1.5/typescript-axios"
150
+ 'User-Agent': "OpenAPI-Generator/8.3.0/typescript-axios"
145
151
  },
146
152
  };
147
153
  this.formDataCtor = param.formDataCtor;