diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index a8d55bab..0a5ed83d 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -4,8 +4,6 @@ api/openapi.yaml build.gradle build.sbt docs/AccountStatistics.md -docs/AdditionalDenialReason.md -docs/Address.md docs/AnswerCallback.md docs/BridgeCompleteCallback.md docs/BridgeTargetCompleteCallback.md @@ -33,7 +31,6 @@ docs/ConferenceRecordingMetadata.md docs/ConferenceRedirectCallback.md docs/ConferenceStateEnum.md docs/ConferencesApi.md -docs/Contact.md docs/CreateCall.md docs/CreateCallResponse.md docs/CreateLookupResponse.md @@ -42,13 +39,10 @@ docs/DeferredResult.md docs/DisconnectCallback.md docs/Diversion.md docs/DtmfCallback.md -docs/Error.md -docs/FailureWebhook.md docs/FieldError.md docs/FileFormatEnum.md docs/GatherCallback.md docs/InitiateCallback.md -docs/LinksObject.md docs/ListMessageDirectionEnum.md docs/ListMessageItem.md docs/LookupRequest.md @@ -76,7 +70,6 @@ docs/MfaApi.md docs/MfaForbiddenRequestError.md docs/MfaRequestError.md docs/MfaUnauthorizedRequestError.md -docs/OptInWorkflow.md docs/PageInfo.md docs/PhoneNumberLookupApi.md docs/PriorityEnum.md @@ -91,16 +84,7 @@ docs/RedirectMethodEnum.md docs/StatisticsApi.md docs/StirShaken.md docs/Tag.md -docs/TelephoneNumber.md -docs/TfvBasicAuthentication.md -docs/TfvCallbackStatusEnum.md -docs/TfvError.md -docs/TfvStatus.md -docs/TfvStatusEnum.md -docs/TfvSubmissionInfo.md -docs/TfvSubmissionWrapper.md docs/TnLookupRequestError.md -docs/TollFreeVerificationApi.md docs/TranscribeRecording.md docs/Transcription.md docs/TranscriptionAvailableCallback.md @@ -112,19 +96,10 @@ docs/UpdateCall.md docs/UpdateCallRecording.md docs/UpdateConference.md docs/UpdateConferenceMember.md -docs/VerificationDenialWebhook.md -docs/VerificationRequest.md -docs/VerificationUpdateRequest.md -docs/VerificationWebhook.md docs/VerifyCodeRequest.md docs/VerifyCodeResponse.md docs/VoiceApiError.md docs/VoiceCodeResponse.md -docs/WebhookSubscription.md -docs/WebhookSubscriptionBasicAuthentication.md -docs/WebhookSubscriptionRequestSchema.md -docs/WebhookSubscriptionTypeEnum.md -docs/WebhookSubscriptionsListBody.md git_push.sh gradle.properties gradle/wrapper/gradle-wrapper.jar @@ -155,7 +130,6 @@ src/main/java/com/bandwidth/sdk/api/MfaApi.java src/main/java/com/bandwidth/sdk/api/PhoneNumberLookupApi.java src/main/java/com/bandwidth/sdk/api/RecordingsApi.java src/main/java/com/bandwidth/sdk/api/StatisticsApi.java -src/main/java/com/bandwidth/sdk/api/TollFreeVerificationApi.java src/main/java/com/bandwidth/sdk/api/TranscriptionsApi.java src/main/java/com/bandwidth/sdk/auth/ApiKeyAuth.java src/main/java/com/bandwidth/sdk/auth/Authentication.java @@ -163,8 +137,6 @@ src/main/java/com/bandwidth/sdk/auth/HttpBasicAuth.java src/main/java/com/bandwidth/sdk/auth/HttpBearerAuth.java src/main/java/com/bandwidth/sdk/model/AbstractOpenApiSchema.java src/main/java/com/bandwidth/sdk/model/AccountStatistics.java -src/main/java/com/bandwidth/sdk/model/AdditionalDenialReason.java -src/main/java/com/bandwidth/sdk/model/Address.java src/main/java/com/bandwidth/sdk/model/AnswerCallback.java src/main/java/com/bandwidth/sdk/model/BridgeCompleteCallback.java src/main/java/com/bandwidth/sdk/model/BridgeTargetCompleteCallback.java @@ -190,7 +162,6 @@ src/main/java/com/bandwidth/sdk/model/ConferenceRecordingAvailableCallback.java src/main/java/com/bandwidth/sdk/model/ConferenceRecordingMetadata.java src/main/java/com/bandwidth/sdk/model/ConferenceRedirectCallback.java src/main/java/com/bandwidth/sdk/model/ConferenceStateEnum.java -src/main/java/com/bandwidth/sdk/model/Contact.java src/main/java/com/bandwidth/sdk/model/CreateCall.java src/main/java/com/bandwidth/sdk/model/CreateCallResponse.java src/main/java/com/bandwidth/sdk/model/CreateLookupResponse.java @@ -199,13 +170,10 @@ src/main/java/com/bandwidth/sdk/model/DeferredResult.java src/main/java/com/bandwidth/sdk/model/DisconnectCallback.java src/main/java/com/bandwidth/sdk/model/Diversion.java src/main/java/com/bandwidth/sdk/model/DtmfCallback.java -src/main/java/com/bandwidth/sdk/model/Error.java -src/main/java/com/bandwidth/sdk/model/FailureWebhook.java src/main/java/com/bandwidth/sdk/model/FieldError.java src/main/java/com/bandwidth/sdk/model/FileFormatEnum.java src/main/java/com/bandwidth/sdk/model/GatherCallback.java src/main/java/com/bandwidth/sdk/model/InitiateCallback.java -src/main/java/com/bandwidth/sdk/model/LinksObject.java src/main/java/com/bandwidth/sdk/model/ListMessageDirectionEnum.java src/main/java/com/bandwidth/sdk/model/ListMessageItem.java src/main/java/com/bandwidth/sdk/model/LookupRequest.java @@ -230,7 +198,6 @@ src/main/java/com/bandwidth/sdk/model/MessagingRequestError.java src/main/java/com/bandwidth/sdk/model/MfaForbiddenRequestError.java src/main/java/com/bandwidth/sdk/model/MfaRequestError.java src/main/java/com/bandwidth/sdk/model/MfaUnauthorizedRequestError.java -src/main/java/com/bandwidth/sdk/model/OptInWorkflow.java src/main/java/com/bandwidth/sdk/model/PageInfo.java src/main/java/com/bandwidth/sdk/model/PriorityEnum.java src/main/java/com/bandwidth/sdk/model/RecordingAvailableCallback.java @@ -242,14 +209,6 @@ src/main/java/com/bandwidth/sdk/model/RedirectCallback.java src/main/java/com/bandwidth/sdk/model/RedirectMethodEnum.java src/main/java/com/bandwidth/sdk/model/StirShaken.java src/main/java/com/bandwidth/sdk/model/Tag.java -src/main/java/com/bandwidth/sdk/model/TelephoneNumber.java -src/main/java/com/bandwidth/sdk/model/TfvBasicAuthentication.java -src/main/java/com/bandwidth/sdk/model/TfvCallbackStatusEnum.java -src/main/java/com/bandwidth/sdk/model/TfvError.java -src/main/java/com/bandwidth/sdk/model/TfvStatus.java -src/main/java/com/bandwidth/sdk/model/TfvStatusEnum.java -src/main/java/com/bandwidth/sdk/model/TfvSubmissionInfo.java -src/main/java/com/bandwidth/sdk/model/TfvSubmissionWrapper.java src/main/java/com/bandwidth/sdk/model/TnLookupRequestError.java src/main/java/com/bandwidth/sdk/model/TranscribeRecording.java src/main/java/com/bandwidth/sdk/model/Transcription.java @@ -261,16 +220,7 @@ src/main/java/com/bandwidth/sdk/model/UpdateCall.java src/main/java/com/bandwidth/sdk/model/UpdateCallRecording.java src/main/java/com/bandwidth/sdk/model/UpdateConference.java src/main/java/com/bandwidth/sdk/model/UpdateConferenceMember.java -src/main/java/com/bandwidth/sdk/model/VerificationDenialWebhook.java -src/main/java/com/bandwidth/sdk/model/VerificationRequest.java -src/main/java/com/bandwidth/sdk/model/VerificationUpdateRequest.java -src/main/java/com/bandwidth/sdk/model/VerificationWebhook.java src/main/java/com/bandwidth/sdk/model/VerifyCodeRequest.java src/main/java/com/bandwidth/sdk/model/VerifyCodeResponse.java src/main/java/com/bandwidth/sdk/model/VoiceApiError.java src/main/java/com/bandwidth/sdk/model/VoiceCodeResponse.java -src/main/java/com/bandwidth/sdk/model/WebhookSubscription.java -src/main/java/com/bandwidth/sdk/model/WebhookSubscriptionBasicAuthentication.java -src/main/java/com/bandwidth/sdk/model/WebhookSubscriptionRequestSchema.java -src/main/java/com/bandwidth/sdk/model/WebhookSubscriptionTypeEnum.java -src/main/java/com/bandwidth/sdk/model/WebhookSubscriptionsListBody.java diff --git a/README.md b/README.md index 2cba1c56..4af7c59a 100644 --- a/README.md +++ b/README.md @@ -158,14 +158,6 @@ Class | Method | HTTP request | Description *RecordingsApi* | [**transcribeCallRecording**](docs/RecordingsApi.md#transcribeCallRecording) | **POST** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription | Create Transcription Request *RecordingsApi* | [**updateCallRecordingState**](docs/RecordingsApi.md#updateCallRecordingState) | **PUT** /accounts/{accountId}/calls/{callId}/recording | Update Recording *StatisticsApi* | [**getStatistics**](docs/StatisticsApi.md#getStatistics) | **GET** /accounts/{accountId}/statistics | Get Account Statistics -*TollFreeVerificationApi* | [**createWebhookSubscription**](docs/TollFreeVerificationApi.md#createWebhookSubscription) | **POST** /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions | Create Webhook Subscription -*TollFreeVerificationApi* | [**deleteWebhookSubscription**](docs/TollFreeVerificationApi.md#deleteWebhookSubscription) | **DELETE** /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions/{id} | Delete Webhook Subscription -*TollFreeVerificationApi* | [**getTollFreeVerificationStatus**](docs/TollFreeVerificationApi.md#getTollFreeVerificationStatus) | **GET** /accounts/{accountId}/phoneNumbers/{phoneNumber}/tollFreeVerification | Get Toll-Free Verification Status -*TollFreeVerificationApi* | [**listTollFreeUseCases**](docs/TollFreeVerificationApi.md#listTollFreeUseCases) | **GET** /tollFreeVerification/useCases | List Toll-Free Use Cases -*TollFreeVerificationApi* | [**listWebhookSubscriptions**](docs/TollFreeVerificationApi.md#listWebhookSubscriptions) | **GET** /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions | List Webhook Subscriptions -*TollFreeVerificationApi* | [**requestTollFreeVerification**](docs/TollFreeVerificationApi.md#requestTollFreeVerification) | **POST** /accounts/{accountId}/tollFreeVerification | Request Toll-Free Verification -*TollFreeVerificationApi* | [**updateTollFreeVerificationRequest**](docs/TollFreeVerificationApi.md#updateTollFreeVerificationRequest) | **PUT** /accounts/{accountId}/phoneNumbers/{phoneNumber}/tollFreeVerification | Update Toll-Free Verification Request -*TollFreeVerificationApi* | [**updateWebhookSubscription**](docs/TollFreeVerificationApi.md#updateWebhookSubscription) | **PUT** /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions/{id} | Update Webhook Subscription *TranscriptionsApi* | [**deleteRealTimeTranscription**](docs/TranscriptionsApi.md#deleteRealTimeTranscription) | **DELETE** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete a specific transcription *TranscriptionsApi* | [**getRealTimeTranscription**](docs/TranscriptionsApi.md#getRealTimeTranscription) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Retrieve a specific transcription *TranscriptionsApi* | [**listRealTimeTranscriptions**](docs/TranscriptionsApi.md#listRealTimeTranscriptions) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions | Enumerate transcriptions made with StartTranscription @@ -174,8 +166,6 @@ Class | Method | HTTP request | Description ## Documentation for Models - [AccountStatistics](docs/AccountStatistics.md) - - [AdditionalDenialReason](docs/AdditionalDenialReason.md) - - [Address](docs/Address.md) - [AnswerCallback](docs/AnswerCallback.md) - [BridgeCompleteCallback](docs/BridgeCompleteCallback.md) - [BridgeTargetCompleteCallback](docs/BridgeTargetCompleteCallback.md) @@ -201,7 +191,6 @@ Class | Method | HTTP request | Description - [ConferenceRecordingMetadata](docs/ConferenceRecordingMetadata.md) - [ConferenceRedirectCallback](docs/ConferenceRedirectCallback.md) - [ConferenceStateEnum](docs/ConferenceStateEnum.md) - - [Contact](docs/Contact.md) - [CreateCall](docs/CreateCall.md) - [CreateCallResponse](docs/CreateCallResponse.md) - [CreateLookupResponse](docs/CreateLookupResponse.md) @@ -210,13 +199,10 @@ Class | Method | HTTP request | Description - [DisconnectCallback](docs/DisconnectCallback.md) - [Diversion](docs/Diversion.md) - [DtmfCallback](docs/DtmfCallback.md) - - [Error](docs/Error.md) - - [FailureWebhook](docs/FailureWebhook.md) - [FieldError](docs/FieldError.md) - [FileFormatEnum](docs/FileFormatEnum.md) - [GatherCallback](docs/GatherCallback.md) - [InitiateCallback](docs/InitiateCallback.md) - - [LinksObject](docs/LinksObject.md) - [ListMessageDirectionEnum](docs/ListMessageDirectionEnum.md) - [ListMessageItem](docs/ListMessageItem.md) - [LookupRequest](docs/LookupRequest.md) @@ -241,7 +227,6 @@ Class | Method | HTTP request | Description - [MfaForbiddenRequestError](docs/MfaForbiddenRequestError.md) - [MfaRequestError](docs/MfaRequestError.md) - [MfaUnauthorizedRequestError](docs/MfaUnauthorizedRequestError.md) - - [OptInWorkflow](docs/OptInWorkflow.md) - [PageInfo](docs/PageInfo.md) - [PriorityEnum](docs/PriorityEnum.md) - [RecordingAvailableCallback](docs/RecordingAvailableCallback.md) @@ -253,14 +238,6 @@ Class | Method | HTTP request | Description - [RedirectMethodEnum](docs/RedirectMethodEnum.md) - [StirShaken](docs/StirShaken.md) - [Tag](docs/Tag.md) - - [TelephoneNumber](docs/TelephoneNumber.md) - - [TfvBasicAuthentication](docs/TfvBasicAuthentication.md) - - [TfvCallbackStatusEnum](docs/TfvCallbackStatusEnum.md) - - [TfvError](docs/TfvError.md) - - [TfvStatus](docs/TfvStatus.md) - - [TfvStatusEnum](docs/TfvStatusEnum.md) - - [TfvSubmissionInfo](docs/TfvSubmissionInfo.md) - - [TfvSubmissionWrapper](docs/TfvSubmissionWrapper.md) - [TnLookupRequestError](docs/TnLookupRequestError.md) - [TranscribeRecording](docs/TranscribeRecording.md) - [Transcription](docs/Transcription.md) @@ -272,19 +249,10 @@ Class | Method | HTTP request | Description - [UpdateCallRecording](docs/UpdateCallRecording.md) - [UpdateConference](docs/UpdateConference.md) - [UpdateConferenceMember](docs/UpdateConferenceMember.md) - - [VerificationDenialWebhook](docs/VerificationDenialWebhook.md) - - [VerificationRequest](docs/VerificationRequest.md) - - [VerificationUpdateRequest](docs/VerificationUpdateRequest.md) - - [VerificationWebhook](docs/VerificationWebhook.md) - [VerifyCodeRequest](docs/VerifyCodeRequest.md) - [VerifyCodeResponse](docs/VerifyCodeResponse.md) - [VoiceApiError](docs/VoiceApiError.md) - [VoiceCodeResponse](docs/VoiceCodeResponse.md) - - [WebhookSubscription](docs/WebhookSubscription.md) - - [WebhookSubscriptionBasicAuthentication](docs/WebhookSubscriptionBasicAuthentication.md) - - [WebhookSubscriptionRequestSchema](docs/WebhookSubscriptionRequestSchema.md) - - [WebhookSubscriptionTypeEnum](docs/WebhookSubscriptionTypeEnum.md) - - [WebhookSubscriptionsListBody](docs/WebhookSubscriptionsListBody.md) diff --git a/api/openapi.yaml b/api/openapi.yaml index 34b06e36..17670371 100644 --- a/api/openapi.yaml +++ b/api/openapi.yaml @@ -21,7 +21,6 @@ tags: - name: Transcriptions - name: MFA - name: Phone Number Lookup -- name: Toll-Free Verification paths: /users/{accountId}/media: get: @@ -4637,829 +4636,6 @@ paths: servers: - description: Production url: https://numbers.bandwidth.com/api/v1 - /accounts/{accountId}/tollFreeVerification: - post: - callbacks: - tfVerificationStatus: - $ref: '#/components/callbacks/tfVerificationStatus' - description: Submit a request for verification of a toll-free phone number. - operationId: requestTollFreeVerification - parameters: - - description: Your Bandwidth Account ID. - example: "9900000" - explode: false - in: path - name: accountId - required: true - schema: - type: string - style: simple - requestBody: - $ref: '#/components/requestBodies/requestTollFreeVerificationRequest' - responses: - "202": - description: Accepted - "400": - content: - application/json: - example: - description: cannot process request. - errors: - businessName: Business name is required. - businessContactEmail: Business contact email is not a valid email - address. - optInWorkflowImageURLs: Entries must be a valid array of objects. - schema: - $ref: '#/components/schemas/tfvError' - description: Bad Request - "401": - content: - application/json: - example: - description: Client is providing incorrect or invalid credentials. - type: unauthorized - schema: - $ref: '#/components/schemas/tfvError' - description: Unauthorized - "403": - content: - application/json: - example: - description: Client is not authorized for the action. - type: forbidden - schema: - $ref: '#/components/schemas/tfvError' - description: Forbidden - "405": - content: - application/json: - example: - description: Method is not allowed. - type: Method Not Allowed - schema: - $ref: '#/components/schemas/tfvError' - description: Method Not Allowed - "429": - content: - application/json: - example: - description: Throttling error. Too many requests. - type: Too Many Requests - schema: - $ref: '#/components/schemas/tfvError' - description: Too Many Requests - "500": - content: - application/json: - example: - description: Internal Server Error. - type: Internal Server Error - schema: - $ref: '#/components/schemas/tfvError' - description: Internal Server Error - "503": - content: - application/json: - example: - description: Service Unavailable Error. - type: Service Unavailable - schema: - $ref: '#/components/schemas/tfvError' - description: Service Unavailable - summary: Request Toll-Free Verification - tags: - - Toll-Free Verification - x-content-type: application/json - x-accepts: - - application/json - servers: - - description: Production - url: https://api.bandwidth.com/api/v2 - /accounts/{accountId}/phoneNumbers/{phoneNumber}/tollFreeVerification: - get: - description: |- - Gets the verification status for a phone number that is provisioned to your account. - Submission information will be appended to the response if it is available. - operationId: getTollFreeVerificationStatus - parameters: - - description: Your Bandwidth Account ID. - example: "9900000" - explode: false - in: path - name: accountId - required: true - schema: - type: string - style: simple - - description: Valid Toll-Free telephone number in E.164 format. - example: "+18885555555" - explode: false - in: path - name: phoneNumber - required: true - schema: - $ref: '#/components/schemas/tfPhoneNumber' - style: simple - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/tfvStatus' - description: OK - "400": - content: - application/json: - example: - description: Cannot process request. - type: bad request - schema: - $ref: '#/components/schemas/tfvError' - description: Bad Request - "401": - content: - application/json: - example: - description: Client is providing incorrect or invalid credentials. - type: unauthorized - schema: - $ref: '#/components/schemas/tfvError' - description: Unauthorized - "403": - content: - application/json: - example: - description: Client is not authorized for the action. - type: forbidden - schema: - $ref: '#/components/schemas/tfvError' - description: Forbidden - "404": - content: - application/json: - example: - description: Cannot find the requested resource. - type: Not Found - schema: - $ref: '#/components/schemas/tfvError' - description: Cannot find the requested resource. - "405": - content: - application/json: - example: - description: Method is not allowed. - type: Method Not Allowed - schema: - $ref: '#/components/schemas/tfvError' - description: Method Not Allowed - "429": - content: - application/json: - example: - description: Throttling error. Too many requests. - type: Too Many Requests - schema: - $ref: '#/components/schemas/tfvError' - description: Too Many Requests - "500": - content: - application/json: - example: - description: Internal Server Error. - type: Internal Server Error - schema: - $ref: '#/components/schemas/tfvError' - description: Internal Server Error - "503": - content: - application/json: - example: - description: Service Unavailable Error. - type: Service Unavailable - schema: - $ref: '#/components/schemas/tfvError' - description: Service Unavailable - summary: Get Toll-Free Verification Status - tags: - - Toll-Free Verification - x-accepts: - - application/json - put: - callbacks: - tfVerificationStatus: - $ref: '#/components/callbacks/tfVerificationStatus' - description: |- - Updates a toll-free verification request. - Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). - operationId: updateTollFreeVerificationRequest - parameters: - - description: Your Bandwidth Account ID. - example: "9900000" - explode: false - in: path - name: accountId - required: true - schema: - type: string - style: simple - - description: Valid Toll-Free telephone number in E.164 format. - example: "+18885555555" - explode: false - in: path - name: phoneNumber - required: true - schema: - $ref: '#/components/schemas/tfPhoneNumber' - style: simple - requestBody: - $ref: '#/components/requestBodies/updateTollFreeVerificationRequestRequest' - responses: - "202": - description: Accepted - "400": - content: - application/json: - example: - description: cannot process request. - errors: - businessName: Business name is required. - businessContactEmail: Business contact email is not a valid email - address. - optInWorkflowImageURLs: Entries must be a valid array of objects. - schema: - $ref: '#/components/schemas/tfvError' - description: Bad Request - "401": - content: - application/json: - example: - description: Client is providing incorrect or invalid credentials. - type: unauthorized - schema: - $ref: '#/components/schemas/tfvError' - description: Unauthorized - "403": - content: - application/json: - example: - description: Client is not authorized for the action. - type: forbidden - schema: - $ref: '#/components/schemas/tfvError' - description: Forbidden - "405": - content: - application/json: - example: - description: Method is not allowed. - type: Method Not Allowed - schema: - $ref: '#/components/schemas/tfvError' - description: Method Not Allowed - "429": - content: - application/json: - example: - description: Throttling error. Too many requests. - type: Too Many Requests - schema: - $ref: '#/components/schemas/tfvError' - description: Too Many Requests - "500": - content: - application/json: - example: - description: Internal Server Error. - type: Internal Server Error - schema: - $ref: '#/components/schemas/tfvError' - description: Internal Server Error - "503": - content: - application/json: - example: - description: Service Unavailable Error. - type: Service Unavailable - schema: - $ref: '#/components/schemas/tfvError' - description: Service Unavailable - summary: Update Toll-Free Verification Request - tags: - - Toll-Free Verification - x-content-type: application/json - x-accepts: - - application/json - servers: - - description: Production - url: https://api.bandwidth.com/api/v2 - /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions: - get: - description: |- - Lists all webhook subscriptions that are registered to receive status updates for the toll-free verification requests submitted under this account (password will not be returned through this API - If `basicAuthentication` is defined, the `password` property of that object will be null). - operationId: listWebhookSubscriptions - parameters: - - description: Your Bandwidth Account ID. - example: "9900000" - explode: false - in: path - name: accountId - required: true - schema: - type: string - style: simple - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/webhookSubscriptionsListBody' - description: OK - "400": - content: - application/json: - example: - description: cannot process request. - errors: - businessName: Business name is required. - businessContactEmail: Business contact email is not a valid email - address. - optInWorkflowImageURLs: Entries must be a valid array of objects. - schema: - $ref: '#/components/schemas/tfvError' - description: Bad Request - "401": - content: - application/json: - example: - description: Client is providing incorrect or invalid credentials. - type: unauthorized - schema: - $ref: '#/components/schemas/tfvError' - description: Unauthorized - "403": - content: - application/json: - example: - description: Client is not authorized for the action. - type: forbidden - schema: - $ref: '#/components/schemas/tfvError' - description: Forbidden - "405": - content: - application/json: - example: - description: Method is not allowed. - type: Method Not Allowed - schema: - $ref: '#/components/schemas/tfvError' - description: Method Not Allowed - "429": - content: - application/json: - example: - description: Throttling error. Too many requests. - type: Too Many Requests - schema: - $ref: '#/components/schemas/tfvError' - description: Too Many Requests - "500": - content: - application/json: - example: - description: Internal Server Error. - type: Internal Server Error - schema: - $ref: '#/components/schemas/tfvError' - description: Internal Server Error - "503": - content: - application/json: - example: - description: Service Unavailable Error. - type: Service Unavailable - schema: - $ref: '#/components/schemas/tfvError' - description: Service Unavailable - summary: List Webhook Subscriptions - tags: - - Toll-Free Verification - x-accepts: - - application/json - post: - description: |- - Create a new webhook subscription (this webhook will be called for every update on every submission). - In addition to a `callbackUrl`, this subscription can provide optional HTTP basic authentication credentials (a username and a password). - The returned subscription object will contain an ID that can be used to modify or delete the subscription at a later time. - operationId: createWebhookSubscription - parameters: - - description: Your Bandwidth Account ID. - example: "9900000" - explode: false - in: path - name: accountId - required: true - schema: - type: string - style: simple - requestBody: - $ref: '#/components/requestBodies/webhookSubscriptionRequest' - responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/webhookSubscription' - description: Created - "400": - content: - application/json: - example: - description: Cannot process request. - type: bad request - schema: - $ref: '#/components/schemas/tfvError' - description: Bad Request - "401": - content: - application/json: - example: - description: Client is providing incorrect or invalid credentials. - type: unauthorized - schema: - $ref: '#/components/schemas/tfvError' - description: Unauthorized - "403": - content: - application/json: - example: - description: Client is not authorized for the action. - type: forbidden - schema: - $ref: '#/components/schemas/tfvError' - description: Forbidden - "404": - content: - application/json: - example: - description: Cannot find the requested resource. - type: Not Found - schema: - $ref: '#/components/schemas/tfvError' - description: Cannot find the requested resource. - "405": - content: - application/json: - example: - description: Method is not allowed. - type: Method Not Allowed - schema: - $ref: '#/components/schemas/tfvError' - description: Method Not Allowed - "429": - content: - application/json: - example: - description: Throttling error. Too many requests. - type: Too Many Requests - schema: - $ref: '#/components/schemas/tfvError' - description: Too Many Requests - "500": - content: - application/json: - example: - description: Internal Server Error. - type: Internal Server Error - schema: - $ref: '#/components/schemas/tfvError' - description: Internal Server Error - "503": - content: - application/json: - example: - description: Service Unavailable Error. - type: Service Unavailable - schema: - $ref: '#/components/schemas/tfvError' - description: Service Unavailable - summary: Create Webhook Subscription - tags: - - Toll-Free Verification - x-content-type: application/json - x-accepts: - - application/json - servers: - - description: Production - url: https://api.bandwidth.com/api/v2 - /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions/{id}: - delete: - description: Delete a webhook subscription by ID. - operationId: deleteWebhookSubscription - parameters: - - description: Your Bandwidth Account ID. - example: "9900000" - explode: false - in: path - name: accountId - required: true - schema: - type: string - style: simple - - description: Webhook subscription ID - example: 7bt57JcsVYJrN9K1OcV1Nu - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - responses: - "204": - description: No Content - "400": - content: - application/json: - example: - description: Cannot process request. - type: bad request - schema: - $ref: '#/components/schemas/tfvError' - description: Bad Request - "401": - content: - application/json: - example: - description: Client is providing incorrect or invalid credentials. - type: unauthorized - schema: - $ref: '#/components/schemas/tfvError' - description: Unauthorized - "403": - content: - application/json: - example: - description: Client is not authorized for the action. - type: forbidden - schema: - $ref: '#/components/schemas/tfvError' - description: Forbidden - "404": - content: - application/json: - example: - description: Cannot find the requested resource. - type: Not Found - schema: - $ref: '#/components/schemas/tfvError' - description: Cannot find the requested resource. - "405": - content: - application/json: - example: - description: Method is not allowed. - type: Method Not Allowed - schema: - $ref: '#/components/schemas/tfvError' - description: Method Not Allowed - "429": - content: - application/json: - example: - description: Throttling error. Too many requests. - type: Too Many Requests - schema: - $ref: '#/components/schemas/tfvError' - description: Too Many Requests - "500": - content: - application/json: - example: - description: Internal Server Error. - type: Internal Server Error - schema: - $ref: '#/components/schemas/tfvError' - description: Internal Server Error - "503": - content: - application/json: - example: - description: Service Unavailable Error. - type: Service Unavailable - schema: - $ref: '#/components/schemas/tfvError' - description: Service Unavailable - summary: Delete Webhook Subscription - tags: - - Toll-Free Verification - x-accepts: - - application/json - put: - description: Update an existing webhook subscription (`callbackUrl` and `basicAuthentication` - can be updated). - operationId: updateWebhookSubscription - parameters: - - description: Your Bandwidth Account ID. - example: "9900000" - explode: false - in: path - name: accountId - required: true - schema: - type: string - style: simple - - description: Webhook subscription ID - example: 7bt57JcsVYJrN9K1OcV1Nu - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - requestBody: - $ref: '#/components/requestBodies/webhookSubscriptionRequest' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/webhookSubscription' - description: OK - "400": - content: - application/json: - example: - description: Cannot process request. - type: bad request - schema: - $ref: '#/components/schemas/tfvError' - description: Bad Request - "401": - content: - application/json: - example: - description: Client is providing incorrect or invalid credentials. - type: unauthorized - schema: - $ref: '#/components/schemas/tfvError' - description: Unauthorized - "403": - content: - application/json: - example: - description: Client is not authorized for the action. - type: forbidden - schema: - $ref: '#/components/schemas/tfvError' - description: Forbidden - "404": - content: - application/json: - example: - description: Cannot find the requested resource. - type: Not Found - schema: - $ref: '#/components/schemas/tfvError' - description: Cannot find the requested resource. - "405": - content: - application/json: - example: - description: Method is not allowed. - type: Method Not Allowed - schema: - $ref: '#/components/schemas/tfvError' - description: Method Not Allowed - "429": - content: - application/json: - example: - description: Throttling error. Too many requests. - type: Too Many Requests - schema: - $ref: '#/components/schemas/tfvError' - description: Too Many Requests - "500": - content: - application/json: - example: - description: Internal Server Error. - type: Internal Server Error - schema: - $ref: '#/components/schemas/tfvError' - description: Internal Server Error - "503": - content: - application/json: - example: - description: Service Unavailable Error. - type: Service Unavailable - schema: - $ref: '#/components/schemas/tfvError' - description: Service Unavailable - summary: Update Webhook Subscription - tags: - - Toll-Free Verification - x-content-type: application/json - x-accepts: - - application/json - servers: - - description: Production - url: https://api.bandwidth.com/api/v2 - /tollFreeVerification/useCases: - get: - description: Lists valid toll-free use cases. - operationId: listTollFreeUseCases - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/useCases' - description: OK - "400": - content: - application/json: - example: - description: Cannot process request. - type: bad request - schema: - $ref: '#/components/schemas/tfvError' - description: Bad Request - "401": - content: - application/json: - example: - description: Client is providing incorrect or invalid credentials. - type: unauthorized - schema: - $ref: '#/components/schemas/tfvError' - description: Unauthorized - "403": - content: - application/json: - example: - description: Client is not authorized for the action. - type: forbidden - schema: - $ref: '#/components/schemas/tfvError' - description: Forbidden - "404": - content: - application/json: - example: - description: Cannot find the requested resource. - type: Not Found - schema: - $ref: '#/components/schemas/tfvError' - description: Cannot find the requested resource. - "405": - content: - application/json: - example: - description: Method is not allowed. - type: Method Not Allowed - schema: - $ref: '#/components/schemas/tfvError' - description: Method Not Allowed - "429": - content: - application/json: - example: - description: Throttling error. Too many requests. - type: Too Many Requests - schema: - $ref: '#/components/schemas/tfvError' - description: Too Many Requests - "500": - content: - application/json: - example: - description: Internal Server Error. - type: Internal Server Error - schema: - $ref: '#/components/schemas/tfvError' - description: Internal Server Error - "503": - content: - application/json: - example: - description: Service Unavailable Error. - type: Service Unavailable - schema: - $ref: '#/components/schemas/tfvError' - description: Service Unavailable - summary: List Toll-Free Use Cases - tags: - - Toll-Free Verification - x-accepts: - - application/json - servers: - - description: Production - url: https://api.bandwidth.com/api/v2 components: callbacks: inboundCallback: @@ -5508,102 +4684,6 @@ components: responses: "200": description: OK - tfVerificationStatus: - your_url.com/webhookService: - post: - description: Unique webhook URL provided by customers to which Bandwidth - sends a POST request to notify customer regarding TFV status updates. - operationId: tfvRequest - parameters: - - description: "64-character lowercase hexidecimal HMAC calculated with\ - \ a shared secret key, the canonicalized request body, and SHA256. It\ - \ is only included when a shared secret key is set through webhook subscription." - example: ca7b9e9816c90d336f5dca529e733354b81535c7af027b81878ac98afb2dbaa2 - explode: false - in: header - name: x-bandwidth-signature-hmac-sha256 - required: false - schema: - type: string - style: simple - requestBody: - $ref: '#/components/requestBodies/verificationWebhookRequest' - responses: - "204": - description: No Content - "400": - content: - application/json: - example: - description: Cannot process request. - type: bad request - schema: - $ref: '#/components/schemas/tfvError' - description: Bad Request - "401": - content: - application/json: - example: - description: Client is providing incorrect or invalid credentials. - type: unauthorized - schema: - $ref: '#/components/schemas/tfvError' - description: Unauthorized - "403": - content: - application/json: - example: - description: Client is not authorized for the action. - type: forbidden - schema: - $ref: '#/components/schemas/tfvError' - description: Forbidden - "404": - content: - application/json: - example: - description: Cannot find the requested resource. - type: Not Found - schema: - $ref: '#/components/schemas/tfvError' - description: Cannot find the requested resource. - "405": - content: - application/json: - example: - description: Method is not allowed. - type: Method Not Allowed - schema: - $ref: '#/components/schemas/tfvError' - description: Method Not Allowed - "429": - content: - application/json: - example: - description: Throttling error. Too many requests. - type: Too Many Requests - schema: - $ref: '#/components/schemas/tfvError' - description: Too Many Requests - "500": - content: - application/json: - example: - description: Internal Server Error. - type: Internal Server Error - schema: - $ref: '#/components/schemas/tfvError' - description: Internal Server Error - "503": - content: - application/json: - example: - description: Service Unavailable Error. - type: Service Unavailable - schema: - $ref: '#/components/schemas/tfvError' - description: Service Unavailable - summary: TFV status updates sent to customer's webhook URL. examples: smsMessageReceivedCallbackExample: summary: An example of a sms message-received callback body. @@ -6336,26 +5416,6 @@ components: schema: type: string style: simple - tfPhoneNumberPathParam: - description: Valid Toll-Free telephone number in E.164 format. - example: "+18885555555" - explode: false - in: path - name: phoneNumber - required: true - schema: - $ref: '#/components/schemas/tfPhoneNumber' - style: simple - webhookSubscriptionIdPathParam: - description: Webhook subscription ID - example: 7bt57JcsVYJrN9K1OcV1Nu - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple requestBodies: createMessageRequest: content: @@ -6660,38 +5720,6 @@ components: $ref: '#/components/schemas/lookupRequest' description: Phone number lookup request. required: true - requestTollFreeVerificationRequest: - content: - application/json: - schema: - $ref: '#/components/schemas/verificationRequest' - description: Request for verification of a toll-free phone number. - required: true - updateTollFreeVerificationRequestRequest: - content: - application/json: - schema: - $ref: '#/components/schemas/tfvSubmissionWrapper' - description: Update a request for verification of a toll-free phone number. - required: true - verificationWebhookRequest: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/verificationWebhook' - - $ref: '#/components/schemas/verificationDenialWebhook' - - $ref: '#/components/schemas/failureWebhook' - description: Verification callback status of a toll-free phone number. - required: true - webhookSubscriptionRequest: - content: - application/json: - schema: - $ref: '#/components/schemas/webhookSubscriptionRequestSchema' - description: Information about a webhook that Bandwidth should send upon the - completion of event customer is trying to subscribe to. - required: true responses: createMessageResponse: content: @@ -7093,167 +6121,53 @@ components: tnLookupForbiddenError: content: application/json: - examples: - forbidden: - summary: Example Forbidden Error - value: - message: Authorization header requires 'Credential' parameter. Authorization - header requires 'Signature' parameter. Authorization header requires - 'SignedHeaders' parameter. Authorization header requires existence - of either a 'X-Amz-Date' or a 'Date' header. Authorization=Basic - Y2tvZloPTGhHgywYIzGlcGVlcGvvcGovYTIGIt==' - schema: - $ref: '#/components/schemas/tnLookupRequestError' - description: Forbidden - tnLookupMediaTypeError: - content: - application/json: - examples: - mediaType: - summary: Example Unsupported Media Type Error - value: - message: Content-Type must be application/json. - schema: - $ref: '#/components/schemas/tnLookupRequestError' - description: Unsupported Media Type - tnLookupNotFoundError: - description: Not Found - tnLookupTooManyRequestsError: - content: - application/json: - examples: - mediaType: - summary: Example Too Many Requests Error - value: - message: Too many requests. - schema: - $ref: '#/components/schemas/tnLookupRequestError' - description: Too Many Requests - tnLookupInternalServerError: - content: - application/json: - examples: - mediaType: - summary: Example Internal Server Error Error - value: - message: Request has not been passed further. - schema: - $ref: '#/components/schemas/tnLookupRequestError' - description: Internal Server Error - getTollFreeVerificationStatusResponse: - content: - application/json: - schema: - $ref: '#/components/schemas/tfvStatus' - description: OK - listWebhookSubscriptionsResponse: - content: - application/json: - schema: - $ref: '#/components/schemas/webhookSubscriptionsListBody' - description: OK - createWebhookSubscriptionResponse: - content: - application/json: - schema: - $ref: '#/components/schemas/webhookSubscription' - description: Created - updateWebhookSubscriptionResponse: - content: - application/json: - schema: - $ref: '#/components/schemas/webhookSubscription' - description: OK - listTollFreeUseCasesResponse: - content: - application/json: - schema: - $ref: '#/components/schemas/useCases' - description: OK - tfvBadRequestResponse: - content: - application/json: - example: - description: Cannot process request. - type: bad request - schema: - $ref: '#/components/schemas/tfvError' - description: Bad Request - tfvPostBadRequestResponse: - content: - application/json: - example: - description: cannot process request. - errors: - businessName: Business name is required. - businessContactEmail: Business contact email is not a valid email address. - optInWorkflowImageURLs: Entries must be a valid array of objects. - schema: - $ref: '#/components/schemas/tfvError' - description: Bad Request - tfvUnauthorizedResponse: - content: - application/json: - example: - description: Client is providing incorrect or invalid credentials. - type: unauthorized - schema: - $ref: '#/components/schemas/tfvError' - description: Unauthorized - tfvForbiddenResponse: - content: - application/json: - example: - description: Client is not authorized for the action. - type: forbidden - schema: - $ref: '#/components/schemas/tfvError' - description: Forbidden - tfvNotFoundResponse: - content: - application/json: - example: - description: Cannot find the requested resource. - type: Not Found + examples: + forbidden: + summary: Example Forbidden Error + value: + message: Authorization header requires 'Credential' parameter. Authorization + header requires 'Signature' parameter. Authorization header requires + 'SignedHeaders' parameter. Authorization header requires existence + of either a 'X-Amz-Date' or a 'Date' header. Authorization=Basic + Y2tvZloPTGhHgywYIzGlcGVlcGvvcGovYTIGIt==' schema: - $ref: '#/components/schemas/tfvError' - description: Cannot find the requested resource. - tfvNotAllowedResponse: + $ref: '#/components/schemas/tnLookupRequestError' + description: Forbidden + tnLookupMediaTypeError: content: application/json: - example: - description: Method is not allowed. - type: Method Not Allowed + examples: + mediaType: + summary: Example Unsupported Media Type Error + value: + message: Content-Type must be application/json. schema: - $ref: '#/components/schemas/tfvError' - description: Method Not Allowed - tfvTooManyRequestsResponse: + $ref: '#/components/schemas/tnLookupRequestError' + description: Unsupported Media Type + tnLookupNotFoundError: + description: Not Found + tnLookupTooManyRequestsError: content: application/json: - example: - description: Throttling error. Too many requests. - type: Too Many Requests + examples: + mediaType: + summary: Example Too Many Requests Error + value: + message: Too many requests. schema: - $ref: '#/components/schemas/tfvError' + $ref: '#/components/schemas/tnLookupRequestError' description: Too Many Requests - tfvServerErrorResponse: + tnLookupInternalServerError: content: application/json: - example: - description: Internal Server Error. - type: Internal Server Error + examples: + mediaType: + summary: Example Internal Server Error Error + value: + message: Request has not been passed further. schema: - $ref: '#/components/schemas/tfvError' + $ref: '#/components/schemas/tnLookupRequestError' description: Internal Server Error - tfvServiceUnavailableResponse: - content: - application/json: - example: - description: Service Unavailable Error. - type: Service Unavailable - schema: - $ref: '#/components/schemas/tfvError' - description: Service Unavailable schemas: callbackTypeEnum: description: | @@ -11419,928 +10333,6 @@ components: example: example error message type: string type: object - accountId1: - description: User's account ID. - example: "1234567" - type: string - tfPhoneNumber: - description: Toll-free telephone number in E.164 format. - example: "+18005555555" - maxLength: 12 - minLength: 12 - nullable: false - pattern: "^\\+1(800|833|844|855|866|877|888)[2-9]\\d{6}$" - type: string - tfvWebhookErrors: - description: Details of the errors that were encountered when processing the - request. - items: - example: "optInWorkflowImageURLs: Entries must be a valid array of objects." - type: string - type: array - tfvCallbackStatusEnum: - enum: - - VERIFIED - - UNVERIFIED - example: VERIFIED - type: string - tfvUnverifiedStatus: - default: UNVERIFIED - example: UNVERIFIED - type: string - declineReasonDescription: - description: Explanation for why a verification request was declined. - example: Invalid Information - Can't Validate URL - Website is not accessible - / not available - nullable: false - type: string - denialStatusCode: - description: Reason code for denial. - example: 511 - type: integer - resubmitAllowed: - description: Whether a Toll-Free Verification request qualifies for resubmission - via PUT. - example: true - type: boolean - additionalDenialReason: - properties: - statusCode: - description: Reason code for denial. - example: 511 - type: integer - reason: - description: Explanation for why a verification request was declined. - example: Invalid Information - Can't Validate URL - Website is not accessible - / not available - nullable: false - type: string - resubmitAllowed: - description: Whether a Toll-Free Verification request qualifies for resubmission - via PUT. - example: true - type: boolean - required: - - reason - - resubmitAllowed - - statusCode - type: object - internalTicketNumber: - description: Unique identifier (UUID) generated by Bandwidth to assist in tracking - the verification status of a toll-free number - included in all webhook payloads. - example: acde070d-8c4c-4f0d-9d8a-162843c10333 - format: uuid - type: string - internalTicketNumberForWebhook: - description: Unique identifier (UUID) generated by Bandwidth to assist in tracking - the verification status of a toll-free number. - example: acde070d-8c4c-4f0d-9d8a-162843c10333 - format: uuid - type: string - businessContactPhoneNumber: - description: Contact telephone number - example: "+19192654500" - maxLength: 500 - minLength: 1 - nullable: false - type: string - verificationRequest: - properties: - businessAddress: - $ref: '#/components/schemas/address' - businessContact: - $ref: '#/components/schemas/contact' - messageVolume: - description: Estimated monthly volume of messages from the toll-free number. - example: 10000 - maximum: 10000000 - minimum: 10 - type: integer - phoneNumbers: - items: - $ref: '#/components/schemas/tfPhoneNumber' - maxItems: 10 - minItems: 1 - type: array - useCase: - description: The category of the use case. - example: 2FA - maxLength: 500 - minLength: 0 - type: string - useCaseSummary: - description: A general idea of the use case and customer. - maxLength: 500 - minLength: 1 - nullable: false - type: string - productionMessageContent: - description: Example of message content. - maxLength: 500 - minLength: 1 - nullable: false - type: string - optInWorkflow: - $ref: '#/components/schemas/optInWorkflow' - additionalInformation: - description: Any additional information. - maxLength: 500 - minLength: 0 - nullable: true - type: string - isvReseller: - description: ISV name. - example: Test ISV - maxLength: 500 - minLength: 0 - nullable: true - type: string - required: - - businessAddress - - businessContact - - messageVolume - - optInWorkflow - - phoneNumbers - - productionMessageContent - - useCase - - useCaseSummary - type: object - verificationUpdateRequest: - properties: - businessAddress: - $ref: '#/components/schemas/address' - businessContact: - $ref: '#/components/schemas/contact' - messageVolume: - description: Estimated monthly volume of messages from the toll-free number. - example: 10000 - maximum: 10000000 - minimum: 10 - type: integer - useCase: - description: The category of the use case. - example: 2FA - maxLength: 500 - minLength: 0 - type: string - useCaseSummary: - description: A general idea of the use case and customer. - maxLength: 500 - minLength: 0 - nullable: false - type: string - productionMessageContent: - description: Example of message content. - maxLength: 500 - minLength: 0 - nullable: false - type: string - optInWorkflow: - $ref: '#/components/schemas/optInWorkflow' - additionalInformation: - description: Any additional information. - maxLength: 500 - minLength: 0 - nullable: true - type: string - isvReseller: - description: ISV name. - example: Test ISV - maxLength: 500 - minLength: 0 - nullable: true - type: string - required: - - businessAddress - - businessContact - - messageVolume - - optInWorkflow - - productionMessageContent - - useCase - - useCaseSummary - type: object - tfvBasicAuthentication: - properties: - username: - maxLength: 100 - type: string - password: - maxLength: 200 - type: string - required: - - password - - username - type: object - webhookSubscriptionRequestSchema: - properties: - basicAuthentication: - $ref: '#/components/schemas/tfvBasicAuthentication' - callbackUrl: - description: "Callback URL to receive status updates from Bandwidth. When\ - \ a webhook subscription is registered with Bandwidth under a given account\ - \ ID, it will be used to send status updates for all requests submitted\ - \ under that account ID." - example: https://www.example.com/path/to/resource - format: url - maxLength: 2000 - minLength: 0 - nullable: true - pattern: "^$|(https?:\\/\\/)?(www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{1,253}\\.[a-z]{2,6}\\\ - b([-a-zA-Z0-9@:%_\\+.~#()?&//=]*)" - type: string - sharedSecretKey: - description: An ASCII string submitted by the user as a shared secret key - for generating an HMAC header for callbacks. - example: This is my $3cret - maxLength: 64 - minLength: 16 - nullable: true - pattern: "^[ -~]{16,64}$" - type: string - required: - - callbackUrl - type: object - failureWebhook: - properties: - accountId: - description: User's account ID. - example: "1234567" - type: string - phoneNumber: - description: Toll-free telephone number in E.164 format. - example: "+18005555555" - maxLength: 12 - minLength: 12 - nullable: false - pattern: "^\\+1(800|833|844|855|866|877|888)[2-9]\\d{6}$" - type: string - errorCode: - description: 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. - example: "400" - type: string - errorDescription: - description: A description of the error that was encountered. - example: cannot process request. - type: string - errors: - description: Details of the errors that were encountered when processing - the request. - items: - example: "optInWorkflowImageURLs: Entries must be a valid array of objects." - type: string - type: array - internalTicketNumber: - description: Unique identifier (UUID) generated by Bandwidth to assist in - tracking the verification status of a toll-free number. - example: acde070d-8c4c-4f0d-9d8a-162843c10333 - format: uuid - type: string - type: object - verificationDenialWebhook: - properties: - accountId: - description: User's account ID. - example: "1234567" - type: string - additionalDenialReasons: - description: An optional list of denial reasons in addition to declineReasonDescription - when multiple reasons apply. - example: - - statusCode: 512 - reason: Reason A - resubmitAllowed: true - - statusCode: 513 - reason: Reason B - resubmitAllowed: true - items: - $ref: '#/components/schemas/additionalDenialReason' - type: array - declineReasonDescription: - description: Explanation for why a verification request was declined. - example: Invalid Information - Can't Validate URL - Website is not accessible - / not available - nullable: false - type: string - denialStatusCode: - description: Reason code for denial. - example: 511 - type: integer - internalTicketNumber: - description: Unique identifier (UUID) generated by Bandwidth to assist in - tracking the verification status of a toll-free number. - example: acde070d-8c4c-4f0d-9d8a-162843c10333 - format: uuid - type: string - phoneNumber: - description: Toll-free telephone number in E.164 format. - example: "+18005555555" - maxLength: 12 - minLength: 12 - nullable: false - pattern: "^\\+1(800|833|844|855|866|877|888)[2-9]\\d{6}$" - type: string - resubmitAllowed: - description: Whether a Toll-Free Verification request qualifies for resubmission - via PUT. - example: true - type: boolean - status: - default: UNVERIFIED - example: UNVERIFIED - type: string - type: object - verificationWebhook: - properties: - accountId: - description: User's account ID. - example: "1234567" - type: string - phoneNumber: - description: Toll-free telephone number in E.164 format. - example: "+18005555555" - maxLength: 12 - minLength: 12 - nullable: false - pattern: "^\\+1(800|833|844|855|866|877|888)[2-9]\\d{6}$" - type: string - status: - $ref: '#/components/schemas/tfvCallbackStatusEnum' - internalTicketNumber: - description: Unique identifier (UUID) generated by Bandwidth to assist in - tracking the verification status of a toll-free number. - example: acde070d-8c4c-4f0d-9d8a-162843c10333 - format: uuid - type: string - type: object - tfvSubmissionWrapper: - properties: - submission: - $ref: '#/components/schemas/verificationUpdateRequest' - type: object - address: - example: - zip: "27606" - addr2: addr2 - addr1: 2230 Bandmate Way - city: Raleigh - name: Bandwidth Inc. - state: NC - url: https://www.example.com/path/to/resource - nullable: false - properties: - name: - description: The name of the business using the toll-free number. - example: Bandwidth Inc. - maxLength: 500 - minLength: 1 - nullable: false - type: string - addr1: - description: The address of the business using the toll-free number. - example: 2230 Bandmate Way - maxLength: 500 - minLength: 1 - nullable: false - type: string - addr2: - description: The address of the business using the toll-free number. - maxLength: 500 - minLength: 0 - nullable: true - type: string - city: - description: The city of the business using the toll-free number. - example: Raleigh - maxLength: 500 - minLength: 1 - nullable: false - type: string - state: - description: The state of the business using the toll-free number. - example: NC - maxLength: 500 - minLength: 1 - nullable: false - type: string - zip: - description: The zip of the business using the toll-free number. - example: "27606" - nullable: false - pattern: "[- A-Za-z0-9]{0,500}" - type: string - url: - description: The website of the business using the toll-free number. - example: https://www.example.com/path/to/resource - format: url - maxLength: 500 - minLength: 1 - nullable: false - type: string - required: - - addr1 - - city - - name - - state - - url - - zip - type: object - optInWorkflow: - example: - imageUrls: - - https://www.example.com/path/to/resource - - https://www.example.com/path/to/resource - description: Opt In Flow - nullable: false - properties: - description: - example: Opt In Flow - maxLength: 500 - minLength: 1 - nullable: false - type: string - imageUrls: - items: - example: https://www.example.com/path/to/resource - maxLength: 500 - minLength: 1 - nullable: false - pattern: "^$|(https?:\\/\\/)?(www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{1,253}\\\ - .[a-z]{2,6}\\b([-a-zA-Z0-9@:%_\\+.~#()?&//=]*)" - type: string - type: array - required: - - description - - imageUrls - type: object - isvReseller: - description: ISV name. - example: Test ISV - maxLength: 500 - minLength: 0 - nullable: true - type: string - contact: - example: - firstName: John - lastName: Doe - phoneNumber: "+19192654500" - email: foo@bar.com - nullable: false - properties: - firstName: - description: The first name of the business contact using the toll-free - number. - example: John - maxLength: 500 - minLength: 1 - nullable: false - type: string - lastName: - description: The last name of the business contact using the toll-free number. - example: Doe - maxLength: 500 - minLength: 1 - nullable: false - type: string - email: - example: foo@bar.com - format: email - maxLength: 500 - minLength: 0 - nullable: false - pattern: "^(?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|\"\ - (?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\\\\ - [\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\\ - .)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\\[(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\\\ - .){3}(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9])|[a-z0-9-]*[a-z0-9]:(?:[\\\ - x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]|\\\\[\\x01-\\x09\\\ - x0b\\x0c\\x0e-\\x7f])+)\\])$" - type: string - phoneNumber: - description: Contact telephone number - example: "+19192654500" - maxLength: 500 - minLength: 1 - nullable: false - type: string - required: - - email - - firstName - - lastName - - phoneNumber - type: object - email: - example: foo@bar.com - format: email - maxLength: 500 - minLength: 0 - nullable: false - pattern: "^(?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|\"\ - (?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\\\[\\x01-\\\ - x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\\\ - [(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\\.){3}(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9])|[a-z0-9-]*[a-z0-9]:(?:[\\\ - x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]|\\\\[\\x01-\\x09\\x0b\\\ - x0c\\x0e-\\x7f])+)\\])$" - type: string - useCases: - example: - - 2FA - - App Notifications - - Appointments - - Auctions - - Auto Repair Services - - Bank Transfers - - Billing - - Booking Confirmations - - Business Updates - - COVID-19 Alerts - items: - type: string - type: array - useCase: - description: The category of the use case. - example: 2FA - maxLength: 500 - minLength: 0 - type: string - webhookSubscriptionsListBody: - description: A list of all webhook subscriptions registered for this account - ID for this particular feature (unpaginated). - example: - data: - - accountId: "1234567" - createdDate: 2023-05-15T13:56:39.965Z - modifiedDate: 2023-05-15T13:56:39.965Z - callbackUrl: https://www.example.com/path/to/resource - id: 7hICGStfAfeGxEq3N0lQwO - type: TOLLFREE_VERIFICATION_STATUS - basicAuthentication: - password: password - username: username - - accountId: "1234567" - createdDate: 2023-05-15T13:56:39.965Z - modifiedDate: 2023-05-15T13:56:39.965Z - callbackUrl: https://www.example.com/path/to/resource - id: 7hICGStfAfeGxEq3N0lQwO - type: TOLLFREE_VERIFICATION_STATUS - basicAuthentication: - password: password - username: username - links: - next: next - previous: previous - last: last - first: first - errors: - - code: 0 - telephoneNumbers: - - telephoneNumber: telephoneNumber - - telephoneNumber: telephoneNumber - description: description - - code: 0 - telephoneNumbers: - - telephoneNumber: telephoneNumber - - telephoneNumber: telephoneNumber - description: description - properties: - links: - $ref: '#/components/schemas/linksObject' - errors: - items: - $ref: '#/components/schemas/error' - type: array - data: - items: - $ref: '#/components/schemas/webhookSubscription' - type: array - required: - - data - type: object - linksObject: - example: - next: next - previous: previous - last: last - first: first - properties: - first: - description: The first (or only) page of results matching the query. - type: string - next: - description: "If more results exist than specified by 'size', this link\ - \ returns the next page of 'size' results." - type: string - previous: - description: "If the results are more than one page, this link returns the\ - \ previous page of 'size' results." - type: string - last: - description: "If more results exist than specified by 'size', this link\ - \ return the last page of result." - type: string - type: object - error: - example: - code: 0 - telephoneNumbers: - - telephoneNumber: telephoneNumber - - telephoneNumber: telephoneNumber - description: description - properties: - code: - type: integer - description: - type: string - telephoneNumbers: - items: - $ref: '#/components/schemas/telephoneNumber' - type: array - type: object - telephoneNumber: - example: - telephoneNumber: telephoneNumber - properties: - telephoneNumber: - description: Simple Telephone Number. - type: string - type: object - webhookSubscriptionTypeEnum: - enum: - - TOLLFREE_VERIFICATION_STATUS - - MESSAGING_PORTOUT_APPROVAL_STATUS - example: TOLLFREE_VERIFICATION_STATUS - type: string - webhookSubscription: - description: Information about a webhook that Bandwidth should send upon the - completion of event customer has subscribed to. - example: - accountId: "1234567" - createdDate: 2023-05-15T13:56:39.965Z - modifiedDate: 2023-05-15T13:56:39.965Z - callbackUrl: https://www.example.com/path/to/resource - id: 7hICGStfAfeGxEq3N0lQwO - type: TOLLFREE_VERIFICATION_STATUS - basicAuthentication: - password: password - username: username - properties: - id: - example: 7hICGStfAfeGxEq3N0lQwO - type: string - accountId: - example: "1234567" - type: string - callbackUrl: - description: "Callback URL to receive status updates from Bandwidth. When\ - \ a webhook subscription is registered with Bandwidth under a given account\ - \ ID, it will be used to send status updates for all requests submitted\ - \ under that account ID." - example: https://www.example.com/path/to/resource - format: url - maxLength: 2000 - minLength: 0 - nullable: true - pattern: "^$|(https?:\\/\\/)?(www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{1,253}\\.[a-z]{2,6}\\\ - b([-a-zA-Z0-9@:%_\\+.~#()?&//=]*)" - type: string - type: - $ref: '#/components/schemas/webhookSubscriptionTypeEnum' - basicAuthentication: - $ref: '#/components/schemas/webhookSubscription_basicAuthentication' - createdDate: - example: 2023-05-15T13:56:39.965Z - format: date-time - type: string - modifiedDate: - example: 2023-05-15T13:56:39.965Z - format: date-time - type: string - required: - - callbackUrl - type: object - webhookUrl: - description: "Callback URL to receive status updates from Bandwidth. When a\ - \ webhook subscription is registered with Bandwidth under a given account\ - \ ID, it will be used to send status updates for all requests submitted under\ - \ that account ID." - example: https://www.example.com/path/to/resource - format: url - maxLength: 2000 - minLength: 0 - nullable: true - pattern: "^$|(https?:\\/\\/)?(www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{1,253}\\.[a-z]{2,6}\\\ - b([-a-zA-Z0-9@:%_\\+.~#()?&//=]*)" - type: string - tfvError: - description: A generic error object. - example: - description: Error Message - type: Error Type - errors: - field: error message - properties: - type: - example: Error Type - type: string - description: - example: Error Message - type: string - errors: - description: "Each key of this errors object refers to a field of the submitted\ - \ object (using dot notation for nested objects), with the field being\ - \ a key to an array of one or more errors for that field." - example: - field: error message - type: object - type: object - tfvStatus: - example: - internalTicketNumber: acde070d-8c4c-4f0d-9d8a-162843c10333 - phoneNumber: "+18005555555" - resubmitAllowed: true - createdDateTime: 2021-06-08T06:45:13Z - modifiedDateTime: 2021-06-08T06:45:13Z - submission: - additionalInformation: Any additional information - useCase: 2FA - isvReseller: Test ISV - businessContact: - firstName: John - lastName: Doe - phoneNumber: "+19192654500" - email: foo@bar.com - messageVolume: 10000 - productionMessageContent: Production message content - businessAddress: - zip: "27606" - addr2: addr2 - addr1: 2230 Bandmate Way - city: Raleigh - name: Bandwidth Inc. - state: NC - url: https://www.example.com/path/to/resource - 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 - properties: - phoneNumber: - description: Toll-free telephone number in E.164 format. - example: "+18005555555" - maxLength: 12 - minLength: 12 - nullable: false - pattern: "^\\+1(800|833|844|855|866|877|888)[2-9]\\d{6}$" - type: string - status: - $ref: '#/components/schemas/tfvStatusEnum' - internalTicketNumber: - description: Unique identifier (UUID) generated by Bandwidth to assist in - tracking the verification status of a toll-free number - included in all - webhook payloads. - example: acde070d-8c4c-4f0d-9d8a-162843c10333 - format: uuid - type: string - declineReasonDescription: - description: Explanation for why a verification request was declined. - example: Invalid Information - Can't Validate URL - Website is not accessible - / not available - nullable: false - type: string - resubmitAllowed: - description: Whether a Toll-Free Verification request qualifies for resubmission - via PUT. - example: true - type: boolean - createdDateTime: - description: Date and time the verification request was created. - example: 2021-06-08T06:45:13Z - format: date-time - type: string - modifiedDateTime: - description: Date and time the verification request was last modified. - example: 2021-06-08T06:45:13Z - format: date-time - type: string - submission: - $ref: '#/components/schemas/tfvSubmissionInfo' - type: object - tfvSubmissionInfo: - example: - additionalInformation: Any additional information - useCase: 2FA - isvReseller: Test ISV - businessContact: - firstName: John - lastName: Doe - phoneNumber: "+19192654500" - email: foo@bar.com - messageVolume: 10000 - productionMessageContent: Production message content - businessAddress: - zip: "27606" - addr2: addr2 - addr1: 2230 Bandmate Way - city: Raleigh - name: Bandwidth Inc. - state: NC - url: https://www.example.com/path/to/resource - 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' - businessContact: - $ref: '#/components/schemas/contact' - messageVolume: - description: Estimated monthly volume of messages from the toll-free number. - example: 10000 - maximum: 10000000 - minimum: 10 - type: integer - useCase: - description: The category of the use case. - example: 2FA - maxLength: 500 - minLength: 0 - type: string - useCaseSummary: - description: A general idea of the use case and customer. - example: Text summarizing the use case for the toll-free number - maxLength: 500 - minLength: 0 - nullable: false - type: string - productionMessageContent: - description: Example of message content. - example: Production message content - maxLength: 500 - minLength: 0 - nullable: false - type: string - optInWorkflow: - $ref: '#/components/schemas/optInWorkflow' - additionalInformation: - description: Any additional information. - example: Any additional information - maxLength: 500 - minLength: 0 - nullable: true - type: string - isvReseller: - description: ISV name. - example: Test ISV - maxLength: 500 - minLength: 0 - nullable: true - type: string - type: object - tfvStatusEnum: - enum: - - VERIFIED - - UNVERIFIED - - PENDING - - PARTIALLY_VERIFIED - - INVALID_STATUS - example: VERIFIED - type: string - sharedSecretKey: - description: An ASCII string submitted by the user as a shared secret key for - generating an HMAC header for callbacks. - example: This is my $3cret - maxLength: 64 - minLength: 16 - nullable: true - pattern: "^[ -~]{16,64}$" - type: string - webhookSubscription_basicAuthentication: - description: "Basic authentication credentials are not required, but if present,\ - \ both username and password must be provided." - example: - password: password - username: username - properties: - username: - maxLength: 100 - type: string - password: - maxLength: 200 - type: string - required: - - password - - username - type: object securitySchemes: Basic: description: |- diff --git a/bandwidth.yml b/bandwidth.yml index 70ca20d3..87921dfa 100644 --- a/bandwidth.yml +++ b/bandwidth.yml @@ -19,7 +19,6 @@ tags: - name: Transcriptions - name: MFA - name: Phone Number Lookup - - name: Toll-Free Verification paths: /users/{accountId}/media: get: @@ -1329,270 +1328,6 @@ paths: '500': $ref: '#/components/responses/tnLookupInternalServerError' servers: *ref_3 - /accounts/{accountId}/tollFreeVerification: - post: - tags: - - Toll-Free Verification - summary: Request Toll-Free Verification - description: Submit a request for verification of a toll-free phone number. - operationId: requestTollFreeVerification - parameters: - - $ref: '#/components/parameters/accountId' - requestBody: - $ref: '#/components/requestBodies/requestTollFreeVerificationRequest' - responses: - '202': - description: Accepted - '400': - $ref: '#/components/responses/tfvPostBadRequestResponse' - '401': - $ref: '#/components/responses/tfvUnauthorizedResponse' - '403': - $ref: '#/components/responses/tfvForbiddenResponse' - '405': - $ref: '#/components/responses/tfvNotAllowedResponse' - '429': - $ref: '#/components/responses/tfvTooManyRequestsResponse' - '500': - $ref: '#/components/responses/tfvServerErrorResponse' - '503': - $ref: '#/components/responses/tfvServiceUnavailableResponse' - callbacks: - tfVerificationStatus: - $ref: '#/components/callbacks/tfVerificationStatus' - servers: &ref_4 - - url: https://api.bandwidth.com/api/v2 - description: Production - /accounts/{accountId}/phoneNumbers/{phoneNumber}/tollFreeVerification: - get: - tags: - - Toll-Free Verification - summary: Get Toll-Free Verification Status - description: >- - Gets the verification status for a phone number that is provisioned to - your account. - - Submission information will be appended to the response if it is - available. - operationId: getTollFreeVerificationStatus - parameters: - - $ref: '#/components/parameters/accountId' - - $ref: '#/components/parameters/tfPhoneNumberPathParam' - responses: - '200': - $ref: '#/components/responses/getTollFreeVerificationStatusResponse' - '400': - $ref: '#/components/responses/tfvBadRequestResponse' - '401': - $ref: '#/components/responses/tfvUnauthorizedResponse' - '403': - $ref: '#/components/responses/tfvForbiddenResponse' - '404': - $ref: '#/components/responses/tfvNotFoundResponse' - '405': - $ref: '#/components/responses/tfvNotAllowedResponse' - '429': - $ref: '#/components/responses/tfvTooManyRequestsResponse' - '500': - $ref: '#/components/responses/tfvServerErrorResponse' - '503': - $ref: '#/components/responses/tfvServiceUnavailableResponse' - put: - tags: - - Toll-Free Verification - summary: Update Toll-Free Verification Request - description: >- - Updates a toll-free verification request. - - Submissions are only eligible for resubmission for 7 days within being - processed and if resubmission is allowed (resubmitAllowed field is - true). - operationId: updateTollFreeVerificationRequest - parameters: - - $ref: '#/components/parameters/accountId' - - $ref: '#/components/parameters/tfPhoneNumberPathParam' - requestBody: - $ref: '#/components/requestBodies/updateTollFreeVerificationRequestRequest' - responses: - '202': - description: Accepted - '400': - $ref: '#/components/responses/tfvPostBadRequestResponse' - '401': - $ref: '#/components/responses/tfvUnauthorizedResponse' - '403': - $ref: '#/components/responses/tfvForbiddenResponse' - '405': - $ref: '#/components/responses/tfvNotAllowedResponse' - '429': - $ref: '#/components/responses/tfvTooManyRequestsResponse' - '500': - $ref: '#/components/responses/tfvServerErrorResponse' - '503': - $ref: '#/components/responses/tfvServiceUnavailableResponse' - callbacks: - tfVerificationStatus: - $ref: '#/components/callbacks/tfVerificationStatus' - servers: *ref_4 - /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions: - get: - tags: - - Toll-Free Verification - summary: List Webhook Subscriptions - description: >- - Lists all webhook subscriptions that are registered to receive status - updates for the toll-free verification requests submitted under this - account (password will not be returned through this API - - If `basicAuthentication` is defined, the `password` property of that - object will be null). - operationId: listWebhookSubscriptions - parameters: - - $ref: '#/components/parameters/accountId' - responses: - '200': - $ref: '#/components/responses/listWebhookSubscriptionsResponse' - '400': - $ref: '#/components/responses/tfvPostBadRequestResponse' - '401': - $ref: '#/components/responses/tfvUnauthorizedResponse' - '403': - $ref: '#/components/responses/tfvForbiddenResponse' - '405': - $ref: '#/components/responses/tfvNotAllowedResponse' - '429': - $ref: '#/components/responses/tfvTooManyRequestsResponse' - '500': - $ref: '#/components/responses/tfvServerErrorResponse' - '503': - $ref: '#/components/responses/tfvServiceUnavailableResponse' - post: - tags: - - Toll-Free Verification - summary: Create Webhook Subscription - description: >- - Create a new webhook subscription (this webhook will be called for every - update on every submission). - - In addition to a `callbackUrl`, this subscription can provide optional - HTTP basic authentication credentials (a username and a password). - - The returned subscription object will contain an ID that can be used to - modify or delete the subscription at a later time. - operationId: createWebhookSubscription - parameters: - - $ref: '#/components/parameters/accountId' - requestBody: - $ref: '#/components/requestBodies/webhookSubscriptionRequest' - responses: - '201': - $ref: '#/components/responses/createWebhookSubscriptionResponse' - '400': - $ref: '#/components/responses/tfvBadRequestResponse' - '401': - $ref: '#/components/responses/tfvUnauthorizedResponse' - '403': - $ref: '#/components/responses/tfvForbiddenResponse' - '404': - $ref: '#/components/responses/tfvNotFoundResponse' - '405': - $ref: '#/components/responses/tfvNotAllowedResponse' - '429': - $ref: '#/components/responses/tfvTooManyRequestsResponse' - '500': - $ref: '#/components/responses/tfvServerErrorResponse' - '503': - $ref: '#/components/responses/tfvServiceUnavailableResponse' - servers: *ref_4 - /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions/{id}: - delete: - tags: - - Toll-Free Verification - summary: Delete Webhook Subscription - description: Delete a webhook subscription by ID. - operationId: deleteWebhookSubscription - parameters: - - $ref: '#/components/parameters/accountId' - - $ref: '#/components/parameters/webhookSubscriptionIdPathParam' - responses: - '204': - description: No Content - '400': - $ref: '#/components/responses/tfvBadRequestResponse' - '401': - $ref: '#/components/responses/tfvUnauthorizedResponse' - '403': - $ref: '#/components/responses/tfvForbiddenResponse' - '404': - $ref: '#/components/responses/tfvNotFoundResponse' - '405': - $ref: '#/components/responses/tfvNotAllowedResponse' - '429': - $ref: '#/components/responses/tfvTooManyRequestsResponse' - '500': - $ref: '#/components/responses/tfvServerErrorResponse' - '503': - $ref: '#/components/responses/tfvServiceUnavailableResponse' - put: - tags: - - Toll-Free Verification - summary: Update Webhook Subscription - description: >- - Update an existing webhook subscription (`callbackUrl` and - `basicAuthentication` can be updated). - operationId: updateWebhookSubscription - parameters: - - $ref: '#/components/parameters/accountId' - - $ref: '#/components/parameters/webhookSubscriptionIdPathParam' - requestBody: - $ref: '#/components/requestBodies/webhookSubscriptionRequest' - responses: - '200': - $ref: '#/components/responses/updateWebhookSubscriptionResponse' - '400': - $ref: '#/components/responses/tfvBadRequestResponse' - '401': - $ref: '#/components/responses/tfvUnauthorizedResponse' - '403': - $ref: '#/components/responses/tfvForbiddenResponse' - '404': - $ref: '#/components/responses/tfvNotFoundResponse' - '405': - $ref: '#/components/responses/tfvNotAllowedResponse' - '429': - $ref: '#/components/responses/tfvTooManyRequestsResponse' - '500': - $ref: '#/components/responses/tfvServerErrorResponse' - '503': - $ref: '#/components/responses/tfvServiceUnavailableResponse' - servers: *ref_4 - /tollFreeVerification/useCases: - get: - tags: - - Toll-Free Verification - summary: List Toll-Free Use Cases - description: Lists valid toll-free use cases. - operationId: listTollFreeUseCases - responses: - '200': - $ref: '#/components/responses/listTollFreeUseCasesResponse' - '400': - $ref: '#/components/responses/tfvBadRequestResponse' - '401': - $ref: '#/components/responses/tfvUnauthorizedResponse' - '403': - $ref: '#/components/responses/tfvForbiddenResponse' - '404': - $ref: '#/components/responses/tfvNotFoundResponse' - '405': - $ref: '#/components/responses/tfvNotAllowedResponse' - '429': - $ref: '#/components/responses/tfvTooManyRequestsResponse' - '500': - $ref: '#/components/responses/tfvServerErrorResponse' - '503': - $ref: '#/components/responses/tfvServiceUnavailableResponse' - servers: *ref_4 components: schemas: callbackTypeEnum: @@ -4675,640 +4410,6 @@ components: type: string description: A description of what validation error occurred. example: example error message - accountId1: - type: string - description: User's account ID. - example: '1234567' - tfPhoneNumber: - type: string - description: Toll-free telephone number in E.164 format. - minLength: 12 - maxLength: 12 - nullable: false - pattern: ^\+1(800|833|844|855|866|877|888)[2-9]\d{6}$ - example: '+18005555555' - tfvWebhookErrors: - type: array - description: Details of the errors that were encountered when processing the request. - items: - type: string - example: 'optInWorkflowImageURLs: Entries must be a valid array of objects.' - tfvCallbackStatusEnum: - type: string - enum: - - VERIFIED - - UNVERIFIED - example: VERIFIED - tfvUnverifiedStatus: - type: string - default: UNVERIFIED - example: UNVERIFIED - declineReasonDescription: - type: string - description: Explanation for why a verification request was declined. - nullable: false - example: >- - Invalid Information - Can't Validate URL - Website is not accessible / - not available - denialStatusCode: - description: Reason code for denial. - type: integer - example: 511 - resubmitAllowed: - description: >- - Whether a Toll-Free Verification request qualifies for resubmission via - PUT. - example: true - type: boolean - additionalDenialReason: - properties: - statusCode: - $ref: '#/components/schemas/denialStatusCode' - reason: - $ref: '#/components/schemas/declineReasonDescription' - resubmitAllowed: - $ref: '#/components/schemas/resubmitAllowed' - required: - - statusCode - - reason - - resubmitAllowed - type: object - internalTicketNumber: - type: string - format: uuid - description: >- - Unique identifier (UUID) generated by Bandwidth to assist in tracking - the verification status of a toll-free number - included in all webhook - payloads. - example: acde070d-8c4c-4f0d-9d8a-162843c10333 - internalTicketNumberForWebhook: - type: string - format: uuid - description: >- - Unique identifier (UUID) generated by Bandwidth to assist in tracking - the verification status of a toll-free number. - example: acde070d-8c4c-4f0d-9d8a-162843c10333 - businessContactPhoneNumber: - description: Contact telephone number - type: string - minLength: 1 - maxLength: 500 - nullable: false - example: '+19192654500' - verificationRequest: - type: object - required: - - businessAddress - - businessContact - - messageVolume - - phoneNumbers - - useCase - - useCaseSummary - - productionMessageContent - - optInWorkflow - properties: - businessAddress: - $ref: '#/components/schemas/address' - businessContact: - $ref: '#/components/schemas/contact' - messageVolume: - type: integer - description: Estimated monthly volume of messages from the toll-free number. - minimum: 10 - maximum: 10000000 - example: 10000 - phoneNumbers: - type: array - minItems: 1 - maxItems: 10 - items: - $ref: '#/components/schemas/tfPhoneNumber' - useCase: - $ref: '#/components/schemas/useCase' - useCaseSummary: - type: string - description: A general idea of the use case and customer. - minLength: 1 - maxLength: 500 - nullable: false - productionMessageContent: - type: string - description: Example of message content. - minLength: 1 - maxLength: 500 - nullable: false - optInWorkflow: - $ref: '#/components/schemas/optInWorkflow' - additionalInformation: - type: string - description: Any additional information. - minLength: 0 - maxLength: 500 - nullable: true - isvReseller: - $ref: '#/components/schemas/isvReseller' - verificationUpdateRequest: - type: object - required: - - businessAddress - - businessContact - - messageVolume - - useCase - - useCaseSummary - - productionMessageContent - - optInWorkflow - properties: - businessAddress: - $ref: '#/components/schemas/address' - businessContact: - $ref: '#/components/schemas/contact' - messageVolume: - type: integer - description: Estimated monthly volume of messages from the toll-free number. - minimum: 10 - maximum: 10000000 - example: 10000 - useCase: - $ref: '#/components/schemas/useCase' - useCaseSummary: - type: string - description: A general idea of the use case and customer. - minLength: 0 - maxLength: 500 - nullable: false - productionMessageContent: - type: string - description: Example of message content. - minLength: 0 - maxLength: 500 - nullable: false - optInWorkflow: - $ref: '#/components/schemas/optInWorkflow' - additionalInformation: - type: string - description: Any additional information. - minLength: 0 - maxLength: 500 - nullable: true - isvReseller: - $ref: '#/components/schemas/isvReseller' - tfvBasicAuthentication: - type: object - properties: - username: - type: string - maxLength: 100 - password: - type: string - maxLength: 200 - required: - - username - - password - webhookSubscriptionRequestSchema: - type: object - properties: - basicAuthentication: - $ref: '#/components/schemas/tfvBasicAuthentication' - callbackUrl: - $ref: '#/components/schemas/webhookUrl' - sharedSecretKey: - $ref: '#/components/schemas/sharedSecretKey' - required: - - callbackUrl - failureWebhook: - type: object - properties: - accountId: - $ref: '#/components/schemas/accountId1' - phoneNumber: - $ref: '#/components/schemas/tfPhoneNumber' - errorCode: - type: string - description: >- - 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. - example: '400' - errorDescription: - type: string - description: A description of the error that was encountered. - example: cannot process request. - errors: - $ref: '#/components/schemas/tfvWebhookErrors' - internalTicketNumber: - $ref: '#/components/schemas/internalTicketNumberForWebhook' - verificationDenialWebhook: - type: object - properties: - accountId: - $ref: '#/components/schemas/accountId1' - additionalDenialReasons: - description: >- - An optional list of denial reasons in addition to - declineReasonDescription when multiple reasons apply. - items: - $ref: '#/components/schemas/additionalDenialReason' - example: - - statusCode: 512 - reason: Reason A - resubmitAllowed: true - - statusCode: 513 - reason: Reason B - resubmitAllowed: true - type: array - declineReasonDescription: - $ref: '#/components/schemas/declineReasonDescription' - denialStatusCode: - $ref: '#/components/schemas/denialStatusCode' - internalTicketNumber: - $ref: '#/components/schemas/internalTicketNumberForWebhook' - phoneNumber: - $ref: '#/components/schemas/tfPhoneNumber' - resubmitAllowed: - $ref: '#/components/schemas/resubmitAllowed' - status: - $ref: '#/components/schemas/tfvUnverifiedStatus' - verificationWebhook: - type: object - properties: - accountId: - $ref: '#/components/schemas/accountId1' - phoneNumber: - $ref: '#/components/schemas/tfPhoneNumber' - status: - $ref: '#/components/schemas/tfvCallbackStatusEnum' - internalTicketNumber: - $ref: '#/components/schemas/internalTicketNumberForWebhook' - tfvSubmissionWrapper: - type: object - properties: - submission: - $ref: '#/components/schemas/verificationUpdateRequest' - address: - type: object - nullable: false - required: - - name - - addr1 - - city - - state - - zip - - url - properties: - name: - type: string - description: The name of the business using the toll-free number. - minLength: 1 - maxLength: 500 - nullable: false - example: Bandwidth Inc. - addr1: - type: string - description: The address of the business using the toll-free number. - minLength: 1 - maxLength: 500 - nullable: false - example: 2230 Bandmate Way - addr2: - type: string - description: The address of the business using the toll-free number. - minLength: 0 - maxLength: 500 - nullable: true - city: - type: string - description: The city of the business using the toll-free number. - minLength: 1 - maxLength: 500 - nullable: false - example: Raleigh - state: - type: string - description: The state of the business using the toll-free number. - minLength: 1 - maxLength: 500 - nullable: false - example: NC - zip: - type: string - description: The zip of the business using the toll-free number. - nullable: false - example: '27606' - pattern: '[- A-Za-z0-9]{0,500}' - url: - type: string - format: url - description: The website of the business using the toll-free number. - minLength: 1 - maxLength: 500 - nullable: false - example: https://www.example.com/path/to/resource - optInWorkflow: - type: object - nullable: false - required: - - description - - imageUrls - properties: - description: - type: string - minLength: 1 - maxLength: 500 - nullable: false - example: Opt In Flow - imageUrls: - type: array - items: - type: string - minLength: 1 - maxLength: 500 - nullable: false - example: https://www.example.com/path/to/resource - pattern: >- - ^$|(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,253}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#()?&//=]*) - isvReseller: - type: string - description: ISV name. - minLength: 0 - maxLength: 500 - nullable: true - example: Test ISV - contact: - type: object - nullable: false - required: - - firstName - - lastName - - email - - phoneNumber - properties: - firstName: - type: string - description: The first name of the business contact using the toll-free number. - minLength: 1 - maxLength: 500 - nullable: false - example: John - lastName: - type: string - description: The last name of the business contact using the toll-free number. - minLength: 1 - maxLength: 500 - nullable: false - example: Doe - email: - $ref: '#/components/schemas/email' - phoneNumber: - $ref: '#/components/schemas/businessContactPhoneNumber' - email: - type: string - format: email - minLength: 0 - maxLength: 500 - nullable: false - pattern: >- - ^(?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9])|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])$ - example: foo@bar.com - useCases: - type: array - items: - type: string - example: - - 2FA - - App Notifications - - Appointments - - Auctions - - Auto Repair Services - - Bank Transfers - - Billing - - Booking Confirmations - - Business Updates - - COVID-19 Alerts - useCase: - type: string - description: The category of the use case. - minLength: 0 - maxLength: 500 - example: 2FA - webhookSubscriptionsListBody: - description: >- - A list of all webhook subscriptions registered for this account ID for - this particular feature (unpaginated). - type: object - required: - - data - properties: - links: - $ref: '#/components/schemas/linksObject' - errors: - type: array - items: - $ref: '#/components/schemas/error' - data: - items: - $ref: '#/components/schemas/webhookSubscription' - type: array - linksObject: - type: object - properties: - first: - description: The first (or only) page of results matching the query. - type: string - next: - description: >- - If more results exist than specified by 'size', this link returns - the next page of 'size' results. - type: string - previous: - description: >- - If the results are more than one page, this link returns the - previous page of 'size' results. - type: string - last: - description: >- - If more results exist than specified by 'size', this link return the - last page of result. - type: string - error: - type: object - properties: - code: - type: integer - description: - type: string - telephoneNumbers: - type: array - items: - $ref: '#/components/schemas/telephoneNumber' - telephoneNumber: - type: object - properties: - telephoneNumber: - description: Simple Telephone Number. - type: string - webhookSubscriptionTypeEnum: - type: string - enum: - - TOLLFREE_VERIFICATION_STATUS - - MESSAGING_PORTOUT_APPROVAL_STATUS - example: TOLLFREE_VERIFICATION_STATUS - webhookSubscription: - description: >- - Information about a webhook that Bandwidth should send upon the - completion of event customer has subscribed to. - type: object - required: - - callbackUrl - properties: - id: - type: string - example: 7hICGStfAfeGxEq3N0lQwO - accountId: - type: string - example: '1234567' - callbackUrl: - $ref: '#/components/schemas/webhookUrl' - type: - $ref: '#/components/schemas/webhookSubscriptionTypeEnum' - basicAuthentication: - description: >- - Basic authentication credentials are not required, but if present, - both username and password must be provided. - type: object - required: - - username - - password - properties: - username: - type: string - maxLength: 100 - password: - type: string - maxLength: 200 - createdDate: - type: string - format: date-time - example: '2023-05-15T13:56:39.965Z' - modifiedDate: - type: string - format: date-time - example: '2023-05-15T13:56:39.965Z' - webhookUrl: - description: >- - Callback URL to receive status updates from Bandwidth. When a webhook - subscription is registered with Bandwidth under a given account ID, it - will be used to send status updates for all requests submitted under - that account ID. - type: string - format: url - minLength: 0 - maxLength: 2000 - nullable: true - example: https://www.example.com/path/to/resource - pattern: >- - ^$|(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,253}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#()?&//=]*) - tfvError: - description: A generic error object. - properties: - type: - type: string - example: Error Type - description: - type: string - example: Error Message - errors: - type: object - description: >- - Each key of this errors object refers to a field of the submitted - object (using dot notation for nested objects), with the field being - a key to an array of one or more errors for that field. - example: - field: error message - type: object - tfvStatus: - type: object - properties: - phoneNumber: - $ref: '#/components/schemas/tfPhoneNumber' - status: - $ref: '#/components/schemas/tfvStatusEnum' - internalTicketNumber: - $ref: '#/components/schemas/internalTicketNumber' - declineReasonDescription: - $ref: '#/components/schemas/declineReasonDescription' - resubmitAllowed: - $ref: '#/components/schemas/resubmitAllowed' - createdDateTime: - type: string - description: Date and time the verification request was created. - format: date-time - example: '2021-06-08T06:45:13.0Z' - modifiedDateTime: - type: string - description: Date and time the verification request was last modified. - format: date-time - example: '2021-06-08T06:45:13.0Z' - submission: - $ref: '#/components/schemas/tfvSubmissionInfo' - tfvSubmissionInfo: - type: object - properties: - businessAddress: - $ref: '#/components/schemas/address' - businessContact: - $ref: '#/components/schemas/contact' - messageVolume: - type: integer - description: Estimated monthly volume of messages from the toll-free number. - minimum: 10 - maximum: 10000000 - example: 10000 - useCase: - $ref: '#/components/schemas/useCase' - useCaseSummary: - type: string - description: A general idea of the use case and customer. - minLength: 0 - maxLength: 500 - nullable: false - example: Text summarizing the use case for the toll-free number - productionMessageContent: - type: string - description: Example of message content. - minLength: 0 - maxLength: 500 - nullable: false - example: Production message content - optInWorkflow: - $ref: '#/components/schemas/optInWorkflow' - additionalInformation: - type: string - description: Any additional information. - minLength: 0 - maxLength: 500 - nullable: true - example: Any additional information - isvReseller: - $ref: '#/components/schemas/isvReseller' - tfvStatusEnum: - type: string - enum: - - VERIFIED - - UNVERIFIED - - PENDING - - PARTIALLY_VERIFIED - - INVALID_STATUS - example: VERIFIED - sharedSecretKey: - description: >- - An ASCII string submitted by the user as a shared secret key for - generating an HMAC header for callbacks. - example: This is my $3cret - maxLength: 64 - minLength: 16 - nullable: true - pattern: ^[ -~]{16,64}$ - type: string responses: createMessageResponse: description: Accepted @@ -5759,120 +4860,6 @@ components: summary: Example Internal Server Error Error value: message: Request has not been passed further. - getTollFreeVerificationStatusResponse: - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/tfvStatus' - listWebhookSubscriptionsResponse: - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/webhookSubscriptionsListBody' - createWebhookSubscriptionResponse: - description: Created - content: - application/json: - schema: - $ref: '#/components/schemas/webhookSubscription' - updateWebhookSubscriptionResponse: - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/webhookSubscription' - listTollFreeUseCasesResponse: - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/useCases' - tfvBadRequestResponse: - description: Bad Request - content: - application/json: - schema: - $ref: '#/components/schemas/tfvError' - example: - description: Cannot process request. - type: bad request - tfvPostBadRequestResponse: - description: Bad Request - content: - application/json: - schema: - $ref: '#/components/schemas/tfvError' - example: - description: cannot process request. - errors: - businessName: Business name is required. - businessContactEmail: Business contact email is not a valid email address. - optInWorkflowImageURLs: Entries must be a valid array of objects. - tfvUnauthorizedResponse: - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/tfvError' - example: - description: Client is providing incorrect or invalid credentials. - type: unauthorized - tfvForbiddenResponse: - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/tfvError' - example: - description: Client is not authorized for the action. - type: forbidden - tfvNotFoundResponse: - description: Cannot find the requested resource. - content: - application/json: - schema: - $ref: '#/components/schemas/tfvError' - example: - description: Cannot find the requested resource. - type: Not Found - tfvNotAllowedResponse: - description: Method Not Allowed - content: - application/json: - schema: - $ref: '#/components/schemas/tfvError' - example: - description: Method is not allowed. - type: Method Not Allowed - tfvTooManyRequestsResponse: - description: Too Many Requests - content: - application/json: - schema: - $ref: '#/components/schemas/tfvError' - example: - description: Throttling error. Too many requests. - type: Too Many Requests - tfvServerErrorResponse: - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/tfvError' - example: - description: Internal Server Error. - type: Internal Server Error - tfvServiceUnavailableResponse: - description: Service Unavailable - content: - application/json: - schema: - $ref: '#/components/schemas/tfvError' - example: - description: Service Unavailable Error. - type: Service Unavailable parameters: accountId: in: path @@ -6240,22 +5227,6 @@ components: type: string description: The phone number lookup request ID from Bandwidth. example: 004223a0-8b17-41b1-bf81-20732adf5590 - tfPhoneNumberPathParam: - in: path - name: phoneNumber - required: true - schema: - $ref: '#/components/schemas/tfPhoneNumber' - description: Valid Toll-Free telephone number in E.164 format. - example: '+18885555555' - webhookSubscriptionIdPathParam: - in: path - name: id - required: true - schema: - type: string - description: Webhook subscription ID - example: 7bt57JcsVYJrN9K1OcV1Nu examples: smsMessageReceivedCallbackExample: summary: An example of a sms message-received callback body. @@ -6872,39 +5843,6 @@ components: $ref: '#/components/examples/singleNumberRequestExample' multipleNumberRequestExample: $ref: '#/components/examples/multipleNumberRequestExample' - requestTollFreeVerificationRequest: - description: Request for verification of a toll-free phone number. - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/verificationRequest' - updateTollFreeVerificationRequestRequest: - description: Update a request for verification of a toll-free phone number. - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/tfvSubmissionWrapper' - verificationWebhookRequest: - description: Verification callback status of a toll-free phone number. - required: true - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/verificationWebhook' - - $ref: '#/components/schemas/verificationDenialWebhook' - - $ref: '#/components/schemas/failureWebhook' - webhookSubscriptionRequest: - description: >- - Information about a webhook that Bandwidth should send upon the - completion of event customer is trying to subscribe to. - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/webhookSubscriptionRequestSchema' securitySchemes: Basic: type: http @@ -6975,43 +5913,3 @@ components: responses: '200': description: OK - tfVerificationStatus: - your_url.com/webhookService: - post: - summary: TFV status updates sent to customer's webhook URL. - description: >- - Unique webhook URL provided by customers to which Bandwidth sends a - POST request to notify customer regarding TFV status updates. - operationId: tfvRequest - parameters: - - description: >- - 64-character lowercase hexidecimal HMAC calculated with a shared - secret key, the canonicalized request body, and SHA256. It is - only included when a shared secret key is set through webhook - subscription. - example: ca7b9e9816c90d336f5dca529e733354b81535c7af027b81878ac98afb2dbaa2 - in: header - name: x-bandwidth-signature-hmac-sha256 - schema: - type: string - requestBody: - $ref: '#/components/requestBodies/verificationWebhookRequest' - responses: - '204': - description: No Content - '400': - $ref: '#/components/responses/tfvBadRequestResponse' - '401': - $ref: '#/components/responses/tfvUnauthorizedResponse' - '403': - $ref: '#/components/responses/tfvForbiddenResponse' - '404': - $ref: '#/components/responses/tfvNotFoundResponse' - '405': - $ref: '#/components/responses/tfvNotAllowedResponse' - '429': - $ref: '#/components/responses/tfvTooManyRequestsResponse' - '500': - $ref: '#/components/responses/tfvServerErrorResponse' - '503': - $ref: '#/components/responses/tfvServiceUnavailableResponse' diff --git a/src/main/java/com/bandwidth/sdk/JSON.java b/src/main/java/com/bandwidth/sdk/JSON.java index e34980af..b5958659 100644 --- a/src/main/java/com/bandwidth/sdk/JSON.java +++ b/src/main/java/com/bandwidth/sdk/JSON.java @@ -94,8 +94,6 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri gsonBuilder.registerTypeAdapter(LocalDate.class, localDateTypeAdapter); gsonBuilder.registerTypeAdapter(byte[].class, byteArrayAdapter); gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.AccountStatistics.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.AdditionalDenialReason.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.Address.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.AnswerCallback.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.BridgeCompleteCallback.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.BridgeTargetCompleteCallback.CustomTypeAdapterFactory()); @@ -114,7 +112,6 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.ConferenceRecordingAvailableCallback.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.ConferenceRecordingMetadata.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.ConferenceRedirectCallback.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.Contact.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.CreateCall.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.CreateCallResponse.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.CreateLookupResponse.CustomTypeAdapterFactory()); @@ -123,12 +120,9 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.DisconnectCallback.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.Diversion.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.DtmfCallback.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.Error.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.FailureWebhook.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.FieldError.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.GatherCallback.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.InitiateCallback.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.LinksObject.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.ListMessageItem.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.LookupRequest.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.LookupResult.CustomTypeAdapterFactory()); @@ -147,7 +141,6 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.MfaForbiddenRequestError.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.MfaRequestError.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.MfaUnauthorizedRequestError.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.OptInWorkflow.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.PageInfo.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.RecordingAvailableCallback.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.RecordingCompleteCallback.CustomTypeAdapterFactory()); @@ -156,12 +149,6 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.RedirectCallback.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.StirShaken.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.Tag.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.TelephoneNumber.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.TfvBasicAuthentication.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.TfvError.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.TfvStatus.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.TfvSubmissionInfo.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.TfvSubmissionWrapper.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.TnLookupRequestError.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.TranscribeRecording.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.Transcription.CustomTypeAdapterFactory()); @@ -173,18 +160,10 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.UpdateCallRecording.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.UpdateConference.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.UpdateConferenceMember.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.VerificationDenialWebhook.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.VerificationRequest.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.VerificationUpdateRequest.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.VerificationWebhook.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.VerifyCodeRequest.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.VerifyCodeResponse.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.VoiceApiError.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.VoiceCodeResponse.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.WebhookSubscription.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.WebhookSubscriptionBasicAuthentication.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.WebhookSubscriptionRequestSchema.CustomTypeAdapterFactory()); - gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.WebhookSubscriptionsListBody.CustomTypeAdapterFactory()); gson = gsonBuilder.create(); }