bandwidth-sdk 8.3.0 → 9.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (258) hide show
  1. package/.github/CODEOWNERS +0 -3
  2. package/.github/workflows/deploy.yml +1 -30
  3. package/.github/workflows/test-pr.yml +0 -20
  4. package/.github/workflows/test-smoke.yml +0 -4
  5. package/.openapi-generator/FILES +2 -0
  6. package/README.md +1 -5
  7. package/api/calls-api.ts +0 -20
  8. package/api/conferences-api.ts +0 -36
  9. package/api/endpoints-api.ts +0 -20
  10. package/api/media-api.ts +8 -24
  11. package/api/messages-api.ts +0 -8
  12. package/api/mfaapi.ts +0 -12
  13. package/api/multi-channel-api.ts +0 -4
  14. package/api/phone-number-lookup-api.ts +0 -12
  15. package/api/recordings-api.ts +0 -40
  16. package/api/statistics-api.ts +0 -4
  17. package/api/toll-free-verification-api.ts +12 -48
  18. package/api/transcriptions-api.ts +0 -12
  19. package/bandwidth.yml +341 -122
  20. package/common.ts +2 -5
  21. package/configuration.ts +4 -13
  22. package/coverage/clover.xml +1249 -1293
  23. package/coverage/coverage-final.json +17 -16
  24. package/coverage/lcov-report/index.html +41 -26
  25. package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +6 -66
  26. package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +6 -114
  27. package/coverage/lcov-report/node-sdk/api/endpoints-api.ts.html +6 -66
  28. package/coverage/lcov-report/node-sdk/api/index.html +69 -69
  29. package/coverage/lcov-report/node-sdk/api/media-api.ts.html +14 -62
  30. package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +6 -30
  31. package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +6 -42
  32. package/coverage/lcov-report/node-sdk/api/multi-channel-api.ts.html +6 -18
  33. package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +6 -42
  34. package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +6 -126
  35. package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +6 -18
  36. package/coverage/lcov-report/node-sdk/api/toll-free-verification-api.ts.html +18 -126
  37. package/coverage/lcov-report/node-sdk/api/transcriptions-api.ts.html +6 -42
  38. package/coverage/lcov-report/node-sdk/api.ts.html +1 -1
  39. package/coverage/lcov-report/node-sdk/base.ts.html +1 -1
  40. package/coverage/lcov-report/node-sdk/common.ts.html +13 -22
  41. package/coverage/lcov-report/node-sdk/configuration.ts.html +11 -38
  42. package/coverage/lcov-report/node-sdk/index.html +20 -20
  43. package/coverage/lcov-report/node-sdk/models/business-entity-type-enum.ts.html +2 -2
  44. package/coverage/lcov-report/node-sdk/models/business-registration-type-enum.ts.html +2 -2
  45. package/coverage/lcov-report/node-sdk/models/bxml/Bxml.ts.html +1 -1
  46. package/coverage/lcov-report/node-sdk/models/bxml/NestableVerb.ts.html +1 -1
  47. package/coverage/lcov-report/node-sdk/models/bxml/Response.ts.html +1 -1
  48. package/coverage/lcov-report/node-sdk/models/bxml/Root.ts.html +1 -1
  49. package/coverage/lcov-report/node-sdk/models/bxml/Verb.ts.html +1 -1
  50. package/coverage/lcov-report/node-sdk/models/bxml/index.html +1 -1
  51. package/coverage/lcov-report/node-sdk/models/bxml/index.ts.html +1 -1
  52. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Bridge.ts.html +1 -1
  53. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Conference.ts.html +1 -1
  54. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Connect.ts.html +1 -1
  55. package/coverage/lcov-report/node-sdk/models/bxml/verbs/CustomParam.ts.html +1 -1
  56. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Endpoint.ts.html +1 -1
  57. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Forward.ts.html +1 -1
  58. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Gather.ts.html +1 -1
  59. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Hangup.ts.html +1 -1
  60. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Pause.ts.html +1 -1
  61. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PauseRecording.ts.html +1 -1
  62. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PhoneNumber.ts.html +1 -1
  63. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PlayAudio.ts.html +1 -1
  64. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Record.ts.html +1 -1
  65. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Redirect.ts.html +1 -1
  66. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Refer.ts.html +1 -1
  67. package/coverage/lcov-report/node-sdk/models/bxml/verbs/ResumeRecording.ts.html +1 -1
  68. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Ring.ts.html +1 -1
  69. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SendDtmf.ts.html +1 -1
  70. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SipUri.ts.html +1 -1
  71. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SpeakSentence.ts.html +1 -1
  72. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartGather.ts.html +1 -1
  73. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartRecording.ts.html +1 -1
  74. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartStream.ts.html +1 -1
  75. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartTranscription.ts.html +1 -1
  76. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopGather.ts.html +1 -1
  77. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopRecording.ts.html +1 -1
  78. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopStream.ts.html +1 -1
  79. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopTranscription.ts.html +1 -1
  80. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StreamParam.ts.html +1 -1
  81. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Tag.ts.html +1 -1
  82. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Transfer.ts.html +1 -1
  83. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.html +1 -1
  84. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.ts.html +1 -1
  85. package/coverage/lcov-report/node-sdk/models/call-direction-enum.ts.html +1 -1
  86. package/coverage/lcov-report/node-sdk/models/call-state-enum.ts.html +1 -1
  87. package/coverage/lcov-report/node-sdk/models/call-transcription-detected-language-enum.ts.html +1 -1
  88. package/coverage/lcov-report/node-sdk/models/call-transcription-track-enum.ts.html +1 -1
  89. package/coverage/lcov-report/node-sdk/models/callback-method-enum.ts.html +1 -1
  90. package/coverage/lcov-report/node-sdk/models/card-width-enum.ts.html +1 -1
  91. package/coverage/lcov-report/node-sdk/models/completed-lookup-status-enum.ts.html +1 -1
  92. package/coverage/lcov-report/node-sdk/models/conference-state-enum.ts.html +1 -1
  93. package/coverage/lcov-report/node-sdk/models/deactivation-event-enum.ts.html +1 -1
  94. package/coverage/lcov-report/node-sdk/models/device-status-enum.ts.html +1 -1
  95. package/coverage/lcov-report/node-sdk/models/endpoint-direction-enum.ts.html +1 -1
  96. package/coverage/lcov-report/node-sdk/models/endpoint-event-type-enum.ts.html +1 -1
  97. package/coverage/lcov-report/node-sdk/models/endpoint-status-enum.ts.html +1 -1
  98. package/coverage/lcov-report/node-sdk/models/endpoint-type-enum.ts.html +1 -1
  99. package/coverage/lcov-report/node-sdk/models/file-format-enum.ts.html +1 -1
  100. package/coverage/lcov-report/node-sdk/models/in-progress-lookup-status-enum.ts.html +1 -1
  101. package/coverage/lcov-report/node-sdk/models/inbound-callback-type-enum.ts.html +1 -1
  102. package/coverage/lcov-report/node-sdk/models/index.html +5 -5
  103. package/coverage/lcov-report/node-sdk/models/index.ts.html +7 -4
  104. package/coverage/lcov-report/node-sdk/models/latest-message-delivery-status-enum.ts.html +1 -1
  105. package/coverage/lcov-report/node-sdk/models/line-type-enum.ts.html +1 -1
  106. package/coverage/lcov-report/node-sdk/models/list-message-direction-enum.ts.html +1 -1
  107. package/coverage/lcov-report/node-sdk/models/machine-detection-mode-enum.ts.html +1 -1
  108. package/coverage/lcov-report/node-sdk/models/message-direction-enum.ts.html +1 -1
  109. package/coverage/lcov-report/node-sdk/models/message-status-enum.ts.html +1 -1
  110. package/coverage/lcov-report/node-sdk/models/message-type-enum.ts.html +1 -1
  111. package/coverage/lcov-report/node-sdk/models/multi-channel-message-channel-enum.ts.html +1 -1
  112. package/coverage/lcov-report/node-sdk/models/priority-enum.ts.html +1 -1
  113. package/coverage/lcov-report/node-sdk/models/product-type-enum.ts.html +1 -1
  114. package/coverage/lcov-report/node-sdk/models/rbm-action-type-enum.ts.html +1 -1
  115. package/coverage/lcov-report/node-sdk/models/rbm-media-height-enum.ts.html +1 -1
  116. package/coverage/lcov-report/node-sdk/models/rbm-open-url-enum.ts.html +1 -1
  117. package/coverage/lcov-report/node-sdk/models/rbm-web-view-enum.ts.html +1 -1
  118. package/coverage/lcov-report/node-sdk/models/recording-state-enum.ts.html +1 -1
  119. package/coverage/lcov-report/node-sdk/models/redirect-method-enum.ts.html +1 -1
  120. package/coverage/lcov-report/node-sdk/models/refer-call-status-enum.ts.html +1 -1
  121. package/coverage/lcov-report/node-sdk/models/standalone-card-orientation-enum.ts.html +1 -1
  122. package/coverage/lcov-report/node-sdk/models/status-callback-type-enum.ts.html +6 -3
  123. package/coverage/lcov-report/node-sdk/models/tfv-callback-status-enum.ts.html +1 -1
  124. package/coverage/lcov-report/node-sdk/models/tfv-status-enum.ts.html +1 -1
  125. package/coverage/lcov-report/node-sdk/models/thumbnail-alignment-enum.ts.html +1 -1
  126. package/coverage/lcov-report/node-sdk/models/webhook-subscription-type-enum.ts.html +1 -1
  127. package/coverage/lcov-report/node-sdk/tests/unit/constants.ts.html +103 -0
  128. package/coverage/lcov-report/node-sdk/tests/unit/index.html +116 -0
  129. package/coverage/lcov.info +3073 -3115
  130. package/custom_templates/common.mustache +2 -5
  131. package/custom_templates/configuration.mustache +3 -12
  132. package/dist/api/calls-api.js +0 -15
  133. package/dist/api/conferences-api.js +0 -27
  134. package/dist/api/endpoints-api.js +0 -15
  135. package/dist/api/media-api.d.ts +8 -8
  136. package/dist/api/media-api.js +8 -20
  137. package/dist/api/messages-api.js +0 -6
  138. package/dist/api/mfaapi.js +0 -9
  139. package/dist/api/multi-channel-api.js +0 -3
  140. package/dist/api/phone-number-lookup-api.js +0 -9
  141. package/dist/api/recordings-api.js +0 -30
  142. package/dist/api/statistics-api.js +0 -3
  143. package/dist/api/toll-free-verification-api.d.ts +12 -12
  144. package/dist/api/toll-free-verification-api.js +12 -39
  145. package/dist/api/transcriptions-api.js +0 -9
  146. package/dist/common.js +2 -5
  147. package/dist/configuration.d.ts +0 -10
  148. package/dist/configuration.js +4 -3
  149. package/dist/models/business-entity-type-enum.d.ts +1 -1
  150. package/dist/models/business-entity-type-enum.js +1 -1
  151. package/dist/models/business-registration-type-enum.d.ts +1 -1
  152. package/dist/models/business-registration-type-enum.js +1 -1
  153. package/dist/models/callback.d.ts +2 -0
  154. package/dist/models/disconnect-callback.d.ts +11 -1
  155. package/dist/models/inbound-callback-message.d.ts +2 -0
  156. package/dist/models/index.d.ts +1 -0
  157. package/dist/models/index.js +1 -0
  158. package/dist/models/initiate-callback.d.ts +1 -1
  159. package/dist/models/list-message-item.d.ts +1 -1
  160. package/dist/models/multi-channel-action-calendar-event.d.ts +1 -1
  161. package/dist/models/multi-channel-action.d.ts +1 -1
  162. package/dist/models/rbm-action-base.d.ts +1 -1
  163. package/dist/models/rbm-action-dial.d.ts +1 -1
  164. package/dist/models/rbm-action-open-url.d.ts +1 -1
  165. package/dist/models/rbm-action-view-location.d.ts +1 -1
  166. package/dist/models/rbm-session.d.ts +36 -0
  167. package/dist/models/rbm-session.js +15 -0
  168. package/dist/models/rbm-suggestion-response.d.ts +2 -2
  169. package/dist/models/status-callback-message.d.ts +2 -0
  170. package/dist/models/status-callback-type-enum.d.ts +2 -1
  171. package/dist/models/status-callback-type-enum.js +2 -1
  172. package/dist/models/tfv-submission-info.d.ts +2 -2
  173. package/dist/models/transfer-disconnect-callback.d.ts +14 -0
  174. package/dist/models/verification-request.d.ts +2 -2
  175. package/dist/models/verification-update-request.d.ts +3 -3
  176. package/docs/BusinessEntityTypeEnum.md +1 -1
  177. package/docs/BusinessRegistrationTypeEnum.md +1 -1
  178. package/docs/CallsApi.md +5 -5
  179. package/docs/ConferencesApi.md +9 -9
  180. package/docs/DisconnectCallback.md +5 -1
  181. package/docs/EndpointsApi.md +5 -5
  182. package/docs/InboundCallbackMessage.md +2 -0
  183. package/docs/InitiateCallback.md +1 -1
  184. package/docs/MFAApi.md +3 -3
  185. package/docs/MediaApi.md +7 -7
  186. package/docs/MessagesApi.md +2 -2
  187. package/docs/MultiChannelAction.md +1 -1
  188. package/docs/MultiChannelActionCalendarEvent.md +1 -1
  189. package/docs/MultiChannelApi.md +1 -1
  190. package/docs/PhoneNumberLookupApi.md +3 -3
  191. package/docs/RbmActionBase.md +1 -1
  192. package/docs/RbmActionDial.md +1 -1
  193. package/docs/RbmActionOpenUrl.md +1 -1
  194. package/docs/RbmActionViewLocation.md +1 -1
  195. package/docs/RbmSession.md +29 -0
  196. package/docs/RbmSuggestionResponse.md +2 -2
  197. package/docs/RecordingsApi.md +10 -10
  198. package/docs/StatisticsApi.md +1 -1
  199. package/docs/StatusCallbackMessage.md +2 -0
  200. package/docs/StatusCallbackTypeEnum.md +3 -1
  201. package/docs/TfvSubmissionInfo.md +2 -2
  202. package/docs/TollFreeVerificationApi.md +15 -12
  203. package/docs/TranscriptionsApi.md +3 -3
  204. package/docs/TransferDisconnectCallback.md +6 -0
  205. package/docs/VerificationRequest.md +2 -2
  206. package/docs/VerificationUpdateRequest.md +3 -3
  207. package/generate.sh +6 -0
  208. package/jest.config.js +0 -6
  209. package/models/business-entity-type-enum.ts +1 -1
  210. package/models/business-registration-type-enum.ts +1 -1
  211. package/models/callback.ts +1 -1
  212. package/models/disconnect-callback.ts +9 -1
  213. package/models/inbound-callback-message.ts +4 -0
  214. package/models/index.ts +1 -0
  215. package/models/initiate-callback.ts +1 -1
  216. package/models/list-message-item.ts +1 -1
  217. package/models/multi-channel-action-calendar-event.ts +1 -1
  218. package/models/multi-channel-action.ts +1 -1
  219. package/models/rbm-action-base.ts +1 -1
  220. package/models/rbm-action-dial.ts +1 -1
  221. package/models/rbm-action-open-url.ts +1 -1
  222. package/models/rbm-action-view-location.ts +1 -1
  223. package/models/rbm-session.ts +42 -0
  224. package/models/rbm-suggestion-response.ts +2 -2
  225. package/models/status-callback-message.ts +4 -0
  226. package/models/status-callback-type-enum.ts +2 -1
  227. package/models/tfv-submission-info.ts +2 -2
  228. package/models/transfer-disconnect-callback.ts +12 -0
  229. package/models/verification-request.ts +2 -2
  230. package/models/verification-update-request.ts +3 -3
  231. package/package.json +1 -1
  232. package/tests/globals.d.ts +0 -6
  233. package/tests/smoke/calls-api.test.ts +1 -23
  234. package/tests/smoke/conferences-api.test.ts +2 -2
  235. package/tests/smoke/media-api.test.ts +4 -1
  236. package/tests/smoke/messages-api.test.ts +4 -19
  237. package/tests/smoke/mfaapi.test.ts +4 -20
  238. package/tests/smoke/multi-channel-api.test.ts +2 -2
  239. package/tests/smoke/statistics-api.test.ts +0 -24
  240. package/tests/unit/api/calls-api.test.ts +2 -1
  241. package/tests/unit/api/conferences-api.test.ts +3 -2
  242. package/tests/unit/api/media-api.test.ts +1 -0
  243. package/tests/unit/api/messages-api.test.ts +1 -0
  244. package/tests/unit/api/mfaapi.test.ts +1 -0
  245. package/tests/unit/api/multi-channel-api.test.ts +1 -0
  246. package/tests/unit/api/phone-number-lookup-api.test.ts +1 -0
  247. package/tests/unit/api/recordings-api.test.ts +2 -1
  248. package/tests/unit/api/statistics-api.test.ts +1 -0
  249. package/tests/unit/api/toll-free-verification-api.test.ts +1 -0
  250. package/tests/unit/api/transcriptions-api.test.ts +1 -0
  251. package/tests/unit/configuration.test.ts +19 -0
  252. package/tests/unit/constants.ts +6 -0
  253. package/tests/unit/models/disconnect-callback.test.ts +4 -0
  254. package/tests/unit/models/inbound-callback-message.test.ts +3 -0
  255. package/tests/unit/models/rbm-session.test.ts +19 -0
  256. package/tests/unit/models/status-callback-message.test.ts +3 -0
  257. package/tests/unit/models/status-callback-type-enum.test.ts +3 -1
  258. package/tests/unit/models/transfer-disconnect-callback.test.ts +6 -0
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
8
  **type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | [default to undefined]
