Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
56 changes: 56 additions & 0 deletions bandwidth.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5228,6 +5228,35 @@ components:
PUT.
example: true
type: boolean
blocked:
description: >-
Whether a Toll-Free Verification is blocked. This attribute will only be
defined when the number is blocked. (Not Available Until 5/28/2025)
example: true
type: boolean
blockedReason:
description: >-
The reason why the Toll-Free Verification is blocked. This attribute
will only be defined when the number is blocked. (Not Available Until
5/28/2025)
example: Toll-free number was used to send spam messages
type: string
privacyPolicyUrl:
description: >-
The Toll-Free Verification request privacy policy URL. (Not Available
Until 5/28/2025)
example: http://your-company.com/privacyPolicyUrl.pdf
type: string
termsAndConditionsUrl:
description: >-
The Toll-Free Verification request terms and conditions policy URL. (Not
Available Until 5/28/2025)
example: http://your-company.com/termsAndConditionsUrl.pdf
type: string
businessDBA:
description: The company 'Doing Business As'. (Not Available Until 5/28/2025)
example: SecondCompany Name
type: string
additionalDenialReason:
properties:
statusCode:
Expand Down Expand Up @@ -5308,6 +5337,12 @@ components:
example: Any additional information
isvReseller:
$ref: '#/components/schemas/isvReseller'
privacyPolicyUrl:
$ref: '#/components/schemas/privacyPolicyUrl'
termsAndConditionsUrl:
$ref: '#/components/schemas/termsAndConditionsUrl'
businessDBA:
$ref: '#/components/schemas/businessDBA'
verificationUpdateRequest:
type: object
required:
Expand Down Expand Up @@ -5341,6 +5376,12 @@ components:
$ref: '#/components/schemas/additionalInformation'
isvReseller:
$ref: '#/components/schemas/isvReseller'
privacyPolicyUrl:
$ref: '#/components/schemas/privacyPolicyUrl'
termsAndConditionsUrl:
$ref: '#/components/schemas/termsAndConditionsUrl'
businessDBA:
$ref: '#/components/schemas/businessDBA'
tfvBasicAuthentication:
type: object
properties:
Expand Down Expand Up @@ -5419,6 +5460,10 @@ components:
$ref: '#/components/schemas/resubmitAllowed'
status:
$ref: '#/components/schemas/tfvUnverifiedStatus'
blocked:
$ref: '#/components/schemas/blocked'
blockedReason:
$ref: '#/components/schemas/blockedReason'
verificationWebhook:
type: object
properties:
Expand Down Expand Up @@ -5501,6 +5546,7 @@ components:
minLength: 0
maxLength: 500
nullable: true
example: Any additional information
optInWorkflow:
type: object
nullable: false
Expand Down Expand Up @@ -5762,6 +5808,10 @@ components:
example: '2021-06-08T06:45:13.0Z'
submission:
$ref: '#/components/schemas/tfvSubmissionInfo'
blocked:
$ref: '#/components/schemas/blocked'
blockedReason:
$ref: '#/components/schemas/blockedReason'
tfvSubmissionInfo:
type: object
properties:
Expand All @@ -5787,6 +5837,12 @@ components:
$ref: '#/components/schemas/additionalInformation'
isvReseller:
$ref: '#/components/schemas/isvReseller'
privacyPolicyUrl:
$ref: '#/components/schemas/privacyPolicyUrl'
termsAndConditionsUrl:
$ref: '#/components/schemas/termsAndConditionsUrl'
businessDBA:
$ref: '#/components/schemas/businessDBA'
tfvStatusEnum:
type: string
enum:
Expand Down
8 changes: 6 additions & 2 deletions bandwidth/models/tfv_status.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,10 @@ class TfvStatus(BaseModel):
created_date_time: Optional[datetime] = Field(default=None, description="Date and time the verification request was created.", alias="createdDateTime")
modified_date_time: Optional[datetime] = Field(default=None, description="Date and time the verification request was last modified.", alias="modifiedDateTime")
submission: Optional[TfvSubmissionInfo] = None
blocked: Optional[StrictBool] = Field(default=None, description="Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025)")
blocked_reason: Optional[StrictStr] = Field(default=None, description="The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025)", alias="blockedReason")
additional_properties: Dict[str, Any] = {}
__properties: ClassVar[List[str]] = ["phoneNumber", "status", "internalTicketNumber", "declineReasonDescription", "resubmitAllowed", "createdDateTime", "modifiedDateTime", "submission"]
__properties: ClassVar[List[str]] = ["phoneNumber", "status", "internalTicketNumber", "declineReasonDescription", "resubmitAllowed", "createdDateTime", "modifiedDateTime", "submission", "blocked", "blockedReason"]

