From f4507e0572235c9a2a50a3f52d0ca036e6710c9a Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Tue, 7 Apr 2026 14:38:00 +0000 Subject: [PATCH 1/3] Generate SDK with OpenAPI Generator Version --- .openapi-generator/FILES | 2 - README.md | 1 - bandwidth.yml | 76 +++++++++---------- docs/MediaApi.md | 2 +- docs/MmsMessageContentFile.md | 2 +- docs/RbmActionBase.md | 2 +- docs/RbmSuggestionResponse.md | 2 +- docs/TfvSubmissionInfo.md | 6 +- docs/VerificationRequest.md | 6 +- docs/VerificationUpdateRequest.md | 6 +- lib/bandwidth-sdk.rb | 1 - lib/bandwidth-sdk/api/media_api.rb | 4 +- .../models/mms_message_content_file.rb | 2 +- .../models/tfv_submission_info.rb | 6 +- .../models/verification_request.rb | 6 +- .../models/verification_update_request.rb | 6 +- 16 files changed, 63 insertions(+), 67 deletions(-) diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 3fc1f0c4..53e9a751 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 352585a3..e981ea0b 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 d3f8539c..835ec5a9 100644 --- a/bandwidth.yml +++ b/bandwidth.yml @@ -95,8 +95,8 @@ paths: under this account, the previous file will be overwritten. - A list of supported media types can be found - [here](https://support.bandwidth.com/hc/en-us/articles/360014128994-What-MMS-file-types-are-supported-). + A list of supported media types can be found at [Bandwidth + Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported). operationId: uploadMedia tags: - Media @@ -2255,8 +2255,8 @@ components: For MMS, the API limits file size to 3.5MB. Specific carriers and channels may have a smaller limit that could cause a large file to - fail, see - [here](https://support.bandwidth.com/hc/en-us/articles/360014235473-What-are-the-MMS-file-size-limits) + fail, see more at [Bandwidth + Support](https://www.bandwidth.com/support/en/articles/12823216-what-are-the-mms-file-size-limits) for more details. example: https://dev.bandwidth.com/images/bandwidth-logo.png maxLength: 1000 @@ -5887,17 +5887,21 @@ components: 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. + **Note: As of October 19th, 2026 this field will be required when + `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is + provided, `businessRegistrationType` and + `businessRegistrationIssuingCountry` are also required.** nullable: true maxLength: 500 example: 12-3456789 businessRegistrationTypeEnum: type: string - description: | + description: > The type of business registration number. + + + **Note: As of October 19th, 2026 this field will be required when + `businessRegistrationNumber` is provided.** enum: - EIN - CBN @@ -5919,20 +5923,16 @@ components: - OTHER example: EIN nullable: true - businessRegistrationIssuingCountryEnum: + businessRegistrationIssuingCountry: type: string description: >- 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. + format. Alpha-2 format is accepted by the API, but alpha-3 is highly + 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`. + **Note: As of October 19th, 2026 this field will be required when + `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | @@ -5974,30 +5974,22 @@ components: | UID | CHE | | OTHER | Must Provide Country Code | - enum: - - USA - - CAN - - HKG - - GBR - - IRL - - BRA - - NLD - - AUS - - FRA - - NZL - - DEU - - ESP - - CHE - - CYP - - IND - - CHN - - BGR example: USA - nullable: false + nullable: true businessEntityTypeEnum: type: string - description: | + description: > The type of registered business. + + + **Note: As of October 19th, 2026 submissions using a value other than + `SOLE_PROPRIETOR` must provide a value for `businessRegistrationNumber`, + `businessRegistrationType`, and `businessRegistrationIssuingCountry`. + + Submissions using `SOLE_PROPRIETOR` must _omit_ + `businessRegistrationNumber`, `businessRegistrationType`, and + `businessRegistrationIssuingCountry`. Failure to adhere to these + constraints will result in a 400 Bad Request rejection.** enum: - SOLE_PROPRIETOR - PRIVATE_PROFIT @@ -6106,7 +6098,7 @@ components: businessRegistrationType: $ref: '#/components/schemas/businessRegistrationTypeEnum' businessRegistrationIssuingCountry: - $ref: '#/components/schemas/businessRegistrationIssuingCountryEnum' + $ref: '#/components/schemas/businessRegistrationIssuingCountry' businessEntityType: $ref: '#/components/schemas/businessEntityTypeEnum' helpMessageResponse: @@ -6161,7 +6153,7 @@ components: businessEntityType: $ref: '#/components/schemas/businessEntityTypeEnum' businessRegistrationIssuingCountry: - $ref: '#/components/schemas/businessRegistrationIssuingCountryEnum' + $ref: '#/components/schemas/businessRegistrationIssuingCountry' helpMessageResponse: $ref: '#/components/schemas/helpMessageResponse' ageGatedContent: @@ -6657,13 +6649,15 @@ components: description: Government-issued business identifying number. businessRegistrationType: $ref: '#/components/schemas/businessRegistrationTypeEnum' + description: The type of business registration number. 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' + description: The type of registered business. tfvStatusEnum: type: string enum: diff --git a/docs/MediaApi.md b/docs/MediaApi.md index 14f2e546..7cc81308 100644 --- a/docs/MediaApi.md +++ b/docs/MediaApi.md @@ -242,7 +242,7 @@ end Upload Media -Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found [here](https://support.bandwidth.com/hc/en-us/articles/360014128994-What-MMS-file-types-are-supported-). +Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported). ### Examples diff --git a/docs/MmsMessageContentFile.md b/docs/MmsMessageContentFile.md index 09bd4b66..4990cdb1 100644 --- a/docs/MmsMessageContentFile.md +++ b/docs/MmsMessageContentFile.md @@ -4,7 +4,7 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| **file_url** | **String** | The URL of a media attachment. For MMS, the API limits file size to 3.5MB. Specific carriers and channels may have a smaller limit that could cause a large file to fail, see [here](https://support.bandwidth.com/hc/en-us/articles/360014235473-What-are-the-MMS-file-size-limits) for more details. | | +| **file_url** | **String** | The URL of a media attachment. For MMS, the API limits file size to 3.5MB. Specific carriers and channels may have a smaller limit that could cause a large file to fail, see more at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823216-what-are-the-mms-file-size-limits) for more details. | | ## Example diff --git a/docs/RbmActionBase.md b/docs/RbmActionBase.md index 5c3804ef..b67a76b6 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@4693d24f + postback_data: [B@662d3e85 ) ``` diff --git a/docs/RbmSuggestionResponse.md b/docs/RbmSuggestionResponse.md index 513519c0..2aa64e13 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@4693d24f + postback_data: [B@662d3e85 ) ``` diff --git a/docs/TfvSubmissionInfo.md b/docs/TfvSubmissionInfo.md index 101b1c5d..c0409e65 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. **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_number** | **String** | Government-issued business identifying number. **Note: As of October 19th, 2026 this field will be required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** | [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 format is accepted by the API, but alpha-3 is highly encouraged. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.** | 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 @@ -41,7 +41,7 @@ instance = Bandwidth::TfvSubmissionInfo.new( business_dba: Another Company Name Inc., business_registration_number: 12-3456789, business_registration_type: null, - business_registration_issuing_country: null, + business_registration_issuing_country: USA, business_entity_type: null ) ``` diff --git a/docs/VerificationRequest.md b/docs/VerificationRequest.md index cf69b333..b2eda27d 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. **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_number** | **String** | Government-issued business identifying number. **Note: As of October 19th, 2026 this field will be required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** | [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 format is accepted by the API, but alpha-3 is highly encouraged. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.** | 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] | @@ -46,7 +46,7 @@ instance = Bandwidth::VerificationRequest.new( business_dba: Another Company Name Inc., business_registration_number: 12-3456789, business_registration_type: null, - business_registration_issuing_country: null, + business_registration_issuing_country: USA, business_entity_type: null, help_message_response: Please contact support for assistance., age_gated_content: false, diff --git a/docs/VerificationUpdateRequest.md b/docs/VerificationUpdateRequest.md index 69182391..0dce8f2b 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. **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_number** | **String** | Government-issued business identifying number. **Note: As of October 19th, 2026 this field will be required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** | [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 format is accepted by the API, but alpha-3 is highly encouraged. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.** | 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] | @@ -45,7 +45,7 @@ instance = Bandwidth::VerificationUpdateRequest.new( business_registration_number: 12-3456789, business_registration_type: null, business_entity_type: null, - business_registration_issuing_country: null, + business_registration_issuing_country: USA, help_message_response: Please contact support for assistance., age_gated_content: false, cv_token: cv.user123|sess456|mno|tfree|read_write|X7yZ9aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVw diff --git a/lib/bandwidth-sdk.rb b/lib/bandwidth-sdk.rb index 07ec2ed8..718f3ece 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/api/media_api.rb b/lib/bandwidth-sdk/api/media_api.rb index 28b69c8c..c6c8cdfa 100644 --- a/lib/bandwidth-sdk/api/media_api.rb +++ b/lib/bandwidth-sdk/api/media_api.rb @@ -224,7 +224,7 @@ def list_media_with_http_info(account_id, opts = {}) end # Upload Media - # Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found [here](https://support.bandwidth.com/hc/en-us/articles/360014128994-What-MMS-file-types-are-supported-). + # Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported). # @param account_id [String] Your Bandwidth Account ID. # @param media_id [String] Media ID to retrieve. # @param body [File] @@ -238,7 +238,7 @@ def upload_media(account_id, media_id, body, opts = {}) end # Upload Media - # Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found [here](https://support.bandwidth.com/hc/en-us/articles/360014128994-What-MMS-file-types-are-supported-). + # Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported). # @param account_id [String] Your Bandwidth Account ID. # @param media_id [String] Media ID to retrieve. # @param body [File] diff --git a/lib/bandwidth-sdk/models/mms_message_content_file.rb b/lib/bandwidth-sdk/models/mms_message_content_file.rb index 73265f8b..7656b2ed 100644 --- a/lib/bandwidth-sdk/models/mms_message_content_file.rb +++ b/lib/bandwidth-sdk/models/mms_message_content_file.rb @@ -15,7 +15,7 @@ module Bandwidth class MmsMessageContentFile < ApiModelBase - # The URL of a media attachment. For MMS, the API limits file size to 3.5MB. Specific carriers and channels may have a smaller limit that could cause a large file to fail, see [here](https://support.bandwidth.com/hc/en-us/articles/360014235473-What-are-the-MMS-file-size-limits) for more details. + # The URL of a media attachment. For MMS, the API limits file size to 3.5MB. Specific carriers and channels may have a smaller limit that could cause a large file to fail, see more at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823216-what-are-the-mms-file-size-limits) for more details. attr_accessor :file_url # Attribute mapping from ruby-style variable name to JSON key. diff --git a/lib/bandwidth-sdk/models/tfv_submission_info.rb b/lib/bandwidth-sdk/models/tfv_submission_info.rb index 04a15ab4..b7a6d118 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. **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. + # Government-issued business identifying number. **Note: As of October 19th, 2026 this field will be required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** 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 format is accepted by the API, but alpha-3 is highly encouraged. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.** | 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 @@ -140,6 +141,7 @@ def self.openapi_nullable :'isv_reseller', :'business_registration_number', :'business_registration_type', + :'business_registration_issuing_country', ]) end diff --git a/lib/bandwidth-sdk/models/verification_request.rb b/lib/bandwidth-sdk/models/verification_request.rb index 94e073c1..0440ab5c 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. **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. + # Government-issued business identifying number. **Note: As of October 19th, 2026 this field will be required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** 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 format is accepted by the API, but alpha-3 is highly encouraged. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.** | 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', @@ -159,6 +160,7 @@ def self.openapi_nullable :'isv_reseller', :'business_registration_number', :'business_registration_type', + :'business_registration_issuing_country', :'help_message_response', :'cv_token' ]) diff --git a/lib/bandwidth-sdk/models/verification_update_request.rb b/lib/bandwidth-sdk/models/verification_update_request.rb index 88fdae92..4beea167 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. **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. + # Government-issued business identifying number. **Note: As of October 19th, 2026 this field will be required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** 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 format is accepted by the API, but alpha-3 is highly encouraged. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.** | 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' @@ -155,6 +156,7 @@ def self.openapi_nullable :'isv_reseller', :'business_registration_number', :'business_registration_type', + :'business_registration_issuing_country', :'help_message_response', :'cv_token' ]) From 61286bd0c4eb919882e76d4cff398427a2154c11 Mon Sep 17 00:00:00 2001 From: ckoegel Date: Tue, 7 Apr 2026 15:35:49 -0400 Subject: [PATCH 2/3] remove old models --- .../BusinessRegistrationIssuingCountryEnum.md | 15 ----- ...iness_registration_issuing_country_enum.rb | 55 ------------------- 2 files changed, 70 deletions(-) delete mode 100644 docs/BusinessRegistrationIssuingCountryEnum.md delete mode 100644 lib/bandwidth-sdk/models/business_registration_issuing_country_enum.rb diff --git a/docs/BusinessRegistrationIssuingCountryEnum.md b/docs/BusinessRegistrationIssuingCountryEnum.md deleted file mode 100644 index 0a7ba7c9..00000000 --- a/docs/BusinessRegistrationIssuingCountryEnum.md +++ /dev/null @@ -1,15 +0,0 @@ -# Bandwidth::BusinessRegistrationIssuingCountryEnum - -## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | - -## Example - -```ruby -require 'bandwidth-sdk' - -instance = Bandwidth::BusinessRegistrationIssuingCountryEnum.new() -``` - diff --git a/lib/bandwidth-sdk/models/business_registration_issuing_country_enum.rb b/lib/bandwidth-sdk/models/business_registration_issuing_country_enum.rb deleted file mode 100644 index 8ae201b7..00000000 --- a/lib/bandwidth-sdk/models/business_registration_issuing_country_enum.rb +++ /dev/null @@ -1,55 +0,0 @@ -=begin -#Bandwidth - -#Bandwidth's Communication APIs - -The version of the OpenAPI document: 1.0.0 -Contact: letstalk@bandwidth.com -Generated by: https://openapi-generator.tech -Generator version: 7.17.0 - -=end - -require 'date' -require 'time' - -module Bandwidth - class BusinessRegistrationIssuingCountryEnum - USA = 'USA'.freeze - CAN = 'CAN'.freeze - HKG = 'HKG'.freeze - GBR = 'GBR'.freeze - IRL = 'IRL'.freeze - BRA = 'BRA'.freeze - NLD = 'NLD'.freeze - AUS = 'AUS'.freeze - FRA = 'FRA'.freeze - NZL = 'NZL'.freeze - 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, CYP, IND, CHN, BGR].freeze - end - - # Builds the enum from string - # @param [String] The enum value in the form of the string - # @return [String] The enum value - def self.build_from_hash(value) - new.build_from_hash(value) - end - - # Builds the enum from string - # @param [String] The enum value in the form of the string - # @return [String] The enum value - def build_from_hash(value) - return value if BusinessRegistrationIssuingCountryEnum.all_vars.include?(value) - raise "Invalid ENUM value #{value} for class #BusinessRegistrationIssuingCountryEnum" - end - end -end From d94044ea04fab37f0adccd6a58a85d09abed0f8a Mon Sep 17 00:00:00 2001 From: ckoegel Date: Tue, 7 Apr 2026 15:35:53 -0400 Subject: [PATCH 3/3] update test --- spec/unit/api/toll_free_verification_api_spec.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/unit/api/toll_free_verification_api_spec.rb b/spec/unit/api/toll_free_verification_api_spec.rb index 0311504c..cebc5c0c 100644 --- a/spec/unit/api/toll_free_verification_api_spec.rb +++ b/spec/unit/api/toll_free_verification_api_spec.rb @@ -35,7 +35,7 @@ business_entity_type: Bandwidth::BusinessEntityTypeEnum::PUBLIC_PROFIT, business_registration_number: '123456789', business_registration_type: Bandwidth::BusinessRegistrationTypeEnum::EIN, - business_registration_issuing_country: Bandwidth::BusinessRegistrationIssuingCountryEnum::USA, + business_registration_issuing_country: 'USA', additional_information: 'additionalInformation', isv_reseller: 'isvReseller' } }