bandwidth-sdk 18.3.0 → 19.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 (120) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +27 -21
  3. data/README.md +2 -11
  4. data/Rakefile +1 -1
  5. data/bandwidth.yml +341 -122
  6. data/coverage/.last_run.json +1 -1
  7. data/coverage/.resultset.json +1308 -939
  8. data/coverage/index.html +21197 -17030
  9. data/custom_templates/README.mustache +1 -1
  10. data/custom_templates/api_client.mustache +3 -1
  11. data/custom_templates/configuration.mustache +18 -12
  12. data/custom_templates/gem.mustache +4 -2
  13. data/docs/Callback.md +1 -0
  14. data/docs/CallsApi.md +5 -25
  15. data/docs/ConferencesApi.md +9 -45
  16. data/docs/DisconnectCallback.md +6 -2
  17. data/docs/EndpointsApi.md +5 -25
  18. data/docs/InboundCallback.md +1 -1
  19. data/docs/InboundCallbackMessage.md +2 -0
  20. data/docs/InitiateCallback.md +1 -1
  21. data/docs/LookupResult.md +2 -2
  22. data/docs/MFAApi.md +3 -15
  23. data/docs/MediaApi.md +7 -23
  24. data/docs/Message.md +1 -1
  25. data/docs/MessagesApi.md +2 -10
  26. data/docs/MultiChannelAction.md +3 -3
  27. data/docs/MultiChannelActionCalendarEvent.md +3 -3
  28. data/docs/MultiChannelApi.md +1 -5
  29. data/docs/PhoneNumberLookupApi.md +3 -15
  30. data/docs/RbmActionBase.md +3 -3
  31. data/docs/RbmActionDial.md +3 -3
  32. data/docs/RbmActionOpenUrl.md +3 -3
  33. data/docs/RbmActionViewLocation.md +3 -3
  34. data/docs/RbmSession.md +26 -0
  35. data/docs/RbmSuggestionResponse.md +4 -4
  36. data/docs/RecordingsApi.md +10 -50
  37. data/docs/StatisticsApi.md +1 -5
  38. data/docs/StatusCallback.md +2 -2
  39. data/docs/StatusCallbackMessage.md +3 -1
  40. data/docs/TfvSubmissionInfo.md +2 -2
  41. data/docs/TollFreeVerificationApi.md +12 -48
  42. data/docs/TranscriptionsApi.md +3 -15
  43. data/docs/TransferDisconnectCallback.md +7 -1
  44. data/docs/VerificationRequest.md +2 -2
  45. data/docs/VerificationUpdateRequest.md +3 -3
  46. data/generate.sh +9 -0
  47. data/lib/bandwidth-sdk/api/calls_api.rb +5 -5
  48. data/lib/bandwidth-sdk/api/conferences_api.rb +9 -9
  49. data/lib/bandwidth-sdk/api/endpoints_api.rb +5 -5
  50. data/lib/bandwidth-sdk/api/media_api.rb +8 -8
  51. data/lib/bandwidth-sdk/api/messages_api.rb +2 -2
  52. data/lib/bandwidth-sdk/api/mfa_api.rb +3 -3
  53. data/lib/bandwidth-sdk/api/multi_channel_api.rb +1 -1
  54. data/lib/bandwidth-sdk/api/phone_number_lookup_api.rb +3 -3
  55. data/lib/bandwidth-sdk/api/recordings_api.rb +10 -10
  56. data/lib/bandwidth-sdk/api/statistics_api.rb +1 -1
  57. data/lib/bandwidth-sdk/api/toll_free_verification_api.rb +15 -15
  58. data/lib/bandwidth-sdk/api/transcriptions_api.rb +3 -3
  59. data/lib/bandwidth-sdk/api_client.rb +3 -1
  60. data/lib/bandwidth-sdk/configuration.rb +18 -19
  61. data/lib/bandwidth-sdk/models/callback.rb +1 -0
  62. data/lib/bandwidth-sdk/models/disconnect_callback.rb +27 -5
  63. data/lib/bandwidth-sdk/models/inbound_callback_message.rb +10 -1
  64. data/lib/bandwidth-sdk/models/initiate_callback.rb +1 -1
  65. data/lib/bandwidth-sdk/models/list_message_item.rb +1 -0
  66. data/lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb +1 -1
  67. data/lib/bandwidth-sdk/models/rbm_action_base.rb +1 -1
  68. data/lib/bandwidth-sdk/models/rbm_action_dial.rb +1 -1
  69. data/lib/bandwidth-sdk/models/rbm_action_open_url.rb +1 -1
  70. data/lib/bandwidth-sdk/models/rbm_action_view_location.rb +1 -1
  71. data/lib/bandwidth-sdk/models/rbm_session.rb +208 -0
  72. data/lib/bandwidth-sdk/models/rbm_suggestion_response.rb +2 -2
  73. data/lib/bandwidth-sdk/models/status_callback_message.rb +13 -4
  74. data/lib/bandwidth-sdk/models/status_callback_type_enum.rb +2 -1
  75. data/lib/bandwidth-sdk/models/tfv_submission_info.rb +2 -2
  76. data/lib/bandwidth-sdk/models/transfer_disconnect_callback.rb +37 -5
  77. data/lib/bandwidth-sdk/models/verification_request.rb +2 -2
  78. data/lib/bandwidth-sdk/models/verification_update_request.rb +19 -2
  79. data/lib/bandwidth-sdk/version.rb +1 -1
  80. data/lib/bandwidth-sdk.rb +3 -2
  81. data/spec/smoke/calls_api_spec.rb +46 -46
  82. data/spec/smoke/conferences_api_spec.rb +1 -1
  83. data/spec/smoke/endpoints_api_spec.rb +2 -31
  84. data/spec/smoke/media_api_spec.rb +2 -0
  85. data/spec/smoke/messages_api_spec.rb +2 -24
  86. data/spec/smoke/mfa_api_spec.rb +4 -27
  87. data/spec/smoke/multi_channel_api_spec.rb +4 -2
  88. data/spec/smoke/phone_number_lookup_api_spec.rb +2 -0
  89. data/spec/smoke/recordings_api_spec.rb +1 -1
  90. data/spec/smoke/smoke_helper.rb +41 -0
  91. data/spec/smoke/statistics_api_spec.rb +2 -37
  92. data/spec/smoke/toll_free_verification_api_spec.rb +2 -0
  93. data/spec/smoke/transcriptions_api_spec.rb +1 -1
  94. data/spec/spec_helper.rb +0 -48
  95. data/spec/unit/api/calls_api_spec.rb +3 -1
  96. data/spec/unit/api/conferences_api_spec.rb +2 -0
  97. data/spec/unit/api/endpoints_api_spec.rb +2 -0
  98. data/spec/unit/api/media_api_spec.rb +2 -0
  99. data/spec/unit/api/messages_api_spec.rb +2 -0
  100. data/spec/unit/api/mfa_api_spec.rb +2 -0
  101. data/spec/unit/api/multi_channel_api_spec.rb +2 -0
  102. data/spec/unit/api/phone_number_lookup_api_spec.rb +2 -0
  103. data/spec/unit/api/recordings_api_spec.rb +2 -0
  104. data/spec/unit/api/statistics_api_spec.rb +2 -0
  105. data/spec/unit/api/toll_free_verification_api_spec.rb +2 -0
  106. data/spec/unit/api/transcriptions_api_spec.rb +2 -0
  107. data/spec/unit/client/api_client_spec.rb +70 -206
  108. data/spec/unit/client/configuration_spec.rb +22 -17
  109. data/spec/unit/constants.rb +6 -0
  110. data/spec/unit/models/callback_spec.rb +1 -0
  111. data/spec/unit/models/disconnect_callback_spec.rb +10 -2
  112. data/spec/unit/models/inbound_callback_message_spec.rb +20 -5
  113. data/spec/unit/models/list_message_item_spec.rb +1 -0
  114. data/spec/unit/models/rbm_session_spec.rb +95 -0
  115. data/spec/unit/models/status_callback_message_spec.rb +20 -5
  116. data/spec/unit/models/status_callback_type_enum_spec.rb +7 -1
  117. data/spec/unit/models/tfv_submission_wrapper_spec.rb +2 -1
  118. data/spec/unit/models/transfer_disconnect_callback_spec.rb +16 -4
  119. data/spec/unit/models/verification_update_request_spec.rb +4 -2
  120. metadata +10 -1
