Generate SDK with OpenAPI Generator Version

Author: DX-Bandwidth

.openapi-generator/FILES

@@ -28,7 +28,6 @@ bandwidth/models/blocked_webhook.py
 bandwidth/models/bridge_complete_callback.py
 bandwidth/models/bridge_target_complete_callback.py
 bandwidth/models/business_entity_type_enum.py
-bandwidth/models/business_registration_issuing_country_enum.py
 bandwidth/models/business_registration_type_enum.py
 bandwidth/models/call_direction_enum.py
 bandwidth/models/call_recording_metadata.py
@@ -207,7 +206,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

README.md

@@ -166,7 +166,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)

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:

bandwidth/__init__.py

@@ -48,7 +48,6 @@
     "BridgeCompleteCallback",
     "BridgeTargetCompleteCallback",
     "BusinessEntityTypeEnum",
-    "BusinessRegistrationIssuingCountryEnum",
     "BusinessRegistrationTypeEnum",
     "CallDirectionEnum",
     "CallRecordingMetadata",
@@ -252,7 +251,6 @@
 from bandwidth.models.bridge_complete_callback import BridgeCompleteCallback as BridgeCompleteCallback
 from bandwidth.models.bridge_target_complete_callback import BridgeTargetCompleteCallback as BridgeTargetCompleteCallback
 from bandwidth.models.business_entity_type_enum import BusinessEntityTypeEnum as BusinessEntityTypeEnum
-from bandwidth.models.business_registration_issuing_country_enum import BusinessRegistrationIssuingCountryEnum as BusinessRegistrationIssuingCountryEnum
 from bandwidth.models.business_registration_type_enum import BusinessRegistrationTypeEnum as BusinessRegistrationTypeEnum
 from bandwidth.models.call_direction_enum import CallDirectionEnum as CallDirectionEnum
 from bandwidth.models.call_recording_metadata import CallRecordingMetadata as CallRecordingMetadata

bandwidth/models/__init__.py

@@ -23,7 +23,6 @@
 from bandwidth.models.bridge_complete_callback import BridgeCompleteCallback
 from bandwidth.models.bridge_target_complete_callback import BridgeTargetCompleteCallback
 from bandwidth.models.business_entity_type_enum import BusinessEntityTypeEnum
-from bandwidth.models.business_registration_issuing_country_enum import BusinessRegistrationIssuingCountryEnum
 from bandwidth.models.business_registration_type_enum import BusinessRegistrationTypeEnum
 from bandwidth.models.call_direction_enum import CallDirectionEnum
 from bandwidth.models.call_recording_metadata import CallRecordingMetadata

bandwidth/models/business_entity_type_enum.py

@@ -21,7 +21,7 @@
 
 class BusinessEntityTypeEnum(str, Enum):
     """
-    The type of registered business. If no option is applicable, please provide \"SOLE_PROPRIETOR\" as a value.
+    The type of registered business. 
     """
 
     """

bandwidth/models/business_registration_type_enum.py

@@ -21,7 +21,7 @@
 
 class BusinessRegistrationTypeEnum(str, Enum):
     """
-    The type of business registration number.
+    The type of business registration number. 
     """
 
     """

bandwidth/models/tfv_submission_info.py

@@ -23,7 +23,6 @@
 from typing_extensions import Annotated
 from bandwidth.models.address import Address
 from bandwidth.models.business_entity_type_enum import BusinessEntityTypeEnum
-from bandwidth.models.business_registration_issuing_country_enum import BusinessRegistrationIssuingCountryEnum
 from bandwidth.models.business_registration_type_enum import BusinessRegistrationTypeEnum
 from bandwidth.models.contact import Contact
 from bandwidth.models.opt_in_workflow import OptInWorkflow
