bandwidth-sdk 18.3.0 → 18.3.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.
@@ -15,7 +15,7 @@
15
15
  {{moduleName}} - the Ruby gem for the {{appName}} SDK
16
16
 
17
17
  ### Generated with the command:
18
- `openapi-generator generate -g ruby -i bandwidth.yml -c openapi-config.yml -o ./`
18
+ `bash generate.sh`
19
19
 
20
20
  {{#appDescriptionWithNewLines}}
21
21
  {{{.}}}
@@ -43,7 +43,9 @@ require 'bandwidth-sdk/models/bxml/verb'
43
43
  require 'bandwidth-sdk/models/bxml/nestable_verb'
44
44
  require 'bandwidth-sdk/models/bxml/verbs/bridge'
45
45
  require 'bandwidth-sdk/models/bxml/verbs/conference'
46
+ require 'bandwidth-sdk/models/bxml/verbs/connect'
46
47
  require 'bandwidth-sdk/models/bxml/verbs/custom_param'
48
+ require 'bandwidth-sdk/models/bxml/verbs/endpoint'
47
49
  require 'bandwidth-sdk/models/bxml/verbs/forward'
48
50
  require 'bandwidth-sdk/models/bxml/verbs/gather'
49
51
  require 'bandwidth-sdk/models/bxml/verbs/hangup'
data/docs/MediaApi.md CHANGED
@@ -242,7 +242,7 @@ end
242
242
 
243
243
  Upload Media
244
244
 
245
- 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).
245
+ Upload a file. Filename should always be unique. Reusing filenames may result in the wrong media being sent. 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).
246
246
 
247
247
  ### Examples
248
248
 
@@ -265,7 +265,7 @@ media_id = 'bw.png' # String | The ID of the media file.
265
265
  body = File.new('/path/to/some/file') # File |
266
266
  opts = {
267
267
  content_type: 'audio/wav', # String | The media type of the entity-body.
268
- cache_control: 'no-cache' # String | General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.
268
+ cache_control: 'no-cache' # String | Pass-through header stored with the media and returned when the media is retrieved by the user. Does not affect internal server caching behavior.
269
269
  }
270
270
 
271
271
  begin
@@ -302,7 +302,7 @@ end
302
302
  | **media_id** | **String** | The ID of the media file. | |
303
303
  | **body** | **File** | | |
304
304
  | **content_type** | **String** | The media type of the entity-body. | [optional] |
305
- | **cache_control** | **String** | General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. | [optional] |
305
+ | **cache_control** | **String** | Pass-through header stored with the media and returned when the media is retrieved by the user. Does not affect internal server caching behavior. | [optional] |
306
306
 
307
307
  ### Return type
308
308
 
@@ -16,7 +16,7 @@ require 'bandwidth-sdk'
16
16
  instance = Bandwidth::RbmActionBase.new(
17
17
  type: null,
18
18
  text: Hello world,
19
- postback_data: [B@dc3eda6
19
+ postback_data: [B@11fa11b2
20
20
  )
21
21
  ```
22
22
 
@@ -15,7 +15,7 @@ require 'bandwidth-sdk'
15
15
 
16
16
  instance = Bandwidth::RbmSuggestionResponse.new(
17
17
  text: Yes, I would like to proceed,
18
- postback_data: [B@dc3eda6,
18
+ postback_data: [B@11fa11b2,
19
19
  paired_message_id: 1752697342534u24xerqdukke523x
20
20
  )
21
21
  ```
@@ -16,9 +16,9 @@
16
16
  | **privacy_policy_url** | **String** | The Toll-Free Verification request privacy policy URL. | [optional] |
17
17
  | **terms_and_conditions_url** | **String** | The Toll-Free Verification request terms and conditions policy URL. | [optional] |
18
18
  | **business_dba** | **String** | The company 'Doing Business As'. | [optional] |
19
- | **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] |
19
+ | **business_registration_number** | **String** | Government-issued business identifying number. **As of October 19th, 2026 this field is required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** | [optional] |
20
20
  | **business_registration_type** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] |
21
- | **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] |
21
+ | **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. **As of October 19th, 2026 this field is 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] |
22
22
  | **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] |