9
9
  **text** | **string** | Displayed text for user to click | [default to undefined]
10
- **postbackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [default to undefined]
10
+ **postbackData** | **string** | Payload the customer receives when the reply is clicked. | [default to undefined]
11
11
  **url** | **string** | The URL to open in browser. Must use http:// or https:// scheme. | [default to undefined]
12
12
  **application** | [**RbmOpenUrlEnum**](RbmOpenUrlEnum.md) | | [optional] [default to undefined]
13
13
  **webviewViewMode** | [**RbmWebViewEnum**](RbmWebViewEnum.md) | | [optional] [default to undefined]
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
8
  **type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | [default to undefined]
9
9
  **text** | **string** | Displayed text for user to click | [default to undefined]
10
- **postbackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [default to undefined]
10
+ **postbackData** | **string** | Payload the customer receives when the reply is clicked. | [default to undefined]
11
11
  **latitude** | **number** | The latitude of the location. Must be in range [-90.000000, 90.000000]. | [default to undefined]
12
12
  **longitude** | **number** | The longitude of the location. Must be in range [-180.000000, 180.000000]. | [default to undefined]
13
13
  **label** | **string** | The label of the location. | [optional] [default to undefined]
@@ -0,0 +1,29 @@
1
+ # RbmSession
2
+
3
+ RCS interactive session information for the message. An interactive session is a 24-hour window covering all Rich and Rich Media messages exchanged between an RCS agent and a specific end user mobile number. It is triggered when at least 4 messages are exchanged within 24 hours, at least 2 of them mobile-originated and at least 1 mobile-terminated. Only present on `message-delivered`, `message-received` and `session-started` callbacks for RBM messages of US agents with the Conversational billing category. Omitted for all other messages.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **canInitiate** | **boolean** | Whether the message can start an interactive session. `false` if the message is already part of an active session, or if the agent is not eligible for interactive session billing. | [default to undefined]
10
+ **id** | **string** | The unique identifier of the interactive session the message is part of. This is not a message ID. Omitted if the message is not part of a session. | [optional] [default to undefined]
11
+ **type** | **string** | The type of the interactive session. Only present on `session-started` callbacks. | [optional] [default to undefined]
12
+ **startTime** | **string** | The time the 24-hour session window opened. Only present on `session-started` callbacks. | [optional] [default to undefined]
13
+ **endTime** | **string** | The time the 24-hour session window closes. Only present on `session-started` callbacks. | [optional] [default to undefined]
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import { RbmSession } from 'bandwidth-sdk';
19
+
20
+ const instance: RbmSession = {
21
+ canInitiate,
22
+ id,
23
+ type,
24
+ startTime,
25
+ endTime,
26
+ };
27
+ ```
28
+
29
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -5,8 +5,8 @@
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **text** | **string** | The text associated with the suggestion response. | [optional] [default to undefined]
9
- **postbackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [optional] [default to undefined]
8
+ **text** | **string** | The text of the suggestion the user tapped. | [optional] [default to undefined]
9
+ **postbackData** | **string** | Payload the customer receives when the reply is clicked. | [optional] [default to undefined]
10
10
  **pairedMessageId** | **string** | Corresponding parent message ID (MT). | [optional] [default to undefined]
11
11
 
12
12
  ## Example
@@ -57,7 +57,7 @@ void (empty response body)
57
57
 
58
58
  ### Authorization
59
59
 
60
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
60
+ [OAuth2](../README.md#OAuth2)
61
61
 
62
62
  ### HTTP request headers
63
63
 
@@ -122,7 +122,7 @@ void (empty response body)
122
122
 
123
123
  ### Authorization
124
124
 
125
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
125
+ [OAuth2](../README.md#OAuth2)
126
126
 
127
127
  ### HTTP request headers
128
128
 
@@ -187,7 +187,7 @@ void (empty response body)
187
187
 
188
188
  ### Authorization
189
189
 
190
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
190
+ [OAuth2](../README.md#OAuth2)
191
191
 
192
192
  ### HTTP request headers
193
193
 
@@ -252,7 +252,7 @@ const { status, data } = await apiInstance.downloadCallRecording(
252
252
 
253
253
  ### Authorization
254
254
 
255
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
255
+ [OAuth2](../README.md#OAuth2)
256
256
 
257
257
  ### HTTP request headers
258
258
 
@@ -317,7 +317,7 @@ const { status, data } = await apiInstance.getCallRecording(
317
317
 
318
318
  ### Authorization
319
319
 
320
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
320
+ [OAuth2](../README.md#OAuth2)
321
321
 
322
322
  ### HTTP request headers
323
323
 
@@ -382,7 +382,7 @@ const { status, data } = await apiInstance.getRecordingTranscription(
382
382
 
383
383
  ### Authorization
384
384
 
385
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
385
+ [OAuth2](../README.md#OAuth2)
386
386
 
387
387
  ### HTTP request headers
388
388
 
@@ -453,7 +453,7 @@ const { status, data } = await apiInstance.listAccountCallRecordings(
453
453
 
454
454
  ### Authorization
455
455
 
456
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
456
+ [OAuth2](../README.md#OAuth2)
457
457
 
458
458
  ### HTTP request headers
459
459
 
@@ -515,7 +515,7 @@ const { status, data } = await apiInstance.listCallRecordings(
515
515
 
516
516
  ### Authorization
517
517
 
518
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
518
+ [OAuth2](../README.md#OAuth2)
519
519
 
520
520
  ### HTTP request headers
521
521
 
@@ -584,7 +584,7 @@ void (empty response body)
584
584
 
585
585
  ### Authorization
586
586
 
587
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
587
+ [OAuth2](../README.md#OAuth2)
588
588
 
589
589
  ### HTTP request headers
590
590
 
@@ -650,7 +650,7 @@ void (empty response body)
650
650
 
651
651
  ### Authorization
652
652
 
653
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
653
+ [OAuth2](../README.md#OAuth2)
654
654
 
655
655
  ### HTTP request headers
656
656
 
@@ -42,7 +42,7 @@ const { status, data } = await apiInstance.getStatistics(
42
42
 
43
43
  ### Authorization
44
44
 
45
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
45
+ [OAuth2](../README.md#OAuth2)
46
46
 
47
47
  ### HTTP request headers
48
48
 
@@ -19,6 +19,7 @@ Name | Type | Description | Notes
19
19
  **media** | **Array<string>** | Optional media, not applicable for sms | [optional] [default to undefined]
20
20
  **priority** | [**PriorityEnum**](PriorityEnum.md) | | [optional] [default to undefined]
21
21
  **channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [optional] [default to undefined]
22
+ **session** | [**RbmSession**](RbmSession.md) | | [optional] [default to undefined]
22
23
 
23
24
  ## Example
24
25
 
@@ -39,6 +40,7 @@ const instance: StatusCallbackMessage = {
39
40
  media,
40
41
  priority,
41
42
  channel,
43
+ session,
42
44
  };
43
45
  ```
