bandwidth-sdk 8.3.1 → 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 (237) hide show
  1. package/.github/workflows/deploy.yml +0 -19
  2. package/.github/workflows/test-pr.yml +0 -20
  3. package/.github/workflows/test-smoke.yml +0 -4
  4. package/.openapi-generator/FILES +2 -0
  5. package/README.md +1 -5
  6. package/api/calls-api.ts +0 -20
  7. package/api/conferences-api.ts +0 -36
  8. package/api/endpoints-api.ts +0 -20
  9. package/api/media-api.ts +0 -16
  10. package/api/messages-api.ts +0 -8
  11. package/api/mfaapi.ts +0 -12
  12. package/api/multi-channel-api.ts +0 -4
  13. package/api/phone-number-lookup-api.ts +0 -12
  14. package/api/recordings-api.ts +0 -40
  15. package/api/statistics-api.ts +0 -4
  16. package/api/toll-free-verification-api.ts +0 -36
  17. package/api/transcriptions-api.ts +0 -12
  18. package/bandwidth.yml +285 -109
  19. package/common.ts +2 -5
  20. package/configuration.ts +4 -13
  21. package/coverage/clover.xml +1249 -1293
  22. package/coverage/coverage-final.json +17 -16
  23. package/coverage/lcov-report/index.html +41 -26
  24. package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +6 -66
  25. package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +6 -114
  26. package/coverage/lcov-report/node-sdk/api/endpoints-api.ts.html +6 -66
  27. package/coverage/lcov-report/node-sdk/api/index.html +69 -69
  28. package/coverage/lcov-report/node-sdk/api/media-api.ts.html +6 -54
  29. package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +6 -30
  30. package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +6 -42
  31. package/coverage/lcov-report/node-sdk/api/multi-channel-api.ts.html +6 -18
  32. package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +6 -42
  33. package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +6 -126
  34. package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +6 -18
  35. package/coverage/lcov-report/node-sdk/api/toll-free-verification-api.ts.html +6 -114
  36. package/coverage/lcov-report/node-sdk/api/transcriptions-api.ts.html +6 -42
  37. package/coverage/lcov-report/node-sdk/api.ts.html +1 -1
  38. package/coverage/lcov-report/node-sdk/base.ts.html +1 -1
  39. package/coverage/lcov-report/node-sdk/common.ts.html +13 -22
  40. package/coverage/lcov-report/node-sdk/configuration.ts.html +11 -38
  41. package/coverage/lcov-report/node-sdk/index.html +20 -20
  42. package/coverage/lcov-report/node-sdk/models/business-entity-type-enum.ts.html +1 -1
  43. package/coverage/lcov-report/node-sdk/models/business-registration-type-enum.ts.html +1 -1
  44. package/coverage/lcov-report/node-sdk/models/bxml/Bxml.ts.html +1 -1
  45. package/coverage/lcov-report/node-sdk/models/bxml/NestableVerb.ts.html +1 -1
  46. package/coverage/lcov-report/node-sdk/models/bxml/Response.ts.html +1 -1
  47. package/coverage/lcov-report/node-sdk/models/bxml/Root.ts.html +1 -1
  48. package/coverage/lcov-report/node-sdk/models/bxml/Verb.ts.html +1 -1
  49. package/coverage/lcov-report/node-sdk/models/bxml/index.html +1 -1
  50. package/coverage/lcov-report/node-sdk/models/bxml/index.ts.html +1 -1
  51. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Bridge.ts.html +1 -1
  52. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Conference.ts.html +1 -1
  53. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Connect.ts.html +1 -1
  54. package/coverage/lcov-report/node-sdk/models/bxml/verbs/CustomParam.ts.html +1 -1
  55. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Endpoint.ts.html +1 -1
  56. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Forward.ts.html +1 -1
  57. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Gather.ts.html +1 -1
  58. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Hangup.ts.html +1 -1
  59. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Pause.ts.html +1 -1
  60. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PauseRecording.ts.html +1 -1
  61. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PhoneNumber.ts.html +1 -1
  62. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PlayAudio.ts.html +1 -1
  63. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Record.ts.html +1 -1
  64. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Redirect.ts.html +1 -1
  65. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Refer.ts.html +1 -1
  66. package/coverage/lcov-report/node-sdk/models/bxml/verbs/ResumeRecording.ts.html +1 -1
  67. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Ring.ts.html +1 -1
  68. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SendDtmf.ts.html +1 -1
  69. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SipUri.ts.html +1 -1
  70. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SpeakSentence.ts.html +1 -1
  71. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartGather.ts.html +1 -1
  72. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartRecording.ts.html +1 -1
  73. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartStream.ts.html +1 -1
  74. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartTranscription.ts.html +1 -1
  75. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopGather.ts.html +1 -1
  76. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopRecording.ts.html +1 -1
  77. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopStream.ts.html +1 -1
  78. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopTranscription.ts.html +1 -1
  79. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StreamParam.ts.html +1 -1
  80. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Tag.ts.html +1 -1
  81. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Transfer.ts.html +1 -1
  82. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.html +1 -1
  83. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.ts.html +1 -1
  84. package/coverage/lcov-report/node-sdk/models/call-direction-enum.ts.html +1 -1
  85. package/coverage/lcov-report/node-sdk/models/call-state-enum.ts.html +1 -1
  86. package/coverage/lcov-report/node-sdk/models/call-transcription-detected-language-enum.ts.html +1 -1
  87. package/coverage/lcov-report/node-sdk/models/call-transcription-track-enum.ts.html +1 -1
  88. package/coverage/lcov-report/node-sdk/models/callback-method-enum.ts.html +1 -1
  89. package/coverage/lcov-report/node-sdk/models/card-width-enum.ts.html +1 -1
  90. package/coverage/lcov-report/node-sdk/models/completed-lookup-status-enum.ts.html +1 -1
  91. package/coverage/lcov-report/node-sdk/models/conference-state-enum.ts.html +1 -1
  92. package/coverage/lcov-report/node-sdk/models/deactivation-event-enum.ts.html +1 -1
  93. package/coverage/lcov-report/node-sdk/models/device-status-enum.ts.html +1 -1
  94. package/coverage/lcov-report/node-sdk/models/endpoint-direction-enum.ts.html +1 -1
  95. package/coverage/lcov-report/node-sdk/models/endpoint-event-type-enum.ts.html +1 -1
  96. package/coverage/lcov-report/node-sdk/models/endpoint-status-enum.ts.html +1 -1
  97. package/coverage/lcov-report/node-sdk/models/endpoint-type-enum.ts.html +1 -1
  98. package/coverage/lcov-report/node-sdk/models/file-format-enum.ts.html +1 -1
  99. package/coverage/lcov-report/node-sdk/models/in-progress-lookup-status-enum.ts.html +1 -1
  100. package/coverage/lcov-report/node-sdk/models/inbound-callback-type-enum.ts.html +1 -1
  101. package/coverage/lcov-report/node-sdk/models/index.html +5 -5
  102. package/coverage/lcov-report/node-sdk/models/index.ts.html +7 -4
  103. package/coverage/lcov-report/node-sdk/models/latest-message-delivery-status-enum.ts.html +1 -1
  104. package/coverage/lcov-report/node-sdk/models/line-type-enum.ts.html +1 -1
  105. package/coverage/lcov-report/node-sdk/models/list-message-direction-enum.ts.html +1 -1
  106. package/coverage/lcov-report/node-sdk/models/machine-detection-mode-enum.ts.html +1 -1
  107. package/coverage/lcov-report/node-sdk/models/message-direction-enum.ts.html +1 -1
  108. package/coverage/lcov-report/node-sdk/models/message-status-enum.ts.html +1 -1
  109. package/coverage/lcov-report/node-sdk/models/message-type-enum.ts.html +1 -1
  110. package/coverage/lcov-report/node-sdk/models/multi-channel-message-channel-enum.ts.html +1 -1
  111. package/coverage/lcov-report/node-sdk/models/priority-enum.ts.html +1 -1
  112. package/coverage/lcov-report/node-sdk/models/product-type-enum.ts.html +1 -1
  113. package/coverage/lcov-report/node-sdk/models/rbm-action-type-enum.ts.html +1 -1
  114. package/coverage/lcov-report/node-sdk/models/rbm-media-height-enum.ts.html +1 -1
  115. package/coverage/lcov-report/node-sdk/models/rbm-open-url-enum.ts.html +1 -1
  116. package/coverage/lcov-report/node-sdk/models/rbm-web-view-enum.ts.html +1 -1
  117. package/coverage/lcov-report/node-sdk/models/recording-state-enum.ts.html +1 -1
  118. package/coverage/lcov-report/node-sdk/models/redirect-method-enum.ts.html +1 -1
  119. package/coverage/lcov-report/node-sdk/models/refer-call-status-enum.ts.html +1 -1
  120. package/coverage/lcov-report/node-sdk/models/standalone-card-orientation-enum.ts.html +1 -1
  121. package/coverage/lcov-report/node-sdk/models/status-callback-type-enum.ts.html +6 -3
  122. package/coverage/lcov-report/node-sdk/models/tfv-callback-status-enum.ts.html +1 -1
  123. package/coverage/lcov-report/node-sdk/models/tfv-status-enum.ts.html +1 -1
  124. package/coverage/lcov-report/node-sdk/models/thumbnail-alignment-enum.ts.html +1 -1
  125. package/coverage/lcov-report/node-sdk/models/webhook-subscription-type-enum.ts.html +1 -1
  126. package/coverage/lcov-report/node-sdk/tests/unit/constants.ts.html +103 -0
  127. package/coverage/lcov-report/node-sdk/tests/unit/index.html +116 -0
  128. package/coverage/lcov.info +3073 -3115
  129. package/custom_templates/common.mustache +2 -5
  130. package/custom_templates/configuration.mustache +3 -12
  131. package/dist/api/calls-api.js +0 -15
  132. package/dist/api/conferences-api.js +0 -27
  133. package/dist/api/endpoints-api.js +0 -15
  134. package/dist/api/media-api.js +0 -12
  135. package/dist/api/messages-api.js +0 -6
  136. package/dist/api/mfaapi.js +0 -9
  137. package/dist/api/multi-channel-api.js +0 -3
  138. package/dist/api/phone-number-lookup-api.js +0 -9
  139. package/dist/api/recordings-api.js +0 -30
  140. package/dist/api/statistics-api.js +0 -3
  141. package/dist/api/toll-free-verification-api.js +0 -27
  142. package/dist/api/transcriptions-api.js +0 -9
  143. package/dist/common.js +2 -5
  144. package/dist/configuration.d.ts +0 -10
  145. package/dist/configuration.js +4 -3
  146. package/dist/models/callback.d.ts +2 -0
  147. package/dist/models/disconnect-callback.d.ts +11 -1
  148. package/dist/models/inbound-callback-message.d.ts +2 -0
  149. package/dist/models/index.d.ts +1 -0
  150. package/dist/models/index.js +1 -0
  151. package/dist/models/initiate-callback.d.ts +1 -1
  152. package/dist/models/list-message-item.d.ts +1 -1
  153. package/dist/models/multi-channel-action-calendar-event.d.ts +1 -1
  154. package/dist/models/multi-channel-action.d.ts +1 -1
  155. package/dist/models/rbm-action-base.d.ts +1 -1
  156. package/dist/models/rbm-action-dial.d.ts +1 -1
  157. package/dist/models/rbm-action-open-url.d.ts +1 -1
  158. package/dist/models/rbm-action-view-location.d.ts +1 -1
  159. package/dist/models/rbm-session.d.ts +36 -0
  160. package/dist/models/rbm-session.js +15 -0
  161. package/dist/models/rbm-suggestion-response.d.ts +2 -2
  162. package/dist/models/status-callback-message.d.ts +2 -0
  163. package/dist/models/status-callback-type-enum.d.ts +2 -1
  164. package/dist/models/status-callback-type-enum.js +2 -1
  165. package/dist/models/transfer-disconnect-callback.d.ts +14 -0
  166. package/docs/CallsApi.md +5 -5
  167. package/docs/ConferencesApi.md +9 -9
  168. package/docs/DisconnectCallback.md +5 -1
  169. package/docs/EndpointsApi.md +5 -5
  170. package/docs/InboundCallbackMessage.md +2 -0
  171. package/docs/InitiateCallback.md +1 -1
  172. package/docs/MFAApi.md +3 -3
  173. package/docs/MediaApi.md +4 -4
  174. package/docs/MessagesApi.md +2 -2
  175. package/docs/MultiChannelAction.md +1 -1
  176. package/docs/MultiChannelActionCalendarEvent.md +1 -1
  177. package/docs/MultiChannelApi.md +1 -1
  178. package/docs/PhoneNumberLookupApi.md +3 -3
  179. package/docs/RbmActionBase.md +1 -1
  180. package/docs/RbmActionDial.md +1 -1
  181. package/docs/RbmActionOpenUrl.md +1 -1
  182. package/docs/RbmActionViewLocation.md +1 -1
  183. package/docs/RbmSession.md +29 -0
  184. package/docs/RbmSuggestionResponse.md +2 -2
  185. package/docs/RecordingsApi.md +10 -10
  186. package/docs/StatisticsApi.md +1 -1
  187. package/docs/StatusCallbackMessage.md +2 -0
  188. package/docs/StatusCallbackTypeEnum.md +3 -1
  189. package/docs/TollFreeVerificationApi.md +9 -9
  190. package/docs/TranscriptionsApi.md +3 -3
  191. package/docs/TransferDisconnectCallback.md +6 -0
  192. package/jest.config.js +0 -6
  193. package/models/callback.ts +1 -1
  194. package/models/disconnect-callback.ts +9 -1
  195. package/models/inbound-callback-message.ts +4 -0
  196. package/models/index.ts +1 -0
  197. package/models/initiate-callback.ts +1 -1
  198. package/models/list-message-item.ts +1 -1
  199. package/models/multi-channel-action-calendar-event.ts +1 -1
  200. package/models/multi-channel-action.ts +1 -1
  201. package/models/rbm-action-base.ts +1 -1
  202. package/models/rbm-action-dial.ts +1 -1
  203. package/models/rbm-action-open-url.ts +1 -1
  204. package/models/rbm-action-view-location.ts +1 -1
  205. package/models/rbm-session.ts +42 -0
  206. package/models/rbm-suggestion-response.ts +2 -2
  207. package/models/status-callback-message.ts +4 -0
  208. package/models/status-callback-type-enum.ts +2 -1
  209. package/models/transfer-disconnect-callback.ts +12 -0
  210. package/package.json +1 -1
  211. package/tests/globals.d.ts +0 -6
  212. package/tests/smoke/calls-api.test.ts +1 -23
  213. package/tests/smoke/conferences-api.test.ts +2 -2
  214. package/tests/smoke/media-api.test.ts +4 -1
  215. package/tests/smoke/messages-api.test.ts +4 -19
  216. package/tests/smoke/mfaapi.test.ts +4 -20
  217. package/tests/smoke/multi-channel-api.test.ts +2 -2
  218. package/tests/smoke/statistics-api.test.ts +0 -24
  219. package/tests/unit/api/calls-api.test.ts +2 -1
  220. package/tests/unit/api/conferences-api.test.ts +3 -2
  221. package/tests/unit/api/media-api.test.ts +1 -0
  222. package/tests/unit/api/messages-api.test.ts +1 -0
  223. package/tests/unit/api/mfaapi.test.ts +1 -0
  224. package/tests/unit/api/multi-channel-api.test.ts +1 -0
  225. package/tests/unit/api/phone-number-lookup-api.test.ts +1 -0
  226. package/tests/unit/api/recordings-api.test.ts +2 -1
  227. package/tests/unit/api/statistics-api.test.ts +1 -0
  228. package/tests/unit/api/toll-free-verification-api.test.ts +1 -0
  229. package/tests/unit/api/transcriptions-api.test.ts +1 -0
  230. package/tests/unit/configuration.test.ts +19 -0
  231. package/tests/unit/constants.ts +6 -0
  232. package/tests/unit/models/disconnect-callback.test.ts +4 -0
  233. package/tests/unit/models/inbound-callback-message.test.ts +3 -0
  234. package/tests/unit/models/rbm-session.test.ts +19 -0
  235. package/tests/unit/models/status-callback-message.test.ts +3 -0
  236. package/tests/unit/models/status-callback-type-enum.test.ts +3 -1
  237. package/tests/unit/models/transfer-disconnect-callback.test.ts +6 -0
