diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 3fc1f0c..53e9a75 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -13,7 +13,6 @@ docs/BlockedWebhook.md docs/BridgeCompleteCallback.md docs/BridgeTargetCompleteCallback.md docs/BusinessEntityTypeEnum.md -docs/BusinessRegistrationIssuingCountryEnum.md docs/BusinessRegistrationTypeEnum.md docs/CallDirectionEnum.md docs/CallRecordingMetadata.md @@ -218,7 +217,6 @@ lib/bandwidth-sdk/models/blocked_webhook.rb lib/bandwidth-sdk/models/bridge_complete_callback.rb lib/bandwidth-sdk/models/bridge_target_complete_callback.rb lib/bandwidth-sdk/models/business_entity_type_enum.rb -lib/bandwidth-sdk/models/business_registration_issuing_country_enum.rb lib/bandwidth-sdk/models/business_registration_type_enum.rb lib/bandwidth-sdk/models/call_direction_enum.rb lib/bandwidth-sdk/models/call_recording_metadata.rb diff --git a/README.md b/README.md index 352585a..e981ea0 100644 --- a/README.md +++ b/README.md @@ -180,7 +180,6 @@ Class | Method | HTTP request | Description - [Bandwidth::BridgeCompleteCallback](docs/BridgeCompleteCallback.md) - [Bandwidth::BridgeTargetCompleteCallback](docs/BridgeTargetCompleteCallback.md) - [Bandwidth::BusinessEntityTypeEnum](docs/BusinessEntityTypeEnum.md) - - [Bandwidth::BusinessRegistrationIssuingCountryEnum](docs/BusinessRegistrationIssuingCountryEnum.md) - [Bandwidth::BusinessRegistrationTypeEnum](docs/BusinessRegistrationTypeEnum.md) - [Bandwidth::CallDirectionEnum](docs/CallDirectionEnum.md) - [Bandwidth::CallRecordingMetadata](docs/CallRecordingMetadata.md) diff --git a/bandwidth.yml b/bandwidth.yml index 4948dd1..0c6582e 100644 --- a/bandwidth.yml +++ b/bandwidth.yml @@ -5828,13 +5828,21 @@ components: 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 @@ -5855,11 +5863,20 @@ components: - UID - OTHER nullable: true - businessRegistrationIssuingCountryEnum: + businessRegistrationIssuingCountry: 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 | @@ -5901,26 +5918,11 @@ components: | UID | CHE | | OTHER | Must Provide Country Code | - enum: - - USA - - CAN - - HKG - - GBR - - IRL - - BRA - - NLD - - AUS - - FRA - - NZL - - DEU - - ESP - - CHE 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 @@ -6028,7 +6030,7 @@ components: businessRegistrationType: $ref: '#/components/schemas/businessRegistrationTypeEnum' businessRegistrationIssuingCountry: - $ref: '#/components/schemas/businessRegistrationIssuingCountryEnum' + $ref: '#/components/schemas/businessRegistrationIssuingCountry' businessEntityType: $ref: '#/components/schemas/businessEntityTypeEnum' helpMessageResponse: @@ -6083,7 +6085,7 @@ components: businessEntityType: $ref: '#/components/schemas/businessEntityTypeEnum' businessRegistrationIssuingCountry: - $ref: '#/components/schemas/businessRegistrationIssuingCountryEnum' + $ref: '#/components/schemas/businessRegistrationIssuingCountry' helpMessageResponse: $ref: '#/components/schemas/helpMessageResponse' ageGatedContent: @@ -6576,10 +6578,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' + $ref: '#/components/schemas/businessRegistrationIssuingCountry' + description: >- + The country issuing the business registration in ISO-3166-1 alpha-3 + format. businessEntityType: $ref: '#/components/schemas/businessEntityTypeEnum' tfvStatusEnum: diff --git a/docs/RbmActionBase.md b/docs/RbmActionBase.md index 892ecb0..70aa056 100644 --- a/docs/RbmActionBase.md +++ b/docs/RbmActionBase.md @@ -16,7 +16,7 @@ require 'bandwidth-sdk' instance = Bandwidth::RbmActionBase.new( type: null, text: Hello world, - postback_data: [B@177302d6 + postback_data: [B@ba27ce6 ) ``` diff --git a/docs/RbmSuggestionResponse.md b/docs/RbmSuggestionResponse.md index 42e3aec..d9ff105 100644 --- a/docs/RbmSuggestionResponse.md +++ b/docs/RbmSuggestionResponse.md @@ -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@ba27ce6 ) ``` diff --git a/docs/TfvSubmissionInfo.md b/docs/TfvSubmissionInfo.md index 68102a1..4736d76 100644 --- a/docs/TfvSubmissionInfo.md +++ b/docs/TfvSubmissionInfo.md @@ -16,9 +16,9 @@ | **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_registration_issuing_country** | **String** | The country issuing the business registration in ISO-3166-1 alpha-3 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 | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | | [optional] | | **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] | ## Example diff --git a/docs/VerificationRequest.md b/docs/VerificationRequest.md index ecf497b..a614d21 100644 --- a/docs/VerificationRequest.md +++ b/docs/VerificationRequest.md @@ -17,9 +17,9 @@ | **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_registration_issuing_country** | **String** | The country issuing the business registration in ISO-3166-1 alpha-3 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 | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | | [optional] | | **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | | | **help_message_response** | **String** | A message that gets sent to users requesting help. | [optional] | | **age_gated_content** | **Boolean** | Indicates whether the content is age-gated. | [optional] | diff --git a/docs/VerificationUpdateRequest.md b/docs/VerificationUpdateRequest.md index 64c69c3..08bbbfc 100644 --- a/docs/VerificationUpdateRequest.md +++ b/docs/VerificationUpdateRequest.md @@ -16,10 +16,10 @@ | **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] | +| **business_registration_issuing_country** | **String** | The country issuing the business registration in ISO-3166-1 alpha-3 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 | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | | [optional] | | **help_message_response** | **String** | A message that gets sent to users requesting help. | [optional] | | **age_gated_content** | **Boolean** | Indicates whether the content is age-gated. | [optional] | | **cv_token** | **String** | The token provided by Campaign Verify to validate your political use case. Only required for 527 political organizations. If you are not a 527 political organization, this field should be omitted. Supplying an empty string will likely result in rejection. | [optional] | diff --git a/lib/bandwidth-sdk.rb b/lib/bandwidth-sdk.rb index 07ec2ed..718f3ec 100644 --- a/lib/bandwidth-sdk.rb +++ b/lib/bandwidth-sdk.rb @@ -27,7 +27,6 @@ require 'bandwidth-sdk/models/bridge_complete_callback' require 'bandwidth-sdk/models/bridge_target_complete_callback' require 'bandwidth-sdk/models/business_entity_type_enum' -require 'bandwidth-sdk/models/business_registration_issuing_country_enum' require 'bandwidth-sdk/models/business_registration_type_enum' require 'bandwidth-sdk/models/call_direction_enum' require 'bandwidth-sdk/models/call_recording_metadata' diff --git a/lib/bandwidth-sdk/models/tfv_submission_info.rb b/lib/bandwidth-sdk/models/tfv_submission_info.rb index 48efd0b..bff86a8 100644 --- a/lib/bandwidth-sdk/models/tfv_submission_info.rb +++ b/lib/bandwidth-sdk/models/tfv_submission_info.rb @@ -48,11 +48,12 @@ 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 + # The country issuing the business registration in ISO-3166-1 alpha-3 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 | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | attr_accessor :business_registration_issuing_country attr_accessor :business_entity_type @@ -128,7 +129,7 @@ def self.openapi_types :'business_dba' => :'String', :'business_registration_number' => :'String', :'business_registration_type' => :'BusinessRegistrationTypeEnum', - :'business_registration_issuing_country' => :'BusinessRegistrationIssuingCountryEnum', + :'business_registration_issuing_country' => :'String', :'business_entity_type' => :'BusinessEntityTypeEnum' } end diff --git a/lib/bandwidth-sdk/models/verification_request.rb b/lib/bandwidth-sdk/models/verification_request.rb index 9f90b4a..5f1b478 100644 --- a/lib/bandwidth-sdk/models/verification_request.rb +++ b/lib/bandwidth-sdk/models/verification_request.rb @@ -50,11 +50,12 @@ class VerificationRequest < 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 + # The country issuing the business registration in ISO-3166-1 alpha-3 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 | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | attr_accessor :business_registration_issuing_country attr_accessor :business_entity_type @@ -144,7 +145,7 @@ def self.openapi_types :'business_dba' => :'String', :'business_registration_number' => :'String', :'business_registration_type' => :'BusinessRegistrationTypeEnum', - :'business_registration_issuing_country' => :'BusinessRegistrationIssuingCountryEnum', + :'business_registration_issuing_country' => :'String', :'business_entity_type' => :'BusinessEntityTypeEnum', :'help_message_response' => :'String', :'age_gated_content' => :'Boolean', diff --git a/lib/bandwidth-sdk/models/verification_update_request.rb b/lib/bandwidth-sdk/models/verification_update_request.rb index 65ff419..2e37470 100644 --- a/lib/bandwidth-sdk/models/verification_update_request.rb +++ b/lib/bandwidth-sdk/models/verification_update_request.rb @@ -48,13 +48,14 @@ class VerificationUpdateRequest < 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 attr_accessor :business_entity_type + # The country issuing the business registration in ISO-3166-1 alpha-3 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 | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | attr_accessor :business_registration_issuing_country # A message that gets sent to users requesting help. @@ -141,7 +142,7 @@ def self.openapi_types :'business_registration_number' => :'String', :'business_registration_type' => :'BusinessRegistrationTypeEnum', :'business_entity_type' => :'BusinessEntityTypeEnum', - :'business_registration_issuing_country' => :'BusinessRegistrationIssuingCountryEnum', + :'business_registration_issuing_country' => :'String', :'help_message_response' => :'String', :'age_gated_content' => :'Boolean', :'cv_token' => :'String'