Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
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
59 changes: 52 additions & 7 deletions bandwidth.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1956,8 +1956,10 @@ components:
type: string
contentLength:
type: integer
example: 1024
mediaName:
type: string
example: image.png
segmentCount:
type: integer
description: >-
Expand Down Expand Up @@ -2744,6 +2746,7 @@ components:
discriminator:
propertyName: type
mapping:
message-sending: '#/components/schemas/statusCallback'
message-sent: '#/components/schemas/statusCallback'
message-delivered: '#/components/schemas/statusCallback'
message-failed: '#/components/schemas/statusCallback'
Expand Down Expand Up @@ -5510,10 +5513,14 @@ components:

- UNKNOWN: Bandwidth cannot find an delivery status entry for the
number.

- NOT_ENABLED: The phone number is not enabled for messaging, so there
is no delivery status information.
enum:
- ACTIVE
- DEACTIVATED
- UNKNOWN
- NOT_ENABLED
lineTypeEnum:
type: string
enum:
Expand Down Expand Up @@ -5816,25 +5823,36 @@ components:
type: string
privacyPolicyUrl:
description: The Toll-Free Verification request privacy policy URL.
maxLength: 500
example: http://your-company.com/privacyPolicy
type: string
termsAndConditionsUrl:
description: The Toll-Free Verification request terms and conditions policy URL.
maxLength: 500
example: http://your-company.com/termsAndConditions
type: string
businessDba:
description: The company 'Doing Business As'.
maxLength: 500
example: Another Company Name Inc.
type: string
businessRegistrationNumber:
type: string
description: Government-issued business identifying number.
description: >
Government-issued business identifying number.


**Note:** If this field is provided, it is strongly recommended to also
provide `businessRegistrationType` and
`businessRegistrationIssuingCountry`. Submissions missing these fields
have a high likelihood of rejection.
nullable: true
maxLength: 500
example: 12-3456789
businessRegistrationTypeEnum:
type: string
description: The type of business registration number.
description: |
The type of business registration number.
enum:
- EIN
- CBN
Expand All @@ -5854,12 +5872,22 @@ components:
- CNPJ
- UID
- OTHER
example: EIN
nullable: true
businessRegistrationIssuingCountryEnum:
type: string
description: >-
The country issuing the business registration in ISO-3166-1 alpha-3
format.
format. Alpha-2 country codes are acceptable, but the application will
convert them to alpha-3 when received, so alpha-3 is encouraged.


**Note:** If this field is omitted but `businessRegistrationType` is
provided, the application will attempt to infer the country based on the
registration type. However, if the application cannot confidently infer
the country, the submission may be rejected. To ensure the highest
likelihood of acceptance, it is recommended to provide both
`businessRegistrationType` and `businessRegistrationIssuingCountry`.


| Registration Type | Supported Countries |
Expand Down Expand Up @@ -5915,18 +5943,23 @@ components:
- DEU
- ESP
- CHE
- CYP
- IND
- CHN
- BGR
example: USA
nullable: false
businessEntityTypeEnum:
type: string
description: >-
The type of registered business. If no option is applicable, please
provide "SOLE_PROPRIETOR" as a value.
description: |
The type of registered business.
enum:
- SOLE_PROPRIETOR
- PRIVATE_PROFIT
- PUBLIC_PROFIT
- NON_PROFIT
- GOVERNMENT
example: PRIVATE_PROFIT
nullable: false
helpMessageResponse:
type: string
Expand Down Expand Up @@ -6576,10 +6609,14 @@ components:
$ref: '#/components/schemas/businessDba'
businessRegistrationNumber:
$ref: '#/components/schemas/businessRegistrationNumber'
description: Government-issued business identifying number.
businessRegistrationType:
$ref: '#/components/schemas/businessRegistrationTypeEnum'
businessRegistrationIssuingCountry:
$ref: '#/components/schemas/businessRegistrationIssuingCountryEnum'
description: >-
The country issuing the business registration in ISO-3166-1 alpha-3
format.
businessEntityType:
$ref: '#/components/schemas/businessEntityTypeEnum'
tfvStatusEnum:
Expand Down Expand Up @@ -8117,7 +8154,7 @@ components:
latestMessageDeliveryStatusDate: '2025-05-18'
- phoneNumber: '+10072904498'
countryCodeA3: USA
lineType: FIXED
lineType: MOBILE
voiceProvider: VERIZON
latestMessageDeliveryStatus: DEACTIVATED
initialMessageDeliveryStatusDate: '2025-09-05'
Expand All @@ -8131,6 +8168,14 @@ components:
deactivationDate: '2025-09-29 01:23:00'
deactivationEvent: DEACTIVATED
latestMessageDeliveryStatus: UNKNOWN
- phoneNumber: '+10072904500'
lineType: FIXED
countryCodeA3: USA
voiceProvider: VERIZON
deactivationReporter: Verizon Wireless
deactivationDate: '2025-09-29 01:23:00'
deactivationEvent: DEACTIVATED
latestMessageDeliveryStatus: NOT_ENABLED
errors: []
badRequestExample:
summary: Example Bad Request Error
Expand Down
1 change: 1 addition & 0 deletions docs/Callback.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ Bandwidth::Callback.openapi_discriminator_mapping
# :'message-failed' => :'StatusCallback',
# :'message-read' => :'StatusCallback',
# :'message-received' => :'InboundCallback',
# :'message-sending' => :'StatusCallback',
# :'message-sent' => :'StatusCallback',
# :'request-location-response' => :'InboundCallback',
# :'suggestion-response' => :'InboundCallback'
Expand Down
4 changes: 2 additions & 2 deletions docs/Media.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ require 'bandwidth-sdk'

