diff --git a/bandwidth.yml b/bandwidth.yml index 4f0d9765..b4542b7a 100644 --- a/bandwidth.yml +++ b/bandwidth.yml @@ -1484,7 +1484,7 @@ paths: $ref: '#/components/requestBodies/updateTollFreeVerificationRequestRequest' responses: '202': - description: Accepted + $ref: '#/components/responses/verifyPutResponse' '400': $ref: '#/components/responses/tfvPostBadRequestResponse' '401': @@ -5965,7 +5965,7 @@ components: ageGatedContent: $ref: '#/components/schemas/ageGatedContent' cvToken: - $ref: '#/components/schemas/cvToken' + $ref: '#/components/schemas/cvTokenNullable' verificationUpdateRequest: type: object required: @@ -6016,7 +6016,7 @@ components: ageGatedContent: $ref: '#/components/schemas/ageGatedContent' cvToken: - $ref: '#/components/schemas/cvToken' + $ref: '#/components/schemas/cvTokenNullable' tfvBasicAuthentication: type: object properties: @@ -6469,7 +6469,7 @@ components: blockedReason: $ref: '#/components/schemas/blockedReason' cvToken: - $ref: '#/components/schemas/cvToken' + $ref: '#/components/schemas/cvTokenNullable' tfvSubmissionInfo: type: object properties: @@ -6534,13 +6534,13 @@ components: nullable: true pattern: ^[ -~]{16,64}$ type: string - cvToken: + cvTokenNullable: type: string description: >- 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. If you pass an - empty string, it will be passed along and potentially rejected. + 527 political organization, this field should be omitted. Supplying an + empty string will likely result in rejection. minLength: 0 maxLength: 500 nullable: true @@ -7214,6 +7214,8 @@ components: example: description: Service Unavailable Error. type: Service Unavailable + verifyPutResponse: + description: Accepted parameters: accountId: in: path diff --git a/bandwidth/models/tfv_status.py b/bandwidth/models/tfv_status.py index 6cafbb2c..669c5f5b 100644 --- a/bandwidth/models/tfv_status.py +++ b/bandwidth/models/tfv_status.py @@ -41,7 +41,7 @@ class TfvStatus(BaseModel): 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.") 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.", alias="blockedReason") - cv_token: Optional[Annotated[str, Field(min_length=0, strict=True, max_length=500)]] = Field(default=None, description="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. If you pass an empty string, it will be passed along and potentially rejected.", alias="cvToken") + cv_token: Optional[Annotated[str, Field(min_length=0, strict=True, max_length=500)]] = Field(default=None, description="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.", alias="cvToken") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["phoneNumber", "status", "internalTicketNumber", "declineReasonDescription", "resubmitAllowed", "createdDateTime", "modifiedDateTime", "submission", "blocked", "blockedReason", "cvToken"] diff --git a/bandwidth/models/verification_request.py b/bandwidth/models/verification_request.py index 943ebffd..66709a00 100644 --- a/bandwidth/models/verification_request.py +++ b/bandwidth/models/verification_request.py @@ -51,7 +51,7 @@ class VerificationRequest(BaseModel): business_entity_type: Optional[BusinessEntityTypeEnum] = Field(default=None, 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") - cv_token: Optional[Annotated[str, Field(min_length=0, strict=True, max_length=500)]] = Field(default=None, description="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. If you pass an empty string, it will be passed along and potentially rejected.", alias="cvToken") + cv_token: Optional[Annotated[str, Field(min_length=0, strict=True, max_length=500)]] = Field(default=None, description="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.", alias="cvToken") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["businessAddress", "businessContact", "messageVolume", "phoneNumbers", "useCase", "useCaseSummary", "productionMessageContent", "optInWorkflow", "additionalInformation", "isvReseller", "privacyPolicyUrl", "termsAndConditionsUrl", "businessDba", "businessRegistrationNumber", "businessRegistrationType", "businessEntityType", "helpMessageResponse", "ageGatedContent", "cvToken"] diff --git a/bandwidth/models/verification_update_request.py b/bandwidth/models/verification_update_request.py index 8d0dd6bb..3ffb7528 100644 --- a/bandwidth/models/verification_update_request.py +++ b/bandwidth/models/verification_update_request.py @@ -50,7 +50,7 @@ class VerificationUpdateRequest(BaseModel): business_entity_type: Optional[BusinessEntityTypeEnum] = Field(default=None, 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") - cv_token: Optional[Annotated[str, Field(min_length=0, strict=True, max_length=500)]] = Field(default=None, description="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. If you pass an empty string, it will be passed along and potentially rejected.", alias="cvToken") + cv_token: Optional[Annotated[str, Field(min_length=0, strict=True, max_length=500)]] = Field(default=None, description="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.", alias="cvToken") additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["businessAddress", "businessContact", "messageVolume", "useCase", "useCaseSummary", "productionMessageContent", "optInWorkflow", "additionalInformation", "isvReseller", "privacyPolicyUrl", "termsAndConditionsUrl", "businessDba", "businessRegistrationNumber", "businessRegistrationType", "businessEntityType", "helpMessageResponse", "ageGatedContent", "cvToken"] diff --git a/docs/TfvStatus.md b/docs/TfvStatus.md index 59ff69b7..d27db92b 100644 --- a/docs/TfvStatus.md +++ b/docs/TfvStatus.md @@ -15,7 +15,7 @@ Name | Type | Description | Notes **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. | [optional] **blocked_reason** | **str** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. | [optional] -**cv_token** | **str** | 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. If you pass an empty string, it will be passed along and potentially rejected. | [optional] +**cv_token** | **str** | 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] ## Example diff --git a/docs/VerificationRequest.md b/docs/VerificationRequest.md index afcdcc5f..c95ce95d 100644 --- a/docs/VerificationRequest.md +++ b/docs/VerificationRequest.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] **help_message_response** | **str** | A message that gets sent to users requesting help. | [optional] **age_gated_content** | **bool** | Indicates whether the content is age-gated. | [optional] -**cv_token** | **str** | 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. If you pass an empty string, it will be passed along and potentially rejected. | [optional] +**cv_token** | **str** | 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] ## Example diff --git a/docs/VerificationUpdateRequest.md b/docs/VerificationUpdateRequest.md index 1da5bd0a..f8f06662 100644 --- a/docs/VerificationUpdateRequest.md +++ b/docs/VerificationUpdateRequest.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] **help_message_response** | **str** | A message that gets sent to users requesting help. | [optional] **age_gated_content** | **bool** | Indicates whether the content is age-gated. | [optional] -**cv_token** | **str** | 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. If you pass an empty string, it will be passed along and potentially rejected. | [optional] +**cv_token** | **str** | 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] ## Example