From 5b7261a6c243bad60c0340fd1a30469927c1fc7f Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Tue, 17 Mar 2026 18:55:24 +0000 Subject: [PATCH] Generate SDK with OpenAPI Generator Version --- .openapi-generator/FILES | 2 - README.md | 1 - api/openapi.yaml | 135 ++++++++++++++---- bandwidth.yml | 54 +++---- docs/TfvSubmissionInfo.md | 4 +- docs/VerificationRequest.md | 4 +- docs/VerificationUpdateRequest.md | 4 +- .../sdk/model/BusinessEntityTypeEnum.java | 2 +- .../model/BusinessRegistrationTypeEnum.java | 2 +- .../sdk/model/TfvSubmissionInfo.java | 18 ++- .../sdk/model/VerificationRequest.java | 18 ++- .../sdk/model/VerificationUpdateRequest.java | 18 ++- 12 files changed, 169 insertions(+), 93 deletions(-) diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index f732b9de..15c18499 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -12,7 +12,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 @@ -242,7 +241,6 @@ src/main/java/com/bandwidth/sdk/model/BlockedWebhook.java src/main/java/com/bandwidth/sdk/model/BridgeCompleteCallback.java src/main/java/com/bandwidth/sdk/model/BridgeTargetCompleteCallback.java src/main/java/com/bandwidth/sdk/model/BusinessEntityTypeEnum.java -src/main/java/com/bandwidth/sdk/model/BusinessRegistrationIssuingCountryEnum.java src/main/java/com/bandwidth/sdk/model/BusinessRegistrationTypeEnum.java src/main/java/com/bandwidth/sdk/model/CallDirectionEnum.java src/main/java/com/bandwidth/sdk/model/CallRecordingMetadata.java diff --git a/README.md b/README.md index 119e7021..11380861 100644 --- a/README.md +++ b/README.md @@ -192,7 +192,6 @@ Class | Method | HTTP request | Description - [BridgeCompleteCallback](docs/BridgeCompleteCallback.md) - [BridgeTargetCompleteCallback](docs/BridgeTargetCompleteCallback.md) - [BusinessEntityTypeEnum](docs/BusinessEntityTypeEnum.md) - - [BusinessRegistrationIssuingCountryEnum](docs/BusinessRegistrationIssuingCountryEnum.md) - [BusinessRegistrationTypeEnum](docs/BusinessRegistrationTypeEnum.md) - [CallDirectionEnum](docs/CallDirectionEnum.md) - [CallRecordingMetadata](docs/CallRecordingMetadata.md) diff --git a/api/openapi.yaml b/api/openapi.yaml index 5aa7b0b3..5350154c 100644 --- a/api/openapi.yaml +++ b/api/openapi.yaml @@ -13725,13 +13725,17 @@ components: example: Another Company Name Inc. type: string businessRegistrationNumber: - 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. example: 12-3456789 maxLength: 500 nullable: true type: string businessRegistrationTypeEnum: - description: The type of business registration number. + description: | + The type of business registration number. enum: - EIN - CBN @@ -13753,9 +13757,11 @@ components: - OTHER nullable: true type: string - businessRegistrationIssuingCountryEnum: + businessRegistrationIssuingCountry: description: |- - The country issuing the business registration in ISO-3166-1 alpha-3 format. + 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 | |----------------------|------------------------------------| @@ -13777,25 +13783,11 @@ components: | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | - enum: - - USA - - CAN - - HKG - - GBR - - IRL - - BRA - - NLD - - AUS - - FRA - - NZL - - DEU - - ESP - - CHE nullable: false type: string businessEntityTypeEnum: - 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 @@ -13921,7 +13913,10 @@ components: example: Another Company Name Inc. type: string businessRegistrationNumber: - 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. example: 12-3456789 maxLength: 500 nullable: true @@ -13929,7 +13924,33 @@ components: businessRegistrationType: $ref: "#/components/schemas/businessRegistrationTypeEnum" businessRegistrationIssuingCountry: - $ref: "#/components/schemas/businessRegistrationIssuingCountryEnum" + 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. + + **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 | + nullable: false + type: string businessEntityType: $ref: "#/components/schemas/businessEntityTypeEnum" helpMessageResponse: @@ -14025,7 +14046,10 @@ components: example: Another Company Name Inc. type: string businessRegistrationNumber: - 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. example: 12-3456789 maxLength: 500 nullable: true @@ -14035,7 +14059,33 @@ components: businessEntityType: $ref: "#/components/schemas/businessEntityTypeEnum" businessRegistrationIssuingCountry: - $ref: "#/components/schemas/businessRegistrationIssuingCountryEnum" + 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. + + **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 | + nullable: false + type: string helpMessageResponse: description: A message that gets sent to users requesting help. example: Please contact support for assistance. @@ -14703,7 +14753,7 @@ components: isvReseller: Test ISV businessRegistrationNumber: 12-3456789 productionMessageContent: Production message content - businessRegistrationIssuingCountry: USA + businessRegistrationIssuingCountry: businessRegistrationIssuingCountry businessAddress: zip: "27606" addr2: 2230 Bandmate Way @@ -14802,7 +14852,7 @@ components: isvReseller: Test ISV businessRegistrationNumber: 12-3456789 productionMessageContent: Production message content - businessRegistrationIssuingCountry: USA + businessRegistrationIssuingCountry: businessRegistrationIssuingCountry businessAddress: zip: "27606" addr2: 2230 Bandmate Way @@ -14873,7 +14923,10 @@ components: example: Another Company Name Inc. type: string businessRegistrationNumber: - 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. example: 12-3456789 maxLength: 500 nullable: true @@ -14881,7 +14934,33 @@ components: businessRegistrationType: $ref: "#/components/schemas/businessRegistrationTypeEnum" businessRegistrationIssuingCountry: - $ref: "#/components/schemas/businessRegistrationIssuingCountryEnum" + 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. + + **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 | + nullable: false + type: string businessEntityType: $ref: "#/components/schemas/businessEntityTypeEnum" type: object diff --git a/bandwidth.yml b/bandwidth.yml index 4948dd1d..0c6582e3 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/TfvSubmissionInfo.md b/docs/TfvSubmissionInfo.md index 471dd3f1..0718786a 100644 --- a/docs/TfvSubmissionInfo.md +++ b/docs/TfvSubmissionInfo.md @@ -19,9 +19,9 @@ |**privacyPolicyUrl** | **String** | The Toll-Free Verification request privacy policy URL. | [optional] | |**termsAndConditionsUrl** | **String** | The Toll-Free Verification request terms and conditions policy URL. | [optional] | |**businessDba** | **String** | The company 'Doing Business As'. | [optional] | -|**businessRegistrationNumber** | **String** | Government-issued business identifying number. | [optional] | +|**businessRegistrationNumber** | **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] | |**businessRegistrationType** | **BusinessRegistrationTypeEnum** | | [optional] | -|**businessRegistrationIssuingCountry** | **BusinessRegistrationIssuingCountryEnum** | | [optional] | +|**businessRegistrationIssuingCountry** | **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] | |**businessEntityType** | **BusinessEntityTypeEnum** | | [optional] | diff --git a/docs/VerificationRequest.md b/docs/VerificationRequest.md index b7bf408d..31d358e9 100644 --- a/docs/VerificationRequest.md +++ b/docs/VerificationRequest.md @@ -20,9 +20,9 @@ |**privacyPolicyUrl** | **String** | The Toll-Free Verification request privacy policy URL. | [optional] | |**termsAndConditionsUrl** | **String** | The Toll-Free Verification request terms and conditions policy URL. | [optional] | |**businessDba** | **String** | The company 'Doing Business As'. | [optional] | -|**businessRegistrationNumber** | **String** | Government-issued business identifying number. | [optional] | +|**businessRegistrationNumber** | **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] | |**businessRegistrationType** | **BusinessRegistrationTypeEnum** | | [optional] | -|**businessRegistrationIssuingCountry** | **BusinessRegistrationIssuingCountryEnum** | | [optional] | +|**businessRegistrationIssuingCountry** | **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] | |**businessEntityType** | **BusinessEntityTypeEnum** | | | |**helpMessageResponse** | **String** | A message that gets sent to users requesting help. | [optional] | |**ageGatedContent** | **Boolean** | Indicates whether the content is age-gated. | [optional] | diff --git a/docs/VerificationUpdateRequest.md b/docs/VerificationUpdateRequest.md index 32a954cc..e7d6d176 100644 --- a/docs/VerificationUpdateRequest.md +++ b/docs/VerificationUpdateRequest.md @@ -19,10 +19,10 @@ |**privacyPolicyUrl** | **String** | The Toll-Free Verification request privacy policy URL. | [optional] | |**termsAndConditionsUrl** | **String** | The Toll-Free Verification request terms and conditions policy URL. | [optional] | |**businessDba** | **String** | The company 'Doing Business As'. | [optional] | -|**businessRegistrationNumber** | **String** | Government-issued business identifying number. | [optional] | +|**businessRegistrationNumber** | **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] | |**businessRegistrationType** | **BusinessRegistrationTypeEnum** | | [optional] | |**businessEntityType** | **BusinessEntityTypeEnum** | | [optional] | -|**businessRegistrationIssuingCountry** | **BusinessRegistrationIssuingCountryEnum** | | [optional] | +|**businessRegistrationIssuingCountry** | **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] | |**helpMessageResponse** | **String** | A message that gets sent to users requesting help. | [optional] | |**ageGatedContent** | **Boolean** | Indicates whether the content is age-gated. | [optional] | |**cvToken** | **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/src/main/java/com/bandwidth/sdk/model/BusinessEntityTypeEnum.java b/src/main/java/com/bandwidth/sdk/model/BusinessEntityTypeEnum.java index 3b7f7b4f..a8c8b883 100644 --- a/src/main/java/com/bandwidth/sdk/model/BusinessEntityTypeEnum.java +++ b/src/main/java/com/bandwidth/sdk/model/BusinessEntityTypeEnum.java @@ -26,7 +26,7 @@ import com.google.gson.stream.JsonWriter; /** - * The type of registered business. If no option is applicable, please provide \"SOLE_PROPRIETOR\" as a value. + * The type of registered business. */ @JsonAdapter(BusinessEntityTypeEnum.Adapter.class) public enum BusinessEntityTypeEnum { diff --git a/src/main/java/com/bandwidth/sdk/model/BusinessRegistrationTypeEnum.java b/src/main/java/com/bandwidth/sdk/model/BusinessRegistrationTypeEnum.java index bf0a54ac..44ce104e 100644 --- a/src/main/java/com/bandwidth/sdk/model/BusinessRegistrationTypeEnum.java +++ b/src/main/java/com/bandwidth/sdk/model/BusinessRegistrationTypeEnum.java @@ -26,7 +26,7 @@ import com.google.gson.stream.JsonWriter; /** - * The type of business registration number. + * The type of business registration number. */ @JsonAdapter(BusinessRegistrationTypeEnum.Adapter.class) public enum BusinessRegistrationTypeEnum { diff --git a/src/main/java/com/bandwidth/sdk/model/TfvSubmissionInfo.java b/src/main/java/com/bandwidth/sdk/model/TfvSubmissionInfo.java index 1bd08048..a1e28ed6 100644 --- a/src/main/java/com/bandwidth/sdk/model/TfvSubmissionInfo.java +++ b/src/main/java/com/bandwidth/sdk/model/TfvSubmissionInfo.java @@ -17,7 +17,6 @@ import java.util.Locale; import com.bandwidth.sdk.model.Address; import com.bandwidth.sdk.model.BusinessEntityTypeEnum; -import com.bandwidth.sdk.model.BusinessRegistrationIssuingCountryEnum; import com.bandwidth.sdk.model.BusinessRegistrationTypeEnum; import com.bandwidth.sdk.model.Contact; import com.bandwidth.sdk.model.OptInWorkflow; @@ -132,7 +131,7 @@ public class TfvSubmissionInfo { public static final String SERIALIZED_NAME_BUSINESS_REGISTRATION_ISSUING_COUNTRY = "businessRegistrationIssuingCountry"; @SerializedName(SERIALIZED_NAME_BUSINESS_REGISTRATION_ISSUING_COUNTRY) @javax.annotation.Nullable - private BusinessRegistrationIssuingCountryEnum businessRegistrationIssuingCountry; + private String businessRegistrationIssuingCountry; public static final String SERIALIZED_NAME_BUSINESS_ENTITY_TYPE = "businessEntityType"; @SerializedName(SERIALIZED_NAME_BUSINESS_ENTITY_TYPE) @@ -378,7 +377,7 @@ public TfvSubmissionInfo businessRegistrationNumber(@javax.annotation.Nullable S } /** - * 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. * @return businessRegistrationNumber */ @javax.annotation.Nullable @@ -410,21 +409,21 @@ public void setBusinessRegistrationType(@javax.annotation.Nullable BusinessRegis } - public TfvSubmissionInfo businessRegistrationIssuingCountry(@javax.annotation.Nullable BusinessRegistrationIssuingCountryEnum businessRegistrationIssuingCountry) { + public TfvSubmissionInfo businessRegistrationIssuingCountry(@javax.annotation.Nullable String businessRegistrationIssuingCountry) { this.businessRegistrationIssuingCountry = businessRegistrationIssuingCountry; return this; } /** - * Get businessRegistrationIssuingCountry + * 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 | * @return businessRegistrationIssuingCountry */ @javax.annotation.Nullable - public BusinessRegistrationIssuingCountryEnum getBusinessRegistrationIssuingCountry() { + public String getBusinessRegistrationIssuingCountry() { return businessRegistrationIssuingCountry; } - public void setBusinessRegistrationIssuingCountry(@javax.annotation.Nullable BusinessRegistrationIssuingCountryEnum businessRegistrationIssuingCountry) { + public void setBusinessRegistrationIssuingCountry(@javax.annotation.Nullable String businessRegistrationIssuingCountry) { this.businessRegistrationIssuingCountry = businessRegistrationIssuingCountry; } @@ -641,9 +640,8 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if (jsonObj.get("businessRegistrationType") != null && !jsonObj.get("businessRegistrationType").isJsonNull()) { BusinessRegistrationTypeEnum.validateJsonElement(jsonObj.get("businessRegistrationType")); } - // validate the optional field `businessRegistrationIssuingCountry` - if (jsonObj.get("businessRegistrationIssuingCountry") != null && !jsonObj.get("businessRegistrationIssuingCountry").isJsonNull()) { - BusinessRegistrationIssuingCountryEnum.validateJsonElement(jsonObj.get("businessRegistrationIssuingCountry")); + if ((jsonObj.get("businessRegistrationIssuingCountry") != null && !jsonObj.get("businessRegistrationIssuingCountry").isJsonNull()) && !jsonObj.get("businessRegistrationIssuingCountry").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `businessRegistrationIssuingCountry` to be a primitive type in the JSON string but got `%s`", jsonObj.get("businessRegistrationIssuingCountry").toString())); } // validate the optional field `businessEntityType` if (jsonObj.get("businessEntityType") != null && !jsonObj.get("businessEntityType").isJsonNull()) { diff --git a/src/main/java/com/bandwidth/sdk/model/VerificationRequest.java b/src/main/java/com/bandwidth/sdk/model/VerificationRequest.java index 8de3d51e..fdaef0e4 100644 --- a/src/main/java/com/bandwidth/sdk/model/VerificationRequest.java +++ b/src/main/java/com/bandwidth/sdk/model/VerificationRequest.java @@ -17,7 +17,6 @@ import java.util.Locale; import com.bandwidth.sdk.model.Address; import com.bandwidth.sdk.model.BusinessEntityTypeEnum; -import com.bandwidth.sdk.model.BusinessRegistrationIssuingCountryEnum; import com.bandwidth.sdk.model.BusinessRegistrationTypeEnum; import com.bandwidth.sdk.model.Contact; import com.bandwidth.sdk.model.OptInWorkflow; @@ -139,7 +138,7 @@ public class VerificationRequest { public static final String SERIALIZED_NAME_BUSINESS_REGISTRATION_ISSUING_COUNTRY = "businessRegistrationIssuingCountry"; @SerializedName(SERIALIZED_NAME_BUSINESS_REGISTRATION_ISSUING_COUNTRY) @javax.annotation.Nullable - private BusinessRegistrationIssuingCountryEnum businessRegistrationIssuingCountry; + private String businessRegistrationIssuingCountry; public static final String SERIALIZED_NAME_BUSINESS_ENTITY_TYPE = "businessEntityType"; @SerializedName(SERIALIZED_NAME_BUSINESS_ENTITY_TYPE) @@ -427,7 +426,7 @@ public VerificationRequest businessRegistrationNumber(@javax.annotation.Nullable } /** - * 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. * @return businessRegistrationNumber */ @javax.annotation.Nullable @@ -459,21 +458,21 @@ public void setBusinessRegistrationType(@javax.annotation.Nullable BusinessRegis } - public VerificationRequest businessRegistrationIssuingCountry(@javax.annotation.Nullable BusinessRegistrationIssuingCountryEnum businessRegistrationIssuingCountry) { + public VerificationRequest businessRegistrationIssuingCountry(@javax.annotation.Nullable String businessRegistrationIssuingCountry) { this.businessRegistrationIssuingCountry = businessRegistrationIssuingCountry; return this; } /** - * Get businessRegistrationIssuingCountry + * 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 | * @return businessRegistrationIssuingCountry */ @javax.annotation.Nullable - public BusinessRegistrationIssuingCountryEnum getBusinessRegistrationIssuingCountry() { + public String getBusinessRegistrationIssuingCountry() { return businessRegistrationIssuingCountry; } - public void setBusinessRegistrationIssuingCountry(@javax.annotation.Nullable BusinessRegistrationIssuingCountryEnum businessRegistrationIssuingCountry) { + public void setBusinessRegistrationIssuingCountry(@javax.annotation.Nullable String businessRegistrationIssuingCountry) { this.businessRegistrationIssuingCountry = businessRegistrationIssuingCountry; } @@ -762,9 +761,8 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if (jsonObj.get("businessRegistrationType") != null && !jsonObj.get("businessRegistrationType").isJsonNull()) { BusinessRegistrationTypeEnum.validateJsonElement(jsonObj.get("businessRegistrationType")); } - // validate the optional field `businessRegistrationIssuingCountry` - if (jsonObj.get("businessRegistrationIssuingCountry") != null && !jsonObj.get("businessRegistrationIssuingCountry").isJsonNull()) { - BusinessRegistrationIssuingCountryEnum.validateJsonElement(jsonObj.get("businessRegistrationIssuingCountry")); + if ((jsonObj.get("businessRegistrationIssuingCountry") != null && !jsonObj.get("businessRegistrationIssuingCountry").isJsonNull()) && !jsonObj.get("businessRegistrationIssuingCountry").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `businessRegistrationIssuingCountry` to be a primitive type in the JSON string but got `%s`", jsonObj.get("businessRegistrationIssuingCountry").toString())); } // validate the required field `businessEntityType` BusinessEntityTypeEnum.validateJsonElement(jsonObj.get("businessEntityType")); diff --git a/src/main/java/com/bandwidth/sdk/model/VerificationUpdateRequest.java b/src/main/java/com/bandwidth/sdk/model/VerificationUpdateRequest.java index 696c2c61..b8c2bcdb 100644 --- a/src/main/java/com/bandwidth/sdk/model/VerificationUpdateRequest.java +++ b/src/main/java/com/bandwidth/sdk/model/VerificationUpdateRequest.java @@ -17,7 +17,6 @@ import java.util.Locale; import com.bandwidth.sdk.model.Address; import com.bandwidth.sdk.model.BusinessEntityTypeEnum; -import com.bandwidth.sdk.model.BusinessRegistrationIssuingCountryEnum; import com.bandwidth.sdk.model.BusinessRegistrationTypeEnum; import com.bandwidth.sdk.model.Contact; import com.bandwidth.sdk.model.OptInWorkflow; @@ -137,7 +136,7 @@ public class VerificationUpdateRequest { public static final String SERIALIZED_NAME_BUSINESS_REGISTRATION_ISSUING_COUNTRY = "businessRegistrationIssuingCountry"; @SerializedName(SERIALIZED_NAME_BUSINESS_REGISTRATION_ISSUING_COUNTRY) @javax.annotation.Nullable - private BusinessRegistrationIssuingCountryEnum businessRegistrationIssuingCountry; + private String businessRegistrationIssuingCountry; public static final String SERIALIZED_NAME_HELP_MESSAGE_RESPONSE = "helpMessageResponse"; @SerializedName(SERIALIZED_NAME_HELP_MESSAGE_RESPONSE) @@ -393,7 +392,7 @@ public VerificationUpdateRequest businessRegistrationNumber(@javax.annotation.Nu } /** - * 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. * @return businessRegistrationNumber */ @javax.annotation.Nullable @@ -444,21 +443,21 @@ public void setBusinessEntityType(@javax.annotation.Nullable BusinessEntityTypeE } - public VerificationUpdateRequest businessRegistrationIssuingCountry(@javax.annotation.Nullable BusinessRegistrationIssuingCountryEnum businessRegistrationIssuingCountry) { + public VerificationUpdateRequest businessRegistrationIssuingCountry(@javax.annotation.Nullable String businessRegistrationIssuingCountry) { this.businessRegistrationIssuingCountry = businessRegistrationIssuingCountry; return this; } /** - * Get businessRegistrationIssuingCountry + * 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 | * @return businessRegistrationIssuingCountry */ @javax.annotation.Nullable - public BusinessRegistrationIssuingCountryEnum getBusinessRegistrationIssuingCountry() { + public String getBusinessRegistrationIssuingCountry() { return businessRegistrationIssuingCountry; } - public void setBusinessRegistrationIssuingCountry(@javax.annotation.Nullable BusinessRegistrationIssuingCountryEnum businessRegistrationIssuingCountry) { + public void setBusinessRegistrationIssuingCountry(@javax.annotation.Nullable String businessRegistrationIssuingCountry) { this.businessRegistrationIssuingCountry = businessRegistrationIssuingCountry; } @@ -724,9 +723,8 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if (jsonObj.get("businessEntityType") != null && !jsonObj.get("businessEntityType").isJsonNull()) { BusinessEntityTypeEnum.validateJsonElement(jsonObj.get("businessEntityType")); } - // validate the optional field `businessRegistrationIssuingCountry` - if (jsonObj.get("businessRegistrationIssuingCountry") != null && !jsonObj.get("businessRegistrationIssuingCountry").isJsonNull()) { - BusinessRegistrationIssuingCountryEnum.validateJsonElement(jsonObj.get("businessRegistrationIssuingCountry")); + if ((jsonObj.get("businessRegistrationIssuingCountry") != null && !jsonObj.get("businessRegistrationIssuingCountry").isJsonNull()) && !jsonObj.get("businessRegistrationIssuingCountry").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `businessRegistrationIssuingCountry` to be a primitive type in the JSON string but got `%s`", jsonObj.get("businessRegistrationIssuingCountry").toString())); } if ((jsonObj.get("helpMessageResponse") != null && !jsonObj.get("helpMessageResponse").isJsonNull()) && !jsonObj.get("helpMessageResponse").isJsonPrimitive()) { throw new IllegalArgumentException(String.format(Locale.ROOT, "Expected the field `helpMessageResponse` to be a primitive type in the JSON string but got `%s`", jsonObj.get("helpMessageResponse").toString()));