bandwidth-sdk 14.1.2 → 15.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 (107) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +18 -16
  3. data/README.md +34 -1
  4. data/bandwidth.yml +675 -101
  5. data/coverage/.last_run.json +1 -1
  6. data/coverage/.resultset.json +210 -6
  7. data/coverage/index.html +14901 -12699
  8. data/docs/Address.md +1 -1
  9. data/docs/CallsApi.md +1 -1
  10. data/docs/CardWidthEnum.md +15 -0
  11. data/docs/ConferencesApi.md +1 -1
  12. data/docs/CreateMultiChannelMessageResponse.md +22 -0
  13. data/docs/ErrorObject.md +20 -0
  14. data/docs/Link.md +20 -0
  15. data/docs/Message.md +1 -1
  16. data/docs/MessageCallback.md +3 -1
  17. data/docs/MessageRequest.md +1 -1
  18. data/docs/MmsMessageContent.md +20 -0
  19. data/docs/MultiChannelAction.md +89 -0
  20. data/docs/MultiChannelActionCalendarEvent.md +30 -0
  21. data/docs/MultiChannelApi.md +80 -0
  22. data/docs/MultiChannelCallbackData.md +26 -0
  23. data/docs/MultiChannelChannelListObject.md +24 -0
  24. data/docs/MultiChannelChannelListObjectContent.md +55 -0
  25. data/docs/MultiChannelMessageCallbackData.md +32 -0
  26. data/docs/MultiChannelMessageChannelEnum.md +15 -0
  27. data/docs/MultiChannelMessageData.md +34 -0
  28. data/docs/MultiChannelMessageDirectionEnum.md +15 -0
  29. data/docs/MultiChannelMessageRequest.md +26 -0
  30. data/docs/MultiChannelStatusEnum.md +15 -0
  31. data/docs/RbmActionBase.md +22 -0
  32. data/docs/RbmActionDial.md +24 -0
  33. data/docs/RbmActionOpenUrl.md +24 -0
  34. data/docs/RbmActionTypeEnum.md +15 -0
  35. data/docs/RbmActionViewLocation.md +28 -0
  36. data/docs/RbmCardContent.md +24 -0
  37. data/docs/RbmCardContentMedia.md +22 -0
  38. data/docs/RbmMediaHeightEnum.md +15 -0
  39. data/docs/RbmMessageCarouselCard.md +22 -0
  40. data/docs/RbmMessageContentFile.md +20 -0
  41. data/docs/RbmMessageContentRichCard.md +49 -0
  42. data/docs/RbmMessageContentText.md +20 -0
  43. data/docs/RbmMessageMedia.md +20 -0
  44. data/docs/RbmStandaloneCard.md +24 -0
  45. data/docs/SmsMessageContent.md +18 -0
  46. data/docs/StandaloneCardOrientationEnum.md +15 -0
  47. data/docs/TfvBasicAuthentication.md +2 -2
  48. data/docs/TfvStatus.md +5 -1
  49. data/docs/TfvSubmissionInfo.md +7 -1
  50. data/docs/ThumbnailAlignmentEnum.md +15 -0
  51. data/docs/TollFreeVerificationApi.md +1 -1
  52. data/docs/VerificationDenialWebhook.md +5 -1
  53. data/docs/VerificationRequest.md +10 -4
  54. data/docs/VerificationUpdateRequest.md +10 -4
  55. data/lib/bandwidth-sdk/api/multi_channel_api.rb +96 -0
  56. data/lib/bandwidth-sdk/configuration.rb +6 -0
  57. data/lib/bandwidth-sdk/models/bxml/verbs/phone_number.rb +1 -0
  58. data/lib/bandwidth-sdk/models/card_width_enum.rb +40 -0
  59. data/lib/bandwidth-sdk/models/create_multi_channel_message_response.rb +234 -0
  60. data/lib/bandwidth-sdk/models/error_object.rb +221 -0
  61. data/lib/bandwidth-sdk/models/link.rb +221 -0
  62. data/lib/bandwidth-sdk/models/message.rb +1 -1
  63. data/lib/bandwidth-sdk/models/message_callback.rb +16 -5
  64. data/lib/bandwidth-sdk/models/message_request.rb +1 -1
  65. data/lib/bandwidth-sdk/models/mms_message_content.rb +244 -0
  66. data/lib/bandwidth-sdk/models/multi_channel_action.rb +61 -0
  67. data/lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb +419 -0
  68. data/lib/bandwidth-sdk/models/multi_channel_callback_data.rb +272 -0
  69. data/lib/bandwidth-sdk/models/multi_channel_channel_list_object.rb +291 -0
  70. data/lib/bandwidth-sdk/models/multi_channel_channel_list_object_content.rb +108 -0
  71. data/lib/bandwidth-sdk/models/multi_channel_message_callback_data.rb +302 -0
  72. data/lib/bandwidth-sdk/models/multi_channel_message_channel_enum.rb +41 -0
  73. data/lib/bandwidth-sdk/models/multi_channel_message_data.rb +312 -0
  74. data/lib/bandwidth-sdk/models/multi_channel_message_direction_enum.rb +40 -0
  75. data/lib/bandwidth-sdk/models/multi_channel_message_request.rb +310 -0
  76. data/lib/bandwidth-sdk/models/multi_channel_status_enum.rb +42 -0
  77. data/lib/bandwidth-sdk/models/rbm_action_base.rb +313 -0
  78. data/lib/bandwidth-sdk/models/rbm_action_dial.rb +337 -0
  79. data/lib/bandwidth-sdk/models/rbm_action_open_url.rb +356 -0
  80. data/lib/bandwidth-sdk/models/rbm_action_type_enum.rb +44 -0
  81. data/lib/bandwidth-sdk/models/rbm_action_view_location.rb +383 -0
  82. data/lib/bandwidth-sdk/models/rbm_card_content.rb +301 -0
  83. data/lib/bandwidth-sdk/models/rbm_card_content_media.rb +313 -0
  84. data/lib/bandwidth-sdk/models/rbm_media_height_enum.rb +41 -0
  85. data/lib/bandwidth-sdk/models/rbm_message_carousel_card.rb +309 -0
  86. data/lib/bandwidth-sdk/models/rbm_message_content_file.rb +268 -0
  87. data/lib/bandwidth-sdk/models/rbm_message_content_rich_card.rb +104 -0
  88. data/lib/bandwidth-sdk/models/rbm_message_content_text.rb +270 -0
  89. data/lib/bandwidth-sdk/models/rbm_message_media.rb +250 -0
  90. data/lib/bandwidth-sdk/models/rbm_standalone_card.rb +304 -0
  91. data/lib/bandwidth-sdk/models/sms_message_content.rb +239 -0
  92. data/lib/bandwidth-sdk/models/standalone_card_orientation_enum.rb +40 -0
  93. data/lib/bandwidth-sdk/models/tfv_status.rb +24 -4
  94. data/lib/bandwidth-sdk/models/tfv_status_enum.rb +1 -3
  95. data/lib/bandwidth-sdk/models/tfv_submission_info.rb +35 -5
  96. data/lib/bandwidth-sdk/models/thumbnail_alignment_enum.rb +40 -0
  97. data/lib/bandwidth-sdk/models/verification_denial_webhook.rb +24 -4
  98. data/lib/bandwidth-sdk/models/verification_request.rb +45 -15
  99. data/lib/bandwidth-sdk/models/verification_update_request.rb +35 -5
  100. data/lib/bandwidth-sdk/version.rb +1 -1
  101. data/lib/bandwidth-sdk.rb +34 -1
  102. data/spec/smoke/conferences_api_spec.rb +4 -4
  103. data/spec/smoke/multi_channel_api_spec.rb +40 -0
  104. data/spec/smoke/transcriptions_api_spec.rb +1 -1
  105. data/spec/unit/api/multi_channel_api_spec.rb +59 -0
  106. data/spec/unit/models/bxml/verbs/phone_number_spec.rb +6 -4
  107. metadata +117 -45