@field_validator('phone_number')
def phone_number_validate_regular_expression(cls, value):
Expand Down Expand Up @@ -120,7 +122,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
"resubmitAllowed": obj.get("resubmitAllowed"),
"createdDateTime": obj.get("createdDateTime"),
"modifiedDateTime": obj.get("modifiedDateTime"),
"submission": TfvSubmissionInfo.from_dict(obj["submission"]) if obj.get("submission") is not None else None
"submission": TfvSubmissionInfo.from_dict(obj["submission"]) if obj.get("submission") is not None else None,
"blocked": obj.get("blocked"),
"blockedReason": obj.get("blockedReason")
})
# store additional fields in additional_properties
for _key in obj.keys():
Expand Down
12 changes: 9 additions & 3 deletions bandwidth/models/tfv_submission_info.py
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
from pydantic import BaseModel, ConfigDict, Field, StrictStr
from typing import Any, ClassVar, Dict, List, Optional
from typing_extensions import Annotated
from bandwidth.models.address import Address
Expand All @@ -40,8 +40,11 @@ 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. (Not Available Until 5/28/2025)", alias="privacyPolicyUrl")
terms_and_conditions_url: Optional[StrictStr] = Field(default=None, description="The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025)", alias="termsAndConditionsUrl")
business_dba: Optional[StrictStr] = Field(default=None, description="The company 'Doing Business As'. (Not Available Until 5/28/2025)", alias="businessDBA")
additional_properties: Dict[str, Any] = {}
__properties: ClassVar[List[str]] = ["businessAddress", "businessContact", "messageVolume", "useCase", "useCaseSummary", "productionMessageContent", "optInWorkflow", "additionalInformation", "isvReseller"]
__properties: ClassVar[List[str]] = ["businessAddress", "businessContact", "messageVolume", "useCase", "useCaseSummary", "productionMessageContent", "optInWorkflow", "additionalInformation", "isvReseller", "privacyPolicyUrl", "termsAndConditionsUrl", "businessDBA"]

model_config = ConfigDict(
populate_by_name=True,
Expand Down Expand Up @@ -128,7 +131,10 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
"productionMessageContent": obj.get("productionMessageContent"),
"optInWorkflow": OptInWorkflow.from_dict(obj["optInWorkflow"]) if obj.get("optInWorkflow") is not None else None,
"additionalInformation": obj.get("additionalInformation"),
"isvReseller": obj.get("isvReseller")
"isvReseller": obj.get("isvReseller"),
"privacyPolicyUrl": obj.get("privacyPolicyUrl"),
"termsAndConditionsUrl": obj.get("termsAndConditionsUrl"),
"businessDBA": obj.get("businessDBA")
})
# store additional fields in additional_properties
for _key in obj.keys():
Expand Down
8 changes: 6 additions & 2 deletions bandwidth/models/verification_denial_webhook.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,10 @@ class VerificationDenialWebhook(BaseModel):
phone_number: Optional[Annotated[str, Field(min_length=12, strict=True, max_length=12)]] = Field(default=None, description="Toll-free telephone number in E.164 format.", alias="phoneNumber")
resubmit_allowed: Optional[StrictBool] = Field(default=None, description="Whether a Toll-Free Verification request qualifies for resubmission via PUT.", alias="resubmitAllowed")
status: Optional[StrictStr] = 'UNVERIFIED'
blocked: Optional[StrictBool] = Field(default=None, description="Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025)")
blocked_reason: Optional[StrictStr] = Field(default=None, description="The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025)", alias="blockedReason")
additional_properties: Dict[str, Any] = {}
__properties: ClassVar[List[str]] = ["accountId", "additionalDenialReasons", "declineReasonDescription", "denialStatusCode", "internalTicketNumber", "phoneNumber", "resubmitAllowed", "status"]
__properties: ClassVar[List[str]] = ["accountId", "additionalDenialReasons", "declineReasonDescription", "denialStatusCode", "internalTicketNumber", "phoneNumber", "resubmitAllowed", "status", "blocked", "blockedReason"]