44
46
 
@@ -1,6 +1,6 @@
1
1
  # StatusCallbackTypeEnum
2
2
 
3
- The possible status callbacks when sending an MT SMS or MMS or RBM message: - `message-sending` indicates that Bandwidth is sending the message to the upstream provider. - `message-sent` indicates that the message has left the Bandwidth network and is in transit to the provider. - `message-delivered` indicates that the message was successfully delivered to handset. - `message-failed` indicates that the message could not be sent to the intended recipient. - `message-read` indicates that the RBM message was read by the recipient.
3
+ The possible status callbacks when sending an MT SMS or MMS or RBM message: - `message-sending` indicates that Bandwidth is sending the message to the upstream provider. - `message-sent` indicates that the message has left the Bandwidth network and is in transit to the provider. - `message-delivered` indicates that the message was successfully delivered to handset. - `message-failed` indicates that the message could not be sent to the intended recipient. - `message-read` indicates that the RBM message was read by the recipient. - `session-started` indicates that a previously exchanged RBM message is now part of an RCS interactive session and is no longer billed individually.
4
4
 
5
5
  ## Enum
6
6
 
@@ -14,4 +14,6 @@ The possible status callbacks when sending an MT SMS or MMS or RBM message: - `m
14
14
 
15
15
  * `MessageRead` (value: `'message-read'`)
16
16
 
17
+ * `SessionStarted` (value: `'session-started'`)
18
+
17
19
  [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -17,9 +17,9 @@ Name | Type | Description | Notes
17
17
  **privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. | [optional] [default to undefined]
18
18
  **termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. | [optional] [default to undefined]
19
19
  **businessDba** | **string** | The company \'Doing Business As\'. | [optional] [default to undefined]
20
- **businessRegistrationNumber** | **string** | Government-issued business identifying number. **Note: As of October 19th, 2026 this field will be required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** | [optional] [default to undefined]
20
+ **businessRegistrationNumber** | **string** | Government-issued business identifying number. **As of October 19th, 2026 this field is required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** | [optional] [default to undefined]
21
21
  **businessRegistrationType** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] [default to undefined]
22
- **businessRegistrationIssuingCountry** | **string** | The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | | [optional] [default to undefined]
22
+ **businessRegistrationIssuingCountry** | **string** | The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **As of October 19th, 2026 this field is required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | | [optional] [default to undefined]
23
23
  **businessEntityType** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] [default to undefined]
24
24
 
25
25
  ## Example
@@ -54,7 +54,7 @@ const { status, data } = await apiInstance.createWebhookSubscription(
54
54
 
55
55
  ### Authorization
56
56
 
57
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
57
+ [OAuth2](../README.md#OAuth2)
58
58
 
59
59
  ### HTTP request headers
60
60
 
@@ -80,7 +80,7 @@ const { status, data } = await apiInstance.createWebhookSubscription(
80
80
  # **deleteVerificationRequest**
81
81
  > deleteVerificationRequest()
82
82
 
83
- Delete a toll-free verification submission for a toll-free number.
83
+ Delete a toll-free verification submission for a toll-free number. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, it will be cancelled and the submission will then be deleted asynchronously.
84
84
 
85
85
  ### Example
86
86
 
@@ -116,7 +116,7 @@ void (empty response body)
116
116
 
117
117
  ### Authorization
118
118
 
119
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
119
+ [OAuth2](../README.md#OAuth2)
120
120
 
121
121
  ### HTTP request headers
122
122
 
@@ -178,7 +178,7 @@ void (empty response body)
178
178
 
179
179
  ### Authorization
180
180
 
181
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
181
+ [OAuth2](../README.md#OAuth2)
182
182
 
183
183
  ### HTTP request headers
184
184
 
@@ -240,7 +240,7 @@ const { status, data } = await apiInstance.getTollFreeVerificationStatus(
240
240
 
241
241
  ### Authorization
242
242
 
243
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
243
+ [OAuth2](../README.md#OAuth2)
244
244
 
245
245
  ### HTTP request headers
246
246
 
@@ -292,7 +292,7 @@ This endpoint does not have any parameters.
292
292
 
293
293
  ### Authorization
294
294
 
295
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
295
+ [OAuth2](../README.md#OAuth2)
296
296
 
297
297
  ### HTTP request headers
298
298
 
@@ -351,7 +351,7 @@ const { status, data } = await apiInstance.listWebhookSubscriptions(
351
351
 
352
352
  ### Authorization
353
353
 
354
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
354
+ [OAuth2](../README.md#OAuth2)
355
355
 
356
356
  ### HTTP request headers
357
357
 
@@ -376,7 +376,7 @@ const { status, data } = await apiInstance.listWebhookSubscriptions(
376
376
  # **requestTollFreeVerification**
377
377
  > requestTollFreeVerification(verificationRequest)
378
378
 
379
- Submit a request for verification of a toll-free phone number.
379
+ Submit a request for verification of a toll-free phone number. **Upcoming change (effective January 2027):** If any phone number in the request already has a verification in progress, the request will be rejected with a `409 Conflict`. This check is all-or-nothing: if a single phone number conflicts, the entire request is rejected and **none** of the phone numbers in the request are submitted. Today, these requests are accepted with a `202`.
380
380
 
381
381
  ### Example
382
382
 
@@ -413,7 +413,7 @@ void (empty response body)
413
413
 
414
414
  ### Authorization
415
415
 
416
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
416
+ [OAuth2](../README.md#OAuth2)
417
417
 
418
418
  ### HTTP request headers
419
419
 
@@ -429,6 +429,7 @@ void (empty response body)
429
429
  |**401** | Unauthorized | - |
430
430
  |**403** | Forbidden | - |
431
431
  |**405** | Method Not Allowed | - |
432
+ |**409** | Conflict. A toll-free verification for the phone number is already in progress. | - |
432
433
  |**429** | Too Many Requests | - |
433
434
  |**500** | Internal Server Error | - |
434
435
  |**503** | Service Unavailable | - |
@@ -438,7 +439,7 @@ void (empty response body)
438
439
  # **updateTollFreeVerificationRequest**
439
440
  > updateTollFreeVerificationRequest(tfvSubmissionWrapper)
440
441
 
441
- Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true).
442
+ Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). Returns a `404` if no verification request exists for the phone number, and a `400` if the existing request is not eligible for resubmission. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, the update will be rejected with a `409 Conflict`.
442
443
 
443
444
  ### Example
444
445
 
@@ -478,7 +479,7 @@ void (empty response body)
478
479
 
479
480
  ### Authorization
480
481
 
481
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
482
+ [OAuth2](../README.md#OAuth2)
482
483
 
483
484
  ### HTTP request headers
484
485
 
@@ -493,7 +494,9 @@ void (empty response body)
493
494
  |**400** | Bad Request | - |
494
495
  |**401** | Unauthorized | - |
495
496
  |**403** | Forbidden | - |
497
+ |**404** | Cannot find the requested resource. | - |
496
498
  |**405** | Method Not Allowed | - |
499
+ |**409** | Conflict. A toll-free verification for the phone number is already in progress. | - |
497
500
  |**429** | Too Many Requests | - |
498
501
  |**500** | Internal Server Error | - |
499
502
  |**503** | Service Unavailable | - |
@@ -543,7 +546,7 @@ const { status, data } = await apiInstance.updateWebhookSubscription(
543
546
 
544
547
  ### Authorization
545
548
 
546
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
549
+ [OAuth2](../README.md#OAuth2)
547
550
 
548
551
  ### HTTP request headers
549
552
 
@@ -50,7 +50,7 @@ void (empty response body)
50
50
 
51
51
  ### Authorization
52
52
 
53
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
53
+ [OAuth2](../README.md#OAuth2)
54
54
 
55
55
  ### HTTP request headers
56
56
 
@@ -115,7 +115,7 @@ const { status, data } = await apiInstance.getRealTimeTranscription(
115
115
 
116
116
  ### Authorization
117
117
 
118
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
118
+ [OAuth2](../README.md#OAuth2)
119
119
 
120
120
  ### HTTP request headers
121
121
 
@@ -177,7 +177,7 @@ const { status, data } = await apiInstance.listRealTimeTranscriptions(
177
177
 
178
178
  ### Authorization
179
179
 
180
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
180
+ [OAuth2](../README.md#OAuth2)
181
181
 
182
182
  ### HTTP request headers
183
183
 
@@ -26,6 +26,9 @@ Name | Type | Description | Notes
26
26
  **cause** | **string** | Reason the call failed - hangup, busy, timeout, cancel, rejected, callback-error, invalid-bxml, application-error, account-limit, node-capacity-exceeded, error, or unknown. | [optional] [default to undefined]
27
27
  **errorMessage** | **string** | Text explaining the reason that caused the call to fail in case of errors. | [optional] [default to undefined]
28
28
  **errorId** | **string** | Bandwidth\'s internal id that references the error event. | [optional] [default to undefined]
29
+ **sipResponseCode** | **number** | (optional) The SIP status code of the final response that rejected an outbound call\'s (or transferred leg\'s) INVITE (e.g. 486 for busy, 603 for decline). Present only when the call was rejected with a SIP response. | [optional] [default to undefined]
30
+ **sipStatusLine** | **string** | (optional) The full SIP status line, exactly as received, of the final response that rejected an outbound call\'s INVITE. The reason phrase can help distinguish outcomes that share a status code, such as `603 Network Blocked` and `603 Decline`. Present only when an outbound call was rejected with a SIP response. | [optional] [default to undefined]
31
+ **sipHeaders** | **{ [key: string]: string; }** | (optional) Map of SIP headers, with lowercase keys (SIP headers are case-insensitive). On the Initiate callback, contains the customer-supplied X-* headers from the original INVITE; present only for inbound SIP URI calls with custom headers. On the Disconnect and Transfer Disconnect callbacks, contains a single `reason` key holding the raw, unmodified `Reason` header value from the final SIP response that rejected an outbound call (or transferred leg); present only when that response included a `Reason` header (for example, `v=analytics1` call-analytics block information from a terminating carrier). If the response carries more than one `Reason` header, all values are returned in the order received, separated by `, `. Note - on the Initiate callback, keys preserve the original SIP header name in lowercase rather than Bandwidth\'s usual camelCase JSON convention, since these are passthrough values from the caller\'s SIP INVITE, not Bandwidth-defined fields. If the same header name is sent more than once in the INVITE, only the last value is kept. The example shown is for the Initiate callback; on the Disconnect and Transfer Disconnect callbacks the only key is `reason`. | [optional] [default to undefined]
29
32
 
30
33
  ## Example
31
34
 
@@ -53,6 +56,9 @@ const instance: TransferDisconnectCallback = {
53
56
  cause,
54
57
  errorMessage,
55
58
  errorId,
59
+ sipResponseCode,
60
+ sipStatusLine,
61
+ sipHeaders,
56
62
  };
57
63
  ```