23
23
 
24
24
  ## Example
@@ -96,7 +96,7 @@ end
96
96
 
97
97
  Delete a Toll-Free Verification Submission
98
98
 
99
- Delete a toll-free verification submission for a toll-free number.
99
+ Delete a toll-free verification submission for a toll-free number. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, it will be cancelled and the submission will then be deleted asynchronously.
100
100
 
101
101
  ### Examples
102
102
 
@@ -462,7 +462,7 @@ end
462
462
 
463
463
  Request Toll-Free Verification
464
464
 
465
- Submit a request for verification of a toll-free phone number.
465
+ Submit a request for verification of a toll-free phone number. **Upcoming change (effective January 2027):** If any phone number in the request already has a verification in progress, the request will be rejected with a `409 Conflict`. This check is all-or-nothing: if a single phone number conflicts, the entire request is rejected and **none** of the phone numbers in the request are submitted. Today, these requests are accepted with a `202`.
466
466
 
467
467
  ### Examples
468
468
 
@@ -536,7 +536,7 @@ nil (empty response body)
536
536
 
537
537
  Update Toll-Free Verification Request
538
538
 
539
- Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true).
539
+ Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). Returns a `404` if no verification request exists for the phone number, and a `400` if the existing request is not eligible for resubmission. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, the update will be rejected with a `409 Conflict`.
540
540
 
541
541
  ### Examples
542
542
 
@@ -17,9 +17,9 @@
17
17
  | **privacy_policy_url** | **String** | The Toll-Free Verification request privacy policy URL. | [optional] |
18
18
  | **terms_and_conditions_url** | **String** | The Toll-Free Verification request terms and conditions policy URL. | [optional] |
19
19
  | **business_dba** | **String** | The company 'Doing Business As'. | [optional] |
20
- | **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] |
20
+ | **business_registration_number** | **String** | Government-issued business identifying number. **As of October 19th, 2026 this field is required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** | [optional] |
21
21
  | **business_registration_type** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] |
22
- | **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] |
22
+ | **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. **As of October 19th, 2026 this field is 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] |
23
23
  | **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | |
24
24
  | **help_message_response** | **String** | A message that gets sent to users requesting help. | [optional] |
25
25
  | **age_gated_content** | **Boolean** | Indicates whether the content is age-gated. | [optional] |
@@ -16,10 +16,10 @@
16
16
  | **privacy_policy_url** | **String** | The Toll-Free Verification request privacy policy URL. | [optional] |
17
17
  | **terms_and_conditions_url** | **String** | The Toll-Free Verification request terms and conditions policy URL. | [optional] |
18
18
  | **business_dba** | **String** | The company 'Doing Business As'. | [optional] |
19
- | **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] |
19
+ | **business_registration_number** | **String** | Government-issued business identifying number. **As of October 19th, 2026 this field is required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** | [optional] |
20
20
  | **business_registration_type** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] |
21
- | **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] |
22
- | **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] |
21
+ | **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | |
22
+ | **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. **As of October 19th, 2026 this field is 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] |
23
23
  | **help_message_response** | **String** | A message that gets sent to users requesting help. | [optional] |
24
24
  | **age_gated_content** | **Boolean** | Indicates whether the content is age-gated. | [optional] |
25
25
  | **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] |
data/generate.sh ADDED
@@ -0,0 +1,9 @@
1
+ #!/bin/bash
2
+ set -euo pipefail
3
+ cd "$(dirname "${BASH_SOURCE[0]}")"
4
+
5
+ npx --yes @openapitools/openapi-generator-cli generate \
6
+ -i bandwidth.yml -g ruby -c openapi-config.yml -o . "$@"
7
+
8
+ bundle install
9
+ bundle exec rubocop -A
@@ -224,13 +224,13 @@ module Bandwidth
224
224
  end
225
225
 
226
226
  # Upload Media
227
- # 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).
227
+ # Upload a file. Filename should always be unique. Reusing filenames may result in the wrong media being sent. 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).
228
228
  # @param account_id [String] This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
229
229
  # @param media_id [String] The ID of the media file.
230
230
  # @param body [File]
231
231
  # @param [Hash] opts the optional parameters