@field_validator('phone_number')
def phone_number_validate_regular_expression(cls, value):
Expand Down Expand Up @@ -122,7 +124,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
"internalTicketNumber": obj.get("internalTicketNumber"),
"phoneNumber": obj.get("phoneNumber"),
"resubmitAllowed": obj.get("resubmitAllowed"),
"status": obj.get("status") if obj.get("status") is not None else 'UNVERIFIED'
"status": obj.get("status") if obj.get("status") is not None else 'UNVERIFIED',
"blocked": obj.get("blocked"),
"blockedReason": obj.get("blockedReason")
})
# store additional fields in additional_properties
for _key in obj.keys():
Expand Down
12 changes: 9 additions & 3 deletions bandwidth/models/verification_request.py
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, field_validator
from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
from typing import Any, ClassVar, Dict, List, Optional
from typing_extensions import Annotated
from bandwidth.models.address import Address
Expand All @@ -41,8 +41,11 @@ 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. (Not Available Until 5/28/2025)", alias="privacyPolicyUrl")
terms_and_conditions_url: Optional[StrictStr] = Field(default=None, description="The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025)", alias="termsAndConditionsUrl")
business_dba: Optional[StrictStr] = Field(default=None, description="The company 'Doing Business As'. (Not Available Until 5/28/2025)", alias="businessDBA")
additional_properties: Dict[str, Any] = {}
__properties: ClassVar[List[str]] = ["businessAddress", "businessContact", "messageVolume", "phoneNumbers", "useCase", "useCaseSummary", "productionMessageContent", "optInWorkflow", "additionalInformation", "isvReseller"]
__properties: ClassVar[List[str]] = ["businessAddress", "businessContact", "messageVolume", "phoneNumbers", "useCase", "useCaseSummary", "productionMessageContent", "optInWorkflow", "additionalInformation", "isvReseller", "privacyPolicyUrl", "termsAndConditionsUrl", "businessDBA"]

model_config = ConfigDict(
populate_by_name=True,
Expand Down Expand Up @@ -130,7 +133,10 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
"productionMessageContent": obj.get("productionMessageContent"),
"optInWorkflow": OptInWorkflow.from_dict(obj["optInWorkflow"]) if obj.get("optInWorkflow") is not None else None,
"additionalInformation": obj.get("additionalInformation"),
"isvReseller": obj.get("isvReseller")
"isvReseller": obj.get("isvReseller"),
"privacyPolicyUrl": obj.get("privacyPolicyUrl"),
"termsAndConditionsUrl": obj.get("termsAndConditionsUrl"),
"businessDBA": obj.get("businessDBA")
})
# store additional fields in additional_properties
for _key in obj.keys():
Expand Down
12 changes: 9 additions & 3 deletions bandwidth/models/verification_update_request.py
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
from pydantic import BaseModel, ConfigDict, Field, StrictStr
from typing import Any, ClassVar, Dict, List, Optional
from typing_extensions import Annotated
from bandwidth.models.address import Address
Expand All @@ -40,8 +40,11 @@ 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. (Not Available Until 5/28/2025)", alias="privacyPolicyUrl")
terms_and_conditions_url: Optional[StrictStr] = Field(default=None, description="The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025)", alias="termsAndConditionsUrl")
business_dba: Optional[StrictStr] = Field(default=None, description="The company 'Doing Business As'. (Not Available Until 5/28/2025)", alias="businessDBA")
additional_properties: Dict[str, Any] = {}
__properties: ClassVar[List[str]] = ["businessAddress", "businessContact", "messageVolume", "useCase", "useCaseSummary", "productionMessageContent", "optInWorkflow", "additionalInformation", "isvReseller"]
__properties: ClassVar[List[str]] = ["businessAddress", "businessContact", "messageVolume", "useCase", "useCaseSummary", "productionMessageContent", "optInWorkflow", "additionalInformation", "isvReseller", "privacyPolicyUrl", "termsAndConditionsUrl", "businessDBA"]