data/docs/MediaApi.md CHANGED
@@ -25,10 +25,6 @@ require 'time'
25
25
  require 'bandwidth-sdk'
26
26
  # setup authorization
27
27
  Bandwidth.configure do |config|
28
- # Configure HTTP basic authorization: Basic
29
- config.username = 'YOUR USERNAME'
30
- config.password = 'YOUR PASSWORD'
31
-
32
28
  # Configure OAuth2 access token for authorization: OAuth2
33
29
  config.access_token = 'YOUR ACCESS TOKEN'
34
30
  end
@@ -76,7 +72,7 @@ nil (empty response body)
76
72
 
77
73
  ### Authorization
78
74
 
79
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
75
+ [OAuth2](../README.md#OAuth2)
80
76
 
81
77
  ### HTTP request headers
82
78
 
@@ -99,10 +95,6 @@ require 'time'
99
95
  require 'bandwidth-sdk'
100
96
  # setup authorization
101
97
  Bandwidth.configure do |config|
102
- # Configure HTTP basic authorization: Basic
103
- config.username = 'YOUR USERNAME'
104
- config.password = 'YOUR PASSWORD'
105
-
106
98
  # Configure OAuth2 access token for authorization: OAuth2
107
99
  config.access_token = 'YOUR ACCESS TOKEN'
108
100
  end
@@ -151,7 +143,7 @@ end
151
143
 
152
144
  ### Authorization
153
145
 
154
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
146
+ [OAuth2](../README.md#OAuth2)
155
147
 
156
148
  ### HTTP request headers
157
149
 
@@ -174,10 +166,6 @@ require 'time'
174
166
  require 'bandwidth-sdk'
175
167
  # setup authorization
176
168
  Bandwidth.configure do |config|
177
- # Configure HTTP basic authorization: Basic
178
- config.username = 'YOUR USERNAME'
179
- config.password = 'YOUR PASSWORD'
180
-
181
169
  # Configure OAuth2 access token for authorization: OAuth2
182
170
  config.access_token = 'YOUR ACCESS TOKEN'
183
171
  end
@@ -228,7 +216,7 @@ end
228
216
 
229
217
  ### Authorization
230
218
 
231
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
219
+ [OAuth2](../README.md#OAuth2)
232
220
 
233
221
  ### HTTP request headers
234
222
 
@@ -242,7 +230,7 @@ end
242
230
 
243
231
  Upload Media
244
232
 
245
- Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
233
+ Upload a file. Filename should always be unique. Reusing filenames may result in the wrong media being sent. A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
246
234
 
247
235
  ### Examples
248
236
 
@@ -251,10 +239,6 @@ require 'time'
251
239
  require 'bandwidth-sdk'
252
240
  # setup authorization
253
241
  Bandwidth.configure do |config|
254
- # Configure HTTP basic authorization: Basic
255
- config.username = 'YOUR USERNAME'
256
- config.password = 'YOUR PASSWORD'
257
-
258
242
  # Configure OAuth2 access token for authorization: OAuth2
259
243
  config.access_token = 'YOUR ACCESS TOKEN'
260
244
  end
@@ -265,7 +249,7 @@ media_id = 'bw.png' # String | The ID of the media file.
265
249
  body = File.new('/path/to/some/file') # File |
266
250
  opts = {
267
251
  content_type: 'audio/wav', # String | The media type of the entity-body.
268
- cache_control: 'no-cache' # String | General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.
252
+ cache_control: 'no-cache' # String | Pass-through header stored with the media and returned when the media is retrieved by the user. Does not affect internal server caching behavior.
269
253
  }
270
254
 
271
255
  begin
@@ -302,7 +286,7 @@ end
302
286
  | **media_id** | **String** | The ID of the media file. | |
303
287
  | **body** | **File** | | |
304
288
  | **content_type** | **String** | The media type of the entity-body. | [optional] |
305
- | **cache_control** | **String** | General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. | [optional] |
289
+ | **cache_control** | **String** | Pass-through header stored with the media and returned when the media is retrieved by the user. Does not affect internal server caching behavior. | [optional] |
306
290
 
307
291
  ### Return type
308
292
 
@@ -310,7 +294,7 @@ nil (empty response body)
310
294
 
311
295
  ### Authorization
312
296
 
313
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
297
+ [OAuth2](../README.md#OAuth2)
314
298
 
315
299
  ### HTTP request headers
316
300
 
data/docs/Message.md CHANGED
@@ -27,7 +27,7 @@ instance = Bandwidth::Message.new(
27
27
  id: 1589228074636lm4k2je7j7jklbn2,
28
28
  owner: +15554443333,
29
29
  application_id: 93de2206-9669-4e07-948d-329f4b722ee2,
30
- time: 2024-12-02T20:15:57.278Z,
30
+ time: 2024-12-02T20:15:57.278201Z,
31
31
  segment_count: 1,
32
32
  direction: null,
33
33
  to: ["+15552223333"],
data/docs/MessagesApi.md CHANGED
@@ -23,10 +23,6 @@ require 'time'
23
23
  require 'bandwidth-sdk'
24
24
  # setup authorization
25
25
  Bandwidth.configure do |config|
26
- # Configure HTTP basic authorization: Basic
27
- config.username = 'YOUR USERNAME'
28
- config.password = 'YOUR PASSWORD'
29
-
30
26
  # Configure OAuth2 access token for authorization: OAuth2
31
27
  config.access_token = 'YOUR ACCESS TOKEN'
32
28
  end
@@ -75,7 +71,7 @@ end
75
71
 
76
72
  ### Authorization
77
73
 
78
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
74
+ [OAuth2](../README.md#OAuth2)
79
75
 
80
76
  ### HTTP request headers
81
77
 
@@ -98,10 +94,6 @@ require 'time'
98
94
  require 'bandwidth-sdk'
99
95
  # setup authorization
100
96
  Bandwidth.configure do |config|
101
- # Configure HTTP basic authorization: Basic
102
- config.username = 'YOUR USERNAME'
103
- config.password = 'YOUR PASSWORD'
104
-
105
97
  # Configure OAuth2 access token for authorization: OAuth2
106
98
  config.access_token = 'YOUR ACCESS TOKEN'
107
99
  end
@@ -204,7 +196,7 @@ end
204
196
 
205
197
  ### Authorization
206
198
 
207
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
199
+ [OAuth2](../README.md#OAuth2)
208
200
 
209
201
  ### HTTP request headers
210
202
 
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | |
8
8
  | **text** | **String** | Displayed text for user to click | |
9
- | **postback_data** | **String** | Base64 payload the customer receives when the reply is clicked. | |
9
+ | **postback_data** | **String** | Payload the customer receives when the reply is clicked. | |
10
10
  | **phone_number** | **String** | The phone number to dial. Must be E164 format. | |
11
11
  | **latitude** | **Float** | The latitude of the location. Must be in range [-90.000000, 90.000000]. | |
12
12
  | **longitude** | **Float** | The longitude of the location. Must be in range [-180.000000, 180.000000]. | |
@@ -26,8 +26,8 @@ require 'bandwidth-sdk'
26
26
 
27
27
  instance = Bandwidth::MultiChannelAction.new(
28
28
  type: null,
29
- text: Hello world,
30
- postback_data: U0dWc2JHOGdkMjl5YkdRPQ==,
29
+ text: Track my order,
30
+ postback_data: track-order-43654,
31
31
  phone_number: +15552223333,
32
32
  latitude: 37.7749,
33
33
  longitude: -122.4194,
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | |
8
8
  | **text** | **String** | Displayed text for user to click | |
9
- | **postback_data** | **String** | Base64 payload the customer receives when the reply is clicked. | |
9
+ | **postback_data** | **String** | Payload the customer receives when the reply is clicked. | |
10
10
  | **title** | **String** | The title of the event. | |
11
11
  | **start_time** | **Time** | The start time of the event. Must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. | |
12
12
  | **end_time** | **Time** | The end time of the event. Must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. | |
@@ -19,8 +19,8 @@ require 'bandwidth-sdk'
19
19
 
20
20
  instance = Bandwidth::MultiChannelActionCalendarEvent.new(
21
21
  type: null,
22
- text: Hello world,
23
- postback_data: U0dWc2JHOGdkMjl5YkdRPQ==,
22
+ text: Track my order,
23
+ postback_data: track-order-43654,
24
24
  title: Meeting with John,
25
25
  start_time: 2022-09-14T18:20:16Z,
26
26
  end_time: 2022-09-14T18:20:16Z,
@@ -22,10 +22,6 @@ require 'time'
22
22
  require 'bandwidth-sdk'
23
23
  # setup authorization
24
24
  Bandwidth.configure do |config|
25
- # Configure HTTP basic authorization: Basic
26
- config.username = 'YOUR USERNAME'
27
- config.password = 'YOUR PASSWORD'
28
-
29
25
  # Configure OAuth2 access token for authorization: OAuth2
30
26
  config.access_token = 'YOUR ACCESS TOKEN'
31
27
  end
@@ -74,7 +70,7 @@ end
74
70
 
75
71
  ### Authorization
76
72
 
77
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
73
+ [OAuth2](../README.md#OAuth2)
78
74
 
79
75
  ### HTTP request headers
80
76
 
@@ -24,10 +24,6 @@ require 'time'
24
24
  require 'bandwidth-sdk'
25
25
  # setup authorization
26
26
  Bandwidth.configure do |config|
27
- # Configure HTTP basic authorization: Basic
28
- config.username = 'YOUR USERNAME'
29
- config.password = 'YOUR PASSWORD'
30
-
31
27
  # Configure OAuth2 access token for authorization: OAuth2
32
28
  config.access_token = 'YOUR ACCESS TOKEN'
33
29
  end
@@ -76,7 +72,7 @@ end
76
72
 
77
73
  ### Authorization
78
74
 
79
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
75
+ [OAuth2](../README.md#OAuth2)
80
76
 
81
77
  ### HTTP request headers
82
78
 
@@ -99,10 +95,6 @@ require 'time'
99
95
  require 'bandwidth-sdk'
100
96
  # setup authorization
101
97
  Bandwidth.configure do |config|
102
- # Configure HTTP basic authorization: Basic
103
- config.username = 'YOUR USERNAME'
104
- config.password = 'YOUR PASSWORD'
105
-
106
98
  # Configure OAuth2 access token for authorization: OAuth2
107
99
  config.access_token = 'YOUR ACCESS TOKEN'
108
100
  end
@@ -151,7 +143,7 @@ end
151
143
 
152
144
  ### Authorization
153
145
 
154
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
146
+ [OAuth2](../README.md#OAuth2)
155
147
 
156
148
  ### HTTP request headers
157
149
 
@@ -174,10 +166,6 @@ require 'time'
174
166
  require 'bandwidth-sdk'
175
167
  # setup authorization
176
168
  Bandwidth.configure do |config|
177
- # Configure HTTP basic authorization: Basic
178
- config.username = 'YOUR USERNAME'
179
- config.password = 'YOUR PASSWORD'
180
-
181
169
  # Configure OAuth2 access token for authorization: OAuth2
182
170
  config.access_token = 'YOUR ACCESS TOKEN'
183
171
  end
@@ -226,7 +214,7 @@ end
226
214
 
227
215
  ### Authorization
228
216
 
229
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
217
+ [OAuth2](../README.md#OAuth2)
230
218
 
231
219
  ### HTTP request headers
232
220
 
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | |
8
8
  | **text** | **String** | Displayed text for user to click | |
9
- | **postback_data** | **String** | Base64 payload the customer receives when the reply is clicked. | |
9
+ | **postback_data** | **String** | Payload the customer receives when the reply is clicked. | |
10
10
 
11
11
  ## Example
12
12
 
@@ -15,8 +15,8 @@ require 'bandwidth-sdk'
15
15
 
16
16
  instance = Bandwidth::RbmActionBase.new(
17
17
  type: null,
18
- text: Hello world,
19
- postback_data: [B@dc3eda6
18
+ text: Track my order,
19
+ postback_data: track-order-43654
20
20
  )
21
21
  ```
22
22
 
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | |
8
8
  | **text** | **String** | Displayed text for user to click | |
9
- | **postback_data** | **String** | Base64 payload the customer receives when the reply is clicked. | |
9
+ | **postback_data** | **String** | Payload the customer receives when the reply is clicked. | |
10
10
  | **phone_number** | **String** | The phone number to dial. Must be E164 format. | |
11
11
 
12
12
  ## Example
@@ -16,8 +16,8 @@ require 'bandwidth-sdk'
16
16
 
17
17
  instance = Bandwidth::RbmActionDial.new(
18
18
  type: null,
19
- text: Hello world,
20
- postback_data: U0dWc2JHOGdkMjl5YkdRPQ==,
19
+ text: Track my order,
20
+ postback_data: track-order-43654,
21
21
  phone_number: +15552223333
22
22
  )
23
23
  ```
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | |
8
8
  | **text** | **String** | Displayed text for user to click | |
9
- | **postback_data** | **String** | Base64 payload the customer receives when the reply is clicked. | |
9
+ | **postback_data** | **String** | Payload the customer receives when the reply is clicked. | |
10
10
  | **url** | **String** | The URL to open in browser. Must use http:// or https:// scheme. | |
11
11
  | **application** | [**RbmOpenUrlEnum**](RbmOpenUrlEnum.md) | | [optional] |
12
12
  | **webview_view_mode** | [**RbmWebViewEnum**](RbmWebViewEnum.md) | | [optional] |
@@ -18,8 +18,8 @@ require 'bandwidth-sdk'
18
18
 
19
19
  instance = Bandwidth::RbmActionOpenUrl.new(
20
20
  type: null,
21
- text: Hello world,
22
- postback_data: U0dWc2JHOGdkMjl5YkdRPQ==,
21
+ text: Track my order,
22
+ postback_data: track-order-43654,
23
23
  url: https://dev.bandwidth.com,
24
24
  application: null,
25
25
  webview_view_mode: null
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | |
8
8
  | **text** | **String** | Displayed text for user to click | |
9
- | **postback_data** | **String** | Base64 payload the customer receives when the reply is clicked. | |
9
+ | **postback_data** | **String** | Payload the customer receives when the reply is clicked. | |
10
10
  | **latitude** | **Float** | The latitude of the location. Must be in range [-90.000000, 90.000000]. | |
11
11
  | **longitude** | **Float** | The longitude of the location. Must be in range [-180.000000, 180.000000]. | |
12
12
  | **label** | **String** | The label of the location. | [optional] |
@@ -18,8 +18,8 @@ require 'bandwidth-sdk'
18
18
 
19
19
  instance = Bandwidth::RbmActionViewLocation.new(
20
20
  type: null,
21
- text: Hello world,
22
- postback_data: U0dWc2JHOGdkMjl5YkdRPQ==,
21
+ text: Track my order,
22
+ postback_data: track-order-43654,
23
23
  latitude: 37.7749,
24
24
  longitude: -122.4194,
25
25
  label: San Francisco
@@ -0,0 +1,26 @@
1
+ # Bandwidth::RbmSession
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **can_initiate** | **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. | |
8
+ | **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] |
9
+ | **type** | **String** | The type of the interactive session. Only present on `session-started` callbacks. | [optional] |
10
+ | **start_time** | **Time** | The time the 24-hour session window opened. Only present on `session-started` callbacks. | [optional] |
11
+ | **end_time** | **Time** | The time the 24-hour session window closes. Only present on `session-started` callbacks. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'bandwidth-sdk'
17
+
18
+ instance = Bandwidth::RbmSession.new(
19
+ can_initiate: false,
20
+ id: 0f5a3b9c-2d4e-4f6a-8b1c-7e9d0a2b3c4d,
21
+ type: INTERACTIVE_SESSION,
22
+ start_time: 2026-08-06T09:59:55Z,
23
+ end_time: 2026-08-07T09:59:55Z
24
+ )
25
+ ```
26
+
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **text** | **String** | The text associated with the suggestion response. | [optional] |
8
- | **postback_data** | **String** | Base64 payload the customer receives when the reply is clicked. | [optional] |
7
+ | **text** | **String** | The text of the suggestion the user tapped. | [optional] |
8
+ | **postback_data** | **String** | Payload the customer receives when the reply is clicked. | [optional] |
9
9
  | **paired_message_id** | **String** | Corresponding parent message ID (MT). | [optional] |
10
10
 
11
11
  ## Example
@@ -14,8 +14,8 @@
14
14
  require 'bandwidth-sdk'
15
15
 
16
16
  instance = Bandwidth::RbmSuggestionResponse.new(
17
- text: Yes, I would like to proceed,
18
- postback_data: [B@dc3eda6,
17
+ text: Track my order,
18
+ postback_data: track-order-43654,
19
19
  paired_message_id: 1752697342534u24xerqdukke523x
20
20
  )
21
21
  ```
@@ -31,10 +31,6 @@ require 'time'
31
31
  require 'bandwidth-sdk'
32
32
  # setup authorization
33
33
  Bandwidth.configure do |config|
34
- # Configure HTTP basic authorization: Basic
35
- config.username = 'YOUR USERNAME'
36
- config.password = 'YOUR PASSWORD'
37
-
38
34
  # Configure OAuth2 access token for authorization: OAuth2
39
35
  config.access_token = 'YOUR ACCESS TOKEN'
40
36
  end
@@ -84,7 +80,7 @@ nil (empty response body)
84
80
 
85
81
  ### Authorization
86
82
 
87
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
83
+ [OAuth2](../README.md#OAuth2)
88
84
 
89
85
  ### HTTP request headers
90
86
 
@@ -107,10 +103,6 @@ require 'time'
107
103
  require 'bandwidth-sdk'
108
104
  # setup authorization
109
105
  Bandwidth.configure do |config|
110
- # Configure HTTP basic authorization: Basic
111
- config.username = 'YOUR USERNAME'
112
- config.password = 'YOUR PASSWORD'
113
-
114
106
  # Configure OAuth2 access token for authorization: OAuth2
115
107
  config.access_token = 'YOUR ACCESS TOKEN'
116
108
  end
@@ -160,7 +152,7 @@ nil (empty response body)
160
152
 
161
153
  ### Authorization
162
154
 
163
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
155
+ [OAuth2](../README.md#OAuth2)
164
156
 
165
157
  ### HTTP request headers
166
158
 
@@ -183,10 +175,6 @@ require 'time'
183
175
  require 'bandwidth-sdk'
184
176
  # setup authorization
185
177
  Bandwidth.configure do |config|
186
- # Configure HTTP basic authorization: Basic
187
- config.username = 'YOUR USERNAME'
188
- config.password = 'YOUR PASSWORD'
189
-
190
178
  # Configure OAuth2 access token for authorization: OAuth2
191
179
  config.access_token = 'YOUR ACCESS TOKEN'
192
180
  end
@@ -236,7 +224,7 @@ nil (empty response body)
236
224
 
237
225
  ### Authorization
238
226
 
239
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
227
+ [OAuth2](../README.md#OAuth2)
240
228
 
241
229
  ### HTTP request headers
242
230
 
@@ -259,10 +247,6 @@ require 'time'
259
247
  require 'bandwidth-sdk'
260
248
  # setup authorization
261
249
  Bandwidth.configure do |config|
262
- # Configure HTTP basic authorization: Basic
263
- config.username = 'YOUR USERNAME'
264
- config.password = 'YOUR PASSWORD'
265
-
266
250
  # Configure OAuth2 access token for authorization: OAuth2
267
251
  config.access_token = 'YOUR ACCESS TOKEN'
268
252
  end
@@ -313,7 +297,7 @@ end
313
297
 
314
298
  ### Authorization
315
299
 
316
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
300
+ [OAuth2](../README.md#OAuth2)
317
301
 
318
302
  ### HTTP request headers
319
303
 
@@ -336,10 +320,6 @@ require 'time'
336
320
  require 'bandwidth-sdk'
337
321
  # setup authorization
338
322
  Bandwidth.configure do |config|
339
- # Configure HTTP basic authorization: Basic
340
- config.username = 'YOUR USERNAME'
341
- config.password = 'YOUR PASSWORD'
342
-
343
323
  # Configure OAuth2 access token for authorization: OAuth2
344
324
  config.access_token = 'YOUR ACCESS TOKEN'
345
325
  end
@@ -390,7 +370,7 @@ end
390
370
 
391
371
  ### Authorization
392
372
 
393
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
373
+ [OAuth2](../README.md#OAuth2)
394
374
 
395
375
  ### HTTP request headers
396
376
 
@@ -413,10 +393,6 @@ require 'time'
413
393
  require 'bandwidth-sdk'
414
394
  # setup authorization
415
395
  Bandwidth.configure do |config|
416
- # Configure HTTP basic authorization: Basic
417
- config.username = 'YOUR USERNAME'
418
- config.password = 'YOUR PASSWORD'
419
-
420
396
  # Configure OAuth2 access token for authorization: OAuth2
421
397
  config.access_token = 'YOUR ACCESS TOKEN'
422
398
  end
@@ -467,7 +443,7 @@ end
467
443
 
468
444
  ### Authorization
469
445
 
470
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
446
+ [OAuth2](../README.md#OAuth2)
471
447
 
472
448
  ### HTTP request headers
473
449
 
@@ -490,10 +466,6 @@ require 'time'
490
466
  require 'bandwidth-sdk'
491
467
  # setup authorization
492
468
  Bandwidth.configure do |config|
493
- # Configure HTTP basic authorization: Basic
494
- config.username = 'YOUR USERNAME'
495
- config.password = 'YOUR PASSWORD'
496
-
497
469
  # Configure OAuth2 access token for authorization: OAuth2
498
470
  config.access_token = 'YOUR ACCESS TOKEN'
499
471
  end
@@ -550,7 +522,7 @@ end
550
522
 
551
523
  ### Authorization
552
524
 
553
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
525
+ [OAuth2](../README.md#OAuth2)
554
526
 
555
527
  ### HTTP request headers
556
528
 
@@ -573,10 +545,6 @@ require 'time'
573
545
  require 'bandwidth-sdk'
574
546
  # setup authorization
575
547
  Bandwidth.configure do |config|
576
- # Configure HTTP basic authorization: Basic
577
- config.username = 'YOUR USERNAME'
578
- config.password = 'YOUR PASSWORD'
579
-
580
548
  # Configure OAuth2 access token for authorization: OAuth2
581
549
  config.access_token = 'YOUR ACCESS TOKEN'
582
550
  end
@@ -625,7 +593,7 @@ end
625
593
 
626
594
  ### Authorization
627
595
 
628
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
596
+ [OAuth2](../README.md#OAuth2)
629
597
 
630
598
  ### HTTP request headers
631
599
 
@@ -648,10 +616,6 @@ require 'time'
648
616
  require 'bandwidth-sdk'
649
617
  # setup authorization
650
618
  Bandwidth.configure do |config|
651
- # Configure HTTP basic authorization: Basic
652
- config.username = 'YOUR USERNAME'
653
- config.password = 'YOUR PASSWORD'
654
-
655
619
  # Configure OAuth2 access token for authorization: OAuth2
656
620
  config.access_token = 'YOUR ACCESS TOKEN'
657
621
  end
@@ -703,7 +667,7 @@ nil (empty response body)
703
667
 
704
668
  ### Authorization
705
669
 
706
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
670
+ [OAuth2](../README.md#OAuth2)
707
671
 
708
672
  ### HTTP request headers
709
673
 
@@ -726,10 +690,6 @@ require 'time'
726
690
  require 'bandwidth-sdk'
727
691
  # setup authorization
728
692
  Bandwidth.configure do |config|
729
- # Configure HTTP basic authorization: Basic
730
- config.username = 'YOUR USERNAME'
731
- config.password = 'YOUR PASSWORD'
732
-
733
693
  # Configure OAuth2 access token for authorization: OAuth2
734
694
  config.access_token = 'YOUR ACCESS TOKEN'
735
695
  end
@@ -779,7 +739,7 @@ nil (empty response body)
779
739
 
780
740
  ### Authorization
781
741
 
782
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
742
+ [OAuth2](../README.md#OAuth2)
783
743
 
784
744
  ### HTTP request headers
785
745
 
@@ -22,10 +22,6 @@ require 'time'
22
22
  require 'bandwidth-sdk'
23
23
  # setup authorization
24
24
  Bandwidth.configure do |config|
25
- # Configure HTTP basic authorization: Basic
26
- config.username = 'YOUR USERNAME'
27
- config.password = 'YOUR PASSWORD'
28
-
29
25
  # Configure OAuth2 access token for authorization: OAuth2
30
26
  config.access_token = 'YOUR ACCESS TOKEN'
31
27
  end
@@ -72,7 +68,7 @@ end
72
68
 
73
69
  ### Authorization
74
70
 
75
- [Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
71
+ [OAuth2](../README.md#OAuth2)
76
72
 
77
73
  ### HTTP request headers
78
74
 
@@ -19,8 +19,8 @@
19
19
  require 'bandwidth-sdk'
20
20
 
21
21
  instance = Bandwidth::StatusCallback.new(
22
- time: 2024-12-02T20:15:57.278Z,
23
- event_time: 2024-12-02T20:15:58.278Z,
22
+ time: 2024-12-02T20:15:57.278201Z,
23
+ event_time: 2024-12-02T20:15:58.278205Z,
24
24
  type: null,
25
25
  to: +15552223333,
26
26
  description: Message delivered to handset.,
@@ -17,6 +17,7 @@
17
17
  | **media** | **Array<String>** | Optional media, not applicable for sms | [optional] |
18
18
  | **priority** | [**PriorityEnum**](PriorityEnum.md) | | [optional] |
19
19
  | **channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [optional] |
20
+ | **session** | [**RbmSession**](RbmSession.md) | | [optional] |
20
21
 
21
22
  ## Example
22
23
 
@@ -36,7 +37,8 @@ instance = Bandwidth::StatusCallbackMessage.new(
36
37
  tag: custom string,
37
38
  media: ["https://dev.bandwidth.com/images/bandwidth-logo.png","https://dev.bandwidth.com/images/github_logo.png"],
38
39
  priority: null,
39
- channel: null
40
+ channel: null,
41
+ session: null
40
42
  )
41
43
  ```
42
44
 
@@ -16,9 +16,9 @@
16
16
  | **privacy_policy_url** | **String** | The Toll-Free Verification request privacy policy URL. | [optional] |
17
17
  | **terms_and_conditions_url** | **String** | The Toll-Free Verification request terms and conditions policy URL. | [optional] |
18
18
  | **business_dba** | **String** | The company 'Doing Business As'. | [optional] |
19
- | **business_registration_number** | **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] |
19
+ | **business_registration_number** | **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] |
20
20
  | **business_registration_type** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] |
21
- | **business_registration_issuing_country** | **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] |
21
+ | **business_registration_issuing_country** | **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] |
22
22
  | **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] |
23
23
 
24
24
  ## Example