232
232
  # @option opts [String] :content_type The media type of the entity-body.
233
- # @option opts [String] :cache_control General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.
233
+ # @option opts [String] :cache_control Pass-through header stored with the media and returned when the media is retrieved by the user. Does not affect internal server caching behavior.
234
234
  # @return [nil]
235
235
  def upload_media(account_id, media_id, body, opts = {})
236
236
  upload_media_with_http_info(account_id, media_id, body, opts)
@@ -238,13 +238,13 @@ module Bandwidth
238
238
  end
239
239
 
240
240
  # Upload Media
241
- # 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).
241
+ # Upload a file. Filename should always be unique. Reusing filenames may result in the wrong media being sent. 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).
242
242
  # @param account_id [String] This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
243
243
  # @param media_id [String] The ID of the media file.
244
244
  # @param body [File]
245
245
  # @param [Hash] opts the optional parameters
246
246
  # @option opts [String] :content_type The media type of the entity-body.
247
- # @option opts [String] :cache_control General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.
247
+ # @option opts [String] :cache_control Pass-through header stored with the media and returned when the media is retrieved by the user. Does not affect internal server caching behavior.
248
248
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
249
249
  def upload_media_with_http_info(account_id, media_id, body, opts = {})
250
250
  if @api_client.config.debugging
@@ -94,7 +94,7 @@ module Bandwidth
94
94
  end
95
95
 
96
96
  # Delete a Toll-Free Verification Submission
97
- # Delete a toll-free verification submission for a toll-free number.
97
+ # Delete a toll-free verification submission for a toll-free number. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, it will be cancelled and the submission will then be deleted asynchronously.
98
98
  # @param account_id [String] Your Bandwidth Account ID.
99
99
  # @param phone_number [String] Valid Toll-Free telephone number in E.164 format.
100
100
  # @param [Hash] opts the optional parameters
@@ -105,7 +105,7 @@ module Bandwidth
105
105
  end
106
106
 
107
107
  # Delete a Toll-Free Verification Submission
108
- # Delete a toll-free verification submission for a toll-free number.
108
+ # Delete a toll-free verification submission for a toll-free number. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, it will be cancelled and the submission will then be deleted asynchronously.
109
109
  # @param account_id [String] Your Bandwidth Account ID.
110
110
  # @param phone_number [String] Valid Toll-Free telephone number in E.164 format.
111
111
  # @param [Hash] opts the optional parameters
@@ -447,7 +447,7 @@ module Bandwidth
447
447
  end
448
448
 
449
449
  # Request Toll-Free Verification
450
- # Submit a request for verification of a toll-free phone number.
450
+ # Submit a request for verification of a toll-free phone number. **Upcoming change (effective January 2027):** If any phone number in the request already has a verification in progress, the request will be rejected with a `409 Conflict`. This check is all-or-nothing: if a single phone number conflicts, the entire request is rejected and **none** of the phone numbers in the request are submitted. Today, these requests are accepted with a `202`.
451
451
  # @param account_id [String] Your Bandwidth Account ID.
452
452
  # @param verification_request [VerificationRequest] Request for verification of a toll-free phone number.
453
453
  # @param [Hash] opts the optional parameters
@@ -458,7 +458,7 @@ module Bandwidth
458
458
  end
459
459
 
460
460
  # Request Toll-Free Verification
461
- # Submit a request for verification of a toll-free phone number.
461
+ # Submit a request for verification of a toll-free phone number. **Upcoming change (effective January 2027):** If any phone number in the request already has a verification in progress, the request will be rejected with a &#x60;409 Conflict&#x60;. This check is all-or-nothing: if a single phone number conflicts, the entire request is rejected and **none** of the phone numbers in the request are submitted. Today, these requests are accepted with a &#x60;202&#x60;.
462
462
  # @param account_id [String] Your Bandwidth Account ID.
463
463
  # @param verification_request [VerificationRequest] Request for verification of a toll-free phone number.
464
464
  # @param [Hash] opts the optional parameters
@@ -521,7 +521,7 @@ module Bandwidth
521
521
  end
522
522
 
523
523
  # Update Toll-Free Verification Request