model_config = ConfigDict(
populate_by_name=True,
Expand Down Expand Up @@ -128,7 +131,10 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
"productionMessageContent": obj.get("productionMessageContent"),
"optInWorkflow": OptInWorkflow.from_dict(obj["optInWorkflow"]) if obj.get("optInWorkflow") is not None else None,
"additionalInformation": obj.get("additionalInformation"),
"isvReseller": obj.get("isvReseller")
"isvReseller": obj.get("isvReseller"),
"privacyPolicyUrl": obj.get("privacyPolicyUrl"),
"termsAndConditionsUrl": obj.get("termsAndConditionsUrl"),
"businessDBA": obj.get("businessDBA")
})
# store additional fields in additional_properties
for _key in obj.keys():
Expand Down
2 changes: 2 additions & 0 deletions docs/TfvStatus.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ Name | Type | Description | Notes
**created_date_time** | **datetime** | Date and time the verification request was created. | [optional]
**modified_date_time** | **datetime** | Date and time the verification request was last modified. | [optional]
**submission** | [**TfvSubmissionInfo**](TfvSubmissionInfo.md) | | [optional]
**blocked** | **bool** | Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional]
**blocked_reason** | **str** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional]

## Example

Expand Down
3 changes: 3 additions & 0 deletions docs/TfvSubmissionInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ Name | Type | Description | Notes
**opt_in_workflow** | [**OptInWorkflow**](OptInWorkflow.md) | | [optional]
**additional_information** | **str** | Any additional information. | [optional]
**isv_reseller** | **str** | ISV name. | [optional]
**privacy_policy_url** | **str** | The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) | [optional]
**terms_and_conditions_url** | **str** | The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025) | [optional]
**business_dba** | **str** | The company 'Doing Business As'. (Not Available Until 5/28/2025) | [optional]

## Example

Expand Down
2 changes: 2 additions & 0 deletions docs/VerificationDenialWebhook.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ Name | Type | Description | Notes
**phone_number** | **str** | Toll-free telephone number in E.164 format. | [optional]
**resubmit_allowed** | **bool** | Whether a Toll-Free Verification request qualifies for resubmission via PUT. | [optional]
**status** | **str** | | [optional] [default to 'UNVERIFIED']
**blocked** | **bool** | Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional]
**blocked_reason** | **str** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional]

## Example

Expand Down
3 changes: 3 additions & 0 deletions docs/VerificationRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ Name | Type | Description | Notes
**opt_in_workflow** | [**OptInWorkflow**](OptInWorkflow.md) | |
**additional_information** | **str** | Any additional information. | [optional]
**isv_reseller** | **str** | ISV name. | [optional]
**privacy_policy_url** | **str** | The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) | [optional]
**terms_and_conditions_url** | **str** | The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025) | [optional]
**business_dba** | **str** | The company 'Doing Business As'. (Not Available Until 5/28/2025) | [optional]

## Example

Expand Down
3 changes: 3 additions & 0 deletions docs/VerificationUpdateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ Name | Type | Description | Notes
**opt_in_workflow** | [**OptInWorkflow**](OptInWorkflow.md) | |
**additional_information** | **str** | Any additional information. | [optional]
**isv_reseller** | **str** | ISV name. | [optional]
**privacy_policy_url** | **str** | The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) | [optional]
**terms_and_conditions_url** | **str** | The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025) | [optional]
**business_dba** | **str** | The company 'Doing Business As'. (Not Available Until 5/28/2025) | [optional]

## Example

Expand Down
Loading