Skip to content

SWI-9238 Update SDK Based on Recent Spec Changes #93

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-9238 Update SDK Based on Recent Spec Changes #93

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
18 changes: 18 additions & 0 deletions bandwidth.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5956,6 +5956,8 @@ components:
$ref: '#/components/schemas/helpMessageResponse'
ageGatedContent:
$ref: '#/components/schemas/ageGatedContent'
cvToken:
$ref: '#/components/schemas/cvToken'
verificationUpdateRequest:
type: object
required:
Expand Down Expand Up @@ -6005,6 +6007,8 @@ components:
$ref: '#/components/schemas/helpMessageResponse'
ageGatedContent:
$ref: '#/components/schemas/ageGatedContent'
cvToken:
$ref: '#/components/schemas/cvToken'
tfvBasicAuthentication:
type: object
properties:
Expand Down Expand Up @@ -6456,6 +6460,8 @@ components:
$ref: '#/components/schemas/blocked'
blockedReason:
$ref: '#/components/schemas/blockedReason'
cvToken:
$ref: '#/components/schemas/cvToken'
tfvSubmissionInfo:
type: object
properties:
Expand Down Expand Up @@ -6520,6 +6526,18 @@ components:
nullable: true
pattern: ^[ -~]{16,64}$
type: string
cvToken:
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.
minLength: 0
maxLength: 500
nullable: true
example: >-
cv.user123|sess456|mno|tfree|read_write|X7yZ9aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVw
responses:
createMessageResponse:
description: Accepted
Expand Down
2 changes: 2 additions & 0 deletions docs/TfvStatus.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Name | Type | Description | Notes
**submission** | [**TfvSubmissionInfo**](TfvSubmissionInfo.md) | | [optional] [default to undefined]
**blocked** | **boolean** | Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. | [optional] [default to undefined]
**blockedReason** | **string** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. | [optional] [default to undefined]
**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] [default to undefined]

## Example

Expand All @@ -32,6 +33,7 @@ const instance: TfvStatus = {
submission,
blocked,
blockedReason,
cvToken,
};
```

Expand Down
2 changes: 2 additions & 0 deletions docs/VerificationRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Name | Type | Description | Notes
**businessEntityType** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] [default to undefined]
**helpMessageResponse** | **string** | A message that gets sent to users requesting help. | [optional] [default to undefined]
**ageGatedContent** | **boolean** | Indicates whether the content is age-gated. | [optional] [default to undefined]
**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] [default to undefined]

## Example

Expand All @@ -48,6 +49,7 @@ const instance: VerificationRequest = {
businessEntityType,
helpMessageResponse,
ageGatedContent,
cvToken,
};
```

Expand Down
2 changes: 2 additions & 0 deletions docs/VerificationUpdateRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Name | Type | Description | Notes
**businessEntityType** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] [default to undefined]
**helpMessageResponse** | **string** | A message that gets sent to users requesting help. | [optional] [default to undefined]
**ageGatedContent** | **boolean** | Indicates whether the content is age-gated. | [optional] [default to undefined]
**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] [default to undefined]

## Example

Expand All @@ -46,6 +47,7 @@ const instance: VerificationUpdateRequest = {
businessEntityType,
helpMessageResponse,
ageGatedContent,
cvToken,
};
```

Expand Down
4 changes: 4 additions & 0 deletions models/tfv-status.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,10 @@ export interface TfvStatus {
* The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked.
*/
'blockedReason'?: 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.
*/
'cvToken'?: string | null;
}


Expand Down
4 changes: 4 additions & 0 deletions models/verification-request.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,10 @@ export interface VerificationRequest {
* Indicates whether the content is age-gated.
*/
'ageGatedContent'?: boolean;
/**
* 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.
*/
'cvToken'?: string | null;
}


Expand Down
4 changes: 4 additions & 0 deletions models/verification-update-request.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,10 @@ export interface VerificationUpdateRequest {
* Indicates whether the content is age-gated.
*/
'ageGatedContent'?: boolean;
/**
* 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.
*/
'cvToken'?: string | null;
}


Expand Down