Merge remote-tracking branch 'origin/main' into brtc-python-sdk

Author: smoghe-bw

bandwidth.yml

@@ -1485,7 +1485,7 @@ paths:
         $ref: '#/components/requestBodies/updateTollFreeVerificationRequestRequest'
       responses:
         '202':
-          description: Accepted
+          $ref: '#/components/responses/verifyPutResponse'
         '400':
           $ref: '#/components/responses/tfvPostBadRequestResponse'
         '401':
@@ -6125,7 +6125,7 @@ components:
         ageGatedContent:
           $ref: '#/components/schemas/ageGatedContent'
         cvToken:
-          $ref: '#/components/schemas/cvToken'
+          $ref: '#/components/schemas/cvTokenNullable'
     verificationUpdateRequest:
       type: object
       required:
@@ -6176,7 +6176,7 @@ components:
         ageGatedContent:
           $ref: '#/components/schemas/ageGatedContent'
         cvToken:
-          $ref: '#/components/schemas/cvToken'
+          $ref: '#/components/schemas/cvTokenNullable'
     tfvBasicAuthentication:
       type: object
       properties:
@@ -6629,7 +6629,7 @@ components:
         blockedReason:
           $ref: '#/components/schemas/blockedReason'
         cvToken:
-          $ref: '#/components/schemas/cvToken'
+          $ref: '#/components/schemas/cvTokenNullable'
     tfvSubmissionInfo:
       type: object
       properties:
@@ -6996,8 +6996,8 @@ components:
       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
@@ -7671,6 +7671,8 @@ components:
           example:
             description: Service Unavailable Error.
             type: Service Unavailable
+    verifyPutResponse:
+      description: Accepted
     listEndpointsResponse:
       description: OK
       content:

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"]
 

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"]
 

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"]
 

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
 

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
 

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