data/docs/Address.md CHANGED
@@ -20,7 +20,7 @@ require 'bandwidth-sdk'
20
20
  instance = Bandwidth::Address.new(
21
21
  name: Bandwidth Inc.,
22
22
  addr1: 2230 Bandmate Way,
23
- addr2: null,
23
+ addr2: 2230 Bandmate Way,
24
24
  city: Raleigh,
25
25
  state: NC,
26
26
  zip: 27606,
data/docs/CallsApi.md CHANGED
@@ -184,7 +184,7 @@ opts = {
184
184
  max_start_time: '2022-06-21T19:13:21Z', # String | Filter results to calls which have a `startTime` before or including `maxStartTime` (in ISO8601 format).
185
185
  disconnect_cause: 'hangup', # String | Filter results to calls with specified call Disconnect Cause.
186
186
  page_size: 500, # Integer | Specifies the max number of calls that will be returned.
187
- page_token: 'page_token_example' # String | Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description.
187
+ page_token: 'eyJwYWdlVG9rZW4iOiJ0b2tlbiJ9' # String | Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description.
188
188
  }
189
189
 
190
190
  begin
@@ -0,0 +1,15 @@
1
+ # Bandwidth::CardWidthEnum
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'bandwidth-sdk'
12
+
13
+ instance = Bandwidth::CardWidthEnum.new()
14
+ ```
15
+
@@ -408,7 +408,7 @@ opts = {
408
408
  min_created_time: '2022-06-21T19:13:21Z', # String | Filter results to conferences which have a `createdTime` after or at `minCreatedTime` (in ISO8601 format).
409
409
  max_created_time: '2022-06-21T19:13:21Z', # String | Filter results to conferences which have a `createdTime` before or at `maxCreatedTime` (in ISO8601 format).
410
410
  page_size: 500, # Integer | Specifies the max number of conferences that will be returned.
411
- page_token: 'page_token_example' # String | Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description.
411
+ page_token: 'eyJwYWdlVG9rZW4iOiJ0b2tlbiJ9' # String | Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description.
412
412
  }
413
413
 
414
414
  begin
@@ -0,0 +1,22 @@
1
+ # Bandwidth::CreateMultiChannelMessageResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **links** | [**Array<Link>**](Link.md) | | [optional] |
8
+ | **data** | [**MultiChannelMessageData**](MultiChannelMessageData.md) | | [optional] |
9
+ | **errors** | [**Array<ErrorObject>**](ErrorObject.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'bandwidth-sdk'
15
+
16
+ instance = Bandwidth::CreateMultiChannelMessageResponse.new(
17
+ links: null,
18
+ data: null,
19
+ errors: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,20 @@
1
+ # Bandwidth::ErrorObject
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **code** | **String** | | [optional] |
8
+ | **message** | **String** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'bandwidth-sdk'
14
+
15
+ instance = Bandwidth::ErrorObject.new(
16
+ code: null,
17
+ message: null
18
+ )
19
+ ```
20
+
data/docs/Link.md ADDED
@@ -0,0 +1,20 @@
1
+ # Bandwidth::Link
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **rel** | **String** | | [optional] |
8
+ | **href** | **String** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'bandwidth-sdk'
14
+
15
+ instance = Bandwidth::Link.new(
16
+ rel: null,
17
+ href: null
18
+ )
19
+ ```
20
+
data/docs/Message.md CHANGED
@@ -16,7 +16,7 @@
16
16
  | **text** | **String** | The contents of the message. | [optional] |
17
17
  | **tag** | **String** | The custom string set by the user. | [optional] |
18
18
  | **priority** | [**PriorityEnum**](PriorityEnum.md) | | [optional] |
19
- | **expiration** | **Time** | The expiration date-time set by the user. | [optional] |
19
+ | **expiration** | **Time** | A string with the date/time value that the message will automatically expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future. | [optional] |
20
20
 
21
21
  ## Example
22
22
 
@@ -10,6 +10,7 @@
10
10
  | **description** | **String** | A detailed description of the event described by the callback. | |
11
11
  | **message** | [**MessageCallbackMessage**](MessageCallbackMessage.md) | | |
12
12
  | **error_code** | **Integer** | Optional error code, applicable only when type is `message-failed`. | [optional] |
13
+ | **carrier_name** | **String** | The name of the Authorized Message Provider (AMP) that handled this message. In the US, this is the carrier that the message was sent to. | [optional] |
13
14
 
14
15
  ## Example
15
16
 
@@ -22,7 +23,8 @@ instance = Bandwidth::MessageCallback.new(
22
23
  to: +15552223333,
23
24
  description: rejected-unallocated-from-number,
24
25
  message: null,
25
- error_code: 4405
26
+ error_code: 4405,
27
+ carrier_name: AT&T
26
28
  )
27
29
  ```
28
30
 
@@ -11,7 +11,7 @@
11
11
  | **media** | **Array<String>** | A list of URLs to include as media attachments as part of the message. Each URL can be at most 4096 characters. | [optional] |
12
12
  | **tag** | **String** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] |
