diff --git a/api/openapi.yaml b/api/openapi.yaml index b5b2311e..0cf3cd0d 100644 --- a/api/openapi.yaml +++ b/api/openapi.yaml @@ -8009,6 +8009,8 @@ components: schema: $ref: "#/components/schemas/tfvError" description: Service Unavailable + verifyPutResponse: + description: Accepted schemas: applicationId: description: The ID of the Application your from number or senderId is associated @@ -13895,8 +13897,8 @@ components: cvToken: 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." + \ not a 527 political organization, this field should be omitted. Supplying\ + \ an empty string will likely result in rejection." example: cv.user123|sess456|mno|tfree|read_write|X7yZ9aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVw maxLength: 500 minLength: 0 @@ -13999,8 +14001,8 @@ components: cvToken: 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." + \ not a 527 political organization, this field should be omitted. Supplying\ + \ an empty string will likely result in rejection." example: cv.user123|sess456|mno|tfree|read_write|X7yZ9aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVw maxLength: 500 minLength: 0 @@ -14719,8 +14721,8 @@ components: cvToken: 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." + \ not a 527 political organization, this field should be omitted. Supplying\ + \ an empty string will likely result in rejection." example: cv.user123|sess456|mno|tfree|read_write|X7yZ9aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVw maxLength: 500 minLength: 0 @@ -14850,11 +14852,11 @@ components: nullable: true pattern: "^[ -~]{16,64}$" type: string - cvToken: + cvTokenNullable: 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." + \ a 527 political organization, this field should be omitted. Supplying an\ + \ empty string will likely result in rejection." example: cv.user123|sess456|mno|tfree|read_write|X7yZ9aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVw maxLength: 500 minLength: 0 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/docs/TfvStatus.md b/docs/TfvStatus.md index 2d7c13bc..61e9c297 100644 --- a/docs/TfvStatus.md +++ b/docs/TfvStatus.md @@ -17,7 +17,7 @@ |**submission** | [**TfvSubmissionInfo**](TfvSubmissionInfo.md) | | [optional] | |**blocked** | **Boolean** | Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. | [optional] | |**blockedReason** | **String** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. | [optional] | -|**cvToken** | **String** | 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] | +|**cvToken** | **String** | 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] | diff --git a/docs/VerificationRequest.md b/docs/VerificationRequest.md index 20d07827..4270504e 100644 --- a/docs/VerificationRequest.md +++ b/docs/VerificationRequest.md @@ -25,7 +25,7 @@ |**businessEntityType** | **BusinessEntityTypeEnum** | | [optional] | |**helpMessageResponse** | **String** | A message that gets sent to users requesting help. | [optional] | |**ageGatedContent** | **Boolean** | Indicates whether the content is age-gated. | [optional] | -|**cvToken** | **String** | 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] | +|**cvToken** | **String** | 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] | diff --git a/docs/VerificationUpdateRequest.md b/docs/VerificationUpdateRequest.md index c7b7d6fa..7a1da16c 100644 --- a/docs/VerificationUpdateRequest.md +++ b/docs/VerificationUpdateRequest.md @@ -24,7 +24,7 @@ |**businessEntityType** | **BusinessEntityTypeEnum** | | [optional] | |**helpMessageResponse** | **String** | A message that gets sent to users requesting help. | [optional] | |**ageGatedContent** | **Boolean** | Indicates whether the content is age-gated. | [optional] | -|**cvToken** | **String** | 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] | +|**cvToken** | **String** | 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] | diff --git a/src/main/java/com/bandwidth/sdk/model/TfvStatus.java b/src/main/java/com/bandwidth/sdk/model/TfvStatus.java index c78cdbda..f26df3dc 100644 --- a/src/main/java/com/bandwidth/sdk/model/TfvStatus.java +++ b/src/main/java/com/bandwidth/sdk/model/TfvStatus.java @@ -310,7 +310,7 @@ public TfvStatus cvToken(@javax.annotation.Nullable String cvToken) { } /** - * 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. + * 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. * @return cvToken */ @javax.annotation.Nullable diff --git a/src/main/java/com/bandwidth/sdk/model/VerificationRequest.java b/src/main/java/com/bandwidth/sdk/model/VerificationRequest.java index e053dde4..3cf0a7b4 100644 --- a/src/main/java/com/bandwidth/sdk/model/VerificationRequest.java +++ b/src/main/java/com/bandwidth/sdk/model/VerificationRequest.java @@ -516,7 +516,7 @@ public VerificationRequest cvToken(@javax.annotation.Nullable String cvToken) { } /** - * 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. + * 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. * @return cvToken */ @javax.annotation.Nullable diff --git a/src/main/java/com/bandwidth/sdk/model/VerificationUpdateRequest.java b/src/main/java/com/bandwidth/sdk/model/VerificationUpdateRequest.java index 744fc8d5..9412f2af 100644 --- a/src/main/java/com/bandwidth/sdk/model/VerificationUpdateRequest.java +++ b/src/main/java/com/bandwidth/sdk/model/VerificationUpdateRequest.java @@ -482,7 +482,7 @@ public VerificationUpdateRequest cvToken(@javax.annotation.Nullable String cvTok } /** - * 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. + * 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. * @return cvToken */ @javax.annotation.Nullable