Skip to content

SWI-7951 Update SDK Based on Recent Spec Changes #174

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 10, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 5 additions & 10 deletions bandwidth.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5239,30 +5239,25 @@ components:
blocked:
description: >-
Whether a Toll-Free Verification is blocked. This attribute will only be
defined when the number is blocked. (Not Available Until 5/28/2025)
defined when the number is blocked.
example: true
type: boolean
blockedReason:
description: >-
The reason why the Toll-Free Verification is blocked. This attribute
will only be defined when the number is blocked. (Not Available Until
5/28/2025)
will only be defined when the number is blocked.
example: Toll-free number was used to send spam messages
type: string
privacyPolicyUrl:
description: >-
The Toll-Free Verification request privacy policy URL. (Not Available
Until 5/28/2025)
description: The Toll-Free Verification request privacy policy URL.
example: http://your-company.com/privacyPolicy
type: string
termsAndConditionsUrl:
description: >-
The Toll-Free Verification request terms and conditions policy URL. (Not
Available Until 5/28/2025)
description: The Toll-Free Verification request terms and conditions policy URL.
example: http://your-company.com/termsAndConditions
type: string
businessDba:
description: The company 'Doing Business As'. (Not Available Until 5/28/2025)
description: The company 'Doing Business As'.
example: Another Company Name Inc.
type: string
additionalDenialReason:
Expand Down
4 changes: 2 additions & 2 deletions docs/BlockedWebhook.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
| **phone_number** | **String** | Toll-free telephone number in E.164 format. | [optional] |
| **status** | [**TfvCallbackStatusEnum**](TfvCallbackStatusEnum.md) | | [optional] |
| **internal_ticket_number** | **String** | Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number. | [optional] |
| **blocked** | **Boolean** | Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional] |
| **blocked_reason** | **String** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional] |
| **blocked** | **Boolean** | Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. | [optional] |
| **blocked_reason** | **String** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. | [optional] |

## Example

Expand Down
4 changes: 2 additions & 2 deletions docs/TfvStatus.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
| **created_date_time** | **Time** | Date and time the verification request was created. | [optional] |
| **modified_date_time** | **Time** | Date and time the verification request was last modified. | [optional] |
| **submission** | [**TfvSubmissionInfo**](TfvSubmissionInfo.md) | | [optional] |
| **blocked** | **Boolean** | Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional] |
| **blocked_reason** | **String** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional] |
| **blocked** | **Boolean** | Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. | [optional] |
| **blocked_reason** | **String** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. | [optional] |

## Example

Expand Down
6 changes: 3 additions & 3 deletions docs/TfvSubmissionInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@
| **opt_in_workflow** | [**OptInWorkflow**](OptInWorkflow.md) | | [optional] |
| **additional_information** | **String** | Any additional information. | [optional] |
| **isv_reseller** | **String** | ISV name. | [optional] |
| **privacy_policy_url** | **String** | The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) | [optional] |
| **terms_and_conditions_url** | **String** | The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025) | [optional] |
| **business_dba** | **String** | The company 'Doing Business As'. (Not Available Until 5/28/2025) | [optional] |
| **privacy_policy_url** | **String** | The Toll-Free Verification request privacy policy URL. | [optional] |
| **terms_and_conditions_url** | **String** | The Toll-Free Verification request terms and conditions policy URL. | [optional] |
| **business_dba** | **String** | The company 'Doing Business As'. | [optional] |

## Example

Expand Down
4 changes: 2 additions & 2 deletions docs/VerificationDenialWebhook.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
| **phone_number** | **String** | Toll-free telephone number in E.164 format. | [optional] |
| **resubmit_allowed** | **Boolean** | Whether a Toll-Free Verification request qualifies for resubmission via PUT. | [optional] |
| **status** | **String** | | [optional][default to 'UNVERIFIED'] |
| **blocked** | **Boolean** | Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional] |
| **blocked_reason** | **String** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional] |
| **blocked** | **Boolean** | Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. | [optional] |
| **blocked_reason** | **String** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. | [optional] |

## Example