@@ -46,9 +45,9 @@ class TfvSubmissionInfo(BaseModel):
     privacy_policy_url: Optional[StrictStr] = Field(default=None, description="The Toll-Free Verification request privacy policy URL.", alias="privacyPolicyUrl")
     terms_and_conditions_url: Optional[StrictStr] = Field(default=None, description="The Toll-Free Verification request terms and conditions policy URL.", alias="termsAndConditionsUrl")
     business_dba: Optional[StrictStr] = Field(default=None, description="The company 'Doing Business As'.", alias="businessDba")
-    business_registration_number: Optional[Annotated[str, Field(strict=True, max_length=500)]] = Field(default=None, description="Government-issued business identifying number.", alias="businessRegistrationNumber")
+    business_registration_number: Optional[Annotated[str, Field(strict=True, max_length=500)]] = Field(default=None, 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. ", alias="businessRegistrationNumber")
     business_registration_type: Optional[BusinessRegistrationTypeEnum] = Field(default=None, alias="businessRegistrationType")
-    business_registration_issuing_country: Optional[BusinessRegistrationIssuingCountryEnum] = Field(default=None, alias="businessRegistrationIssuingCountry")
+    business_registration_issuing_country: Optional[StrictStr] = Field(default=None, 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          |", alias="businessRegistrationIssuingCountry")
     business_entity_type: Optional[BusinessEntityTypeEnum] = Field(default=None, alias="businessEntityType")
     additional_properties: Dict[str, Any] = {}
     __properties: ClassVar[List[str]] = ["businessAddress", "businessContact", "messageVolume", "useCase", "useCaseSummary", "productionMessageContent", "optInWorkflow", "additionalInformation", "isvReseller", "privacyPolicyUrl", "termsAndConditionsUrl", "businessDba", "businessRegistrationNumber", "businessRegistrationType", "businessRegistrationIssuingCountry", "businessEntityType"]

bandwidth/models/verification_request.py

@@ -23,7 +23,6 @@
 from typing_extensions import Annotated
 from bandwidth.models.address import Address
 from bandwidth.models.business_entity_type_enum import BusinessEntityTypeEnum
-from bandwidth.models.business_registration_issuing_country_enum import BusinessRegistrationIssuingCountryEnum
 from bandwidth.models.business_registration_type_enum import BusinessRegistrationTypeEnum
 from bandwidth.models.contact import Contact
 from bandwidth.models.opt_in_workflow import OptInWorkflow
@@ -47,9 +46,9 @@ class VerificationRequest(BaseModel):
     privacy_policy_url: Optional[StrictStr] = Field(default=None, description="The Toll-Free Verification request privacy policy URL.", alias="privacyPolicyUrl")
     terms_and_conditions_url: Optional[StrictStr] = Field(default=None, description="The Toll-Free Verification request terms and conditions policy URL.", alias="termsAndConditionsUrl")
     business_dba: Optional[StrictStr] = Field(default=None, description="The company 'Doing Business As'.", alias="businessDba")
-    business_registration_number: Optional[Annotated[str, Field(strict=True, max_length=500)]] = Field(default=None, description="Government-issued business identifying number.", alias="businessRegistrationNumber")
+    business_registration_number: Optional[Annotated[str, Field(strict=True, max_length=500)]] = Field(default=None, 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. ", alias="businessRegistrationNumber")
     business_registration_type: Optional[BusinessRegistrationTypeEnum] = Field(default=None, alias="businessRegistrationType")
-    business_registration_issuing_country: Optional[BusinessRegistrationIssuingCountryEnum] = Field(default=None, alias="businessRegistrationIssuingCountry")
+    business_registration_issuing_country: Optional[StrictStr] = Field(default=None, 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          |", alias="businessRegistrationIssuingCountry")
     business_entity_type: BusinessEntityTypeEnum = Field(alias="businessEntityType")
     help_message_response: Optional[Annotated[str, Field(strict=True, max_length=500)]] = Field(default=None, description="A message that gets sent to users requesting help.", alias="helpMessageResponse")
     age_gated_content: Optional[StrictBool] = Field(default=None, description="Indicates whether the content is age-gated.", alias="ageGatedContent")