Skip to content

Commit 517c15f

Browse files
ckoegelckoegel
committed
docs
1 parent f7ed7a6 commit 517c15f

27 files changed

+1069
-0
lines changed

‎docs/AdditionalDenialReason.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
2+
3+
# AdditionalDenialReason
4+
5+
6+
## Properties
7+
8+
| Name | Type | Description | Notes |
9+
|------------ | ------------- | ------------- | -------------|
10+
|**statusCode** | **Integer** | Reason code for denial. | |
11+
|**reason** | **String** | Explanation for why a verification request was declined. | |
12+
|**resubmitAllowed** | **Boolean** | Whether a Toll-Free Verification request qualifies for resubmission via PUT. | |
13+
14+
15+

‎docs/Address.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
2+
3+
# Address
4+
5+
6+
## Properties
7+
8+
| Name | Type | Description | Notes |
9+
|------------ | ------------- | ------------- | -------------|
10+
|**name** | **String** | The name of the business using the toll-free number. | |
11+
|**addr1** | **String** | The address of the business using the toll-free number. | |
12+
|**addr2** | **String** | The address of the business using the toll-free number. | [optional] |
13+
|**city** | **String** | The city of the business using the toll-free number. | |
14+
|**state** | **String** | The state of the business using the toll-free number. | |
15+
|**zip** | **String** | The zip of the business using the toll-free number. | |
16+
|**url** | **String** | The website of the business using the toll-free number. | |
17+
18+
19+

‎docs/Contact.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
2+
3+
# Contact
4+
5+
6+
## Properties
7+
8+
| Name | Type | Description | Notes |
9+
|------------ | ------------- | ------------- | -------------|
10+
|**firstName** | **String** | The first name of the business contact using the toll-free number. | |
11+
|**lastName** | **String** | The last name of the business contact using the toll-free number. | |
12+
|**email** | **String** | | |
13+
|**phoneNumber** | **String** | Contact telephone number | |
14+
15+
16+

‎docs/Error.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
2+
3+
# Error
4+
5+
6+
## Properties
7+
8+
| Name | Type | Description | Notes |
9+
|------------ | ------------- | ------------- | -------------|
10+
|**code** | **Integer** | | [optional] |
11+
|**description** | **String** | | [optional] |
12+
|**telephoneNumbers** | [**List<TelephoneNumber>**](TelephoneNumber.md) | | [optional] |
13+
14+
15+

‎docs/FailureWebhook.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
2+
3+
# FailureWebhook
4+
5+
6+
## Properties
7+
8+
| Name | Type | Description | Notes |
9+
|------------ | ------------- | ------------- | -------------|
10+
|**accountId** | **String** | User's account ID. | [optional] |
11+
|**phoneNumber** | **String** | Toll-free telephone number in E.164 format. | [optional] |
12+
|**errorCode** | **String** | An error code indicating what error was encountered. This code can be interpreted as an HTTP status code in regards to the error that was encountered. | [optional] |
13+
|**errorDescription** | **String** | A description of the error that was encountered. | [optional] |
14+
|**errors** | **List<String>** | Details of the errors that were encountered when processing the request. | [optional] |
15+
|**internalTicketNumber** | **UUID** | Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number. | [optional] |
16+
17+
18+

‎docs/GetTollFreeVerificationStatus200Response.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
2+
3+
# GetTollFreeVerificationStatus200Response
4+
5+
6+
## Properties
7+
8+
| Name | Type | Description | Notes |
9+
|------------ | ------------- | ------------- | -------------|
10+
|**phoneNumber** | **String** | Toll-free telephone number in E.164 format. | [optional] |
11+
|**status** | **TfvStatusEnum** | | [optional] |
12+
|**internalTicketNumber** | **UUID** | Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number - included in all webhook payloads. | [optional] |
13+
|**declineReasonDescription** | **String** | Explanation for why a verification request was declined. | [optional] |
14+
|**resubmitAllowed** | **Boolean** | Whether a Toll-Free Verification request qualifies for resubmission via PUT. | [optional] |
15+
|**createdDateTime** | **OffsetDateTime** | Date and time the verification request was created. | [optional] |
16+
|**modifiedDateTime** | **OffsetDateTime** | Date and time the verification request was last modified. | [optional] |
17+
|**submission** | [**TfvSubmissionInfo**](TfvSubmissionInfo.md) | | [optional] |
18+
19+
20+

‎docs/Links.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
2+
3+
# Links
4+
5+
6+
## Properties
7+
8+
| Name | Type | Description | Notes |
9+
|------------ | ------------- | ------------- | -------------|
10+
|**first** | **String** | The first (or only) page of results matching the query. | [optional] |
11+
|**next** | **String** | If more results exist than specified by 'size', this link returns the next page of 'size' results. | [optional] |
12+
|**previous** | **String** | If the results are more than one page, this link returns the previous page of 'size' results. | [optional] |
13+
|**last** | **String** | If more results exist than specified by 'size', this link return the last page of result. | [optional] |
14+
15+
16+

‎docs/OptInWorkflow.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
2+
3+
# OptInWorkflow
4+
5+
6+
## Properties
7+
8+
| Name | Type | Description | Notes |
9+
|------------ | ------------- | ------------- | -------------|
10+
|**description** | **String** | | |
11+
|**imageUrls** | **List<String>** | | |
12+
13+
14+

‎docs/TelephoneNumber.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
3+
# TelephoneNumber
4+
5+
6+
## Properties
7+
8+
| Name | Type | Description | Notes |
9+
|------------ | ------------- | ------------- | -------------|
10+
|**telephoneNumber** | **String** | Simple Telephone Number. | [optional] |
11+
12+
13+

‎docs/TfvBasicAuthentication.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
2+
3+
# TfvBasicAuthentication
4+
5+
6+
## Properties
7+
8+
| Name | Type | Description | Notes |
9+
|------------ | ------------- | ------------- | -------------|
10+
|**username** | **String** | | |
11+
|**password** | **String** | | |
12+
13+
14+

0 commit comments

Comments
 (0)