diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 7f39912..08e4428 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -41,10 +41,10 @@ jobs: fi - name: Checkout - uses: actions/checkout@v4 + uses: actions/checkout@v5 - name: Setup Node - uses: actions/setup-node@v4 + uses: actions/setup-node@v6 with: node-version: 22 registry-url: "https://registry.npmjs.org" diff --git a/.github/workflows/test-pr.yml b/.github/workflows/test-pr.yml index c924b58..3318829 100644 --- a/.github/workflows/test-pr.yml +++ b/.github/workflows/test-pr.yml @@ -36,10 +36,10 @@ jobs: fail-fast: false steps: - name: Checkout - uses: actions/checkout@v4 + uses: actions/checkout@v5 - name: Setup Node - uses: actions/setup-node@v4 + uses: actions/setup-node@v6 with: node-version: ${{ matrix.node-version }} diff --git a/.github/workflows/test-smoke.yml b/.github/workflows/test-smoke.yml index fc70654..d09ff6a 100644 --- a/.github/workflows/test-smoke.yml +++ b/.github/workflows/test-smoke.yml @@ -35,10 +35,10 @@ jobs: MANTECA_APPLICATION_ID: ${{ secrets.MANTECA_APPLICATION_ID }} steps: - name: Checkout - uses: actions/checkout@v4 + uses: actions/checkout@v5 - name: Setup Node - uses: actions/setup-node@v4 + uses: actions/setup-node@v6 with: node-version: 22 @@ -62,10 +62,10 @@ jobs: MANTECA_APPLICATION_ID: ${{ secrets.MANTECA_UP_APPLICATION_ID }} steps: - name: Checkout - uses: actions/checkout@v4 + uses: actions/checkout@v5 - name: Setup Node - uses: actions/setup-node@v4 + uses: actions/setup-node@v6 with: node-version: 22 diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 924dc65..f51b865 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -19,6 +19,7 @@ docs/AccountStatistics.md docs/AdditionalDenialReason.md docs/Address.md docs/AnswerCallback.md +docs/AsyncLookupRequest.md docs/BlockedWebhook.md docs/BridgeCompleteCallback.md docs/BridgeTargetCompleteCallback.md @@ -38,6 +39,7 @@ docs/CallbackMethodEnum.md docs/CallsApi.md docs/CardWidthEnum.md docs/CodeRequest.md +docs/CompletedLookupStatusEnum.md docs/Conference.md docs/ConferenceCompletedCallback.md docs/ConferenceCreatedCallback.md @@ -50,11 +52,15 @@ docs/ConferenceRedirectCallback.md docs/ConferenceStateEnum.md docs/ConferencesApi.md docs/Contact.md +docs/CreateAsyncBulkLookupResponse.md +docs/CreateAsyncBulkLookupResponseData.md docs/CreateCall.md docs/CreateCallResponse.md -docs/CreateLookupResponse.md docs/CreateMessageRequestError.md docs/CreateMultiChannelMessageResponse.md +docs/CreateSyncLookupResponse.md +docs/CreateSyncLookupResponseData.md +docs/DeactivationEventEnum.md docs/DisconnectCallback.md docs/Diversion.md docs/DtmfCallback.md @@ -65,18 +71,24 @@ docs/FailureWebhook.md docs/FieldError.md docs/FileFormatEnum.md docs/GatherCallback.md +docs/GetAsyncBulkLookupResponse.md +docs/GetAsyncBulkLookupResponseData.md +docs/InProgressLookupStatusEnum.md docs/InboundCallback.md docs/InboundCallbackMessage.md docs/InboundCallbackTypeEnum.md docs/InitiateCallback.md +docs/LatestMessageDeliveryStatusEnum.md +docs/LineTypeEnum.md docs/Link.md +docs/LinkSchema.md docs/LinksObject.md docs/ListMessageDirectionEnum.md docs/ListMessageItem.md -docs/LookupRequest.md +docs/LookupErrorResponse.md +docs/LookupErrorSchema.md +docs/LookupErrorSchemaMeta.md docs/LookupResult.md -docs/LookupStatus.md -docs/LookupStatusEnum.md docs/MFAApi.md docs/MachineDetectionCompleteCallback.md docs/MachineDetectionConfiguration.md @@ -145,6 +157,7 @@ docs/StatusCallback.md docs/StatusCallbackMessage.md docs/StatusCallbackTypeEnum.md docs/StirShaken.md +docs/SyncLookupRequest.md docs/TelephoneNumber.md docs/TfvBasicAuthentication.md docs/TfvCallbackStatusEnum.md @@ -154,7 +167,6 @@ docs/TfvStatusEnum.md docs/TfvSubmissionInfo.md docs/TfvSubmissionWrapper.md docs/ThumbnailAlignmentEnum.md -docs/TnLookupRequestError.md docs/TollFreeVerificationApi.md docs/TranscribeRecording.md docs/Transcription.md @@ -186,6 +198,7 @@ models/account-statistics.ts models/additional-denial-reason.ts models/address.ts models/answer-callback.ts +models/async-lookup-request.ts models/blocked-webhook.ts models/bridge-complete-callback.ts models/bridge-target-complete-callback.ts @@ -204,6 +217,7 @@ models/callback-method-enum.ts models/callback.ts models/card-width-enum.ts models/code-request.ts +models/completed-lookup-status-enum.ts models/conference-completed-callback.ts models/conference-created-callback.ts models/conference-member-exit-callback.ts @@ -215,11 +229,15 @@ models/conference-redirect-callback.ts models/conference-state-enum.ts models/conference.ts models/contact.ts +models/create-async-bulk-lookup-response-data.ts +models/create-async-bulk-lookup-response.ts models/create-call-response.ts models/create-call.ts -models/create-lookup-response.ts models/create-message-request-error.ts models/create-multi-channel-message-response.ts +models/create-sync-lookup-response-data.ts +models/create-sync-lookup-response.ts +models/deactivation-event-enum.ts models/disconnect-callback.ts models/diversion.ts models/dtmf-callback.ts @@ -229,19 +247,25 @@ models/failure-webhook.ts models/field-error.ts models/file-format-enum.ts models/gather-callback.ts +models/get-async-bulk-lookup-response-data.ts +models/get-async-bulk-lookup-response.ts +models/in-progress-lookup-status-enum.ts models/inbound-callback-message.ts models/inbound-callback-type-enum.ts models/inbound-callback.ts models/index.ts models/initiate-callback.ts +models/latest-message-delivery-status-enum.ts +models/line-type-enum.ts +models/link-schema.ts models/link.ts models/links-object.ts models/list-message-direction-enum.ts models/list-message-item.ts -models/lookup-request.ts +models/lookup-error-response.ts +models/lookup-error-schema-meta.ts +models/lookup-error-schema.ts models/lookup-result.ts -models/lookup-status-enum.ts -models/lookup-status.ts models/machine-detection-complete-callback.ts models/machine-detection-configuration.ts models/machine-detection-mode-enum.ts @@ -304,6 +328,7 @@ models/status-callback-message.ts models/status-callback-type-enum.ts models/status-callback.ts models/stir-shaken.ts +models/sync-lookup-request.ts models/telephone-number.ts models/tfv-basic-authentication.ts models/tfv-callback-status-enum.ts @@ -313,7 +338,6 @@ models/tfv-status.ts models/tfv-submission-info.ts models/tfv-submission-wrapper.ts models/thumbnail-alignment-enum.ts -models/tn-lookup-request-error.ts models/transcribe-recording.ts models/transcription-available-callback.ts models/transcription.ts diff --git a/.openapi-generator/VERSION b/.openapi-generator/VERSION index eb1dc6a..6328c54 100644 --- a/.openapi-generator/VERSION +++ b/.openapi-generator/VERSION @@ -1 +1 @@ -7.13.0 +7.17.0 diff --git a/README.md b/README.md index d8a2505..e145029 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,10 @@ | **OS** | **Node** | |:------------:|:----------:| -| Windows 2019 | 18, 20, 22 | -| Windows 2022 | 18, 20, 22 | -| Ubuntu 22.04 | 18, 20, 22 | -| Ubuntu 24.04 | 18, 20, 22 | +| Windows 2022 | 18, 20, 22, 24 | +| Windows 2025 | 18, 20, 22, 24 | +| Ubuntu 22.04 | 18, 20, 22, 24 | +| Ubuntu 24.04 | 18, 20, 22, 24 | #### Available on NPM ``` @@ -46,7 +46,7 @@ Module system * CommonJS * ES6 module system -It can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via `package.json`. ([Reference](http://www.typescriptlang.org/docs/handbook/typings-for-npm-packages.html)) +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) ### Building @@ -58,7 +58,7 @@ npm run build ### Publishing -First build the package then run ```npm publish``` +First build the package then run `npm publish` ### Consuming @@ -99,3 +99,242 @@ await callsApi.createCall(BW_ACCOUNT_ID, body); ``` More samples can be found in the [Bandwidth Samples](https://github.com/orgs/Bandwidth-Samples/repositories?q=lang%3Ajavascript&type=all) GitHub Organization. + +### Documentation for API Endpoints + +All URIs are relative to *http://localhost* + +Class | Method | HTTP request | Description +------------ | ------------- | ------------- | ------------- +*CallsApi* | [**createCall**](docs/CallsApi.md#createcall) | **POST** /accounts/{accountId}/calls | Create Call +*CallsApi* | [**getCallState**](docs/CallsApi.md#getcallstate) | **GET** /accounts/{accountId}/calls/{callId} | Get Call State Information +*CallsApi* | [**listCalls**](docs/CallsApi.md#listcalls) | **GET** /accounts/{accountId}/calls | Get Calls +*CallsApi* | [**updateCall**](docs/CallsApi.md#updatecall) | **POST** /accounts/{accountId}/calls/{callId} | Update Call +*CallsApi* | [**updateCallBxml**](docs/CallsApi.md#updatecallbxml) | **PUT** /accounts/{accountId}/calls/{callId}/bxml | Update Call BXML +*ConferencesApi* | [**downloadConferenceRecording**](docs/ConferencesApi.md#downloadconferencerecording) | **GET** /accounts/{accountId}/conferences/{conferenceId}/recordings/{recordingId}/media | Download Conference Recording +*ConferencesApi* | [**getConference**](docs/ConferencesApi.md#getconference) | **GET** /accounts/{accountId}/conferences/{conferenceId} | Get Conference Information +*ConferencesApi* | [**getConferenceMember**](docs/ConferencesApi.md#getconferencemember) | **GET** /accounts/{accountId}/conferences/{conferenceId}/members/{memberId} | Get Conference Member +*ConferencesApi* | [**getConferenceRecording**](docs/ConferencesApi.md#getconferencerecording) | **GET** /accounts/{accountId}/conferences/{conferenceId}/recordings/{recordingId} | Get Conference Recording Information +*ConferencesApi* | [**listConferenceRecordings**](docs/ConferencesApi.md#listconferencerecordings) | **GET** /accounts/{accountId}/conferences/{conferenceId}/recordings | Get Conference Recordings +*ConferencesApi* | [**listConferences**](docs/ConferencesApi.md#listconferences) | **GET** /accounts/{accountId}/conferences | Get Conferences +*ConferencesApi* | [**updateConference**](docs/ConferencesApi.md#updateconference) | **POST** /accounts/{accountId}/conferences/{conferenceId} | Update Conference +*ConferencesApi* | [**updateConferenceBxml**](docs/ConferencesApi.md#updateconferencebxml) | **PUT** /accounts/{accountId}/conferences/{conferenceId}/bxml | Update Conference BXML +*ConferencesApi* | [**updateConferenceMember**](docs/ConferencesApi.md#updateconferencemember) | **PUT** /accounts/{accountId}/conferences/{conferenceId}/members/{memberId} | Update Conference Member +*MFAApi* | [**generateMessagingCode**](docs/MFAApi.md#generatemessagingcode) | **POST** /accounts/{accountId}/code/messaging | Messaging Authentication Code +*MFAApi* | [**generateVoiceCode**](docs/MFAApi.md#generatevoicecode) | **POST** /accounts/{accountId}/code/voice | Voice Authentication Code +*MFAApi* | [**verifyCode**](docs/MFAApi.md#verifycode) | **POST** /accounts/{accountId}/code/verify | Verify Authentication Code +*MediaApi* | [**deleteMedia**](docs/MediaApi.md#deletemedia) | **DELETE** /users/{accountId}/media/{mediaId} | Delete Media +*MediaApi* | [**getMedia**](docs/MediaApi.md#getmedia) | **GET** /users/{accountId}/media/{mediaId} | Get Media +*MediaApi* | [**listMedia**](docs/MediaApi.md#listmedia) | **GET** /users/{accountId}/media | List Media +*MediaApi* | [**uploadMedia**](docs/MediaApi.md#uploadmedia) | **PUT** /users/{accountId}/media/{mediaId} | Upload Media +*MessagesApi* | [**createMessage**](docs/MessagesApi.md#createmessage) | **POST** /users/{accountId}/messages | Create Message +*MessagesApi* | [**listMessages**](docs/MessagesApi.md#listmessages) | **GET** /users/{accountId}/messages | List Messages +*MultiChannelApi* | [**createMultiChannelMessage**](docs/MultiChannelApi.md#createmultichannelmessage) | **POST** /users/{accountId}/messages/multiChannel | Create Multi-Channel Message +*PhoneNumberLookupApi* | [**createAsyncBulkLookup**](docs/PhoneNumberLookupApi.md#createasyncbulklookup) | **POST** /accounts/{accountId}/phoneNumberLookup/bulk | Create Asynchronous Bulk Number Lookup +*PhoneNumberLookupApi* | [**createSyncLookup**](docs/PhoneNumberLookupApi.md#createsynclookup) | **POST** /accounts/{accountId}/phoneNumberLookup | Create Synchronous Number Lookup +*PhoneNumberLookupApi* | [**getAsyncBulkLookup**](docs/PhoneNumberLookupApi.md#getasyncbulklookup) | **GET** /accounts/{accountId}/phoneNumberLookup/bulk/{requestId} | Get Asynchronous Bulk Number Lookup +*RecordingsApi* | [**deleteRecording**](docs/RecordingsApi.md#deleterecording) | **DELETE** /accounts/{accountId}/calls/{callId}/recordings/{recordingId} | Delete Recording +*RecordingsApi* | [**deleteRecordingMedia**](docs/RecordingsApi.md#deleterecordingmedia) | **DELETE** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/media | Delete Recording Media +*RecordingsApi* | [**deleteRecordingTranscription**](docs/RecordingsApi.md#deleterecordingtranscription) | **DELETE** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription | Delete Transcription +*RecordingsApi* | [**downloadCallRecording**](docs/RecordingsApi.md#downloadcallrecording) | **GET** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/media | Download Recording +*RecordingsApi* | [**getCallRecording**](docs/RecordingsApi.md#getcallrecording) | **GET** /accounts/{accountId}/calls/{callId}/recordings/{recordingId} | Get Call Recording +*RecordingsApi* | [**getRecordingTranscription**](docs/RecordingsApi.md#getrecordingtranscription) | **GET** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription | Get Transcription +*RecordingsApi* | [**listAccountCallRecordings**](docs/RecordingsApi.md#listaccountcallrecordings) | **GET** /accounts/{accountId}/recordings | Get Call Recordings +*RecordingsApi* | [**listCallRecordings**](docs/RecordingsApi.md#listcallrecordings) | **GET** /accounts/{accountId}/calls/{callId}/recordings | List Call Recordings +*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* | [**deleteVerificationRequest**](docs/TollFreeVerificationApi.md#deleteverificationrequest) | **DELETE** /accounts/{accountId}/phoneNumbers/{phoneNumber}/tollFreeVerification | Delete a Toll-Free Verification Submission +*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 Real-time Transcription +*TranscriptionsApi* | [**getRealTimeTranscription**](docs/TranscriptionsApi.md#getrealtimetranscription) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Get Real-time Transcription +*TranscriptionsApi* | [**listRealTimeTranscriptions**](docs/TranscriptionsApi.md#listrealtimetranscriptions) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions | List Real-time Transcriptions + + +### Documentation For Models + + - [AccountStatistics](docs/AccountStatistics.md) + - [AdditionalDenialReason](docs/AdditionalDenialReason.md) + - [Address](docs/Address.md) + - [AnswerCallback](docs/AnswerCallback.md) + - [AsyncLookupRequest](docs/AsyncLookupRequest.md) + - [BlockedWebhook](docs/BlockedWebhook.md) + - [BridgeCompleteCallback](docs/BridgeCompleteCallback.md) + - [BridgeTargetCompleteCallback](docs/BridgeTargetCompleteCallback.md) + - [BusinessEntityTypeEnum](docs/BusinessEntityTypeEnum.md) + - [BusinessRegistrationTypeEnum](docs/BusinessRegistrationTypeEnum.md) + - [CallDirectionEnum](docs/CallDirectionEnum.md) + - [CallRecordingMetadata](docs/CallRecordingMetadata.md) + - [CallState](docs/CallState.md) + - [CallStateEnum](docs/CallStateEnum.md) + - [CallTranscription](docs/CallTranscription.md) + - [CallTranscriptionDetectedLanguageEnum](docs/CallTranscriptionDetectedLanguageEnum.md) + - [CallTranscriptionMetadata](docs/CallTranscriptionMetadata.md) + - [CallTranscriptionResponse](docs/CallTranscriptionResponse.md) + - [CallTranscriptionTrackEnum](docs/CallTranscriptionTrackEnum.md) + - [Callback](docs/Callback.md) + - [CallbackMethodEnum](docs/CallbackMethodEnum.md) + - [CardWidthEnum](docs/CardWidthEnum.md) + - [CodeRequest](docs/CodeRequest.md) + - [CompletedLookupStatusEnum](docs/CompletedLookupStatusEnum.md) + - [Conference](docs/Conference.md) + - [ConferenceCompletedCallback](docs/ConferenceCompletedCallback.md) + - [ConferenceCreatedCallback](docs/ConferenceCreatedCallback.md) + - [ConferenceMember](docs/ConferenceMember.md) + - [ConferenceMemberExitCallback](docs/ConferenceMemberExitCallback.md) + - [ConferenceMemberJoinCallback](docs/ConferenceMemberJoinCallback.md) + - [ConferenceRecordingAvailableCallback](docs/ConferenceRecordingAvailableCallback.md) + - [ConferenceRecordingMetadata](docs/ConferenceRecordingMetadata.md) + - [ConferenceRedirectCallback](docs/ConferenceRedirectCallback.md) + - [ConferenceStateEnum](docs/ConferenceStateEnum.md) + - [Contact](docs/Contact.md) + - [CreateAsyncBulkLookupResponse](docs/CreateAsyncBulkLookupResponse.md) + - [CreateAsyncBulkLookupResponseData](docs/CreateAsyncBulkLookupResponseData.md) + - [CreateCall](docs/CreateCall.md) + - [CreateCallResponse](docs/CreateCallResponse.md) + - [CreateMessageRequestError](docs/CreateMessageRequestError.md) + - [CreateMultiChannelMessageResponse](docs/CreateMultiChannelMessageResponse.md) + - [CreateSyncLookupResponse](docs/CreateSyncLookupResponse.md) + - [CreateSyncLookupResponseData](docs/CreateSyncLookupResponseData.md) + - [DeactivationEventEnum](docs/DeactivationEventEnum.md) + - [DisconnectCallback](docs/DisconnectCallback.md) + - [Diversion](docs/Diversion.md) + - [DtmfCallback](docs/DtmfCallback.md) + - [ErrorObject](docs/ErrorObject.md) + - [ErrorSource](docs/ErrorSource.md) + - [FailureWebhook](docs/FailureWebhook.md) + - [FieldError](docs/FieldError.md) + - [FileFormatEnum](docs/FileFormatEnum.md) + - [GatherCallback](docs/GatherCallback.md) + - [GetAsyncBulkLookupResponse](docs/GetAsyncBulkLookupResponse.md) + - [GetAsyncBulkLookupResponseData](docs/GetAsyncBulkLookupResponseData.md) + - [InProgressLookupStatusEnum](docs/InProgressLookupStatusEnum.md) + - [InboundCallback](docs/InboundCallback.md) + - [InboundCallbackMessage](docs/InboundCallbackMessage.md) + - [InboundCallbackTypeEnum](docs/InboundCallbackTypeEnum.md) + - [InitiateCallback](docs/InitiateCallback.md) + - [LatestMessageDeliveryStatusEnum](docs/LatestMessageDeliveryStatusEnum.md) + - [LineTypeEnum](docs/LineTypeEnum.md) + - [Link](docs/Link.md) + - [LinkSchema](docs/LinkSchema.md) + - [LinksObject](docs/LinksObject.md) + - [ListMessageDirectionEnum](docs/ListMessageDirectionEnum.md) + - [ListMessageItem](docs/ListMessageItem.md) + - [LookupErrorResponse](docs/LookupErrorResponse.md) + - [LookupErrorSchema](docs/LookupErrorSchema.md) + - [LookupErrorSchemaMeta](docs/LookupErrorSchemaMeta.md) + - [LookupResult](docs/LookupResult.md) + - [MachineDetectionCompleteCallback](docs/MachineDetectionCompleteCallback.md) + - [MachineDetectionConfiguration](docs/MachineDetectionConfiguration.md) + - [MachineDetectionModeEnum](docs/MachineDetectionModeEnum.md) + - [MachineDetectionResult](docs/MachineDetectionResult.md) + - [Media](docs/Media.md) + - [Message](docs/Message.md) + - [MessageDirectionEnum](docs/MessageDirectionEnum.md) + - [MessageRequest](docs/MessageRequest.md) + - [MessageStatusEnum](docs/MessageStatusEnum.md) + - [MessageTypeEnum](docs/MessageTypeEnum.md) + - [MessagesList](docs/MessagesList.md) + - [MessagingCodeResponse](docs/MessagingCodeResponse.md) + - [MessagingRequestError](docs/MessagingRequestError.md) + - [MfaForbiddenRequestError](docs/MfaForbiddenRequestError.md) + - [MfaRequestError](docs/MfaRequestError.md) + - [MfaUnauthorizedRequestError](docs/MfaUnauthorizedRequestError.md) + - [MmsMessageContent](docs/MmsMessageContent.md) + - [MmsMessageContentFile](docs/MmsMessageContentFile.md) + - [ModelError](docs/ModelError.md) + - [MultiChannelAction](docs/MultiChannelAction.md) + - [MultiChannelActionCalendarEvent](docs/MultiChannelActionCalendarEvent.md) + - [MultiChannelChannelListObject](docs/MultiChannelChannelListObject.md) + - [MultiChannelChannelListObjectContent](docs/MultiChannelChannelListObjectContent.md) + - [MultiChannelError](docs/MultiChannelError.md) + - [MultiChannelMessageChannelEnum](docs/MultiChannelMessageChannelEnum.md) + - [MultiChannelMessageContent](docs/MultiChannelMessageContent.md) + - [MultiChannelMessageRequest](docs/MultiChannelMessageRequest.md) + - [MultiChannelMessageResponseData](docs/MultiChannelMessageResponseData.md) + - [MultiChannelMessageResponseDataChannelListInner](docs/MultiChannelMessageResponseDataChannelListInner.md) + - [OptInWorkflow](docs/OptInWorkflow.md) + - [PageInfo](docs/PageInfo.md) + - [PriorityEnum](docs/PriorityEnum.md) + - [ProductTypeEnum](docs/ProductTypeEnum.md) + - [RbmActionBase](docs/RbmActionBase.md) + - [RbmActionDial](docs/RbmActionDial.md) + - [RbmActionOpenUrl](docs/RbmActionOpenUrl.md) + - [RbmActionTypeEnum](docs/RbmActionTypeEnum.md) + - [RbmActionViewLocation](docs/RbmActionViewLocation.md) + - [RbmCardContent](docs/RbmCardContent.md) + - [RbmCardContentMedia](docs/RbmCardContentMedia.md) + - [RbmLocationResponse](docs/RbmLocationResponse.md) + - [RbmMediaHeightEnum](docs/RbmMediaHeightEnum.md) + - [RbmMessageCarouselCard](docs/RbmMessageCarouselCard.md) + - [RbmMessageContentFile](docs/RbmMessageContentFile.md) + - [RbmMessageContentRichCard](docs/RbmMessageContentRichCard.md) + - [RbmMessageContentText](docs/RbmMessageContentText.md) + - [RbmMessageMedia](docs/RbmMessageMedia.md) + - [RbmStandaloneCard](docs/RbmStandaloneCard.md) + - [RbmSuggestionResponse](docs/RbmSuggestionResponse.md) + - [RecordingAvailableCallback](docs/RecordingAvailableCallback.md) + - [RecordingCompleteCallback](docs/RecordingCompleteCallback.md) + - [RecordingStateEnum](docs/RecordingStateEnum.md) + - [RecordingTranscriptionMetadata](docs/RecordingTranscriptionMetadata.md) + - [RecordingTranscriptions](docs/RecordingTranscriptions.md) + - [RedirectCallback](docs/RedirectCallback.md) + - [RedirectMethodEnum](docs/RedirectMethodEnum.md) + - [SmsMessageContent](docs/SmsMessageContent.md) + - [StandaloneCardOrientationEnum](docs/StandaloneCardOrientationEnum.md) + - [StatusCallback](docs/StatusCallback.md) + - [StatusCallbackMessage](docs/StatusCallbackMessage.md) + - [StatusCallbackTypeEnum](docs/StatusCallbackTypeEnum.md) + - [StirShaken](docs/StirShaken.md) + - [SyncLookupRequest](docs/SyncLookupRequest.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) + - [ThumbnailAlignmentEnum](docs/ThumbnailAlignmentEnum.md) + - [TranscribeRecording](docs/TranscribeRecording.md) + - [Transcription](docs/Transcription.md) + - [TranscriptionAvailableCallback](docs/TranscriptionAvailableCallback.md) + - [TransferAnswerCallback](docs/TransferAnswerCallback.md) + - [TransferCompleteCallback](docs/TransferCompleteCallback.md) + - [TransferDisconnectCallback](docs/TransferDisconnectCallback.md) + - [UpdateCall](docs/UpdateCall.md) + - [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) + + + +## Documentation For Authorization + + +Authentication schemes defined for the API: + +### Basic + +- **Type**: HTTP basic authentication + diff --git a/api/calls-api.ts b/api/calls-api.ts index ea6fd81..2d30644 100644 --- a/api/calls-api.ts +++ b/api/calls-api.ts @@ -33,7 +33,6 @@ import type { UpdateCall } from '../models'; import type { VoiceApiError } from '../models'; /** * CallsApi - axios parameter creator - * @export */ export const CallsApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -297,7 +296,6 @@ export const CallsApiAxiosParamCreator = function (configuration?: Configuration /** * CallsApi - functional programming interface - * @export */ export const CallsApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = CallsApiAxiosParamCreator(configuration) @@ -385,7 +383,6 @@ export const CallsApiFp = function(configuration?: Configuration) { /** * CallsApi - factory interface - * @export */ export const CallsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = CallsApiFp(configuration) @@ -458,9 +455,6 @@ export const CallsApiFactory = function (configuration?: Configuration, basePath /** * CallsApi - object-oriented interface - * @export - * @class CallsApi - * @extends {BaseAPI} */ export class CallsApi extends BaseAPI { /** @@ -470,7 +464,6 @@ export class CallsApi extends BaseAPI { * @param {CreateCall} createCall JSON object containing information to create an outbound call * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof CallsApi */ public createCall(accountId: string, createCall: CreateCall, options?: RawAxiosRequestConfig) { return CallsApiFp(this.configuration).createCall(accountId, createCall, options).then((request) => request(this.axios, this.basePath)); @@ -483,7 +476,6 @@ export class CallsApi extends BaseAPI { * @param {string} callId Programmable Voice API Call ID. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof CallsApi */ public getCallState(accountId: string, callId: string, options?: RawAxiosRequestConfig) { return CallsApiFp(this.configuration).getCallState(accountId, callId, options).then((request) => request(this.axios, this.basePath)); @@ -502,7 +494,6 @@ export class CallsApi extends BaseAPI { * @param {string} [pageToken] Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof CallsApi */ public listCalls(accountId: string, to?: string, from?: string, minStartTime?: string, maxStartTime?: string, disconnectCause?: string, pageSize?: number, pageToken?: string, options?: RawAxiosRequestConfig) { return CallsApiFp(this.configuration).listCalls(accountId, to, from, minStartTime, maxStartTime, disconnectCause, pageSize, pageToken, options).then((request) => request(this.axios, this.basePath)); @@ -516,7 +507,6 @@ export class CallsApi extends BaseAPI { * @param {UpdateCall} updateCall JSON object containing information to redirect an existing call to a new BXML document * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof CallsApi */ public updateCall(accountId: string, callId: string, updateCall: UpdateCall, options?: RawAxiosRequestConfig) { return CallsApiFp(this.configuration).updateCall(accountId, callId, updateCall, options).then((request) => request(this.axios, this.basePath)); @@ -530,7 +520,6 @@ export class CallsApi extends BaseAPI { * @param {string} body * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof CallsApi */ public updateCallBxml(accountId: string, callId: string, body: string, options?: RawAxiosRequestConfig) { return CallsApiFp(this.configuration).updateCallBxml(accountId, callId, body, options).then((request) => request(this.axios, this.basePath)); diff --git a/api/conferences-api.ts b/api/conferences-api.ts index 40de231..7bceb85 100644 --- a/api/conferences-api.ts +++ b/api/conferences-api.ts @@ -35,7 +35,6 @@ import type { UpdateConferenceMember } from '../models'; import type { VoiceApiError } from '../models'; /** * ConferencesApi - axios parameter creator - * @export */ export const ConferencesApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -477,7 +476,6 @@ export const ConferencesApiAxiosParamCreator = function (configuration?: Configu /** * ConferencesApi - functional programming interface - * @export */ export const ConferencesApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = ConferencesApiAxiosParamCreator(configuration) @@ -624,7 +622,6 @@ export const ConferencesApiFp = function(configuration?: Configuration) { /** * ConferencesApi - factory interface - * @export */ export const ConferencesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = ConferencesApiFp(configuration) @@ -744,9 +741,6 @@ export const ConferencesApiFactory = function (configuration?: Configuration, ba /** * ConferencesApi - object-oriented interface - * @export - * @class ConferencesApi - * @extends {BaseAPI} */ export class ConferencesApi extends BaseAPI { /** @@ -757,7 +751,6 @@ export class ConferencesApi extends BaseAPI { * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ConferencesApi */ public downloadConferenceRecording(accountId: string, conferenceId: string, recordingId: string, options?: RawAxiosRequestConfig) { return ConferencesApiFp(this.configuration).downloadConferenceRecording(accountId, conferenceId, recordingId, options).then((request) => request(this.axios, this.basePath)); @@ -770,7 +763,6 @@ export class ConferencesApi extends BaseAPI { * @param {string} conferenceId Programmable Voice API Conference ID. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ConferencesApi */ public getConference(accountId: string, conferenceId: string, options?: RawAxiosRequestConfig) { return ConferencesApiFp(this.configuration).getConference(accountId, conferenceId, options).then((request) => request(this.axios, this.basePath)); @@ -784,7 +776,6 @@ export class ConferencesApi extends BaseAPI { * @param {string} memberId Programmable Voice API Conference Member ID. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ConferencesApi */ public getConferenceMember(accountId: string, conferenceId: string, memberId: string, options?: RawAxiosRequestConfig) { return ConferencesApiFp(this.configuration).getConferenceMember(accountId, conferenceId, memberId, options).then((request) => request(this.axios, this.basePath)); @@ -798,7 +789,6 @@ export class ConferencesApi extends BaseAPI { * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ConferencesApi */ public getConferenceRecording(accountId: string, conferenceId: string, recordingId: string, options?: RawAxiosRequestConfig) { return ConferencesApiFp(this.configuration).getConferenceRecording(accountId, conferenceId, recordingId, options).then((request) => request(this.axios, this.basePath)); @@ -811,7 +801,6 @@ export class ConferencesApi extends BaseAPI { * @param {string} conferenceId Programmable Voice API Conference ID. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ConferencesApi */ public listConferenceRecordings(accountId: string, conferenceId: string, options?: RawAxiosRequestConfig) { return ConferencesApiFp(this.configuration).listConferenceRecordings(accountId, conferenceId, options).then((request) => request(this.axios, this.basePath)); @@ -828,7 +817,6 @@ export class ConferencesApi extends BaseAPI { * @param {string} [pageToken] Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ConferencesApi */ public listConferences(accountId: string, name?: string, minCreatedTime?: string, maxCreatedTime?: string, pageSize?: number, pageToken?: string, options?: RawAxiosRequestConfig) { return ConferencesApiFp(this.configuration).listConferences(accountId, name, minCreatedTime, maxCreatedTime, pageSize, pageToken, options).then((request) => request(this.axios, this.basePath)); @@ -842,7 +830,6 @@ export class ConferencesApi extends BaseAPI { * @param {UpdateConference} updateConference * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ConferencesApi */ public updateConference(accountId: string, conferenceId: string, updateConference: UpdateConference, options?: RawAxiosRequestConfig) { return ConferencesApiFp(this.configuration).updateConference(accountId, conferenceId, updateConference, options).then((request) => request(this.axios, this.basePath)); @@ -856,7 +843,6 @@ export class ConferencesApi extends BaseAPI { * @param {string} body * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ConferencesApi */ public updateConferenceBxml(accountId: string, conferenceId: string, body: string, options?: RawAxiosRequestConfig) { return ConferencesApiFp(this.configuration).updateConferenceBxml(accountId, conferenceId, body, options).then((request) => request(this.axios, this.basePath)); @@ -871,7 +857,6 @@ export class ConferencesApi extends BaseAPI { * @param {UpdateConferenceMember} updateConferenceMember * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ConferencesApi */ public updateConferenceMember(accountId: string, conferenceId: string, memberId: string, updateConferenceMember: UpdateConferenceMember, options?: RawAxiosRequestConfig) { return ConferencesApiFp(this.configuration).updateConferenceMember(accountId, conferenceId, memberId, updateConferenceMember, options).then((request) => request(this.axios, this.basePath)); diff --git a/api/media-api.ts b/api/media-api.ts index d1a0cff..be90feb 100644 --- a/api/media-api.ts +++ b/api/media-api.ts @@ -27,7 +27,6 @@ import type { Media } from '../models'; import type { MessagingRequestError } from '../models'; /** * MediaApi - axios parameter creator - * @export */ export const MediaApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -218,7 +217,6 @@ export const MediaApiAxiosParamCreator = function (configuration?: Configuration /** * MediaApi - functional programming interface - * @export */ export const MediaApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = MediaApiAxiosParamCreator(configuration) @@ -287,7 +285,6 @@ export const MediaApiFp = function(configuration?: Configuration) { /** * MediaApi - factory interface - * @export */ export const MediaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = MediaApiFp(configuration) @@ -344,9 +341,6 @@ export const MediaApiFactory = function (configuration?: Configuration, basePath /** * MediaApi - object-oriented interface - * @export - * @class MediaApi - * @extends {BaseAPI} */ export class MediaApi extends BaseAPI { /** @@ -356,7 +350,6 @@ export class MediaApi extends BaseAPI { * @param {string} mediaId Media ID to retrieve. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof MediaApi */ public deleteMedia(accountId: string, mediaId: string, options?: RawAxiosRequestConfig) { return MediaApiFp(this.configuration).deleteMedia(accountId, mediaId, options).then((request) => request(this.axios, this.basePath)); @@ -369,7 +362,6 @@ export class MediaApi extends BaseAPI { * @param {string} mediaId Media ID to retrieve. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof MediaApi */ public getMedia(accountId: string, mediaId: string, options?: RawAxiosRequestConfig) { return MediaApiFp(this.configuration).getMedia(accountId, mediaId, options).then((request) => request(this.axios, this.basePath)); @@ -382,7 +374,6 @@ export class MediaApi extends BaseAPI { * @param {string} [continuationToken] Continuation token used to retrieve subsequent media. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof MediaApi */ public listMedia(accountId: string, continuationToken?: string, options?: RawAxiosRequestConfig) { return MediaApiFp(this.configuration).listMedia(accountId, continuationToken, options).then((request) => request(this.axios, this.basePath)); @@ -398,7 +389,6 @@ export class MediaApi extends BaseAPI { * @param {string} [cacheControl] General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof MediaApi */ public uploadMedia(accountId: string, mediaId: string, body: File, contentType?: string, cacheControl?: string, options?: RawAxiosRequestConfig) { return MediaApiFp(this.configuration).uploadMedia(accountId, mediaId, body, contentType, cacheControl, options).then((request) => request(this.axios, this.basePath)); diff --git a/api/messages-api.ts b/api/messages-api.ts index 44ecd61..df5e412 100644 --- a/api/messages-api.ts +++ b/api/messages-api.ts @@ -41,7 +41,6 @@ import type { MessagingRequestError } from '../models'; import type { ProductTypeEnum } from '../models'; /** * MessagesApi - axios parameter creator - * @export */ export const MessagesApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -267,7 +266,6 @@ export const MessagesApiAxiosParamCreator = function (configuration?: Configurat /** * MessagesApi - functional programming interface - * @export */ export const MessagesApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = MessagesApiAxiosParamCreator(configuration) @@ -331,7 +329,6 @@ export const MessagesApiFp = function(configuration?: Configuration) { /** * MessagesApi - factory interface - * @export */ export const MessagesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = MessagesApiFp(configuration) @@ -389,9 +386,6 @@ export const MessagesApiFactory = function (configuration?: Configuration, baseP /** * MessagesApi - object-oriented interface - * @export - * @class MessagesApi - * @extends {BaseAPI} */ export class MessagesApi extends BaseAPI { /** @@ -401,7 +395,6 @@ export class MessagesApi extends BaseAPI { * @param {MessageRequest} messageRequest * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof MessagesApi */ public createMessage(accountId: string, messageRequest: MessageRequest, options?: RawAxiosRequestConfig) { return MessagesApiFp(this.configuration).createMessage(accountId, messageRequest, options).then((request) => request(this.axios, this.basePath)); @@ -440,7 +433,6 @@ export class MessagesApi extends BaseAPI { * @param {boolean} [limitTotalCount] When set to true, the response\'s totalCount field will have a maximum value of 10,000. When set to false, or excluded, this will give an accurate totalCount of all messages that match the provided filters. If you are experiencing latency, try using this parameter to limit your results. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof MessagesApi */ public listMessages(accountId: string, messageId?: string, sourceTn?: string, destinationTn?: string, messageStatus?: MessageStatusEnum, messageDirection?: ListMessageDirectionEnum, carrierName?: string, messageType?: MessageTypeEnum, errorCode?: number, fromDateTime?: string, toDateTime?: string, campaignId?: string, fromBwLatency?: number, bwQueued?: boolean, product?: ProductTypeEnum, location?: string, carrierQueued?: boolean, fromCarrierLatency?: number, callingNumberCountryA3?: string, calledNumberCountryA3?: string, fromSegmentCount?: number, toSegmentCount?: number, fromMessageSize?: number, toMessageSize?: number, sort?: string, pageToken?: string, limit?: number, limitTotalCount?: boolean, options?: RawAxiosRequestConfig) { return MessagesApiFp(this.configuration).listMessages(accountId, messageId, sourceTn, destinationTn, messageStatus, messageDirection, carrierName, messageType, errorCode, fromDateTime, toDateTime, campaignId, fromBwLatency, bwQueued, product, location, carrierQueued, fromCarrierLatency, callingNumberCountryA3, calledNumberCountryA3, fromSegmentCount, toSegmentCount, fromMessageSize, toMessageSize, sort, pageToken, limit, limitTotalCount, options).then((request) => request(this.axios, this.basePath)); diff --git a/api/mfaapi.ts b/api/mfaapi.ts index bffc0e3..dafb8ec 100644 --- a/api/mfaapi.ts +++ b/api/mfaapi.ts @@ -39,7 +39,6 @@ import type { VerifyCodeResponse } from '../models'; import type { VoiceCodeResponse } from '../models'; /** * MFAApi - axios parameter creator - * @export */ export const MFAApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -180,7 +179,6 @@ export const MFAApiAxiosParamCreator = function (configuration?: Configuration) /** * MFAApi - functional programming interface - * @export */ export const MFAApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = MFAApiAxiosParamCreator(configuration) @@ -232,7 +230,6 @@ export const MFAApiFp = function(configuration?: Configuration) { /** * MFAApi - factory interface - * @export */ export const MFAApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = MFAApiFp(configuration) @@ -275,9 +272,6 @@ export const MFAApiFactory = function (configuration?: Configuration, basePath?: /** * MFAApi - object-oriented interface - * @export - * @class MFAApi - * @extends {BaseAPI} */ export class MFAApi extends BaseAPI { /** @@ -287,7 +281,6 @@ export class MFAApi extends BaseAPI { * @param {CodeRequest} codeRequest MFA code request body. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof MFAApi */ public generateMessagingCode(accountId: string, codeRequest: CodeRequest, options?: RawAxiosRequestConfig) { return MFAApiFp(this.configuration).generateMessagingCode(accountId, codeRequest, options).then((request) => request(this.axios, this.basePath)); @@ -300,7 +293,6 @@ export class MFAApi extends BaseAPI { * @param {CodeRequest} codeRequest MFA code request body. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof MFAApi */ public generateVoiceCode(accountId: string, codeRequest: CodeRequest, options?: RawAxiosRequestConfig) { return MFAApiFp(this.configuration).generateVoiceCode(accountId, codeRequest, options).then((request) => request(this.axios, this.basePath)); @@ -313,7 +305,6 @@ export class MFAApi extends BaseAPI { * @param {VerifyCodeRequest} verifyCodeRequest MFA code verify request body. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof MFAApi */ public verifyCode(accountId: string, verifyCodeRequest: VerifyCodeRequest, options?: RawAxiosRequestConfig) { return MFAApiFp(this.configuration).verifyCode(accountId, verifyCodeRequest, options).then((request) => request(this.axios, this.basePath)); diff --git a/api/multi-channel-api.ts b/api/multi-channel-api.ts index c94ebaa..ccfab14 100644 --- a/api/multi-channel-api.ts +++ b/api/multi-channel-api.ts @@ -29,7 +29,6 @@ import type { MultiChannelError } from '../models'; import type { MultiChannelMessageRequest } from '../models'; /** * MultiChannelApi - axios parameter creator - * @export */ export const MultiChannelApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -82,7 +81,6 @@ export const MultiChannelApiAxiosParamCreator = function (configuration?: Config /** * MultiChannelApi - functional programming interface - * @export */ export const MultiChannelApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = MultiChannelApiAxiosParamCreator(configuration) @@ -106,7 +104,6 @@ export const MultiChannelApiFp = function(configuration?: Configuration) { /** * MultiChannelApi - factory interface - * @export */ export const MultiChannelApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = MultiChannelApiFp(configuration) @@ -127,9 +124,6 @@ export const MultiChannelApiFactory = function (configuration?: Configuration, b /** * MultiChannelApi - object-oriented interface - * @export - * @class MultiChannelApi - * @extends {BaseAPI} */ export class MultiChannelApi extends BaseAPI { /** @@ -139,7 +133,6 @@ export class MultiChannelApi extends BaseAPI { * @param {MultiChannelMessageRequest} multiChannelMessageRequest * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof MultiChannelApi */ public createMultiChannelMessage(accountId: string, multiChannelMessageRequest: MultiChannelMessageRequest, options?: RawAxiosRequestConfig) { return MultiChannelApiFp(this.configuration).createMultiChannelMessage(accountId, multiChannelMessageRequest, options).then((request) => request(this.axios, this.basePath)); diff --git a/api/phone-number-lookup-api.ts b/api/phone-number-lookup-api.ts index 4c3095d..8a16272 100644 --- a/api/phone-number-lookup-api.ts +++ b/api/phone-number-lookup-api.ts @@ -22,34 +22,80 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base'; // @ts-ignore -import type { CreateLookupResponse } from '../models'; +import type { AsyncLookupRequest } from '../models'; // @ts-ignore -import type { LookupRequest } from '../models'; +import type { CreateAsyncBulkLookupResponse } from '../models'; // @ts-ignore -import type { LookupStatus } from '../models'; +import type { CreateSyncLookupResponse } from '../models'; // @ts-ignore -import type { TnLookupRequestError } from '../models'; +import type { GetAsyncBulkLookupResponse } from '../models'; +// @ts-ignore +import type { LookupErrorResponse } from '../models'; +// @ts-ignore +import type { SyncLookupRequest } from '../models'; /** * PhoneNumberLookupApi - axios parameter creator - * @export */ export const PhoneNumberLookupApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Create a Phone Number Lookup Request. - * @summary Create Lookup - * @param {string} accountId Your Bandwidth Account ID. - * @param {LookupRequest} lookupRequest Phone number lookup request. + * Creates an asynchronous bulk phone number lookup request. Maximum of 15,000 telephone numbers per request. Use the [Get Asynchronous Bulk Number Lookup](#tag/Phone-Number-Lookup/operation/getAsyncBulkLookup) endpoint to check the status of the request and view the results. + * @summary Create Asynchronous Bulk Number Lookup + * @param {string} accountId + * @param {AsyncLookupRequest} asyncLookupRequest Asynchronous bulk phone number lookup request. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createAsyncBulkLookup: async (accountId: string, asyncLookupRequest: AsyncLookupRequest, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'accountId' is not null or undefined + assertParamExists('createAsyncBulkLookup', 'accountId', accountId) + // verify required parameter 'asyncLookupRequest' is not null or undefined + assertParamExists('createAsyncBulkLookup', 'asyncLookupRequest', asyncLookupRequest) + const localVarPath = `/accounts/{accountId}/phoneNumberLookup/bulk` + .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Basic required + // http basic authentication required + setBasicAuthToObject(localVarRequestOptions, configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(asyncLookupRequest, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Creates a synchronous phone number lookup request. Maximum of 100 telephone numbers per request. + * @summary Create Synchronous Number Lookup + * @param {string} accountId + * @param {SyncLookupRequest} syncLookupRequest Synchronous phone number lookup request. * @param {*} [options] Override http request option. - * @deprecated * @throws {RequiredError} */ - createLookup: async (accountId: string, lookupRequest: LookupRequest, options: RawAxiosRequestConfig = {}): Promise => { + createSyncLookup: async (accountId: string, syncLookupRequest: SyncLookupRequest, options: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'accountId' is not null or undefined - assertParamExists('createLookup', 'accountId', accountId) - // verify required parameter 'lookupRequest' is not null or undefined - assertParamExists('createLookup', 'lookupRequest', lookupRequest) - const localVarPath = `/accounts/{accountId}/tnlookup` + assertParamExists('createSyncLookup', 'accountId', accountId) + // verify required parameter 'syncLookupRequest' is not null or undefined + assertParamExists('createSyncLookup', 'syncLookupRequest', syncLookupRequest) + const localVarPath = `/accounts/{accountId}/phoneNumberLookup` .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -73,7 +119,7 @@ export const PhoneNumberLookupApiAxiosParamCreator = function (configuration?: C setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(lookupRequest, localVarRequestOptions, configuration) + localVarRequestOptions.data = serializeDataIfNeeded(syncLookupRequest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), @@ -81,20 +127,19 @@ export const PhoneNumberLookupApiAxiosParamCreator = function (configuration?: C }; }, /** - * Get an existing Phone Number Lookup Request. - * @summary Get Lookup Request Status - * @param {string} accountId Your Bandwidth Account ID. - * @param {string} requestId The phone number lookup request ID from Bandwidth. + * Get an existing [Asynchronous Bulk Number Lookup](#tag/Phone-Number-Lookup/operation/createAsyncBulkLookup). Use this endpoint to check the status of the request and view the results. + * @summary Get Asynchronous Bulk Number Lookup + * @param {string} accountId + * @param {string} requestId * @param {*} [options] Override http request option. - * @deprecated * @throws {RequiredError} */ - getLookupStatus: async (accountId: string, requestId: string, options: RawAxiosRequestConfig = {}): Promise => { + getAsyncBulkLookup: async (accountId: string, requestId: string, options: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'accountId' is not null or undefined - assertParamExists('getLookupStatus', 'accountId', accountId) + assertParamExists('getAsyncBulkLookup', 'accountId', accountId) // verify required parameter 'requestId' is not null or undefined - assertParamExists('getLookupStatus', 'requestId', requestId) - const localVarPath = `/accounts/{accountId}/tnlookup/{requestId}` + assertParamExists('getAsyncBulkLookup', 'requestId', requestId) + const localVarPath = `/accounts/{accountId}/phoneNumberLookup/bulk/{requestId}` .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId))) .replace(`{${"requestId"}}`, encodeURIComponent(String(requestId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. @@ -128,39 +173,50 @@ export const PhoneNumberLookupApiAxiosParamCreator = function (configuration?: C /** * PhoneNumberLookupApi - functional programming interface - * @export */ export const PhoneNumberLookupApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = PhoneNumberLookupApiAxiosParamCreator(configuration) return { /** - * Create a Phone Number Lookup Request. - * @summary Create Lookup - * @param {string} accountId Your Bandwidth Account ID. - * @param {LookupRequest} lookupRequest Phone number lookup request. + * Creates an asynchronous bulk phone number lookup request. Maximum of 15,000 telephone numbers per request. Use the [Get Asynchronous Bulk Number Lookup](#tag/Phone-Number-Lookup/operation/getAsyncBulkLookup) endpoint to check the status of the request and view the results. + * @summary Create Asynchronous Bulk Number Lookup + * @param {string} accountId + * @param {AsyncLookupRequest} asyncLookupRequest Asynchronous bulk phone number lookup request. * @param {*} [options] Override http request option. - * @deprecated * @throws {RequiredError} */ - async createLookup(accountId: string, lookupRequest: LookupRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createLookup(accountId, lookupRequest, options); + async createAsyncBulkLookup(accountId: string, asyncLookupRequest: AsyncLookupRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createAsyncBulkLookup(accountId, asyncLookupRequest, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PhoneNumberLookupApi.createLookup']?.[localVarOperationServerIndex]?.url; + const localVarOperationServerBasePath = operationServerMap['PhoneNumberLookupApi.createAsyncBulkLookup']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** - * Get an existing Phone Number Lookup Request. - * @summary Get Lookup Request Status - * @param {string} accountId Your Bandwidth Account ID. - * @param {string} requestId The phone number lookup request ID from Bandwidth. + * Creates a synchronous phone number lookup request. Maximum of 100 telephone numbers per request. + * @summary Create Synchronous Number Lookup + * @param {string} accountId + * @param {SyncLookupRequest} syncLookupRequest Synchronous phone number lookup request. * @param {*} [options] Override http request option. - * @deprecated * @throws {RequiredError} */ - async getLookupStatus(accountId: string, requestId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getLookupStatus(accountId, requestId, options); + async createSyncLookup(accountId: string, syncLookupRequest: SyncLookupRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createSyncLookup(accountId, syncLookupRequest, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PhoneNumberLookupApi.getLookupStatus']?.[localVarOperationServerIndex]?.url; + const localVarOperationServerBasePath = operationServerMap['PhoneNumberLookupApi.createSyncLookup']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get an existing [Asynchronous Bulk Number Lookup](#tag/Phone-Number-Lookup/operation/createAsyncBulkLookup). Use this endpoint to check the status of the request and view the results. + * @summary Get Asynchronous Bulk Number Lookup + * @param {string} accountId + * @param {string} requestId + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getAsyncBulkLookup(accountId: string, requestId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAsyncBulkLookup(accountId, requestId, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PhoneNumberLookupApi.getAsyncBulkLookup']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, } @@ -168,71 +224,84 @@ export const PhoneNumberLookupApiFp = function(configuration?: Configuration) { /** * PhoneNumberLookupApi - factory interface - * @export */ export const PhoneNumberLookupApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = PhoneNumberLookupApiFp(configuration) return { /** - * Create a Phone Number Lookup Request. - * @summary Create Lookup - * @param {string} accountId Your Bandwidth Account ID. - * @param {LookupRequest} lookupRequest Phone number lookup request. + * Creates an asynchronous bulk phone number lookup request. Maximum of 15,000 telephone numbers per request. Use the [Get Asynchronous Bulk Number Lookup](#tag/Phone-Number-Lookup/operation/getAsyncBulkLookup) endpoint to check the status of the request and view the results. + * @summary Create Asynchronous Bulk Number Lookup + * @param {string} accountId + * @param {AsyncLookupRequest} asyncLookupRequest Asynchronous bulk phone number lookup request. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createAsyncBulkLookup(accountId: string, asyncLookupRequest: AsyncLookupRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createAsyncBulkLookup(accountId, asyncLookupRequest, options).then((request) => request(axios, basePath)); + }, + /** + * Creates a synchronous phone number lookup request. Maximum of 100 telephone numbers per request. + * @summary Create Synchronous Number Lookup + * @param {string} accountId + * @param {SyncLookupRequest} syncLookupRequest Synchronous phone number lookup request. * @param {*} [options] Override http request option. - * @deprecated * @throws {RequiredError} */ - createLookup(accountId: string, lookupRequest: LookupRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createLookup(accountId, lookupRequest, options).then((request) => request(axios, basePath)); + createSyncLookup(accountId: string, syncLookupRequest: SyncLookupRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createSyncLookup(accountId, syncLookupRequest, options).then((request) => request(axios, basePath)); }, /** - * Get an existing Phone Number Lookup Request. - * @summary Get Lookup Request Status - * @param {string} accountId Your Bandwidth Account ID. - * @param {string} requestId The phone number lookup request ID from Bandwidth. + * Get an existing [Asynchronous Bulk Number Lookup](#tag/Phone-Number-Lookup/operation/createAsyncBulkLookup). Use this endpoint to check the status of the request and view the results. + * @summary Get Asynchronous Bulk Number Lookup + * @param {string} accountId + * @param {string} requestId * @param {*} [options] Override http request option. - * @deprecated * @throws {RequiredError} */ - getLookupStatus(accountId: string, requestId: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getLookupStatus(accountId, requestId, options).then((request) => request(axios, basePath)); + getAsyncBulkLookup(accountId: string, requestId: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getAsyncBulkLookup(accountId, requestId, options).then((request) => request(axios, basePath)); }, }; }; /** * PhoneNumberLookupApi - object-oriented interface - * @export - * @class PhoneNumberLookupApi - * @extends {BaseAPI} */ export class PhoneNumberLookupApi extends BaseAPI { /** - * Create a Phone Number Lookup Request. - * @summary Create Lookup - * @param {string} accountId Your Bandwidth Account ID. - * @param {LookupRequest} lookupRequest Phone number lookup request. + * Creates an asynchronous bulk phone number lookup request. Maximum of 15,000 telephone numbers per request. Use the [Get Asynchronous Bulk Number Lookup](#tag/Phone-Number-Lookup/operation/getAsyncBulkLookup) endpoint to check the status of the request and view the results. + * @summary Create Asynchronous Bulk Number Lookup + * @param {string} accountId + * @param {AsyncLookupRequest} asyncLookupRequest Asynchronous bulk phone number lookup request. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + public createAsyncBulkLookup(accountId: string, asyncLookupRequest: AsyncLookupRequest, options?: RawAxiosRequestConfig) { + return PhoneNumberLookupApiFp(this.configuration).createAsyncBulkLookup(accountId, asyncLookupRequest, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Creates a synchronous phone number lookup request. Maximum of 100 telephone numbers per request. + * @summary Create Synchronous Number Lookup + * @param {string} accountId + * @param {SyncLookupRequest} syncLookupRequest Synchronous phone number lookup request. * @param {*} [options] Override http request option. - * @deprecated * @throws {RequiredError} - * @memberof PhoneNumberLookupApi */ - public createLookup(accountId: string, lookupRequest: LookupRequest, options?: RawAxiosRequestConfig) { - return PhoneNumberLookupApiFp(this.configuration).createLookup(accountId, lookupRequest, options).then((request) => request(this.axios, this.basePath)); + public createSyncLookup(accountId: string, syncLookupRequest: SyncLookupRequest, options?: RawAxiosRequestConfig) { + return PhoneNumberLookupApiFp(this.configuration).createSyncLookup(accountId, syncLookupRequest, options).then((request) => request(this.axios, this.basePath)); } /** - * Get an existing Phone Number Lookup Request. - * @summary Get Lookup Request Status - * @param {string} accountId Your Bandwidth Account ID. - * @param {string} requestId The phone number lookup request ID from Bandwidth. + * Get an existing [Asynchronous Bulk Number Lookup](#tag/Phone-Number-Lookup/operation/createAsyncBulkLookup). Use this endpoint to check the status of the request and view the results. + * @summary Get Asynchronous Bulk Number Lookup + * @param {string} accountId + * @param {string} requestId * @param {*} [options] Override http request option. - * @deprecated * @throws {RequiredError} - * @memberof PhoneNumberLookupApi */ - public getLookupStatus(accountId: string, requestId: string, options?: RawAxiosRequestConfig) { - return PhoneNumberLookupApiFp(this.configuration).getLookupStatus(accountId, requestId, options).then((request) => request(this.axios, this.basePath)); + public getAsyncBulkLookup(accountId: string, requestId: string, options?: RawAxiosRequestConfig) { + return PhoneNumberLookupApiFp(this.configuration).getAsyncBulkLookup(accountId, requestId, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/api/recordings-api.ts b/api/recordings-api.ts index 33ed1a8..1fcec47 100644 --- a/api/recordings-api.ts +++ b/api/recordings-api.ts @@ -33,7 +33,6 @@ import type { UpdateCallRecording } from '../models'; import type { VoiceApiError } from '../models'; /** * RecordingsApi - axios parameter creator - * @export */ export const RecordingsApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -518,7 +517,6 @@ export const RecordingsApiAxiosParamCreator = function (configuration?: Configur /** * RecordingsApi - functional programming interface - * @export */ export const RecordingsApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = RecordingsApiAxiosParamCreator(configuration) @@ -680,7 +678,6 @@ export const RecordingsApiFp = function(configuration?: Configuration) { /** * RecordingsApi - factory interface - * @export */ export const RecordingsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = RecordingsApiFp(configuration) @@ -812,9 +809,6 @@ export const RecordingsApiFactory = function (configuration?: Configuration, bas /** * RecordingsApi - object-oriented interface - * @export - * @class RecordingsApi - * @extends {BaseAPI} */ export class RecordingsApi extends BaseAPI { /** @@ -825,7 +819,6 @@ export class RecordingsApi extends BaseAPI { * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof RecordingsApi */ public deleteRecording(accountId: string, callId: string, recordingId: string, options?: RawAxiosRequestConfig) { return RecordingsApiFp(this.configuration).deleteRecording(accountId, callId, recordingId, options).then((request) => request(this.axios, this.basePath)); @@ -839,7 +832,6 @@ export class RecordingsApi extends BaseAPI { * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof RecordingsApi */ public deleteRecordingMedia(accountId: string, callId: string, recordingId: string, options?: RawAxiosRequestConfig) { return RecordingsApiFp(this.configuration).deleteRecordingMedia(accountId, callId, recordingId, options).then((request) => request(this.axios, this.basePath)); @@ -853,7 +845,6 @@ export class RecordingsApi extends BaseAPI { * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof RecordingsApi */ public deleteRecordingTranscription(accountId: string, callId: string, recordingId: string, options?: RawAxiosRequestConfig) { return RecordingsApiFp(this.configuration).deleteRecordingTranscription(accountId, callId, recordingId, options).then((request) => request(this.axios, this.basePath)); @@ -867,7 +858,6 @@ export class RecordingsApi extends BaseAPI { * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof RecordingsApi */ public downloadCallRecording(accountId: string, callId: string, recordingId: string, options?: RawAxiosRequestConfig) { return RecordingsApiFp(this.configuration).downloadCallRecording(accountId, callId, recordingId, options).then((request) => request(this.axios, this.basePath)); @@ -881,7 +871,6 @@ export class RecordingsApi extends BaseAPI { * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof RecordingsApi */ public getCallRecording(accountId: string, callId: string, recordingId: string, options?: RawAxiosRequestConfig) { return RecordingsApiFp(this.configuration).getCallRecording(accountId, callId, recordingId, options).then((request) => request(this.axios, this.basePath)); @@ -895,7 +884,6 @@ export class RecordingsApi extends BaseAPI { * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof RecordingsApi */ public getRecordingTranscription(accountId: string, callId: string, recordingId: string, options?: RawAxiosRequestConfig) { return RecordingsApiFp(this.configuration).getRecordingTranscription(accountId, callId, recordingId, options).then((request) => request(this.axios, this.basePath)); @@ -911,7 +899,6 @@ export class RecordingsApi extends BaseAPI { * @param {string} [maxStartTime] Filter results to recordings which have a `startTime` before `maxStartTime` (in ISO8601 format). * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof RecordingsApi */ public listAccountCallRecordings(accountId: string, to?: string, from?: string, minStartTime?: string, maxStartTime?: string, options?: RawAxiosRequestConfig) { return RecordingsApiFp(this.configuration).listAccountCallRecordings(accountId, to, from, minStartTime, maxStartTime, options).then((request) => request(this.axios, this.basePath)); @@ -924,7 +911,6 @@ export class RecordingsApi extends BaseAPI { * @param {string} callId Programmable Voice API Call ID. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof RecordingsApi */ public listCallRecordings(accountId: string, callId: string, options?: RawAxiosRequestConfig) { return RecordingsApiFp(this.configuration).listCallRecordings(accountId, callId, options).then((request) => request(this.axios, this.basePath)); @@ -939,7 +925,6 @@ export class RecordingsApi extends BaseAPI { * @param {TranscribeRecording} transcribeRecording * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof RecordingsApi */ public transcribeCallRecording(accountId: string, callId: string, recordingId: string, transcribeRecording: TranscribeRecording, options?: RawAxiosRequestConfig) { return RecordingsApiFp(this.configuration).transcribeCallRecording(accountId, callId, recordingId, transcribeRecording, options).then((request) => request(this.axios, this.basePath)); @@ -953,7 +938,6 @@ export class RecordingsApi extends BaseAPI { * @param {UpdateCallRecording} updateCallRecording * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof RecordingsApi */ public updateCallRecordingState(accountId: string, callId: string, updateCallRecording: UpdateCallRecording, options?: RawAxiosRequestConfig) { return RecordingsApiFp(this.configuration).updateCallRecordingState(accountId, callId, updateCallRecording, options).then((request) => request(this.axios, this.basePath)); diff --git a/api/statistics-api.ts b/api/statistics-api.ts index 71a1e1e..af5250c 100644 --- a/api/statistics-api.ts +++ b/api/statistics-api.ts @@ -27,7 +27,6 @@ import type { AccountStatistics } from '../models'; import type { VoiceApiError } from '../models'; /** * StatisticsApi - axios parameter creator - * @export */ export const StatisticsApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -74,7 +73,6 @@ export const StatisticsApiAxiosParamCreator = function (configuration?: Configur /** * StatisticsApi - functional programming interface - * @export */ export const StatisticsApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = StatisticsApiAxiosParamCreator(configuration) @@ -97,7 +95,6 @@ export const StatisticsApiFp = function(configuration?: Configuration) { /** * StatisticsApi - factory interface - * @export */ export const StatisticsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = StatisticsApiFp(configuration) @@ -117,9 +114,6 @@ export const StatisticsApiFactory = function (configuration?: Configuration, bas /** * StatisticsApi - object-oriented interface - * @export - * @class StatisticsApi - * @extends {BaseAPI} */ export class StatisticsApi extends BaseAPI { /** @@ -128,7 +122,6 @@ export class StatisticsApi extends BaseAPI { * @param {string} accountId Your Bandwidth Account ID. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StatisticsApi */ public getStatistics(accountId: string, options?: RawAxiosRequestConfig) { return StatisticsApiFp(this.configuration).getStatistics(accountId, options).then((request) => request(this.axios, this.basePath)); diff --git a/api/toll-free-verification-api.ts b/api/toll-free-verification-api.ts index 6b77001..e681a87 100644 --- a/api/toll-free-verification-api.ts +++ b/api/toll-free-verification-api.ts @@ -37,7 +37,6 @@ import type { WebhookSubscriptionRequestSchema } from '../models'; import type { WebhookSubscriptionsListBody } from '../models'; /** * TollFreeVerificationApi - axios parameter creator - * @export */ export const TollFreeVerificationApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -428,7 +427,6 @@ export const TollFreeVerificationApiAxiosParamCreator = function (configuration? /** * TollFreeVerificationApi - functional programming interface - * @export */ export const TollFreeVerificationApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = TollFreeVerificationApiAxiosParamCreator(configuration) @@ -563,7 +561,6 @@ export const TollFreeVerificationApiFp = function(configuration?: Configuration) /** * TollFreeVerificationApi - factory interface - * @export */ export const TollFreeVerificationApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = TollFreeVerificationApiFp(configuration) @@ -671,9 +668,6 @@ export const TollFreeVerificationApiFactory = function (configuration?: Configur /** * TollFreeVerificationApi - object-oriented interface - * @export - * @class TollFreeVerificationApi - * @extends {BaseAPI} */ export class TollFreeVerificationApi extends BaseAPI { /** @@ -683,7 +677,6 @@ export class TollFreeVerificationApi extends BaseAPI { * @param {WebhookSubscriptionRequestSchema} webhookSubscriptionRequestSchema Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof TollFreeVerificationApi */ public createWebhookSubscription(accountId: string, webhookSubscriptionRequestSchema: WebhookSubscriptionRequestSchema, options?: RawAxiosRequestConfig) { return TollFreeVerificationApiFp(this.configuration).createWebhookSubscription(accountId, webhookSubscriptionRequestSchema, options).then((request) => request(this.axios, this.basePath)); @@ -696,7 +689,6 @@ export class TollFreeVerificationApi extends BaseAPI { * @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof TollFreeVerificationApi */ public deleteVerificationRequest(accountId: string, phoneNumber: string, options?: RawAxiosRequestConfig) { return TollFreeVerificationApiFp(this.configuration).deleteVerificationRequest(accountId, phoneNumber, options).then((request) => request(this.axios, this.basePath)); @@ -709,7 +701,6 @@ export class TollFreeVerificationApi extends BaseAPI { * @param {string} id Webhook subscription ID * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof TollFreeVerificationApi */ public deleteWebhookSubscription(accountId: string, id: string, options?: RawAxiosRequestConfig) { return TollFreeVerificationApiFp(this.configuration).deleteWebhookSubscription(accountId, id, options).then((request) => request(this.axios, this.basePath)); @@ -722,7 +713,6 @@ export class TollFreeVerificationApi extends BaseAPI { * @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof TollFreeVerificationApi */ public getTollFreeVerificationStatus(accountId: string, phoneNumber: string, options?: RawAxiosRequestConfig) { return TollFreeVerificationApiFp(this.configuration).getTollFreeVerificationStatus(accountId, phoneNumber, options).then((request) => request(this.axios, this.basePath)); @@ -733,7 +723,6 @@ export class TollFreeVerificationApi extends BaseAPI { * @summary List Toll-Free Use Cases * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof TollFreeVerificationApi */ public listTollFreeUseCases(options?: RawAxiosRequestConfig) { return TollFreeVerificationApiFp(this.configuration).listTollFreeUseCases(options).then((request) => request(this.axios, this.basePath)); @@ -745,7 +734,6 @@ export class TollFreeVerificationApi extends BaseAPI { * @param {string} accountId Your Bandwidth Account ID. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof TollFreeVerificationApi */ public listWebhookSubscriptions(accountId: string, options?: RawAxiosRequestConfig) { return TollFreeVerificationApiFp(this.configuration).listWebhookSubscriptions(accountId, options).then((request) => request(this.axios, this.basePath)); @@ -758,7 +746,6 @@ export class TollFreeVerificationApi extends BaseAPI { * @param {VerificationRequest} verificationRequest Request for verification of a toll-free phone number. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof TollFreeVerificationApi */ public requestTollFreeVerification(accountId: string, verificationRequest: VerificationRequest, options?: RawAxiosRequestConfig) { return TollFreeVerificationApiFp(this.configuration).requestTollFreeVerification(accountId, verificationRequest, options).then((request) => request(this.axios, this.basePath)); @@ -772,7 +759,6 @@ export class TollFreeVerificationApi extends BaseAPI { * @param {TfvSubmissionWrapper} tfvSubmissionWrapper Update a request for verification of a toll-free phone number. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof TollFreeVerificationApi */ public updateTollFreeVerificationRequest(accountId: string, phoneNumber: string, tfvSubmissionWrapper: TfvSubmissionWrapper, options?: RawAxiosRequestConfig) { return TollFreeVerificationApiFp(this.configuration).updateTollFreeVerificationRequest(accountId, phoneNumber, tfvSubmissionWrapper, options).then((request) => request(this.axios, this.basePath)); @@ -786,7 +772,6 @@ export class TollFreeVerificationApi extends BaseAPI { * @param {WebhookSubscriptionRequestSchema} webhookSubscriptionRequestSchema Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof TollFreeVerificationApi */ public updateWebhookSubscription(accountId: string, id: string, webhookSubscriptionRequestSchema: WebhookSubscriptionRequestSchema, options?: RawAxiosRequestConfig) { return TollFreeVerificationApiFp(this.configuration).updateWebhookSubscription(accountId, id, webhookSubscriptionRequestSchema, options).then((request) => request(this.axios, this.basePath)); diff --git a/api/transcriptions-api.ts b/api/transcriptions-api.ts index eee25bf..adf0251 100644 --- a/api/transcriptions-api.ts +++ b/api/transcriptions-api.ts @@ -29,7 +29,6 @@ import type { CallTranscriptionResponse } from '../models'; import type { VoiceApiError } from '../models'; /** * TranscriptionsApi - axios parameter creator - * @export */ export const TranscriptionsApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -172,7 +171,6 @@ export const TranscriptionsApiAxiosParamCreator = function (configuration?: Conf /** * TranscriptionsApi - functional programming interface - * @export */ export const TranscriptionsApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = TranscriptionsApiAxiosParamCreator(configuration) @@ -226,7 +224,6 @@ export const TranscriptionsApiFp = function(configuration?: Configuration) { /** * TranscriptionsApi - factory interface - * @export */ export const TranscriptionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = TranscriptionsApiFp(configuration) @@ -271,9 +268,6 @@ export const TranscriptionsApiFactory = function (configuration?: Configuration, /** * TranscriptionsApi - object-oriented interface - * @export - * @class TranscriptionsApi - * @extends {BaseAPI} */ export class TranscriptionsApi extends BaseAPI { /** @@ -284,7 +278,6 @@ export class TranscriptionsApi extends BaseAPI { * @param {string} transcriptionId Programmable Voice API Transcription ID. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof TranscriptionsApi */ public deleteRealTimeTranscription(accountId: string, callId: string, transcriptionId: string, options?: RawAxiosRequestConfig) { return TranscriptionsApiFp(this.configuration).deleteRealTimeTranscription(accountId, callId, transcriptionId, options).then((request) => request(this.axios, this.basePath)); @@ -298,7 +291,6 @@ export class TranscriptionsApi extends BaseAPI { * @param {string} transcriptionId Programmable Voice API Transcription ID. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof TranscriptionsApi */ public getRealTimeTranscription(accountId: string, callId: string, transcriptionId: string, options?: RawAxiosRequestConfig) { return TranscriptionsApiFp(this.configuration).getRealTimeTranscription(accountId, callId, transcriptionId, options).then((request) => request(this.axios, this.basePath)); @@ -311,7 +303,6 @@ export class TranscriptionsApi extends BaseAPI { * @param {string} callId Programmable Voice API Call ID. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof TranscriptionsApi */ public listRealTimeTranscriptions(accountId: string, callId: string, options?: RawAxiosRequestConfig) { return TranscriptionsApiFp(this.configuration).listRealTimeTranscriptions(accountId, callId, options).then((request) => request(this.axios, this.basePath)); diff --git a/bandwidth.yml b/bandwidth.yml index bf2c9ab..0c61348 100644 --- a/bandwidth.yml +++ b/bandwidth.yml @@ -1328,62 +1328,66 @@ paths: '500': $ref: '#/components/responses/mfaInternalServerError' servers: *ref_2 - /accounts/{accountId}/tnlookup: + /accounts/{accountId}/phoneNumberLookup: post: - deprecated: true - summary: Create Lookup - description: Create a Phone Number Lookup Request. - operationId: createLookup + summary: Create Synchronous Number Lookup + description: >- + Creates a synchronous phone number lookup request. Maximum of 100 + telephone numbers per request. + operationId: createSyncLookup tags: - Phone Number Lookup parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId1' requestBody: - $ref: '#/components/requestBodies/createLookupRequest' + $ref: '#/components/requestBodies/createSyncLookupRequest' responses: - '202': - $ref: '#/components/responses/createLookupResponse' - '400': - $ref: '#/components/responses/tnLookupBadRequestError' - '401': - $ref: '#/components/responses/tnLookupUnauthorizedError' - '403': - $ref: '#/components/responses/tnLookupForbiddenError' - '415': - $ref: '#/components/responses/tnLookupMediaTypeError' - '429': - $ref: '#/components/responses/tnLookupTooManyRequestsError' - '500': - $ref: '#/components/responses/tnLookupInternalServerError' + '200': + $ref: '#/components/responses/createSyncLookupResponse' + default: + $ref: '#/components/responses/tnLookupDefaultResponse' servers: &ref_3 - - url: https://numbers.bandwidth.com/api/v1 + - url: https://api.bandwidth.com/v2 description: Production - /accounts/{accountId}/tnlookup/{requestId}: + /accounts/{accountId}/phoneNumberLookup/bulk: + post: + summary: Create Asynchronous Bulk Number Lookup + description: >- + Creates an asynchronous bulk phone number lookup request. Maximum of + 15,000 telephone numbers per request. Use the [Get Asynchronous Bulk + Number Lookup](#tag/Phone-Number-Lookup/operation/getAsyncBulkLookup) + endpoint to check the status of the request and view the results. + operationId: createAsyncBulkLookup + tags: + - Phone Number Lookup + parameters: + - $ref: '#/components/parameters/accountId1' + requestBody: + $ref: '#/components/requestBodies/createAsyncBulkLookupRequest' + responses: + '202': + $ref: '#/components/responses/createAsyncBulkLookupResponse' + default: + $ref: '#/components/responses/tnLookupDefaultResponse' + servers: *ref_3 + /accounts/{accountId}/phoneNumberLookup/bulk/{requestId}: get: - deprecated: true - summary: Get Lookup Request Status - description: Get an existing Phone Number Lookup Request. - operationId: getLookupStatus + summary: Get Asynchronous Bulk Number Lookup + description: >- + Get an existing [Asynchronous Bulk Number + Lookup](#tag/Phone-Number-Lookup/operation/createAsyncBulkLookup). Use + this endpoint to check the status of the request and view the results. + operationId: getAsyncBulkLookup tags: - Phone Number Lookup parameters: - - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/accountId1' - $ref: '#/components/parameters/requestId' responses: '200': - $ref: '#/components/responses/getLookupResponse' - '400': - $ref: '#/components/responses/tnLookupBadRequestError' - '401': - $ref: '#/components/responses/tnLookupUnauthorizedError' - '403': - $ref: '#/components/responses/tnLookupForbiddenError' - '404': - $ref: '#/components/responses/tnLookupNotFoundError' - '429': - $ref: '#/components/responses/tnLookupTooManyRequestsError' - '500': - $ref: '#/components/responses/tnLookupInternalServerError' + $ref: '#/components/responses/getAsyncBulkLookupResponse' + default: + $ref: '#/components/responses/tnLookupDefaultResponse' servers: *ref_3 /accounts/{accountId}/tollFreeVerification: post: @@ -5368,112 +5372,291 @@ components: The message containing the reason behind the request being forbidden. example: Missing Authentication Token - lookupStatusEnum: + completedLookupStatusEnum: + type: string + enum: + - COMPLETE + - PARTIAL_COMPLETE + - FAILED + example: COMPLETE + inProgressLookupStatusEnum: type: string - description: >- - The status of the request (IN_PROGRESS, COMPLETE, PARTIAL_COMPLETE, or - FAILED). enum: - IN_PROGRESS - COMPLETE - PARTIAL_COMPLETE - FAILED example: COMPLETE - lookupRequest: + deactivationEventEnum: + type: string + description: > + [DNI-Only](#section/DNI-Only). + + `DEACTIVATED` if the carrier reported a deactivation event for this + phone number. + enum: + - DEACTIVATED + latestMessageDeliveryStatusEnum: + type: string + description: >- + [DNI-Only](#section/DNI-Only). The current delivery status of the phone + number. + + - ACTIVE: A message was successfully sent to the number (delivery code + 0). + + - DEACTIVATED: A message was not delivered to a number (delivery code + 720) + + - UNKNOWN: Bandwidth cannot find an delivery status entry for the + number. + enum: + - ACTIVE + - DEACTIVATED + - UNKNOWN + lineTypeEnum: + type: string + enum: + - FIXED + - VOIP-FIXED + - MOBILE + - VOIP + example: MOBILE + requestId: + type: string + format: uuid + description: The phone number lookup request ID from Bandwidth. + example: 004223a0-8b17-41b1-bf81-20732adf5590 + linkSchema: + title: Link type: object - description: Create phone number lookup request. properties: - tns: + href: + type: string + description: URI of the link. + example: /relative/uri + rel: + type: string + description: Specifies the relationship between this link and the resource. + example: aRelatedResource + method: + type: string + description: HTTP method to be used. + example: GET + lookupErrorSchema: + type: object + properties: + code: + type: string + description: Validation error code + example: NO-MATCH + description: + type: string + description: Description of validation error + example: Example error description + type: + type: string + description: Type of validation error + example: NumberInventory + meta: + type: object + properties: + phoneNumbers: + type: array + items: + type: string + description: Phone number experiencing the error. + example: + - '+13992077164' + - '+19196104424' + message: + type: string + description: Message describing the error + example: Invalid TNs + code: + type: integer + description: Error code associated with the message + example: 1001 + syncLookupRequest: + type: object + properties: + phoneNumbers: + description: Telephone numbers in E.164 format. type: array + minimum: 1 + maximum: 100 items: type: string + pattern: ^\+[1-9]\d{1,14}$ required: - - tns - createLookupResponse: + - phoneNumbers + asyncLookupRequest: type: object - description: >- - The request has been accepted for processing but not yet finished and in - a terminal state (COMPLETE, PARTIAL_COMPLETE, or FAILED). properties: - requestId: - type: string - description: The phone number lookup request ID from Bandwidth. - status: - $ref: '#/components/schemas/lookupStatusEnum' - lookupStatus: + phoneNumbers: + description: Telephone numbers in E.164 format. + type: array + minimum: 1 + maximum: 15000 + items: + type: string + pattern: ^\+[1-9]\d{1,14}$ + required: + - phoneNumbers + createSyncLookupResponse: type: object - description: >- - If requestId exists, the result for that request is returned. See the - Examples for details on the various responses that you can receive. - Generally, if you see a Response Code of 0 in a result for a TN, - information will be available for it. Any other Response Code will - indicate no information was available for the TN. properties: - requestId: - type: string - description: The requestId. - example: 004223a0-8b17-41b1-bf81-20732adf5590 - status: - $ref: '#/components/schemas/lookupStatusEnum' - result: + links: + type: array + items: + $ref: '#/components/schemas/linkSchema' + example: [] + data: + type: object + description: The phone number lookup response data + properties: + requestId: + $ref: '#/components/schemas/requestId' + status: + $ref: '#/components/schemas/completedLookupStatusEnum' + results: + type: array + description: >- + The carrier information results for the specified telephone + numbers. + items: + $ref: '#/components/schemas/lookupResult' + errors: type: array - description: The carrier information results for the specified telephone number. items: - $ref: '#/components/schemas/lookupResult' - failedTelephoneNumbers: + $ref: '#/components/schemas/lookupErrorSchema' + createAsyncBulkLookupResponse: + type: object + properties: + links: type: array - description: The telephone numbers whose lookup failed. + description: Links for pagination (if applicable) items: - type: string - example: - - '+191955512345' + $ref: '#/components/schemas/linkSchema' + data: + type: object + description: The phone number lookup response data + properties: + requestId: + $ref: '#/components/schemas/requestId' + status: + $ref: '#/components/schemas/inProgressLookupStatusEnum' + errors: + type: array + items: + $ref: '#/components/schemas/lookupErrorSchema' + getAsyncBulkLookupResponse: + type: object + properties: + links: + type: array + items: + $ref: '#/components/schemas/linkSchema' + example: [] + data: + type: object + description: The phone number lookup response data + properties: + requestId: + $ref: '#/components/schemas/requestId' + status: + $ref: '#/components/schemas/inProgressLookupStatusEnum' + results: + type: array + description: >- + The carrier information results for the specified telephone + number. + items: + $ref: '#/components/schemas/lookupResult' + errors: + type: array + items: + $ref: '#/components/schemas/lookupErrorSchema' + lookupErrorResponse: + type: object + properties: + links: + type: array + items: + $ref: '#/components/schemas/linkSchema' + example: [] + data: + type: object + description: The phone number lookup response data + errors: + type: array + items: + $ref: '#/components/schemas/lookupErrorSchema' lookupResult: type: object description: Carrier information results for the specified telephone number. properties: - Response Code: - type: integer - description: Our vendor's response code. - example: 0 - Message: - type: string - description: Message associated with the response code. - example: NOERROR - E.164 Format: + phoneNumber: type: string description: The telephone number in E.164 format. - example: '+19195551234' - Formatted: - type: string - description: The formatted version of the telephone number. - example: (919) 555-1234 - Country: - type: string - description: The country of the telephone number. - example: US - Line Type: - type: string - description: The line type of the telephone number. - example: Mobile - Line Provider: + example: '+10072904498' + lineType: + $ref: '#/components/schemas/lineTypeEnum' + messagingProvider: type: string description: The messaging service provider of the telephone number. example: Verizon Wireless - Mobile Country Code: + voiceProvider: type: string - description: The first half of the Home Network Identity (HNI). - example: '310' - Mobile Network Code: + description: The voice service provider of the telephone number. + example: Verizon Wireless + countryCodeA3: type: string - description: The second half of the HNI. - example: '010' - tnLookupRequestError: - type: object - properties: - message: + description: >- + The country code of the telephone number in ISO 3166-1 alpha-3 + format. + example: USA + deactivationReporter: + type: string + description: > + [DNI-Only](#section/DNI-Only). + + The carrier that reported a deactivation event for this phone + number. + deactivationDate: + type: string + format: date-time-local + description: >- + [DNI-Only](#section/DNI-Only). The datetime the carrier reported a + deactivation event. + example: 2025-06-20 18:35 + deactivationEvent: + $ref: '#/components/schemas/deactivationEventEnum' + latestMessageDeliveryStatus: + $ref: '#/components/schemas/latestMessageDeliveryStatusEnum' + initialMessageDeliveryStatusDate: + type: string + format: date + description: >- + [DNI-Only](#section/DNI-Only). The date the phone number entered the + status described in `latestMessageDeliveryStatus`. + + Think of this as the "start time" for that status. + + Value resets every time the `latestMessageDeliveryStatus` changes. + example: '2025-06-20' + latestMessageDeliveryStatusDate: type: string - description: A description of what validation error occurred. - example: example error message + format: date + description: >- + [DNI-Only](#section/DNI-Only). The date bandwidth last received + delivery status information for this phone number. + + Use this field to understand how up-to-date the + `latestMessageDeliveryStatus` is. + + Value resets every time the `latestMessageDeliveryStatus` changes. + example: '2025-06-21' accountId1: type: string description: User's account ID. @@ -6720,109 +6903,68 @@ components: application/json: schema: $ref: '#/components/schemas/mfaRequestError' - createLookupResponse: + createSyncLookupResponse: + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/createSyncLookupResponse' + examples: + lookupCompleteWithDniExample: + $ref: '#/components/examples/lookupCompleteWithDniExample' + lookupCompleteExample: + $ref: '#/components/examples/lookupCompleteExample' + lookupPartialExample: + $ref: '#/components/examples/lookupPartialExample' + lookupFailedExample: + $ref: '#/components/examples/lookupFailedExample' + createAsyncBulkLookupResponse: description: Accepted content: application/json: schema: - $ref: '#/components/schemas/createLookupResponse' + $ref: '#/components/schemas/createAsyncBulkLookupResponse' examples: - lookupResponseExample: + lookupInProgressExample: $ref: '#/components/examples/lookupInProgressExample' - getLookupResponse: + getAsyncBulkLookupResponse: description: OK content: application/json: schema: - $ref: '#/components/schemas/lookupStatus' + $ref: '#/components/schemas/getAsyncBulkLookupResponse' examples: + lookupCompleteWithDniExample: + $ref: '#/components/examples/lookupCompleteWithDniExample' + lookupCompleteExample: + $ref: '#/components/examples/lookupCompleteExample' lookupInProgressExample: $ref: '#/components/examples/lookupInProgressExample' + lookupPartialExample: + $ref: '#/components/examples/lookupPartialExample' lookupFailedExample: $ref: '#/components/examples/lookupFailedExample' - lookupSingleNumberCompleteExample: - $ref: '#/components/examples/lookupSingleNumberCompleteExample' - lookupMultipleNumbersCompleteExample: - $ref: '#/components/examples/lookupMultipleNumbersCompleteExample' - lookupMultipleNumbersPartialCompleteExample: - $ref: >- - #/components/examples/lookupMultipleNumbersPartialCompleteExample - lookupSingleNumberCompleteNoInfoExample: - $ref: '#/components/examples/lookupSingleNumberCompleteNoInfoExample' - tnLookupBadRequestError: + tnLookupDefaultResponse: description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/tnLookupRequestError' + $ref: '#/components/schemas/lookupErrorResponse' examples: badRequest: - summary: Example Bad Request Error - value: - message: 'Some tns do not match e164 format: 1234' - tnLookupUnauthorizedError: - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/tnLookupRequestError' - examples: + $ref: '#/components/examples/badRequestExample' unauthorized: - summary: Example Unauthorized Error - value: - message: Unauthorized - tnLookupForbiddenError: - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/tnLookupRequestError' - examples: + $ref: '#/components/examples/unauthorizedExample' 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==' - tnLookupMediaTypeError: - description: Unsupported Media Type - content: - application/json: - schema: - $ref: '#/components/schemas/tnLookupRequestError' - examples: - mediaType: - summary: Example Unsupported Media Type Error - value: - message: Content-Type must be application/json. - tnLookupNotFoundError: - description: Not Found - tnLookupTooManyRequestsError: - description: Too Many Requests - content: - application/json: - schema: - $ref: '#/components/schemas/tnLookupRequestError' - examples: + $ref: '#/components/examples/forbiddenExample' mediaType: - summary: Example Too Many Requests Error - value: - message: Too many requests. - tnLookupInternalServerError: - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/tnLookupRequestError' - examples: - mediaType: - summary: Example Internal Server Error Error - value: - message: Request has not been passed further. + $ref: '#/components/examples/unsupportedMediaTypeExample' + notFound: + $ref: '#/components/examples/notFoundExample' + tooManyRequests: + $ref: '#/components/examples/tooManyRequestsExample' + internalServer: + $ref: '#/components/examples/internalServerErrorExample' getTollFreeVerificationStatusResponse: description: OK content: @@ -7405,14 +7547,23 @@ components: type: string description: Filter results to calls with specified call Disconnect Cause. example: hangup + accountId1: + in: path + name: accountId + required: true + schema: + type: string + description: Your Bandwidth Account ID. + example: '9900000' requestId: - name: requestId in: path + name: requestId required: true schema: type: string - description: The phone number lookup request ID from Bandwidth. - example: 004223a0-8b17-41b1-bf81-20732adf5590 + format: uuid + description: The phone number lookup request ID from Bandwidth. + example: 004223a0-8b17-41b1-bf81-20732adf5590 tfPhoneNumberPathParam: in: path name: phoneNumber @@ -7651,95 +7802,208 @@ components: type: validation description: 'Invalid answerUrl: only http and https are allowed.' singleNumberRequestExample: - summary: Example Number Lookup Request for One Number + summary: Number Lookup Request value: - tns: - - '+19195551234' + phoneNumbers: + - '+19196104423' multipleNumberRequestExample: - summary: Example Number Lookup Request for Multiple Numbers + summary: Number Lookup Request for Multiple Numbers value: - tns: - - '+19195551234' - - '+19195554321' + phoneNumbers: + - '+19196104423' + - '+19196104424' lookupInProgressExample: - summary: Example Lookup In Progress Response + summary: Numbers Lookup In Progress value: - requestId: 004223a0-8b17-41b1-bf81-20732adf5590 - status: IN_PROGRESS + links: + - href: href + rel: rel + method: GET + data: + requestId: 004223a0-8b17-41b1-bf81-20732adf5590 + status: IN_PROGRESS + results: [] + errors: [] lookupFailedExample: - summary: Example Lookup Failed Response + summary: Numbers Lookup Failed + value: + links: + - href: href + rel: rel + method: GET + data: + requestId: 004223a0-8b17-41b1-bf81-20732adf5590 + status: FAILED + results: [] + errors: + - code: NO-MATCH + description: The following TNs could not be found in the Number Industry data + meta: + phoneNumbers: + - '+13992077164' + message: Invalid TNs + code: 1001 + type: NumberInventory + lookupPartialExample: + summary: Numbers Lookup Partial Complete + value: + links: + - href: href + rel: rel + method: GET + data: + requestId: 004223a0-8b17-41b1-bf81-20732adf5590 + status: PARTIAL_COMPLETE + results: + - phoneNumber: '+19196104423' + lineType: MOBILE + messagingProvider: Verizon Wireless + voiceProvider: Verizon Wireless + countryCodeA3: USA + - phoneNumber: '+19196104424' + lineType: MOBILE + messagingProvider: T-Mobile USA + voiceProvider: T-Mobile USA + countryCodeA3: USA + errors: + - code: NO-MATCH + description: The following TNs could not be found in the Number Industry data + meta: + phoneNumbers: + - '+13992077164' + message: Invalid TNs + code: 1001 + type: NumberInventory + lookupCompleteExample: + summary: Numbers Lookup Complete (without DNI) + value: + links: + - href: href + rel: rel + method: GET + data: + requestId: 004223a0-8b17-41b1-bf81-20732adf5590 + status: COMPLETE + results: + - phoneNumber: '+10072904497' + lineType: MOBILE + messagingProvider: Verizon Wireless + voiceProvider: Verizon Wireless + countryCodeA3: USA + - phoneNumber: '+10072904498' + lineType: MOBILE + messagingProvider: T-Mobile USA + voiceProvider: T-Mobile USA + countryCodeA3: USA + errors: [] + lookupCompleteWithDniExample: + summary: Numbers Lookup Complete (with DNI) value: - requestId: 004223a0-8b17-41b1-bf81-20732adf5590 - status: FAILED - failedTelephoneNumbers: - - '+191955512345' - lookupSingleNumberCompleteExample: - summary: Example Single Number Lookup Complete Response + links: + - href: href + rel: rel + method: GET + data: + requestId: 20732adf-bf81-8b17-41b1-004223a05590 + status: COMPLETE + results: + - phoneNumber: '+10072904497' + countryCodeA3: USA + lineType: MOBILE + messagingProvider: T-MOBILE USA INC + voiceProvider: T-MOBILE USA INC + latestMessageDeliveryStatus: ACTIVE + initialMessageDeliveryStatusDate: '2025-05-14' + latestMessageDeliveryStatusDate: '2025-05-18' + - phoneNumber: '+10072904498' + countryCodeA3: USA + lineType: FIXED + voiceProvider: VERIZON + latestMessageDeliveryStatus: DEACTIVATED + initialMessageDeliveryStatusDate: '2025-09-05' + latestMessageDeliveryStatusDate: '2025-09-05' + - phoneNumber: '+10072904499' + lineType: MOBILE + countryCodeA3: USA + messagingProvider: VERIZON + voiceProvider: VERIZON + deactivationReporter: Verizon Wireless + deactivationDate: '2025-09-29 01:23:00' + deactivationEvent: DEACTIVATED + latestMessageDeliveryStatus: UNKNOWN + errors: [] + badRequestExample: + summary: Example Bad Request Error + value: + links: [] + data: {} + errors: + - type: bad-request + description: >- + Bad Request. Ensure that you have set the requestId as a URL path + parameter. + unauthorizedExample: + summary: Unauthorized Error + value: + links: [] + data: {} + errors: + - type: Unauthorized + description: You are not authorized to access this resource. + code: '1' + page: null + forbiddenExample: + summary: Forbidden Error + value: + links: [] + data: {} + errors: + - type: Forbidden + description: You do not have permission to access this resource. + code: '2' + page: null + unsupportedMediaTypeExample: + summary: Unsupported Media Type Error value: - requestId: 004223a0-8b17-41b1-bf81-20732adf5590 - status: COMPLETE - result: - - Response Code: 0 - Message: NOERROR - E.164 Format: '+19195551234' - Formatted: (919) 555-1234 - Country: US - Line Type: Mobile - Line Provider: Verizon Wireless - Mobile Country Code: '310' - Mobile Network Code: '010' - lookupMultipleNumbersCompleteExample: - summary: Example Multiple Numbers Lookup Complete Response + links: [] + data: {} + errors: + - type: invalid-content-type + description: >- + Invalid content-type. Ensure that your content-type header is set + to application/json. + notFoundExample: + summary: Not Found Error value: - requestId: 004223a0-8b17-41b1-bf81-20732adf5590 - status: COMPLETE - result: - - Response Code: 0 - Message: NOERROR - E.164 Format: '+19195551234' - Formatted: (919) 555-1234 - Country: US - Line Type: Mobile - Line Provider: Verizon Wireless - Mobile Country Code: '310' - Mobile Network Code: '010' - - Response Code: 0 - Message: NOERROR - E.164 Format: '+19195554321' - Formatted: (919) 555-4321 - Country: US - Line Type: Mobile - Line Provider: T-Mobile USA - Mobile Country Code: '310' - Mobile Network Code: '160' - lookupMultipleNumbersPartialCompleteExample: - summary: Example Multiple Numbers Lookup Partial Complete Response + links: [] + data: {} + errors: + - type: not-found + description: >- + RequestId not found. Ensure that the requestId used in the URL + path is valid and maps to a previous request that was submitted. + tooManyRequestsExample: + summary: Too Many Requests Error value: - requestId: 004223a0-8b17-41b1-bf81-20732adf5590 - status: PARTIAL_COMPLETE - result: - - Response Code: 0 - Message: NOERROR - E.164 Format: '+19195551234' - Formatted: (919) 555-1234 - Country: US - Line Type: Mobile - Line Provider: Verizon Wireless - Mobile Country Code: '310' - Mobile Network Code: '010' - failedTelephoneNumbers: - - '+191955512345' - lookupSingleNumberCompleteNoInfoExample: - summary: Example Single Number Lookup Complete with No Information Response + links: [] + data: {} + errors: + - type: rate-limiting + description: >- + Rate limit exceeded. Wait for the time specified in the + Retry-After header before sending another request. + internalServerErrorExample: + summary: Internal Server Error value: - requestId: 004223a0-8b17-41b1-bf81-20732adf5590 - status: COMPLETE - result: - - Response Code: 3 - Message: NXDOMAIN - E.164 Format: '+19195550000' - Formatted: (919) 555-0000 - Country: US + links: [] + data: {} + errors: + - code: '500' + type: unexpected-error + description: >- + Unexpected error. Please contact Bandwidth Support if your + requests are receiving this status code for an extended period of + time. requestBodies: createMessageRequest: content: @@ -8039,18 +8303,28 @@ components: application/json: schema: $ref: '#/components/schemas/verifyCodeRequest' - createLookupRequest: - description: Phone number lookup request. + createSyncLookupRequest: + description: Synchronous phone number lookup request. required: true content: application/json: schema: - $ref: '#/components/schemas/lookupRequest' + $ref: '#/components/schemas/syncLookupRequest' examples: singleNumberRequestExample: $ref: '#/components/examples/singleNumberRequestExample' multipleNumberRequestExample: $ref: '#/components/examples/multipleNumberRequestExample' + createAsyncBulkLookupRequest: + description: Asynchronous bulk phone number lookup request. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/asyncLookupRequest' + examples: + multipleNumberRequestExample: + $ref: '#/components/examples/multipleNumberRequestExample' requestTollFreeVerificationRequest: description: Request for verification of a toll-free phone number. required: true diff --git a/base.ts b/base.ts index 42301da..c8864f5 100644 --- a/base.ts +++ b/base.ts @@ -21,10 +21,6 @@ import globalAxios from 'axios'; export const BASE_PATH = "http://localhost".replace(/\/+$/, ""); -/** - * - * @export - */ export const COLLECTION_FORMATS = { csv: ",", ssv: " ", @@ -32,21 +28,11 @@ export const COLLECTION_FORMATS = { pipes: "|", }; -/** - * - * @export - * @interface RequestArgs - */ export interface RequestArgs { url: string; options: RawAxiosRequestConfig; } -/** - * - * @export - * @class BaseAPI - */ export class BaseAPI { protected configuration: Configuration | undefined; @@ -58,12 +44,6 @@ export class BaseAPI { } }; -/** - * - * @export - * @class RequiredError - * @extends {Error} - */ export class RequiredError extends Error { constructor(public field: string, msg?: string) { super(msg); @@ -78,10 +58,6 @@ interface ServerMap { }[]; } -/** - * - * @export - */ export const operationServerMap: ServerMap = { "CallsApi.createCall": [ { @@ -227,15 +203,21 @@ export const operationServerMap: ServerMap = { description: "Production", } ], - "PhoneNumberLookupApi.createLookup": [ + "PhoneNumberLookupApi.createAsyncBulkLookup": [ + { + url: "https://api.bandwidth.com/v2", + description: "Production", + } + ], + "PhoneNumberLookupApi.createSyncLookup": [ { - url: "https://numbers.bandwidth.com/api/v1", + url: "https://api.bandwidth.com/v2", description: "Production", } ], - "PhoneNumberLookupApi.getLookupStatus": [ + "PhoneNumberLookupApi.getAsyncBulkLookup": [ { - url: "https://numbers.bandwidth.com/api/v1", + url: "https://api.bandwidth.com/v2", description: "Production", } ], diff --git a/common.ts b/common.ts index d79102a..1024bac 100644 --- a/common.ts +++ b/common.ts @@ -12,22 +12,16 @@ * Do not edit the class manually. */ - import type { Configuration } from "./configuration"; import type { RequestArgs } from "./base"; import type { AxiosInstance, AxiosResponse } from 'axios'; import { RequiredError } from "./base"; -/** - * - * @export - */ export const DUMMY_BASE_URL = 'https://example.com' /** * * @throws {RequiredError} - * @export */ export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { if (paramValue === null || paramValue === undefined) { @@ -35,10 +29,6 @@ export const assertParamExists = function (functionName: string, paramName: stri } } -/** - * - * @export - */ export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { if (configuration && configuration.apiKey) { const localVarApiKeyValue = typeof configuration.apiKey === 'function' @@ -48,20 +38,12 @@ export const setApiKeyToObject = async function (object: any, keyParamName: stri } } -/** - * - * @export - */ export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { if (configuration && (configuration.username || configuration.password)) { object["auth"] = { username: configuration.username, password: configuration.password }; } } -/** - * - * @export - */ export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { if (configuration && configuration.accessToken) { const accessToken = typeof configuration.accessToken === 'function' @@ -71,10 +53,6 @@ export const setBearerAuthToObject = async function (object: any, configuration? } } -/** - * - * @export - */ export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { if (configuration && configuration.accessToken) { const localVarAccessTokenValue = typeof configuration.accessToken === 'function' @@ -84,42 +62,35 @@ export const setOAuthToObject = async function (object: any, name: string, scope } } + function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { if (parameter == null) return; if (typeof parameter === "object") { if (Array.isArray(parameter)) { (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); - } + } else { - Object.keys(parameter).forEach(currentKey => + Object.keys(parameter).forEach(currentKey => setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) ); } - } + } else { if (urlSearchParams.has(key)) { urlSearchParams.append(key, parameter); - } + } else { urlSearchParams.set(key, parameter); } } } -/** - * - * @export - */ export const setSearchParams = function (url: URL, ...objects: any[]) { const searchParams = new URLSearchParams(url.search); setFlattenedQueryParams(searchParams, objects); url.search = searchParams.toString(); } -/** - * - * @export - */ export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { const nonString = typeof value !== 'string'; const needsSerialization = nonString && configuration && configuration.isJsonMime @@ -130,18 +101,10 @@ export const serializeDataIfNeeded = function (value: any, requestOptions: any, : (value || ""); } -/** - * - * @export - */ export const toPathString = function (url: URL) { return url.pathname + url.search + url.hash } -/** - * - * @export - */ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { return >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url}; diff --git a/configuration.ts b/configuration.ts index f2c6aa7..25df277 100644 --- a/configuration.ts +++ b/configuration.ts @@ -1,5 +1,4 @@ /* tslint:disable */ -/* eslint-disable */ /** * Bandwidth * Bandwidth\'s Communication APIs @@ -12,12 +11,24 @@ * Do not edit the class manually. */ +interface AWSv4Configuration { + options?: { + region?: string + service?: string + } + credentials?: { + accessKeyId?: string + secretAccessKey?: string, + sessionToken?: string + } +} export interface ConfigurationParameters { apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); username?: string; password?: string; accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + awsv4?: AWSv4Configuration; basePath?: string; serverIndex?: number; baseOptions?: any; @@ -28,49 +39,43 @@ export class Configuration { /** * parameter for apiKey security * @param name security name - * @memberof Configuration */ apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ username?: string; /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ password?: string; /** * parameter for oauth2 security * @param name security name * @param scopes oauth2 scope - * @memberof Configuration */ accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); /** - * override base path - * - * @type {string} + * parameter for aws4 signature security + * @param {Object} AWS4Signature - AWS4 Signature security + * @param {string} options.region - aws region + * @param {string} options.service - name of the service. + * @param {string} credentials.accessKeyId - aws access key id + * @param {string} credentials.secretAccessKey - aws access key + * @param {string} credentials.sessionToken - aws session token * @memberof Configuration */ + awsv4?: AWSv4Configuration; + /** + * override base path + */ basePath?: string; /** * override server index - * - * @type {number} - * @memberof Configuration */ serverIndex?: number; /** * base options for axios calls - * - * @type {any} - * @memberof Configuration */ baseOptions?: any; /** @@ -87,6 +92,7 @@ export class Configuration { this.username = param.username; this.password = param.password; this.accessToken = param.accessToken; + this.awsv4 = param.awsv4; this.basePath = param.basePath; this.serverIndex = param.serverIndex; this.baseOptions = { @@ -94,7 +100,7 @@ export class Configuration { headers: { ...param.baseOptions?.headers, 'User-Agent': "OpenAPI-Generator/1.0.0/typescript-axios" - } + }, }; this.formDataCtor = param.formDataCtor; } diff --git a/custom_templates/README.mustache b/custom_templates/README.mustache index b276d92..95dd080 100644 --- a/custom_templates/README.mustache +++ b/custom_templates/README.mustache @@ -4,10 +4,10 @@ | **OS** | **Node** | |:------------:|:----------:| -| Windows 2019 | 18, 20, 22 | -| Windows 2022 | 18, 20, 22 | -| Ubuntu 22.04 | 18, 20, 22 | -| Ubuntu 24.04 | 18, 20, 22 | +| Windows 2022 | 18, 20, 22, 24 | +| Windows 2025 | 18, 20, 22, 24 | +| Ubuntu 22.04 | 18, 20, 22, 24 | +| Ubuntu 24.04 | 18, 20, 22, 24 | #### Available on NPM ``` @@ -46,7 +46,7 @@ Module system * CommonJS * ES6 module system -It can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via `package.json`. ([Reference](http://www.typescriptlang.org/docs/handbook/typings-for-npm-packages.html)) +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) ### Building @@ -58,7 +58,7 @@ npm run build ### Publishing -First build the package then run ```npm publish``` +First build the package then run `npm publish` ### Consuming @@ -99,3 +99,53 @@ await callsApi.createCall(BW_ACCOUNT_ID, body); ``` More samples can be found in the [Bandwidth Samples](https://github.com/orgs/Bandwidth-Samples/repositories?q=lang%3Ajavascript&type=all) GitHub Organization. + +### Documentation for API Endpoints + +All URIs are relative to *{{{basePath}}}* + +Class | Method | HTTP request | Description +------------ | ------------- | ------------- | ------------- +{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | [**{{operationId}}**]({{apiDocPath}}{{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{path}} | {{summary}} +{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}} + +### Documentation For Models + +{{#models}}{{#model}} - [{{{classname}}}]({{modelDocPath}}{{{classname}}}.md) +{{/model}}{{/models}} + + +## Documentation For Authorization + +{{^authMethods}}Endpoints do not require authorization.{{/authMethods}} +{{#hasAuthMethods}}Authentication schemes defined for the API:{{/hasAuthMethods}} +{{#authMethods}} + +### {{{name}}} + +{{#isApiKey}} +- **Type**: API key +- **API key parameter name**: {{{keyParamName}}} +- **Location**: {{#isKeyInQuery}}URL query string{{/isKeyInQuery}}{{#isKeyInHeader}}HTTP header{{/isKeyInHeader}} +{{/isApiKey}} +{{#isBasic}} +{{#isBasicBasic}} +- **Type**: HTTP basic authentication +{{/isBasicBasic}} +{{#isBasicBearer}} +- **Type**: Bearer authentication{{#bearerFormat}} ({{{.}}}){{/bearerFormat}} +{{/isBasicBearer}} +{{#isHttpSignature}} +- **Type**: HTTP signature authentication +{{/isHttpSignature}} +{{/isBasic}} +{{#isOAuth}} +- **Type**: OAuth +- **Flow**: {{{flow}}} +- **Authorization URL**: {{{authorizationUrl}}} +- **Scopes**: {{^scopes}}N/A{{/scopes}} +{{#scopes}} - **{{{scope}}}**: {{{description}}} +{{/scopes}} +{{/isOAuth}} + +{{/authMethods}} diff --git a/custom_templates/common.mustache b/custom_templates/common.mustache index 1221f35..61054cc 100644 --- a/custom_templates/common.mustache +++ b/custom_templates/common.mustache @@ -2,24 +2,22 @@ /* eslint-disable */ {{>licenseInfo}} -import type { Configuration } from "./configuration"; -import type { RequestArgs } from "./base"; +import type { Configuration } from "./configuration{{importFileExtension}}"; +import type { RequestArgs } from "./base{{importFileExtension}}"; import type { AxiosInstance, AxiosResponse } from 'axios'; -import { RequiredError } from "./base"; +{{#withAWSV4Signature}} +import { aws4Interceptor } from "aws4-axios"; +{{/withAWSV4Signature}} +import { RequiredError } from "./base{{importFileExtension}}"; {{#withNodeImports}} import { URL, URLSearchParams } from 'url'; {{/withNodeImports}} -/** - * - * @export - */ export const DUMMY_BASE_URL = 'https://example.com' /** * * @throws {RequiredError} - * @export */ export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { if (paramValue === null || paramValue === undefined) { @@ -27,10 +25,6 @@ export const assertParamExists = function (functionName: string, paramName: stri } } -/** - * - * @export - */ export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { if (configuration && configuration.apiKey) { const localVarApiKeyValue = typeof configuration.apiKey === 'function' @@ -40,20 +34,12 @@ export const setApiKeyToObject = async function (object: any, keyParamName: stri } } -/** - * - * @export - */ export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { if (configuration && (configuration.username || configuration.password)) { object["auth"] = { username: configuration.username, password: configuration.password }; } } -/** - * - * @export - */ export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { if (configuration && configuration.accessToken) { const accessToken = typeof configuration.accessToken === 'function' @@ -63,10 +49,6 @@ export const setBearerAuthToObject = async function (object: any, configuration? } } -/** - * - * @export - */ export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { if (configuration && configuration.accessToken) { const localVarAccessTokenValue = typeof configuration.accessToken === 'function' @@ -76,42 +58,53 @@ export const setOAuthToObject = async function (object: any, name: string, scope } } +{{#withAWSV4Signature}} +export const setAWS4SignatureInterceptor = async function (globalAxios: AxiosInstance, configuration?: Configuration) { + if (configuration && configuration.awsv4) { + const interceptor = aws4Interceptor({ + options: { + region: configuration.awsv4?.options?.region ?? process.env.AWS_REGION ?? 'us-east-1', + service: configuration.awsv4?.options?.service ?? 'execute-api', + }, + credentials: { + accessKeyId: configuration.awsv4?.credentials?.accessKeyId ?? process.env.AWS_ACCESS_KEY_ID, + secretAccessKey: configuration.awsv4?.credentials?.secretAccessKey ?? process.env.AWS_SECRET_ACCESS_KEY, + sessionToken: configuration.awsv4?.credentials?.sessionToken ?? process.env.AWS_SESSION_TOKEN + }, + }); + globalAxios.interceptors.request.use(interceptor); + } +} +{{/withAWSV4Signature}} + function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { if (parameter == null) return; if (typeof parameter === "object") { if (Array.isArray(parameter)) { (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); - } + } else { - Object.keys(parameter).forEach(currentKey => + Object.keys(parameter).forEach(currentKey => setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) ); } - } + } else { if (urlSearchParams.has(key)) { urlSearchParams.append(key, parameter); - } + } else { urlSearchParams.set(key, parameter); } } } -/** - * - * @export - */ export const setSearchParams = function (url: URL, ...objects: any[]) { const searchParams = new URLSearchParams(url.search); setFlattenedQueryParams(searchParams, objects); url.search = searchParams.toString(); } -/** - * - * @export - */ export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { const nonString = typeof value !== 'string'; const needsSerialization = nonString && configuration && configuration.isJsonMime @@ -122,18 +115,10 @@ export const serializeDataIfNeeded = function (value: any, requestOptions: any, : (value || ""); } -/** - * - * @export - */ export const toPathString = function (url: URL) { return url.pathname + url.search + url.hash } -/** - * - * @export - */ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { return >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url}; diff --git a/custom_templates/configuration.mustache b/custom_templates/configuration.mustache index 0459dda..1f64ab5 100644 --- a/custom_templates/configuration.mustache +++ b/custom_templates/configuration.mustache @@ -1,12 +1,24 @@ /* tslint:disable */ -/* eslint-disable */ {{>licenseInfo}} +interface AWSv4Configuration { + options?: { + region?: string + service?: string + } + credentials?: { + accessKeyId?: string + secretAccessKey?: string, + sessionToken?: string + } +} + export interface ConfigurationParameters { apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); username?: string; password?: string; accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + awsv4?: AWSv4Configuration; basePath?: string; serverIndex?: number; baseOptions?: any; @@ -17,49 +29,43 @@ export class Configuration { /** * parameter for apiKey security * @param name security name - * @memberof Configuration */ apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ username?: string; /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ password?: string; /** * parameter for oauth2 security * @param name security name * @param scopes oauth2 scope - * @memberof Configuration */ accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); /** - * override base path - * - * @type {string} + * parameter for aws4 signature security + * @param {Object} AWS4Signature - AWS4 Signature security + * @param {string} options.region - aws region + * @param {string} options.service - name of the service. + * @param {string} credentials.accessKeyId - aws access key id + * @param {string} credentials.secretAccessKey - aws access key + * @param {string} credentials.sessionToken - aws session token * @memberof Configuration */ + awsv4?: AWSv4Configuration; + /** + * override base path + */ basePath?: string; /** * override server index - * - * @type {number} - * @memberof Configuration */ serverIndex?: number; /** * base options for axios calls - * - * @type {any} - * @memberof Configuration */ baseOptions?: any; /** @@ -76,6 +82,7 @@ export class Configuration { this.username = param.username; this.password = param.password; this.accessToken = param.accessToken; + this.awsv4 = param.awsv4; this.basePath = param.basePath; this.serverIndex = param.serverIndex; this.baseOptions = { @@ -83,7 +90,7 @@ export class Configuration { headers: { ...param.baseOptions?.headers, 'User-Agent': "OpenAPI-Generator{{#npmVersion}}/{{npmVersion}}{{/npmVersion}}/typescript-axios" - } + }, }; this.formDataCtor = param.formDataCtor; } diff --git a/custom_templates/package.mustache b/custom_templates/package.mustache index cd834cd..f1a6d1e 100644 --- a/custom_templates/package.mustache +++ b/custom_templates/package.mustache @@ -22,7 +22,7 @@ "sideEffects": false, {{/supportsES6}} "scripts": { - "build": "tsc {{#supportsES6}}&& tsc -p tsconfig.esm.json{{/supportsES6}}", + "build": "tsc{{#supportsES6}} && tsc -p tsconfig.esm.json{{/supportsES6}}", "prepare": "npm run build", "test-unit": "jest --coverage --detectOpenHandles --testPathPattern=tests/unit", "test-smoke": "jest --coverage --detectOpenHandles --testPathPattern=tests/smoke", diff --git a/docs/TnLookupRequestError.md b/docs/AsyncLookupRequest.md similarity index 56% rename from docs/TnLookupRequestError.md rename to docs/AsyncLookupRequest.md index 0eca6ef..328bca2 100644 --- a/docs/TnLookupRequestError.md +++ b/docs/AsyncLookupRequest.md @@ -1,19 +1,19 @@ -# TnLookupRequestError +# AsyncLookupRequest ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**message** | **string** | A description of what validation error occurred. | [optional] [default to undefined] +**phoneNumbers** | **Array<string>** | Telephone numbers in E.164 format. | [default to undefined] ## Example ```typescript -import { TnLookupRequestError } from 'bandwidth-sdk'; +import { AsyncLookupRequest } from 'bandwidth-sdk'; -const instance: TnLookupRequestError = { - message, +const instance: AsyncLookupRequest = { + phoneNumbers, }; ``` diff --git a/docs/CompletedLookupStatusEnum.md b/docs/CompletedLookupStatusEnum.md new file mode 100644 index 0000000..6bd1d94 --- /dev/null +++ b/docs/CompletedLookupStatusEnum.md @@ -0,0 +1,12 @@ +# CompletedLookupStatusEnum + + +## Enum + +* `Complete` (value: `'COMPLETE'`) + +* `PartialComplete` (value: `'PARTIAL_COMPLETE'`) + +* `Failed` (value: `'FAILED'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CreateAsyncBulkLookupResponse.md b/docs/CreateAsyncBulkLookupResponse.md new file mode 100644 index 0000000..dfce805 --- /dev/null +++ b/docs/CreateAsyncBulkLookupResponse.md @@ -0,0 +1,24 @@ +# CreateAsyncBulkLookupResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**Array<LinkSchema>**](LinkSchema.md) | Links for pagination (if applicable) | [optional] [default to undefined] +**data** | [**CreateAsyncBulkLookupResponseData**](CreateAsyncBulkLookupResponseData.md) | | [optional] [default to undefined] +**errors** | [**Array<LookupErrorSchema>**](LookupErrorSchema.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { CreateAsyncBulkLookupResponse } from 'bandwidth-sdk'; + +const instance: CreateAsyncBulkLookupResponse = { + links, + data, + errors, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CreateLookupResponse.md b/docs/CreateAsyncBulkLookupResponseData.md similarity index 56% rename from docs/CreateLookupResponse.md rename to docs/CreateAsyncBulkLookupResponseData.md index b37c651..3e964a9 100644 --- a/docs/CreateLookupResponse.md +++ b/docs/CreateAsyncBulkLookupResponseData.md @@ -1,20 +1,20 @@ -# CreateLookupResponse +# CreateAsyncBulkLookupResponseData -The request has been accepted for processing but not yet finished and in a terminal state (COMPLETE, PARTIAL_COMPLETE, or FAILED). +The phone number lookup response data ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **requestId** | **string** | The phone number lookup request ID from Bandwidth. | [optional] [default to undefined] -**status** | [**LookupStatusEnum**](LookupStatusEnum.md) | | [optional] [default to undefined] +**status** | [**InProgressLookupStatusEnum**](InProgressLookupStatusEnum.md) | | [optional] [default to undefined] ## Example ```typescript -import { CreateLookupResponse } from 'bandwidth-sdk'; +import { CreateAsyncBulkLookupResponseData } from 'bandwidth-sdk'; -const instance: CreateLookupResponse = { +const instance: CreateAsyncBulkLookupResponseData = { requestId, status, }; diff --git a/docs/CreateSyncLookupResponse.md b/docs/CreateSyncLookupResponse.md new file mode 100644 index 0000000..f12b872 --- /dev/null +++ b/docs/CreateSyncLookupResponse.md @@ -0,0 +1,24 @@ +# CreateSyncLookupResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**Array<LinkSchema>**](LinkSchema.md) | | [optional] [default to undefined] +**data** | [**CreateSyncLookupResponseData**](CreateSyncLookupResponseData.md) | | [optional] [default to undefined] +**errors** | [**Array<LookupErrorSchema>**](LookupErrorSchema.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { CreateSyncLookupResponse } from 'bandwidth-sdk'; + +const instance: CreateSyncLookupResponse = { + links, + data, + errors, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CreateSyncLookupResponseData.md b/docs/CreateSyncLookupResponseData.md new file mode 100644 index 0000000..419f9db --- /dev/null +++ b/docs/CreateSyncLookupResponseData.md @@ -0,0 +1,25 @@ +# CreateSyncLookupResponseData + +The phone number lookup response data + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requestId** | **string** | The phone number lookup request ID from Bandwidth. | [optional] [default to undefined] +**status** | [**CompletedLookupStatusEnum**](CompletedLookupStatusEnum.md) | | [optional] [default to undefined] +**results** | [**Array<LookupResult>**](LookupResult.md) | The carrier information results for the specified telephone numbers. | [optional] [default to undefined] + +## Example + +```typescript +import { CreateSyncLookupResponseData } from 'bandwidth-sdk'; + +const instance: CreateSyncLookupResponseData = { + requestId, + status, + results, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/DeactivationEventEnum.md b/docs/DeactivationEventEnum.md new file mode 100644 index 0000000..bba29d6 --- /dev/null +++ b/docs/DeactivationEventEnum.md @@ -0,0 +1,9 @@ +# DeactivationEventEnum + +[DNI-Only](#section/DNI-Only). `DEACTIVATED` if the carrier reported a deactivation event for this phone number. + +## Enum + +* `Deactivated` (value: `'DEACTIVATED'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/GetAsyncBulkLookupResponse.md b/docs/GetAsyncBulkLookupResponse.md new file mode 100644 index 0000000..4348799 --- /dev/null +++ b/docs/GetAsyncBulkLookupResponse.md @@ -0,0 +1,24 @@ +# GetAsyncBulkLookupResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**Array<LinkSchema>**](LinkSchema.md) | | [optional] [default to undefined] +**data** | [**GetAsyncBulkLookupResponseData**](GetAsyncBulkLookupResponseData.md) | | [optional] [default to undefined] +**errors** | [**Array<LookupErrorSchema>**](LookupErrorSchema.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { GetAsyncBulkLookupResponse } from 'bandwidth-sdk'; + +const instance: GetAsyncBulkLookupResponse = { + links, + data, + errors, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/GetAsyncBulkLookupResponseData.md b/docs/GetAsyncBulkLookupResponseData.md new file mode 100644 index 0000000..653c7f5 --- /dev/null +++ b/docs/GetAsyncBulkLookupResponseData.md @@ -0,0 +1,25 @@ +# GetAsyncBulkLookupResponseData + +The phone number lookup response data + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requestId** | **string** | The phone number lookup request ID from Bandwidth. | [optional] [default to undefined] +**status** | [**InProgressLookupStatusEnum**](InProgressLookupStatusEnum.md) | | [optional] [default to undefined] +**results** | [**Array<LookupResult>**](LookupResult.md) | The carrier information results for the specified telephone number. | [optional] [default to undefined] + +## Example + +```typescript +import { GetAsyncBulkLookupResponseData } from 'bandwidth-sdk'; + +const instance: GetAsyncBulkLookupResponseData = { + requestId, + status, + results, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/LookupStatusEnum.md b/docs/InProgressLookupStatusEnum.md similarity index 77% rename from docs/LookupStatusEnum.md rename to docs/InProgressLookupStatusEnum.md index 144df63..f4e5e09 100644 --- a/docs/LookupStatusEnum.md +++ b/docs/InProgressLookupStatusEnum.md @@ -1,6 +1,5 @@ -# LookupStatusEnum +# InProgressLookupStatusEnum -The status of the request (IN_PROGRESS, COMPLETE, PARTIAL_COMPLETE, or FAILED). ## Enum diff --git a/docs/LatestMessageDeliveryStatusEnum.md b/docs/LatestMessageDeliveryStatusEnum.md new file mode 100644 index 0000000..379a1a1 --- /dev/null +++ b/docs/LatestMessageDeliveryStatusEnum.md @@ -0,0 +1,13 @@ +# LatestMessageDeliveryStatusEnum + +[DNI-Only](#section/DNI-Only). The current delivery status of the phone number. - ACTIVE: A message was successfully sent to the number (delivery code 0). - DEACTIVATED: A message was not delivered to a number (delivery code 720) - UNKNOWN: Bandwidth cannot find an delivery status entry for the number. + +## Enum + +* `Active` (value: `'ACTIVE'`) + +* `Deactivated` (value: `'DEACTIVATED'`) + +* `Unknown` (value: `'UNKNOWN'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/LineTypeEnum.md b/docs/LineTypeEnum.md new file mode 100644 index 0000000..2ebee7a --- /dev/null +++ b/docs/LineTypeEnum.md @@ -0,0 +1,14 @@ +# LineTypeEnum + + +## Enum + +* `Fixed` (value: `'FIXED'`) + +* `VoipFixed` (value: `'VOIP-FIXED'`) + +* `Mobile` (value: `'MOBILE'`) + +* `Voip` (value: `'VOIP'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/LinkSchema.md b/docs/LinkSchema.md new file mode 100644 index 0000000..4a2127e --- /dev/null +++ b/docs/LinkSchema.md @@ -0,0 +1,24 @@ +# LinkSchema + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**href** | **string** | URI of the link. | [optional] [default to undefined] +**rel** | **string** | Specifies the relationship between this link and the resource. | [optional] [default to undefined] +**method** | **string** | HTTP method to be used. | [optional] [default to undefined] + +## Example + +```typescript +import { LinkSchema } from 'bandwidth-sdk'; + +const instance: LinkSchema = { + href, + rel, + method, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/LookupErrorResponse.md b/docs/LookupErrorResponse.md new file mode 100644 index 0000000..bb74b88 --- /dev/null +++ b/docs/LookupErrorResponse.md @@ -0,0 +1,24 @@ +# LookupErrorResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**Array<LinkSchema>**](LinkSchema.md) | | [optional] [default to undefined] +**data** | **object** | The phone number lookup response data | [optional] [default to undefined] +**errors** | [**Array<LookupErrorSchema>**](LookupErrorSchema.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { LookupErrorResponse } from 'bandwidth-sdk'; + +const instance: LookupErrorResponse = { + links, + data, + errors, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/LookupErrorSchema.md b/docs/LookupErrorSchema.md new file mode 100644 index 0000000..38fc625 --- /dev/null +++ b/docs/LookupErrorSchema.md @@ -0,0 +1,26 @@ +# LookupErrorSchema + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **string** | Validation error code | [optional] [default to undefined] +**description** | **string** | Description of validation error | [optional] [default to undefined] +**type** | **string** | Type of validation error | [optional] [default to undefined] +**meta** | [**LookupErrorSchemaMeta**](LookupErrorSchemaMeta.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { LookupErrorSchema } from 'bandwidth-sdk'; + +const instance: LookupErrorSchema = { + code, + description, + type, + meta, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/LookupErrorSchemaMeta.md b/docs/LookupErrorSchemaMeta.md new file mode 100644 index 0000000..3921065 --- /dev/null +++ b/docs/LookupErrorSchemaMeta.md @@ -0,0 +1,24 @@ +# LookupErrorSchemaMeta + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**phoneNumbers** | **Array<string>** | | [optional] [default to undefined] +**message** | **string** | Message describing the error | [optional] [default to undefined] +**code** | **number** | Error code associated with the message | [optional] [default to undefined] + +## Example + +```typescript +import { LookupErrorSchemaMeta } from 'bandwidth-sdk'; + +const instance: LookupErrorSchemaMeta = { + phoneNumbers, + message, + code, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/LookupResult.md b/docs/LookupResult.md index 3072615..2a21931 100644 --- a/docs/LookupResult.md +++ b/docs/LookupResult.md @@ -6,15 +6,17 @@ Carrier information results for the specified telephone number. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Response_Code** | **number** | Our vendor\'s response code. | [optional] [default to undefined] -**Message** | **string** | Message associated with the response code. | [optional] [default to undefined] -**E_164_Format** | **string** | The telephone number in E.164 format. | [optional] [default to undefined] -**Formatted** | **string** | The formatted version of the telephone number. | [optional] [default to undefined] -**Country** | **string** | The country of the telephone number. | [optional] [default to undefined] -**Line_Type** | **string** | The line type of the telephone number. | [optional] [default to undefined] -**Line_Provider** | **string** | The messaging service provider of the telephone number. | [optional] [default to undefined] -**Mobile_Country_Code** | **string** | The first half of the Home Network Identity (HNI). | [optional] [default to undefined] -**Mobile_Network_Code** | **string** | The second half of the HNI. | [optional] [default to undefined] +**phoneNumber** | **string** | The telephone number in E.164 format. | [optional] [default to undefined] +**lineType** | [**LineTypeEnum**](LineTypeEnum.md) | | [optional] [default to undefined] +**messagingProvider** | **string** | The messaging service provider of the telephone number. | [optional] [default to undefined] +**voiceProvider** | **string** | The voice service provider of the telephone number. | [optional] [default to undefined] +**countryCodeA3** | **string** | The country code of the telephone number in ISO 3166-1 alpha-3 format. | [optional] [default to undefined] +**deactivationReporter** | **string** | [DNI-Only](#section/DNI-Only). The carrier that reported a deactivation event for this phone number. | [optional] [default to undefined] +**deactivationDate** | **string** | [DNI-Only](#section/DNI-Only). The datetime the carrier reported a deactivation event. | [optional] [default to undefined] +**deactivationEvent** | [**DeactivationEventEnum**](DeactivationEventEnum.md) | | [optional] [default to undefined] +**latestMessageDeliveryStatus** | [**LatestMessageDeliveryStatusEnum**](LatestMessageDeliveryStatusEnum.md) | | [optional] [default to undefined] +**initialMessageDeliveryStatusDate** | **string** | [DNI-Only](#section/DNI-Only). The date the phone number entered the status described in `latestMessageDeliveryStatus`. Think of this as the \"start time\" for that status. Value resets every time the `latestMessageDeliveryStatus` changes. | [optional] [default to undefined] +**latestMessageDeliveryStatusDate** | **string** | [DNI-Only](#section/DNI-Only). The date bandwidth last received delivery status information for this phone number. Use this field to understand how up-to-date the `latestMessageDeliveryStatus` is. Value resets every time the `latestMessageDeliveryStatus` changes. | [optional] [default to undefined] ## Example @@ -22,15 +24,17 @@ Name | Type | Description | Notes import { LookupResult } from 'bandwidth-sdk'; const instance: LookupResult = { - Response_Code, - Message, - E_164_Format, - Formatted, - Country, - Line_Type, - Line_Provider, - Mobile_Country_Code, - Mobile_Network_Code, + phoneNumber, + lineType, + messagingProvider, + voiceProvider, + countryCodeA3, + deactivationReporter, + deactivationDate, + deactivationEvent, + latestMessageDeliveryStatus, + initialMessageDeliveryStatusDate, + latestMessageDeliveryStatusDate, }; ``` diff --git a/docs/LookupStatus.md b/docs/LookupStatus.md deleted file mode 100644 index 86001a9..0000000 --- a/docs/LookupStatus.md +++ /dev/null @@ -1,27 +0,0 @@ -# LookupStatus - -If requestId exists, the result for that request is returned. See the Examples for details on the various responses that you can receive. Generally, if you see a Response Code of 0 in a result for a TN, information will be available for it. Any other Response Code will indicate no information was available for the TN. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**requestId** | **string** | The requestId. | [optional] [default to undefined] -**status** | [**LookupStatusEnum**](LookupStatusEnum.md) | | [optional] [default to undefined] -**result** | [**Array<LookupResult>**](LookupResult.md) | The carrier information results for the specified telephone number. | [optional] [default to undefined] -**failedTelephoneNumbers** | **Array<string>** | The telephone numbers whose lookup failed. | [optional] [default to undefined] - -## Example - -```typescript -import { LookupStatus } from 'bandwidth-sdk'; - -const instance: LookupStatus = { - requestId, - status, - result, - failedTelephoneNumbers, -}; -``` - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/PhoneNumberLookupApi.md b/docs/PhoneNumberLookupApi.md index ad635d6..e695efe 100644 --- a/docs/PhoneNumberLookupApi.md +++ b/docs/PhoneNumberLookupApi.md @@ -4,13 +4,14 @@ All URIs are relative to *http://localhost* |Method | HTTP request | Description| |------------- | ------------- | -------------| -|[**createLookup**](#createlookup) | **POST** /accounts/{accountId}/tnlookup | Create Lookup| -|[**getLookupStatus**](#getlookupstatus) | **GET** /accounts/{accountId}/tnlookup/{requestId} | Get Lookup Request Status| +|[**createAsyncBulkLookup**](#createasyncbulklookup) | **POST** /accounts/{accountId}/phoneNumberLookup/bulk | Create Asynchronous Bulk Number Lookup| +|[**createSyncLookup**](#createsynclookup) | **POST** /accounts/{accountId}/phoneNumberLookup | Create Synchronous Number Lookup| +|[**getAsyncBulkLookup**](#getasyncbulklookup) | **GET** /accounts/{accountId}/phoneNumberLookup/bulk/{requestId} | Get Asynchronous Bulk Number Lookup| -# **createLookup** -> CreateLookupResponse createLookup(lookupRequest) +# **createAsyncBulkLookup** +> CreateAsyncBulkLookupResponse createAsyncBulkLookup(asyncLookupRequest) -Create a Phone Number Lookup Request. +Creates an asynchronous bulk phone number lookup request. Maximum of 15,000 telephone numbers per request. Use the [Get Asynchronous Bulk Number Lookup](#tag/Phone-Number-Lookup/operation/getAsyncBulkLookup) endpoint to check the status of the request and view the results. ### Example @@ -18,18 +19,18 @@ Create a Phone Number Lookup Request. import { PhoneNumberLookupApi, Configuration, - LookupRequest + AsyncLookupRequest } from 'bandwidth-sdk'; const configuration = new Configuration(); const apiInstance = new PhoneNumberLookupApi(configuration); -let accountId: string; //Your Bandwidth Account ID. (default to undefined) -let lookupRequest: LookupRequest; //Phone number lookup request. +let accountId: string; // (default to undefined) +let asyncLookupRequest: AsyncLookupRequest; //Asynchronous bulk phone number lookup request. -const { status, data } = await apiInstance.createLookup( +const { status, data } = await apiInstance.createAsyncBulkLookup( accountId, - lookupRequest + asyncLookupRequest ); ``` @@ -37,13 +38,13 @@ const { status, data } = await apiInstance.createLookup( |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| -| **lookupRequest** | **LookupRequest**| Phone number lookup request. | | -| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| +| **asyncLookupRequest** | **AsyncLookupRequest**| Asynchronous bulk phone number lookup request. | | +| **accountId** | [**string**] | | defaults to undefined| ### Return type -**CreateLookupResponse** +**CreateAsyncBulkLookupResponse** ### Authorization @@ -59,19 +60,70 @@ const { status, data } = await apiInstance.createLookup( | Status code | Description | Response headers | |-------------|-------------|------------------| |**202** | Accepted | - | -|**400** | Bad Request | - | -|**401** | Unauthorized | - | -|**403** | Forbidden | - | -|**415** | Unsupported Media Type | - | -|**429** | Too Many Requests | - | -|**500** | Internal Server Error | - | +|**0** | Bad Request | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **getLookupStatus** -> LookupStatus getLookupStatus() +# **createSyncLookup** +> CreateSyncLookupResponse createSyncLookup(syncLookupRequest) -Get an existing Phone Number Lookup Request. +Creates a synchronous phone number lookup request. Maximum of 100 telephone numbers per request. + +### Example + +```typescript +import { + PhoneNumberLookupApi, + Configuration, + SyncLookupRequest +} from 'bandwidth-sdk'; + +const configuration = new Configuration(); +const apiInstance = new PhoneNumberLookupApi(configuration); + +let accountId: string; // (default to undefined) +let syncLookupRequest: SyncLookupRequest; //Synchronous phone number lookup request. + +const { status, data } = await apiInstance.createSyncLookup( + accountId, + syncLookupRequest +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **syncLookupRequest** | **SyncLookupRequest**| Synchronous phone number lookup request. | | +| **accountId** | [**string**] | | defaults to undefined| + + +### Return type + +**CreateSyncLookupResponse** + +### Authorization + +[Basic](../README.md#Basic) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | - | +|**0** | Bad Request | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getAsyncBulkLookup** +> GetAsyncBulkLookupResponse getAsyncBulkLookup() + +Get an existing [Asynchronous Bulk Number Lookup](#tag/Phone-Number-Lookup/operation/createAsyncBulkLookup). Use this endpoint to check the status of the request and view the results. ### Example @@ -84,10 +136,10 @@ import { const configuration = new Configuration(); const apiInstance = new PhoneNumberLookupApi(configuration); -let accountId: string; //Your Bandwidth Account ID. (default to undefined) -let requestId: string; //The phone number lookup request ID from Bandwidth. (default to undefined) +let accountId: string; // (default to undefined) +let requestId: string; // (default to undefined) -const { status, data } = await apiInstance.getLookupStatus( +const { status, data } = await apiInstance.getAsyncBulkLookup( accountId, requestId ); @@ -97,13 +149,13 @@ const { status, data } = await apiInstance.getLookupStatus( |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| -| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined| -| **requestId** | [**string**] | The phone number lookup request ID from Bandwidth. | defaults to undefined| +| **accountId** | [**string**] | | defaults to undefined| +| **requestId** | [**string**] | | defaults to undefined| ### Return type -**LookupStatus** +**GetAsyncBulkLookupResponse** ### Authorization @@ -119,12 +171,7 @@ const { status, data } = await apiInstance.getLookupStatus( | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | OK | - | -|**400** | Bad Request | - | -|**401** | Unauthorized | - | -|**403** | Forbidden | - | -|**404** | Not Found | - | -|**429** | Too Many Requests | - | -|**500** | Internal Server Error | - | +|**0** | Bad Request | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/docs/LookupRequest.md b/docs/SyncLookupRequest.md similarity index 57% rename from docs/LookupRequest.md rename to docs/SyncLookupRequest.md index 39fe75e..3619676 100644 --- a/docs/LookupRequest.md +++ b/docs/SyncLookupRequest.md @@ -1,20 +1,19 @@ -# LookupRequest +# SyncLookupRequest -Create phone number lookup request. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**tns** | **Array<string>** | | [default to undefined] +**phoneNumbers** | **Array<string>** | Telephone numbers in E.164 format. | [default to undefined] ## Example ```typescript -import { LookupRequest } from 'bandwidth-sdk'; +import { SyncLookupRequest } from 'bandwidth-sdk'; -const instance: LookupRequest = { - tns, +const instance: SyncLookupRequest = { + phoneNumbers, }; ``` diff --git a/models/account-statistics.ts b/models/account-statistics.ts index cdcb1be..49f8116 100644 --- a/models/account-statistics.ts +++ b/models/account-statistics.ts @@ -14,22 +14,13 @@ -/** - * - * @export - * @interface AccountStatistics - */ export interface AccountStatistics { /** * The number of calls currently enqueued. - * @type {number} - * @memberof AccountStatistics */ 'currentCallQueueSize'?: number; /** * The maximum size of the queue before outgoing calls start being rejected. - * @type {number} - * @memberof AccountStatistics */ 'maxCallQueueSize'?: number; } diff --git a/models/additional-denial-reason.ts b/models/additional-denial-reason.ts index 5836adc..ef77297 100644 --- a/models/additional-denial-reason.ts +++ b/models/additional-denial-reason.ts @@ -14,28 +14,17 @@ -/** - * - * @export - * @interface AdditionalDenialReason - */ export interface AdditionalDenialReason { /** * Reason code for denial. - * @type {number} - * @memberof AdditionalDenialReason */ 'statusCode': number; /** * Explanation for why a verification request was declined. - * @type {string} - * @memberof AdditionalDenialReason */ 'reason': string; /** * Whether a Toll-Free Verification request qualifies for resubmission via PUT. - * @type {boolean} - * @memberof AdditionalDenialReason */ 'resubmitAllowed': boolean; } diff --git a/models/address.ts b/models/address.ts index 369d3a4..e9423cb 100644 --- a/models/address.ts +++ b/models/address.ts @@ -14,52 +14,33 @@ -/** - * - * @export - * @interface Address - */ export interface Address { /** * The name of the business using the toll-free number. - * @type {string} - * @memberof Address */ 'name': string; /** * The address of the business using the toll-free number. - * @type {string} - * @memberof Address */ 'addr1': string; /** * The address of the business using the toll-free number. - * @type {string} - * @memberof Address */ 'addr2'?: string | null; /** * The city of the business using the toll-free number. - * @type {string} - * @memberof Address */ 'city': string; /** * The state of the business using the toll-free number. - * @type {string} - * @memberof Address */ 'state': string; /** * The zip of the business using the toll-free number. - * @type {string} - * @memberof Address */ 'zip': string; /** * The website of the business using the toll-free number. - * @type {string} - * @memberof Address */ 'url': string; } diff --git a/models/answer-callback.ts b/models/answer-callback.ts index 0a1e313..da67333 100644 --- a/models/answer-callback.ts +++ b/models/answer-callback.ts @@ -22,93 +22,57 @@ import type { MachineDetectionResult } from './machine-detection-result'; /** * The Answer event is sent to the answerUrl specified in the createCall request when an outbound call is answered. - * @export - * @interface AnswerCallback */ export interface AnswerCallback { /** * The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. - * @type {string} - * @memberof AnswerCallback */ 'eventType'?: string; /** * The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. - * @type {string} - * @memberof AnswerCallback */ 'eventTime'?: string; /** * The user account associated with the call. - * @type {string} - * @memberof AnswerCallback */ 'accountId'?: string; /** * The id of the application associated with the call. - * @type {string} - * @memberof AnswerCallback */ 'applicationId'?: string; /** * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof AnswerCallback */ 'from'?: string; /** * The phone number that received the call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof AnswerCallback */ 'to'?: string; - /** - * - * @type {CallDirectionEnum} - * @memberof AnswerCallback - */ 'direction'?: CallDirectionEnum; /** * The call id associated with the event. - * @type {string} - * @memberof AnswerCallback */ 'callId'?: string; /** * The URL of the call associated with the event. - * @type {string} - * @memberof AnswerCallback */ 'callUrl'?: string; /** * (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. - * @type {string} - * @memberof AnswerCallback */ 'enqueuedTime'?: string | null; /** * Time the call was started, in ISO 8601 format. - * @type {string} - * @memberof AnswerCallback */ 'startTime'?: string; /** * Time the call was answered, in ISO 8601 format. - * @type {string} - * @memberof AnswerCallback */ 'answerTime'?: string | null; /** * (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. - * @type {string} - * @memberof AnswerCallback */ 'tag'?: string | null; - /** - * - * @type {MachineDetectionResult} - * @memberof AnswerCallback - */ 'machineDetectionResult'?: MachineDetectionResult | null; } diff --git a/models/lookup-request.ts b/models/async-lookup-request.ts similarity index 63% rename from models/lookup-request.ts rename to models/async-lookup-request.ts index 907a426..eee2cdf 100644 --- a/models/lookup-request.ts +++ b/models/async-lookup-request.ts @@ -14,17 +14,10 @@ -/** - * Create phone number lookup request. - * @export - * @interface LookupRequest - */ -export interface LookupRequest { +export interface AsyncLookupRequest { /** - * - * @type {Array} - * @memberof LookupRequest + * Telephone numbers in E.164 format. */ - 'tns': Array; + 'phoneNumbers': Array; } diff --git a/models/blocked-webhook.ts b/models/blocked-webhook.ts index 9259540..2c42a1b 100644 --- a/models/blocked-webhook.ts +++ b/models/blocked-webhook.ts @@ -17,46 +17,26 @@ // @ts-ignore import type { TfvCallbackStatusEnum } from './tfv-callback-status-enum'; -/** - * - * @export - * @interface BlockedWebhook - */ export interface BlockedWebhook { /** * User\'s account ID. - * @type {string} - * @memberof BlockedWebhook */ 'accountId'?: string; /** * Toll-free telephone number in E.164 format. - * @type {string} - * @memberof BlockedWebhook */ 'phoneNumber'?: string; - /** - * - * @type {TfvCallbackStatusEnum} - * @memberof BlockedWebhook - */ 'status'?: TfvCallbackStatusEnum; /** * Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number. - * @type {string} - * @memberof BlockedWebhook */ 'internalTicketNumber'?: string; /** * Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. - * @type {boolean} - * @memberof BlockedWebhook */ 'blocked'?: boolean; /** * The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. - * @type {string} - * @memberof BlockedWebhook */ 'blockedReason'?: string; } diff --git a/models/bridge-complete-callback.ts b/models/bridge-complete-callback.ts index 125ae97..89c36b9 100644 --- a/models/bridge-complete-callback.ts +++ b/models/bridge-complete-callback.ts @@ -19,104 +19,67 @@ import type { CallDirectionEnum } from './call-direction-enum'; /** * If the target call leaves the , then this callback is sent to the bridgeCompleteUrl, and the BXML returned in it is executed on the call. If this webhook is sent, the Bridge Target Complete webhook is NOT sent. This callback is also sent if any problem occurs that prevents the calls to be bridged. - * @export - * @interface BridgeCompleteCallback */ export interface BridgeCompleteCallback { /** * The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. - * @type {string} - * @memberof BridgeCompleteCallback */ 'eventType'?: string; /** * The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. - * @type {string} - * @memberof BridgeCompleteCallback */ 'eventTime'?: string; /** * The user account associated with the call. - * @type {string} - * @memberof BridgeCompleteCallback */ 'accountId'?: string; /** * The id of the application associated with the call. - * @type {string} - * @memberof BridgeCompleteCallback */ 'applicationId'?: string; /** * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof BridgeCompleteCallback */ 'from'?: string; /** * The phone number that received the call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof BridgeCompleteCallback */ 'to'?: string; - /** - * - * @type {CallDirectionEnum} - * @memberof BridgeCompleteCallback - */ 'direction'?: CallDirectionEnum; /** * The call id associated with the event. - * @type {string} - * @memberof BridgeCompleteCallback */ 'callId'?: string; /** * The URL of the call associated with the event. - * @type {string} - * @memberof BridgeCompleteCallback */ 'callUrl'?: string; /** * (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. - * @type {string} - * @memberof BridgeCompleteCallback */ 'enqueuedTime'?: string | null; /** * Time the call was started, in ISO 8601 format. - * @type {string} - * @memberof BridgeCompleteCallback */ 'startTime'?: string; /** * Time the call was answered, in ISO 8601 format. - * @type {string} - * @memberof BridgeCompleteCallback */ 'answerTime'?: string | null; /** * (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. - * @type {string} - * @memberof BridgeCompleteCallback */ 'tag'?: string | null; /** * Reason the call failed - hangup, busy, timeout, cancel, rejected, callback-error, invalid-bxml, application-error, account-limit, node-capacity-exceeded, error, or unknown. - * @type {string} - * @memberof BridgeCompleteCallback */ 'cause'?: string; /** * Text explaining the reason that caused the call to fail in case of errors. - * @type {string} - * @memberof BridgeCompleteCallback */ 'errorMessage'?: string | null; /** * Bandwidth\'s internal id that references the error event. - * @type {string} - * @memberof BridgeCompleteCallback */ 'errorId'?: string | null; } diff --git a/models/bridge-target-complete-callback.ts b/models/bridge-target-complete-callback.ts index 78a92f5..54ca3f2 100644 --- a/models/bridge-target-complete-callback.ts +++ b/models/bridge-target-complete-callback.ts @@ -19,86 +19,55 @@ import type { CallDirectionEnum } from './call-direction-enum'; /** * If the originating call leaves the , then this callback is sent to the bridgeTargetCompleteUrl, and the BXML returned in it is executed on the target call. If this webhook is sent, the Bridge Complete webhook is NOT sent. - * @export - * @interface BridgeTargetCompleteCallback */ export interface BridgeTargetCompleteCallback { /** * The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. - * @type {string} - * @memberof BridgeTargetCompleteCallback */ 'eventType'?: string; /** * The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. - * @type {string} - * @memberof BridgeTargetCompleteCallback */ 'eventTime'?: string; /** * The user account associated with the call. - * @type {string} - * @memberof BridgeTargetCompleteCallback */ 'accountId'?: string; /** * The id of the application associated with the call. - * @type {string} - * @memberof BridgeTargetCompleteCallback */ 'applicationId'?: string; /** * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof BridgeTargetCompleteCallback */ 'from'?: string; /** * The phone number that received the call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof BridgeTargetCompleteCallback */ 'to'?: string; - /** - * - * @type {CallDirectionEnum} - * @memberof BridgeTargetCompleteCallback - */ 'direction'?: CallDirectionEnum; /** * The call id associated with the event. - * @type {string} - * @memberof BridgeTargetCompleteCallback */ 'callId'?: string; /** * The URL of the call associated with the event. - * @type {string} - * @memberof BridgeTargetCompleteCallback */ 'callUrl'?: string; /** * (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. - * @type {string} - * @memberof BridgeTargetCompleteCallback */ 'enqueuedTime'?: string | null; /** * Time the call was started, in ISO 8601 format. - * @type {string} - * @memberof BridgeTargetCompleteCallback */ 'startTime'?: string; /** * Time the call was answered, in ISO 8601 format. - * @type {string} - * @memberof BridgeTargetCompleteCallback */ 'answerTime'?: string | null; /** * (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. - * @type {string} - * @memberof BridgeTargetCompleteCallback */ 'tag'?: string | null; } diff --git a/models/business-entity-type-enum.ts b/models/business-entity-type-enum.ts index 074ef54..5ec96c1 100644 --- a/models/business-entity-type-enum.ts +++ b/models/business-entity-type-enum.ts @@ -16,8 +16,6 @@ /** * The type of registered business. If no option is applicable, please provide \"SOLE_PROPRIETOR\" as a value. Optional until early 2026; required if `businessRegistrationNumber` is provided. Available starting October 1st, 2025. - * @export - * @enum {string} */ export const BusinessEntityTypeEnum = { diff --git a/models/business-registration-type-enum.ts b/models/business-registration-type-enum.ts index df314b6..8e81226 100644 --- a/models/business-registration-type-enum.ts +++ b/models/business-registration-type-enum.ts @@ -16,8 +16,6 @@ /** * The type of business registration number. Optional until early 2026; required if `businessRegistrationNumber` is provided. Available starting October 1st, 2025. - * @export - * @enum {string} */ export const BusinessRegistrationTypeEnum = { diff --git a/models/call-direction-enum.ts b/models/call-direction-enum.ts index 9d33c16..9e9fae2 100644 --- a/models/call-direction-enum.ts +++ b/models/call-direction-enum.ts @@ -16,8 +16,6 @@ /** * The direction of the call. - * @export - * @enum {string} */ export const CallDirectionEnum = { diff --git a/models/call-recording-metadata.ts b/models/call-recording-metadata.ts index a0cf258..9d45bc3 100644 --- a/models/call-recording-metadata.ts +++ b/models/call-recording-metadata.ts @@ -23,124 +23,72 @@ import type { FileFormatEnum } from './file-format-enum'; // @ts-ignore import type { RecordingTranscriptionMetadata } from './recording-transcription-metadata'; -/** - * - * @export - * @interface CallRecordingMetadata - */ export interface CallRecordingMetadata { /** * The id of the application associated with the call. - * @type {string} - * @memberof CallRecordingMetadata */ 'applicationId'?: string; /** * The user account associated with the call. - * @type {string} - * @memberof CallRecordingMetadata */ 'accountId'?: string; /** * The call id associated with the event. - * @type {string} - * @memberof CallRecordingMetadata */ 'callId'?: string; /** * (optional) If the event is related to the B leg of a , the call id of the original call leg that executed the . Otherwise, this field will not be present. - * @type {string} - * @memberof CallRecordingMetadata */ 'parentCallId'?: string; /** * The unique ID of this recording - * @type {string} - * @memberof CallRecordingMetadata */ 'recordingId'?: string; /** * The phone number that received the call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof CallRecordingMetadata */ 'to'?: string; /** * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof CallRecordingMetadata */ 'from'?: string; /** * The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof CallRecordingMetadata */ 'transferCallerId'?: string; /** * The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof CallRecordingMetadata */ 'transferTo'?: string; /** * The duration of the recording in ISO-8601 format - * @type {string} - * @memberof CallRecordingMetadata */ 'duration'?: string; - /** - * - * @type {CallDirectionEnum} - * @memberof CallRecordingMetadata - */ 'direction'?: CallDirectionEnum; /** * Always `1` for conference recordings; multi-channel recordings are not supported on conferences. - * @type {number} - * @memberof CallRecordingMetadata */ 'channels'?: number; /** * Time the call was started, in ISO 8601 format. - * @type {string} - * @memberof CallRecordingMetadata */ 'startTime'?: string; /** * The time that the recording ended in ISO-8601 format - * @type {string} - * @memberof CallRecordingMetadata */ 'endTime'?: string; - /** - * - * @type {FileFormatEnum} - * @memberof CallRecordingMetadata - */ 'fileFormat'?: FileFormatEnum; /** * The current status of the process. For recording, current possible values are \'processing\', \'partial\', \'complete\', \'deleted\', and \'error\'. For transcriptions, current possible values are \'none\', \'processing\', \'available\', \'error\', \'timeout\', \'file-size-too-big\', and \'file-size-too-small\'. Additional states may be added in the future, so your application must be tolerant of unknown values. - * @type {string} - * @memberof CallRecordingMetadata */ 'status'?: string; /** * The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded. - * @type {string} - * @memberof CallRecordingMetadata */ 'mediaUrl'?: string | null; - /** - * - * @type {RecordingTranscriptionMetadata} - * @memberof CallRecordingMetadata - */ 'transcription'?: RecordingTranscriptionMetadata | null; /** * A name to identify this recording. - * @type {string} - * @memberof CallRecordingMetadata */ 'recordingName'?: string; } diff --git a/models/call-state-enum.ts b/models/call-state-enum.ts index 5584099..3a07d4f 100644 --- a/models/call-state-enum.ts +++ b/models/call-state-enum.ts @@ -16,8 +16,6 @@ /** * The call state. Possible values:
`active` to redirect the call (default)
`completed` to hang up the call if it is answered, cancel it if it is an unanswered outbound call, or reject it if it an unanswered inbound call - * @export - * @enum {string} */ export const CallStateEnum = { diff --git a/models/call-state.ts b/models/call-state.ts index 6451295..44d80d3 100644 --- a/models/call-state.ts +++ b/models/call-state.ts @@ -17,118 +17,74 @@ // @ts-ignore import type { CallDirectionEnum } from './call-direction-enum'; -/** - * - * @export - * @interface CallState - */ export interface CallState { /** * The application id associated with the call. - * @type {string} - * @memberof CallState */ 'applicationId'?: string; /** * The account id associated with the call. - * @type {string} - * @memberof CallState */ 'accountId'?: string; /** * The programmable voice API call ID. - * @type {string} - * @memberof CallState */ 'callId'?: string; /** * The A-leg call id, set only if this call is the B-leg of a [``](/docs/voice/bxml/transfer). - * @type {string} - * @memberof CallState */ 'parentCallId'?: string | null; /** * The phone number that received the call, in E.164 format (e.g. +15555555555), or if the call was to a SIP URI, the SIP URI. - * @type {string} - * @memberof CallState */ 'to'?: string; /** * The phone number that made the call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof CallState */ 'from'?: string; - /** - * - * @type {CallDirectionEnum} - * @memberof CallState - */ 'direction'?: CallDirectionEnum; /** * The current state of the call. Current possible values are `queued`, `initiated`, `answered` and `disconnected`. Additional states may be added in the future, so your application must be tolerant of unknown values. - * @type {string} - * @memberof CallState */ 'state'?: string; /** * For inbound calls, the Bandwidth STIR/SHAKEN implementation will verify the information provided in the inbound invite request `Identity` header. The verification status is stored in the call state `stirShaken` property as follows. | Property | Description | |:------------------|:------------| | verstat | (optional) The verification status indicating whether the verification was successful or not. Possible values are `TN-Validation-Passed` or `TN-Validation-Failed`. | | attestationIndicator | (optional) The attestation level verified by Bandwidth. Possible values are `A` (full), `B` (partial) or `C` (gateway). | | originatingId | (optional) A unique origination identifier. | Note that these are common properties but that the `stirShaken` object is free form and can contain other key-value pairs. More information: [Understanding STIR/SHAKEN](https://www.bandwidth.com/regulations/stir-shaken). - * @type {{ [key: string]: string; }} - * @memberof CallState */ 'stirShaken'?: { [key: string]: string; } | null; /** * The value of the `Identity` header from the inbound invite request. Only present for inbound calls and if the account is configured to forward this header. - * @type {string} - * @memberof CallState */ 'identity'?: string | null; /** * The time this call was placed in queue. - * @type {string} - * @memberof CallState */ 'enqueuedTime'?: string | null; /** * The time the call was initiated, in ISO 8601 format. `null` if the call is still in your queue. - * @type {string} - * @memberof CallState */ 'startTime'?: string | null; /** * Populated once the call has been answered, with the time in ISO 8601 format. - * @type {string} - * @memberof CallState */ 'answerTime'?: string | null; /** * Populated once the call has ended, with the time in ISO 8601 format. - * @type {string} - * @memberof CallState */ 'endTime'?: string | null; /** * | Cause | Description | |:------|:------------| | `hangup`| One party hung up the call, a [``](../../bxml/verbs/hangup.md) verb was executed, or there was no more BXML to execute; it indicates that the call ended normally. | | `busy` | Callee was busy. | | `timeout` | Call wasn\'t answered before the `callTimeout` was reached. | | `cancel` | Call was cancelled by its originator while it was ringing. | | `rejected` | Call was rejected by the callee. | | `callback-error` | BXML callback couldn\'t be delivered to your callback server. | | `invalid-bxml` | Invalid BXML was returned in response to a callback. | | `application-error` | An unsupported action was tried on the call, e.g. trying to play a .ogg audio. | | `account-limit` | Account rate limits were reached. | | `node-capacity-exceeded` | System maximum capacity was reached. | | `error` | Some error not described in any of the other causes happened on the call. | | `unknown` | Unknown error happened on the call. | Note: This list is not exhaustive and other values can appear in the future. - * @type {string} - * @memberof CallState */ 'disconnectCause'?: string | null; /** * Populated only if the call ended with an error, with text explaining the reason. - * @type {string} - * @memberof CallState */ 'errorMessage'?: string | null; /** * Populated only if the call ended with an error, with a Bandwidth internal id that references the error event. - * @type {string} - * @memberof CallState */ 'errorId'?: string | null; /** * The last time the call had a state update, in ISO 8601 format. - * @type {string} - * @memberof CallState */ 'lastUpdate'?: string; } diff --git a/models/call-transcription-detected-language-enum.ts b/models/call-transcription-detected-language-enum.ts index 41e6006..5fdcdbf 100644 --- a/models/call-transcription-detected-language-enum.ts +++ b/models/call-transcription-detected-language-enum.ts @@ -16,8 +16,6 @@ /** * The detected language for this transcription. - * @export - * @enum {string} */ export const CallTranscriptionDetectedLanguageEnum = { diff --git a/models/call-transcription-metadata.ts b/models/call-transcription-metadata.ts index 931a52c..c85e49d 100644 --- a/models/call-transcription-metadata.ts +++ b/models/call-transcription-metadata.ts @@ -14,28 +14,17 @@ -/** - * - * @export - * @interface CallTranscriptionMetadata - */ export interface CallTranscriptionMetadata { /** * The programmable voice API transcription ID. - * @type {string} - * @memberof CallTranscriptionMetadata */ 'transcriptionId'?: string; /** * The programmable voice API transcription name. This name could be provided by the user when creating the transcription. - * @type {string} - * @memberof CallTranscriptionMetadata */ 'transcriptionName'?: string; /** * A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice-apis/voice/#tag/Transcriptions/operation/getRealTimeTranscription) endpoint. - * @type {string} - * @memberof CallTranscriptionMetadata */ 'transcriptionUrl'?: string; } diff --git a/models/call-transcription-response.ts b/models/call-transcription-response.ts index 1e5b8fb..0b37be0 100644 --- a/models/call-transcription-response.ts +++ b/models/call-transcription-response.ts @@ -17,35 +17,19 @@ // @ts-ignore import type { CallTranscription } from './call-transcription'; -/** - * - * @export - * @interface CallTranscriptionResponse - */ export interface CallTranscriptionResponse { /** * The user account associated with the call. - * @type {string} - * @memberof CallTranscriptionResponse */ 'accountId'?: string; /** * The call id associated with the event. - * @type {string} - * @memberof CallTranscriptionResponse */ 'callId'?: string; /** * The programmable voice API transcription ID. - * @type {string} - * @memberof CallTranscriptionResponse */ 'transcriptionId'?: string; - /** - * - * @type {Array} - * @memberof CallTranscriptionResponse - */ 'tracks'?: Array; } diff --git a/models/call-transcription-track-enum.ts b/models/call-transcription-track-enum.ts index 33c32b0..3299f7b 100644 --- a/models/call-transcription-track-enum.ts +++ b/models/call-transcription-track-enum.ts @@ -16,8 +16,6 @@ /** * Which `track` this transcription is derived from. - * @export - * @enum {string} */ export const CallTranscriptionTrackEnum = { diff --git a/models/call-transcription.ts b/models/call-transcription.ts index 230edc9..39bcf8d 100644 --- a/models/call-transcription.ts +++ b/models/call-transcription.ts @@ -20,34 +20,15 @@ import type { CallTranscriptionDetectedLanguageEnum } from './call-transcription // @ts-ignore import type { CallTranscriptionTrackEnum } from './call-transcription-track-enum'; -/** - * - * @export - * @interface CallTranscription - */ export interface CallTranscription { - /** - * - * @type {CallTranscriptionDetectedLanguageEnum} - * @memberof CallTranscription - */ 'detectedLanguage'?: CallTranscriptionDetectedLanguageEnum; - /** - * - * @type {CallTranscriptionTrackEnum} - * @memberof CallTranscription - */ 'track'?: CallTranscriptionTrackEnum; /** * The transcription itself. - * @type {string} - * @memberof CallTranscription */ 'transcript'?: string; /** * How confident the transcription engine was in transcribing the associated audio (from `0` to `1`). - * @type {number} - * @memberof CallTranscription */ 'confidence'?: number; } diff --git a/models/callback-method-enum.ts b/models/callback-method-enum.ts index 17aa746..abed4ba 100644 --- a/models/callback-method-enum.ts +++ b/models/callback-method-enum.ts @@ -16,8 +16,6 @@ /** * The HTTP method to use to deliver the callback. GET or POST. Default value is POST. - * @export - * @enum {string} */ export const CallbackMethodEnum = { diff --git a/models/callback.ts b/models/callback.ts index 683a7c1..4f9c2a8 100644 --- a/models/callback.ts +++ b/models/callback.ts @@ -29,7 +29,6 @@ import type { StatusCallback } from './status-callback'; /** * @type Callback * Callbacks are divided into two types based on direction of the related message: - `statusCallback` indicates status of an outbound MT SMS, MMS, or RBM message. - `inboundCallback` indicates an inbound MO message or a multichannel message client\'s response to a suggestion or location request. - * @export */ export type Callback = { type: 'message-delivered' } & StatusCallback | { type: 'message-failed' } & StatusCallback | { type: 'message-read' } & StatusCallback | { type: 'message-received' } & InboundCallback | { type: 'message-sent' } & StatusCallback | { type: 'request-location-response' } & InboundCallback | { type: 'suggestion-response' } & InboundCallback; diff --git a/models/card-width-enum.ts b/models/card-width-enum.ts index 24b407d..6c5967a 100644 --- a/models/card-width-enum.ts +++ b/models/card-width-enum.ts @@ -14,11 +14,6 @@ -/** - * - * @export - * @enum {string} - */ export const CardWidthEnum = { Small: 'SMALL', diff --git a/models/code-request.ts b/models/code-request.ts index f88da33..b851078 100644 --- a/models/code-request.ts +++ b/models/code-request.ts @@ -14,46 +14,29 @@ -/** - * - * @export - * @interface CodeRequest - */ export interface CodeRequest { /** * The phone number to send the mfa code to. - * @type {string} - * @memberof CodeRequest */ 'to': string; /** * The application phone number, the sender of the mfa code. - * @type {string} - * @memberof CodeRequest */ 'from': string; /** * The application unique ID, obtained from Bandwidth. - * @type {string} - * @memberof CodeRequest */ 'applicationId': string; /** * An optional field to denote what scope or action the mfa code is addressing. If not supplied, defaults to \"2FA\". - * @type {string} - * @memberof CodeRequest */ 'scope'?: string; /** * The message format of the mfa code. There are three values that the system will replace \"{CODE}\", \"{NAME}\", \"{SCOPE}\". The \"{SCOPE}\" and \"{NAME} value template are optional, while \"{CODE}\" must be supplied. As the name would suggest, code will be replace with the actual mfa code. Name is replaced with the application name, configured during provisioning of mfa. The scope value is the same value sent during the call and partitioned by the server. - * @type {string} - * @memberof CodeRequest */ 'message': string; /** * The number of digits for your mfa code. The valid number ranges from 2 to 8, inclusively. - * @type {number} - * @memberof CodeRequest */ 'digits': number; } diff --git a/models/completed-lookup-status-enum.ts b/models/completed-lookup-status-enum.ts new file mode 100644 index 0000000..0380fbf --- /dev/null +++ b/models/completed-lookup-status-enum.ts @@ -0,0 +1,27 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Bandwidth + * Bandwidth\'s Communication APIs + * + * The version of the OpenAPI document: 1.0.0 + * Contact: letstalk@bandwidth.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + + +export const CompletedLookupStatusEnum = { + Complete: 'COMPLETE', + PartialComplete: 'PARTIAL_COMPLETE', + Failed: 'FAILED' +} as const; + +export type CompletedLookupStatusEnum = typeof CompletedLookupStatusEnum[keyof typeof CompletedLookupStatusEnum]; + + + diff --git a/models/conference-completed-callback.ts b/models/conference-completed-callback.ts index 30eb869..224ce2a 100644 --- a/models/conference-completed-callback.ts +++ b/models/conference-completed-callback.ts @@ -16,38 +16,26 @@ /** * The Conference Completed event is fired when the last member leaves the conference. The response to this event may not contain BXML. - * @export - * @interface ConferenceCompletedCallback */ export interface ConferenceCompletedCallback { /** * The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. - * @type {string} - * @memberof ConferenceCompletedCallback */ 'eventType'?: string; /** * The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. - * @type {string} - * @memberof ConferenceCompletedCallback */ 'eventTime'?: string; /** * The unique, Bandwidth-generated ID of the conference that was recorded - * @type {string} - * @memberof ConferenceCompletedCallback */ 'conferenceId'?: string; /** * The user-specified name of the conference that was recorded - * @type {string} - * @memberof ConferenceCompletedCallback */ 'name'?: string; /** * (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. - * @type {string} - * @memberof ConferenceCompletedCallback */ 'tag'?: string | null; } diff --git a/models/conference-created-callback.ts b/models/conference-created-callback.ts index 1ff258f..1a8cf8a 100644 --- a/models/conference-created-callback.ts +++ b/models/conference-created-callback.ts @@ -16,38 +16,26 @@ /** * The Conference Created event is fired whenever a new conference that specified a callbackUrl is created. The response may be either empty or a BXML document. Only the following verbs are valid for conferences: PlayAudio, SpeakSentence, StartRecording, StopRecording, PauseRecording, ResumeRecording. Audio verbs will be heard by all members of the conference. Recordings capture audio from all members who are not muted or on hold, as well as any audio verbs that are played into the conference. - * @export - * @interface ConferenceCreatedCallback */ export interface ConferenceCreatedCallback { /** * The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. - * @type {string} - * @memberof ConferenceCreatedCallback */ 'eventType'?: string; /** * The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. - * @type {string} - * @memberof ConferenceCreatedCallback */ 'eventTime'?: string; /** * The unique, Bandwidth-generated ID of the conference that was recorded - * @type {string} - * @memberof ConferenceCreatedCallback */ 'conferenceId'?: string; /** * The user-specified name of the conference that was recorded - * @type {string} - * @memberof ConferenceCreatedCallback */ 'name'?: string; /** * (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. - * @type {string} - * @memberof ConferenceCreatedCallback */ 'tag'?: string | null; } diff --git a/models/conference-member-exit-callback.ts b/models/conference-member-exit-callback.ts index e2f807a..8f4636a 100644 --- a/models/conference-member-exit-callback.ts +++ b/models/conference-member-exit-callback.ts @@ -16,56 +16,38 @@ /** * The Conference Member Exit event is fired whenever a caller exits a conference that specified a callbackUrl. The response may be either empty or a BXML document. Only the following verbs are valid for conferences: PlayAudio, SpeakSentence, StartRecording, StopRecording, PauseRecording, ResumeRecording. Audio verbs will be heard by all members of the conference. Recordings capture audio from all members who are not muted or on hold, as well as any audio verbs that are played into the conference. - * @export - * @interface ConferenceMemberExitCallback */ export interface ConferenceMemberExitCallback { /** * The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. - * @type {string} - * @memberof ConferenceMemberExitCallback */ 'eventType'?: string; /** * The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. - * @type {string} - * @memberof ConferenceMemberExitCallback */ 'eventTime'?: string; /** * The unique, Bandwidth-generated ID of the conference that was recorded - * @type {string} - * @memberof ConferenceMemberExitCallback */ 'conferenceId'?: string; /** * The user-specified name of the conference that was recorded - * @type {string} - * @memberof ConferenceMemberExitCallback */ 'name'?: string; /** * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof ConferenceMemberExitCallback */ 'from'?: string; /** * The phone number that received the call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof ConferenceMemberExitCallback */ 'to'?: string; /** * The call id associated with the event. - * @type {string} - * @memberof ConferenceMemberExitCallback */ 'callId'?: string; /** * (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. - * @type {string} - * @memberof ConferenceMemberExitCallback */ 'tag'?: string | null; } diff --git a/models/conference-member-join-callback.ts b/models/conference-member-join-callback.ts index 5a1c19d..d14ab37 100644 --- a/models/conference-member-join-callback.ts +++ b/models/conference-member-join-callback.ts @@ -16,56 +16,38 @@ /** * The Conference Member Join event is fired whenever a caller joins a conference that specified a callbackUrl. The response may be either empty or a BXML document. Only the following verbs are valid for conferences: PlayAudio, SpeakSentence, StartRecording, StopRecording, PauseRecording, ResumeRecording. Audio verbs will be heard by all members of the conference. Recordings capture audio from all members who are not muted or on hold, as well as any audio verbs that are played into the conference. - * @export - * @interface ConferenceMemberJoinCallback */ export interface ConferenceMemberJoinCallback { /** * The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. - * @type {string} - * @memberof ConferenceMemberJoinCallback */ 'eventType'?: string; /** * The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. - * @type {string} - * @memberof ConferenceMemberJoinCallback */ 'eventTime'?: string; /** * The unique, Bandwidth-generated ID of the conference that was recorded - * @type {string} - * @memberof ConferenceMemberJoinCallback */ 'conferenceId'?: string; /** * The user-specified name of the conference that was recorded - * @type {string} - * @memberof ConferenceMemberJoinCallback */ 'name'?: string; /** * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof ConferenceMemberJoinCallback */ 'from'?: string; /** * The phone number that received the call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof ConferenceMemberJoinCallback */ 'to'?: string; /** * The call id associated with the event. - * @type {string} - * @memberof ConferenceMemberJoinCallback */ 'callId'?: string; /** * (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. - * @type {string} - * @memberof ConferenceMemberJoinCallback */ 'tag'?: string | null; } diff --git a/models/conference-member.ts b/models/conference-member.ts index 03e988b..162ffe2 100644 --- a/models/conference-member.ts +++ b/models/conference-member.ts @@ -14,46 +14,29 @@ -/** - * - * @export - * @interface ConferenceMember - */ export interface ConferenceMember { /** * The call id associated with the event. - * @type {string} - * @memberof ConferenceMember */ 'callId'?: string; /** * The unique, Bandwidth-generated ID of the conference that was recorded - * @type {string} - * @memberof ConferenceMember */ 'conferenceId'?: string; /** * A URL that may be used to retrieve information about or update the state of this conference member. This is the URL of this member\'s [Get Conference Member](/apis/voice-apis/voice/#tag/Conferences/operation/getConferenceMember) endpoint and [Modify Conference Member](/apis/voice-apis/voice/#tag/Conferences/operation/updateConferenceMember) endpoint. - * @type {string} - * @memberof ConferenceMember */ 'memberUrl'?: string; /** * Whether or not this member is currently muted. Members who are muted are still able to hear other participants. If used in a PUT request, updates this member\'s mute status. Has no effect if omitted. - * @type {boolean} - * @memberof ConferenceMember */ 'mute'?: boolean; /** * Whether or not this member is currently on hold. Members who are on hold are not able to hear or speak in the conference. If used in a PUT request, updates this member\'s hold status. Has no effect if omitted. - * @type {boolean} - * @memberof ConferenceMember */ 'hold'?: boolean; /** * If this member had a value set for `callIdsToCoach` in its [Conference](/docs/voice/bxml/conference) verb or this list was added with a previous PUT request to modify the member, this is that list of calls. If present in a PUT request, modifies the calls that this member is coaching. Has no effect if omitted. See the documentation for the [Conference](/docs/voice/bxml/conference) verb for more details about coaching. Note that this will not add the matching calls to the conference; each call must individually execute a Conference verb to join. - * @type {Array} - * @memberof ConferenceMember */ 'callIdsToCoach'?: Array | null; } diff --git a/models/conference-recording-available-callback.ts b/models/conference-recording-available-callback.ts index c7bdccf..2c3fc42 100644 --- a/models/conference-recording-available-callback.ts +++ b/models/conference-recording-available-callback.ts @@ -19,92 +19,59 @@ import type { FileFormatEnum } from './file-format-enum'; /** * The Conference Recording Available event is sent after a conference recording has been processed. It indicates that the recording is available for download. - * @export - * @interface ConferenceRecordingAvailableCallback */ export interface ConferenceRecordingAvailableCallback { /** * The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. - * @type {string} - * @memberof ConferenceRecordingAvailableCallback */ 'eventType'?: string; /** * The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. - * @type {string} - * @memberof ConferenceRecordingAvailableCallback */ 'eventTime'?: string; /** * The unique, Bandwidth-generated ID of the conference that was recorded - * @type {string} - * @memberof ConferenceRecordingAvailableCallback */ 'conferenceId'?: string; /** * The user-specified name of the conference that was recorded - * @type {string} - * @memberof ConferenceRecordingAvailableCallback */ 'name'?: string; /** * The user account associated with the call. - * @type {string} - * @memberof ConferenceRecordingAvailableCallback */ 'accountId'?: string; /** * The unique ID of this recording - * @type {string} - * @memberof ConferenceRecordingAvailableCallback */ 'recordingId'?: string; /** * Always `1` for conference recordings; multi-channel recordings are not supported on conferences. - * @type {number} - * @memberof ConferenceRecordingAvailableCallback */ 'channels'?: number; /** * Time the call was started, in ISO 8601 format. - * @type {string} - * @memberof ConferenceRecordingAvailableCallback */ 'startTime'?: string; /** * The time that the recording ended in ISO-8601 format - * @type {string} - * @memberof ConferenceRecordingAvailableCallback */ 'endTime'?: string; /** * The duration of the recording in ISO-8601 format - * @type {string} - * @memberof ConferenceRecordingAvailableCallback */ 'duration'?: string; - /** - * - * @type {FileFormatEnum} - * @memberof ConferenceRecordingAvailableCallback - */ 'fileFormat'?: FileFormatEnum; /** * The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded. - * @type {string} - * @memberof ConferenceRecordingAvailableCallback */ 'mediaUrl'?: string | null; /** * (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. - * @type {string} - * @memberof ConferenceRecordingAvailableCallback */ 'tag'?: string | null; /** * The current status of the process. For recording, current possible values are \'processing\', \'partial\', \'complete\', \'deleted\', and \'error\'. For transcriptions, current possible values are \'none\', \'processing\', \'available\', \'error\', \'timeout\', \'file-size-too-big\', and \'file-size-too-small\'. Additional states may be added in the future, so your application must be tolerant of unknown values. - * @type {string} - * @memberof ConferenceRecordingAvailableCallback */ 'status'?: string; } diff --git a/models/conference-recording-metadata.ts b/models/conference-recording-metadata.ts index 60819bb..9c8468a 100644 --- a/models/conference-recording-metadata.ts +++ b/models/conference-recording-metadata.ts @@ -17,82 +17,50 @@ // @ts-ignore import type { FileFormatEnum } from './file-format-enum'; -/** - * - * @export - * @interface ConferenceRecordingMetadata - */ export interface ConferenceRecordingMetadata { /** * The user account associated with the call. - * @type {string} - * @memberof ConferenceRecordingMetadata */ 'accountId'?: string; /** * The unique, Bandwidth-generated ID of the conference that was recorded - * @type {string} - * @memberof ConferenceRecordingMetadata */ 'conferenceId'?: string; /** * The user-specified name of the conference that was recorded - * @type {string} - * @memberof ConferenceRecordingMetadata */ 'name'?: string; /** * The unique ID of this recording - * @type {string} - * @memberof ConferenceRecordingMetadata */ 'recordingId'?: string; /** * The duration of the recording in ISO-8601 format - * @type {string} - * @memberof ConferenceRecordingMetadata */ 'duration'?: string; /** * Always `1` for conference recordings; multi-channel recordings are not supported on conferences. - * @type {number} - * @memberof ConferenceRecordingMetadata */ 'channels'?: number; /** * Time the call was started, in ISO 8601 format. - * @type {string} - * @memberof ConferenceRecordingMetadata */ 'startTime'?: string; /** * The time that the recording ended in ISO-8601 format - * @type {string} - * @memberof ConferenceRecordingMetadata */ 'endTime'?: string; - /** - * - * @type {FileFormatEnum} - * @memberof ConferenceRecordingMetadata - */ 'fileFormat'?: FileFormatEnum; /** * The current status of the process. For recording, current possible values are \'processing\', \'partial\', \'complete\', \'deleted\', and \'error\'. For transcriptions, current possible values are \'none\', \'processing\', \'available\', \'error\', \'timeout\', \'file-size-too-big\', and \'file-size-too-small\'. Additional states may be added in the future, so your application must be tolerant of unknown values. - * @type {string} - * @memberof ConferenceRecordingMetadata */ 'status'?: string; /** * The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded. - * @type {string} - * @memberof ConferenceRecordingMetadata */ 'mediaUrl'?: string | null; /** * A name to identify this recording. - * @type {string} - * @memberof ConferenceRecordingMetadata */ 'recordingName'?: string; } diff --git a/models/conference-redirect-callback.ts b/models/conference-redirect-callback.ts index da13d99..975df6b 100644 --- a/models/conference-redirect-callback.ts +++ b/models/conference-redirect-callback.ts @@ -16,38 +16,26 @@ /** * The Conference Redirect event is fired whenever an existing conference is modified via a POST request made to the /conferences/{conferenceId} endpoint. The response may be either empty or a BXML document. Only the following verbs are valid for conferences: PlayAudio, SpeakSentence, StartRecording, StopRecording, PauseRecording, ResumeRecording. Audio verbs will be heard by all members of the conference. Recordings capture audio from all members who are not muted or on hold, as well as any audio verbs that are played into the conference. - * @export - * @interface ConferenceRedirectCallback */ export interface ConferenceRedirectCallback { /** * The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. - * @type {string} - * @memberof ConferenceRedirectCallback */ 'eventType'?: string; /** * The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. - * @type {string} - * @memberof ConferenceRedirectCallback */ 'eventTime'?: string; /** * The unique, Bandwidth-generated ID of the conference that was recorded - * @type {string} - * @memberof ConferenceRedirectCallback */ 'conferenceId'?: string; /** * The user-specified name of the conference that was recorded - * @type {string} - * @memberof ConferenceRedirectCallback */ 'name'?: string; /** * (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. - * @type {string} - * @memberof ConferenceRedirectCallback */ 'tag'?: string | null; } diff --git a/models/conference-state-enum.ts b/models/conference-state-enum.ts index 08bdba4..be36b73 100644 --- a/models/conference-state-enum.ts +++ b/models/conference-state-enum.ts @@ -16,8 +16,6 @@ /** * Setting the conference state to `completed` ends the conference and ejects all members. - * @export - * @enum {string} */ export const ConferenceStateEnum = { diff --git a/models/conference.ts b/models/conference.ts index 50d43a8..d4cb83a 100644 --- a/models/conference.ts +++ b/models/conference.ts @@ -20,58 +20,34 @@ import type { CallbackMethodEnum } from './callback-method-enum'; // @ts-ignore import type { ConferenceMember } from './conference-member'; -/** - * - * @export - * @interface Conference - */ export interface Conference { /** * The Bandwidth-generated conference ID. - * @type {string} - * @memberof Conference */ 'id'?: string; /** * The name of the conference, as specified by your application. - * @type {string} - * @memberof Conference */ 'name'?: string; /** * The time the conference was initiated, in ISO 8601 format. - * @type {string} - * @memberof Conference */ 'createdTime'?: string; /** * The time the conference was terminated, in ISO 8601 format. - * @type {string} - * @memberof Conference */ 'completedTime'?: string | null; /** * The URL to send the conference-related events. - * @type {string} - * @memberof Conference */ 'conferenceEventUrl'?: string | null; - /** - * - * @type {CallbackMethodEnum} - * @memberof Conference - */ 'conferenceEventMethod'?: CallbackMethodEnum | null; /** * The custom string attached to the conference that will be sent with callbacks. - * @type {string} - * @memberof Conference */ 'tag'?: string | null; /** * A list of active members of the conference. Omitted if this is a response to the [Get Conferences endpoint](/apis/voice#tag/Conferences/operation/listConferences). - * @type {Array} - * @memberof Conference */ 'activeMembers'?: Array | null; } diff --git a/models/contact.ts b/models/contact.ts index e98dbad..6cc4ef5 100644 --- a/models/contact.ts +++ b/models/contact.ts @@ -14,34 +14,18 @@ -/** - * - * @export - * @interface Contact - */ export interface Contact { /** * The first name of the business contact using the toll-free number. - * @type {string} - * @memberof Contact */ 'firstName': string; /** * The last name of the business contact using the toll-free number. - * @type {string} - * @memberof Contact */ 'lastName': string; - /** - * - * @type {string} - * @memberof Contact - */ 'email': string; /** * Contact telephone number - * @type {string} - * @memberof Contact */ 'phoneNumber': string; } diff --git a/models/create-async-bulk-lookup-response-data.ts b/models/create-async-bulk-lookup-response-data.ts new file mode 100644 index 0000000..012c6b1 --- /dev/null +++ b/models/create-async-bulk-lookup-response-data.ts @@ -0,0 +1,32 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Bandwidth + * Bandwidth\'s Communication APIs + * + * The version of the OpenAPI document: 1.0.0 + * Contact: letstalk@bandwidth.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import type { InProgressLookupStatusEnum } from './in-progress-lookup-status-enum'; + +/** + * The phone number lookup response data + */ +export interface CreateAsyncBulkLookupResponseData { + /** + * The phone number lookup request ID from Bandwidth. + */ + 'requestId'?: string; + 'status'?: InProgressLookupStatusEnum; +} + + + diff --git a/models/create-async-bulk-lookup-response.ts b/models/create-async-bulk-lookup-response.ts new file mode 100644 index 0000000..56ac44e --- /dev/null +++ b/models/create-async-bulk-lookup-response.ts @@ -0,0 +1,34 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Bandwidth + * Bandwidth\'s Communication APIs + * + * The version of the OpenAPI document: 1.0.0 + * Contact: letstalk@bandwidth.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import type { CreateAsyncBulkLookupResponseData } from './create-async-bulk-lookup-response-data'; +// May contain unused imports in some cases +// @ts-ignore +import type { LinkSchema } from './link-schema'; +// May contain unused imports in some cases +// @ts-ignore +import type { LookupErrorSchema } from './lookup-error-schema'; + +export interface CreateAsyncBulkLookupResponse { + /** + * Links for pagination (if applicable) + */ + 'links'?: Array; + 'data'?: CreateAsyncBulkLookupResponseData; + 'errors'?: Array; +} + diff --git a/models/create-call-response.ts b/models/create-call-response.ts index 0c7eaab..173882d 100644 --- a/models/create-call-response.ts +++ b/models/create-call-response.ts @@ -17,136 +17,80 @@ // @ts-ignore import type { CallbackMethodEnum } from './callback-method-enum'; -/** - * - * @export - * @interface CreateCallResponse - */ export interface CreateCallResponse { /** * The id of the application associated with the `from` number. - * @type {string} - * @memberof CreateCallResponse */ 'applicationId': string; /** * The bandwidth account ID associated with the call. - * @type {string} - * @memberof CreateCallResponse */ 'accountId': string; /** * Programmable Voice API Call ID. - * @type {string} - * @memberof CreateCallResponse */ 'callId': string; /** * Recipient of the outgoing call. - * @type {string} - * @memberof CreateCallResponse */ 'to': string; /** * Phone number that created the outbound call. - * @type {string} - * @memberof CreateCallResponse */ 'from': string; /** * The time at which the call was accepted into the queue. - * @type {string} - * @memberof CreateCallResponse */ 'enqueuedTime'?: string | null; /** * The URL to update this call\'s state. - * @type {string} - * @memberof CreateCallResponse */ 'callUrl': string; /** * The timeout (in seconds) for the callee to answer the call after it starts ringing. - * @type {number} - * @memberof CreateCallResponse */ 'callTimeout'?: number; /** * This is the timeout (in seconds) to use when delivering webhooks for the call. - * @type {number} - * @memberof CreateCallResponse */ 'callbackTimeout'?: number; /** * Custom tag value. - * @type {string} - * @memberof CreateCallResponse */ 'tag'?: string | null; - /** - * - * @type {CallbackMethodEnum} - * @memberof CreateCallResponse - */ 'answerMethod': CallbackMethodEnum | null; /** * URL to deliver the `answer` event webhook. - * @type {string} - * @memberof CreateCallResponse */ 'answerUrl': string; - /** - * - * @type {CallbackMethodEnum} - * @memberof CreateCallResponse - */ 'answerFallbackMethod'?: CallbackMethodEnum | null; /** * Fallback URL to deliver the `answer` event webhook. - * @type {string} - * @memberof CreateCallResponse */ 'answerFallbackUrl'?: string | null; - /** - * - * @type {CallbackMethodEnum} - * @memberof CreateCallResponse - */ 'disconnectMethod': CallbackMethodEnum | null; /** * URL to deliver the `disconnect` event webhook. - * @type {string} - * @memberof CreateCallResponse */ 'disconnectUrl'?: string | null; /** * Basic auth username. - * @type {string} - * @memberof CreateCallResponse */ 'username'?: string | null; /** * Basic auth password. - * @type {string} - * @memberof CreateCallResponse */ 'password'?: string | null; /** * Basic auth username. - * @type {string} - * @memberof CreateCallResponse */ 'fallbackUsername'?: string | null; /** * Basic auth password. - * @type {string} - * @memberof CreateCallResponse */ 'fallbackPassword'?: string | null; /** * The priority of this call over other calls from your account. - * @type {number} - * @memberof CreateCallResponse */ 'priority'?: number | null; } diff --git a/models/create-call.ts b/models/create-call.ts index 462f1ed..2f71c96 100644 --- a/models/create-call.ts +++ b/models/create-call.ts @@ -20,136 +20,77 @@ import type { CallbackMethodEnum } from './callback-method-enum'; // @ts-ignore import type { MachineDetectionConfiguration } from './machine-detection-configuration'; -/** - * - * @export - * @interface CreateCall - */ export interface CreateCall { /** * The destination to call (must be an E.164 formatted number (e.g. `+15555551212`) or a SIP URI (e.g. `sip:user@server.example`)). - * @type {string} - * @memberof CreateCall */ 'to': string; /** * A Bandwidth phone number on your account the call should come from (must be in E.164 format, like `+15555551212`) even if `privacy` is set to true. - * @type {string} - * @memberof CreateCall */ 'from': string; /** * Hide the calling number. The `displayName` field can be used to customize the displayed name. - * @type {boolean} - * @memberof CreateCall */ 'privacy'?: boolean | null; /** * The caller display name to use when the call is created. May not exceed 256 characters nor contain control characters such as new lines. If `privacy` is true, only the following values are valid: `Restricted`, `Anonymous`, `Private`, or `Unavailable`. - * @type {string} - * @memberof CreateCall */ 'displayName'?: string | null; /** * A comma-separated list of \'User-To-User\' headers to be sent in the INVITE when calling a SIP URI. Each value must end with an \'encoding\' parameter as described in RFC 7433. Only \'jwt\', \'base64\' and \'hex\' encodings are allowed. The entire value cannot exceed 350 characters, including parameters and separators. - * @type {string} - * @memberof CreateCall */ 'uui'?: string | null; /** * The id of the application associated with the `from` number. - * @type {string} - * @memberof CreateCall */ 'applicationId': string; /** * The full URL to send the Answer event to when the called party answers. This endpoint should return the first BXML document to be executed in the call. Must use `https` if specifying `username` and `password`. - * @type {string} - * @memberof CreateCall */ 'answerUrl': string; - /** - * - * @type {CallbackMethodEnum} - * @memberof CreateCall - */ 'answerMethod'?: CallbackMethodEnum | null; /** * Basic auth username. - * @type {string} - * @memberof CreateCall */ 'username'?: string | null; /** * Basic auth password. - * @type {string} - * @memberof CreateCall */ 'password'?: string | null; /** * A fallback url which, if provided, will be used to retry the `answer` webhook delivery in case `answerUrl` fails to respond Must use `https` if specifying `fallbackUsername` and `fallbackPassword`. - * @type {string} - * @memberof CreateCall */ 'answerFallbackUrl'?: string | null; - /** - * - * @type {CallbackMethodEnum} - * @memberof CreateCall - */ 'answerFallbackMethod'?: CallbackMethodEnum | null; /** * Basic auth username. - * @type {string} - * @memberof CreateCall */ 'fallbackUsername'?: string | null; /** * Basic auth password. - * @type {string} - * @memberof CreateCall */ 'fallbackPassword'?: string | null; /** * The URL to send the Disconnect event to when the call ends. This event does not expect a BXML response. - * @type {string} - * @memberof CreateCall */ 'disconnectUrl'?: string | null; - /** - * - * @type {CallbackMethodEnum} - * @memberof CreateCall - */ 'disconnectMethod'?: CallbackMethodEnum | null; /** * The timeout (in seconds) for the callee to answer the call after it starts ringing. If the call does not start ringing within 30s, the call will be cancelled regardless of this value. Can be any numeric value (including decimals) between 1 and 300. - * @type {number} - * @memberof CreateCall */ 'callTimeout'?: number | null; /** * This is the timeout (in seconds) to use when delivering webhooks for the call. Can be any numeric value (including decimals) between 1 and 25. - * @type {number} - * @memberof CreateCall */ 'callbackTimeout'?: number | null; - /** - * - * @type {MachineDetectionConfiguration} - * @memberof CreateCall - */ 'machineDetection'?: MachineDetectionConfiguration; /** * The priority of this call over other calls from your account. For example, if during a call your application needs to place a new call and bridge it with the current call, you might want to create the call with priority 1 so that it will be the next call picked off your queue, ahead of other less time sensitive calls. A lower value means higher priority, so a priority 1 call takes precedence over a priority 2 call. - * @type {number} - * @memberof CreateCall */ 'priority'?: number | null; /** * A custom string that will be sent with all webhooks for this call unless overwritten by a future `` verb or `tag` attribute on another verb, or cleared. May be cleared by setting `tag=\"\"` Max length 256 characters. - * @type {string} - * @memberof CreateCall */ 'tag'?: string | null; } diff --git a/models/create-message-request-error.ts b/models/create-message-request-error.ts index de6ff98..9675322 100644 --- a/models/create-message-request-error.ts +++ b/models/create-message-request-error.ts @@ -17,29 +17,9 @@ // @ts-ignore import type { FieldError } from './field-error'; -/** - * - * @export - * @interface CreateMessageRequestError - */ export interface CreateMessageRequestError { - /** - * - * @type {string} - * @memberof CreateMessageRequestError - */ 'type': string; - /** - * - * @type {string} - * @memberof CreateMessageRequestError - */ 'description': string; - /** - * - * @type {Array} - * @memberof CreateMessageRequestError - */ 'fieldErrors'?: Array; } diff --git a/models/create-multi-channel-message-response.ts b/models/create-multi-channel-message-response.ts index f4f0d3e..d1e3f90 100644 --- a/models/create-multi-channel-message-response.ts +++ b/models/create-multi-channel-message-response.ts @@ -23,29 +23,9 @@ import type { Link } from './link'; // @ts-ignore import type { MultiChannelMessageResponseData } from './multi-channel-message-response-data'; -/** - * - * @export - * @interface CreateMultiChannelMessageResponse - */ export interface CreateMultiChannelMessageResponse { - /** - * - * @type {Array} - * @memberof CreateMultiChannelMessageResponse - */ 'links'?: Array; - /** - * - * @type {MultiChannelMessageResponseData} - * @memberof CreateMultiChannelMessageResponse - */ 'data'?: MultiChannelMessageResponseData; - /** - * - * @type {Array} - * @memberof CreateMultiChannelMessageResponse - */ 'errors'?: Array; } diff --git a/models/create-lookup-response.ts b/models/create-sync-lookup-response-data.ts similarity index 54% rename from models/create-lookup-response.ts rename to models/create-sync-lookup-response-data.ts index a17258c..805ae10 100644 --- a/models/create-lookup-response.ts +++ b/models/create-sync-lookup-response-data.ts @@ -15,26 +15,24 @@ // May contain unused imports in some cases // @ts-ignore -import type { LookupStatusEnum } from './lookup-status-enum'; +import type { CompletedLookupStatusEnum } from './completed-lookup-status-enum'; +// May contain unused imports in some cases +// @ts-ignore +import type { LookupResult } from './lookup-result'; /** - * The request has been accepted for processing but not yet finished and in a terminal state (COMPLETE, PARTIAL_COMPLETE, or FAILED). - * @export - * @interface CreateLookupResponse + * The phone number lookup response data */ -export interface CreateLookupResponse { +export interface CreateSyncLookupResponseData { /** * The phone number lookup request ID from Bandwidth. - * @type {string} - * @memberof CreateLookupResponse */ 'requestId'?: string; + 'status'?: CompletedLookupStatusEnum; /** - * - * @type {LookupStatusEnum} - * @memberof CreateLookupResponse + * The carrier information results for the specified telephone numbers. */ - 'status'?: LookupStatusEnum; + 'results'?: Array; } diff --git a/models/create-sync-lookup-response.ts b/models/create-sync-lookup-response.ts new file mode 100644 index 0000000..28b4c91 --- /dev/null +++ b/models/create-sync-lookup-response.ts @@ -0,0 +1,31 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Bandwidth + * Bandwidth\'s Communication APIs + * + * The version of the OpenAPI document: 1.0.0 + * Contact: letstalk@bandwidth.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import type { CreateSyncLookupResponseData } from './create-sync-lookup-response-data'; +// May contain unused imports in some cases +// @ts-ignore +import type { LinkSchema } from './link-schema'; +// May contain unused imports in some cases +// @ts-ignore +import type { LookupErrorSchema } from './lookup-error-schema'; + +export interface CreateSyncLookupResponse { + 'links'?: Array; + 'data'?: CreateSyncLookupResponseData; + 'errors'?: Array; +} + diff --git a/models/deactivation-event-enum.ts b/models/deactivation-event-enum.ts new file mode 100644 index 0000000..a87de5a --- /dev/null +++ b/models/deactivation-event-enum.ts @@ -0,0 +1,28 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Bandwidth + * Bandwidth\'s Communication APIs + * + * The version of the OpenAPI document: 1.0.0 + * Contact: letstalk@bandwidth.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * [DNI-Only](#section/DNI-Only). `DEACTIVATED` if the carrier reported a deactivation event for this phone number. + */ + +export const DeactivationEventEnum = { + Deactivated: 'DEACTIVATED' +} as const; + +export type DeactivationEventEnum = typeof DeactivationEventEnum[keyof typeof DeactivationEventEnum]; + + + diff --git a/models/disconnect-callback.ts b/models/disconnect-callback.ts index 8d75588..3c2afef 100644 --- a/models/disconnect-callback.ts +++ b/models/disconnect-callback.ts @@ -19,110 +19,71 @@ import type { CallDirectionEnum } from './call-direction-enum'; /** * The Disconnect event is fired when a call ends, for any reason. - * @export - * @interface DisconnectCallback */ export interface DisconnectCallback { /** * The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. - * @type {string} - * @memberof DisconnectCallback */ 'eventType'?: string; /** * The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. - * @type {string} - * @memberof DisconnectCallback */ 'eventTime'?: string; /** * The user account associated with the call. - * @type {string} - * @memberof DisconnectCallback */ 'accountId'?: string; /** * The id of the application associated with the call. - * @type {string} - * @memberof DisconnectCallback */ 'applicationId'?: string; /** * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof DisconnectCallback */ 'from'?: string; /** * The phone number that received the call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof DisconnectCallback */ 'to'?: string; /** * The call id associated with the event. - * @type {string} - * @memberof DisconnectCallback */ 'callId'?: string; - /** - * - * @type {CallDirectionEnum} - * @memberof DisconnectCallback - */ 'direction'?: CallDirectionEnum; /** * The URL of the call associated with the event. - * @type {string} - * @memberof DisconnectCallback */ 'callUrl'?: string; /** * (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. - * @type {string} - * @memberof DisconnectCallback */ 'enqueuedTime'?: string | null; /** * Time the call was started, in ISO 8601 format. - * @type {string} - * @memberof DisconnectCallback */ 'startTime'?: string; /** * Time the call was answered, in ISO 8601 format. - * @type {string} - * @memberof DisconnectCallback */ 'answerTime'?: string | null; /** * The time that the recording ended in ISO-8601 format - * @type {string} - * @memberof DisconnectCallback */ 'endTime'?: string; /** * Reason the call failed - hangup, busy, timeout, cancel, rejected, callback-error, invalid-bxml, application-error, account-limit, node-capacity-exceeded, error, or unknown. - * @type {string} - * @memberof DisconnectCallback */ 'cause'?: string; /** * Text explaining the reason that caused the call to fail in case of errors. - * @type {string} - * @memberof DisconnectCallback */ 'errorMessage'?: string | null; /** * Bandwidth\'s internal id that references the error event. - * @type {string} - * @memberof DisconnectCallback */ 'errorId'?: string | null; /** * (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. - * @type {string} - * @memberof DisconnectCallback */ 'tag'?: string | null; } diff --git a/models/diversion.ts b/models/diversion.ts index b60f351..465b53d 100644 --- a/models/diversion.ts +++ b/models/diversion.ts @@ -14,52 +14,33 @@ -/** - * - * @export - * @interface Diversion - */ export interface Diversion { /** * The reason for the diversion. Common values: unknown, user-busy, no-answer, unavailable, unconditional, time-of-day, do-not-disturb, deflection, follow-me, out-of-service, away. - * @type {string} - * @memberof Diversion */ 'reason'?: string; /** * off or full - * @type {string} - * @memberof Diversion */ 'privacy'?: string; /** * No if the number was provided by the user, yes if the number was provided by the network - * @type {string} - * @memberof Diversion */ 'screen'?: string; /** * The number of diversions that have occurred - * @type {string} - * @memberof Diversion */ 'counter'?: string; /** * The maximum number of diversions allowed for this session - * @type {string} - * @memberof Diversion */ 'limit'?: string; /** * The normal list of values is not exhaustive. Your application must be tolerant of unlisted keys and unlisted values of those keys. - * @type {string} - * @memberof Diversion */ 'unknown'?: string; /** * Always present. Indicates the last telephone number that the call was diverted from. - * @type {string} - * @memberof Diversion */ 'origTo'?: string; } diff --git a/models/dtmf-callback.ts b/models/dtmf-callback.ts index c451e5f..48a57ac 100644 --- a/models/dtmf-callback.ts +++ b/models/dtmf-callback.ts @@ -19,110 +19,71 @@ import type { CallDirectionEnum } from './call-direction-enum'; /** * The DTMF event is sent for every digit detected after a verb is executed. You may not respond to this event with BXML. - * @export - * @interface DtmfCallback */ export interface DtmfCallback { /** * The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. - * @type {string} - * @memberof DtmfCallback */ 'eventType'?: string; /** * The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. - * @type {string} - * @memberof DtmfCallback */ 'eventTime'?: string; /** * The user account associated with the call. - * @type {string} - * @memberof DtmfCallback */ 'accountId'?: string; /** * The id of the application associated with the call. - * @type {string} - * @memberof DtmfCallback */ 'applicationId'?: string; /** * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof DtmfCallback */ 'from'?: string; /** * The phone number that received the call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof DtmfCallback */ 'to'?: string; /** * The call id associated with the event. - * @type {string} - * @memberof DtmfCallback */ 'callId'?: string; - /** - * - * @type {CallDirectionEnum} - * @memberof DtmfCallback - */ 'direction'?: CallDirectionEnum; /** * The digit collected in the call. - * @type {string} - * @memberof DtmfCallback */ 'digit'?: string; /** * The URL of the call associated with the event. - * @type {string} - * @memberof DtmfCallback */ 'callUrl'?: string; /** * (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. - * @type {string} - * @memberof DtmfCallback */ 'enqueuedTime'?: string | null; /** * Time the call was started, in ISO 8601 format. - * @type {string} - * @memberof DtmfCallback */ 'startTime'?: string; /** * Time the call was answered, in ISO 8601 format. - * @type {string} - * @memberof DtmfCallback */ 'answerTime'?: string | null; /** * (optional) If the event is related to the B leg of a , the call id of the original call leg that executed the . Otherwise, this field will not be present. - * @type {string} - * @memberof DtmfCallback */ 'parentCallId'?: string; /** * The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof DtmfCallback */ 'transferCallerId'?: string; /** * The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof DtmfCallback */ 'transferTo'?: string; /** * (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. - * @type {string} - * @memberof DtmfCallback */ 'tag'?: string | null; } diff --git a/models/error-object.ts b/models/error-object.ts index 1868b36..5a81a39 100644 --- a/models/error-object.ts +++ b/models/error-object.ts @@ -17,29 +17,15 @@ // @ts-ignore import type { ErrorSource } from './error-source'; -/** - * - * @export - * @interface ErrorObject - */ export interface ErrorObject { /** * A concise summary of the error used for categorization. - * @type {string} - * @memberof ErrorObject */ 'type': string; /** * A detailed explanation of the error. - * @type {string} - * @memberof ErrorObject */ 'description': string; - /** - * - * @type {ErrorSource} - * @memberof ErrorObject - */ 'source': ErrorSource; } diff --git a/models/error-source.ts b/models/error-source.ts index 4c61468..716cf0f 100644 --- a/models/error-source.ts +++ b/models/error-source.ts @@ -16,32 +16,22 @@ /** * Specifies relevant sources of the error, if any. - * @export - * @interface ErrorSource */ export interface ErrorSource { /** * The relevant URI query parameter causing the error - * @type {string} - * @memberof ErrorSource */ 'parameter'?: string; /** * The request body field that led to the error - * @type {string} - * @memberof ErrorSource */ 'field'?: string; /** * The header field that contributed to the error - * @type {string} - * @memberof ErrorSource */ 'header'?: string; /** * A resource ID or path linked to the error - * @type {string} - * @memberof ErrorSource */ 'reference'?: string; } diff --git a/models/failure-webhook.ts b/models/failure-webhook.ts index 93061ab..f183db9 100644 --- a/models/failure-webhook.ts +++ b/models/failure-webhook.ts @@ -14,46 +14,29 @@ -/** - * - * @export - * @interface FailureWebhook - */ export interface FailureWebhook { /** * User\'s account ID. - * @type {string} - * @memberof FailureWebhook */ 'accountId'?: string; /** * Toll-free telephone number in E.164 format. - * @type {string} - * @memberof FailureWebhook */ 'phoneNumber'?: string; /** * An error code indicating what error was encountered. This code can be interpreted as an HTTP status code in regards to the error that was encountered. - * @type {string} - * @memberof FailureWebhook */ 'errorCode'?: string; /** * A description of the error that was encountered. - * @type {string} - * @memberof FailureWebhook */ 'errorMessage'?: string; /** * Details of the errors that were encountered when processing the request. - * @type {Array} - * @memberof FailureWebhook */ 'errors'?: Array; /** * Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number. - * @type {string} - * @memberof FailureWebhook */ 'internalTicketNumber'?: string; } diff --git a/models/field-error.ts b/models/field-error.ts index 5b8ba60..f29b30f 100644 --- a/models/field-error.ts +++ b/models/field-error.ts @@ -14,22 +14,13 @@ -/** - * - * @export - * @interface FieldError - */ export interface FieldError { /** * The name of the field that contains the error - * @type {string} - * @memberof FieldError */ 'fieldName'?: string; /** * The error associated with the field - * @type {string} - * @memberof FieldError */ 'description'?: string; } diff --git a/models/file-format-enum.ts b/models/file-format-enum.ts index 4e845ac..c640501 100644 --- a/models/file-format-enum.ts +++ b/models/file-format-enum.ts @@ -16,8 +16,6 @@ /** * The format that the recording is stored in. - * @export - * @enum {string} */ export const FileFormatEnum = { diff --git a/models/gather-callback.ts b/models/gather-callback.ts index 6c88f76..0af1b08 100644 --- a/models/gather-callback.ts +++ b/models/gather-callback.ts @@ -19,116 +19,75 @@ import type { CallDirectionEnum } from './call-direction-enum'; /** * The gather event is sent after a verb is executed. Its purpose is to report the gathered digits to the calling application. - * @export - * @interface GatherCallback */ export interface GatherCallback { /** * The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. - * @type {string} - * @memberof GatherCallback */ 'eventType'?: string; /** * The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. - * @type {string} - * @memberof GatherCallback */ 'eventTime'?: string; /** * The user account associated with the call. - * @type {string} - * @memberof GatherCallback */ 'accountId'?: string; /** * The id of the application associated with the call. - * @type {string} - * @memberof GatherCallback */ 'applicationId'?: string; /** * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof GatherCallback */ 'from'?: string; /** * The phone number that received the call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof GatherCallback */ 'to'?: string; - /** - * - * @type {CallDirectionEnum} - * @memberof GatherCallback - */ 'direction'?: CallDirectionEnum; /** * The call id associated with the event. - * @type {string} - * @memberof GatherCallback */ 'callId'?: string; /** * (optional) The digits, letters, and/or symbols entered by the user. The string is empty if a timeout occurred before any buttons were pressed. - * @type {string} - * @memberof GatherCallback */ 'digits'?: string; /** * The URL of the call associated with the event. - * @type {string} - * @memberof GatherCallback */ 'callUrl'?: string; /** * (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. - * @type {string} - * @memberof GatherCallback */ 'enqueuedTime'?: string | null; /** * Time the call was started, in ISO 8601 format. - * @type {string} - * @memberof GatherCallback */ 'startTime'?: string; /** * Time the call was answered, in ISO 8601 format. - * @type {string} - * @memberof GatherCallback */ 'answerTime'?: string | null; /** * (optional) If the event is related to the B leg of a , the call id of the original call leg that executed the . Otherwise, this field will not be present. - * @type {string} - * @memberof GatherCallback */ 'parentCallId'?: string; /** * (optional) The digit the user pressed to end the gather. Empty string value if no terminating digit was pressed. - * @type {string} - * @memberof GatherCallback */ 'terminatingDigit'?: string; /** * The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof GatherCallback */ 'transferCallerId'?: string; /** * The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof GatherCallback */ 'transferTo'?: string; /** * (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. - * @type {string} - * @memberof GatherCallback */ 'tag'?: string | null; } diff --git a/models/get-async-bulk-lookup-response-data.ts b/models/get-async-bulk-lookup-response-data.ts new file mode 100644 index 0000000..80494bc --- /dev/null +++ b/models/get-async-bulk-lookup-response-data.ts @@ -0,0 +1,39 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Bandwidth + * Bandwidth\'s Communication APIs + * + * The version of the OpenAPI document: 1.0.0 + * Contact: letstalk@bandwidth.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import type { InProgressLookupStatusEnum } from './in-progress-lookup-status-enum'; +// May contain unused imports in some cases +// @ts-ignore +import type { LookupResult } from './lookup-result'; + +/** + * The phone number lookup response data + */ +export interface GetAsyncBulkLookupResponseData { + /** + * The phone number lookup request ID from Bandwidth. + */ + 'requestId'?: string; + 'status'?: InProgressLookupStatusEnum; + /** + * The carrier information results for the specified telephone number. + */ + 'results'?: Array; +} + + + diff --git a/models/get-async-bulk-lookup-response.ts b/models/get-async-bulk-lookup-response.ts new file mode 100644 index 0000000..ea4e41a --- /dev/null +++ b/models/get-async-bulk-lookup-response.ts @@ -0,0 +1,31 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Bandwidth + * Bandwidth\'s Communication APIs + * + * The version of the OpenAPI document: 1.0.0 + * Contact: letstalk@bandwidth.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import type { GetAsyncBulkLookupResponseData } from './get-async-bulk-lookup-response-data'; +// May contain unused imports in some cases +// @ts-ignore +import type { LinkSchema } from './link-schema'; +// May contain unused imports in some cases +// @ts-ignore +import type { LookupErrorSchema } from './lookup-error-schema'; + +export interface GetAsyncBulkLookupResponse { + 'links'?: Array; + 'data'?: GetAsyncBulkLookupResponseData; + 'errors'?: Array; +} + diff --git a/models/lookup-status-enum.ts b/models/in-progress-lookup-status-enum.ts similarity index 66% rename from models/lookup-status-enum.ts rename to models/in-progress-lookup-status-enum.ts index a6cbf2d..982d612 100644 --- a/models/lookup-status-enum.ts +++ b/models/in-progress-lookup-status-enum.ts @@ -14,20 +14,15 @@ -/** - * The status of the request (IN_PROGRESS, COMPLETE, PARTIAL_COMPLETE, or FAILED). - * @export - * @enum {string} - */ -export const LookupStatusEnum = { +export const InProgressLookupStatusEnum = { InProgress: 'IN_PROGRESS', Complete: 'COMPLETE', PartialComplete: 'PARTIAL_COMPLETE', Failed: 'FAILED' } as const; -export type LookupStatusEnum = typeof LookupStatusEnum[keyof typeof LookupStatusEnum]; +export type InProgressLookupStatusEnum = typeof InProgressLookupStatusEnum[keyof typeof InProgressLookupStatusEnum]; diff --git a/models/inbound-callback-message.ts b/models/inbound-callback-message.ts index 47c59f6..28e609a 100644 --- a/models/inbound-callback-message.ts +++ b/models/inbound-callback-message.ts @@ -37,7 +37,6 @@ import type { StatusCallbackMessage } from './status-callback-message'; /** * @type InboundCallbackMessage - * @export */ export type InboundCallbackMessage = StatusCallbackMessage; diff --git a/models/inbound-callback-type-enum.ts b/models/inbound-callback-type-enum.ts index c60b809..bb29bbe 100644 --- a/models/inbound-callback-type-enum.ts +++ b/models/inbound-callback-type-enum.ts @@ -16,8 +16,6 @@ /** * The possible inbound callback types originating from MO messages or multichannel message client responses: - `message-received` indicates an MO message from a Bandwidth user\'s client to a Bandwidth number. - `request-location-response` indicates a response to a location request sent by the Bandwidth user\'s client after receiving an RBM message. - `suggestion-response` indicates a response to a suggestion sent by the Bandwidth user\'s client after receiving an RBM message. - * @export - * @enum {string} */ export const InboundCallbackTypeEnum = { diff --git a/models/inbound-callback.ts b/models/inbound-callback.ts index 546695e..7080ef7 100644 --- a/models/inbound-callback.ts +++ b/models/inbound-callback.ts @@ -22,44 +22,21 @@ import type { InboundCallbackTypeEnum } from './inbound-callback-type-enum'; /** * Represents an inbound callback. - * @export - * @interface InboundCallback */ export interface InboundCallback { - /** - * - * @type {string} - * @memberof InboundCallback - */ 'time': string; - /** - * - * @type {InboundCallbackTypeEnum} - * @memberof InboundCallback - */ 'type': InboundCallbackTypeEnum; /** * The destination phone number the message was sent to. For inbound callbacks, this is the Bandwidth number or alphanumeric identifier that received the message. - * @type {string} - * @memberof InboundCallback */ 'to': string; /** * A detailed description of the event described by the callback. - * @type {string} - * @memberof InboundCallback */ 'description': string; - /** - * - * @type {InboundCallbackMessage} - * @memberof InboundCallback - */ 'message': InboundCallbackMessage; /** * The name of the Authorized Message Provider (AMP) that handled this message. In the US, this is the carrier that the message was sent to. This field is present only when this account feature has been enabled. - * @type {string} - * @memberof InboundCallback */ 'carrierName'?: string; } diff --git a/models/index.ts b/models/index.ts index d85bb94..3dfcf17 100644 --- a/models/index.ts +++ b/models/index.ts @@ -2,6 +2,7 @@ export * from './account-statistics'; export * from './additional-denial-reason'; export * from './address'; export * from './answer-callback'; +export * from './async-lookup-request'; export * from './blocked-webhook'; export * from './bridge-complete-callback'; export * from './bridge-target-complete-callback'; @@ -20,6 +21,7 @@ export * from './callback'; export * from './callback-method-enum'; export * from './card-width-enum'; export * from './code-request'; +export * from './completed-lookup-status-enum'; export * from './conference'; export * from './conference-completed-callback'; export * from './conference-created-callback'; @@ -31,11 +33,15 @@ export * from './conference-recording-metadata'; export * from './conference-redirect-callback'; export * from './conference-state-enum'; export * from './contact'; +export * from './create-async-bulk-lookup-response'; +export * from './create-async-bulk-lookup-response-data'; export * from './create-call'; export * from './create-call-response'; -export * from './create-lookup-response'; export * from './create-message-request-error'; export * from './create-multi-channel-message-response'; +export * from './create-sync-lookup-response'; +export * from './create-sync-lookup-response-data'; +export * from './deactivation-event-enum'; export * from './disconnect-callback'; export * from './diversion'; export * from './dtmf-callback'; @@ -45,18 +51,24 @@ export * from './failure-webhook'; export * from './field-error'; export * from './file-format-enum'; export * from './gather-callback'; +export * from './get-async-bulk-lookup-response'; +export * from './get-async-bulk-lookup-response-data'; +export * from './in-progress-lookup-status-enum'; export * from './inbound-callback'; export * from './inbound-callback-message'; export * from './inbound-callback-type-enum'; export * from './initiate-callback'; +export * from './latest-message-delivery-status-enum'; +export * from './line-type-enum'; export * from './link'; +export * from './link-schema'; export * from './links-object'; export * from './list-message-direction-enum'; export * from './list-message-item'; -export * from './lookup-request'; +export * from './lookup-error-response'; +export * from './lookup-error-schema'; +export * from './lookup-error-schema-meta'; export * from './lookup-result'; -export * from './lookup-status'; -export * from './lookup-status-enum'; export * from './machine-detection-complete-callback'; export * from './machine-detection-configuration'; export * from './machine-detection-mode-enum'; @@ -119,6 +131,7 @@ export * from './status-callback'; export * from './status-callback-message'; export * from './status-callback-type-enum'; export * from './stir-shaken'; +export * from './sync-lookup-request'; export * from './telephone-number'; export * from './tfv-basic-authentication'; export * from './tfv-callback-status-enum'; @@ -128,7 +141,6 @@ export * from './tfv-status-enum'; export * from './tfv-submission-info'; export * from './tfv-submission-wrapper'; export * from './thumbnail-alignment-enum'; -export * from './tn-lookup-request-error'; export * from './transcribe-recording'; export * from './transcription'; export * from './transcription-available-callback'; diff --git a/models/initiate-callback.ts b/models/initiate-callback.ts index bbef765..87abcf8 100644 --- a/models/initiate-callback.ts +++ b/models/initiate-callback.ts @@ -25,86 +25,49 @@ import type { StirShaken } from './stir-shaken'; /** * The Initiate event is fired when an inbound call is received for a Telephone Number on your Account. It is sent to the URL specified in the application associated with the location (sip-peer) that the called telephone number belongs to. - * @export - * @interface InitiateCallback */ export interface InitiateCallback { /** * The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. - * @type {string} - * @memberof InitiateCallback */ 'eventType'?: string; /** * The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. - * @type {string} - * @memberof InitiateCallback */ 'eventTime'?: string; /** * The user account associated with the call. - * @type {string} - * @memberof InitiateCallback */ 'accountId'?: string; /** * The id of the application associated with the call. - * @type {string} - * @memberof InitiateCallback */ 'applicationId'?: string; /** * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof InitiateCallback */ 'from'?: string; /** * The phone number that received the call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof InitiateCallback */ 'to'?: string; - /** - * - * @type {CallDirectionEnum} - * @memberof InitiateCallback - */ 'direction'?: CallDirectionEnum; /** * The call id associated with the event. - * @type {string} - * @memberof InitiateCallback */ 'callId'?: string; /** * The URL of the call associated with the event. - * @type {string} - * @memberof InitiateCallback */ 'callUrl'?: string; /** * Time the call was started, in ISO 8601 format. - * @type {string} - * @memberof InitiateCallback */ 'startTime'?: string; - /** - * - * @type {Diversion} - * @memberof InitiateCallback - */ 'diversion'?: Diversion; - /** - * - * @type {StirShaken} - * @memberof InitiateCallback - */ 'stirShaken'?: StirShaken; /** * The value of the `User-To-User` header to send within the initial `INVITE`. Must include the encoding parameter as specified in RFC 7433. Only `base64`, `jwt` and `hex` encoding are currently allowed. This value, including the encoding specifier, may not exceed 256 characters. - * @type {string} - * @memberof InitiateCallback */ 'uui'?: string; } diff --git a/models/latest-message-delivery-status-enum.ts b/models/latest-message-delivery-status-enum.ts new file mode 100644 index 0000000..2ad3edb --- /dev/null +++ b/models/latest-message-delivery-status-enum.ts @@ -0,0 +1,30 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Bandwidth + * Bandwidth\'s Communication APIs + * + * The version of the OpenAPI document: 1.0.0 + * Contact: letstalk@bandwidth.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * [DNI-Only](#section/DNI-Only). The current delivery status of the phone number. - ACTIVE: A message was successfully sent to the number (delivery code 0). - DEACTIVATED: A message was not delivered to a number (delivery code 720) - UNKNOWN: Bandwidth cannot find an delivery status entry for the number. + */ + +export const LatestMessageDeliveryStatusEnum = { + Active: 'ACTIVE', + Deactivated: 'DEACTIVATED', + Unknown: 'UNKNOWN' +} as const; + +export type LatestMessageDeliveryStatusEnum = typeof LatestMessageDeliveryStatusEnum[keyof typeof LatestMessageDeliveryStatusEnum]; + + + diff --git a/models/line-type-enum.ts b/models/line-type-enum.ts new file mode 100644 index 0000000..6b2694f --- /dev/null +++ b/models/line-type-enum.ts @@ -0,0 +1,28 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Bandwidth + * Bandwidth\'s Communication APIs + * + * The version of the OpenAPI document: 1.0.0 + * Contact: letstalk@bandwidth.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + + +export const LineTypeEnum = { + Fixed: 'FIXED', + VoipFixed: 'VOIP-FIXED', + Mobile: 'MOBILE', + Voip: 'VOIP' +} as const; + +export type LineTypeEnum = typeof LineTypeEnum[keyof typeof LineTypeEnum]; + + + diff --git a/models/link-schema.ts b/models/link-schema.ts new file mode 100644 index 0000000..189210f --- /dev/null +++ b/models/link-schema.ts @@ -0,0 +1,31 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Bandwidth + * Bandwidth\'s Communication APIs + * + * The version of the OpenAPI document: 1.0.0 + * Contact: letstalk@bandwidth.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +export interface LinkSchema { + /** + * URI of the link. + */ + 'href'?: string; + /** + * Specifies the relationship between this link and the resource. + */ + 'rel'?: string; + /** + * HTTP method to be used. + */ + 'method'?: string; +} + diff --git a/models/link.ts b/models/link.ts index a528414..db18d4c 100644 --- a/models/link.ts +++ b/models/link.ts @@ -14,23 +14,8 @@ -/** - * - * @export - * @interface Link - */ export interface Link { - /** - * - * @type {string} - * @memberof Link - */ 'rel'?: string; - /** - * - * @type {string} - * @memberof Link - */ 'href'?: string; } diff --git a/models/links-object.ts b/models/links-object.ts index 52a5fb3..4502eaf 100644 --- a/models/links-object.ts +++ b/models/links-object.ts @@ -14,34 +14,21 @@ -/** - * - * @export - * @interface LinksObject - */ export interface LinksObject { /** * The first (or only) page of results matching the query. - * @type {string} - * @memberof LinksObject */ 'first'?: string; /** * If more results exist than specified by \'size\', this link returns the next page of \'size\' results. - * @type {string} - * @memberof LinksObject */ 'next'?: string; /** * If the results are more than one page, this link returns the previous page of \'size\' results. - * @type {string} - * @memberof LinksObject */ 'previous'?: string; /** * If more results exist than specified by \'size\', this link return the last page of result. - * @type {string} - * @memberof LinksObject */ 'last'?: string; } diff --git a/models/list-message-direction-enum.ts b/models/list-message-direction-enum.ts index d6c5b1a..4bc436d 100644 --- a/models/list-message-direction-enum.ts +++ b/models/list-message-direction-enum.ts @@ -16,8 +16,6 @@ /** * The direction of the message. One of INBOUND OUTBOUND. - * @export - * @enum {string} */ export const ListMessageDirectionEnum = { diff --git a/models/list-message-item.ts b/models/list-message-item.ts index 45aa7d1..980737b 100644 --- a/models/list-message-item.ts +++ b/models/list-message-item.ts @@ -23,148 +23,88 @@ import type { MessageStatusEnum } from './message-status-enum'; // @ts-ignore import type { MessageTypeEnum } from './message-type-enum'; -/** - * - * @export - * @interface ListMessageItem - */ export interface ListMessageItem { /** * The message id - * @type {string} - * @memberof ListMessageItem */ 'messageId'?: string; /** * The account id associated with this message. - * @type {string} - * @memberof ListMessageItem */ 'accountId'?: string; /** * The source phone number of the message. - * @type {string} - * @memberof ListMessageItem */ 'sourceTn'?: string; /** * The recipient phone number of the message. - * @type {string} - * @memberof ListMessageItem */ 'destinationTn'?: string; - /** - * - * @type {MessageStatusEnum} - * @memberof ListMessageItem - */ 'messageStatus'?: MessageStatusEnum; - /** - * - * @type {ListMessageDirectionEnum} - * @memberof ListMessageItem - */ 'messageDirection'?: ListMessageDirectionEnum; - /** - * - * @type {MessageTypeEnum} - * @memberof ListMessageItem - */ 'messageType'?: MessageTypeEnum; /** * The number of segments the user\'s message is broken into before sending over carrier networks. - * @type {number} - * @memberof ListMessageItem */ 'segmentCount'?: number; /** * The numeric error code of the message. - * @type {number} - * @memberof ListMessageItem */ 'errorCode'?: number; /** * The ISO 8601 datetime of the message. - * @type {string} - * @memberof ListMessageItem */ 'receiveTime'?: string; /** * The name of the carrier. Not currently supported for MMS coming soon. - * @type {string} - * @memberof ListMessageItem */ 'carrierName'?: string | null; /** * The size of the message including message content and headers. - * @type {number} - * @memberof ListMessageItem */ 'messageSize'?: number | null; /** * The length of the message content. - * @type {number} - * @memberof ListMessageItem */ 'messageLength'?: number; /** * The number of attachments the message has. - * @type {number} - * @memberof ListMessageItem */ 'attachmentCount'?: number | null; /** * The number of recipients the message has. - * @type {number} - * @memberof ListMessageItem */ 'recipientCount'?: number | null; /** * The campaign class of the message if it has one. - * @type {string} - * @memberof ListMessageItem */ 'campaignClass'?: string | null; /** * The campaign ID of the message if it has one. - * @type {string} - * @memberof ListMessageItem */ 'campaignId'?: string | null; /** * The Bandwidth latency of the message in seconds. Only available for accounts with the Advanced Quality Metrics feature enabled. - * @type {number} - * @memberof ListMessageItem */ 'bwLatency'?: number | null; /** * The carrier latency of the message in seconds. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled. - * @type {number} - * @memberof ListMessageItem */ 'carrierLatency'?: number | null; /** * The A3 country code of the calling number. - * @type {string} - * @memberof ListMessageItem */ 'callingNumberCountryA3'?: string | null; /** * The A3 country code of the called number. - * @type {string} - * @memberof ListMessageItem */ 'calledNumberCountryA3'?: string | null; /** * The messaging product associated with the message. - * @type {string} - * @memberof ListMessageItem */ 'product'?: string | null; /** * The location ID associated with this message. - * @type {string} - * @memberof ListMessageItem */ 'location'?: string | null; } diff --git a/models/lookup-error-response.ts b/models/lookup-error-response.ts new file mode 100644 index 0000000..bc938ea --- /dev/null +++ b/models/lookup-error-response.ts @@ -0,0 +1,31 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Bandwidth + * Bandwidth\'s Communication APIs + * + * The version of the OpenAPI document: 1.0.0 + * Contact: letstalk@bandwidth.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import type { LinkSchema } from './link-schema'; +// May contain unused imports in some cases +// @ts-ignore +import type { LookupErrorSchema } from './lookup-error-schema'; + +export interface LookupErrorResponse { + 'links'?: Array; + /** + * The phone number lookup response data + */ + 'data'?: object; + 'errors'?: Array; +} + diff --git a/models/tn-lookup-request-error.ts b/models/lookup-error-schema-meta.ts similarity index 64% rename from models/tn-lookup-request-error.ts rename to models/lookup-error-schema-meta.ts index e5e3bf1..17d23b2 100644 --- a/models/tn-lookup-request-error.ts +++ b/models/lookup-error-schema-meta.ts @@ -14,17 +14,15 @@ -/** - * - * @export - * @interface TnLookupRequestError - */ -export interface TnLookupRequestError { +export interface LookupErrorSchemaMeta { + 'phoneNumbers'?: Array; /** - * A description of what validation error occurred. - * @type {string} - * @memberof TnLookupRequestError + * Message describing the error */ 'message'?: string; + /** + * Error code associated with the message + */ + 'code'?: number; } diff --git a/models/lookup-error-schema.ts b/models/lookup-error-schema.ts new file mode 100644 index 0000000..7ec687e --- /dev/null +++ b/models/lookup-error-schema.ts @@ -0,0 +1,35 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Bandwidth + * Bandwidth\'s Communication APIs + * + * The version of the OpenAPI document: 1.0.0 + * Contact: letstalk@bandwidth.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import type { LookupErrorSchemaMeta } from './lookup-error-schema-meta'; + +export interface LookupErrorSchema { + /** + * Validation error code + */ + 'code'?: string; + /** + * Description of validation error + */ + 'description'?: string; + /** + * Type of validation error + */ + 'type'?: string; + 'meta'?: LookupErrorSchemaMeta; +} + diff --git a/models/lookup-result.ts b/models/lookup-result.ts index 2d6917f..7592687 100644 --- a/models/lookup-result.ts +++ b/models/lookup-result.ts @@ -13,66 +13,56 @@ */ +// May contain unused imports in some cases +// @ts-ignore +import type { DeactivationEventEnum } from './deactivation-event-enum'; +// May contain unused imports in some cases +// @ts-ignore +import type { LatestMessageDeliveryStatusEnum } from './latest-message-delivery-status-enum'; +// May contain unused imports in some cases +// @ts-ignore +import type { LineTypeEnum } from './line-type-enum'; /** * Carrier information results for the specified telephone number. - * @export - * @interface LookupResult */ export interface LookupResult { /** - * Our vendor\'s response code. - * @type {number} - * @memberof LookupResult - */ - 'Response Code'?: number; - /** - * Message associated with the response code. - * @type {string} - * @memberof LookupResult + * The telephone number in E.164 format. */ - 'Message'?: string; + 'phoneNumber'?: string; + 'lineType'?: LineTypeEnum; /** - * The telephone number in E.164 format. - * @type {string} - * @memberof LookupResult + * The messaging service provider of the telephone number. */ - 'E.164 Format'?: string; + 'messagingProvider'?: string; /** - * The formatted version of the telephone number. - * @type {string} - * @memberof LookupResult + * The voice service provider of the telephone number. */ - 'Formatted'?: string; + 'voiceProvider'?: string; /** - * The country of the telephone number. - * @type {string} - * @memberof LookupResult + * The country code of the telephone number in ISO 3166-1 alpha-3 format. */ - 'Country'?: string; + 'countryCodeA3'?: string; /** - * The line type of the telephone number. - * @type {string} - * @memberof LookupResult + * [DNI-Only](#section/DNI-Only). The carrier that reported a deactivation event for this phone number. */ - 'Line Type'?: string; + 'deactivationReporter'?: string; /** - * The messaging service provider of the telephone number. - * @type {string} - * @memberof LookupResult + * [DNI-Only](#section/DNI-Only). The datetime the carrier reported a deactivation event. */ - 'Line Provider'?: string; + 'deactivationDate'?: string; + 'deactivationEvent'?: DeactivationEventEnum; + 'latestMessageDeliveryStatus'?: LatestMessageDeliveryStatusEnum; /** - * The first half of the Home Network Identity (HNI). - * @type {string} - * @memberof LookupResult + * [DNI-Only](#section/DNI-Only). The date the phone number entered the status described in `latestMessageDeliveryStatus`. Think of this as the \"start time\" for that status. Value resets every time the `latestMessageDeliveryStatus` changes. */ - 'Mobile Country Code'?: string; + 'initialMessageDeliveryStatusDate'?: string; /** - * The second half of the HNI. - * @type {string} - * @memberof LookupResult + * [DNI-Only](#section/DNI-Only). The date bandwidth last received delivery status information for this phone number. Use this field to understand how up-to-date the `latestMessageDeliveryStatus` is. Value resets every time the `latestMessageDeliveryStatus` changes. */ - 'Mobile Network Code'?: string; + 'latestMessageDeliveryStatusDate'?: string; } + + diff --git a/models/lookup-status.ts b/models/lookup-status.ts deleted file mode 100644 index 8b5770b..0000000 --- a/models/lookup-status.ts +++ /dev/null @@ -1,56 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Bandwidth - * Bandwidth\'s Communication APIs - * - * The version of the OpenAPI document: 1.0.0 - * Contact: letstalk@bandwidth.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -// May contain unused imports in some cases -// @ts-ignore -import type { LookupResult } from './lookup-result'; -// May contain unused imports in some cases -// @ts-ignore -import type { LookupStatusEnum } from './lookup-status-enum'; - -/** - * If requestId exists, the result for that request is returned. See the Examples for details on the various responses that you can receive. Generally, if you see a Response Code of 0 in a result for a TN, information will be available for it. Any other Response Code will indicate no information was available for the TN. - * @export - * @interface LookupStatus - */ -export interface LookupStatus { - /** - * The requestId. - * @type {string} - * @memberof LookupStatus - */ - 'requestId'?: string; - /** - * - * @type {LookupStatusEnum} - * @memberof LookupStatus - */ - 'status'?: LookupStatusEnum; - /** - * The carrier information results for the specified telephone number. - * @type {Array} - * @memberof LookupStatus - */ - 'result'?: Array; - /** - * The telephone numbers whose lookup failed. - * @type {Array} - * @memberof LookupStatus - */ - 'failedTelephoneNumbers'?: Array; -} - - - diff --git a/models/machine-detection-complete-callback.ts b/models/machine-detection-complete-callback.ts index da3746c..8212114 100644 --- a/models/machine-detection-complete-callback.ts +++ b/models/machine-detection-complete-callback.ts @@ -22,93 +22,57 @@ import type { MachineDetectionResult } from './machine-detection-result'; /** * This event is sent to the url informed when requesting a machine detection operation. It contains the machine detection operation result, which can be: human, answering-machine, silence, timeout, error. This event is not sent when sync answering machine detection mode is chosen. - * @export - * @interface MachineDetectionCompleteCallback */ export interface MachineDetectionCompleteCallback { /** * The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. - * @type {string} - * @memberof MachineDetectionCompleteCallback */ 'eventType'?: string; /** * The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. - * @type {string} - * @memberof MachineDetectionCompleteCallback */ 'eventTime'?: string; /** * The user account associated with the call. - * @type {string} - * @memberof MachineDetectionCompleteCallback */ 'accountId'?: string; /** * The id of the application associated with the call. - * @type {string} - * @memberof MachineDetectionCompleteCallback */ 'applicationId'?: string; /** * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof MachineDetectionCompleteCallback */ 'from'?: string; /** * The phone number that received the call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof MachineDetectionCompleteCallback */ 'to'?: string; - /** - * - * @type {CallDirectionEnum} - * @memberof MachineDetectionCompleteCallback - */ 'direction'?: CallDirectionEnum; /** * The call id associated with the event. - * @type {string} - * @memberof MachineDetectionCompleteCallback */ 'callId'?: string; /** * The URL of the call associated with the event. - * @type {string} - * @memberof MachineDetectionCompleteCallback */ 'callUrl'?: string; /** * (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. - * @type {string} - * @memberof MachineDetectionCompleteCallback */ 'enqueuedTime'?: string | null; /** * Time the call was started, in ISO 8601 format. - * @type {string} - * @memberof MachineDetectionCompleteCallback */ 'startTime'?: string; /** * Time the call was answered, in ISO 8601 format. - * @type {string} - * @memberof MachineDetectionCompleteCallback */ 'answerTime'?: string | null; /** * (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. - * @type {string} - * @memberof MachineDetectionCompleteCallback */ 'tag'?: string | null; - /** - * - * @type {MachineDetectionResult} - * @memberof MachineDetectionCompleteCallback - */ 'machineDetectionResult'?: MachineDetectionResult | null; } diff --git a/models/machine-detection-configuration.ts b/models/machine-detection-configuration.ts index ef87f15..ab04051 100644 --- a/models/machine-detection-configuration.ts +++ b/models/machine-detection-configuration.ts @@ -22,98 +22,57 @@ import type { MachineDetectionModeEnum } from './machine-detection-mode-enum'; /** * The machine detection request used to perform machine detection on the call. Currently, there is an issue where decimal values are not getting processed correctly. Please use whole number values. We are working to resolve this issue. Please contact Bandwidth Support if you need more information. - * @export - * @interface MachineDetectionConfiguration */ export interface MachineDetectionConfiguration { - /** - * - * @type {MachineDetectionModeEnum} - * @memberof MachineDetectionConfiguration - */ 'mode'?: MachineDetectionModeEnum; /** * The timeout used for the whole operation, in seconds. If no result is determined in this period, a callback with a `timeout` result is sent. - * @type {number} - * @memberof MachineDetectionConfiguration */ 'detectionTimeout'?: number | null; /** * If no speech is detected in this period, a callback with a \'silence\' result is sent. - * @type {number} - * @memberof MachineDetectionConfiguration */ 'silenceTimeout'?: number | null; /** * When speech has ended and a result couldn\'t be determined based on the audio content itself, this value is used to determine if the speaker is a machine based on the speech duration. If the length of the speech detected is greater than or equal to this threshold, the result will be \'answering-machine\'. If the length of speech detected is below this threshold, the result will be \'human\'. - * @type {number} - * @memberof MachineDetectionConfiguration */ 'speechThreshold'?: number | null; /** * Amount of silence (in seconds) before assuming the callee has finished speaking. - * @type {number} - * @memberof MachineDetectionConfiguration */ 'speechEndThreshold'?: number | null; /** * When an answering machine is detected, the amount of silence (in seconds) before assuming the message has finished playing. If not provided it will default to the speechEndThreshold value. - * @type {number} - * @memberof MachineDetectionConfiguration */ 'machineSpeechEndThreshold'?: number | null; /** * If set to \'true\' and if an answering machine is detected, the \'answering-machine\' callback will be delayed until the machine is done speaking, or an end of message tone is detected, or until the \'detectionTimeout\' is exceeded. If false, the \'answering-machine\' result is sent immediately. - * @type {boolean} - * @memberof MachineDetectionConfiguration */ 'delayResult'?: boolean | null; /** * The URL to send the \'machineDetectionComplete\' webhook when the detection is completed. Only for \'async\' mode. - * @type {string} - * @memberof MachineDetectionConfiguration */ 'callbackUrl'?: string | null; - /** - * - * @type {CallbackMethodEnum} - * @memberof MachineDetectionConfiguration - */ 'callbackMethod'?: CallbackMethodEnum | null; /** * Basic auth username. - * @type {string} - * @memberof MachineDetectionConfiguration */ 'username'?: string | null; /** * Basic auth password. - * @type {string} - * @memberof MachineDetectionConfiguration */ 'password'?: string | null; /** * A fallback URL which, if provided, will be used to retry the machine detection complete webhook delivery in case `callbackUrl` fails to respond - * @type {string} - * @memberof MachineDetectionConfiguration */ 'fallbackUrl'?: string | null; - /** - * - * @type {CallbackMethodEnum} - * @memberof MachineDetectionConfiguration - */ 'fallbackMethod'?: CallbackMethodEnum | null; /** * Basic auth username. - * @type {string} - * @memberof MachineDetectionConfiguration */ 'fallbackUsername'?: string | null; /** * Basic auth password. - * @type {string} - * @memberof MachineDetectionConfiguration */ 'fallbackPassword'?: string | null; } diff --git a/models/machine-detection-mode-enum.ts b/models/machine-detection-mode-enum.ts index 64012eb..fd9e732 100644 --- a/models/machine-detection-mode-enum.ts +++ b/models/machine-detection-mode-enum.ts @@ -16,8 +16,6 @@ /** * The machine detection mode. If set to \'async\', the detection result will be sent in a \'machineDetectionComplete\' callback. If set to \'sync\', the \'answer\' callback will wait for the machine detection to complete and will include its result. - * @export - * @enum {string} */ export const MachineDetectionModeEnum = { diff --git a/models/machine-detection-result.ts b/models/machine-detection-result.ts index 8a7aea4..a90173b 100644 --- a/models/machine-detection-result.ts +++ b/models/machine-detection-result.ts @@ -16,20 +16,14 @@ /** * (optional) if machine detection was requested in sync mode, the result will be specified here. Possible values are the same as the async counterpart: Machine Detection Complete - * @export - * @interface MachineDetectionResult */ export interface MachineDetectionResult { /** * Possible values are answering-machine, human, silence, timeout, or error. - * @type {string} - * @memberof MachineDetectionResult */ 'value'?: string; /** * The amount of time it took to determine the result. - * @type {string} - * @memberof MachineDetectionResult */ 'duration'?: string; } diff --git a/models/media.ts b/models/media.ts index 6c395df..719aef5 100644 --- a/models/media.ts +++ b/models/media.ts @@ -14,29 +14,9 @@ -/** - * - * @export - * @interface Media - */ export interface Media { - /** - * - * @type {string} - * @memberof Media - */ 'content'?: string; - /** - * - * @type {number} - * @memberof Media - */ 'contentLength'?: number; - /** - * - * @type {string} - * @memberof Media - */ 'mediaName'?: string; } diff --git a/models/message-direction-enum.ts b/models/message-direction-enum.ts index b23f8dd..ba7c228 100644 --- a/models/message-direction-enum.ts +++ b/models/message-direction-enum.ts @@ -16,8 +16,6 @@ /** * The direction of the message. One of in out. - * @export - * @enum {string} */ export const MessageDirectionEnum = { diff --git a/models/message-request.ts b/models/message-request.ts index d3e5d7d..7dee1d1 100644 --- a/models/message-request.ts +++ b/models/message-request.ts @@ -17,58 +17,34 @@ // @ts-ignore import type { PriorityEnum } from './priority-enum'; -/** - * - * @export - * @interface MessageRequest - */ export interface MessageRequest { /** * The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. - * @type {string} - * @memberof MessageRequest */ 'applicationId': string; /** * The phone number(s) the message should be sent to in E164 format. - * @type {Set} - * @memberof MessageRequest */ 'to': Set; /** * Either an alphanumeric sender ID or the sender\'s Bandwidth phone number in E.164 format, which must be hosted within Bandwidth and linked to the account that is generating the message. Alphanumeric Sender IDs can contain up to 11 characters, upper-case letters A-Z, lower-case letters a-z, numbers 0-9, space, hyphen -, plus +, underscore _ and ampersand &. Alphanumeric Sender IDs must contain at least one letter. - * @type {string} - * @memberof MessageRequest */ 'from': string; /** * The contents of the text message. Must be 2048 characters or less. - * @type {string} - * @memberof MessageRequest */ 'text'?: string; /** * A list of URLs to include as media attachments as part of the message. Each URL can be at most 4096 characters. - * @type {Array} - * @memberof MessageRequest */ 'media'?: Array; /** * A custom string that will be included in callback events of the message. Max 1024 characters. - * @type {string} - * @memberof MessageRequest */ 'tag'?: string; - /** - * - * @type {PriorityEnum} - * @memberof MessageRequest - */ 'priority'?: PriorityEnum; /** * A string with the date/time value that the message will automatically expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future. - * @type {string} - * @memberof MessageRequest */ 'expiration'?: string; } diff --git a/models/message-status-enum.ts b/models/message-status-enum.ts index 972f175..d4c71b4 100644 --- a/models/message-status-enum.ts +++ b/models/message-status-enum.ts @@ -16,8 +16,6 @@ /** * The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED. - * @export - * @enum {string} */ export const MessageStatusEnum = { diff --git a/models/message-type-enum.ts b/models/message-type-enum.ts index 4290875..bbe3253 100644 --- a/models/message-type-enum.ts +++ b/models/message-type-enum.ts @@ -16,8 +16,6 @@ /** * The type of message. Either SMS or MMS. - * @export - * @enum {string} */ export const MessageTypeEnum = { diff --git a/models/message.ts b/models/message.ts index 288279e..454d62e 100644 --- a/models/message.ts +++ b/models/message.ts @@ -20,88 +20,51 @@ import type { MessageDirectionEnum } from './message-direction-enum'; // @ts-ignore import type { PriorityEnum } from './priority-enum'; -/** - * - * @export - * @interface Message - */ export interface Message { /** * The id of the message. - * @type {string} - * @memberof Message */ 'id'?: string; /** * The Bandwidth phone number associated with the message. - * @type {string} - * @memberof Message */ 'owner'?: string; /** * The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. - * @type {string} - * @memberof Message */ 'applicationId'?: string; /** * The datetime stamp of the message in ISO 8601 - * @type {string} - * @memberof Message */ 'time'?: string; /** * The number of segments the user\'s message is broken into before sending over carrier networks. - * @type {number} - * @memberof Message */ 'segmentCount'?: number; - /** - * - * @type {MessageDirectionEnum} - * @memberof Message - */ 'direction'?: MessageDirectionEnum; /** * The phone number recipients of the message. - * @type {Set} - * @memberof Message */ 'to'?: Set; /** * The phone number the message was sent from. - * @type {string} - * @memberof Message */ 'from'?: string; /** * The list of media URLs sent in the message. Including a `filename` field in the `Content-Disposition` header of the media linked with a URL will set the displayed file name. This is a best practice to ensure that your media has a readable file name. - * @type {Set} - * @memberof Message */ 'media'?: Set; /** * The contents of the message. - * @type {string} - * @memberof Message */ 'text'?: string; /** * A custom string that will be included in callback events of the message. Max 1024 characters. - * @type {string} - * @memberof Message */ 'tag'?: string; - /** - * - * @type {PriorityEnum} - * @memberof Message - */ 'priority'?: PriorityEnum; /** * A string with the date/time value that the message will automatically expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future. - * @type {string} - * @memberof Message */ 'expiration'?: string; } diff --git a/models/messages-list.ts b/models/messages-list.ts index e7f80b7..577e49f 100644 --- a/models/messages-list.ts +++ b/models/messages-list.ts @@ -20,29 +20,12 @@ import type { ListMessageItem } from './list-message-item'; // @ts-ignore import type { PageInfo } from './page-info'; -/** - * - * @export - * @interface MessagesList - */ export interface MessagesList { /** * The total number of messages matched by the search. When the request has limitTotalCount set to true this value is limited to 10,000. - * @type {number} - * @memberof MessagesList */ 'totalCount'?: number; - /** - * - * @type {PageInfo} - * @memberof MessagesList - */ 'pageInfo'?: PageInfo; - /** - * - * @type {Array} - * @memberof MessagesList - */ 'messages'?: Array; } diff --git a/models/messaging-code-response.ts b/models/messaging-code-response.ts index 628af5a..718fa7e 100644 --- a/models/messaging-code-response.ts +++ b/models/messaging-code-response.ts @@ -14,16 +14,9 @@ -/** - * - * @export - * @interface MessagingCodeResponse - */ export interface MessagingCodeResponse { /** * Messaging API Message ID. - * @type {string} - * @memberof MessagingCodeResponse */ 'messageId'?: string; } diff --git a/models/messaging-request-error.ts b/models/messaging-request-error.ts index b244fca..293431a 100644 --- a/models/messaging-request-error.ts +++ b/models/messaging-request-error.ts @@ -14,23 +14,8 @@ -/** - * - * @export - * @interface MessagingRequestError - */ export interface MessagingRequestError { - /** - * - * @type {string} - * @memberof MessagingRequestError - */ 'type': string; - /** - * - * @type {string} - * @memberof MessagingRequestError - */ 'description': string; } diff --git a/models/mfa-forbidden-request-error.ts b/models/mfa-forbidden-request-error.ts index d8ae542..93b32f5 100644 --- a/models/mfa-forbidden-request-error.ts +++ b/models/mfa-forbidden-request-error.ts @@ -14,16 +14,9 @@ -/** - * - * @export - * @interface MfaForbiddenRequestError - */ export interface MfaForbiddenRequestError { /** * The message containing the reason behind the request being forbidden. - * @type {string} - * @memberof MfaForbiddenRequestError */ 'message'?: string; } diff --git a/models/mfa-request-error.ts b/models/mfa-request-error.ts index 82115ba..b32e75a 100644 --- a/models/mfa-request-error.ts +++ b/models/mfa-request-error.ts @@ -14,22 +14,13 @@ -/** - * - * @export - * @interface MfaRequestError - */ export interface MfaRequestError { /** * A message describing the error with your request. - * @type {string} - * @memberof MfaRequestError */ 'error'?: string; /** * The associated requestId from AWS. - * @type {string} - * @memberof MfaRequestError */ 'requestId'?: string; } diff --git a/models/mfa-unauthorized-request-error.ts b/models/mfa-unauthorized-request-error.ts index b810669..737eb52 100644 --- a/models/mfa-unauthorized-request-error.ts +++ b/models/mfa-unauthorized-request-error.ts @@ -14,16 +14,9 @@ -/** - * - * @export - * @interface MfaUnauthorizedRequestError - */ export interface MfaUnauthorizedRequestError { /** * Unauthorized - * @type {string} - * @memberof MfaUnauthorizedRequestError */ 'message'?: string; } diff --git a/models/mms-message-content-file.ts b/models/mms-message-content-file.ts index a095c29..a06be6a 100644 --- a/models/mms-message-content-file.ts +++ b/models/mms-message-content-file.ts @@ -14,16 +14,9 @@ -/** - * - * @export - * @interface MmsMessageContentFile - */ export interface MmsMessageContentFile { /** * The URL of a media attachment. For MMS, the API limits file size to 3.5MB. Specific carriers and channels may have a smaller limit that could cause a large file to fail, see [here](https://support.bandwidth.com/hc/en-us/articles/360014235473-What-are-the-MMS-file-size-limits) for more details. - * @type {string} - * @memberof MmsMessageContentFile */ 'fileUrl': string; } diff --git a/models/mms-message-content.ts b/models/mms-message-content.ts index b18e555..b5c10be 100644 --- a/models/mms-message-content.ts +++ b/models/mms-message-content.ts @@ -17,23 +17,11 @@ // @ts-ignore import type { MmsMessageContentFile } from './mms-message-content-file'; -/** - * - * @export - * @interface MmsMessageContent - */ export interface MmsMessageContent { /** * The contents of the text message. Must be 2048 characters or less. - * @type {string} - * @memberof MmsMessageContent */ 'text'?: string; - /** - * - * @type {Array} - * @memberof MmsMessageContent - */ 'media'?: Array; } diff --git a/models/model-error.ts b/models/model-error.ts index ec1211f..8fe991b 100644 --- a/models/model-error.ts +++ b/models/model-error.ts @@ -17,29 +17,9 @@ // @ts-ignore import type { TelephoneNumber } from './telephone-number'; -/** - * - * @export - * @interface ModelError - */ export interface ModelError { - /** - * - * @type {number} - * @memberof ModelError - */ 'code'?: number; - /** - * - * @type {string} - * @memberof ModelError - */ 'description'?: string; - /** - * - * @type {Array} - * @memberof ModelError - */ 'telephoneNumbers'?: Array; } diff --git a/models/multi-channel-action-calendar-event.ts b/models/multi-channel-action-calendar-event.ts index bf3bc66..7fc8036 100644 --- a/models/multi-channel-action-calendar-event.ts +++ b/models/multi-channel-action-calendar-event.ts @@ -22,7 +22,6 @@ import type { RbmActionTypeEnum } from './rbm-action-type-enum'; /** * @type MultiChannelActionCalendarEvent - * @export */ export type MultiChannelActionCalendarEvent = RbmActionBase; diff --git a/models/multi-channel-action.ts b/models/multi-channel-action.ts index b934dc6..5e6688f 100644 --- a/models/multi-channel-action.ts +++ b/models/multi-channel-action.ts @@ -34,7 +34,6 @@ import type { RbmActionViewLocation } from './rbm-action-view-location'; /** * @type MultiChannelAction - * @export */ export type MultiChannelAction = { type: 'CREATE_CALENDAR_EVENT' } & MultiChannelActionCalendarEvent | { type: 'DIAL_PHONE' } & RbmActionDial | { type: 'OPEN_URL' } & RbmActionOpenUrl | { type: 'REPLY' } & RbmActionBase | { type: 'REQUEST_LOCATION' } & RbmActionBase | { type: 'SHOW_LOCATION' } & RbmActionViewLocation; diff --git a/models/multi-channel-channel-list-object-content.ts b/models/multi-channel-channel-list-object-content.ts index f543524..28607b2 100644 --- a/models/multi-channel-channel-list-object-content.ts +++ b/models/multi-channel-channel-list-object-content.ts @@ -50,7 +50,6 @@ import type { ThumbnailAlignmentEnum } from './thumbnail-alignment-enum'; /** * @type MultiChannelChannelListObjectContent * The content of the message. - * @export */ export type MultiChannelChannelListObjectContent = MmsMessageContent | RbmMessageContentRichCard | RbmMessageContentText | RbmMessageMedia | SmsMessageContent; diff --git a/models/multi-channel-channel-list-object.ts b/models/multi-channel-channel-list-object.ts index e4f61e7..4e7c23d 100644 --- a/models/multi-channel-channel-list-object.ts +++ b/models/multi-channel-channel-list-object.ts @@ -20,35 +20,16 @@ import type { MultiChannelChannelListObjectContent } from './multi-channel-chann // @ts-ignore import type { MultiChannelMessageChannelEnum } from './multi-channel-message-channel-enum'; -/** - * - * @export - * @interface MultiChannelChannelListObject - */ export interface MultiChannelChannelListObject { /** * The sender ID of the message. This could be an alphanumeric sender ID. - * @type {string} - * @memberof MultiChannelChannelListObject */ 'from': string; /** * The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. - * @type {string} - * @memberof MultiChannelChannelListObject */ 'applicationId': string; - /** - * - * @type {MultiChannelMessageChannelEnum} - * @memberof MultiChannelChannelListObject - */ 'channel': MultiChannelMessageChannelEnum; - /** - * - * @type {MultiChannelChannelListObjectContent} - * @memberof MultiChannelChannelListObject - */ 'content': MultiChannelChannelListObjectContent; } diff --git a/models/multi-channel-error.ts b/models/multi-channel-error.ts index dd1b508..879ddc7 100644 --- a/models/multi-channel-error.ts +++ b/models/multi-channel-error.ts @@ -20,29 +20,9 @@ import type { ErrorObject } from './error-object'; // @ts-ignore import type { Link } from './link'; -/** - * - * @export - * @interface MultiChannelError - */ export interface MultiChannelError { - /** - * - * @type {Array} - * @memberof MultiChannelError - */ 'links'?: Array; - /** - * - * @type {object} - * @memberof MultiChannelError - */ 'data'?: object | null; - /** - * - * @type {Array} - * @memberof MultiChannelError - */ 'errors'?: Array; } diff --git a/models/multi-channel-message-channel-enum.ts b/models/multi-channel-message-channel-enum.ts index 61e39bc..e3b4ec9 100644 --- a/models/multi-channel-message-channel-enum.ts +++ b/models/multi-channel-message-channel-enum.ts @@ -16,8 +16,6 @@ /** * The channel of the multi-channel message. - * @export - * @enum {string} */ export const MultiChannelMessageChannelEnum = { diff --git a/models/multi-channel-message-content.ts b/models/multi-channel-message-content.ts index e26cc24..acaaa6e 100644 --- a/models/multi-channel-message-content.ts +++ b/models/multi-channel-message-content.ts @@ -19,21 +19,9 @@ import type { RbmMessageContentFile } from './rbm-message-content-file'; /** * The structure of the content field of a multichannel message. - * @export - * @interface MultiChannelMessageContent */ export interface MultiChannelMessageContent { - /** - * - * @type {string} - * @memberof MultiChannelMessageContent - */ 'text'?: string; - /** - * - * @type {RbmMessageContentFile} - * @memberof MultiChannelMessageContent - */ 'media'?: RbmMessageContentFile; } diff --git a/models/multi-channel-message-request.ts b/models/multi-channel-message-request.ts index f63b4b6..8734632 100644 --- a/models/multi-channel-message-request.ts +++ b/models/multi-channel-message-request.ts @@ -22,38 +22,23 @@ import type { PriorityEnum } from './priority-enum'; /** * Multi-Channel Message Request - * @export - * @interface MultiChannelMessageRequest */ export interface MultiChannelMessageRequest { /** * The phone number the message should be sent to in E164 format. - * @type {string} - * @memberof MultiChannelMessageRequest */ 'to': string; /** * A list of message bodies. The messages will be attempted in the order they are listed. Once a message sends successfully, the others will be ignored. - * @type {Array} - * @memberof MultiChannelMessageRequest */ 'channelList': Array; /** * A custom string that will be included in callback events of the message. Max 1024 characters. - * @type {string} - * @memberof MultiChannelMessageRequest */ 'tag'?: string; - /** - * - * @type {PriorityEnum} - * @memberof MultiChannelMessageRequest - */ 'priority'?: PriorityEnum; /** * A string with the date/time value that the message will automatically expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future. - * @type {string} - * @memberof MultiChannelMessageRequest */ 'expiration'?: string; } diff --git a/models/multi-channel-message-response-data-channel-list-inner.ts b/models/multi-channel-message-response-data-channel-list-inner.ts index 4d1ec76..c29dd6a 100644 --- a/models/multi-channel-message-response-data-channel-list-inner.ts +++ b/models/multi-channel-message-response-data-channel-list-inner.ts @@ -25,7 +25,6 @@ import type { MultiChannelMessageChannelEnum } from './multi-channel-message-cha /** * @type MultiChannelMessageResponseDataChannelListInner - * @export */ export type MultiChannelMessageResponseDataChannelListInner = MultiChannelChannelListObject; diff --git a/models/multi-channel-message-response-data.ts b/models/multi-channel-message-response-data.ts index 556f7a2..1b0db97 100644 --- a/models/multi-channel-message-response-data.ts +++ b/models/multi-channel-message-response-data.ts @@ -25,56 +25,32 @@ import type { PriorityEnum } from './priority-enum'; /** * The data returned in a multichannel message response. - * @export - * @interface MultiChannelMessageResponseData */ export interface MultiChannelMessageResponseData { /** * The ID of the message. - * @type {string} - * @memberof MultiChannelMessageResponseData */ 'id': string; /** * The time the message was received by the Bandwidth API. - * @type {string} - * @memberof MultiChannelMessageResponseData */ 'time': string; - /** - * - * @type {MessageDirectionEnum} - * @memberof MultiChannelMessageResponseData - */ 'direction': MessageDirectionEnum; /** * The destination phone number(s) of the message, in E164 format. - * @type {Set} - * @memberof MultiChannelMessageResponseData */ 'to': Set; /** * A list of message bodies. The messages will be attempted in the order they are listed. Once a message sends successfully, the others will be ignored. - * @type {Array} - * @memberof MultiChannelMessageResponseData */ 'channelList': Array; /** * A custom string that will be included in callback events of the message. Max 1024 characters. - * @type {string} - * @memberof MultiChannelMessageResponseData */ 'tag'?: string; - /** - * - * @type {PriorityEnum} - * @memberof MultiChannelMessageResponseData - */ 'priority'?: PriorityEnum; /** * A string with the date/time value that the message will automatically expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future. - * @type {string} - * @memberof MultiChannelMessageResponseData */ 'expiration'?: string; } diff --git a/models/opt-in-workflow.ts b/models/opt-in-workflow.ts index 2e85892..d77ebdf 100644 --- a/models/opt-in-workflow.ts +++ b/models/opt-in-workflow.ts @@ -14,29 +14,9 @@ -/** - * - * @export - * @interface OptInWorkflow - */ export interface OptInWorkflow { - /** - * - * @type {string} - * @memberof OptInWorkflow - */ 'description': string; - /** - * - * @type {Array} - * @memberof OptInWorkflow - */ 'imageUrls': Array; - /** - * - * @type {string} - * @memberof OptInWorkflow - */ 'confirmationResponse'?: string | null; } diff --git a/models/page-info.ts b/models/page-info.ts index e0495f8..ff9fe5d 100644 --- a/models/page-info.ts +++ b/models/page-info.ts @@ -14,34 +14,21 @@ -/** - * - * @export - * @interface PageInfo - */ export interface PageInfo { /** * The link to the previous page for pagination. - * @type {string} - * @memberof PageInfo */ 'prevPage'?: string; /** * The link to the next page for pagination. - * @type {string} - * @memberof PageInfo */ 'nextPage'?: string; /** * The isolated pagination token for the previous page. - * @type {string} - * @memberof PageInfo */ 'prevPageToken'?: string; /** * The isolated pagination token for the next page. - * @type {string} - * @memberof PageInfo */ 'nextPageToken'?: string; } diff --git a/models/priority-enum.ts b/models/priority-enum.ts index f824d20..db3d87b 100644 --- a/models/priority-enum.ts +++ b/models/priority-enum.ts @@ -16,8 +16,6 @@ /** * Specifies the message\'s sending priority with respect to other messages in your account. For best results and optimal throughput, reserve the \'high\' priority setting for critical messages only. - * @export - * @enum {string} */ export const PriorityEnum = { diff --git a/models/product-type-enum.ts b/models/product-type-enum.ts index af1ab1e..b078361 100644 --- a/models/product-type-enum.ts +++ b/models/product-type-enum.ts @@ -16,8 +16,6 @@ /** * The type of product associated with the message. - * @export - * @enum {string} */ export const ProductTypeEnum = { diff --git a/models/rbm-action-base.ts b/models/rbm-action-base.ts index 389d48d..5819d0c 100644 --- a/models/rbm-action-base.ts +++ b/models/rbm-action-base.ts @@ -17,28 +17,14 @@ // @ts-ignore import type { RbmActionTypeEnum } from './rbm-action-type-enum'; -/** - * - * @export - * @interface RbmActionBase - */ export interface RbmActionBase { - /** - * - * @type {RbmActionTypeEnum} - * @memberof RbmActionBase - */ 'type': RbmActionTypeEnum; /** * Displayed text for user to click - * @type {string} - * @memberof RbmActionBase */ 'text': string; /** * Base64 payload the customer receives when the reply is clicked. - * @type {string} - * @memberof RbmActionBase */ 'postbackData': string; } diff --git a/models/rbm-action-dial.ts b/models/rbm-action-dial.ts index 4105867..95df4d0 100644 --- a/models/rbm-action-dial.ts +++ b/models/rbm-action-dial.ts @@ -22,7 +22,6 @@ import type { RbmActionTypeEnum } from './rbm-action-type-enum'; /** * @type RbmActionDial - * @export */ export type RbmActionDial = RbmActionBase; diff --git a/models/rbm-action-open-url.ts b/models/rbm-action-open-url.ts index 70743c0..627df50 100644 --- a/models/rbm-action-open-url.ts +++ b/models/rbm-action-open-url.ts @@ -22,7 +22,6 @@ import type { RbmActionTypeEnum } from './rbm-action-type-enum'; /** * @type RbmActionOpenUrl - * @export */ export type RbmActionOpenUrl = RbmActionBase; diff --git a/models/rbm-action-type-enum.ts b/models/rbm-action-type-enum.ts index 431cf0a..8eb7d82 100644 --- a/models/rbm-action-type-enum.ts +++ b/models/rbm-action-type-enum.ts @@ -14,11 +14,6 @@ -/** - * - * @export - * @enum {string} - */ export const RbmActionTypeEnum = { Reply: 'REPLY', diff --git a/models/rbm-action-view-location.ts b/models/rbm-action-view-location.ts index d33417c..d507e56 100644 --- a/models/rbm-action-view-location.ts +++ b/models/rbm-action-view-location.ts @@ -22,7 +22,6 @@ import type { RbmActionTypeEnum } from './rbm-action-type-enum'; /** * @type RbmActionViewLocation - * @export */ export type RbmActionViewLocation = RbmActionBase; diff --git a/models/rbm-card-content-media.ts b/models/rbm-card-content-media.ts index 246fba3..e8ea2cb 100644 --- a/models/rbm-card-content-media.ts +++ b/models/rbm-card-content-media.ts @@ -22,7 +22,6 @@ import type { RbmMessageContentFile } from './rbm-message-content-file'; /** * @type RbmCardContentMedia - * @export */ export type RbmCardContentMedia = RbmMessageContentFile; diff --git a/models/rbm-card-content.ts b/models/rbm-card-content.ts index 4170f5b..b11fb43 100644 --- a/models/rbm-card-content.ts +++ b/models/rbm-card-content.ts @@ -20,34 +20,18 @@ import type { MultiChannelAction } from './multi-channel-action'; // @ts-ignore import type { RbmCardContentMedia } from './rbm-card-content-media'; -/** - * - * @export - * @interface RbmCardContent - */ export interface RbmCardContent { /** * The title of the card. Must be 200 characters or less. - * @type {string} - * @memberof RbmCardContent */ 'title'?: string; /** * The description of the card. Must be 2000 characters or less. - * @type {string} - * @memberof RbmCardContent */ 'description'?: string; - /** - * - * @type {RbmCardContentMedia} - * @memberof RbmCardContent - */ 'media'?: RbmCardContentMedia; /** * An array of suggested actions for the recipient that will be displayed on the rich card. - * @type {Array} - * @memberof RbmCardContent */ 'suggestions'?: Array; } diff --git a/models/rbm-location-response.ts b/models/rbm-location-response.ts index 35c3fec..ea6bb50 100644 --- a/models/rbm-location-response.ts +++ b/models/rbm-location-response.ts @@ -14,22 +14,13 @@ -/** - * - * @export - * @interface RbmLocationResponse - */ export interface RbmLocationResponse { /** * The latitude of the client\'s location. - * @type {number} - * @memberof RbmLocationResponse */ 'latitude'?: number; /** * The longitude of the client\'s location. - * @type {number} - * @memberof RbmLocationResponse */ 'longitude'?: number; } diff --git a/models/rbm-media-height-enum.ts b/models/rbm-media-height-enum.ts index e82e6c6..b5265c8 100644 --- a/models/rbm-media-height-enum.ts +++ b/models/rbm-media-height-enum.ts @@ -16,8 +16,6 @@ /** * The height of the media. - * @export - * @enum {string} */ export const RbmMediaHeightEnum = { diff --git a/models/rbm-message-carousel-card.ts b/models/rbm-message-carousel-card.ts index a09a725..81c7224 100644 --- a/models/rbm-message-carousel-card.ts +++ b/models/rbm-message-carousel-card.ts @@ -23,28 +23,11 @@ import type { MultiChannelAction } from './multi-channel-action'; // @ts-ignore import type { RbmCardContent } from './rbm-card-content'; -/** - * - * @export - * @interface RbmMessageCarouselCard - */ export interface RbmMessageCarouselCard { - /** - * - * @type {CardWidthEnum} - * @memberof RbmMessageCarouselCard - */ 'cardWidth': CardWidthEnum; - /** - * - * @type {Array} - * @memberof RbmMessageCarouselCard - */ 'cardContents': Array; /** * An array of suggested actions for the recipient. - * @type {Array} - * @memberof RbmMessageCarouselCard */ 'suggestions'?: Array; } diff --git a/models/rbm-message-content-file.ts b/models/rbm-message-content-file.ts index cbf3acf..0b14ada 100644 --- a/models/rbm-message-content-file.ts +++ b/models/rbm-message-content-file.ts @@ -14,22 +14,13 @@ -/** - * - * @export - * @interface RbmMessageContentFile - */ export interface RbmMessageContentFile { /** * The URL of the media file. 100MB is the maximum file size. - * @type {string} - * @memberof RbmMessageContentFile */ 'fileUrl': string; /** * The URL of the thumbnail image. Applies only to video file media. - * @type {string} - * @memberof RbmMessageContentFile */ 'thumbnailUrl'?: string; } diff --git a/models/rbm-message-content-rich-card.ts b/models/rbm-message-content-rich-card.ts index 17469d8..573d431 100644 --- a/models/rbm-message-content-rich-card.ts +++ b/models/rbm-message-content-rich-card.ts @@ -37,7 +37,6 @@ import type { ThumbnailAlignmentEnum } from './thumbnail-alignment-enum'; /** * @type RbmMessageContentRichCard - * @export */ export type RbmMessageContentRichCard = RbmMessageCarouselCard | RbmStandaloneCard; diff --git a/models/rbm-message-content-text.ts b/models/rbm-message-content-text.ts index 4c43a6c..619106a 100644 --- a/models/rbm-message-content-text.ts +++ b/models/rbm-message-content-text.ts @@ -17,22 +17,13 @@ // @ts-ignore import type { MultiChannelAction } from './multi-channel-action'; -/** - * - * @export - * @interface RbmMessageContentText - */ export interface RbmMessageContentText { /** * The text associated with the message. Must be 3270 characters or less - * @type {string} - * @memberof RbmMessageContentText */ 'text': string; /** * An array of suggested actions for the recipient. - * @type {Array} - * @memberof RbmMessageContentText */ 'suggestions'?: Array; } diff --git a/models/rbm-message-media.ts b/models/rbm-message-media.ts index 218b180..c196bef 100644 --- a/models/rbm-message-media.ts +++ b/models/rbm-message-media.ts @@ -20,22 +20,10 @@ import type { MultiChannelAction } from './multi-channel-action'; // @ts-ignore import type { RbmMessageContentFile } from './rbm-message-content-file'; -/** - * - * @export - * @interface RbmMessageMedia - */ export interface RbmMessageMedia { - /** - * - * @type {RbmMessageContentFile} - * @memberof RbmMessageMedia - */ 'media': RbmMessageContentFile; /** * An array of suggested actions for the recipient. - * @type {Array} - * @memberof RbmMessageMedia */ 'suggestions'?: Array; } diff --git a/models/rbm-standalone-card.ts b/models/rbm-standalone-card.ts index eda7533..5072ce8 100644 --- a/models/rbm-standalone-card.ts +++ b/models/rbm-standalone-card.ts @@ -26,34 +26,12 @@ import type { StandaloneCardOrientationEnum } from './standalone-card-orientatio // @ts-ignore import type { ThumbnailAlignmentEnum } from './thumbnail-alignment-enum'; -/** - * - * @export - * @interface RbmStandaloneCard - */ export interface RbmStandaloneCard { - /** - * - * @type {StandaloneCardOrientationEnum} - * @memberof RbmStandaloneCard - */ 'orientation': StandaloneCardOrientationEnum; - /** - * - * @type {ThumbnailAlignmentEnum} - * @memberof RbmStandaloneCard - */ 'thumbnailImageAlignment': ThumbnailAlignmentEnum; - /** - * - * @type {RbmCardContent} - * @memberof RbmStandaloneCard - */ 'cardContent': RbmCardContent; /** * An array of suggested actions for the recipient. - * @type {Array} - * @memberof RbmStandaloneCard */ 'suggestions'?: Array; } diff --git a/models/rbm-suggestion-response.ts b/models/rbm-suggestion-response.ts index 1434f03..c346d37 100644 --- a/models/rbm-suggestion-response.ts +++ b/models/rbm-suggestion-response.ts @@ -14,22 +14,13 @@ -/** - * - * @export - * @interface RbmSuggestionResponse - */ export interface RbmSuggestionResponse { /** * The text associated with the suggestion response. - * @type {string} - * @memberof RbmSuggestionResponse */ 'text'?: string; /** * Base64 payload the customer receives when the reply is clicked. - * @type {string} - * @memberof RbmSuggestionResponse */ 'postbackData'?: string; } diff --git a/models/recording-available-callback.ts b/models/recording-available-callback.ts index 64f6f58..0217e2d 100644 --- a/models/recording-available-callback.ts +++ b/models/recording-available-callback.ts @@ -22,140 +22,88 @@ import type { FileFormatEnum } from './file-format-enum'; /** * The Recording Available event is sent after a recording has been processed. It indicates that the recording is available for download. - * @export - * @interface RecordingAvailableCallback */ export interface RecordingAvailableCallback { /** * The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. - * @type {string} - * @memberof RecordingAvailableCallback */ 'eventType'?: string; /** * The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. - * @type {string} - * @memberof RecordingAvailableCallback */ 'eventTime'?: string; /** * The user account associated with the call. - * @type {string} - * @memberof RecordingAvailableCallback */ 'accountId'?: string; /** * The id of the application associated with the call. - * @type {string} - * @memberof RecordingAvailableCallback */ 'applicationId'?: string; /** * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof RecordingAvailableCallback */ 'from'?: string; /** * The phone number that received the call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof RecordingAvailableCallback */ 'to'?: string; - /** - * - * @type {CallDirectionEnum} - * @memberof RecordingAvailableCallback - */ 'direction'?: CallDirectionEnum; /** * The call id associated with the event. - * @type {string} - * @memberof RecordingAvailableCallback */ 'callId'?: string; /** * The URL of the call associated with the event. - * @type {string} - * @memberof RecordingAvailableCallback */ 'callUrl'?: string; /** * (optional) If the event is related to the B leg of a , the call id of the original call leg that executed the . Otherwise, this field will not be present. - * @type {string} - * @memberof RecordingAvailableCallback */ 'parentCallId'?: string; /** * The unique ID of this recording - * @type {string} - * @memberof RecordingAvailableCallback */ 'recordingId'?: string; /** * The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded. - * @type {string} - * @memberof RecordingAvailableCallback */ 'mediaUrl'?: string | null; /** * (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. - * @type {string} - * @memberof RecordingAvailableCallback */ 'enqueuedTime'?: string | null; /** * Time the call was started, in ISO 8601 format. - * @type {string} - * @memberof RecordingAvailableCallback */ 'startTime'?: string; /** * The time that the recording ended in ISO-8601 format - * @type {string} - * @memberof RecordingAvailableCallback */ 'endTime'?: string; /** * The duration of the recording in ISO-8601 format - * @type {string} - * @memberof RecordingAvailableCallback */ 'duration'?: string; - /** - * - * @type {FileFormatEnum} - * @memberof RecordingAvailableCallback - */ 'fileFormat'?: FileFormatEnum; /** * Always `1` for conference recordings; multi-channel recordings are not supported on conferences. - * @type {number} - * @memberof RecordingAvailableCallback */ 'channels'?: number; /** * (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. - * @type {string} - * @memberof RecordingAvailableCallback */ 'tag'?: string | null; /** * The current status of the process. For recording, current possible values are \'processing\', \'partial\', \'complete\', \'deleted\', and \'error\'. For transcriptions, current possible values are \'none\', \'processing\', \'available\', \'error\', \'timeout\', \'file-size-too-big\', and \'file-size-too-small\'. Additional states may be added in the future, so your application must be tolerant of unknown values. - * @type {string} - * @memberof RecordingAvailableCallback */ 'status'?: string; /** * The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof RecordingAvailableCallback */ 'transferCallerId'?: string; /** * The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof RecordingAvailableCallback */ 'transferTo'?: string; } diff --git a/models/recording-complete-callback.ts b/models/recording-complete-callback.ts index ec23b4d..569e7b1 100644 --- a/models/recording-complete-callback.ts +++ b/models/recording-complete-callback.ts @@ -22,140 +22,88 @@ import type { FileFormatEnum } from './file-format-enum'; /** * The Record Complete event is sent after a verb has executed if the call is still active. The BXML returned by this callback is executed next. When the recording is available for download, a Recording Available event will be sent. - * @export - * @interface RecordingCompleteCallback */ export interface RecordingCompleteCallback { /** * The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. - * @type {string} - * @memberof RecordingCompleteCallback */ 'eventType'?: string; /** * The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. - * @type {string} - * @memberof RecordingCompleteCallback */ 'eventTime'?: string; /** * The user account associated with the call. - * @type {string} - * @memberof RecordingCompleteCallback */ 'accountId'?: string; /** * The id of the application associated with the call. - * @type {string} - * @memberof RecordingCompleteCallback */ 'applicationId'?: string; /** * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof RecordingCompleteCallback */ 'from'?: string; /** * The phone number that received the call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof RecordingCompleteCallback */ 'to'?: string; - /** - * - * @type {CallDirectionEnum} - * @memberof RecordingCompleteCallback - */ 'direction'?: CallDirectionEnum; /** * The call id associated with the event. - * @type {string} - * @memberof RecordingCompleteCallback */ 'callId'?: string; /** * The URL of the call associated with the event. - * @type {string} - * @memberof RecordingCompleteCallback */ 'callUrl'?: string; /** * (optional) If the event is related to the B leg of a , the call id of the original call leg that executed the . Otherwise, this field will not be present. - * @type {string} - * @memberof RecordingCompleteCallback */ 'parentCallId'?: string; /** * The unique ID of this recording - * @type {string} - * @memberof RecordingCompleteCallback */ 'recordingId'?: string; /** * The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded. - * @type {string} - * @memberof RecordingCompleteCallback */ 'mediaUrl'?: string | null; /** * (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. - * @type {string} - * @memberof RecordingCompleteCallback */ 'enqueuedTime'?: string | null; /** * Time the call was started, in ISO 8601 format. - * @type {string} - * @memberof RecordingCompleteCallback */ 'startTime'?: string; /** * Time the call was answered, in ISO 8601 format. - * @type {string} - * @memberof RecordingCompleteCallback */ 'answerTime'?: string | null; /** * The time that the recording ended in ISO-8601 format - * @type {string} - * @memberof RecordingCompleteCallback */ 'endTime'?: string; /** * The duration of the recording in ISO-8601 format - * @type {string} - * @memberof RecordingCompleteCallback */ 'duration'?: string; - /** - * - * @type {FileFormatEnum} - * @memberof RecordingCompleteCallback - */ 'fileFormat'?: FileFormatEnum; /** * Always `1` for conference recordings; multi-channel recordings are not supported on conferences. - * @type {number} - * @memberof RecordingCompleteCallback */ 'channels'?: number; /** * (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. - * @type {string} - * @memberof RecordingCompleteCallback */ 'tag'?: string | null; /** * The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof RecordingCompleteCallback */ 'transferCallerId'?: string; /** * The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof RecordingCompleteCallback */ 'transferTo'?: string; } diff --git a/models/recording-state-enum.ts b/models/recording-state-enum.ts index d90083c..99ca352 100644 --- a/models/recording-state-enum.ts +++ b/models/recording-state-enum.ts @@ -16,8 +16,6 @@ /** * The recording state. Possible values: `paused` to pause an active recording `recording` to resume a paused recording - * @export - * @enum {string} */ export const RecordingStateEnum = { diff --git a/models/recording-transcription-metadata.ts b/models/recording-transcription-metadata.ts index edd0b96..6620042 100644 --- a/models/recording-transcription-metadata.ts +++ b/models/recording-transcription-metadata.ts @@ -16,32 +16,22 @@ /** * If the recording was transcribed, metadata about the transcription - * @export - * @interface RecordingTranscriptionMetadata */ export interface RecordingTranscriptionMetadata { /** * The unique transcription ID - * @type {string} - * @memberof RecordingTranscriptionMetadata */ 'id'?: string; /** * The current status of the process. For recording, current possible values are \'processing\', \'partial\', \'complete\', \'deleted\', and \'error\'. For transcriptions, current possible values are \'none\', \'processing\', \'available\', \'error\', \'timeout\', \'file-size-too-big\', and \'file-size-too-small\'. Additional states may be added in the future, so your application must be tolerant of unknown values. - * @type {string} - * @memberof RecordingTranscriptionMetadata */ 'status'?: string; /** * The time that the transcription was completed - * @type {string} - * @memberof RecordingTranscriptionMetadata */ 'completedTime'?: string; /** * The URL of the [transcription](#operation/getCallTranscription) - * @type {string} - * @memberof RecordingTranscriptionMetadata */ 'url'?: string; } diff --git a/models/recording-transcriptions.ts b/models/recording-transcriptions.ts index 8ce6354..8f74add 100644 --- a/models/recording-transcriptions.ts +++ b/models/recording-transcriptions.ts @@ -17,17 +17,7 @@ // @ts-ignore import type { Transcription } from './transcription'; -/** - * - * @export - * @interface RecordingTranscriptions - */ export interface RecordingTranscriptions { - /** - * - * @type {Array} - * @memberof RecordingTranscriptions - */ 'transcripts'?: Array; } diff --git a/models/redirect-callback.ts b/models/redirect-callback.ts index 4185e0a..57dbe27 100644 --- a/models/redirect-callback.ts +++ b/models/redirect-callback.ts @@ -19,104 +19,67 @@ import type { CallDirectionEnum } from './call-direction-enum'; /** * The Redirect event is fired when a verb is executed. Its purpose is to get the next set of verbs from the calling application. - * @export - * @interface RedirectCallback */ export interface RedirectCallback { /** * The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. - * @type {string} - * @memberof RedirectCallback */ 'eventType'?: string; /** * The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. - * @type {string} - * @memberof RedirectCallback */ 'eventTime'?: string; /** * The user account associated with the call. - * @type {string} - * @memberof RedirectCallback */ 'accountId'?: string; /** * The id of the application associated with the call. - * @type {string} - * @memberof RedirectCallback */ 'applicationId'?: string; /** * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof RedirectCallback */ 'from'?: string; /** * The phone number that received the call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof RedirectCallback */ 'to'?: string; - /** - * - * @type {CallDirectionEnum} - * @memberof RedirectCallback - */ 'direction'?: CallDirectionEnum; /** * The call id associated with the event. - * @type {string} - * @memberof RedirectCallback */ 'callId'?: string; /** * The URL of the call associated with the event. - * @type {string} - * @memberof RedirectCallback */ 'callUrl'?: string; /** * (optional) If the event is related to the B leg of a , the call id of the original call leg that executed the . Otherwise, this field will not be present. - * @type {string} - * @memberof RedirectCallback */ 'parentCallId'?: string; /** * (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. - * @type {string} - * @memberof RedirectCallback */ 'enqueuedTime'?: string | null; /** * Time the call was started, in ISO 8601 format. - * @type {string} - * @memberof RedirectCallback */ 'startTime'?: string; /** * Time the call was answered, in ISO 8601 format. - * @type {string} - * @memberof RedirectCallback */ 'answerTime'?: string | null; /** * (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. - * @type {string} - * @memberof RedirectCallback */ 'tag'?: string | null; /** * The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof RedirectCallback */ 'transferCallerId'?: string; /** * The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof RedirectCallback */ 'transferTo'?: string; } diff --git a/models/redirect-method-enum.ts b/models/redirect-method-enum.ts index 4aaaf91..86d2cee 100644 --- a/models/redirect-method-enum.ts +++ b/models/redirect-method-enum.ts @@ -16,8 +16,6 @@ /** * The HTTP method to use for the request to `redirectUrl`. GET or POST. Default value is POST.

Not allowed if `state` is `completed`. - * @export - * @enum {string} */ export const RedirectMethodEnum = { diff --git a/models/sms-message-content.ts b/models/sms-message-content.ts index 5d3cad8..d863c2a 100644 --- a/models/sms-message-content.ts +++ b/models/sms-message-content.ts @@ -14,16 +14,9 @@ -/** - * - * @export - * @interface SmsMessageContent - */ export interface SmsMessageContent { /** * The contents of the text message. Must be 2048 characters or less. - * @type {string} - * @memberof SmsMessageContent */ 'text': string; } diff --git a/models/standalone-card-orientation-enum.ts b/models/standalone-card-orientation-enum.ts index 25fa274..e1a0d28 100644 --- a/models/standalone-card-orientation-enum.ts +++ b/models/standalone-card-orientation-enum.ts @@ -14,11 +14,6 @@ -/** - * - * @export - * @enum {string} - */ export const StandaloneCardOrientationEnum = { Horizontal: 'HORIZONTAL', diff --git a/models/status-callback-message.ts b/models/status-callback-message.ts index 8e6c1ae..dfd2c91 100644 --- a/models/status-callback-message.ts +++ b/models/status-callback-message.ts @@ -25,87 +25,44 @@ import type { PriorityEnum } from './priority-enum'; /** * Message payload schema within a callback - * @export - * @interface StatusCallbackMessage */ export interface StatusCallbackMessage { /** * A unique identifier of the message. - * @type {string} - * @memberof StatusCallbackMessage */ 'id': string; /** * The Bandwidth phone number or alphanumeric identifier associated with the message. - * @type {string} - * @memberof StatusCallbackMessage */ 'owner': string; /** * The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. - * @type {string} - * @memberof StatusCallbackMessage */ 'applicationId': string; - /** - * - * @type {string} - * @memberof StatusCallbackMessage - */ 'time': string; /** * The number of segments the user\'s message is broken into before sending over carrier networks. - * @type {number} - * @memberof StatusCallbackMessage */ 'segmentCount': number; - /** - * - * @type {MessageDirectionEnum} - * @memberof StatusCallbackMessage - */ 'direction': MessageDirectionEnum; /** * The phone number recipients of the message. - * @type {Set} - * @memberof StatusCallbackMessage */ 'to': Set; /** * The Bandwidth phone number or alphanumeric identifier the message was sent from. - * @type {string} - * @memberof StatusCallbackMessage */ 'from': string; - /** - * - * @type {string} - * @memberof StatusCallbackMessage - */ 'text'?: string; /** * A custom string that will be included in callback events of the message. Max 1024 characters. - * @type {string} - * @memberof StatusCallbackMessage */ 'tag'?: string; /** * Optional media, not applicable for sms - * @type {Array} - * @memberof StatusCallbackMessage */ 'media'?: Array; - /** - * - * @type {PriorityEnum} - * @memberof StatusCallbackMessage - */ 'priority'?: PriorityEnum; - /** - * - * @type {MultiChannelMessageChannelEnum} - * @memberof StatusCallbackMessage - */ 'channel'?: MultiChannelMessageChannelEnum; } diff --git a/models/status-callback-type-enum.ts b/models/status-callback-type-enum.ts index cecc6d6..a974c11 100644 --- a/models/status-callback-type-enum.ts +++ b/models/status-callback-type-enum.ts @@ -16,8 +16,6 @@ /** * The possible status callbacks when sending an MT SMS or MMS or RBM message: - `message-sending` indicates that Bandwidth is sending the message to the upstream provider. - `message-delivered` indicates that the message was successfully sent. - `message-failed` indicates that the message could not be sent to the intended recipient. - `message-read` indicates that the RBM message was read by the recipient. - * @export - * @enum {string} */ export const StatusCallbackTypeEnum = { diff --git a/models/status-callback.ts b/models/status-callback.ts index 5de44c7..b91b87c 100644 --- a/models/status-callback.ts +++ b/models/status-callback.ts @@ -22,56 +22,29 @@ import type { StatusCallbackTypeEnum } from './status-callback-type-enum'; /** * Represents a status callback for an outbound MT SMS or MMS or RBM message. - * @export - * @interface StatusCallback */ export interface StatusCallback { - /** - * - * @type {string} - * @memberof StatusCallback - */ 'time': string; /** * Represents the time at which the message was read, for `message-read` callbacks. - * @type {string} - * @memberof StatusCallback */ 'eventTime'?: string; - /** - * - * @type {StatusCallbackTypeEnum} - * @memberof StatusCallback - */ 'type': StatusCallbackTypeEnum; /** * The destination phone number the message was sent to. For status callbacks, this the the Bandwidth user\'s client phone number. - * @type {string} - * @memberof StatusCallback */ 'to': string; /** * A detailed description of the event described by the callback. - * @type {string} - * @memberof StatusCallback */ 'description': string; - /** - * - * @type {StatusCallbackMessage} - * @memberof StatusCallback - */ 'message': StatusCallbackMessage; /** * Optional error code, applicable only when type is `message-failed`. - * @type {number} - * @memberof StatusCallback */ 'errorCode'?: number; /** * The name of the Authorized Message Provider (AMP) that handled this message. In the US, this is the carrier that the message was sent to. This field is present only when this account feature has been enabled. - * @type {string} - * @memberof StatusCallback */ 'carrierName'?: string; } diff --git a/models/stir-shaken.ts b/models/stir-shaken.ts index 39438ac..74f9ca4 100644 --- a/models/stir-shaken.ts +++ b/models/stir-shaken.ts @@ -14,28 +14,17 @@ -/** - * - * @export - * @interface StirShaken - */ export interface StirShaken { /** * (optional) The verification status indicating whether the verification was successful or not. Possible values are TN-Validation-Passed and TN-Validation-Failed. - * @type {string} - * @memberof StirShaken */ 'verstat'?: string; /** * (optional) The attestation level verified by Bandwidth. Possible values are A (full), B (partial) or C (gateway). - * @type {string} - * @memberof StirShaken */ 'attestationIndicator'?: string; /** * (optional) A unique origination identifier. - * @type {string} - * @memberof StirShaken */ 'originatingId'?: string; } diff --git a/models/sync-lookup-request.ts b/models/sync-lookup-request.ts new file mode 100644 index 0000000..7f2e6e6 --- /dev/null +++ b/models/sync-lookup-request.ts @@ -0,0 +1,23 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Bandwidth + * Bandwidth\'s Communication APIs + * + * The version of the OpenAPI document: 1.0.0 + * Contact: letstalk@bandwidth.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +export interface SyncLookupRequest { + /** + * Telephone numbers in E.164 format. + */ + 'phoneNumbers': Array; +} + diff --git a/models/telephone-number.ts b/models/telephone-number.ts index d6a8124..8f7515f 100644 --- a/models/telephone-number.ts +++ b/models/telephone-number.ts @@ -14,16 +14,9 @@ -/** - * - * @export - * @interface TelephoneNumber - */ export interface TelephoneNumber { /** * Simple Telephone Number. - * @type {string} - * @memberof TelephoneNumber */ 'telephoneNumber'?: string; } diff --git a/models/tfv-basic-authentication.ts b/models/tfv-basic-authentication.ts index 006320e..cdd87be 100644 --- a/models/tfv-basic-authentication.ts +++ b/models/tfv-basic-authentication.ts @@ -14,23 +14,8 @@ -/** - * - * @export - * @interface TfvBasicAuthentication - */ export interface TfvBasicAuthentication { - /** - * - * @type {string} - * @memberof TfvBasicAuthentication - */ 'username': string; - /** - * - * @type {string} - * @memberof TfvBasicAuthentication - */ 'password': string; } diff --git a/models/tfv-callback-status-enum.ts b/models/tfv-callback-status-enum.ts index ecb2f03..2c6a359 100644 --- a/models/tfv-callback-status-enum.ts +++ b/models/tfv-callback-status-enum.ts @@ -14,11 +14,6 @@ -/** - * - * @export - * @enum {string} - */ export const TfvCallbackStatusEnum = { Verified: 'VERIFIED', diff --git a/models/tfv-error.ts b/models/tfv-error.ts index 667f672..54e5b6a 100644 --- a/models/tfv-error.ts +++ b/models/tfv-error.ts @@ -16,26 +16,12 @@ /** * A generic error object. - * @export - * @interface TfvError */ export interface TfvError { - /** - * - * @type {string} - * @memberof TfvError - */ 'type'?: string; - /** - * - * @type {string} - * @memberof TfvError - */ 'description'?: string; /** * 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. - * @type {object} - * @memberof TfvError */ 'errors'?: object; } diff --git a/models/tfv-status-enum.ts b/models/tfv-status-enum.ts index 584e4ab..6b06a90 100644 --- a/models/tfv-status-enum.ts +++ b/models/tfv-status-enum.ts @@ -14,11 +14,6 @@ -/** - * - * @export - * @enum {string} - */ export const TfvStatusEnum = { Verified: 'VERIFIED', diff --git a/models/tfv-status.ts b/models/tfv-status.ts index b3acb3a..8330fcf 100644 --- a/models/tfv-status.ts +++ b/models/tfv-status.ts @@ -20,70 +20,39 @@ import type { TfvStatusEnum } from './tfv-status-enum'; // @ts-ignore import type { TfvSubmissionInfo } from './tfv-submission-info'; -/** - * - * @export - * @interface TfvStatus - */ export interface TfvStatus { /** * Toll-free telephone number in E.164 format. - * @type {string} - * @memberof TfvStatus */ 'phoneNumber'?: string; - /** - * - * @type {TfvStatusEnum} - * @memberof TfvStatus - */ 'status'?: TfvStatusEnum; /** * Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number - included in all webhook payloads. - * @type {string} - * @memberof TfvStatus */ 'internalTicketNumber'?: string; /** * Explanation for why a verification request was declined. - * @type {string} - * @memberof TfvStatus */ 'declineReasonDescription'?: string; /** * Whether a Toll-Free Verification request qualifies for resubmission via PUT. - * @type {boolean} - * @memberof TfvStatus */ 'resubmitAllowed'?: boolean; /** * Date and time the verification request was created. - * @type {string} - * @memberof TfvStatus */ 'createdDateTime'?: string; /** * Date and time the verification request was last modified. - * @type {string} - * @memberof TfvStatus */ 'modifiedDateTime'?: string; - /** - * - * @type {TfvSubmissionInfo} - * @memberof TfvStatus - */ 'submission'?: TfvSubmissionInfo; /** * Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. - * @type {boolean} - * @memberof TfvStatus */ 'blocked'?: boolean; /** * The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. - * @type {string} - * @memberof TfvStatus */ 'blockedReason'?: string; } diff --git a/models/tfv-submission-info.ts b/models/tfv-submission-info.ts index 57c2410..a0840a5 100644 --- a/models/tfv-submission-info.ts +++ b/models/tfv-submission-info.ts @@ -29,101 +29,51 @@ import type { Contact } from './contact'; // @ts-ignore import type { OptInWorkflow } from './opt-in-workflow'; -/** - * - * @export - * @interface TfvSubmissionInfo - */ export interface TfvSubmissionInfo { - /** - * - * @type {Address} - * @memberof TfvSubmissionInfo - */ 'businessAddress'?: Address; - /** - * - * @type {Contact} - * @memberof TfvSubmissionInfo - */ 'businessContact'?: Contact; /** * Estimated monthly volume of messages from the toll-free number. - * @type {number} - * @memberof TfvSubmissionInfo */ 'messageVolume'?: number; /** * The category of the use case. - * @type {string} - * @memberof TfvSubmissionInfo */ 'useCase'?: string; /** * A general idea of the use case and customer. - * @type {string} - * @memberof TfvSubmissionInfo */ 'useCaseSummary'?: string; /** * Example of message content. - * @type {string} - * @memberof TfvSubmissionInfo */ 'productionMessageContent'?: string; - /** - * - * @type {OptInWorkflow} - * @memberof TfvSubmissionInfo - */ 'optInWorkflow'?: OptInWorkflow; /** * Any additional information. - * @type {string} - * @memberof TfvSubmissionInfo */ 'additionalInformation'?: string | null; /** * ISV name. - * @type {string} - * @memberof TfvSubmissionInfo */ 'isvReseller'?: string | null; /** * The Toll-Free Verification request privacy policy URL. - * @type {string} - * @memberof TfvSubmissionInfo */ 'privacyPolicyUrl'?: string; /** * The Toll-Free Verification request terms and conditions policy URL. - * @type {string} - * @memberof TfvSubmissionInfo */ 'termsAndConditionsUrl'?: string; /** * The company \'Doing Business As\'. - * @type {string} - * @memberof TfvSubmissionInfo */ 'businessDba'?: string; /** * US Federal Tax ID Number (EIN) or Canada Business Number (CBN). Optional until early 2026. If a value is provided for this field, a value must be provided for `businessRegistrationType` and `businessEntityType`. Available starting October 1st, 2025. - * @type {string} - * @memberof TfvSubmissionInfo */ 'businessRegistrationNumber'?: string | null; - /** - * - * @type {BusinessRegistrationTypeEnum} - * @memberof TfvSubmissionInfo - */ 'businessRegistrationType'?: BusinessRegistrationTypeEnum | null; - /** - * - * @type {BusinessEntityTypeEnum} - * @memberof TfvSubmissionInfo - */ 'businessEntityType'?: BusinessEntityTypeEnum | null; } diff --git a/models/tfv-submission-wrapper.ts b/models/tfv-submission-wrapper.ts index 1692cb2..a62fa14 100644 --- a/models/tfv-submission-wrapper.ts +++ b/models/tfv-submission-wrapper.ts @@ -17,17 +17,7 @@ // @ts-ignore import type { VerificationUpdateRequest } from './verification-update-request'; -/** - * - * @export - * @interface TfvSubmissionWrapper - */ export interface TfvSubmissionWrapper { - /** - * - * @type {VerificationUpdateRequest} - * @memberof TfvSubmissionWrapper - */ 'submission'?: VerificationUpdateRequest; } diff --git a/models/thumbnail-alignment-enum.ts b/models/thumbnail-alignment-enum.ts index 784d7b9..c1336eb 100644 --- a/models/thumbnail-alignment-enum.ts +++ b/models/thumbnail-alignment-enum.ts @@ -16,8 +16,6 @@ /** * The alignment of the thumbnail image in the card. Only applicable if the card using horizontal orientation. - * @export - * @enum {string} */ export const ThumbnailAlignmentEnum = { diff --git a/models/transcribe-recording.ts b/models/transcribe-recording.ts index 57e0519..ecc8fc5 100644 --- a/models/transcribe-recording.ts +++ b/models/transcribe-recording.ts @@ -17,52 +17,30 @@ // @ts-ignore import type { CallbackMethodEnum } from './callback-method-enum'; -/** - * - * @export - * @interface TranscribeRecording - */ export interface TranscribeRecording { /** * The URL to send the [TranscriptionAvailable](/docs/voice/webhooks/transcriptionAvailable) event to. You should not include sensitive or personally-identifiable information in the callbackUrl field! Always use the proper username and password fields for authorization. - * @type {string} - * @memberof TranscribeRecording */ 'callbackUrl'?: string; - /** - * - * @type {CallbackMethodEnum} - * @memberof TranscribeRecording - */ 'callbackMethod'?: CallbackMethodEnum | null; /** * Basic auth username. - * @type {string} - * @memberof TranscribeRecording */ 'username'?: string | null; /** * Basic auth password. - * @type {string} - * @memberof TranscribeRecording */ 'password'?: string | null; /** * (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. - * @type {string} - * @memberof TranscribeRecording */ 'tag'?: string | null; /** * This is the timeout (in seconds) to use when delivering the webhook to `callbackUrl`. Can be any numeric value (including decimals) between 1 and 25. - * @type {number} - * @memberof TranscribeRecording */ 'callbackTimeout'?: number | null; /** * A boolean value to indicate that the recording may not be in English, and the transcription service will need to detect the dominant language the recording is in and transcribe accordingly. Current supported languages are English, French, and Spanish. - * @type {boolean} - * @memberof TranscribeRecording */ 'detectLanguage'?: boolean | null; } diff --git a/models/transcription-available-callback.ts b/models/transcription-available-callback.ts index 4c7358a..305ff65 100644 --- a/models/transcription-available-callback.ts +++ b/models/transcription-available-callback.ts @@ -25,134 +25,81 @@ import type { Transcription } from './transcription'; /** * The Transcription Available event is sent when the recording transcription is available to be downloaded. - * @export - * @interface TranscriptionAvailableCallback */ export interface TranscriptionAvailableCallback { /** * The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. - * @type {string} - * @memberof TranscriptionAvailableCallback */ 'eventType'?: string; /** * The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. - * @type {string} - * @memberof TranscriptionAvailableCallback */ 'eventTime'?: string; /** * The user account associated with the call. - * @type {string} - * @memberof TranscriptionAvailableCallback */ 'accountId'?: string; /** * The id of the application associated with the call. - * @type {string} - * @memberof TranscriptionAvailableCallback */ 'applicationId'?: string; /** * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof TranscriptionAvailableCallback */ 'from'?: string; /** * The phone number that received the call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof TranscriptionAvailableCallback */ 'to'?: string; - /** - * - * @type {CallDirectionEnum} - * @memberof TranscriptionAvailableCallback - */ 'direction'?: CallDirectionEnum; /** * The call id associated with the event. - * @type {string} - * @memberof TranscriptionAvailableCallback */ 'callId'?: string; /** * The URL of the call associated with the event. - * @type {string} - * @memberof TranscriptionAvailableCallback */ 'callUrl'?: string; /** * The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded. - * @type {string} - * @memberof TranscriptionAvailableCallback */ 'mediaUrl'?: string | null; /** * (optional) If the event is related to the B leg of a , the call id of the original call leg that executed the . Otherwise, this field will not be present. - * @type {string} - * @memberof TranscriptionAvailableCallback */ 'parentCallId'?: string; /** * The unique ID of this recording - * @type {string} - * @memberof TranscriptionAvailableCallback */ 'recordingId'?: string; /** * (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. - * @type {string} - * @memberof TranscriptionAvailableCallback */ 'enqueuedTime'?: string | null; /** * Time the call was started, in ISO 8601 format. - * @type {string} - * @memberof TranscriptionAvailableCallback */ 'startTime'?: string; /** * The time that the recording ended in ISO-8601 format - * @type {string} - * @memberof TranscriptionAvailableCallback */ 'endTime'?: string; /** * The duration of the recording in ISO-8601 format - * @type {string} - * @memberof TranscriptionAvailableCallback */ 'duration'?: string; - /** - * - * @type {FileFormatEnum} - * @memberof TranscriptionAvailableCallback - */ 'fileFormat'?: FileFormatEnum; /** * (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. - * @type {string} - * @memberof TranscriptionAvailableCallback */ 'tag'?: string | null; - /** - * - * @type {Transcription} - * @memberof TranscriptionAvailableCallback - */ 'transcription'?: Transcription; /** * The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof TranscriptionAvailableCallback */ 'transferCallerId'?: string; /** * The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof TranscriptionAvailableCallback */ 'transferTo'?: string; } diff --git a/models/transcription.ts b/models/transcription.ts index 5a94ce7..45648da 100644 --- a/models/transcription.ts +++ b/models/transcription.ts @@ -14,22 +14,13 @@ -/** - * - * @export - * @interface Transcription - */ export interface Transcription { /** * The transcribed text - * @type {string} - * @memberof Transcription */ 'text'?: string; /** * The confidence on the recognized content, ranging from `0.0` to `1.0` with `1.0` being the highest confidence. - * @type {number} - * @memberof Transcription */ 'confidence'?: number; } diff --git a/models/transfer-answer-callback.ts b/models/transfer-answer-callback.ts index d8d2692..e484d5d 100644 --- a/models/transfer-answer-callback.ts +++ b/models/transfer-answer-callback.ts @@ -19,98 +19,63 @@ import type { CallDirectionEnum } from './call-direction-enum'; /** * When processing a verb, this event is sent when a called party (B-leg) answers. The event is sent to the endpoint specified in the transferAnswerUrl attribute of the tag that answered. BXML returned by this callback will be executed for the called party only. After all BXML has been executed, the called party will be bridged to the original call. Most BXML verbs are allowed in response to a transferAnswer event, but some are not allowed. - * @export - * @interface TransferAnswerCallback */ export interface TransferAnswerCallback { /** * The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. - * @type {string} - * @memberof TransferAnswerCallback */ 'eventType'?: string; /** * The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. - * @type {string} - * @memberof TransferAnswerCallback */ 'eventTime'?: string; /** * The user account associated with the call. - * @type {string} - * @memberof TransferAnswerCallback */ 'accountId'?: string; /** * The id of the application associated with the call. - * @type {string} - * @memberof TransferAnswerCallback */ 'applicationId'?: string; /** * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof TransferAnswerCallback */ 'from'?: string; /** * The phone number that received the call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof TransferAnswerCallback */ 'to'?: string; - /** - * - * @type {CallDirectionEnum} - * @memberof TransferAnswerCallback - */ 'direction'?: CallDirectionEnum; /** * The call id associated with the event. - * @type {string} - * @memberof TransferAnswerCallback */ 'callId'?: string; /** * The URL of the call associated with the event. - * @type {string} - * @memberof TransferAnswerCallback */ 'callUrl'?: string; /** * (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. - * @type {string} - * @memberof TransferAnswerCallback */ 'enqueuedTime'?: string | null; /** * Time the call was started, in ISO 8601 format. - * @type {string} - * @memberof TransferAnswerCallback */ 'startTime'?: string; /** * Time the call was answered, in ISO 8601 format. - * @type {string} - * @memberof TransferAnswerCallback */ 'answerTime'?: string | null; /** * (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. - * @type {string} - * @memberof TransferAnswerCallback */ 'tag'?: string | null; /** * The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof TransferAnswerCallback */ 'transferCallerId'?: string; /** * The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof TransferAnswerCallback */ 'transferTo'?: string; } diff --git a/models/transfer-complete-callback.ts b/models/transfer-complete-callback.ts index d5d0e2c..6712b24 100644 --- a/models/transfer-complete-callback.ts +++ b/models/transfer-complete-callback.ts @@ -19,116 +19,75 @@ import type { CallDirectionEnum } from './call-direction-enum'; /** * This event is sent to the transferCompleteUrl of the A-leg\'s verb when the transferred call (B-leg) completes. In a simultaneous ringing scenario, only one B-leg succeeds and this event corresponds to that successful leg. If none of the calls were answered, the transferComplete event corresponds to one of the legs. - * @export - * @interface TransferCompleteCallback */ export interface TransferCompleteCallback { /** * The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. - * @type {string} - * @memberof TransferCompleteCallback */ 'eventType'?: string; /** * The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. - * @type {string} - * @memberof TransferCompleteCallback */ 'eventTime'?: string; /** * The user account associated with the call. - * @type {string} - * @memberof TransferCompleteCallback */ 'accountId'?: string; /** * The id of the application associated with the call. - * @type {string} - * @memberof TransferCompleteCallback */ 'applicationId'?: string; /** * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof TransferCompleteCallback */ 'from'?: string; /** * The phone number that received the call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof TransferCompleteCallback */ 'to'?: string; - /** - * - * @type {CallDirectionEnum} - * @memberof TransferCompleteCallback - */ 'direction'?: CallDirectionEnum; /** * The call id associated with the event. - * @type {string} - * @memberof TransferCompleteCallback */ 'callId'?: string; /** * The URL of the call associated with the event. - * @type {string} - * @memberof TransferCompleteCallback */ 'callUrl'?: string; /** * (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. - * @type {string} - * @memberof TransferCompleteCallback */ 'enqueuedTime'?: string | null; /** * Time the call was started, in ISO 8601 format. - * @type {string} - * @memberof TransferCompleteCallback */ 'startTime'?: string; /** * Time the call was answered, in ISO 8601 format. - * @type {string} - * @memberof TransferCompleteCallback */ 'answerTime'?: string | null; /** * (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. - * @type {string} - * @memberof TransferCompleteCallback */ 'tag'?: string | null; /** * The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof TransferCompleteCallback */ 'transferCallerId'?: string; /** * The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof TransferCompleteCallback */ 'transferTo'?: string; /** * Reason the call failed - hangup, busy, timeout, cancel, rejected, callback-error, invalid-bxml, application-error, account-limit, node-capacity-exceeded, error, or unknown. - * @type {string} - * @memberof TransferCompleteCallback */ 'cause'?: string; /** * Text explaining the reason that caused the call to fail in case of errors. - * @type {string} - * @memberof TransferCompleteCallback */ 'errorMessage'?: string | null; /** * Bandwidth\'s internal id that references the error event. - * @type {string} - * @memberof TransferCompleteCallback */ 'errorId'?: string | null; } diff --git a/models/transfer-disconnect-callback.ts b/models/transfer-disconnect-callback.ts index d2567fd..b2fca5a 100644 --- a/models/transfer-disconnect-callback.ts +++ b/models/transfer-disconnect-callback.ts @@ -19,128 +19,83 @@ import type { CallDirectionEnum } from './call-direction-enum'; /** * This event is sent to the transferDisconnectUrl of each tag when its respective call leg ends for any reason. The event is sent in the normal case, when the transferred leg is answered and later hung up, but is also sent if the new leg was never answered in the first place, if it was rejected, and if the original call leg hung up before the transferred leg. - * @export - * @interface TransferDisconnectCallback */ export interface TransferDisconnectCallback { /** * The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. - * @type {string} - * @memberof TransferDisconnectCallback */ 'eventType'?: string; /** * The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. - * @type {string} - * @memberof TransferDisconnectCallback */ 'eventTime'?: string; /** * The user account associated with the call. - * @type {string} - * @memberof TransferDisconnectCallback */ 'accountId'?: string; /** * The id of the application associated with the call. - * @type {string} - * @memberof TransferDisconnectCallback */ 'applicationId'?: string; /** * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof TransferDisconnectCallback */ 'from'?: string; /** * The phone number that received the call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof TransferDisconnectCallback */ 'to'?: string; - /** - * - * @type {CallDirectionEnum} - * @memberof TransferDisconnectCallback - */ 'direction'?: CallDirectionEnum; /** * The call id associated with the event. - * @type {string} - * @memberof TransferDisconnectCallback */ 'callId'?: string; /** * The URL of the call associated with the event. - * @type {string} - * @memberof TransferDisconnectCallback */ 'callUrl'?: string; /** * (optional) If the event is related to the B leg of a , the call id of the original call leg that executed the . Otherwise, this field will not be present. - * @type {string} - * @memberof TransferDisconnectCallback */ 'parentCallId'?: string; /** * (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. - * @type {string} - * @memberof TransferDisconnectCallback */ 'enqueuedTime'?: string | null; /** * Time the call was started, in ISO 8601 format. - * @type {string} - * @memberof TransferDisconnectCallback */ 'startTime'?: string; /** * Time the call was answered, in ISO 8601 format. - * @type {string} - * @memberof TransferDisconnectCallback */ 'answerTime'?: string | null; /** * The time that the recording ended in ISO-8601 format - * @type {string} - * @memberof TransferDisconnectCallback */ 'endTime'?: string; /** * (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. - * @type {string} - * @memberof TransferDisconnectCallback */ 'tag'?: string | null; /** * The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof TransferDisconnectCallback */ 'transferCallerId'?: string; /** * The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). - * @type {string} - * @memberof TransferDisconnectCallback */ 'transferTo'?: string; /** * Reason the call failed - hangup, busy, timeout, cancel, rejected, callback-error, invalid-bxml, application-error, account-limit, node-capacity-exceeded, error, or unknown. - * @type {string} - * @memberof TransferDisconnectCallback */ 'cause'?: string; /** * Text explaining the reason that caused the call to fail in case of errors. - * @type {string} - * @memberof TransferDisconnectCallback */ 'errorMessage'?: string | null; /** * Bandwidth\'s internal id that references the error event. - * @type {string} - * @memberof TransferDisconnectCallback */ 'errorId'?: string | null; } diff --git a/models/update-call-recording.ts b/models/update-call-recording.ts index e4e6de5..85915db 100644 --- a/models/update-call-recording.ts +++ b/models/update-call-recording.ts @@ -17,17 +17,7 @@ // @ts-ignore import type { RecordingStateEnum } from './recording-state-enum'; -/** - * - * @export - * @interface UpdateCallRecording - */ export interface UpdateCallRecording { - /** - * - * @type {RecordingStateEnum} - * @memberof UpdateCallRecording - */ 'state': RecordingStateEnum; } diff --git a/models/update-call.ts b/models/update-call.ts index ff07a60..f374513 100644 --- a/models/update-call.ts +++ b/models/update-call.ts @@ -20,70 +20,36 @@ import type { CallStateEnum } from './call-state-enum'; // @ts-ignore import type { RedirectMethodEnum } from './redirect-method-enum'; -/** - * - * @export - * @interface UpdateCall - */ export interface UpdateCall { - /** - * - * @type {CallStateEnum} - * @memberof UpdateCall - */ 'state'?: CallStateEnum | null; /** * The URL to send the [Redirect](/docs/voice/bxml/redirect) event to which will provide new BXML. Required if `state` is `active`. Not allowed if `state` is `completed`. - * @type {string} - * @memberof UpdateCall */ 'redirectUrl'?: string | null; - /** - * - * @type {RedirectMethodEnum} - * @memberof UpdateCall - */ 'redirectMethod'?: RedirectMethodEnum | null; /** * Basic auth username. - * @type {string} - * @memberof UpdateCall */ 'username'?: string | null; /** * Basic auth password. - * @type {string} - * @memberof UpdateCall */ 'password'?: string | null; /** * A fallback url which, if provided, will be used to retry the redirect callback delivery in case `redirectUrl` fails to respond. - * @type {string} - * @memberof UpdateCall */ 'redirectFallbackUrl'?: string | null; - /** - * - * @type {RedirectMethodEnum} - * @memberof UpdateCall - */ 'redirectFallbackMethod'?: RedirectMethodEnum | null; /** * Basic auth username. - * @type {string} - * @memberof UpdateCall */ 'fallbackUsername'?: string | null; /** * Basic auth password. - * @type {string} - * @memberof UpdateCall */ 'fallbackPassword'?: string | null; /** * A custom string that will be sent with this and all future callbacks unless overwritten by a future `tag` attribute or [``](/docs/voice/bxml/tag) verb, or cleared. May be cleared by setting `tag=\"\"`. Max length 256 characters. Not allowed if `state` is `completed`. - * @type {string} - * @memberof UpdateCall */ 'tag'?: string | null; } diff --git a/models/update-conference-member.ts b/models/update-conference-member.ts index b7d37d8..19ee0ee 100644 --- a/models/update-conference-member.ts +++ b/models/update-conference-member.ts @@ -14,28 +14,17 @@ -/** - * - * @export - * @interface UpdateConferenceMember - */ export interface UpdateConferenceMember { /** * Whether or not this member is currently muted. Members who are muted are still able to hear other participants. Updates this member\'s mute status. Has no effect if omitted. - * @type {boolean} - * @memberof UpdateConferenceMember */ 'mute'?: boolean; /** * Whether or not this member is currently on hold. Members who are on hold are not able to hear or speak in the conference. Updates this member\'s hold status. Has no effect if omitted. - * @type {boolean} - * @memberof UpdateConferenceMember */ 'hold'?: boolean; /** * If this member had a value set for `callIdsToCoach` in its [Conference](/docs/voice/bxml/conference) verb or this list was added with a previous PUT request to modify the member, this is that list of calls. Modifies the calls that this member is coaching. Has no effect if omitted. See the documentation for the [Conference](/docs/voice/bxml/conference) verb for more details about coaching. Note that this will not add the matching calls to the conference; each call must individually execute a Conference verb to join. - * @type {Array} - * @memberof UpdateConferenceMember */ 'callIdsToCoach'?: Array | null; } diff --git a/models/update-conference.ts b/models/update-conference.ts index 1e2a305..9bc2188 100644 --- a/models/update-conference.ts +++ b/models/update-conference.ts @@ -20,64 +20,32 @@ import type { ConferenceStateEnum } from './conference-state-enum'; // @ts-ignore import type { RedirectMethodEnum } from './redirect-method-enum'; -/** - * - * @export - * @interface UpdateConference - */ export interface UpdateConference { - /** - * - * @type {ConferenceStateEnum} - * @memberof UpdateConference - */ 'status'?: ConferenceStateEnum | null; /** * The URL to send the [conferenceRedirect](/docs/voice/webhooks/conferenceRedirect) event which will provide new BXML. Not allowed if `state` is `completed`, but required if `state` is `active`. - * @type {string} - * @memberof UpdateConference */ 'redirectUrl'?: string | null; - /** - * - * @type {RedirectMethodEnum} - * @memberof UpdateConference - */ 'redirectMethod'?: RedirectMethodEnum | null; /** * Basic auth username. - * @type {string} - * @memberof UpdateConference */ 'username'?: string | null; /** * Basic auth password. - * @type {string} - * @memberof UpdateConference */ 'password'?: string | null; /** * A fallback url which, if provided, will be used to retry the `conferenceRedirect` webhook delivery in case `redirectUrl` fails to respond. Not allowed if `state` is `completed`. - * @type {string} - * @memberof UpdateConference */ 'redirectFallbackUrl'?: string | null; - /** - * - * @type {RedirectMethodEnum} - * @memberof UpdateConference - */ 'redirectFallbackMethod'?: RedirectMethodEnum | null; /** * Basic auth username. - * @type {string} - * @memberof UpdateConference */ 'fallbackUsername'?: string | null; /** * Basic auth password. - * @type {string} - * @memberof UpdateConference */ 'fallbackPassword'?: string | null; } diff --git a/models/verification-denial-webhook.ts b/models/verification-denial-webhook.ts index 615a3e8..76f2194 100644 --- a/models/verification-denial-webhook.ts +++ b/models/verification-denial-webhook.ts @@ -17,70 +17,42 @@ // @ts-ignore import type { AdditionalDenialReason } from './additional-denial-reason'; -/** - * - * @export - * @interface VerificationDenialWebhook - */ export interface VerificationDenialWebhook { /** * User\'s account ID. - * @type {string} - * @memberof VerificationDenialWebhook */ 'accountId'?: string; /** * An optional list of denial reasons in addition to declineReasonDescription when multiple reasons apply. - * @type {Array} - * @memberof VerificationDenialWebhook */ 'additionalDenialReasons'?: Array; /** * Explanation for why a verification request was declined. - * @type {string} - * @memberof VerificationDenialWebhook */ 'declineReasonDescription'?: string; /** * Reason code for denial. - * @type {number} - * @memberof VerificationDenialWebhook */ 'denialStatusCode'?: number; /** * Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number. - * @type {string} - * @memberof VerificationDenialWebhook */ 'internalTicketNumber'?: string; /** * Toll-free telephone number in E.164 format. - * @type {string} - * @memberof VerificationDenialWebhook */ 'phoneNumber'?: string; /** * Whether a Toll-Free Verification request qualifies for resubmission via PUT. - * @type {boolean} - * @memberof VerificationDenialWebhook */ 'resubmitAllowed'?: boolean; - /** - * - * @type {string} - * @memberof VerificationDenialWebhook - */ 'status'?: string; /** * Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. - * @type {boolean} - * @memberof VerificationDenialWebhook */ 'blocked'?: boolean; /** * The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. - * @type {string} - * @memberof VerificationDenialWebhook */ 'blockedReason'?: string; } diff --git a/models/verification-request.ts b/models/verification-request.ts index 4e63541..409b383 100644 --- a/models/verification-request.ts +++ b/models/verification-request.ts @@ -29,118 +29,59 @@ import type { Contact } from './contact'; // @ts-ignore import type { OptInWorkflow } from './opt-in-workflow'; -/** - * - * @export - * @interface VerificationRequest - */ export interface VerificationRequest { - /** - * - * @type {Address} - * @memberof VerificationRequest - */ 'businessAddress': Address; - /** - * - * @type {Contact} - * @memberof VerificationRequest - */ 'businessContact': Contact; /** * Estimated monthly volume of messages from the toll-free number. - * @type {number} - * @memberof VerificationRequest */ 'messageVolume': number; - /** - * - * @type {Array} - * @memberof VerificationRequest - */ 'phoneNumbers': Array; /** * The category of the use case. - * @type {string} - * @memberof VerificationRequest */ 'useCase': string; /** * A general idea of the use case and customer. - * @type {string} - * @memberof VerificationRequest */ 'useCaseSummary': string; /** * Example of message content. - * @type {string} - * @memberof VerificationRequest */ 'productionMessageContent': string; - /** - * - * @type {OptInWorkflow} - * @memberof VerificationRequest - */ 'optInWorkflow': OptInWorkflow; /** * Any additional information. - * @type {string} - * @memberof VerificationRequest */ 'additionalInformation'?: string | null; /** * ISV name. - * @type {string} - * @memberof VerificationRequest */ 'isvReseller'?: string | null; /** * The Toll-Free Verification request privacy policy URL. - * @type {string} - * @memberof VerificationRequest */ 'privacyPolicyUrl'?: string; /** * The Toll-Free Verification request terms and conditions policy URL. - * @type {string} - * @memberof VerificationRequest */ 'termsAndConditionsUrl'?: string; /** * The company \'Doing Business As\'. - * @type {string} - * @memberof VerificationRequest */ 'businessDba'?: string; /** * US Federal Tax ID Number (EIN) or Canada Business Number (CBN). Optional until early 2026. If a value is provided for this field, a value must be provided for `businessRegistrationType` and `businessEntityType`. Available starting October 1st, 2025. - * @type {string} - * @memberof VerificationRequest */ 'businessRegistrationNumber'?: string | null; - /** - * - * @type {BusinessRegistrationTypeEnum} - * @memberof VerificationRequest - */ 'businessRegistrationType'?: BusinessRegistrationTypeEnum | null; - /** - * - * @type {BusinessEntityTypeEnum} - * @memberof VerificationRequest - */ 'businessEntityType'?: BusinessEntityTypeEnum | null; /** * A message that gets sent to users requesting help. - * @type {string} - * @memberof VerificationRequest */ 'helpMessageResponse'?: string | null; /** * Indicates whether the content is age-gated. - * @type {boolean} - * @memberof VerificationRequest */ 'ageGatedContent'?: boolean; } diff --git a/models/verification-update-request.ts b/models/verification-update-request.ts index d2e3b6d..5e6d90e 100644 --- a/models/verification-update-request.ts +++ b/models/verification-update-request.ts @@ -29,112 +29,58 @@ import type { Contact } from './contact'; // @ts-ignore import type { OptInWorkflow } from './opt-in-workflow'; -/** - * - * @export - * @interface VerificationUpdateRequest - */ export interface VerificationUpdateRequest { - /** - * - * @type {Address} - * @memberof VerificationUpdateRequest - */ 'businessAddress': Address; - /** - * - * @type {Contact} - * @memberof VerificationUpdateRequest - */ 'businessContact': Contact; /** * Estimated monthly volume of messages from the toll-free number. - * @type {number} - * @memberof VerificationUpdateRequest */ 'messageVolume': number; /** * The category of the use case. - * @type {string} - * @memberof VerificationUpdateRequest */ 'useCase': string; /** * A general idea of the use case and customer. - * @type {string} - * @memberof VerificationUpdateRequest */ 'useCaseSummary': string; /** * Example of message content. - * @type {string} - * @memberof VerificationUpdateRequest */ 'productionMessageContent': string; - /** - * - * @type {OptInWorkflow} - * @memberof VerificationUpdateRequest - */ 'optInWorkflow': OptInWorkflow; /** * Any additional information. - * @type {string} - * @memberof VerificationUpdateRequest */ 'additionalInformation'?: string | null; /** * ISV name. - * @type {string} - * @memberof VerificationUpdateRequest */ 'isvReseller'?: string | null; /** * The Toll-Free Verification request privacy policy URL. - * @type {string} - * @memberof VerificationUpdateRequest */ 'privacyPolicyUrl'?: string; /** * The Toll-Free Verification request terms and conditions policy URL. - * @type {string} - * @memberof VerificationUpdateRequest */ 'termsAndConditionsUrl'?: string; /** * The company \'Doing Business As\'. - * @type {string} - * @memberof VerificationUpdateRequest */ 'businessDba'?: string; /** * US Federal Tax ID Number (EIN) or Canada Business Number (CBN). Optional until early 2026. If a value is provided for this field, a value must be provided for `businessRegistrationType` and `businessEntityType`. Available starting October 1st, 2025. - * @type {string} - * @memberof VerificationUpdateRequest */ 'businessRegistrationNumber'?: string | null; - /** - * - * @type {BusinessRegistrationTypeEnum} - * @memberof VerificationUpdateRequest - */ 'businessRegistrationType'?: BusinessRegistrationTypeEnum | null; - /** - * - * @type {BusinessEntityTypeEnum} - * @memberof VerificationUpdateRequest - */ 'businessEntityType'?: BusinessEntityTypeEnum | null; /** * A message that gets sent to users requesting help. - * @type {string} - * @memberof VerificationUpdateRequest */ 'helpMessageResponse'?: string | null; /** * Indicates whether the content is age-gated. - * @type {boolean} - * @memberof VerificationUpdateRequest */ 'ageGatedContent'?: boolean; } diff --git a/models/verification-webhook.ts b/models/verification-webhook.ts index 4d25d8e..c3ae954 100644 --- a/models/verification-webhook.ts +++ b/models/verification-webhook.ts @@ -17,34 +17,18 @@ // @ts-ignore import type { TfvCallbackStatusEnum } from './tfv-callback-status-enum'; -/** - * - * @export - * @interface VerificationWebhook - */ export interface VerificationWebhook { /** * User\'s account ID. - * @type {string} - * @memberof VerificationWebhook */ 'accountId'?: string; /** * Toll-free telephone number in E.164 format. - * @type {string} - * @memberof VerificationWebhook */ 'phoneNumber'?: string; - /** - * - * @type {TfvCallbackStatusEnum} - * @memberof VerificationWebhook - */ 'status'?: TfvCallbackStatusEnum; /** * Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number. - * @type {string} - * @memberof VerificationWebhook */ 'internalTicketNumber'?: string; } diff --git a/models/verify-code-request.ts b/models/verify-code-request.ts index 9ac47e5..20fc909 100644 --- a/models/verify-code-request.ts +++ b/models/verify-code-request.ts @@ -14,34 +14,21 @@ -/** - * - * @export - * @interface VerifyCodeRequest - */ export interface VerifyCodeRequest { /** * The phone number to send the mfa code to. - * @type {string} - * @memberof VerifyCodeRequest */ 'to': string; /** * An optional field to denote what scope or action the mfa code is addressing. If not supplied, defaults to \"2FA\". - * @type {string} - * @memberof VerifyCodeRequest */ 'scope'?: string; /** * The time period, in minutes, to validate the mfa code. By setting this to 3 minutes, it will mean any code generated within the last 3 minutes are still valid. The valid range for expiration time is between 0 and 15 minutes, exclusively and inclusively, respectively. - * @type {number} - * @memberof VerifyCodeRequest */ 'expirationTimeInMinutes': number; /** * The generated mfa code to check if valid. - * @type {string} - * @memberof VerifyCodeRequest */ 'code': string; } diff --git a/models/verify-code-response.ts b/models/verify-code-response.ts index 44ff760..5b242e0 100644 --- a/models/verify-code-response.ts +++ b/models/verify-code-response.ts @@ -14,16 +14,9 @@ -/** - * - * @export - * @interface VerifyCodeResponse - */ export interface VerifyCodeResponse { /** * Whether or not the supplied code is valid. - * @type {boolean} - * @memberof VerifyCodeResponse */ 'valid'?: boolean; } diff --git a/models/voice-api-error.ts b/models/voice-api-error.ts index 07e250a..8f3cdec 100644 --- a/models/voice-api-error.ts +++ b/models/voice-api-error.ts @@ -14,29 +14,9 @@ -/** - * - * @export - * @interface VoiceApiError - */ export interface VoiceApiError { - /** - * - * @type {string} - * @memberof VoiceApiError - */ 'type'?: string; - /** - * - * @type {string} - * @memberof VoiceApiError - */ 'description'?: string; - /** - * - * @type {string} - * @memberof VoiceApiError - */ 'id'?: string | null; } diff --git a/models/voice-code-response.ts b/models/voice-code-response.ts index e5f6a47..90bf43c 100644 --- a/models/voice-code-response.ts +++ b/models/voice-code-response.ts @@ -14,16 +14,9 @@ -/** - * - * @export - * @interface VoiceCodeResponse - */ export interface VoiceCodeResponse { /** * Programmable Voice API Call ID. - * @type {string} - * @memberof VoiceCodeResponse */ 'callId'?: string; } diff --git a/models/webhook-subscription-basic-authentication.ts b/models/webhook-subscription-basic-authentication.ts index c706292..594422c 100644 --- a/models/webhook-subscription-basic-authentication.ts +++ b/models/webhook-subscription-basic-authentication.ts @@ -16,21 +16,9 @@ /** * Basic authentication credentials are not required, but if present, both username and password must be provided. - * @export - * @interface WebhookSubscriptionBasicAuthentication */ export interface WebhookSubscriptionBasicAuthentication { - /** - * - * @type {string} - * @memberof WebhookSubscriptionBasicAuthentication - */ 'username': string; - /** - * - * @type {string} - * @memberof WebhookSubscriptionBasicAuthentication - */ 'password': string; } diff --git a/models/webhook-subscription-request-schema.ts b/models/webhook-subscription-request-schema.ts index 4581526..cc248cb 100644 --- a/models/webhook-subscription-request-schema.ts +++ b/models/webhook-subscription-request-schema.ts @@ -17,28 +17,14 @@ // @ts-ignore import type { TfvBasicAuthentication } from './tfv-basic-authentication'; -/** - * - * @export - * @interface WebhookSubscriptionRequestSchema - */ export interface WebhookSubscriptionRequestSchema { - /** - * - * @type {TfvBasicAuthentication} - * @memberof WebhookSubscriptionRequestSchema - */ 'basicAuthentication'?: TfvBasicAuthentication; /** * 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} - * @memberof WebhookSubscriptionRequestSchema */ 'callbackUrl': string | null; /** * An ASCII string submitted by the user as a shared secret key for generating an HMAC header for callbacks. - * @type {string} - * @memberof WebhookSubscriptionRequestSchema */ 'sharedSecretKey'?: string | null; } diff --git a/models/webhook-subscription-type-enum.ts b/models/webhook-subscription-type-enum.ts index 5dfbfa4..84842e9 100644 --- a/models/webhook-subscription-type-enum.ts +++ b/models/webhook-subscription-type-enum.ts @@ -14,11 +14,6 @@ -/** - * - * @export - * @enum {string} - */ export const WebhookSubscriptionTypeEnum = { TollfreeVerificationStatus: 'TOLLFREE_VERIFICATION_STATUS', diff --git a/models/webhook-subscription.ts b/models/webhook-subscription.ts index 23d2377..15b3789 100644 --- a/models/webhook-subscription.ts +++ b/models/webhook-subscription.ts @@ -22,51 +22,17 @@ import type { WebhookSubscriptionTypeEnum } from './webhook-subscription-type-en /** * Information about a webhook that Bandwidth should send upon the completion of event customer has subscribed to. - * @export - * @interface WebhookSubscription */ export interface WebhookSubscription { - /** - * - * @type {string} - * @memberof WebhookSubscription - */ 'id'?: string; - /** - * - * @type {string} - * @memberof WebhookSubscription - */ 'accountId'?: string; /** * 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} - * @memberof WebhookSubscription */ 'callbackUrl': string | null; - /** - * - * @type {WebhookSubscriptionTypeEnum} - * @memberof WebhookSubscription - */ 'type'?: WebhookSubscriptionTypeEnum; - /** - * - * @type {WebhookSubscriptionBasicAuthentication} - * @memberof WebhookSubscription - */ 'basicAuthentication'?: WebhookSubscriptionBasicAuthentication; - /** - * - * @type {string} - * @memberof WebhookSubscription - */ 'createdDate'?: string; - /** - * - * @type {string} - * @memberof WebhookSubscription - */ 'modifiedDate'?: string; } diff --git a/models/webhook-subscriptions-list-body.ts b/models/webhook-subscriptions-list-body.ts index 564109e..c54ce43 100644 --- a/models/webhook-subscriptions-list-body.ts +++ b/models/webhook-subscriptions-list-body.ts @@ -25,27 +25,10 @@ import type { WebhookSubscription } from './webhook-subscription'; /** * A list of all webhook subscriptions registered for this account ID for this particular feature (unpaginated). - * @export - * @interface WebhookSubscriptionsListBody */ export interface WebhookSubscriptionsListBody { - /** - * - * @type {LinksObject} - * @memberof WebhookSubscriptionsListBody - */ 'links'?: LinksObject; - /** - * - * @type {Array} - * @memberof WebhookSubscriptionsListBody - */ 'errors'?: Array; - /** - * - * @type {Array} - * @memberof WebhookSubscriptionsListBody - */ 'data': Array; } diff --git a/openapitools.json b/openapitools.json index 151c200..f052220 100644 --- a/openapitools.json +++ b/openapitools.json @@ -2,6 +2,6 @@ "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json", "spaces": 2, "generator-cli": { - "version": "7.13.0" + "version": "7.17.0" } } diff --git a/package.json b/package.json index 3628cf1..10ff4cc 100644 --- a/package.json +++ b/package.json @@ -18,7 +18,7 @@ "main": "./dist/index.js", "typings": "./dist/index.d.ts", "scripts": { - "build": "tsc ", + "build": "tsc", "prepare": "npm run build", "test-unit": "jest --coverage --detectOpenHandles --testPathPattern=tests/unit", "test-smoke": "jest --coverage --detectOpenHandles --testPathPattern=tests/smoke", diff --git a/tests/smoke/phone-number-lookup-api.test.ts b/tests/smoke/phone-number-lookup-api.test.ts index 17513fd..3f35e3d 100644 --- a/tests/smoke/phone-number-lookup-api.test.ts +++ b/tests/smoke/phone-number-lookup-api.test.ts @@ -1,82 +1,85 @@ //@ts-nocheck import { PhoneNumberLookupApi } from "../../api"; import { Configuration } from "../../configuration"; -import { LookupRequest, LookupStatusEnum } from "../../models"; -import { sleep } from "../callUtils"; +import { + AsyncLookupRequest, + CompletedLookupStatusEnum, + InProgressLookupStatusEnum, + LatestMessageDeliveryStatusEnum, + LineTypeEnum, + SyncLookupRequest +} from "../../models"; +import { sleep } from '../callUtils'; describe('PhoneNumberLookupApi', () => { - jest.setTimeout(10000); - const config = new Configuration({username: BW_USERNAME, password: BW_PASSWORD}); + jest.setTimeout(20000); + const config = new Configuration({ + username: BW_USERNAME, + password: BW_PASSWORD + }); const phoneNumberLookupApi = new PhoneNumberLookupApi(config); - let lookupRequestId: string; + const phoneNumbers = [BW_NUMBER, USER_NUMBER]; - describe('createLookup', () => { - test('should lookup phone number', async () => { - const lookupRequest: LookupRequest = { - tns: [BW_NUMBER] - }; + describe('createGetAsyncBulkLookup', () => { + test('should create and get an async bulk lookup request', async () => { + const request: AsyncLookupRequest = { phoneNumbers }; - const { status, data } = await phoneNumberLookupApi.createLookup(BW_ACCOUNT_ID, lookupRequest); + const { status: createStatus, data: createData } + = await phoneNumberLookupApi.createAsyncBulkLookup(BW_ACCOUNT_ID, request); - expect(status).toEqual(202); - expect(data.requestId).toHaveLength(36); - expect(data.status).toBeOneOf(Object.values(LookupStatusEnum)); + expect(createStatus).toEqual(202); + expect(createData.links[0]).toBeDefined(); + expect(createData.links[0].rel).toBeString(); + expect(createData.links[0].href).toBeString(); + expect(createData.links[0].method).toBeString(); + expect(createData.data.requestId).toBeString(); + expect(createData.data.status).toBeOneOf(Object.values(InProgressLookupStatusEnum)); + expect(createData.errors).toBeInstanceOf(Array); - lookupRequestId = data.requestId!; - await sleep(1); - }); - }); + const requestId = createData.data.requestId; + await sleep(10); - describe('getLookupStatus', () => { - test('should get lookup status', async () => { - const { status, data } = await phoneNumberLookupApi.getLookupStatus(BW_ACCOUNT_ID, lookupRequestId); + const { status: getStatus, data: getData } + = await phoneNumberLookupApi.getAsyncBulkLookup(BW_ACCOUNT_ID, requestId); - expect(status).toEqual(200); - expect(data.requestId).toEqual(lookupRequestId); - expect(data.status).toBeOneOf(Object.values(LookupStatusEnum)); - expect(data.result).toBeInstanceOf(Array); - expect(data.result![0]['Response Code']).toBeInteger(); - expect(data.result![0]['E.164 Format']).toEqual(BW_NUMBER); + expect(getStatus).toEqual(200); + expect(getData.links[0]).toBeDefined(); + expect(getData.links[0].rel).toBeString(); + expect(getData.links[0].href).toBeString(); + expect(getData.links[0].method).toBeString(); + expect(getData.data.requestId).toEqual(requestId); + expect(getData.data.status).toBeOneOf(Object.values(InProgressLookupStatusEnum)); + expect(getData.data.results).toBeInstanceOf(Array); + expect(getData.data.results[0]).toBeDefined(); + expect(getData.data.results[0].phoneNumber).toBeString(); + expect(getData.data.results[0].lineType).toBeOneOf(Object.values(LineTypeEnum)); + expect(getData.data.results[0].messagingProvider).toBeString(); + expect(getData.data.results[0].voiceProvider).toBeString(); + expect(getData.data.results[0].countryCodeA3).toBeString(); }); }); - describe('HTTP Errors', () => { - test('400', async () => { - const lookupRequest: LookupRequest = { - tns: ['+1invalid'] - }; - - try { - await phoneNumberLookupApi.createLookup(BW_ACCOUNT_ID, lookupRequest); - } catch (e) { - expect(e.response.status).toEqual(400); - } - }); + describe('createSyncLookup', () => { + test('should create a sync lookup', async () => { + const request: SyncLookupRequest = { phoneNumbers }; - test('401', async () => { - const configBad = new Configuration({username: UNAUTHORIZED_USERNAME, password: UNAUTHORIZED_PASSWORD}); - const phoneNumberLookupApiBad = new PhoneNumberLookupApi(configBad); + const { status, data } = await phoneNumberLookupApi.createSyncLookup(BW_ACCOUNT_ID, request); - const lookupRequest: LookupRequest = { - tns: [BW_NUMBER] - }; - - try { - await phoneNumberLookupApiBad.createLookup(BW_ACCOUNT_ID, lookupRequest); - } catch (e) { - expect(e.response.status).toEqual(401); - } - }); - - test('404', async () => { - const requestIdBad = '00000000-0000-0000-0000-000000000000'; - - try { - await phoneNumberLookupApi.getLookupStatus(BW_ACCOUNT_ID, requestIdBad); - } catch (e) { - expect(e.response.status).toEqual(404); - } + expect(status).toEqual(200); + expect(data.links[0]).toBeDefined(); + expect(data.links[0].rel).toBeString(); + expect(data.links[0].href).toBeString(); + expect(data.links[0].method).toBeString(); + expect(data.data.requestId).toBeString(); + expect(data.data.status).toBeOneOf(Object.values(CompletedLookupStatusEnum)); + expect(data.data.results).toBeInstanceOf(Array); + expect(data.data.results[0]).toBeDefined(); + expect(data.data.results[0].phoneNumber).toBeString(); + expect(data.data.results[0].lineType).toBeOneOf(Object.values(LineTypeEnum)); + expect(data.data.results[0].messagingProvider).toBeString(); + expect(data.data.results[0].voiceProvider).toBeString(); + expect(data.data.results[0].countryCodeA3).toBeString(); }); }); }); diff --git a/tests/unit/api/phone-number-lookup-api.test.ts b/tests/unit/api/phone-number-lookup-api.test.ts index 8f1e555..c68474f 100644 --- a/tests/unit/api/phone-number-lookup-api.test.ts +++ b/tests/unit/api/phone-number-lookup-api.test.ts @@ -1,7 +1,14 @@ //@ts-nocheck import { PhoneNumberLookupApi } from "../../../api"; import { Configuration } from "../../../configuration"; -import { LookupRequest, LookupStatusEnum } from "../../../models"; +import { + AsyncLookupRequest, + CompletedLookupStatusEnum, + InProgressLookupStatusEnum, + LatestMessageDeliveryStatusEnum, + LineTypeEnum, + SyncLookupRequest +} from "../../../models"; describe('PhoneNumberLookupApi', () => { const config = new Configuration({ @@ -11,76 +18,75 @@ describe('PhoneNumberLookupApi', () => { }); const phoneNumberLookupApi = new PhoneNumberLookupApi(config); - const lookupRequestId = '1234'; + const phoneNumbers = [BW_NUMBER, USER_NUMBER]; + const requestId = '123e4567-e89b-12d3-a456-426614174000'; - describe('createLookup', () => { - test('should lookup phone number', async () => { - const lookupRequest: LookupRequest = { - tns: [BW_NUMBER] - }; + describe('createAsyncBulkLookup', () => { + test('should create an async bulk lookup request', async () => { + const request: AsyncLookupRequest = { phoneNumbers }; - const { status, data } = await phoneNumberLookupApi.createLookup(BW_ACCOUNT_ID, lookupRequest); + const { status, data } = await phoneNumberLookupApi.createAsyncBulkLookup(BW_ACCOUNT_ID, request); expect(status).toEqual(202); - expect(data.requestId).toHaveLength(36); - expect(data.status).toBeOneOf(Object.values(LookupStatusEnum)); + expect(data.links[0]).toBeDefined(); + expect(data.links[0].rel).toBeString(); + expect(data.links[0].href).toBeString(); + expect(data.links[0].method).toBeString(); + expect(data.data.requestId).toBeString(); + expect(data.data.status).toBeOneOf(Object.values(InProgressLookupStatusEnum)); + expect(data.errors).toBeInstanceOf(Array); }); }); - describe('getLookupStatus', () => { - test('should get lookup status', async () => { - const { status, data } = await phoneNumberLookupApi.getLookupStatus( - BW_ACCOUNT_ID, - lookupRequestId, - { headers: { Prefer: 'example=lookupMultipleNumbersPartialCompleteExample' } } - ); + describe('createSyncLookup', () => { + test('should create a sync lookup', async () => { + const request: SyncLookupRequest = { phoneNumbers }; + + const { status, data } = await phoneNumberLookupApi.createSyncLookup(BW_ACCOUNT_ID, request); expect(status).toEqual(200); - expect(data.requestId).toHaveLength(36); - expect(data.status).toBeOneOf(Object.values(LookupStatusEnum)); - expect(data.result).toBeInstanceOf(Array); - expect(data.result![0]).toContainAllKeys([ - 'Response Code', - 'Message', - 'E.164 Format', - 'Formatted', - 'Country', - 'Line Type', - 'Line Provider', - 'Mobile Country Code', - 'Mobile Network Code', - ]); - expect(data.result![0]['Response Code']).toBeInteger(); - expect(data.result![0].Message).toBeString(); - expect(data.result![0]['E.164 Format']).toHaveLength(12); - expect(data.result![0].Formatted).toHaveLength(14); - expect(data.result![0].Country).toBeString(); - expect(data.result![0]['Line Type']).toBeString(); - expect(data.result![0]['Line Provider']).toBeString(); - expect(data.result![0]['Mobile Country Code']).toBeString(); - expect(data.result![0]['Mobile Network Code']).toBeString(); - expect(data.failedTelephoneNumbers).toBeInstanceOf(Array); - expect(data.failedTelephoneNumbers![0]).toBeString(); + expect(data.links[0]).toBeDefined(); + expect(data.links[0].rel).toBeString(); + expect(data.links[0].href).toBeString(); + expect(data.links[0].method).toBeString(); + expect(data.data.requestId).toBeString(); + expect(data.data.status).toBeOneOf(Object.values(CompletedLookupStatusEnum)); + expect(data.data.results).toBeInstanceOf(Array); + expect(data.data.results[0]).toBeDefined(); + expect(data.data.results[0].phoneNumber).toBeString(); + expect(data.data.results[0].lineType).toBeOneOf(Object.values(LineTypeEnum)); + expect(data.data.results[0].messagingProvider).toBeString(); + expect(data.data.results[0].voiceProvider).toBeString(); + expect(data.data.results[0].countryCodeA3).toBeString(); + expect(data.data.results[0].latestMessageDeliveryStatus).toBeOneOf(Object.values(LatestMessageDeliveryStatusEnum)); + expect(data.data.results[0].initialMessageDeliveryStatusDate).toBeDateString(); + expect(data.data.results[0].latestMessageDeliveryStatusDate).toBeDateString(); + expect(data.errors).toBeInstanceOf(Array); }); }); - describe('HTTP Errors', () => { - test('400', async () => { - try { - await phoneNumberLookupApi.createLookup(BW_ACCOUNT_ID, {}); - } catch (e) { - expect(e.response.status).toEqual(400); - } - }); + describe('getAsyncBulkLookup', () => { + test('should get an async bulk lookup', async () => { + const { status, data } = await phoneNumberLookupApi.getAsyncBulkLookup(BW_ACCOUNT_ID, requestId); - test('401', async () => { - const unauthorizedConfig = new Configuration({ basePath: 'http://127.0.0.1:4010' }); - const unauthorizedPhoneNumberLookupApi = new PhoneNumberLookupApi(unauthorizedConfig); - try { - await unauthorizedPhoneNumberLookupApi.getLookupStatus(BW_ACCOUNT_ID, lookupRequestId); - } catch (e) { - expect(e.response.status).toEqual(401); - } + expect(status).toEqual(200); + expect(data.links[0]).toBeDefined(); + expect(data.links[0].rel).toBeString(); + expect(data.links[0].href).toBeString(); + expect(data.links[0].method).toBeString(); + expect(data.data.requestId).toBeString(); + expect(data.data.status).toBeOneOf(Object.values(InProgressLookupStatusEnum)); + expect(data.data.results).toBeInstanceOf(Array); + expect(data.data.results[0]).toBeDefined(); + expect(data.data.results[0].phoneNumber).toBeString(); + expect(data.data.results[0].lineType).toBeOneOf(Object.values(LineTypeEnum)); + expect(data.data.results[0].messagingProvider).toBeString(); + expect(data.data.results[0].voiceProvider).toBeString(); + expect(data.data.results[0].countryCodeA3).toBeString(); + expect(data.data.results[0].latestMessageDeliveryStatus).toBeOneOf(Object.values(LatestMessageDeliveryStatusEnum)); + expect(data.data.results[0].initialMessageDeliveryStatusDate).toBeDateString(); + expect(data.data.results[0].latestMessageDeliveryStatusDate).toBeDateString(); + expect(data.errors).toBeInstanceOf(Array); }); }); }); diff --git a/tests/unit/models/completed-lookup-status-enum.test.ts b/tests/unit/models/completed-lookup-status-enum.test.ts new file mode 100644 index 0000000..431c1a6 --- /dev/null +++ b/tests/unit/models/completed-lookup-status-enum.test.ts @@ -0,0 +1,9 @@ +import { CompletedLookupStatusEnum } from '../../../models/completed-lookup-status-enum'; + +describe('CompletedLookupStatusEnum', () => { + test('should define the expected values', () => { + expect(CompletedLookupStatusEnum.Complete).toBe('COMPLETE'); + expect(CompletedLookupStatusEnum.PartialComplete).toBe('PARTIAL_COMPLETE'); + expect(CompletedLookupStatusEnum.Failed).toBe('FAILED'); + }); +}); diff --git a/tests/unit/models/deactivation-event-enum.test.ts b/tests/unit/models/deactivation-event-enum.test.ts new file mode 100644 index 0000000..d7e53e5 --- /dev/null +++ b/tests/unit/models/deactivation-event-enum.test.ts @@ -0,0 +1,7 @@ +import { DeactivationEventEnum } from '../../../models/deactivation-event-enum'; + +describe('DeactivationEventEnum', () => { + test('should define the expected values', () => { + expect(DeactivationEventEnum.Deactivated).toBe('DEACTIVATED'); + }); +}); diff --git a/tests/unit/models/in-progress-lookup-status-enum.test.ts b/tests/unit/models/in-progress-lookup-status-enum.test.ts new file mode 100644 index 0000000..f829f06 --- /dev/null +++ b/tests/unit/models/in-progress-lookup-status-enum.test.ts @@ -0,0 +1,11 @@ +import { InProgressLookupStatusEnum } from '../../../models/in-progress-lookup-status-enum'; + +describe('InProgressLookupStatusEnum', () => { + test('should define the expected values', () => { + expect(InProgressLookupStatusEnum.InProgress).toBe('IN_PROGRESS'); + expect(InProgressLookupStatusEnum.Complete).toBe('COMPLETE'); + expect(InProgressLookupStatusEnum.PartialComplete).toBe('PARTIAL_COMPLETE'); + expect(InProgressLookupStatusEnum.Failed).toBe('FAILED'); + }); +}); + diff --git a/tests/unit/models/latest-message-delivery-status-enum.test.ts b/tests/unit/models/latest-message-delivery-status-enum.test.ts new file mode 100644 index 0000000..d596405 --- /dev/null +++ b/tests/unit/models/latest-message-delivery-status-enum.test.ts @@ -0,0 +1,10 @@ +import { LatestMessageDeliveryStatusEnum } from '../../../models/latest-message-delivery-status-enum'; + +describe('LatestMessageDeliveryStatusEnum', () => { + test('should define the expected values', () => { + expect(LatestMessageDeliveryStatusEnum.Active).toBe('ACTIVE'); + expect(LatestMessageDeliveryStatusEnum.Deactivated).toBe('DEACTIVATED'); + expect(LatestMessageDeliveryStatusEnum.Unknown).toBe('UNKNOWN'); + }); +}); + diff --git a/tests/unit/models/line-type-enum.test.ts b/tests/unit/models/line-type-enum.test.ts new file mode 100644 index 0000000..d1e429c --- /dev/null +++ b/tests/unit/models/line-type-enum.test.ts @@ -0,0 +1,11 @@ +import { LineTypeEnum } from '../../../models/line-type-enum'; + +describe('LineTypeEnum', () => { + test('should define the expected values', () => { + expect(LineTypeEnum.Fixed).toBe('FIXED'); + expect(LineTypeEnum.VoipFixed).toBe('VOIP-FIXED'); + expect(LineTypeEnum.Mobile).toBe('MOBILE'); + expect(LineTypeEnum.Voip).toBe('VOIP'); + }); +}); + diff --git a/tests/unit/models/lookup-status-enum.test.ts b/tests/unit/models/lookup-status-enum.test.ts deleted file mode 100644 index a39beb6..0000000 --- a/tests/unit/models/lookup-status-enum.test.ts +++ /dev/null @@ -1,10 +0,0 @@ -import { LookupStatusEnum } from '../../../models/lookup-status-enum'; - -describe('LookupStatusEnum', () => { - test('should define the expected values', () => { - expect(LookupStatusEnum.InProgress).toBe('IN_PROGRESS'); - expect(LookupStatusEnum.Complete).toBe('COMPLETE'); - expect(LookupStatusEnum.PartialComplete).toBe('PARTIAL_COMPLETE'); - expect(LookupStatusEnum.Failed).toBe('FAILED'); - }); -});