58
64
 
@@ -18,9 +18,9 @@ Name | Type | Description | Notes
18
18
  **privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. | [optional] [default to undefined]
19
19
  **termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. | [optional] [default to undefined]
20
20
  **businessDba** | **string** | The company \'Doing Business As\'. | [optional] [default to undefined]
21
- **businessRegistrationNumber** | **string** | Government-issued business identifying number. **Note: As of October 19th, 2026 this field will be required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** | [optional] [default to undefined]
21
+ **businessRegistrationNumber** | **string** | Government-issued business identifying number. **As of October 19th, 2026 this field is required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** | [optional] [default to undefined]
22
22
  **businessRegistrationType** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] [default to undefined]
23
- **businessRegistrationIssuingCountry** | **string** | The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | | [optional] [default to undefined]
23
+ **businessRegistrationIssuingCountry** | **string** | The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **As of October 19th, 2026 this field is required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | | [optional] [default to undefined]
24
24
  **businessEntityType** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [default to undefined]
25
25
  **helpMessageResponse** | **string** | A message that gets sent to users requesting help. | [optional] [default to undefined]
26
26
  **ageGatedContent** | **boolean** | Indicates whether the content is age-gated. | [optional] [default to undefined]
@@ -17,10 +17,10 @@ Name | Type | Description | Notes
17
17
  **privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. | [optional] [default to undefined]
