bandwidth-sdk 14.0.0 → 14.1.1
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 +10 -10
- data/README.md +42 -10
- data/bandwidth.yml +1113 -0
- data/coverage/.last_run.json +1 -1
- data/coverage/.resultset.json +1204 -231
- data/coverage/index.html +20499 -10053
- data/custom_templates/README.mustache +6 -6
- data/docs/AdditionalDenialReason.md +22 -0
- data/docs/Address.md +30 -0
- data/docs/Contact.md +24 -0
- data/docs/Error.md +22 -0
- data/docs/FailureWebhook.md +28 -0
- data/docs/InitiateCallback.md +3 -1
- data/docs/LinksObject.md +24 -0
- data/docs/OptInWorkflow.md +20 -0
- data/docs/TelephoneNumber.md +18 -0
- data/docs/TfvBasicAuthentication.md +20 -0
- data/docs/{PublishPermissionsEnum.md → TfvCallbackStatusEnum.md} +2 -2
- data/docs/TfvError.md +22 -0
- data/docs/TfvStatus.md +32 -0
- data/docs/{DeviceApiVersionEnum.md → TfvStatusEnum.md} +2 -2
- 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/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/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/initiate_callback.rb +33 -4
- data/lib/bandwidth-sdk/models/links_object.rb +243 -0
- data/lib/bandwidth-sdk/models/opt_in_workflow.rb +265 -0
- data/lib/bandwidth-sdk/models/telephone_number.rb +213 -0
- data/lib/bandwidth-sdk/models/tfv_basic_authentication.rb +273 -0
- data/lib/bandwidth-sdk/models/tfv_callback_status_enum.rb +40 -0
- data/lib/bandwidth-sdk/models/tfv_error.rb +232 -0
- data/lib/bandwidth-sdk/models/tfv_status.rb +342 -0
- 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/tfv_submission_wrapper.rb +212 -0
- 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/webhook_subscription.rb +328 -0
- 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 +25 -0
- 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 +91 -61
- data/docs/CreateParticipantRequest.md +0 -24
- data/docs/CreateParticipantResponse.md +0 -20
- data/docs/DisconenctCallback.md +0 -50
- data/docs/ForbiddenRequest.md +0 -18
- data/docs/InboundMessageCallback.md +0 -26
- data/docs/InboundMessageCallbackMessage.md +0 -40
- data/docs/MessageDeliveredCallback.md +0 -26
- data/docs/MessageDeliveredCallbackMessage.md +0 -40
- data/docs/MessageFailedCallback.md +0 -28
- data/docs/MessageFailedCallbackMessage.md +0 -40
- data/docs/MessageSendingCallback.md +0 -26
- data/docs/MessageSendingCallbackMessage.md +0 -40
- data/docs/Participant.md +0 -30
- data/docs/ParticipantSubscription.md +0 -20
- data/docs/ParticipantsApi.md +0 -227
- data/docs/RequestError.md +0 -20
- data/docs/Session.md +0 -20
- data/docs/SessionsApi.md +0 -605
- data/docs/Subscriptions.md +0 -20
- data/docs/TranscriptionList.md +0 -18
- data/docs/TranscriptionMetadata.md +0 -24
- data/docs/UnauthorizedRequest.md +0 -18
|
@@ -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
|
+
|