bandwidth-sdk 15.1.0 → 16.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.
- checksums.yaml +4 -4
- data/Gemfile.lock +11 -11
- data/README.md +17 -10
- data/bandwidth.yml +523 -184
- data/coverage/.last_run.json +1 -1
- data/coverage/.resultset.json +321 -366
- data/coverage/index.html +10047 -10501
- data/custom_templates/README.mustache +1 -1
- data/docs/BlockedWebhook.md +2 -2
- data/docs/Callback.md +84 -0
- data/docs/CreateMultiChannelMessageResponse.md +3 -3
- data/docs/ErrorObject.md +6 -4
- data/docs/ErrorSource.md +24 -0
- data/docs/FailureWebhook.md +2 -2
- data/docs/InboundCallback.md +28 -0
- data/docs/InboundCallbackMessage.md +48 -0
- data/docs/{MultiChannelStatusEnum.md → InboundCallbackTypeEnum.md} +2 -2
- data/docs/ListMessageItem.md +1 -1
- data/docs/Message.md +5 -5
- data/docs/MessageRequest.md +1 -1
- data/docs/MmsMessageContent.md +2 -2
- data/docs/MmsMessageContentFile.md +18 -0
- data/docs/MultiChannelActionCalendarEvent.md +2 -2
- data/docs/MultiChannelError.md +22 -0
- data/docs/MultiChannelMessageContent.md +20 -0
- data/docs/MultiChannelMessageResponseData.md +32 -0
- data/docs/MultiChannelMessageResponseDataChannelListInner.md +26 -0
- data/docs/RbmActionBase.md +2 -2
- data/docs/RbmActionDial.md +2 -2
- data/docs/RbmActionOpenUrl.md +2 -2
- data/docs/RbmActionViewLocation.md +2 -2
- data/docs/RbmLocationResponse.md +20 -0
- data/docs/RbmSuggestionResponse.md +20 -0
- data/docs/StatusCallback.md +32 -0
- data/docs/StatusCallbackMessage.md +42 -0
- data/docs/{CallbackTypeEnum.md → StatusCallbackTypeEnum.md} +2 -2
- data/docs/TfvStatus.md +2 -2
- data/docs/TfvSubmissionInfo.md +3 -3
- data/docs/TollFreeVerificationApi.md +72 -0
- data/docs/VerificationDenialWebhook.md +2 -2
- data/docs/VerificationRequest.md +3 -3
- data/docs/VerificationUpdateRequest.md +3 -3
- data/lib/bandwidth-sdk/api/toll_free_verification_api.rb +82 -0
- data/lib/bandwidth-sdk/configuration.rb +6 -0
- data/lib/bandwidth-sdk/models/blocked_webhook.rb +2 -2
- data/lib/bandwidth-sdk/models/callback.rb +60 -0
- data/lib/bandwidth-sdk/models/create_multi_channel_message_response.rb +1 -1
- data/lib/bandwidth-sdk/models/error_object.rb +45 -13
- data/lib/bandwidth-sdk/models/error_source.rb +244 -0
- data/lib/bandwidth-sdk/models/failure_webhook.rb +7 -7
- data/lib/bandwidth-sdk/models/{message_callback.rb → inbound_callback.rb} +9 -20
- data/lib/bandwidth-sdk/models/inbound_callback_message.rb +454 -0
- data/lib/bandwidth-sdk/models/{multi_channel_message_direction_enum.rb → inbound_callback_type_enum.rb} +7 -6
- data/lib/bandwidth-sdk/models/list_message_item.rb +1 -1
- data/lib/bandwidth-sdk/models/message.rb +3 -3
- data/lib/bandwidth-sdk/models/message_request.rb +1 -1
- data/lib/bandwidth-sdk/models/mms_message_content.rb +1 -2
- data/lib/bandwidth-sdk/models/{multi_channel_message_callback_data.rb → mms_message_content_file.rb} +37 -100
- data/lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb +21 -21
- data/lib/bandwidth-sdk/models/multi_channel_error.rb +235 -0
- data/lib/bandwidth-sdk/models/{deferred_result.rb → multi_channel_message_content.rb} +17 -16
- data/lib/bandwidth-sdk/models/multi_channel_message_response_data.rb +372 -0
- data/lib/bandwidth-sdk/models/{multi_channel_message_data.rb → multi_channel_message_response_data_channel_list_inner.rb} +62 -59
- data/lib/bandwidth-sdk/models/rbm_action_base.rb +21 -21
- data/lib/bandwidth-sdk/models/rbm_action_dial.rb +21 -21
- data/lib/bandwidth-sdk/models/rbm_action_open_url.rb +21 -21
- data/lib/bandwidth-sdk/models/rbm_action_view_location.rb +21 -21
- data/lib/bandwidth-sdk/models/{tag.rb → rbm_location_response.rb} +18 -16
- data/lib/bandwidth-sdk/models/{multi_channel_callback_data.rb → rbm_suggestion_response.rb} +37 -67
- data/lib/bandwidth-sdk/models/status_callback.rb +338 -0
- data/lib/bandwidth-sdk/models/{message_callback_message.rb → status_callback_message.rb} +25 -17
- data/lib/bandwidth-sdk/models/{callback_type_enum.rb → status_callback_type_enum.rb} +5 -5
- data/lib/bandwidth-sdk/models/tfv_status.rb +2 -2
- data/lib/bandwidth-sdk/models/tfv_submission_info.rb +3 -3
- data/lib/bandwidth-sdk/models/verification_denial_webhook.rb +2 -2
- data/lib/bandwidth-sdk/models/verification_request.rb +3 -3
- data/lib/bandwidth-sdk/models/verification_update_request.rb +3 -3
- data/lib/bandwidth-sdk/version.rb +1 -1
- data/lib/bandwidth-sdk.rb +15 -9
- data/spec/smoke/multi_channel_api_spec.rb +18 -20
- data/spec/smoke/toll_free_verification_api_spec.rb +7 -0
- data/spec/unit/api/toll_free_verification_api_spec.rb +8 -0
- data/spec/unit/client/api_client_spec.rb +4 -4
- data/spec/unit/models/tfv_error_spec.rb +78 -0
- data/spec/unit/models/verify_code_response_spec.rb +70 -0
- metadata +112 -100
- data/docs/DeferredResult.md +0 -20
- data/docs/MessageCallback.md +0 -30
- data/docs/MessageCallbackMessage.md +0 -40
- data/docs/MultiChannelCallbackData.md +0 -26
- data/docs/MultiChannelMessageCallbackData.md +0 -32
- data/docs/MultiChannelMessageData.md +0 -34
- data/docs/MultiChannelMessageDirectionEnum.md +0 -15
- data/docs/Tag.md +0 -20
- data/lib/bandwidth-sdk/models/multi_channel_status_enum.rb +0 -42
- data/spec/unit/models/deferred_result_spec.rb +0 -74
- /data/coverage/assets/{0.13.1 → 0.13.2}/DataTables-1.10.20/images/sort_asc.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/DataTables-1.10.20/images/sort_asc_disabled.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/DataTables-1.10.20/images/sort_both.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/DataTables-1.10.20/images/sort_desc.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/DataTables-1.10.20/images/sort_desc_disabled.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/application.css +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/application.js +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/colorbox/border.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/colorbox/controls.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/colorbox/loading.gif +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/colorbox/loading_background.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/favicon_green.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/favicon_red.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/favicon_yellow.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/images/ui-bg_flat_0_aaaaaa_40x100.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/images/ui-bg_flat_75_ffffff_40x100.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/images/ui-bg_glass_55_fbf9ee_1x400.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/images/ui-bg_glass_65_ffffff_1x400.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/images/ui-bg_glass_75_dadada_1x400.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/images/ui-bg_glass_75_e6e6e6_1x400.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/images/ui-bg_glass_95_fef1ec_1x400.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/images/ui-bg_highlight-soft_75_cccccc_1x100.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/images/ui-icons_222222_256x240.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/images/ui-icons_2e83ff_256x240.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/images/ui-icons_454545_256x240.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/images/ui-icons_888888_256x240.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/images/ui-icons_cd0a0a_256x240.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/loading.gif +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/magnify.png +0 -0
@@ -7,8 +7,8 @@
|
|
7
7
|
|
8
8
|
| **OS** | **Ruby** |
|
9
9
|
|:------------:|:------------------:|
|
10
|
-
| Windows 2019 | 3.0, 3.1, 3.2, 3.3 |
|
11
10
|
| Windows 2022 | 3.0, 3.1, 3.2, 3.3 |
|
11
|
+
| Windows 2025 | 3.0, 3.1, 3.2, 3.3 |
|
12
12
|
| Ubuntu 22.04 | 3.0, 3.1, 3.2, 3.3 |
|
13
13
|
| Ubuntu 24.04 | 3.0, 3.1, 3.2, 3.3 |
|
14
14
|
|
data/docs/BlockedWebhook.md
CHANGED
@@ -8,8 +8,8 @@
|
|
8
8
|
| **phone_number** | **String** | Toll-free telephone number in E.164 format. | [optional] |
|
9
9
|
| **status** | [**TfvCallbackStatusEnum**](TfvCallbackStatusEnum.md) | | [optional] |
|
10
10
|
| **internal_ticket_number** | **String** | Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number. | [optional] |
|
11
|
-
| **blocked** | **Boolean** | Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked.
|
12
|
-
| **blocked_reason** | **String** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked.
|
11
|
+
| **blocked** | **Boolean** | Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. | [optional] |
|
12
|
+
| **blocked_reason** | **String** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. | [optional] |
|
13
13
|
|
14
14
|
## Example
|
15
15
|
|
data/docs/Callback.md
ADDED
@@ -0,0 +1,84 @@
|
|
1
|
+
# Bandwidth::Callback
|
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::Callback.openapi_one_of
|
15
|
+
# =>
|
16
|
+
# [
|
17
|
+
# :'InboundCallback',
|
18
|
+
# :'StatusCallback'
|
19
|
+
# ]
|
20
|
+
```
|
21
|
+
|
22
|
+
### `openapi_discriminator_name`
|
23
|
+
|
24
|
+
Returns the discriminator's property name.
|
25
|
+
|
26
|
+
#### Example
|
27
|
+
|
28
|
+
```ruby
|
29
|
+
require 'bandwidth-sdk'
|
30
|
+
|
31
|
+
Bandwidth::Callback.openapi_discriminator_name
|
32
|
+
# => :'type'
|
33
|
+
```
|
34
|
+
|
35
|
+
### `openapi_discriminator_name`
|
36
|
+
|
37
|
+
Returns the discriminator's mapping.
|
38
|
+
|
39
|
+
#### Example
|
40
|
+
|
41
|
+
```ruby
|
42
|
+
require 'bandwidth-sdk'
|
43
|
+
|
44
|
+
Bandwidth::Callback.openapi_discriminator_mapping
|
45
|
+
# =>
|
46
|
+
# {
|
47
|
+
# :'message-delivered' => :'StatusCallback',
|
48
|
+
# :'message-failed' => :'StatusCallback',
|
49
|
+
# :'message-read' => :'StatusCallback',
|
50
|
+
# :'message-received' => :'InboundCallback',
|
51
|
+
# :'message-sent' => :'StatusCallback',
|
52
|
+
# :'request-location-response' => :'InboundCallback',
|
53
|
+
# :'suggestion-response' => :'InboundCallback'
|
54
|
+
# }
|
55
|
+
```
|
56
|
+
|
57
|
+
### build
|
58
|
+
|
59
|
+
Find the appropriate object from the `openapi_one_of` list and casts the data into it.
|
60
|
+
|
61
|
+
#### Example
|
62
|
+
|
63
|
+
```ruby
|
64
|
+
require 'bandwidth-sdk'
|
65
|
+
|
66
|
+
Bandwidth::Callback.build(data)
|
67
|
+
# => #<InboundCallback:0x00007fdd4aab02a0>
|
68
|
+
|
69
|
+
Bandwidth::Callback.build(data_that_doesnt_match)
|
70
|
+
# => nil
|
71
|
+
```
|
72
|
+
|
73
|
+
#### Parameters
|
74
|
+
|
75
|
+
| Name | Type | Description |
|
76
|
+
| ---- | ---- | ----------- |
|
77
|
+
| **data** | **Mixed** | data to be matched against the list of oneOf items |
|
78
|
+
|
79
|
+
#### Return type
|
80
|
+
|
81
|
+
- `InboundCallback`
|
82
|
+
- `StatusCallback`
|
83
|
+
- `nil` (if no type matches)
|
84
|
+
|
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **links** | [**Array<Link>**](Link.md) | | [optional] |
|
8
|
-
| **data** | [**
|
8
|
+
| **data** | [**MultiChannelMessageResponseData**](MultiChannelMessageResponseData.md) | | [optional] |
|
9
9
|
| **errors** | [**Array<ErrorObject>**](ErrorObject.md) | | [optional] |
|
10
10
|
|
11
11
|
## Example
|
@@ -14,9 +14,9 @@
|
|
14
14
|
require 'bandwidth-sdk'
|
15
15
|
|
16
16
|
instance = Bandwidth::CreateMultiChannelMessageResponse.new(
|
17
|
-
links:
|
17
|
+
links: [],
|
18
18
|
data: null,
|
19
|
-
errors:
|
19
|
+
errors: []
|
20
20
|
)
|
21
21
|
```
|
22
22
|
|
data/docs/ErrorObject.md
CHANGED
@@ -4,8 +4,9 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **
|
8
|
-
| **
|
7
|
+
| **type** | **String** | A concise summary of the error used for categorization. | |
|
8
|
+
| **description** | **String** | A detailed explanation of the error. | |
|
9
|
+
| **source** | [**ErrorSource**](ErrorSource.md) | | |
|
9
10
|
|
10
11
|
## Example
|
11
12
|
|
@@ -13,8 +14,9 @@
|
|
13
14
|
require 'bandwidth-sdk'
|
14
15
|
|
15
16
|
instance = Bandwidth::ErrorObject.new(
|
16
|
-
|
17
|
-
|
17
|
+
type: null,
|
18
|
+
description: null,
|
19
|
+
source: null
|
18
20
|
)
|
19
21
|
```
|
20
22
|
|
data/docs/ErrorSource.md
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
# Bandwidth::ErrorSource
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **parameter** | **String** | The relevant URI query parameter causing the error | [optional] |
|
8
|
+
| **field** | **String** | The request body field that led to the error | [optional] |
|
9
|
+
| **header** | **String** | The header field that contributed to the error | [optional] |
|
10
|
+
| **reference** | **String** | A resource ID or path linked to the error | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'bandwidth-sdk'
|
16
|
+
|
17
|
+
instance = Bandwidth::ErrorSource.new(
|
18
|
+
parameter: null,
|
19
|
+
field: null,
|
20
|
+
header: null,
|
21
|
+
reference: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/FailureWebhook.md
CHANGED
@@ -7,7 +7,7 @@
|
|
7
7
|
| **account_id** | **String** | User's account ID. | [optional] |
|
8
8
|
| **phone_number** | **String** | Toll-free telephone number in E.164 format. | [optional] |
|
9
9
|
| **error_code** | **String** | An error code indicating what error was encountered. This code can be interpreted as an HTTP status code in regards to the error that was encountered. | [optional] |
|
10
|
-
| **
|
10
|
+
| **error_message** | **String** | A description of the error that was encountered. | [optional] |
|
11
11
|
| **errors** | **Array<String>** | Details of the errors that were encountered when processing the request. | [optional] |
|
12
12
|
| **internal_ticket_number** | **String** | Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number. | [optional] |
|
13
13
|
|
@@ -20,7 +20,7 @@ instance = Bandwidth::FailureWebhook.new(
|
|
20
20
|
account_id: 1234567,
|
21
21
|
phone_number: +18005555555,
|
22
22
|
error_code: 400,
|
23
|
-
|
23
|
+
error_message: cannot process request.,
|
24
24
|
errors: null,
|
25
25
|
internal_ticket_number: acde070d-8c4c-4f0d-9d8a-162843c10333
|
26
26
|
)
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# Bandwidth::InboundCallback
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **time** | **Time** | | |
|
8
|
+
| **type** | [**InboundCallbackTypeEnum**](InboundCallbackTypeEnum.md) | | |
|
9
|
+
| **to** | **String** | The destination phone number the message was sent to. For inbound callbacks, this is the Bandwidth number or alphanumeric identifier that received the message. | |
|
10
|
+
| **description** | **String** | A detailed description of the event described by the callback. | |
|
11
|
+
| **message** | [**InboundCallbackMessage**](InboundCallbackMessage.md) | | |
|
12
|
+
| **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. This field is present only when this account feature has been enabled. | [optional] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'bandwidth-sdk'
|
18
|
+
|
19
|
+
instance = Bandwidth::InboundCallback.new(
|
20
|
+
time: 2024-12-02T20:15:57.278Z,
|
21
|
+
type: null,
|
22
|
+
to: +15552223333,
|
23
|
+
description: Incoming message received,
|
24
|
+
message: null,
|
25
|
+
carrier_name: AT&T
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
@@ -0,0 +1,48 @@
|
|
1
|
+
# Bandwidth::InboundCallbackMessage
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | A unique identifier of the message. | |
|
8
|
+
| **owner** | **String** | The Bandwidth phone number or alphanumeric identifier associated with the message. | |
|
9
|
+
| **application_id** | **String** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. | |
|
10
|
+
| **time** | **Time** | | |
|
11
|
+
| **segment_count** | **Integer** | The number of segments the user's message is broken into before sending over carrier networks. | |
|
12
|
+
| **direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) | | |
|
13
|
+
| **to** | **Array<String>** | The phone number recipients of the message. | |
|
14
|
+
| **from** | **String** | The Bandwidth phone number or alphanumeric identifier the message was sent from. | |
|
15
|
+
| **text** | **String** | | [optional] |
|
16
|
+
| **tag** | **String** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] |
|
17
|
+
| **media** | **Array<String>** | Optional media, not applicable for sms | [optional] |
|
18
|
+
| **priority** | [**PriorityEnum**](PriorityEnum.md) | | [optional] |
|
19
|
+
| **channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [optional] |
|
20
|
+
| **content** | [**MultiChannelMessageContent**](MultiChannelMessageContent.md) | | [optional] |
|
21
|
+
| **suggestion_response** | [**RbmSuggestionResponse**](RbmSuggestionResponse.md) | | [optional] |
|
22
|
+
| **location_response** | [**RbmLocationResponse**](RbmLocationResponse.md) | | [optional] |
|
23
|
+
|
24
|
+
## Example
|
25
|
+
|
26
|
+
```ruby
|
27
|
+
require 'bandwidth-sdk'
|
28
|
+
|
29
|
+
instance = Bandwidth::InboundCallbackMessage.new(
|
30
|
+
id: 1661365814859loidf7mcwd4qacn7,
|
31
|
+
owner: +15553332222,
|
32
|
+
application_id: 93de2206-9669-4e07-948d-329f4b722ee2,
|
33
|
+
time: 2024-12-02T20:15:57.666Z,
|
34
|
+
segment_count: 1,
|
35
|
+
direction: null,
|
36
|
+
to: [+15552223333],
|
37
|
+
from: +15553332222,
|
38
|
+
text: Hello world,
|
39
|
+
tag: custom string,
|
40
|
+
media: [https://dev.bandwidth.com/images/bandwidth-logo.png, https://dev.bandwidth.com/images/github_logo.png],
|
41
|
+
priority: null,
|
42
|
+
channel: null,
|
43
|
+
content: null,
|
44
|
+
suggestion_response: null,
|
45
|
+
location_response: null
|
46
|
+
)
|
47
|
+
```
|
48
|
+
|
@@ -1,4 +1,4 @@
|
|
1
|
-
# Bandwidth::
|
1
|
+
# Bandwidth::InboundCallbackTypeEnum
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
@@ -10,6 +10,6 @@
|
|
10
10
|
```ruby
|
11
11
|
require 'bandwidth-sdk'
|
12
12
|
|
13
|
-
instance = Bandwidth::
|
13
|
+
instance = Bandwidth::InboundCallbackTypeEnum.new()
|
14
14
|
```
|
15
15
|
|
data/docs/ListMessageItem.md
CHANGED
@@ -11,7 +11,7 @@
|
|
11
11
|
| **message_status** | [**MessageStatusEnum**](MessageStatusEnum.md) | | [optional] |
|
12
12
|
| **message_direction** | [**ListMessageDirectionEnum**](ListMessageDirectionEnum.md) | | [optional] |
|
13
13
|
| **message_type** | [**MessageTypeEnum**](MessageTypeEnum.md) | | [optional] |
|
14
|
-
| **segment_count** | **Integer** | The number of segments the message
|
14
|
+
| **segment_count** | **Integer** | The number of segments the user's message is broken into before sending over carrier networks. | [optional] |
|
15
15
|
| **error_code** | **Integer** | The numeric error code of the message. | [optional] |
|
16
16
|
| **receive_time** | **Time** | The ISO 8601 datetime of the message. | [optional] |
|
17
17
|
| **carrier_name** | **String** | The name of the carrier. Not currently supported for MMS coming soon. | [optional] |
|
data/docs/Message.md
CHANGED
@@ -6,15 +6,15 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | The id of the message. | [optional] |
|
8
8
|
| **owner** | **String** | The Bandwidth phone number associated with the message. | [optional] |
|
9
|
-
| **application_id** | **String** | The
|
9
|
+
| **application_id** | **String** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. | [optional] |
|
10
10
|
| **time** | **Time** | The datetime stamp of the message in ISO 8601 | [optional] |
|
11
|
-
| **segment_count** | **Integer** | The number of segments the
|
11
|
+
| **segment_count** | **Integer** | The number of segments the user's message is broken into before sending over carrier networks. | [optional] |
|
12
12
|
| **direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) | | [optional] |
|
13
13
|
| **to** | **Array<String>** | The phone number recipients of the message. | [optional] |
|
14
14
|
| **from** | **String** | The phone number the message was sent from. | [optional] |
|
15
15
|
| **media** | **Array<String>** | The list of media URLs sent in the message. Including a `filename` field in the `Content-Disposition` header of the media linked with a URL will set the displayed file name. This is a best practice to ensure that your media has a readable file name. | [optional] |
|
16
16
|
| **text** | **String** | The contents of the message. | [optional] |
|
17
|
-
| **tag** | **String** |
|
17
|
+
| **tag** | **String** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] |
|
18
18
|
| **priority** | [**PriorityEnum**](PriorityEnum.md) | | [optional] |
|
19
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
|
|
@@ -28,13 +28,13 @@ instance = Bandwidth::Message.new(
|
|
28
28
|
owner: +15554443333,
|
29
29
|
application_id: 93de2206-9669-4e07-948d-329f4b722ee2,
|
30
30
|
time: 2024-12-02T20:15:57.278Z,
|
31
|
-
segment_count:
|
31
|
+
segment_count: 1,
|
32
32
|
direction: null,
|
33
33
|
to: ["+15552223333"],
|
34
34
|
from: +15553332222,
|
35
35
|
media: ["https://dev.bandwidth.com/images/bandwidth-logo.png"],
|
36
36
|
text: Hello world,
|
37
|
-
tag: custom
|
37
|
+
tag: custom string,
|
38
38
|
priority: null,
|
39
39
|
expiration: 2021-02-01T11:29:18-05:00
|
40
40
|
)
|
data/docs/MessageRequest.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **application_id** | **String** | The ID of the Application your from number is associated with in the Bandwidth Phone Number Dashboard. | |
|
7
|
+
| **application_id** | **String** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. | |
|
8
8
|
| **to** | **Array<String>** | The phone number(s) the message should be sent to in E164 format. | |
|
9
9
|
| **from** | **String** | Either an alphanumeric sender ID or the sender's Bandwidth phone number in E.164 format, which must be hosted within Bandwidth and linked to the account that is generating the message. Alphanumeric Sender IDs can contain up to 11 characters, upper-case letters A-Z, lower-case letters a-z, numbers 0-9, space, hyphen -, plus +, underscore _ and ampersand &. Alphanumeric Sender IDs must contain at least one letter. | |
|
10
10
|
| **text** | **String** | The contents of the text message. Must be 2048 characters or less. | [optional] |
|
data/docs/MmsMessageContent.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **text** | **String** | The contents of the text message. Must be 2048 characters or less. | [optional] |
|
8
|
-
| **media** | **Array<
|
8
|
+
| **media** | [**Array<MmsMessageContentFile>**](MmsMessageContentFile.md) | | [optional] |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
@@ -14,7 +14,7 @@ require 'bandwidth-sdk'
|
|
14
14
|
|
15
15
|
instance = Bandwidth::MmsMessageContent.new(
|
16
16
|
text: Hello world,
|
17
|
-
media:
|
17
|
+
media: null
|
18
18
|
)
|
19
19
|
```
|
20
20
|
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# Bandwidth::MmsMessageContentFile
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **file_url** | **String** | The URL of a media attachment. For MMS, the API limits file size to 3.5MB. Specific carriers and channels may have a smaller limit that could cause a large file to fail, see [here](https://support.bandwidth.com/hc/en-us/articles/360014235473-What-are-the-MMS-file-size-limits) for more details. | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'bandwidth-sdk'
|
13
|
+
|
14
|
+
instance = Bandwidth::MmsMessageContentFile.new(
|
15
|
+
file_url: https://dev.bandwidth.com/images/bandwidth-logo.png
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -6,7 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | |
|
8
8
|
| **text** | **String** | Displayed text for user to click | |
|
9
|
-
| **
|
9
|
+
| **postback_data** | **String** | Base64 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. | |
|
12
12
|
| **end_time** | **Time** | The end time of the event. | |
|
@@ -20,7 +20,7 @@ require 'bandwidth-sdk'
|
|
20
20
|
instance = Bandwidth::MultiChannelActionCalendarEvent.new(
|
21
21
|
type: null,
|
22
22
|
text: Hello world,
|
23
|
-
|
23
|
+
postback_data: U0dWc2JHOGdkMjl5YkdRPQ==,
|
24
24
|
title: Meeting with John,
|
25
25
|
start_time: 2022-09-14T18:20:16Z,
|
26
26
|
end_time: 2022-09-14T18:20:16Z,
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# Bandwidth::MultiChannelError
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **links** | [**Array<Link>**](Link.md) | | [optional] |
|
8
|
+
| **data** | **Object** | | [optional] |
|
9
|
+
| **errors** | [**Array<ErrorObject>**](ErrorObject.md) | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'bandwidth-sdk'
|
15
|
+
|
16
|
+
instance = Bandwidth::MultiChannelError.new(
|
17
|
+
links: [],
|
18
|
+
data: null,
|
19
|
+
errors: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# Bandwidth::MultiChannelMessageContent
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **text** | **String** | | [optional] |
|
8
|
+
| **media** | [**RbmMessageContentFile**](RbmMessageContentFile.md) | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'bandwidth-sdk'
|
14
|
+
|
15
|
+
instance = Bandwidth::MultiChannelMessageContent.new(
|
16
|
+
text: null,
|
17
|
+
media: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,32 @@
|
|
1
|
+
# Bandwidth::MultiChannelMessageResponseData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **message_id** | **String** | The ID of the message. | |
|
8
|
+
| **time** | **Time** | The time the message was received by the Bandwidth API. | |
|
9
|
+
| **direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) | | |
|
10
|
+
| **to** | **Array<String>** | The destination phone number(s) of the message, in E164 format. | |
|
11
|
+
| **channel_list** | [**Array<MultiChannelMessageResponseDataChannelListInner>**](MultiChannelMessageResponseDataChannelListInner.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. | |
|
12
|
+
| **tag** | **String** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] |
|
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. | [optional] |
|
15
|
+
|
16
|
+
## Example
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
require 'bandwidth-sdk'
|
20
|
+
|
21
|
+
instance = Bandwidth::MultiChannelMessageResponseData.new(
|
22
|
+
message_id: 1589228074636lm4k2je7j7jklbn2,
|
23
|
+
time: 2025-01-01T18:20:16Z,
|
24
|
+
direction: null,
|
25
|
+
to: ["+15554443333"],
|
26
|
+
channel_list: null,
|
27
|
+
tag: custom string,
|
28
|
+
priority: null,
|
29
|
+
expiration: 2021-02-01T11:29:18-05:00
|
30
|
+
)
|
31
|
+
```
|
32
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# Bandwidth::MultiChannelMessageResponseDataChannelListInner
|
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
|
+
| **owner** | **String** | The Bandwidth senderId associated with the message. Identical to 'from'. | |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'bandwidth-sdk'
|
17
|
+
|
18
|
+
instance = Bandwidth::MultiChannelMessageResponseDataChannelListInner.new(
|
19
|
+
from: BandwidthRBM,
|
20
|
+
application_id: 93de2206-9669-4e07-948d-329f4b722ee2,
|
21
|
+
channel: null,
|
22
|
+
content: null,
|
23
|
+
owner: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
data/docs/RbmActionBase.md
CHANGED
@@ -6,7 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | |
|
8
8
|
| **text** | **String** | Displayed text for user to click | |
|
9
|
-
| **
|
9
|
+
| **postback_data** | **String** | Base64 payload the customer receives when the reply is clicked. | |
|
10
10
|
|
11
11
|
## Example
|
12
12
|
|
@@ -16,7 +16,7 @@ require 'bandwidth-sdk'
|
|
16
16
|
instance = Bandwidth::RbmActionBase.new(
|
17
17
|
type: null,
|
18
18
|
text: Hello world,
|
19
|
-
|
19
|
+
postback_data: [B@2c6aa46c
|
20
20
|
)
|
21
21
|
```
|
22
22
|
|
data/docs/RbmActionDial.md
CHANGED
@@ -6,7 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | |
|
8
8
|
| **text** | **String** | Displayed text for user to click | |
|
9
|
-
| **
|
9
|
+
| **postback_data** | **String** | Base64 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
|
@@ -17,7 +17,7 @@ require 'bandwidth-sdk'
|
|
17
17
|
instance = Bandwidth::RbmActionDial.new(
|
18
18
|
type: null,
|
19
19
|
text: Hello world,
|
20
|
-
|
20
|
+
postback_data: U0dWc2JHOGdkMjl5YkdRPQ==,
|
21
21
|
phone_number: +15552223333
|
22
22
|
)
|
23
23
|
```
|
data/docs/RbmActionOpenUrl.md
CHANGED
@@ -6,7 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | |
|
8
8
|
| **text** | **String** | Displayed text for user to click | |
|
9
|
-
| **
|
9
|
+
| **postback_data** | **String** | Base64 payload the customer receives when the reply is clicked. | |
|
10
10
|
| **url** | **String** | The URL to open in browser. | |
|
11
11
|
|
12
12
|
## Example
|
@@ -17,7 +17,7 @@ require 'bandwidth-sdk'
|
|
17
17
|
instance = Bandwidth::RbmActionOpenUrl.new(
|
18
18
|
type: null,
|
19
19
|
text: Hello world,
|
20
|
-
|
20
|
+
postback_data: U0dWc2JHOGdkMjl5YkdRPQ==,
|
21
21
|
url: https://dev.bandwidth.com
|
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
|
-
| **
|
9
|
+
| **postback_data** | **String** | Base64 payload the customer receives when the reply is clicked. | |
|
10
10
|
| **latitude** | **Float** | The latitude of the location. | |
|
11
11
|
| **longitude** | **Float** | The longitude of the location. | |
|
12
12
|
| **label** | **String** | The label of the location. | [optional] |
|
@@ -19,7 +19,7 @@ require 'bandwidth-sdk'
|
|
19
19
|
instance = Bandwidth::RbmActionViewLocation.new(
|
20
20
|
type: null,
|
21
21
|
text: Hello world,
|
22
|
-
|
22
|
+
postback_data: U0dWc2JHOGdkMjl5YkdRPQ==,
|
23
23
|
latitude: 37.7749,
|
24
24
|
longitude: -122.4194,
|
25
25
|
label: San Francisco
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# Bandwidth::RbmLocationResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **latitude** | **Float** | The latitude of the client's location. | [optional] |
|
8
|
+
| **longitude** | **Float** | The longitude of the client's location. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'bandwidth-sdk'
|
14
|
+
|
15
|
+
instance = Bandwidth::RbmLocationResponse.new(
|
16
|
+
latitude: 37.7749,
|
17
|
+
longitude: -122.4194
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# Bandwidth::RbmSuggestionResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
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] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'bandwidth-sdk'
|
14
|
+
|
15
|
+
instance = Bandwidth::RbmSuggestionResponse.new(
|
16
|
+
text: Yes, I would like to proceed,
|
17
|
+
postback_data: [B@2c6aa46c
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,32 @@
|
|
1
|
+
# Bandwidth::StatusCallback
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **time** | **Time** | | |
|
8
|
+
| **event_time** | **Time** | Represents the time at which the message was read, for `message-read` callbacks. | [optional] |
|
9
|
+
| **type** | [**StatusCallbackTypeEnum**](StatusCallbackTypeEnum.md) | | |
|
10
|
+
| **to** | **String** | The destination phone number the message was sent to. For status callbacks, this the the Bandwidth user's client phone number. | |
|
11
|
+
| **description** | **String** | A detailed description of the event described by the callback. | |
|
12
|
+
| **message** | [**StatusCallbackMessage**](StatusCallbackMessage.md) | | |
|
13
|
+
| **error_code** | **Integer** | Optional error code, applicable only when type is `message-failed`. | [optional] |
|
14
|
+
| **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. This field is present only when this account feature has been enabled. | [optional] |
|
15
|
+
|
16
|
+
## Example
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
require 'bandwidth-sdk'
|
20
|
+
|
21
|
+
instance = Bandwidth::StatusCallback.new(
|
22
|
+
time: 2024-12-02T20:15:57.278Z,
|
23
|
+
event_time: 2024-12-02T20:15:58.278Z,
|
24
|
+
type: null,
|
25
|
+
to: +15552223333,
|
26
|
+
description: Message delivered to carrier.,
|
27
|
+
message: null,
|
28
|
+
error_code: 4405,
|
29
|
+
carrier_name: AT&T
|
30
|
+
)
|
31
|
+
```
|
32
|
+
|