18
18
  **termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. | [optional] [default to undefined]
19
19
  **businessDba** | **string** | The company \'Doing Business As\'. | [optional] [default to undefined]
20
- **businessRegistrationNumber** | **string** | Government-issued business identifying number. **Note: As of October 19th, 2026 this field will be required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** | [optional] [default to undefined]
20
+ **businessRegistrationNumber** | **string** | Government-issued business identifying number. **As of October 19th, 2026 this field is required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** | [optional] [default to undefined]
21
21
  **businessRegistrationType** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] [default to undefined]
22
- **businessEntityType** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] [default to undefined]
23
- **businessRegistrationIssuingCountry** | **string** | The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | | [optional] [default to undefined]
22
+ **businessEntityType** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [default to undefined]
23
+ **businessRegistrationIssuingCountry** | **string** | The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **As of October 19th, 2026 this field is required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | | [optional] [default to undefined]
24
24
  **helpMessageResponse** | **string** | A message that gets sent to users requesting help. | [optional] [default to undefined]
25
25
  **ageGatedContent** | **boolean** | Indicates whether the content is age-gated. | [optional] [default to undefined]
26
26
  **cvToken** | **string** | The token provided by Campaign Verify to validate your political use case. Only required for 527 political organizations. If you are not a 527 political organization, this field should be omitted. Supplying an empty string will likely result in rejection. | [optional] [default to undefined]