524
- # Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true).
524
+ # Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). Returns a `404` if no verification request exists for the phone number, and a `400` if the existing request is not eligible for resubmission. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, the update will be rejected with a `409 Conflict`.
525
525
  # @param account_id [String] Your Bandwidth Account ID.
526
526
  # @param phone_number [String] Valid Toll-Free telephone number in E.164 format.
527
527
  # @param tfv_submission_wrapper [TfvSubmissionWrapper] Update a request for verification of a toll-free phone number.
@@ -533,7 +533,7 @@ module Bandwidth
533
533
  end
534
534
 
535
535
  # Update Toll-Free Verification Request
536
- # Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true).
536
+ # Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). Returns a &#x60;404&#x60; if no verification request exists for the phone number, and a &#x60;400&#x60; if the existing request is not eligible for resubmission. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, the update will be rejected with a &#x60;409 Conflict&#x60;.
537
537
  # @param account_id [String] Your Bandwidth Account ID.
538
538
  # @param phone_number [String] Valid Toll-Free telephone number in E.164 format.
539
539
  # @param tfv_submission_wrapper [TfvSubmissionWrapper] Update a request for verification of a toll-free phone number.
@@ -48,12 +48,12 @@ module Bandwidth
48
48
  # The company 'Doing Business As'.
49
49
  attr_accessor :business_dba
50
50
 
51
- # 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.**
51
+ # Government-issued business identifying number. **As of October 19th, 2026 this field is required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.**
52
52
  attr_accessor :business_registration_number
53
53
 
54
54
  attr_accessor :business_registration_type
55
55
 
56
- # 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 |
56
+ # 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. **As of October 19th, 2026 this field is 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 |
57
57
  attr_accessor :business_registration_issuing_country
58
58
 
59
59
  attr_accessor :business_entity_type
@@ -50,12 +50,12 @@ module Bandwidth
50
50
  # The company 'Doing Business As'.
51
51
  attr_accessor :business_dba
52
52
 
53
- # 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.**
53
+ # Government-issued business identifying number. **As of October 19th, 2026 this field is required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.**
54
54
  attr_accessor :business_registration_number
55
55
 
56
56
  attr_accessor :business_registration_type
57
57
 
58
- # 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 |
58
+ # 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. **As of October 19th, 2026 this field is 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 |
59
59
  attr_accessor :business_registration_issuing_country
60
60
 
61
61
  attr_accessor :business_entity_type
@@ -48,14 +48,14 @@ module Bandwidth
48
48
  # The company 'Doing Business As'.
49
49
  attr_accessor :business_dba
50
50
 
51
- # 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.**
51
+ # Government-issued business identifying number. **As of October 19th, 2026 this field is required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.**
52
52
  attr_accessor :business_registration_number
53
53
 
54
54
  attr_accessor :business_registration_type
55
55
 
56
56
  attr_accessor :business_entity_type
57
57
 
58
- # 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 |
58
+ # 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. **As of October 19th, 2026 this field is 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 |
59
59
  attr_accessor :business_registration_issuing_country
60
60
 
61
61
  # A message that gets sent to users requesting help.
@@ -250,6 +250,8 @@ module Bandwidth
250
250
 
251
251
  if attributes.key?(:'business_entity_type')
252
252
  self.business_entity_type = attributes[:'business_entity_type']
253
+ else
254
+ self.business_entity_type = nil
253
255
  end
254
256
 
255
257
  if attributes.key?(:'business_registration_issuing_country')
@@ -366,6 +368,10 @@ module Bandwidth
366
368
  invalid_properties.push('invalid value for "business_registration_number", the character length must be smaller than or equal to 500.')
367
369
  end
368
370
 
371
+ if @business_entity_type.nil?
372
+ invalid_properties.push('invalid value for "business_entity_type", business_entity_type cannot be nil.')
373
+ end
374
+
369
375
  if !@help_message_response.nil? && @help_message_response.to_s.length > 500
370
376
  invalid_properties.push('invalid value for "help_message_response", the character length must be smaller than or equal to 500.')
371
377
  end
@@ -408,6 +414,7 @@ module Bandwidth
408
414
  return false if !@terms_and_conditions_url.nil? && @terms_and_conditions_url.to_s.length > 500
