bandwidth-sdk 13.1.4 → 14.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +15 -12
- data/README.md +45 -18
- data/bandwidth-sdk.gemspec +1 -1
- data/bandwidth.yml +1638 -589
- data/coverage/.last_run.json +1 -1
- data/coverage/.resultset.json +1388 -420
- data/coverage/index.html +20846 -10460
- data/custom_templates/README.mustache +6 -6
- data/custom_templates/gemspec.mustache +1 -1
- data/docs/AdditionalDenialReason.md +22 -0
- data/docs/Address.md +30 -0
- data/docs/CallbackTypeEnum.md +15 -0
- data/docs/Contact.md +24 -0
- data/docs/Error.md +22 -0
- data/docs/FailureWebhook.md +28 -0
- data/docs/LinksObject.md +24 -0
- data/docs/MediaApi.md +1 -1
- data/docs/Message.md +1 -1
- data/docs/MessageCallback.md +28 -0
- data/docs/MessageCallbackMessage.md +40 -0
- data/docs/OptInWorkflow.md +20 -0
- data/docs/TelephoneNumber.md +18 -0
- data/docs/TfvBasicAuthentication.md +20 -0
- data/docs/TfvCallbackStatusEnum.md +15 -0
- data/docs/TfvError.md +22 -0
- data/docs/TfvStatus.md +32 -0
- data/docs/TfvStatusEnum.md +15 -0
- data/docs/TfvSubmissionInfo.md +34 -0
- data/docs/TfvSubmissionWrapper.md +18 -0
- data/docs/TollFreeVerificationApi.md +585 -0
- data/docs/VerificationDenialWebhook.md +32 -0
- data/docs/VerificationRequest.md +36 -0
- data/docs/VerificationUpdateRequest.md +34 -0
- data/docs/VerificationWebhook.md +24 -0
- data/docs/WebhookSubscription.md +30 -0
- data/docs/WebhookSubscriptionBasicAuthentication.md +20 -0
- data/docs/WebhookSubscriptionRequestSchema.md +22 -0
- data/docs/WebhookSubscriptionTypeEnum.md +15 -0
- data/docs/WebhookSubscriptionsListBody.md +22 -0
- data/lib/bandwidth-sdk/api/media_api.rb +1 -1
- data/lib/bandwidth-sdk/api/toll_free_verification_api.rb +614 -0
- data/lib/bandwidth-sdk/configuration.rb +48 -0
- data/lib/bandwidth-sdk/models/additional_denial_reason.rb +254 -0
- data/lib/bandwidth-sdk/models/address.rb +501 -0
- data/lib/bandwidth-sdk/models/callback_type_enum.rb +42 -0
- data/lib/bandwidth-sdk/models/contact.rb +393 -0
- data/lib/bandwidth-sdk/models/error.rb +232 -0
- data/lib/bandwidth-sdk/models/failure_webhook.rb +304 -0
- data/lib/bandwidth-sdk/models/{transcription_metadata.rb → links_object.rb} +34 -35
- data/lib/bandwidth-sdk/models/{message_failed_callback.rb → message_callback.rb} +31 -13
- data/lib/bandwidth-sdk/models/{inbound_message_callback_message.rb → message_callback_message.rb} +6 -4
- data/lib/bandwidth-sdk/models/{inbound_message_callback.rb → opt_in_workflow.rb} +42 -61
- data/lib/bandwidth-sdk/models/telephone_number.rb +213 -0
- data/lib/bandwidth-sdk/models/{message_delivered_callback.rb → tfv_basic_authentication.rb} +58 -69
- data/lib/bandwidth-sdk/models/tfv_callback_status_enum.rb +40 -0
- data/lib/bandwidth-sdk/models/{message_sending_callback.rb → tfv_error.rb} +12 -64
- data/lib/bandwidth-sdk/models/{message_delivered_callback_message.rb → tfv_status.rb} +86 -162
- data/lib/bandwidth-sdk/models/tfv_status_enum.rb +43 -0
- data/lib/bandwidth-sdk/models/tfv_submission_info.rb +452 -0
- data/lib/bandwidth-sdk/models/{transcription_list.rb → tfv_submission_wrapper.rb} +12 -14
- data/lib/bandwidth-sdk/models/verification_denial_webhook.rb +325 -0
- data/lib/bandwidth-sdk/models/verification_request.rb +547 -0
- data/lib/bandwidth-sdk/models/verification_update_request.rb +501 -0
- data/lib/bandwidth-sdk/models/verification_webhook.rb +303 -0
- data/lib/bandwidth-sdk/models/{message_failed_callback_message.rb → webhook_subscription.rb} +68 -158
- data/lib/bandwidth-sdk/models/webhook_subscription_basic_authentication.rb +274 -0
- data/lib/bandwidth-sdk/models/webhook_subscription_request_schema.rb +306 -0
- data/lib/bandwidth-sdk/models/webhook_subscription_type_enum.rb +40 -0
- data/lib/bandwidth-sdk/models/webhook_subscriptions_list_body.rb +242 -0
- data/lib/bandwidth-sdk/version.rb +1 -1
- data/lib/bandwidth-sdk.rb +28 -8
- data/openapi-config.yml +1 -1
- data/spec/call_utils.rb +2 -2
- data/spec/smoke/toll_free_verification_api_spec.rb +69 -0
- data/spec/spec_helper.rb +1 -1
- data/spec/unit/api/mfa_api_spec.rb +1 -1
- data/spec/unit/api/toll_free_verification_api_spec.rb +278 -0
- data/spec/unit/client/api_client_spec.rb +1 -1
- metadata +111 -62
- data/lib/bandwidth-sdk/models/disconenct_callback.rb +0 -405
- data/lib/bandwidth-sdk/models/message_sending_callback_message.rb +0 -418
@@ -0,0 +1,24 @@
|
|
1
|
+
# Bandwidth::VerificationWebhook
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **account_id** | **String** | User's account ID. | [optional] |
|
8
|
+
| **phone_number** | **String** | Toll-free telephone number in E.164 format. | [optional] |
|
9
|
+
| **status** | [**TfvCallbackStatusEnum**](TfvCallbackStatusEnum.md) | | [optional] |
|
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
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'bandwidth-sdk'
|
16
|
+
|
17
|
+
instance = Bandwidth::VerificationWebhook.new(
|
18
|
+
account_id: 1234567,
|
19
|
+
phone_number: +18005555555,
|
20
|
+
status: null,
|
21
|
+
internal_ticket_number: acde070d-8c4c-4f0d-9d8a-162843c10333
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# Bandwidth::WebhookSubscription
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | | [optional] |
|
8
|
+
| **account_id** | **String** | | [optional] |
|
9
|
+
| **callback_url** | **String** | Callback URL to receive status updates from Bandwidth. When a webhook subscription is registered with Bandwidth under a given account ID, it will be used to send status updates for all requests submitted under that account ID. | |
|
10
|
+
| **type** | [**WebhookSubscriptionTypeEnum**](WebhookSubscriptionTypeEnum.md) | | [optional] |
|
11
|
+
| **basic_authentication** | [**WebhookSubscriptionBasicAuthentication**](WebhookSubscriptionBasicAuthentication.md) | | [optional] |
|
12
|
+
| **created_date** | **Time** | | [optional] |
|
13
|
+
| **modified_date** | **Time** | | [optional] |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'bandwidth-sdk'
|
19
|
+
|
20
|
+
instance = Bandwidth::WebhookSubscription.new(
|
21
|
+
id: 7hICGStfAfeGxEq3N0lQwO,
|
22
|
+
account_id: 1234567,
|
23
|
+
callback_url: https://www.example.com/path/to/resource,
|
24
|
+
type: null,
|
25
|
+
basic_authentication: null,
|
26
|
+
created_date: 2023-05-15T13:56:39.965Z,
|
27
|
+
modified_date: 2023-05-15T13:56:39.965Z
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# Bandwidth::WebhookSubscriptionBasicAuthentication
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **username** | **String** | | |
|
8
|
+
| **password** | **String** | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'bandwidth-sdk'
|
14
|
+
|
15
|
+
instance = Bandwidth::WebhookSubscriptionBasicAuthentication.new(
|
16
|
+
username: null,
|
17
|
+
password: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# Bandwidth::WebhookSubscriptionRequestSchema
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **basic_authentication** | [**TfvBasicAuthentication**](TfvBasicAuthentication.md) | | [optional] |
|
8
|
+
| **callback_url** | **String** | Callback URL to receive status updates from Bandwidth. When a webhook subscription is registered with Bandwidth under a given account ID, it will be used to send status updates for all requests submitted under that account ID. | |
|
9
|
+
| **shared_secret_key** | **String** | An ASCII string submitted by the user as a shared secret key for generating an HMAC header for callbacks. | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'bandwidth-sdk'
|
15
|
+
|
16
|
+
instance = Bandwidth::WebhookSubscriptionRequestSchema.new(
|
17
|
+
basic_authentication: null,
|
18
|
+
callback_url: https://www.example.com/path/to/resource,
|
19
|
+
shared_secret_key: This is my $3cret
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# Bandwidth::WebhookSubscriptionTypeEnum
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
|
8
|
+
## Example
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'bandwidth-sdk'
|
12
|
+
|
13
|
+
instance = Bandwidth::WebhookSubscriptionTypeEnum.new()
|
14
|
+
```
|
15
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# Bandwidth::WebhookSubscriptionsListBody
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **links** | [**LinksObject**](LinksObject.md) | | [optional] |
|
8
|
+
| **errors** | [**Array<Error>**](Error.md) | | [optional] |
|
9
|
+
| **data** | [**Array<WebhookSubscription>**](WebhookSubscription.md) | | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'bandwidth-sdk'
|
15
|
+
|
16
|
+
instance = Bandwidth::WebhookSubscriptionsListBody.new(
|
17
|
+
links: null,
|
18
|
+
errors: null,
|
19
|
+
data: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -273,7 +273,7 @@ module Bandwidth
|
|
273
273
|
# HTTP header 'Accept' (if needed)
|
274
274
|
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
275
275
|
# HTTP header 'Content-Type'
|
276
|
-
content_type = @api_client.select_header_content_type(['application/json', 'application/ogg', 'application/pdf', 'application/rtf', 'application/zip', 'application/x-tar', 'application/xml', 'application/gzip', 'application/x-bzip2', 'application/x-gzip', 'application/smil', 'application/javascript', 'audio/mp4', 'audio/mpeg', 'audio/ogg', 'audio/flac', 'audio/webm', 'audio/wav', 'audio/amr', 'audio/3gpp', 'image/bmp', 'image/gif', 'image/jpeg', 'image/pjpeg', 'image/png', 'image/svg+xml', 'image/tiff', 'image/webp', 'image/x-icon', 'text/css', 'text/csv', 'text/calendar', 'text/plain', 'text/javascript', 'text/vcard', 'text/vnd.wap.wml', 'text/xml', 'video/avi', 'video/mp4', 'video/mpeg', 'video/ogg', 'video/quicktime', 'video/webm', 'video/x-ms-wmv'])
|
276
|
+
content_type = @api_client.select_header_content_type(['application/json', 'application/ogg', 'application/pdf', 'application/rtf', 'application/zip', 'application/x-tar', 'application/xml', 'application/gzip', 'application/x-bzip2', 'application/x-gzip', 'application/smil', 'application/javascript', 'audio/mp4', 'audio/mpeg', 'audio/ogg', 'audio/flac', 'audio/webm', 'audio/wav', 'audio/amr', 'audio/3gpp', 'image/bmp', 'image/gif', 'image/heic', 'image/heif', 'image/jpeg', 'image/pjpeg', 'image/png', 'image/svg+xml', 'image/tiff', 'image/webp', 'image/x-icon', 'text/css', 'text/csv', 'text/calendar', 'text/html', 'text/plain', 'text/javascript', 'text/vcard', 'text/vnd.wap.wml', 'text/xml', 'video/avi', 'video/mp4', 'video/mpeg', 'video/ogg', 'video/quicktime', 'video/webm', 'video/x-ms-wmv', 'video/x-flv'])
|
277
277
|
if !content_type.nil?
|
278
278
|
header_params['Content-Type'] = content_type
|
279
279
|
end
|