diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index e986b28..5866ce2 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -19,6 +19,7 @@ docs/AccountStatistics.md docs/AdditionalDenialReason.md docs/Address.md docs/AnswerCallback.md +docs/BlockedWebhook.md docs/BridgeCompleteCallback.md docs/BridgeTargetCompleteCallback.md docs/CallDirectionEnum.md @@ -176,6 +177,7 @@ models/account-statistics.ts models/additional-denial-reason.ts models/address.ts models/answer-callback.ts +models/blocked-webhook.ts models/bridge-complete-callback.ts models/bridge-target-complete-callback.ts models/call-direction-enum.ts diff --git a/bandwidth.yml b/bandwidth.yml index e180a94..89d9488 100644 --- a/bandwidth.yml +++ b/bandwidth.yml @@ -5253,17 +5253,17 @@ components: description: >- The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) - example: http://your-company.com/privacyPolicyUrl.pdf + example: http://your-company.com/privacyPolicy type: string termsAndConditionsUrl: description: >- The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025) - example: http://your-company.com/termsAndConditionsUrl.pdf + example: http://your-company.com/termsAndConditions type: string - businessDBA: + businessDba: description: The company 'Doing Business As'. (Not Available Until 5/28/2025) - example: SecondCompany Name + example: Another Company Name Inc. type: string additionalDenialReason: properties: @@ -5349,8 +5349,8 @@ components: $ref: '#/components/schemas/privacyPolicyUrl' termsAndConditionsUrl: $ref: '#/components/schemas/termsAndConditionsUrl' - businessDBA: - $ref: '#/components/schemas/businessDBA' + businessDba: + $ref: '#/components/schemas/businessDba' verificationUpdateRequest: type: object required: @@ -5388,8 +5388,8 @@ components: $ref: '#/components/schemas/privacyPolicyUrl' termsAndConditionsUrl: $ref: '#/components/schemas/termsAndConditionsUrl' - businessDBA: - $ref: '#/components/schemas/businessDBA' + businessDba: + $ref: '#/components/schemas/businessDba' tfvBasicAuthentication: type: object properties: @@ -5483,6 +5483,21 @@ components: $ref: '#/components/schemas/tfvCallbackStatusEnum' internalTicketNumber: $ref: '#/components/schemas/internalTicketNumberForWebhook' + blockedWebhook: + type: object + properties: + accountId: + $ref: '#/components/schemas/accountId1' + phoneNumber: + $ref: '#/components/schemas/tfPhoneNumber' + status: + $ref: '#/components/schemas/tfvCallbackStatusEnum' + internalTicketNumber: + $ref: '#/components/schemas/internalTicketNumberForWebhook' + blocked: + $ref: '#/components/schemas/blocked' + blockedReason: + $ref: '#/components/schemas/blockedReason' tfvSubmissionWrapper: type: object properties: @@ -5849,8 +5864,8 @@ components: $ref: '#/components/schemas/privacyPolicyUrl' termsAndConditionsUrl: $ref: '#/components/schemas/termsAndConditionsUrl' - businessDBA: - $ref: '#/components/schemas/businessDBA' + businessDba: + $ref: '#/components/schemas/businessDba' tfvStatusEnum: type: string enum: @@ -7468,6 +7483,7 @@ components: - $ref: '#/components/schemas/verificationWebhook' - $ref: '#/components/schemas/verificationDenialWebhook' - $ref: '#/components/schemas/failureWebhook' + - $ref: '#/components/schemas/blockedWebhook' webhookSubscriptionRequest: description: >- Information about a webhook that Bandwidth should send upon the diff --git a/docs/BlockedWebhook.md b/docs/BlockedWebhook.md new file mode 100644 index 0000000..14fa7d4 --- /dev/null +++ b/docs/BlockedWebhook.md @@ -0,0 +1,30 @@ +# BlockedWebhook + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accountId** | **string** | User\'s account ID. | [optional] [default to undefined] +**phoneNumber** | **string** | Toll-free telephone number in E.164 format. | [optional] [default to undefined] +**status** | [**TfvCallbackStatusEnum**](TfvCallbackStatusEnum.md) | | [optional] [default to undefined] +**internalTicketNumber** | **string** | Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number. | [optional] [default to undefined] +**blocked** | **boolean** | Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [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. (Not Available Until 5/28/2025) | [optional] [default to undefined] + +## Example + +```typescript +import { BlockedWebhook } from 'bandwidth-sdk'; + +const instance: BlockedWebhook = { + accountId, + phoneNumber, + status, + internalTicketNumber, + blocked, + blockedReason, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TfvSubmissionInfo.md b/docs/TfvSubmissionInfo.md index 1754f98..914d369 100644 --- a/docs/TfvSubmissionInfo.md +++ b/docs/TfvSubmissionInfo.md @@ -16,7 +16,7 @@ Name | Type | Description | Notes **isvReseller** | **string** | ISV name. | [optional] [default to undefined] **privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) | [optional] [default to undefined] **termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025) | [optional] [default to undefined] -**businessDBA** | **string** | The company \'Doing Business As\'. (Not Available Until 5/28/2025) | [optional] [default to undefined] +**businessDba** | **string** | The company \'Doing Business As\'. (Not Available Until 5/28/2025) | [optional] [default to undefined] ## Example @@ -35,7 +35,7 @@ const instance: TfvSubmissionInfo = { isvReseller, privacyPolicyUrl, termsAndConditionsUrl, - businessDBA, + businessDba, }; ``` diff --git a/docs/VerificationRequest.md b/docs/VerificationRequest.md index 114a9f1..eeba726 100644 --- a/docs/VerificationRequest.md +++ b/docs/VerificationRequest.md @@ -17,7 +17,7 @@ Name | Type | Description | Notes **isvReseller** | **string** | ISV name. | [optional] [default to undefined] **privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) | [optional] [default to undefined] **termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025) | [optional] [default to undefined] -**businessDBA** | **string** | The company \'Doing Business As\'. (Not Available Until 5/28/2025) | [optional] [default to undefined] +**businessDba** | **string** | The company \'Doing Business As\'. (Not Available Until 5/28/2025) | [optional] [default to undefined] ## Example @@ -37,7 +37,7 @@ const instance: VerificationRequest = { isvReseller, privacyPolicyUrl, termsAndConditionsUrl, - businessDBA, + businessDba, }; ``` diff --git a/docs/VerificationUpdateRequest.md b/docs/VerificationUpdateRequest.md index 14e2493..522c350 100644 --- a/docs/VerificationUpdateRequest.md +++ b/docs/VerificationUpdateRequest.md @@ -16,7 +16,7 @@ Name | Type | Description | Notes **isvReseller** | **string** | ISV name. | [optional] [default to undefined] **privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) | [optional] [default to undefined] **termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025) | [optional] [default to undefined] -**businessDBA** | **string** | The company \'Doing Business As\'. (Not Available Until 5/28/2025) | [optional] [default to undefined] +**businessDba** | **string** | The company \'Doing Business As\'. (Not Available Until 5/28/2025) | [optional] [default to undefined] ## Example @@ -35,7 +35,7 @@ const instance: VerificationUpdateRequest = { isvReseller, privacyPolicyUrl, termsAndConditionsUrl, - businessDBA, + businessDba, }; ``` diff --git a/models/blocked-webhook.ts b/models/blocked-webhook.ts new file mode 100644 index 0000000..665ab7c --- /dev/null +++ b/models/blocked-webhook.ts @@ -0,0 +1,65 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Bandwidth + * Bandwidth\'s Communication APIs + * + * The version of the OpenAPI document: 1.0.0 + * Contact: letstalk@bandwidth.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import type { TfvCallbackStatusEnum } from './tfv-callback-status-enum'; + +/** + * + * @export + * @interface BlockedWebhook + */ +export interface BlockedWebhook { + /** + * User\'s account ID. + * @type {string} + * @memberof BlockedWebhook + */ + 'accountId'?: string; + /** + * Toll-free telephone number in E.164 format. + * @type {string} + * @memberof BlockedWebhook + */ + 'phoneNumber'?: string; + /** + * + * @type {TfvCallbackStatusEnum} + * @memberof BlockedWebhook + */ + 'status'?: TfvCallbackStatusEnum; + /** + * Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number. + * @type {string} + * @memberof BlockedWebhook + */ + 'internalTicketNumber'?: string; + /** + * Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) + * @type {boolean} + * @memberof BlockedWebhook + */ + 'blocked'?: boolean; + /** + * The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) + * @type {string} + * @memberof BlockedWebhook + */ + 'blockedReason'?: string; +} + + + diff --git a/models/index.ts b/models/index.ts index 5298d2d..d953e9d 100644 --- a/models/index.ts +++ b/models/index.ts @@ -2,6 +2,7 @@ export * from './account-statistics'; export * from './additional-denial-reason'; export * from './address'; export * from './answer-callback'; +export * from './blocked-webhook'; export * from './bridge-complete-callback'; export * from './bridge-target-complete-callback'; export * from './call-direction-enum'; diff --git a/models/tfv-submission-info.ts b/models/tfv-submission-info.ts index 6cf70d7..677c145 100644 --- a/models/tfv-submission-info.ts +++ b/models/tfv-submission-info.ts @@ -100,6 +100,6 @@ export interface TfvSubmissionInfo { * @type {string} * @memberof TfvSubmissionInfo */ - 'businessDBA'?: string; + 'businessDba'?: string; } diff --git a/models/verification-request.ts b/models/verification-request.ts index e17ccb7..fcd7496 100644 --- a/models/verification-request.ts +++ b/models/verification-request.ts @@ -106,6 +106,6 @@ export interface VerificationRequest { * @type {string} * @memberof VerificationRequest */ - 'businessDBA'?: string; + 'businessDba'?: string; } diff --git a/models/verification-update-request.ts b/models/verification-update-request.ts index 96ec2ed..8a4cd14 100644 --- a/models/verification-update-request.ts +++ b/models/verification-update-request.ts @@ -100,6 +100,6 @@ export interface VerificationUpdateRequest { * @type {string} * @memberof VerificationUpdateRequest */ - 'businessDBA'?: string; + 'businessDba'?: string; }