Skip to content

SWI-10073 Update SDK Based on Recent Spec Changes #288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
band-swi-release-engineering wants to merge 1 commit into
base: main
Choose a base branch
from
Open

SWI-10073 Update SDK Based on Recent Spec Changes #288

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 52 additions & 7 deletions bandwidth.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1956,8 +1956,10 @@ components:
type: string
contentLength:
type: integer
example: 1024
mediaName:
type: string
example: image.png
segmentCount:
type: integer
description: >-
Expand Down Expand Up @@ -2744,6 +2746,7 @@ components:
discriminator:
propertyName: type
mapping:
message-sending: '#/components/schemas/statusCallback'
message-sent: '#/components/schemas/statusCallback'
message-delivered: '#/components/schemas/statusCallback'
message-failed: '#/components/schemas/statusCallback'
Expand Down Expand Up @@ -5510,10 +5513,14 @@ components:

- UNKNOWN: Bandwidth cannot find an delivery status entry for the
number.

- NOT_ENABLED: The phone number is not enabled for messaging, so there
is no delivery status information.
enum:
- ACTIVE
- DEACTIVATED
- UNKNOWN
- NOT_ENABLED
lineTypeEnum:
type: string
enum:
Expand Down Expand Up @@ -5816,25 +5823,36 @@ components:
type: string
privacyPolicyUrl:
description: The Toll-Free Verification request privacy policy URL.
maxLength: 500
example: http://your-company.com/privacyPolicy
type: string
termsAndConditionsUrl:
description: The Toll-Free Verification request terms and conditions policy URL.
maxLength: 500
example: http://your-company.com/termsAndConditions
type: string
businessDba:
description: The company 'Doing Business As'.
maxLength: 500
example: Another Company Name Inc.
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
Expand All @@ -5854,12 +5872,22 @@ components:
- CNPJ
- UID
- OTHER
example: EIN
nullable: true
businessRegistrationIssuingCountryEnum:
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 |
Expand Down Expand Up @@ -5915,18 +5943,23 @@ components:
- DEU
- ESP
- CHE
- CYP
- IND
- CHN
- BGR
example: USA
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
- PUBLIC_PROFIT
- NON_PROFIT
- GOVERNMENT
example: PRIVATE_PROFIT
nullable: false
helpMessageResponse:
type: string
Expand Down Expand Up @@ -6576,10 +6609,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'
description: >-
The country issuing the business registration in ISO-3166-1 alpha-3
format.
businessEntityType:
$ref: '#/components/schemas/businessEntityTypeEnum'
tfvStatusEnum:
Expand Down Expand Up @@ -8117,7 +8154,7 @@ components:
latestMessageDeliveryStatusDate: '2025-05-18'
- phoneNumber: '+10072904498'
countryCodeA3: USA
lineType: FIXED
lineType: MOBILE
voiceProvider: VERIZON
latestMessageDeliveryStatus: DEACTIVATED
initialMessageDeliveryStatusDate: '2025-09-05'
Expand All @@ -8131,6 +8168,14 @@ components:
deactivationDate: '2025-09-29 01:23:00'
deactivationEvent: DEACTIVATED
latestMessageDeliveryStatus: UNKNOWN
- phoneNumber: '+10072904500'
lineType: FIXED
countryCodeA3: USA
voiceProvider: VERIZON
deactivationReporter: Verizon Wireless
deactivationDate: '2025-09-29 01:23:00'
deactivationEvent: DEACTIVATED
latestMessageDeliveryStatus: NOT_ENABLED
errors: []
badRequestExample:
summary: Example Bad Request Error
Expand Down
2 changes: 1 addition & 1 deletion bandwidth/models/business_entity_type_enum.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""

"""
Expand Down
6 changes: 5 additions & 1 deletion bandwidth/models/business_registration_issuing_country_enum.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

class BusinessRegistrationIssuingCountryEnum(str, Enum):
"""
The country issuing the business registration in ISO-3166-1 alpha-3 format. | 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 |
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 |
"""

"""
Expand All @@ -40,6 +40,10 @@ class BusinessRegistrationIssuingCountryEnum(str, Enum):
DEU = 'DEU'
ESP = 'ESP'
CHE = 'CHE'
CYP = 'CYP'
IND = 'IND'
CHN = 'CHN'
BGR = 'BGR'

@classmethod
def from_json(cls, json_str: str) -> Self:
Expand Down
2 changes: 1 addition & 1 deletion bandwidth/models/business_registration_type_enum.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

class BusinessRegistrationTypeEnum(str, Enum):
"""
The type of business registration number.
The type of business registration number.
"""