package/generate.sh ADDED
@@ -0,0 +1,6 @@
1
+ #!/bin/bash
2
+ set -euo pipefail
3
+ cd "$(dirname "${BASH_SOURCE[0]}")"
4
+
5
+ npx --yes @openapitools/openapi-generator-cli generate \
6
+ -i bandwidth.yml -g typescript-axios -c openapi-config.yml -o . "$@"
package/jest.config.js CHANGED
@@ -7,8 +7,6 @@ module.exports = {
7
7
  '^.+\\.tsx?$': ['ts-jest', { tsconfig: 'tests/tsconfig.json' }]
8
8
  },
9
9
  globals: {
10
- 'BW_USERNAME': process.env.BW_USERNAME,
11
- 'BW_PASSWORD': process.env.BW_PASSWORD,
12
10
  'BW_CLIENT_ID': process.env.BW_CLIENT_ID,
13
11
  'BW_CLIENT_SECRET': process.env.BW_CLIENT_SECRET,
14
12
  'BW_ACCOUNT_ID': process.env.BW_ACCOUNT_ID,
@@ -22,10 +20,6 @@ module.exports = {
22
20
  'MANTECA_IDLE_NUMBER': process.env.MANTECA_IDLE_NUMBER,
23
21
  'MANTECA_ACTIVE_NUMBER': process.env.MANTECA_ACTIVE_NUMBER,
24
22
  'MANTECA_BASE_URL': process.env.MANTECA_BASE_URL,
25
- 'FORBIDDEN_USERNAME': process.env.BW_USERNAME_FORBIDDEN,
26
- 'FORBIDDEN_PASSWORD': process.env.BW_PASSWORD_FORBIDDEN,
27
- 'UNAUTHORIZED_USERNAME': 'bad_username',
28
- 'UNAUTHORIZED_PASSWORD': 'bad_password',
29
23
  'MAX_RETRIES': 40,
30
24
  'SLEEP_TIME_S': 3
31
25
  }
@@ -15,7 +15,7 @@
15
15
 
16
16
 
17
17
  /**
18
- * The type of registered business. **Note: As of October 19th, 2026 submissions using a value other than `SOLE_PROPRIETOR` must provide a value for `businessRegistrationNumber`, `businessRegistrationType`, and `businessRegistrationIssuingCountry`. Submissions using `SOLE_PROPRIETOR` must _omit_ `businessRegistrationNumber`, `businessRegistrationType`, and `businessRegistrationIssuingCountry`. Failure to adhere to these constraints will result in a 400 Bad Request rejection.**
18
+ * The type of registered business. **As of October 19th, 2026 submissions using a value other than `SOLE_PROPRIETOR` must provide a value for `businessRegistrationNumber`, `businessRegistrationType`, and `businessRegistrationIssuingCountry`. Submissions using `SOLE_PROPRIETOR` must _omit_ `businessRegistrationNumber`, `businessRegistrationType`, and `businessRegistrationIssuingCountry`. Failure to adhere to these constraints will result in a 400 Bad Request rejection.**
19
19
  */
20
20
 
21
21
  export const BusinessEntityTypeEnum = {
@@ -15,7 +15,7 @@
15
15
 
16
16
 
17
17
  /**
18
- * The type of business registration number. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.**
18
+ * The type of business registration number. **As of October 19th, 2026 this field is required when `businessRegistrationNumber` is provided.**
19
19
  */
20
20
 
21
21
  export const BusinessRegistrationTypeEnum = {
@@ -30,6 +30,6 @@ import type { StatusCallback } from './status-callback';
30
30
  * @type Callback
31
31
  * Callbacks are divided into two types based on direction of the related message: - `statusCallback` indicates status of an outbound MT SMS, MMS, or RBM message. - `inboundCallback` indicates an inbound MO message or a multichannel message client\'s response to a suggestion or location request.
32
32
  */
33
- export type Callback = { type: 'message-delivered' } & StatusCallback | { type: 'message-failed' } & StatusCallback | { type: 'message-read' } & StatusCallback | { type: 'message-received' } & InboundCallback | { type: 'message-sending' } & StatusCallback | { type: 'message-sent' } & StatusCallback | { type: 'requested-location-response' } & InboundCallback | { type: 'suggestion-response' } & InboundCallback;
33
+ export type Callback = { type: 'message-delivered' } & StatusCallback | { type: 'message-failed' } & StatusCallback | { type: 'message-read' } & StatusCallback | { type: 'message-received' } & InboundCallback | { type: 'message-sending' } & StatusCallback | { type: 'message-sent' } & StatusCallback | { type: 'requested-location-response' } & InboundCallback | { type: 'session-started' } & StatusCallback | { type: 'suggestion-response' } & InboundCallback;
34
34
 
35
35
 
@@ -91,9 +91,17 @@ export interface DisconnectCallback {
91
91
  */
92
92
  'sipCallId'?: string;
93
93
  /**
94
- * (optional) The SIP status code returned by Bandwidth\'s SBC when it rejected an outbound call\'s INVITE (e.g. 486 for busy, 603 for decline). Present only when an outbound call was rejected by the SBC.
94
+ * (optional) The SIP status code of the final response that rejected an outbound call\'s (or transferred leg\'s) INVITE (e.g. 486 for busy, 603 for decline). Present only when the call was rejected with a SIP response.
95
95
  */
96
96
  'sipResponseCode'?: number;
97
+ /**
98
+ * (optional) The full SIP status line, exactly as received, of the final response that rejected an outbound call\'s INVITE. The reason phrase can help distinguish outcomes that share a status code, such as `603 Network Blocked` and `603 Decline`. Present only when an outbound call was rejected with a SIP response.
99
+ */
100
+ 'sipStatusLine'?: string;
101
+ /**
102
+ * (optional) Map of SIP headers, with lowercase keys (SIP headers are case-insensitive). On the Initiate callback, contains the customer-supplied X-* headers from the original INVITE; present only for inbound SIP URI calls with custom headers. On the Disconnect and Transfer Disconnect callbacks, contains a single `reason` key holding the raw, unmodified `Reason` header value from the final SIP response that rejected an outbound call (or transferred leg); present only when that response included a `Reason` header (for example, `v=analytics1` call-analytics block information from a terminating carrier). If the response carries more than one `Reason` header, all values are returned in the order received, separated by `, `. Note - on the Initiate callback, keys preserve the original SIP header name in lowercase rather than Bandwidth\'s usual camelCase JSON convention, since these are passthrough values from the caller\'s SIP INVITE, not Bandwidth-defined fields. If the same header name is sent more than once in the INVITE, only the last value is kept. The example shown is for the Initiate callback; on the Disconnect and Transfer Disconnect callbacks the only key is `reason`.
103
+ */
104
+ 'sipHeaders'?: { [key: string]: string; };
97
105
  }
98
106
 
99
107
 
@@ -30,6 +30,9 @@ import type { PriorityEnum } from './priority-enum';
30
30
  import type { RbmLocationResponse } from './rbm-location-response';
31
31
  // May contain unused imports in some cases
32
32
  // @ts-ignore
33
+ import type { RbmSession } from './rbm-session';
34
+ // May contain unused imports in some cases
35
+ // @ts-ignore
33
36
  import type { RbmSuggestionResponse } from './rbm-suggestion-response';
34
37
  // May contain unused imports in some cases
35
38
  // @ts-ignore
@@ -76,6 +79,7 @@ export interface InboundCallbackMessage {
76
79
  'media'?: Array<string>;
77
80
  'priority'?: PriorityEnum;
78
81
  'channel'?: MultiChannelMessageChannelEnum;
82
+ 'session'?: RbmSession;
79
83
  'content'?: MultiChannelMessageContent;
80
84
  'suggestionResponse'?: RbmSuggestionResponse;
81
85
  'locationResponse'?: RbmLocationResponse;
package/models/index.ts CHANGED
@@ -144,6 +144,7 @@ export * from './rbm-message-content-rich-card';
144
144
  export * from './rbm-message-content-text';
145
145
  export * from './rbm-message-media';
146
146
  export * from './rbm-open-url-enum';
147
+ export * from './rbm-session';
147
148
  export * from './rbm-standalone-card';
148
149
  export * from './rbm-suggestion-response';
149
150
  export * from './rbm-web-view-enum';
@@ -75,7 +75,7 @@ export interface InitiateCallback {
75
75
  */
76
76
  'sipCallId'?: string;
77
77
  /**
78
- * (optional) Map of customer-supplied X-* headers from the original INVITE. Keys are lowercase (SIP headers are case-insensitive). Present only for inbound SIP URI calls with custom headers. Note - keys preserve the original SIP header name in lowercase rather than Bandwidth\'s usual camelCase JSON convention, since these are passthrough values from the caller\'s SIP INVITE, not Bandwidth-defined fields. If the same header name is sent more than once in the INVITE, only the last value is kept.
78
+ * (optional) Map of SIP headers, with lowercase keys (SIP headers are case-insensitive). On the Initiate callback, contains the customer-supplied X-* headers from the original INVITE; present only for inbound SIP URI calls with custom headers. On the Disconnect and Transfer Disconnect callbacks, contains a single `reason` key holding the raw, unmodified `Reason` header value from the final SIP response that rejected an outbound call (or transferred leg); present only when that response included a `Reason` header (for example, `v=analytics1` call-analytics block information from a terminating carrier). If the response carries more than one `Reason` header, all values are returned in the order received, separated by `, `. Note - on the Initiate callback, keys preserve the original SIP header name in lowercase rather than Bandwidth\'s usual camelCase JSON convention, since these are passthrough values from the caller\'s SIP INVITE, not Bandwidth-defined fields. If the same header name is sent more than once in the INVITE, only the last value is kept. The example shown is for the Initiate callback; on the Disconnect and Transfer Disconnect callbacks the only key is `reason`.
79
79
  */
80
80
  'sipHeaders'?: { [key: string]: string; };
81
81
  }
@@ -66,7 +66,7 @@ export interface ListMessageItem {
66
66
  /**
67
67
  * The length of the message content.
68
68
  */
69
- 'messageLength'?: number;
69
+ 'messageLength'?: number | null;
70
70
  /**
71
71
  * The number of attachments the message has.
72
72
  */
@@ -30,7 +30,7 @@ export interface MultiChannelActionCalendarEvent {
30
30
  */
31
31
  'text': string;
32
32
  /**
33
- * Base64 payload the customer receives when the reply is clicked.
33
+ * Payload the customer receives when the reply is clicked.
34
34
  */
35
35
  'postbackData': string;
36
36
  /**
@@ -45,7 +45,7 @@ export interface MultiChannelAction {
45
45
  */
46
46
  'text': string;
47
47
  /**
48
- * Base64 payload the customer receives when the reply is clicked.
48
+ * Payload the customer receives when the reply is clicked.
49
49
  */
50
50
  'postbackData': string;
51
51
  /**
@@ -24,7 +24,7 @@ export interface RbmActionBase {
24
24
  */
25
25
  'text': string;
26
26
  /**
27
- * Base64 payload the customer receives when the reply is clicked.
27
+ * Payload the customer receives when the reply is clicked.
28
28
  */
29
29
  'postbackData': string;
30
30
  }
@@ -30,7 +30,7 @@ export interface RbmActionDial {
30
30
  */
31
31
  'text': string;
32
32
  /**
33
- * Base64 payload the customer receives when the reply is clicked.
33
+ * Payload the customer receives when the reply is clicked.
34
34
  */
35
35
  'postbackData': string;
36
36
  /**
@@ -36,7 +36,7 @@ export interface RbmActionOpenUrl {
36
36
  */
37
37
  'text': string;
38
38
  /**
39
- * Base64 payload the customer receives when the reply is clicked.
39
+ * Payload the customer receives when the reply is clicked.
40
40
  */
41
41
  'postbackData': string;
42
42
  /**
@@ -30,7 +30,7 @@ export interface RbmActionViewLocation {
30
30
  */
31
31
  'text': string;
32
32
  /**
33
- * Base64 payload the customer receives when the reply is clicked.
33
+ * Payload the customer receives when the reply is clicked.
34
34
  */
35
35
  'postbackData': string;
36
36
  /**