Expand Down
6 changes: 3 additions & 3 deletions docs/VerificationRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
| **opt_in_workflow** | [**OptInWorkflow**](OptInWorkflow.md) | | |
| **additional_information** | **String** | Any additional information. | [optional] |
| **isv_reseller** | **String** | ISV name. | [optional] |
| **privacy_policy_url** | **String** | The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) | [optional] |
| **terms_and_conditions_url** | **String** | The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025) | [optional] |
| **business_dba** | **String** | The company 'Doing Business As'. (Not Available Until 5/28/2025) | [optional] |
| **privacy_policy_url** | **String** | The Toll-Free Verification request privacy policy URL. | [optional] |
| **terms_and_conditions_url** | **String** | The Toll-Free Verification request terms and conditions policy URL. | [optional] |
| **business_dba** | **String** | The company 'Doing Business As'. | [optional] |

## Example

Expand Down
6 changes: 3 additions & 3 deletions docs/VerificationUpdateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@
| **opt_in_workflow** | [**OptInWorkflow**](OptInWorkflow.md) | | |
| **additional_information** | **String** | Any additional information. | [optional] |
| **isv_reseller** | **String** | ISV name. | [optional] |
| **privacy_policy_url** | **String** | The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) | [optional] |
| **terms_and_conditions_url** | **String** | The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025) | [optional] |
| **business_dba** | **String** | The company 'Doing Business As'. (Not Available Until 5/28/2025) | [optional] |
| **privacy_policy_url** | **String** | The Toll-Free Verification request privacy policy URL. | [optional] |
| **terms_and_conditions_url** | **String** | The Toll-Free Verification request terms and conditions policy URL. | [optional] |
| **business_dba** | **String** | The company 'Doing Business As'. | [optional] |

## Example

Expand Down
4 changes: 2 additions & 2 deletions lib/bandwidth-sdk/models/blocked_webhook.rb
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ class BlockedWebhook
# Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number.
attr_accessor :internal_ticket_number

# Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025)
# Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked.
attr_accessor :blocked

# The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025)
# The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked.
attr_accessor :blocked_reason

class EnumAttributeValidator
Expand Down
4 changes: 2 additions & 2 deletions lib/bandwidth-sdk/models/tfv_status.rb
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,10 @@ class TfvStatus

attr_accessor :submission

# Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025)
# Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked.
attr_accessor :blocked

# The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025)
# The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked.
attr_accessor :blocked_reason

class EnumAttributeValidator
Expand Down
6 changes: 3 additions & 3 deletions lib/bandwidth-sdk/models/tfv_submission_info.rb
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,13 @@ class TfvSubmissionInfo
# ISV name.
attr_accessor :isv_reseller

# The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025)
# The Toll-Free Verification request privacy policy URL.
attr_accessor :privacy_policy_url

# The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025)
# The Toll-Free Verification request terms and conditions policy URL.
attr_accessor :terms_and_conditions_url

# The company 'Doing Business As'. (Not Available Until 5/28/2025)
# The company 'Doing Business As'.
attr_accessor :business_dba

# Attribute mapping from ruby-style variable name to JSON key.
Expand Down
4 changes: 2 additions & 2 deletions lib/bandwidth-sdk/models/verification_denial_webhook.rb
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,10 @@ class VerificationDenialWebhook

attr_accessor :status

# Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025)
# Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked.
attr_accessor :blocked

# The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025)
# The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked.
attr_accessor :blocked_reason

# Attribute mapping from ruby-style variable name to JSON key.
Expand Down
6 changes: 3 additions & 3 deletions lib/bandwidth-sdk/models/verification_request.rb
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,13 @@ class VerificationRequest
# ISV name.
attr_accessor :isv_reseller

# The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025)
# The Toll-Free Verification request privacy policy URL.
attr_accessor :privacy_policy_url

# The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025)
# The Toll-Free Verification request terms and conditions policy URL.
attr_accessor :terms_and_conditions_url

# The company 'Doing Business As'. (Not Available Until 5/28/2025)
# The company 'Doing Business As'.
attr_accessor :business_dba

# Attribute mapping from ruby-style variable name to JSON key.
Expand Down
6 changes: 3 additions & 3 deletions lib/bandwidth-sdk/models/verification_update_request.rb
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,13 @@ class VerificationUpdateRequest
# ISV name.
attr_accessor :isv_reseller

# The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025)
# The Toll-Free Verification request privacy policy URL.
attr_accessor :privacy_policy_url

# The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025)
# The Toll-Free Verification request terms and conditions policy URL.
attr_accessor :terms_and_conditions_url

# The company 'Doing Business As'. (Not Available Until 5/28/2025)
# The company 'Doing Business As'.
attr_accessor :business_dba

# Attribute mapping from ruby-style variable name to JSON key.
Expand Down
Loading