13
13
  | **priority** | [**PriorityEnum**](PriorityEnum.md) | | [optional] |
14
- | **expiration** | **Time** | A string with the date/time value that the message will automatically expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future. Not supported on MMS. | [optional] |
14
+ | **expiration** | **Time** | A string with the date/time value that the message will automatically expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future. | [optional] |
15
15
 
16
16
  ## Example
17
17
 
@@ -0,0 +1,20 @@
1
+ # Bandwidth::MmsMessageContent
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **text** | **String** | The contents of the text message. Must be 2048 characters or less. | [optional] |
8
+ | **media** | **Array<String>** | A list of URLs to include as media attachments as part of the message. Each URL can be at most 4096 characters. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'bandwidth-sdk'
14
+
15
+ instance = Bandwidth::MmsMessageContent.new(
16
+ text: Hello world,
17
+ media: ["https://dev.bandwidth.com/images/bandwidth-logo.png","https://dev.bandwidth.com/images/github_logo.png"]
18
+ )
19
+ ```
20
+
@@ -0,0 +1,89 @@
1
+ # Bandwidth::MultiChannelAction
2
+
3
+ ## Class instance methods
4
+
5
+ ### `openapi_one_of`
6
+
7
+ Returns the list of classes defined in oneOf.
8
+
9
+ #### Example
10
+
11
+ ```ruby
12
+ require 'bandwidth-sdk'
13
+
14
+ Bandwidth::MultiChannelAction.openapi_one_of
15
+ # =>
16
+ # [
17
+ # :'MultiChannelActionCalendarEvent',
18
+ # :'RbmActionBase',
19
+ # :'RbmActionDial',
20
+ # :'RbmActionOpenUrl',
21
+ # :'RbmActionViewLocation'
22
+ # ]
23
+ ```
24
+
25
+ ### `openapi_discriminator_name`
26
+
27
+ Returns the discriminator's property name.
28
+
29
+ #### Example
30
+
31
+ ```ruby
32
+ require 'bandwidth-sdk'
33
+
34
+ Bandwidth::MultiChannelAction.openapi_discriminator_name
35
+ # => :'type'
36
+ ```
37
+
38
+ ### `openapi_discriminator_name`
39
+
40
+ Returns the discriminator's mapping.
41
+
42
+ #### Example
43
+
44
+ ```ruby
45
+ require 'bandwidth-sdk'
46
+
47
+ Bandwidth::MultiChannelAction.openapi_discriminator_mapping
48
+ # =>
49
+ # {
50
+ # :'CREATE_CALENDAR_EVENT' => :'MultiChannelActionCalendarEvent',
51
+ # :'DIAL_PHONE' => :'RbmActionDial',
52
+ # :'OPEN_URL' => :'RbmActionOpenUrl',
53
+ # :'REPLY' => :'RbmActionBase',
54
+ # :'REQUEST_LOCATION' => :'RbmActionBase',
55
+ # :'SHOW_LOCATION' => :'RbmActionViewLocation'
56
+ # }
57
+ ```
58
+
59
+ ### build
60
+
61
+ Find the appropriate object from the `openapi_one_of` list and casts the data into it.
62
+
63
+ #### Example
64
+
65
+ ```ruby
66
+ require 'bandwidth-sdk'
67
+
68
+ Bandwidth::MultiChannelAction.build(data)
69
+ # => #<MultiChannelActionCalendarEvent:0x00007fdd4aab02a0>
70
+
71
+ Bandwidth::MultiChannelAction.build(data_that_doesnt_match)
72
+ # => nil
73
+ ```
74
+
75
+ #### Parameters
76
+
77
+ | Name | Type | Description |
78
+ | ---- | ---- | ----------- |
79
+ | **data** | **Mixed** | data to be matched against the list of oneOf items |
80
+
81
+ #### Return type
82
+
83
+ - `MultiChannelActionCalendarEvent`
84
+ - `RbmActionBase`
85
+ - `RbmActionDial`
86
+ - `RbmActionOpenUrl`
87
+ - `RbmActionViewLocation`
88
+ - `nil` (if no type matches)
89
+
@@ -0,0 +1,30 @@
1
+ # Bandwidth::MultiChannelActionCalendarEvent
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | |
8
+ | **text** | **String** | Displayed text for user to click | |
9
+ | **post_back_data** | **String** | Base64 payload the customer receives when the reply is clicked. | |
10
+ | **title** | **String** | The title of the event. | |
11
+ | **start_time** | **Time** | The start time of the event. | |
12
+ | **end_time** | **Time** | The end time of the event. | |
13
+ | **description** | **String** | The description of the event. | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'bandwidth-sdk'
19
+
20
+ instance = Bandwidth::MultiChannelActionCalendarEvent.new(
21
+ type: null,
22
+ text: Hello world,
23
+ post_back_data: U0dWc2JHOGdkMjl5YkdRPQ&#x3D;&#x3D;,
24
+ title: Meeting with John,
25
+ start_time: 2022-09-14T18:20:16Z,
26
+ end_time: 2022-09-14T18:20:16Z,
27
+ description: Discuss the new project
28
+ )
29
+ ```
30
+
@@ -0,0 +1,80 @@
1
+ # Bandwidth::MultiChannelApi
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_multi_channel_message**](MultiChannelApi.md#create_multi_channel_message) | **POST** /users/{accountId}/messages/multiChannel | Create Multi-Channel Message |
8
+
9
+
10
+ ## create_multi_channel_message
11
+
12
+ > <CreateMultiChannelMessageResponse> create_multi_channel_message(account_id, multi_channel_message_request)
13
+
14
+ Create Multi-Channel Message
15
+
16
+ Endpoint for sending Multi-Channel messages.
17
+
18
+ ### Examples
19
+
20
+ ```ruby
21
+ require 'time'
22
+ require 'bandwidth-sdk'
23
+ # setup authorization
24
+ Bandwidth.configure do |config|
25
+ # Configure HTTP basic authorization: Basic
26
+ config.username = 'YOUR USERNAME'
27
+ config.password = 'YOUR PASSWORD'
28
+ end
29
+
30
+ api_instance = Bandwidth::MultiChannelApi.new
31
+ account_id = '9900000' # String | Your Bandwidth Account ID.
32
+ multi_channel_message_request = Bandwidth::MultiChannelMessageRequest.new({to: '+15552223333', channel_list: [Bandwidth::MultiChannelChannelListObject.new({from: 'BandwidthRBM', application_id: '93de2206-9669-4e07-948d-329f4b722ee2', channel: Bandwidth::MultiChannelMessageChannelEnum::RBM, content: Bandwidth::MmsMessageContent.new})]}) # MultiChannelMessageRequest |
33
+
34
+ begin
35
+ # Create Multi-Channel Message
36
+ result = api_instance.create_multi_channel_message(account_id, multi_channel_message_request)
37
+ p result
38
+ rescue Bandwidth::ApiError => e
39
+ puts "Error when calling MultiChannelApi->create_multi_channel_message: #{e}"
40
+ end
41
+ ```
42
+
43
+ #### Using the create_multi_channel_message_with_http_info variant
44
+
45
+ This returns an Array which contains the response data, status code and headers.
46
+
47
+ > <Array(<CreateMultiChannelMessageResponse>, Integer, Hash)> create_multi_channel_message_with_http_info(account_id, multi_channel_message_request)
48
+
49
+ ```ruby
50
+ begin
51
+ # Create Multi-Channel Message
52
+ data, status_code, headers = api_instance.create_multi_channel_message_with_http_info(account_id, multi_channel_message_request)
53
+ p status_code # => 2xx
54
+ p headers # => { ... }
55
+ p data # => <CreateMultiChannelMessageResponse>
56
+ rescue Bandwidth::ApiError => e
57
+ puts "Error when calling MultiChannelApi->create_multi_channel_message_with_http_info: #{e}"
58
+ end
59
+ ```
60
+
61
+ ### Parameters
62
+
63
+ | Name | Type | Description | Notes |
64
+ | ---- | ---- | ----------- | ----- |
65
+ | **account_id** | **String** | Your Bandwidth Account ID. | |
66
+ | **multi_channel_message_request** | [**MultiChannelMessageRequest**](MultiChannelMessageRequest.md) | | |
67
+
68
+ ### Return type
69
+
70
+ [**CreateMultiChannelMessageResponse**](CreateMultiChannelMessageResponse.md)
71
+
72
+ ### Authorization
73
+
74
+ [Basic](../README.md#Basic)
75
+
76
+ ### HTTP request headers
77
+
78
+ - **Content-Type**: application/json
79
+ - **Accept**: application/json
80
+
@@ -0,0 +1,26 @@
1
+ # Bandwidth::MultiChannelCallbackData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **time** | **Time** | The time of the callback event. | [optional] |
8
+ | **type** | [**MultiChannelStatusEnum**](MultiChannelStatusEnum.md) | | [optional] |
9
+ | **to** | **String** | The phone number the message should be sent to in E164 format. | [optional] |
10
+ | **description** | **String** | | [optional] |
11
+ | **message** | [**MultiChannelMessageCallbackData**](MultiChannelMessageCallbackData.md) | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'bandwidth-sdk'
17
+
18
+ instance = Bandwidth::MultiChannelCallbackData.new(
19
+ time: 2025-01-01T18:20:16Z,
20
+ type: null,
21
+ to: +15552223333,
22
+ description: Incoming message received,
23
+ message: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,24 @@
1
+ # Bandwidth::MultiChannelChannelListObject
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **from** | **String** | The sender ID of the message. This could be an alphanumeric sender ID. | |
8
+ | **application_id** | **String** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. | |
9
+ | **channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | |
10
+ | **content** | [**MultiChannelChannelListObjectContent**](MultiChannelChannelListObjectContent.md) | | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'bandwidth-sdk'
16
+
17
+ instance = Bandwidth::MultiChannelChannelListObject.new(
18
+ from: BandwidthRBM,
19
+ application_id: 93de2206-9669-4e07-948d-329f4b722ee2,
20
+ channel: null,
21
+ content: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,55 @@
1
+ # Bandwidth::MultiChannelChannelListObjectContent
2
+
3
+ ## Class instance methods
4
+
5
+ ### `openapi_one_of`
6
+
7
+ Returns the list of classes defined in oneOf.
8
+
9
+ #### Example
10
+
11
+ ```ruby
12
+ require 'bandwidth-sdk'
13
+
14
+ Bandwidth::MultiChannelChannelListObjectContent.openapi_one_of
15
+ # =>
16
+ # [
17
+ # :'MmsMessageContent',
18
+ # :'RbmMessageContentRichCard',
19
+ # :'RbmMessageContentText',
20
+ # :'RbmMessageMedia',
21
+ # :'SmsMessageContent'
22
+ # ]
23
+ ```
24
+
25
+ ### build
26
+
27
+ Find the appropriate object from the `openapi_one_of` list and casts the data into it.
28
+
29
+ #### Example
30
+
31
+ ```ruby
32
+ require 'bandwidth-sdk'
33
+
34
+ Bandwidth::MultiChannelChannelListObjectContent.build(data)
35
+ # => #<MmsMessageContent:0x00007fdd4aab02a0>
36
+
37
+ Bandwidth::MultiChannelChannelListObjectContent.build(data_that_doesnt_match)
38
+ # => nil
39
+ ```
40
+
41
+ #### Parameters
42
+
43
+ | Name | Type | Description |
44
+ | ---- | ---- | ----------- |
45
+ | **data** | **Mixed** | data to be matched against the list of oneOf items |
46
+
47
+ #### Return type
48
+
49
+ - `MmsMessageContent`
50
+ - `RbmMessageContentRichCard`
51
+ - `RbmMessageContentText`
52
+ - `RbmMessageMedia`
53
+ - `SmsMessageContent`
54
+ - `nil` (if no type matches)
55
+
@@ -0,0 +1,32 @@
1
+ # Bandwidth::MultiChannelMessageCallbackData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **message_id** | **String** | The ID of the message. | [optional] |
8
+ | **status** | [**MultiChannelStatusEnum**](MultiChannelStatusEnum.md) | | [optional] |
9
+ | **direction** | [**MultiChannelMessageDirectionEnum**](MultiChannelMessageDirectionEnum.md) | | [optional] |
10
+ | **from** | **String** | The sender ID of the message. This could be an alphanumeric sender ID. | [optional] |
11
+ | **to** | **String** | The phone number the message should be sent to in E164 format. | [optional] |
12
+ | **application_id** | **String** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. | [optional] |
13
+ | **channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [optional] |
14
+ | **tag** | **String** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'bandwidth-sdk'
20
+
21
+ instance = Bandwidth::MultiChannelMessageCallbackData.new(
22
+ message_id: 1589228074636lm4k2je7j7jklbn2,
23
+ status: null,
24
+ direction: null,
25
+ from: BandwidthRBM,
26
+ to: +15552223333,
27
+ application_id: 93de2206-9669-4e07-948d-329f4b722ee2,
28
+ channel: null,
29
+ tag: custom string
30
+ )
31
+ ```
32
+
@@ -0,0 +1,15 @@
1
+ # Bandwidth::MultiChannelMessageChannelEnum
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'bandwidth-sdk'
12
+
13
+ instance = Bandwidth::MultiChannelMessageChannelEnum.new()
14
+ ```
15
+
@@ -0,0 +1,34 @@
1
+ # Bandwidth::MultiChannelMessageData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **message_id** | **String** | The ID of the message. | [optional] |
8
+ | **status** | [**MultiChannelStatusEnum**](MultiChannelStatusEnum.md) | | [optional] |
9
+ | **time** | **Time** | The time the message was received by the Bandwidth API. | [optional] |
10
+ | **direction** | [**MultiChannelMessageDirectionEnum**](MultiChannelMessageDirectionEnum.md) | | [optional] |
11
+ | **from** | **String** | The sender ID of the message. This could be an alphanumeric sender ID. | [optional] |
12
+ | **to** | **String** | The phone number the message should be sent to in E164 format. | [optional] |
13
+ | **application_id** | **String** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. | [optional] |
14
+ | **channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [optional] |
15
+ | **tag** | **String** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'bandwidth-sdk'
21
+
22
+ instance = Bandwidth::MultiChannelMessageData.new(
23
+ message_id: 1589228074636lm4k2je7j7jklbn2,
24
+ status: null,
25
+ time: 2025-01-01T18:20:16Z,
26
+ direction: null,
27
+ from: BandwidthRBM,
28
+ to: +15552223333,
29
+ application_id: 93de2206-9669-4e07-948d-329f4b722ee2,
30
+ channel: null,
31
+ tag: custom string
32
+ )
33
+ ```
34
+
@@ -0,0 +1,15 @@
1
+ # Bandwidth::MultiChannelMessageDirectionEnum
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'bandwidth-sdk'
12
+
13
+ instance = Bandwidth::MultiChannelMessageDirectionEnum.new()
14
+ ```
15
+
@@ -0,0 +1,26 @@
1
+ # Bandwidth::MultiChannelMessageRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **to** | **String** | The phone number the message should be sent to in E164 format. | |
8
+ | **channel_list** | [**Array&lt;MultiChannelChannelListObject&gt;**](MultiChannelChannelListObject.md) | A list of message bodies. The messages will be attempted in the order they are listed. Once a message sends successfully, the others will be ignored. | |
9
+ | **tag** | **String** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] |
10
+ | **priority** | [**PriorityEnum**](PriorityEnum.md) | | [optional] |
11
+ | **expiration** | **Time** | A string with the date/time value that the message will automatically expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'bandwidth-sdk'
17
+
18
+ instance = Bandwidth::MultiChannelMessageRequest.new(
19
+ to: +15552223333,
20
+ channel_list: null,
21
+ tag: custom string,
22
+ priority: null,
23
+ expiration: 2021-02-01T11:29:18-05:00
24
+ )
25
+ ```
26
+
@@ -0,0 +1,15 @@
1
+ # Bandwidth::MultiChannelStatusEnum
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'bandwidth-sdk'
12
+
13
+ instance = Bandwidth::MultiChannelStatusEnum.new()
14
+ ```
15
+
@@ -0,0 +1,22 @@
1
+ # Bandwidth::RbmActionBase
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | |
8
+ | **text** | **String** | Displayed text for user to click | |
9
+ | **post_back_data** | **String** | Base64 payload the customer receives when the reply is clicked. | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'bandwidth-sdk'
15
+
16
+ instance = Bandwidth::RbmActionBase.new(
17
+ type: null,
18
+ text: Hello world,
19
+ post_back_data: [B@204c5ddf
20
+ )
21
+ ```
22
+
@@ -0,0 +1,24 @@
1
+ # Bandwidth::RbmActionDial
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | |
8
+ | **text** | **String** | Displayed text for user to click | |
9
+ | **post_back_data** | **String** | Base64 payload the customer receives when the reply is clicked. | |
10
+ | **phone_number** | **String** | The phone number to dial. Must be E164 format. | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'bandwidth-sdk'
16
+
17
+ instance = Bandwidth::RbmActionDial.new(
18
+ type: null,
19
+ text: Hello world,
20
+ post_back_data: U0dWc2JHOGdkMjl5YkdRPQ&#x3D;&#x3D;,
21
+ phone_number: +15552223333
22
+ )
23
+ ```
24
+