"""
Expand Down
1 change: 1 addition & 0 deletions bandwidth/models/callback.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ class Callback(BaseModel):
'message-failed': 'StatusCallback',
'message-read': 'StatusCallback',
'message-received': 'InboundCallback',
'message-sending': 'StatusCallback',
'message-sent': 'StatusCallback',
'request-location-response': 'InboundCallback',
'suggestion-response': 'InboundCallback'
Expand Down
3 changes: 2 additions & 1 deletion bandwidth/models/latest_message_delivery_status_enum.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

class LatestMessageDeliveryStatusEnum(str, Enum):
"""
[DNI-Only](#section/DNI-Only). The current delivery status of the phone number. - ACTIVE: A message was successfully sent to the number (delivery code 0). - DEACTIVATED: A message was not delivered to a number (delivery code 720) - UNKNOWN: Bandwidth cannot find an delivery status entry for the number.
[DNI-Only](#section/DNI-Only). The current delivery status of the phone number. - ACTIVE: A message was successfully sent to the number (delivery code 0). - DEACTIVATED: A message was not delivered to a number (delivery code 720) - UNKNOWN: Bandwidth cannot find an delivery status entry for the number. - NOT_ENABLED: The phone number is not enabled for messaging, so there is no delivery status information.
"""

"""
Expand All @@ -30,6 +30,7 @@ class LatestMessageDeliveryStatusEnum(str, Enum):
ACTIVE = 'ACTIVE'
DEACTIVATED = 'DEACTIVATED'
UNKNOWN = 'UNKNOWN'
NOT_ENABLED = 'NOT_ENABLED'

@classmethod
def from_json(cls, json_str: str) -> Self:
Expand Down
10 changes: 5 additions & 5 deletions bandwidth/models/tfv_submission_info.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
import re # noqa: F401
import json

from pydantic import BaseModel, ConfigDict, Field, StrictStr
from pydantic import BaseModel, ConfigDict, Field
from typing import Any, ClassVar, Dict, List, Optional
from typing_extensions import Annotated
from bandwidth.models.address import Address
Expand All @@ -43,10 +43,10 @@ class TfvSubmissionInfo(BaseModel):
opt_in_workflow: Optional[OptInWorkflow] = Field(default=None, alias="optInWorkflow")
additional_information: Optional[Annotated[str, Field(min_length=0, strict=True, max_length=500)]] = Field(default=None, description="Any additional information.", alias="additionalInformation")
isv_reseller: Optional[Annotated[str, Field(min_length=0, strict=True, max_length=500)]] = Field(default=None, description="ISV name.", alias="isvReseller")
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")
privacy_policy_url: Optional[Annotated[str, Field(strict=True, max_length=500)]] = Field(default=None, description="The Toll-Free Verification request privacy policy URL.", alias="privacyPolicyUrl")
terms_and_conditions_url: Optional[Annotated[str, Field(strict=True, max_length=500)]] = Field(default=None, description="The Toll-Free Verification request terms and conditions policy URL.", alias="termsAndConditionsUrl")
business_dba: Optional[Annotated[str, Field(strict=True, max_length=500)]] = 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. **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_entity_type: Optional[BusinessEntityTypeEnum] = Field(default=None, alias="businessEntityType")
Expand Down
10 changes: 5 additions & 5 deletions bandwidth/models/verification_request.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
import re # noqa: F401
import json

from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator
from pydantic import BaseModel, ConfigDict, Field, StrictBool, field_validator
from typing import Any, ClassVar, Dict, List, Optional
from typing_extensions import Annotated
from bandwidth.models.address import Address
Expand All @@ -44,10 +44,10 @@ class VerificationRequest(BaseModel):
opt_in_workflow: OptInWorkflow = Field(alias="optInWorkflow")
additional_information: Optional[Annotated[str, Field(min_length=0, strict=True, max_length=500)]] = Field(default=None, description="Any additional information.", alias="additionalInformation")
isv_reseller: Optional[Annotated[str, Field(min_length=0, strict=True, max_length=500)]] = Field(default=None, description="ISV name.", alias="isvReseller")
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")
privacy_policy_url: Optional[Annotated[str, Field(strict=True, max_length=500)]] = Field(default=None, description="The Toll-Free Verification request privacy policy URL.", alias="privacyPolicyUrl")
terms_and_conditions_url: Optional[Annotated[str, Field(strict=True, max_length=500)]] = Field(default=None, description="The Toll-Free Verification request terms and conditions policy URL.", alias="termsAndConditionsUrl")
business_dba: Optional[Annotated[str, Field(strict=True, max_length=500)]] = 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. **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_entity_type: BusinessEntityTypeEnum = Field(alias="businessEntityType")
Expand Down
10 changes: 5 additions & 5 deletions bandwidth/models/verification_update_request.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
import re # noqa: F401
import json

from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
from pydantic import BaseModel, ConfigDict, Field, StrictBool
from typing import Any, ClassVar, Dict, List, Optional
from typing_extensions import Annotated
from bandwidth.models.address import Address
Expand All @@ -43,10 +43,10 @@ class VerificationUpdateRequest(BaseModel):
opt_in_workflow: OptInWorkflow = Field(alias="optInWorkflow")
additional_information: Optional[Annotated[str, Field(min_length=0, strict=True, max_length=500)]] = Field(default=None, description="Any additional information.", alias="additionalInformation")
isv_reseller: Optional[Annotated[str, Field(min_length=0, strict=True, max_length=500)]] = Field(default=None, description="ISV name.", alias="isvReseller")
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")
privacy_policy_url: Optional[Annotated[str, Field(strict=True, max_length=500)]] = Field(default=None, description="The Toll-Free Verification request privacy policy URL.", alias="privacyPolicyUrl")
terms_and_conditions_url: Optional[Annotated[str, Field(strict=True, max_length=500)]] = Field(default=None, description="The Toll-Free Verification request terms and conditions policy URL.", alias="termsAndConditionsUrl")
business_dba: Optional[Annotated[str, Field(strict=True, max_length=500)]] = 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. **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_entity_type: Optional[BusinessEntityTypeEnum] = Field(default=None, alias="businessEntityType")
business_registration_issuing_country: Optional[BusinessRegistrationIssuingCountryEnum] = Field(default=None, alias="businessRegistrationIssuingCountry")
Expand Down
2 changes: 1 addition & 1 deletion docs/BusinessEntityTypeEnum.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# BusinessEntityTypeEnum

The type of registered business. If no option is applicable, please provide \"SOLE_PROPRIETOR\" as a value.
The type of registered business.

## Enum

Expand Down
Loading
Loading