409
415
  return false if !@business_dba.nil? && @business_dba.to_s.length > 500
410
416
  return false if !@business_registration_number.nil? && @business_registration_number.to_s.length > 500
417
+ return false if @business_entity_type.nil?
411
418
  return false if !@help_message_response.nil? && @help_message_response.to_s.length > 500
412
419
  return false if !@cv_token.nil? && @cv_token.to_s.length > 500
413
420
  return false if !@cv_token.nil? && @cv_token.to_s.length < 0
@@ -596,6 +603,16 @@ module Bandwidth
596
603
  @business_registration_number = business_registration_number
597
604
  end
598
605
 
606
+ # Custom attribute writer method with validation
607
+ # @param [Object] business_entity_type Value to be assigned
608
+ def business_entity_type=(business_entity_type)
609
+ if business_entity_type.nil?
610
+ fail ArgumentError, 'business_entity_type cannot be nil'
611
+ end
612
+
613
+ @business_entity_type = business_entity_type
614
+ end
615
+
599
616
  # Custom attribute writer method with validation
600
617
  # @param [Object] help_message_response Value to be assigned
601
618
  def help_message_response=(help_message_response)
@@ -11,5 +11,5 @@ Generator version: 7.24.0
11
11
  =end
12
12
 
13
13
  module Bandwidth
14
- VERSION = '18.3.0'
14
+ VERSION = '18.3.1'
15
15
  end
@@ -44,7 +44,8 @@ describe Bandwidth::TfvSubmissionWrapper do
44
44
  optInWorkflow: { description: 'opt-in via website', imageUrls: ['https://example.com/optin.png'] },
45
45
  privacyPolicyUrl: 'https://example.com/privacy',
46
46
  termsAndConditionsUrl: 'https://example.com/terms',
47
- businessDba: 'Bandwidth Inc'
47
+ businessDba: 'Bandwidth Inc',
48
+ businessEntityType: Bandwidth::BusinessEntityTypeEnum::PRIVATE_PROFIT
48
49
  }
49
50
  })
50
51
  expect(tfv_submission_wrapper_from_hash).to be_instance_of(Bandwidth::TfvSubmissionWrapper)
@@ -7,7 +7,8 @@ describe Bandwidth::VerificationUpdateRequest do
7
7
  use_case: 'baseline use case',
8
8
  use_case_summary: 'baseline summary',
9
9
  production_message_content: 'baseline message',
10
- opt_in_workflow: { description: 'baseline opt-in', imageUrls: [] }
10
+ opt_in_workflow: { description: 'baseline opt-in', imageUrls: [] },
11
+ business_entity_type: Bandwidth::BusinessEntityTypeEnum::PRIVATE_PROFIT
11
12
  }) }
12
13
  let(:verification_update_request_values) { Bandwidth::VerificationUpdateRequest.new({
13
14
  business_address: { name: 'Bandwidth' },
@@ -126,7 +127,8 @@ describe Bandwidth::VerificationUpdateRequest do
126
127
  use_case: 'baseline use case',
127
128
  use_case_summary: 'baseline summary',
128
129
  production_message_content: 'baseline message',
129
- opt_in_workflow: { description: 'baseline opt-in', imageUrls: [] }
130
+ opt_in_workflow: { description: 'baseline opt-in', imageUrls: [] },
131
+ business_entity_type: Bandwidth::BusinessEntityTypeEnum::PRIVATE_PROFIT
130
132
  })
131
133
  expect(verification_update_request_default.eql?(verification_update_request_equal)).to be true
132
134
  expect(verification_update_request_default.eql?(verification_update_request_values)).to be false
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: bandwidth-sdk
3
3
  version: !ruby/object:Gem::Version
4
- version: 18.3.0
4
+ version: 18.3.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Bandwidth
@@ -367,6 +367,7 @@ files:
367
367
  - docs/WebhookSubscriptionTypeEnum.md
368
368
  - docs/WebhookSubscriptionsListBody.md
369
369
  - generate-model-tests.sh
370
+ - generate.sh
370
371
  - git_push.sh
371
372
  - lib/bandwidth-sdk.rb
372
373
  - lib/bandwidth-sdk/api/calls_api.rb