instance = Bandwidth::Media.new(
content: null,
content_length: null,
media_name: null
content_length: 1024,
media_name: image.png
)
```

2 changes: 1 addition & 1 deletion docs/RbmActionBase.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ require 'bandwidth-sdk'
instance = Bandwidth::RbmActionBase.new(
type: null,
text: Hello world,
postback_data: [B@177302d6
postback_data: [B@764a3867
)
```

2 changes: 1 addition & 1 deletion docs/RbmSuggestionResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ require 'bandwidth-sdk'

instance = Bandwidth::RbmSuggestionResponse.new(
text: Yes, I would like to proceed,
postback_data: [B@177302d6
postback_data: [B@764a3867
)
```

2 changes: 1 addition & 1 deletion docs/TfvSubmissionInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
| **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] |
| **business_registration_number** | **String** | Government-issued business identifying number. | [optional] |
| **business_registration_number** | **String** | Government-issued business identifying number. **Note:** If this field is provided, it is strongly recommended to also provide `businessRegistrationType` and `businessRegistrationIssuingCountry`. Submissions missing these fields have a high likelihood of rejection. | [optional] |
| **business_registration_type** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] |
| **business_registration_issuing_country** | [**BusinessRegistrationIssuingCountryEnum**](BusinessRegistrationIssuingCountryEnum.md) | | [optional] |
| **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] |
Expand Down
2 changes: 1 addition & 1 deletion docs/VerificationRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
| **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] |
| **business_registration_number** | **String** | Government-issued business identifying number. | [optional] |
| **business_registration_number** | **String** | Government-issued business identifying number. **Note:** If this field is provided, it is strongly recommended to also provide `businessRegistrationType` and `businessRegistrationIssuingCountry`. Submissions missing these fields have a high likelihood of rejection. | [optional] |
| **business_registration_type** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] |
| **business_registration_issuing_country** | [**BusinessRegistrationIssuingCountryEnum**](BusinessRegistrationIssuingCountryEnum.md) | | [optional] |
| **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | |
Expand Down
2 changes: 1 addition & 1 deletion docs/VerificationUpdateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
| **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] |
| **business_registration_number** | **String** | Government-issued business identifying number. | [optional] |
| **business_registration_number** | **String** | Government-issued business identifying number. **Note:** If this field is provided, it is strongly recommended to also provide `businessRegistrationType` and `businessRegistrationIssuingCountry`. Submissions missing these fields have a high likelihood of rejection. | [optional] |
| **business_registration_type** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] |
| **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] |
| **business_registration_issuing_country** | [**BusinessRegistrationIssuingCountryEnum**](BusinessRegistrationIssuingCountryEnum.md) | | [optional] |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,13 @@ class BusinessRegistrationIssuingCountryEnum
DEU = 'DEU'.freeze
ESP = 'ESP'.freeze
CHE = 'CHE'.freeze
CYP = 'CYP'.freeze
IND = 'IND'.freeze
CHN = 'CHN'.freeze
BGR = 'BGR'.freeze

def self.all_vars
@all_vars ||= [USA, CAN, HKG, GBR, IRL, BRA, NLD, AUS, FRA, NZL, DEU, ESP, CHE].freeze
@all_vars ||= [USA, CAN, HKG, GBR, IRL, BRA, NLD, AUS, FRA, NZL, DEU, ESP, CHE, CYP, IND, CHN, BGR].freeze
end

# Builds the enum from string
Expand Down
1 change: 1 addition & 0 deletions lib/bandwidth-sdk/models/callback.rb
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ def openapi_discriminator_mapping
:'message-failed' => :'StatusCallback',
:'message-read' => :'StatusCallback',
:'message-received' => :'InboundCallback',
:'message-sending' => :'StatusCallback',
:'message-sent' => :'StatusCallback',
:'request-location-response' => :'InboundCallback',
:'suggestion-response' => :'InboundCallback'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,10 @@ class LatestMessageDeliveryStatusEnum
ACTIVE = 'ACTIVE'.freeze
DEACTIVATED = 'DEACTIVATED'.freeze
UNKNOWN = 'UNKNOWN'.freeze
NOT_ENABLED = 'NOT_ENABLED'.freeze

def self.all_vars
@all_vars ||= [ACTIVE, DEACTIVATED, UNKNOWN].freeze
@all_vars ||= [ACTIVE, DEACTIVATED, UNKNOWN, NOT_ENABLED].freeze
end

# Builds the enum from string
Expand Down
59 changes: 58 additions & 1 deletion lib/bandwidth-sdk/models/tfv_submission_info.rb
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ class TfvSubmissionInfo < ApiModelBase
# The company 'Doing Business As'.
attr_accessor :business_dba

# Government-issued business identifying number.
# Government-issued business identifying number. **Note:** If this field is provided, it is strongly recommended to also provide `businessRegistrationType` and `businessRegistrationIssuingCountry`. Submissions missing these fields have a high likelihood of rejection.
attr_accessor :business_registration_number

attr_accessor :business_registration_type
Expand Down Expand Up @@ -277,6 +277,18 @@ def list_invalid_properties
invalid_properties.push('invalid value for "isv_reseller", the character length must be greater than or equal to 0.')
end

if !@privacy_policy_url.nil? && @privacy_policy_url.to_s.length > 500
invalid_properties.push('invalid value for "privacy_policy_url", the character length must be smaller than or equal to 500.')
end

if !@terms_and_conditions_url.nil? && @terms_and_conditions_url.to_s.length > 500
invalid_properties.push('invalid value for "terms_and_conditions_url", the character length must be smaller than or equal to 500.')
end

if !@business_dba.nil? && @business_dba.to_s.length > 500
invalid_properties.push('invalid value for "business_dba", the character length must be smaller than or equal to 500.')
end

if !@business_registration_number.nil? && @business_registration_number.to_s.length > 500
invalid_properties.push('invalid value for "business_registration_number", the character length must be smaller than or equal to 500.')
end
Expand All @@ -300,6 +312,9 @@ def valid?
return false if !@additional_information.nil? && @additional_information.to_s.length < 0
return false if !@isv_reseller.nil? && @isv_reseller.to_s.length > 500
return false if !@isv_reseller.nil? && @isv_reseller.to_s.length < 0
return false if !@privacy_policy_url.nil? && @privacy_policy_url.to_s.length > 500
return false if !@terms_and_conditions_url.nil? && @terms_and_conditions_url.to_s.length > 500
return false if !@business_dba.nil? && @business_dba.to_s.length > 500
return false if !@business_registration_number.nil? && @business_registration_number.to_s.length > 500
true
end
Expand Down Expand Up @@ -404,6 +419,48 @@ def isv_reseller=(isv_reseller)
@isv_reseller = isv_reseller
end

# Custom attribute writer method with validation
# @param [Object] privacy_policy_url Value to be assigned
def privacy_policy_url=(privacy_policy_url)
if privacy_policy_url.nil?
fail ArgumentError, 'privacy_policy_url cannot be nil'
end

if privacy_policy_url.to_s.length > 500
fail ArgumentError, 'invalid value for "privacy_policy_url", the character length must be smaller than or equal to 500.'
end

@privacy_policy_url = privacy_policy_url
end

# Custom attribute writer method with validation
# @param [Object] terms_and_conditions_url Value to be assigned
def terms_and_conditions_url=(terms_and_conditions_url)
if terms_and_conditions_url.nil?
fail ArgumentError, 'terms_and_conditions_url cannot be nil'
end

if terms_and_conditions_url.to_s.length > 500
fail ArgumentError, 'invalid value for "terms_and_conditions_url", the character length must be smaller than or equal to 500.'
end

@terms_and_conditions_url = terms_and_conditions_url
end

# Custom attribute writer method with validation
# @param [Object] business_dba Value to be assigned
def business_dba=(business_dba)
if business_dba.nil?
fail ArgumentError, 'business_dba cannot be nil'
end

if business_dba.to_s.length > 500
fail ArgumentError, 'invalid value for "business_dba", the character length must be smaller than or equal to 500.'
end

@business_dba = business_dba
end

# Custom attribute writer method with validation
# @param [Object] business_registration_number Value to be assigned
def business_registration_number=(business_registration_number)
Expand Down
Loading