Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ docs/AnswerCallback.md
docs/BlockedWebhook.md
docs/BridgeCompleteCallback.md
docs/BridgeTargetCompleteCallback.md
docs/BusinessEntityTypeEnum.md
docs/BusinessRegistrationTypeEnum.md
docs/CallDirectionEnum.md
docs/CallRecordingMetadata.md
docs/CallState.md
Expand Down Expand Up @@ -211,6 +213,8 @@ src/main/java/com/bandwidth/sdk/model/AnswerCallback.java
src/main/java/com/bandwidth/sdk/model/BlockedWebhook.java
src/main/java/com/bandwidth/sdk/model/BridgeCompleteCallback.java
src/main/java/com/bandwidth/sdk/model/BridgeTargetCompleteCallback.java
src/main/java/com/bandwidth/sdk/model/BusinessEntityTypeEnum.java
src/main/java/com/bandwidth/sdk/model/BusinessRegistrationTypeEnum.java
src/main/java/com/bandwidth/sdk/model/CallDirectionEnum.java
src/main/java/com/bandwidth/sdk/model/CallRecordingMetadata.java
src/main/java/com/bandwidth/sdk/model/CallState.java
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,8 @@ Class | Method | HTTP request | Description
- [BlockedWebhook](docs/BlockedWebhook.md)
- [BridgeCompleteCallback](docs/BridgeCompleteCallback.md)
- [BridgeTargetCompleteCallback](docs/BridgeTargetCompleteCallback.md)
- [BusinessEntityTypeEnum](docs/BusinessEntityTypeEnum.md)
- [BusinessRegistrationTypeEnum](docs/BusinessRegistrationTypeEnum.md)
- [CallDirectionEnum](docs/CallDirectionEnum.md)
- [CallRecordingMetadata](docs/CallRecordingMetadata.md)
- [CallState](docs/CallState.md)
Expand Down
203 changes: 187 additions & 16 deletions api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -559,6 +559,28 @@ paths:
schema:
type: string
style: form
- description: A boolean value indicating whether the message is queued in the
carrier network. Only available for OUTBOUND messages from accounts with
the Advanced Quality Metrics feature enabled.
example: true
explode: true
in: query
name: carrierQueued
required: false
schema:
type: boolean
style: form
- description: The minimum carrier latency of the message in seconds. Only available
for OUTBOUND messages from accounts with the Advanced Quality Metrics feature
enabled.
example: 50
explode: true
in: query
name: fromCarrierLatency
required: false
schema:
type: integer
style: form
- description: Calling number country in A3 format.
example: USA
explode: true
Expand Down Expand Up @@ -6493,6 +6515,30 @@ components:
schema:
type: string
style: form
carrierQueued:
description: A boolean value indicating whether the message is queued in the
carrier network. Only available for OUTBOUND messages from accounts with the
Advanced Quality Metrics feature enabled.
example: true
explode: true
in: query
name: carrierQueued
required: false
schema:
type: boolean
style: form
fromCarrierLatency:
description: The minimum carrier latency of the message in seconds. Only available
for OUTBOUND messages from accounts with the Advanced Quality Metrics feature
enabled.
example: 50
explode: true
in: query
name: fromCarrierLatency
required: false
schema:
type: integer
style: form
callingNumberCountryA3:
description: Calling number country in A3 format.
example: USA
Expand Down Expand Up @@ -7957,6 +8003,7 @@ components:
receiveTime: 2020-04-07T14:03:07Z
accountId: "9900000"
messageDirection: INBOUND
carrierLatency: 20
messageType: sms
carrierName: other
recipientCount: 1
Expand All @@ -7979,6 +8026,7 @@ components:
receiveTime: 2020-04-07T14:03:07Z
accountId: "9900000"
messageDirection: INBOUND
carrierLatency: 20
messageType: sms
carrierName: other
recipientCount: 1
Expand Down Expand Up @@ -8018,6 +8066,7 @@ components:
receiveTime: 2020-04-07T14:03:07Z
accountId: "9900000"
messageDirection: INBOUND
carrierLatency: 20
messageType: sms
carrierName: other
recipientCount: 1
Expand Down Expand Up @@ -8104,6 +8153,13 @@ components:
example: 20
nullable: true
type: integer
carrierLatency:
description: The carrier latency of the message in seconds. Only available
for OUTBOUND messages from accounts with the Advanced Quality Metrics
feature enabled.
example: 20
nullable: true
type: integer
callingNumberCountryA3:
description: The A3 country code of the calling number.
example: USA
Expand Down Expand Up @@ -13192,6 +13248,47 @@ components:
description: The company 'Doing Business As'.
example: Another Company Name Inc.
type: string
businessRegistrationNumber:
description: "US Federal Tax ID Number (EIN) or Canada Business Number (CBN).\
\ Optional until early 2026. If a value is provided for this field, a value\
\ must be provided for `businessRegistrationType` and `businessEntityType`.\
\ Available starting October 1st, 2025."
example: 12-3456789
maxLength: 500
nullable: true
type: string
businessRegistrationTypeEnum:
description: "The type of business registration number. Optional until early\
\ 2026; required if `businessRegistrationNumber` is provided. Available starting\
\ October 1st, 2025."
enum:
- EIN
- CBN
nullable: true
type: string
businessEntityTypeEnum:
description: "The type of registered business. If no option is applicable, please\
\ provide \"SOLE_PROPRIETOR\" as a value. Optional until early 2026; required\
\ if `businessRegistrationNumber` is provided. Available starting October\
\ 1st, 2025."
enum:
- SOLE_PROPRIETOR
- PRIVATE_PROFIT
- PUBLIC_PROFIT
- NON_PROFIT
- GOVERNMENT
nullable: true
type: string
helpMessageResponse:
description: A message that gets sent to users requesting help.
example: Please contact support for assistance.
maxLength: 500
nullable: true
type: string
ageGatedContent:
description: Indicates whether the content is age-gated.
example: false
type: boolean
additionalDenialReason:
properties:
statusCode:
Expand Down Expand Up @@ -13300,6 +13397,29 @@ components:
description: The company 'Doing Business As'.
example: Another Company Name Inc.
type: string
businessRegistrationNumber:
description: "US Federal Tax ID Number (EIN) or Canada Business Number (CBN).\
\ Optional until early 2026. If a value is provided for this field, a\
\ value must be provided for `businessRegistrationType` and `businessEntityType`.\
\ Available starting October 1st, 2025."
example: 12-3456789
maxLength: 500
nullable: true
type: string
businessRegistrationType:
$ref: '#/components/schemas/businessRegistrationTypeEnum'
businessEntityType:
$ref: '#/components/schemas/businessEntityTypeEnum'
helpMessageResponse:
description: A message that gets sent to users requesting help.
example: Please contact support for assistance.
maxLength: 500
nullable: true
type: string
ageGatedContent:
description: Indicates whether the content is age-gated.
example: false
type: boolean
required:
- businessAddress
- businessContact
Expand Down Expand Up @@ -13371,6 +13491,29 @@ components:
description: The company 'Doing Business As'.
example: Another Company Name Inc.
type: string
businessRegistrationNumber:
description: "US Federal Tax ID Number (EIN) or Canada Business Number (CBN).\
\ Optional until early 2026. If a value is provided for this field, a\
\ value must be provided for `businessRegistrationType` and `businessEntityType`.\
\ Available starting October 1st, 2025."
example: 12-3456789
maxLength: 500
nullable: true
type: string
businessRegistrationType:
$ref: '#/components/schemas/businessRegistrationTypeEnum'
businessEntityType:
$ref: '#/components/schemas/businessEntityTypeEnum'
helpMessageResponse:
description: A message that gets sent to users requesting help.
example: Please contact support for assistance.
maxLength: 500
nullable: true
type: string
ageGatedContent:
description: Indicates whether the content is age-gated.
example: false
type: boolean
required:
- businessAddress
- businessContact
Expand Down Expand Up @@ -13665,6 +13808,7 @@ components:
imageUrls:
- https://www.example.com/path/to/resource
- https://www.example.com/path/to/resource
confirmationResponse: Thank you for opting in!
description: Opt In Flow
nullable: false
properties:
Expand All @@ -13684,6 +13828,12 @@ components:
.[a-z]{2,6}\\b([-a-zA-Z0-9@:%_\\+.~#()?&//=]*)"
type: string
type: array
confirmationResponse:
example: Thank you for opting in!
maxLength: 500
minLength: 0
nullable: true
type: string
required:
- description
- imageUrls
Expand Down Expand Up @@ -13994,16 +14144,26 @@ components:
modifiedDateTime: 2021-06-08T06:45:13Z
submission:
additionalInformation: Any additional information
useCase: 2FA
termsAndConditionsUrl: http://your-company.com/termsAndConditions
businessDba: Another Company Name Inc.
isvReseller: Test ISV
businessContact:
firstName: John
lastName: Doe
phoneNumber: "+19192654500"
email: [email protected]
messageVolume: 10000
businessEntityType: SOLE_PROPRIETOR
businessRegistrationType: EIN
privacyPolicyUrl: http://your-company.com/privacyPolicy
optInWorkflow:
imageUrls:
- https://www.example.com/path/to/resource
- https://www.example.com/path/to/resource
confirmationResponse: Thank you for opting in!
description: Opt In Flow
useCase: 2FA
isvReseller: Test ISV
businessRegistrationNumber: 12-3456789
productionMessageContent: Production message content
businessAddress:
zip: "27606"
Expand All @@ -14013,13 +14173,7 @@ components:
name: Bandwidth Inc.
state: NC
url: https://www.example.com/path/to/resource
privacyPolicyUrl: http://your-company.com/privacyPolicy
useCaseSummary: Text summarizing the use case for the toll-free number
optInWorkflow:
imageUrls:
- https://www.example.com/path/to/resource
- https://www.example.com/path/to/resource
description: Opt In Flow
declineReasonDescription: Invalid Information - Can't Validate URL - Website
is not accessible / not available
status: VERIFIED
Expand Down Expand Up @@ -14078,16 +14232,26 @@ components:
tfvSubmissionInfo:
example:
additionalInformation: Any additional information
useCase: 2FA
termsAndConditionsUrl: http://your-company.com/termsAndConditions
businessDba: Another Company Name Inc.
isvReseller: Test ISV
businessContact:
firstName: John
lastName: Doe
phoneNumber: "+19192654500"
email: [email protected]
messageVolume: 10000
businessEntityType: SOLE_PROPRIETOR
businessRegistrationType: EIN
privacyPolicyUrl: http://your-company.com/privacyPolicy
optInWorkflow:
imageUrls:
- https://www.example.com/path/to/resource
- https://www.example.com/path/to/resource
confirmationResponse: Thank you for opting in!
description: Opt In Flow
useCase: 2FA
isvReseller: Test ISV
businessRegistrationNumber: 12-3456789
productionMessageContent: Production message content
businessAddress:
zip: "27606"
Expand All @@ -14097,13 +14261,7 @@ components:
name: Bandwidth Inc.
state: NC
url: https://www.example.com/path/to/resource
privacyPolicyUrl: http://your-company.com/privacyPolicy
useCaseSummary: Text summarizing the use case for the toll-free number
optInWorkflow:
imageUrls:
- https://www.example.com/path/to/resource
- https://www.example.com/path/to/resource
description: Opt In Flow
properties:
businessAddress:
$ref: '#/components/schemas/address'
Expand Down Expand Up @@ -14164,6 +14322,19 @@ components:
description: The company 'Doing Business As'.
example: Another Company Name Inc.
type: string
businessRegistrationNumber:
description: "US Federal Tax ID Number (EIN) or Canada Business Number (CBN).\
\ Optional until early 2026. If a value is provided for this field, a\
\ value must be provided for `businessRegistrationType` and `businessEntityType`.\
\ Available starting October 1st, 2025."
example: 12-3456789
maxLength: 500
nullable: true
type: string
businessRegistrationType:
$ref: '#/components/schemas/businessRegistrationTypeEnum'
businessEntityType:
$ref: '#/components/schemas/businessEntityTypeEnum'
type: object
tfvStatusEnum:
enum:
Expand Down
Loading