@@ -22,8 +22,6 @@ interface AWSv4Configuration {
22
22
  }
23
23
  export interface ConfigurationParameters {
24
24
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
25
- username?: string;
26
- password?: string;
27
25
  clientId?: string;
28
26
  clientSecret?: string;
29
27
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
@@ -40,14 +38,6 @@ export declare class Configuration {
40
38
  * @param name security name
41
39
  */
42
40
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
43
- /**
44
- * parameter for basic security
45
- */
46
- username?: string;
47
- /**
48
- * parameter for basic security
49
- */
50
- password?: string;
51
41
  /**
52
42
  * parameter for client ID
53
43
  */
@@ -66,9 +66,10 @@ var Configuration = /** @class */ (function () {
66
66
  if (param === void 0) { param = {}; }
67
67
  var _this = this;
68
68
  var _a, _b, _c;
69
+ if ('username' in param || 'password' in param) {
70
+ throw new Error('Basic authentication is no longer supported. Use `clientId` and `clientSecret` instead.');
71
+ }
69
72
  this.apiKey = param.apiKey;
70
- this.username = param.username;
71
- this.password = param.password;
72
73
  this.clientId = param.clientId;
73
74
  this.clientSecret = param.clientSecret;
74
75
  this.tempAccessToken;
@@ -104,7 +105,7 @@ var Configuration = /** @class */ (function () {
104
105
  this.awsv4 = param.awsv4;
105
106
  this.basePath = param.basePath;
106
107
  this.serverIndex = param.serverIndex;
107
- this.baseOptions = __assign(__assign({}, param.baseOptions), { headers: __assign(__assign({}, (_c = param.baseOptions) === null || _c === void 0 ? void 0 : _c.headers), { 'User-Agent': "OpenAPI-Generator/8.3.1/typescript-axios" }) });
108
+ this.baseOptions = __assign(__assign({}, param.baseOptions), { headers: __assign(__assign({}, (_c = param.baseOptions) === null || _c === void 0 ? void 0 : _c.headers), { 'User-Agent': "OpenAPI-Generator/9.0.0/typescript-axios" }) });
108
109
  this.formDataCtor = param.formDataCtor;
109
110
  }
110
111
  /**
@@ -30,5 +30,7 @@ export type Callback = {
30
30
  } & StatusCallback | {
31
31
  type: 'requested-location-response';
32
32
  } & InboundCallback | {
33
+ type: 'session-started';
34
+ } & StatusCallback | {
33
35
  type: 'suggestion-response';
34
36
  } & InboundCallback;
@@ -84,7 +84,17 @@ export interface DisconnectCallback {
84
84
  */
85
85
  'sipCallId'?: string;
86
86
  /**
87
- * (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.
87
+ * (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.
88
88
  */
89
89
  'sipResponseCode'?: number;
90
+ /**
91
+ * (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.
92
+ */
93
+ 'sipStatusLine'?: string;
94
+ /**
95
+ * (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`.
96
+ */
97
+ 'sipHeaders'?: {
98
+ [key: string]: string;
99
+ };
90
100
  }
@@ -14,6 +14,7 @@ import type { MultiChannelMessageChannelEnum } from './multi-channel-message-cha
14
14
  import type { MultiChannelMessageContent } from './multi-channel-message-content';
15
15
  import type { PriorityEnum } from './priority-enum';
16
16
  import type { RbmLocationResponse } from './rbm-location-response';
17
+ import type { RbmSession } from './rbm-session';
17
18
  import type { RbmSuggestionResponse } from './rbm-suggestion-response';
18
19
  /**
19
20
  * @type InboundCallbackMessage
@@ -56,6 +57,7 @@ export interface InboundCallbackMessage {
56
57
  'media'?: Array<string>;
57
58
  'priority'?: PriorityEnum;
58
59
  'channel'?: MultiChannelMessageChannelEnum;
60
+ 'session'?: RbmSession;
59
61
  'content'?: MultiChannelMessageContent;
60
62
  'suggestionResponse'?: RbmSuggestionResponse;
61
63
  'locationResponse'?: RbmLocationResponse;
@@ -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';
@@ -160,6 +160,7 @@ __exportStar(require("./rbm-message-content-rich-card"), exports);
160
160
  __exportStar(require("./rbm-message-content-text"), exports);
161
161
  __exportStar(require("./rbm-message-media"), exports);
162
162
  __exportStar(require("./rbm-open-url-enum"), exports);
163
+ __exportStar(require("./rbm-session"), exports);
163
164
  __exportStar(require("./rbm-standalone-card"), exports);
164
165
  __exportStar(require("./rbm-suggestion-response"), exports);
165
166
  __exportStar(require("./rbm-web-view-enum"), exports);
@@ -64,7 +64,7 @@ export interface InitiateCallback {
64
64
  */
65
65
  'sipCallId'?: string;
66
66
  /**
67
- * (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.
67
+ * (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`.
68
68
  */
69
69
  'sipHeaders'?: {
70
70
  [key: string]: string;
@@ -55,7 +55,7 @@ export interface ListMessageItem {
55
55
  /**
56
56
  * The length of the message content.
57
57
  */
58
- 'messageLength'?: number;
58
+ 'messageLength'?: number | null;
59
59
  /**
60
60
  * The number of attachments the message has.
61
61
  */
@@ -20,7 +20,7 @@ export interface MultiChannelActionCalendarEvent {
20
20
  */
21
21
  'text': string;
22
22
  /**
23
- * Base64 payload the customer receives when the reply is clicked.
23
+ * Payload the customer receives when the reply is clicked.
24
24
  */
25
25
  'postbackData': string;
26
26
  /**
@@ -19,7 +19,7 @@ export interface MultiChannelAction {
19
19
  */
20
20
  'text': string;
21
21
  /**
22
- * Base64 payload the customer receives when the reply is clicked.
22
+ * Payload the customer receives when the reply is clicked.
23
23
  */
24
24
  'postbackData': string;
25
25
  /**
@@ -17,7 +17,7 @@ export interface RbmActionBase {
17
17
  */
18
18
  'text': string;
19
19
  /**
20
- * Base64 payload the customer receives when the reply is clicked.
20
+ * Payload the customer receives when the reply is clicked.
21
21
  */
22
22
  'postbackData': string;
23
23
  }
@@ -20,7 +20,7 @@ export interface RbmActionDial {
20
20
  */
21
21
  'text': string;
22
22
  /**
23
- * Base64 payload the customer receives when the reply is clicked.
23
+ * Payload the customer receives when the reply is clicked.
24
24
  */
25
25
  'postbackData': string;
26
26
  /**
@@ -22,7 +22,7 @@ export interface RbmActionOpenUrl {
22
22
  */
23
23
  'text': string;
24
24
  /**
25
- * Base64 payload the customer receives when the reply is clicked.
25
+ * Payload the customer receives when the reply is clicked.
26
26
  */
27
27
  'postbackData': string;
28
28
  /**
@@ -20,7 +20,7 @@ export interface RbmActionViewLocation {
20
20
  */
21
21
  'text': string;
22
22
  /**
23
- * Base64 payload the customer receives when the reply is clicked.
23
+ * Payload the customer receives when the reply is clicked.
24
24
  */
25
25
  'postbackData': string;
26
26
  /**
@@ -0,0 +1,36 @@
1
+ /**
2
+ * Bandwidth
3
+ * Bandwidth\'s Communication APIs
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: letstalk@bandwidth.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * 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.
14
+ */
15
+ export interface RbmSession {
16
+ /**
17
+ * 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.
18
+ */
19
+ 'canInitiate': boolean;
20
+ /**
21
+ * 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.
22
+ */
23
+ 'id'?: string | null;
24
+ /**
25
+ * The type of the interactive session. Only present on `session-started` callbacks.
26
+ */
27
+ 'type'?: string | null;
28
+ /**
29
+ * The time the 24-hour session window opened. Only present on `session-started` callbacks.
30
+ */
31
+ 'startTime'?: string | null;
32
+ /**
33
+ * The time the 24-hour session window closes. Only present on `session-started` callbacks.
34
+ */
35
+ 'endTime'?: string | null;
36
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Bandwidth
6
+ * Bandwidth\'s Communication APIs
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ * Contact: letstalk@bandwidth.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -11,11 +11,11 @@
11
11
  */
12
12
  export interface RbmSuggestionResponse {
13
13
  /**
14
- * The text associated with the suggestion response.
14
+ * The text of the suggestion the user tapped.
15
15
  */
16
16
  'text'?: string;
17
17
  /**
18
- * Base64 payload the customer receives when the reply is clicked.
18
+ * Payload the customer receives when the reply is clicked.
19
19
  */
20
20
  'postbackData'?: string;
21
21
  /**
@@ -12,6 +12,7 @@
12
12
  import type { MessageDirectionEnum } from './message-direction-enum';
13
13
  import type { MultiChannelMessageChannelEnum } from './multi-channel-message-channel-enum';
14
14
  import type { PriorityEnum } from './priority-enum';
15
+ import type { RbmSession } from './rbm-session';
15
16
  /**
16
17
  * Message payload schema within a callback
17
18
  */
@@ -53,4 +54,5 @@ export interface StatusCallbackMessage {
53
54
  'media'?: Array<string>;
54
55
  'priority'?: PriorityEnum;
55
56
  'channel'?: MultiChannelMessageChannelEnum;
57
+ 'session'?: RbmSession;
56
58
  }
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * 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.
13
+ * 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.
14
14
  */
15
15
  export declare const StatusCallbackTypeEnum: {
16
16
  readonly MessageSending: "message-sending";
@@ -18,5 +18,6 @@ export declare const StatusCallbackTypeEnum: {
18
18
  readonly MessageDelivered: "message-delivered";
19
19
  readonly MessageFailed: "message-failed";
20
20
  readonly MessageRead: "message-read";
21
+ readonly SessionStarted: "session-started";
21
22
  };
22
23
  export type StatusCallbackTypeEnum = typeof StatusCallbackTypeEnum[keyof typeof StatusCallbackTypeEnum];
@@ -15,7 +15,7 @@
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.StatusCallbackTypeEnum = void 0;
17
17
  /**
18
- * 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.
18
+ * 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.
19
19
  */
20
20
  exports.StatusCallbackTypeEnum = {
21
21
  MessageSending: 'message-sending',
@@ -23,4 +23,5 @@ exports.StatusCallbackTypeEnum = {
23
23
  MessageDelivered: 'message-delivered',
24
24
  MessageFailed: 'message-failed',
25
25
  MessageRead: 'message-read',
26
+ SessionStarted: 'session-started',
26
27
  };
@@ -91,4 +91,18 @@ export interface TransferDisconnectCallback {
91
91
  * Bandwidth\'s internal id that references the error event.
92
92
  */
93
93
  'errorId'?: string | null;
94
+ /**
95
+ * (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.
96
+ */
97
+ 'sipResponseCode'?: number;
98
+ /**
99
+ * (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.
100
+ */
101
+ 'sipStatusLine'?: string;
102
+ /**
103
+ * (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`.
104
+ */
105
+ 'sipHeaders'?: {
106
+ [key: string]: string;
107
+ };
94
108
  }
package/docs/CallsApi.md CHANGED
@@ -50,7 +50,7 @@ const { status, data } = await apiInstance.createCall(
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
 
@@ -112,7 +112,7 @@ const { status, data } = await apiInstance.getCallState(
112
112
 
113
113
  ### Authorization
114
114
 
115
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
115
+ [OAuth2](../README.md#OAuth2)
116
116
 
117
117
  ### HTTP request headers
118
118
 
@@ -192,7 +192,7 @@ const { status, data } = await apiInstance.listCalls(
192
192
 
193
193
  ### Authorization
194
194
 
195
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
195
+ [OAuth2](../README.md#OAuth2)
196
196
 
197
197
  ### HTTP request headers
198
198
 
@@ -258,7 +258,7 @@ void (empty response body)
258
258
 
259
259
  ### Authorization
260
260
 
261
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
261
+ [OAuth2](../README.md#OAuth2)
262
262
 
263
263
  ### HTTP request headers
264
264
 
@@ -324,7 +324,7 @@ void (empty response body)
324
324
 
325
325
  ### Authorization
326
326
 
327
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
327
+ [OAuth2](../README.md#OAuth2)
328
328
 
329
329
  ### HTTP request headers
330
330
 
@@ -56,7 +56,7 @@ const { status, data } = await apiInstance.downloadConferenceRecording(
56
56
 
57
57
  ### Authorization
58
58
 
59
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
59
+ [OAuth2](../README.md#OAuth2)
60
60
 
61
61
  ### HTTP request headers
62
62
 
@@ -118,7 +118,7 @@ const { status, data } = await apiInstance.getConference(
118
118
 
119
119
  ### Authorization
120
120
 
121
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
121
+ [OAuth2](../README.md#OAuth2)
122
122
 
123
123
  ### HTTP request headers
124
124
 
@@ -183,7 +183,7 @@ const { status, data } = await apiInstance.getConferenceMember(
183
183
 
184
184
  ### Authorization
185
185
 
186
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
186
+ [OAuth2](../README.md#OAuth2)
187
187
 
188
188
  ### HTTP request headers
189
189
 
@@ -248,7 +248,7 @@ const { status, data } = await apiInstance.getConferenceRecording(
248
248
 
249
249
  ### Authorization
250
250
 
251
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
251
+ [OAuth2](../README.md#OAuth2)
252
252
 
253
253
  ### HTTP request headers
254
254
 
@@ -310,7 +310,7 @@ const { status, data } = await apiInstance.listConferenceRecordings(
310
310
 
311
311
  ### Authorization
312
312
 
313
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
313
+ [OAuth2](../README.md#OAuth2)
314
314
 
315
315
  ### HTTP request headers
316
316
 
@@ -384,7 +384,7 @@ const { status, data } = await apiInstance.listConferences(
384
384
 
385
385
  ### Authorization
386
386
 
387
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
387
+ [OAuth2](../README.md#OAuth2)
388
388
 
389
389
  ### HTTP request headers
390
390
 
@@ -450,7 +450,7 @@ void (empty response body)
450
450
 
451
451
  ### Authorization
452
452
 
453
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
453
+ [OAuth2](../README.md#OAuth2)
454
454
 
455
455
  ### HTTP request headers
456
456
 
@@ -515,7 +515,7 @@ void (empty response body)
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
 
@@ -24,7 +24,9 @@ Name | Type | Description | Notes
24
24
  **errorId** | **string** | Bandwidth\&#39;s internal id that references the error event. | [optional] [default to undefined]
25
25
  **tag** | **string** | (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. | [optional] [default to undefined]
26
26
  **sipCallId** | **string** | (optional) The SIP Call-ID of the call\&#39;s current SIP dialog with Bandwidth\&#39;s SBC. Used to correlate dialogs and trace calls. Present on any call, inbound or outbound, once that dialog has been established; may be absent very early in a call before the dialog exists. | [optional] [default to undefined]
27
- **sipResponseCode** | **number** | (optional) The SIP status code returned by Bandwidth\&#39;s SBC when it rejected an outbound call\&#39;s INVITE (e.g. 486 for busy, 603 for decline). Present only when an outbound call was rejected by the SBC. | [optional] [default to undefined]
27
+ **sipResponseCode** | **number** | (optional) The SIP status code of the final response that rejected an outbound call\&#39;s (or transferred leg\&#39;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]
28
+ **sipStatusLine** | **string** | (optional) The full SIP status line, exactly as received, of the final response that rejected an outbound call\&#39;s INVITE. The reason phrase can help distinguish outcomes that share a status code, such as &#x60;603 Network Blocked&#x60; and &#x60;603 Decline&#x60;. Present only when an outbound call was rejected with a SIP response. | [optional] [default to undefined]
29
+ **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 &#x60;reason&#x60; key holding the raw, unmodified &#x60;Reason&#x60; header value from the final SIP response that rejected an outbound call (or transferred leg); present only when that response included a &#x60;Reason&#x60; header (for example, &#x60;v&#x3D;analytics1&#x60; call-analytics block information from a terminating carrier). If the response carries more than one &#x60;Reason&#x60; header, all values are returned in the order received, separated by &#x60;, &#x60;. Note - on the Initiate callback, keys preserve the original SIP header name in lowercase rather than Bandwidth\&#39;s usual camelCase JSON convention, since these are passthrough values from the caller\&#39;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 &#x60;reason&#x60;. | [optional] [default to undefined]
28
30
 
29
31
  ## Example
30
32
 
@@ -51,6 +53,8 @@ const instance: DisconnectCallback = {
51
53
  tag,
52
54
  sipCallId,
53
55
  sipResponseCode,
56
+ sipStatusLine,
57
+ sipHeaders,
54
58
  };
55
59
  ```
56
60
 
@@ -49,7 +49,7 @@ const { status, data } = await apiInstance.createEndpoint(
49
49
 
50
50
  ### Authorization
51
51
 
52
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
52
+ [OAuth2](../README.md#OAuth2)
53
53
 
54
54
  ### HTTP request headers
55
55
 
@@ -111,7 +111,7 @@ void (empty response body)
111
111
 
112
112
  ### Authorization
113
113
 
114
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
114
+ [OAuth2](../README.md#OAuth2)
115
115
 
116
116
  ### HTTP request headers
117
117
 
@@ -173,7 +173,7 @@ const { status, data } = await apiInstance.getEndpoint(
173
173
 
174
174
  ### Authorization
175
175
 
176
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
176
+ [OAuth2](../README.md#OAuth2)
177
177
 
178
178
  ### HTTP request headers
179
179
 
@@ -244,7 +244,7 @@ const { status, data } = await apiInstance.listEndpoints(
244
244
 
245
245
  ### Authorization
246
246
 
247
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
247
+ [OAuth2](../README.md#OAuth2)
248
248
 
249
249
  ### HTTP request headers
250
250
 
@@ -309,7 +309,7 @@ void (empty response body)
309
309
 
310
310
  ### Authorization
311
311
 
312
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
312
+ [OAuth2](../README.md#OAuth2)
313
313
 
314
314
  ### HTTP request headers
315
315
 
@@ -18,6 +18,7 @@ Name | Type | Description | Notes
18
18
  **media** | **Array&lt;string&gt;** | Optional media, not applicable for sms | [optional] [default to undefined]
19
19
  **priority** | [**PriorityEnum**](PriorityEnum.md) | | [optional] [default to undefined]
20
20
  **channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [optional] [default to undefined]
21
+ **session** | [**RbmSession**](RbmSession.md) | | [optional] [default to undefined]
21
22
  **content** | [**MultiChannelMessageContent**](MultiChannelMessageContent.md) | | [optional] [default to undefined]
22
23
  **suggestionResponse** | [**RbmSuggestionResponse**](RbmSuggestionResponse.md) | | [optional] [default to undefined]
23
24
  **locationResponse** | [**RbmLocationResponse**](RbmLocationResponse.md) | | [optional] [default to undefined]
@@ -41,6 +42,7 @@ const instance: InboundCallbackMessage = {
41
42
  media,
42
43
  priority,
43
44
  channel,
45
+ session,
44
46
  content,
45
47
  suggestionResponse,
46
48
  locationResponse,
@@ -20,7 +20,7 @@ Name | Type | Description | Notes
20
20
  **stirShaken** | [**StirShaken**](StirShaken.md) | | [optional] [default to undefined]
21
21
  **uui** | **string** | The value of the &#x60;User-To-User&#x60; header to send within the initial &#x60;INVITE&#x60;. Must include the encoding parameter as specified in RFC 7433. Only &#x60;base64&#x60;, &#x60;jwt&#x60; and &#x60;hex&#x60; encoding are currently allowed. This value, including the encoding specifier, may not exceed 256 characters. | [optional] [default to undefined]
22
22
  **sipCallId** | **string** | (optional) The SIP Call-ID of the call\&#39;s current SIP dialog with Bandwidth\&#39;s SBC. Used to correlate dialogs and trace calls. Present on any call, inbound or outbound, once that dialog has been established; may be absent very early in a call before the dialog exists. | [optional] [default to undefined]
23
- **sipHeaders** | **{ [key: string]: string; }** | (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\&#39;s usual camelCase JSON convention, since these are passthrough values from the caller\&#39;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. | [optional] [default to undefined]
23
+ **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 &#x60;reason&#x60; key holding the raw, unmodified &#x60;Reason&#x60; header value from the final SIP response that rejected an outbound call (or transferred leg); present only when that response included a &#x60;Reason&#x60; header (for example, &#x60;v&#x3D;analytics1&#x60; call-analytics block information from a terminating carrier). If the response carries more than one &#x60;Reason&#x60; header, all values are returned in the order received, separated by &#x60;, &#x60;. Note - on the Initiate callback, keys preserve the original SIP header name in lowercase rather than Bandwidth\&#39;s usual camelCase JSON convention, since these are passthrough values from the caller\&#39;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 &#x60;reason&#x60;. | [optional] [default to undefined]
24
24
 
25
25
  ## Example
26
26
 
package/docs/MFAApi.md CHANGED
@@ -48,7 +48,7 @@ const { status, data } = await apiInstance.generateMessagingCode(
48
48
 
49
49
  ### Authorization
50
50
 
51
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
51
+ [OAuth2](../README.md#OAuth2)
52
52
 
53
53
  ### HTTP request headers
54
54
 
@@ -107,7 +107,7 @@ const { status, data } = await apiInstance.generateVoiceCode(
107
107
 
108
108
  ### Authorization
109
109
 
110
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
110
+ [OAuth2](../README.md#OAuth2)
111
111
 
112
112
  ### HTTP request headers
113
113
 
@@ -166,7 +166,7 @@ const { status, data } = await apiInstance.verifyCode(
166
166
 
167
167
  ### Authorization
168
168
 
169
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
169
+ [OAuth2](../README.md#OAuth2)
170
170
 
171
171
  ### HTTP request headers
172
172
 
package/docs/MediaApi.md CHANGED
@@ -48,7 +48,7 @@ void (empty response body)
48
48
 
49
49
  ### Authorization
50
50
 
51
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
51
+ [OAuth2](../README.md#OAuth2)
52
52
 
53
53
  ### HTTP request headers
54
54
 
@@ -110,7 +110,7 @@ const { status, data } = await apiInstance.getMedia(
110
110
 
111
111
  ### Authorization
112
112
 
113
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
113
+ [OAuth2](../README.md#OAuth2)
114
114
 
115
115
  ### HTTP request headers
116
116
 
@@ -172,7 +172,7 @@ const { status, data } = await apiInstance.listMedia(
172
172
 
173
173
  ### Authorization
174
174
 
175
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
175
+ [OAuth2](../README.md#OAuth2)
176
176
 
177
177
  ### HTTP request headers
178
178
 
@@ -243,7 +243,7 @@ void (empty response body)
243
243
 
244
244
  ### Authorization
245
245
 
246
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
246
+ [OAuth2](../README.md#OAuth2)
247
247
 
248
248
  ### HTTP request headers
249
249
 
@@ -47,7 +47,7 @@ const { status, data } = await apiInstance.createMessage(
47
47
 
48
48
  ### Authorization
49
49
 
50
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
50
+ [OAuth2](../README.md#OAuth2)
51
51
 
52
52
  ### HTTP request headers
53
53
 
@@ -188,7 +188,7 @@ const { status, data } = await apiInstance.listMessages(
188
188
 
189
189
  ### Authorization
190
190
 
191
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
191
+ [OAuth2](../README.md#OAuth2)
192
192
 
193
193
  ### HTTP request headers
194
194