bandwidth-sdk 4.1.2 → 5.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +189 -1
- package/.openapi-generator/VERSION +1 -1
- package/api/multi-channel-api.ts +150 -0
- package/api.ts +1 -0
- package/bandwidth.yml +675 -101
- package/base.ts +6 -0
- package/configuration.ts +1 -1
- package/coverage/clover.xml +565 -460
- package/coverage/coverage-final.json +79 -70
- package/coverage/lcov-report/index.html +27 -27
- package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +14 -14
- package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +18 -18
- package/coverage/lcov-report/node-sdk/api/index.html +24 -9
- package/coverage/lcov-report/node-sdk/api/media-api.ts.html +13 -13
- package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +11 -11
- package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +12 -12
- package/coverage/lcov-report/node-sdk/api/multi-channel-api.ts.html +535 -0
- package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +11 -11
- package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +19 -19
- package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +10 -10
- package/coverage/lcov-report/node-sdk/api/toll-free-verification-api.ts.html +17 -17
- package/coverage/lcov-report/node-sdk/api/transcriptions-api.ts.html +12 -12
- package/coverage/lcov-report/node-sdk/api.ts.html +17 -14
- package/coverage/lcov-report/node-sdk/base.ts.html +32 -14
- package/coverage/lcov-report/node-sdk/common.ts.html +11 -11
- package/coverage/lcov-report/node-sdk/configuration.ts.html +14 -14
- package/coverage/lcov-report/node-sdk/index.html +7 -7
- package/coverage/lcov-report/node-sdk/models/bxml/Bxml.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/NestableVerb.ts.html +6 -6
- package/coverage/lcov-report/node-sdk/models/bxml/Response.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/Root.ts.html +8 -8
- package/coverage/lcov-report/node-sdk/models/bxml/Verb.ts.html +6 -6
- package/coverage/lcov-report/node-sdk/models/bxml/index.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/index.ts.html +3 -3
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Bridge.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Conference.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/CustomParam.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Forward.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Gather.ts.html +7 -7
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Hangup.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Pause.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PauseRecording.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PhoneNumber.ts.html +7 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PlayAudio.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Record.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Redirect.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/ResumeRecording.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Ring.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SendDtmf.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SipUri.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SpeakSentence.ts.html +6 -6
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartGather.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartRecording.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartStream.ts.html +5 -5
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartTranscription.ts.html +5 -5
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopGather.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopRecording.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopStream.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopTranscription.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StreamParam.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Tag.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Transfer.ts.html +5 -5
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.ts.html +31 -31
- package/coverage/lcov-report/node-sdk/models/call-direction-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/call-state-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/call-transcription-detected-language-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/call-transcription-track-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/callback-method-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/callback-type-enum.ts.html +6 -6
- package/coverage/lcov-report/node-sdk/models/card-width-enum.ts.html +178 -0
- package/coverage/lcov-report/node-sdk/models/conference-state-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/file-format-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/index.html +125 -5
- package/coverage/lcov-report/node-sdk/models/index.ts.html +213 -117
- package/coverage/lcov-report/node-sdk/models/list-message-direction-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/lookup-status-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/machine-detection-mode-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/message-direction-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/message-status-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/message-type-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/multi-channel-message-channel-enum.ts.html +181 -0
- package/coverage/lcov-report/node-sdk/models/multi-channel-message-direction-enum.ts.html +178 -0
- package/coverage/lcov-report/node-sdk/models/multi-channel-status-enum.ts.html +184 -0
- package/coverage/lcov-report/node-sdk/models/priority-enum.ts.html +3 -3
- package/coverage/lcov-report/node-sdk/models/rbm-action-type-enum.ts.html +190 -0
- package/coverage/lcov-report/node-sdk/models/rbm-media-height-enum.ts.html +181 -0
- package/coverage/lcov-report/node-sdk/models/recording-state-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/redirect-method-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/standalone-card-orientation-enum.ts.html +178 -0
- package/coverage/lcov-report/node-sdk/models/tfv-callback-status-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/tfv-status-enum.ts.html +4 -10
- package/coverage/lcov-report/node-sdk/models/thumbnail-alignment-enum.ts.html +178 -0
- package/coverage/lcov-report/node-sdk/models/webhook-subscription-type-enum.ts.html +2 -2
- package/coverage/lcov.info +723 -517
- package/dist/api/multi-channel-api.d.ts +79 -0
- package/dist/api/multi-channel-api.js +230 -0
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/base.js +6 -0
- package/dist/configuration.js +1 -1
- package/dist/models/bxml/verbs/PhoneNumber.d.ts +1 -0
- package/dist/models/callback-type-enum.d.ts +4 -4
- package/dist/models/callback-type-enum.js +4 -4
- package/dist/models/card-width-enum.d.ts +21 -0
- package/dist/models/card-width-enum.js +25 -0
- package/dist/models/create-multi-channel-message-response.d.ts +39 -0
- package/dist/models/create-multi-channel-message-response.js +15 -0
- package/dist/models/error-object.d.ts +30 -0
- package/dist/models/error-object.js +15 -0
- package/dist/models/index.d.ts +33 -1
- package/dist/models/index.js +33 -1
- package/dist/models/link.d.ts +30 -0
- package/dist/models/link.js +15 -0
- package/dist/models/message-callback.d.ts +6 -0
- package/dist/models/message-request.d.ts +1 -1
- package/dist/models/message.d.ts +1 -1
- package/dist/models/mms-message-content.d.ts +30 -0
- package/dist/models/mms-message-content.js +15 -0
- package/dist/models/multi-channel-action-calendar-event.d.ts +17 -0
- package/dist/models/multi-channel-action-calendar-event.js +15 -0
- package/dist/models/multi-channel-action.d.ts +33 -0
- package/dist/models/multi-channel-action.js +15 -0
- package/dist/models/multi-channel-callback-data.d.ts +50 -0
- package/dist/models/multi-channel-callback-data.js +15 -0
- package/dist/models/multi-channel-channel-list-object-content.d.ts +22 -0
- package/dist/models/multi-channel-channel-list-object-content.js +15 -0
- package/dist/models/multi-channel-channel-list-object.d.ts +44 -0
- package/dist/models/multi-channel-channel-list-object.js +15 -0
- package/dist/models/multi-channel-message-callback-data.d.ts +69 -0
- package/dist/models/multi-channel-message-callback-data.js +15 -0
- package/dist/models/multi-channel-message-channel-enum.d.ts +22 -0
- package/dist/models/multi-channel-message-channel-enum.js +26 -0
- package/dist/models/multi-channel-message-data.d.ts +75 -0
- package/dist/models/multi-channel-message-data.js +15 -0
- package/dist/models/multi-channel-message-direction-enum.d.ts +21 -0
- package/dist/models/multi-channel-message-direction-enum.js +25 -0
- package/dist/models/multi-channel-message-request.d.ts +50 -0
- package/dist/models/multi-channel-message-request.js +15 -0
- package/dist/models/multi-channel-status-enum.d.ts +23 -0
- package/dist/models/multi-channel-status-enum.js +27 -0
- package/dist/models/priority-enum.d.ts +1 -1
- package/dist/models/priority-enum.js +1 -1
- package/dist/models/rbm-action-base.d.ts +37 -0
- package/dist/models/rbm-action-base.js +15 -0
- package/dist/models/rbm-action-dial.d.ts +17 -0
- package/dist/models/rbm-action-dial.js +15 -0
- package/dist/models/rbm-action-open-url.d.ts +17 -0
- package/dist/models/rbm-action-open-url.js +15 -0
- package/dist/models/rbm-action-type-enum.d.ts +25 -0
- package/dist/models/rbm-action-type-enum.js +29 -0
- package/dist/models/rbm-action-view-location.d.ts +17 -0
- package/dist/models/rbm-action-view-location.js +15 -0
- package/dist/models/rbm-card-content-media.d.ts +17 -0
- package/dist/models/rbm-card-content-media.js +15 -0
- package/dist/models/rbm-card-content.d.ts +44 -0
- package/dist/models/rbm-card-content.js +15 -0
- package/dist/models/rbm-media-height-enum.d.ts +22 -0
- package/dist/models/rbm-media-height-enum.js +26 -0
- package/dist/models/rbm-message-carousel-card.d.ts +39 -0
- package/dist/models/rbm-message-carousel-card.js +15 -0
- package/dist/models/rbm-message-content-file.d.ts +30 -0
- package/dist/models/rbm-message-content-file.js +15 -0
- package/dist/models/rbm-message-content-rich-card.d.ts +18 -0
- package/dist/models/rbm-message-content-rich-card.js +15 -0
- package/dist/models/rbm-message-content-text.d.ts +31 -0
- package/dist/models/rbm-message-content-text.js +15 -0
- package/dist/models/rbm-message-media.d.ts +32 -0
- package/dist/models/rbm-message-media.js +15 -0
- package/dist/models/rbm-standalone-card.d.ts +46 -0
- package/dist/models/rbm-standalone-card.js +15 -0
- package/dist/models/sms-message-content.d.ts +24 -0
- package/dist/models/sms-message-content.js +15 -0
- package/dist/models/standalone-card-orientation-enum.d.ts +21 -0
- package/dist/models/standalone-card-orientation-enum.js +25 -0
- package/dist/models/tfv-status-enum.d.ts +0 -2
- package/dist/models/tfv-status-enum.js +1 -3
- package/dist/models/tfv-status.d.ts +12 -0
- package/dist/models/tfv-submission-info.d.ts +18 -0
- package/dist/models/thumbnail-alignment-enum.d.ts +21 -0
- package/dist/models/thumbnail-alignment-enum.js +25 -0
- package/dist/models/verification-denial-webhook.d.ts +12 -0
- package/dist/models/verification-request.d.ts +18 -0
- package/dist/models/verification-update-request.d.ts +18 -0
- package/docs/AccountStatistics.md +22 -0
- package/docs/AdditionalDenialReason.md +24 -0
- package/docs/Address.md +32 -0
- package/docs/AnswerCallback.md +47 -0
- package/docs/BridgeCompleteCallback.md +51 -0
- package/docs/BridgeTargetCompleteCallback.md +45 -0
- package/docs/CallDirectionEnum.md +11 -0
- package/docs/CallRecordingMetadata.md +56 -0
- package/docs/CallState.md +54 -0
- package/docs/CallStateEnum.md +11 -0
- package/docs/CallTranscription.md +26 -0
- package/docs/CallTranscriptionDetectedLanguageEnum.md +13 -0
- package/docs/CallTranscriptionMetadata.md +24 -0
- package/docs/CallTranscriptionResponse.md +26 -0
- package/docs/CallTranscriptionTrackEnum.md +11 -0
- package/docs/CallbackMethodEnum.md +11 -0
- package/docs/CallbackTypeEnum.md +15 -0
- package/docs/CallsApi.md +350 -0
- package/docs/CardWidthEnum.md +10 -0
- package/docs/CodeRequest.md +30 -0
- package/docs/Conference.md +34 -0
- package/docs/ConferenceCompletedCallback.md +29 -0
- package/docs/ConferenceCreatedCallback.md +29 -0
- package/docs/ConferenceMember.md +30 -0
- package/docs/ConferenceMemberExitCallback.md +35 -0
- package/docs/ConferenceMemberJoinCallback.md +35 -0
- package/docs/ConferenceRecordingAvailableCallback.md +47 -0
- package/docs/ConferenceRecordingMetadata.md +42 -0
- package/docs/ConferenceRedirectCallback.md +29 -0
- package/docs/ConferenceStateEnum.md +11 -0
- package/docs/ConferencesApi.md +609 -0
- package/docs/Contact.md +26 -0
- package/docs/CreateCall.md +60 -0
- package/docs/CreateCallResponse.md +60 -0
- package/docs/CreateLookupResponse.md +23 -0
- package/docs/CreateMessageRequestError.md +24 -0
- package/docs/CreateMultiChannelMessageResponse.md +24 -0
- package/docs/DeferredResult.md +22 -0
- package/docs/DisconnectCallback.md +53 -0
- package/docs/Diversion.md +32 -0
- package/docs/DtmfCallback.md +53 -0
- package/docs/Error.md +24 -0
- package/docs/ErrorObject.md +22 -0
- package/docs/FailureWebhook.md +30 -0
- package/docs/FieldError.md +22 -0
- package/docs/FileFormatEnum.md +11 -0
- package/docs/GatherCallback.md +55 -0
- package/docs/InitiateCallback.md +45 -0
- package/docs/Link.md +22 -0
- package/docs/LinksObject.md +26 -0
- package/docs/ListMessageDirectionEnum.md +11 -0
- package/docs/ListMessageItem.md +52 -0
- package/docs/LookupRequest.md +21 -0
- package/docs/LookupResult.md +37 -0
- package/docs/LookupStatus.md +27 -0
- package/docs/LookupStatusEnum.md +15 -0
- package/docs/MFAApi.md +188 -0
- package/docs/MachineDetectionCompleteCallback.md +47 -0
- package/docs/MachineDetectionConfiguration.md +49 -0
- package/docs/MachineDetectionModeEnum.md +11 -0
- package/docs/MachineDetectionResult.md +23 -0
- package/docs/Media.md +24 -0
- package/docs/MediaApi.md +268 -0
- package/docs/Message.md +44 -0
- package/docs/MessageCallback.md +33 -0
- package/docs/MessageCallbackMessage.md +43 -0
- package/docs/MessageDirectionEnum.md +11 -0
- package/docs/MessageRequest.md +34 -0
- package/docs/MessageStatusEnum.md +23 -0
- package/docs/MessageTypeEnum.md +11 -0
- package/docs/MessagesApi.md +175 -0
- package/docs/MessagesList.md +24 -0
- package/docs/MessagingCodeResponse.md +20 -0
- package/docs/MessagingRequestError.md +22 -0
- package/docs/MfaForbiddenRequestError.md +20 -0
- package/docs/MfaRequestError.md +22 -0
- package/docs/MfaUnauthorizedRequestError.md +20 -0
- package/docs/MmsMessageContent.md +22 -0
- package/docs/MultiChannelAction.md +42 -0
- package/docs/MultiChannelActionCalendarEvent.md +32 -0
- package/docs/MultiChannelApi.md +71 -0
- package/docs/MultiChannelCallbackData.md +28 -0
- package/docs/MultiChannelChannelListObject.md +26 -0
- package/docs/MultiChannelChannelListObjectContent.md +35 -0
- package/docs/MultiChannelMessageCallbackData.md +34 -0
- package/docs/MultiChannelMessageChannelEnum.md +13 -0
- package/docs/MultiChannelMessageData.md +36 -0
- package/docs/MultiChannelMessageDirectionEnum.md +10 -0
- package/docs/MultiChannelMessageRequest.md +29 -0
- package/docs/MultiChannelStatusEnum.md +14 -0
- package/docs/OptInWorkflow.md +22 -0
- package/docs/PageInfo.md +26 -0
- package/docs/PhoneNumberLookupApi.md +130 -0
- package/docs/PriorityEnum.md +11 -0
- package/docs/RbmActionBase.md +24 -0
- package/docs/RbmActionDial.md +26 -0
- package/docs/RbmActionOpenUrl.md +26 -0
- package/docs/RbmActionTypeEnum.md +18 -0
- package/docs/RbmActionViewLocation.md +30 -0
- package/docs/RbmCardContent.md +26 -0
- package/docs/RbmCardContentMedia.md +24 -0
- package/docs/RbmMediaHeightEnum.md +13 -0
- package/docs/RbmMessageCarouselCard.md +24 -0
- package/docs/RbmMessageContentFile.md +22 -0
- package/docs/RbmMessageContentRichCard.md +30 -0
- package/docs/RbmMessageContentText.md +22 -0
- package/docs/RbmMessageMedia.md +22 -0
- package/docs/RbmStandaloneCard.md +26 -0
- package/docs/RecordingAvailableCallback.md +63 -0
- package/docs/RecordingCompleteCallback.md +63 -0
- package/docs/RecordingStateEnum.md +11 -0
- package/docs/RecordingTranscriptionMetadata.md +27 -0
- package/docs/RecordingTranscriptions.md +20 -0
- package/docs/RecordingsApi.md +675 -0
- package/docs/RedirectCallback.md +51 -0
- package/docs/RedirectMethodEnum.md +11 -0
- package/docs/SmsMessageContent.md +20 -0
- package/docs/StandaloneCardOrientationEnum.md +10 -0
- package/docs/StatisticsApi.md +67 -0
- package/docs/StirShaken.md +24 -0
- package/docs/TelephoneNumber.md +20 -0
- package/docs/TfvBasicAuthentication.md +22 -0
- package/docs/TfvCallbackStatusEnum.md +10 -0
- package/docs/TfvError.md +25 -0
- package/docs/TfvStatus.md +38 -0
- package/docs/TfvStatusEnum.md +12 -0
- package/docs/TfvSubmissionInfo.md +42 -0
- package/docs/TfvSubmissionWrapper.md +20 -0
- package/docs/ThumbnailAlignmentEnum.md +11 -0
- package/docs/TnLookupRequestError.md +20 -0
- package/docs/TollFreeVerificationApi.md +505 -0
- package/docs/TranscribeRecording.md +32 -0
- package/docs/Transcription.md +22 -0
- package/docs/TranscriptionAvailableCallback.md +61 -0
- package/docs/TranscriptionsApi.md +202 -0
- package/docs/TransferAnswerCallback.md +49 -0
- package/docs/TransferCompleteCallback.md +55 -0
- package/docs/TransferDisconnectCallback.md +59 -0
- package/docs/UpdateCall.md +38 -0
- package/docs/UpdateCallRecording.md +20 -0
- package/docs/UpdateConference.md +36 -0
- package/docs/UpdateConferenceMember.md +24 -0
- package/docs/VerificationDenialWebhook.md +38 -0
- package/docs/VerificationRequest.md +44 -0
- package/docs/VerificationUpdateRequest.md +42 -0
- package/docs/VerificationWebhook.md +26 -0
- package/docs/VerifyCodeRequest.md +26 -0
- package/docs/VerifyCodeResponse.md +20 -0
- package/docs/VoiceApiError.md +24 -0
- package/docs/VoiceCodeResponse.md +20 -0
- package/docs/WebhookSubscription.md +33 -0
- package/docs/WebhookSubscriptionBasicAuthentication.md +23 -0
- package/docs/WebhookSubscriptionRequestSchema.md +24 -0
- package/docs/WebhookSubscriptionTypeEnum.md +10 -0
- package/docs/WebhookSubscriptionsListBody.md +25 -0
- package/models/bxml/verbs/PhoneNumber.ts +1 -0
- package/models/callback-type-enum.ts +4 -4
- package/models/card-width-enum.ts +31 -0
- package/models/create-multi-channel-message-response.ts +51 -0
- package/models/error-object.ts +36 -0
- package/models/index.ts +33 -1
- package/models/link.ts +36 -0
- package/models/message-callback.ts +6 -0
- package/models/message-request.ts +1 -1
- package/models/message.ts +1 -1
- package/models/mms-message-content.ts +36 -0
- package/models/multi-channel-action-calendar-event.ts +29 -0
- package/models/multi-channel-action.ts +41 -0
- package/models/multi-channel-callback-data.ts +62 -0
- package/models/multi-channel-channel-list-object-content.ts +54 -0
- package/models/multi-channel-channel-list-object.ts +56 -0
- package/models/multi-channel-message-callback-data.ts +83 -0
- package/models/multi-channel-message-channel-enum.ts +32 -0
- package/models/multi-channel-message-data.ts +89 -0
- package/models/multi-channel-message-direction-enum.ts +31 -0
- package/models/multi-channel-message-request.ts +62 -0
- package/models/multi-channel-status-enum.ts +33 -0
- package/models/priority-enum.ts +1 -1
- package/models/rbm-action-base.ts +47 -0
- package/models/rbm-action-dial.ts +29 -0
- package/models/rbm-action-open-url.ts +29 -0
- package/models/rbm-action-type-enum.ts +35 -0
- package/models/rbm-action-view-location.ts +29 -0
- package/models/rbm-card-content-media.ts +29 -0
- package/models/rbm-card-content.ts +54 -0
- package/models/rbm-media-height-enum.ts +32 -0
- package/models/rbm-message-carousel-card.ts +53 -0
- package/models/rbm-message-content-file.ts +36 -0
- package/models/rbm-message-content-rich-card.ts +44 -0
- package/models/rbm-message-content-text.ts +39 -0
- package/models/rbm-message-media.ts +42 -0
- package/models/rbm-standalone-card.ts +62 -0
- package/models/sms-message-content.ts +30 -0
- package/models/standalone-card-orientation-enum.ts +31 -0
- package/models/tfv-status-enum.ts +1 -3
- package/models/tfv-status.ts +12 -0
- package/models/tfv-submission-info.ts +18 -0
- package/models/thumbnail-alignment-enum.ts +31 -0
- package/models/verification-denial-webhook.ts +12 -0
- package/models/verification-request.ts +18 -0
- package/models/verification-update-request.ts +18 -0
- package/openapitools.json +1 -1
- package/package.json +1 -1
- package/tests/smoke/conferences-api.test.ts +4 -4
- package/tests/smoke/multi-channel-api.test.ts +44 -0
- package/tests/smoke/transcriptions-api.test.ts +1 -1
- package/tests/unit/api/multi-channel-api.test.ts +45 -0
- package/tests/unit/models/bxml/verbs/PhoneNumber.test.ts +3 -2
- package/tests/unit/models/callback-type-enum.test.ts +4 -4
- package/tests/unit/models/card-width-enum.test.ts +8 -0
- package/tests/unit/models/multi-channel-message-channel-enum.test.ts +9 -0
- package/tests/unit/models/multi-channel-message-direction-enum.test.ts +8 -0
- package/tests/unit/models/multi-channel-status-enum.test.ts +10 -0
- package/tests/unit/models/rbm-action-type-enum.test.ts +12 -0
- package/tests/unit/models/rbm-media-height-enum.test.ts +9 -0
- package/tests/unit/models/standalone-card-orientation-enum.test.ts +8 -0
- package/tests/unit/models/tfv-status-enum.test.ts +0 -2
- package/tests/unit/models/thumbnail-alignment-enum.test.ts +7 -0
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# LinksObject
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**first** | **string** | The first (or only) page of results matching the query. | [optional] [default to undefined]
|
|
9
|
+
**next** | **string** | If more results exist than specified by \'size\', this link returns the next page of \'size\' results. | [optional] [default to undefined]
|
|
10
|
+
**previous** | **string** | If the results are more than one page, this link returns the previous page of \'size\' results. | [optional] [default to undefined]
|
|
11
|
+
**last** | **string** | If more results exist than specified by \'size\', this link return the last page of result. | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { LinksObject } from 'bandwidth-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: LinksObject = {
|
|
19
|
+
first,
|
|
20
|
+
next,
|
|
21
|
+
previous,
|
|
22
|
+
last,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# ListMessageDirectionEnum
|
|
2
|
+
|
|
3
|
+
The direction of the message. One of INBOUND OUTBOUND.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `Inbound` (value: `'INBOUND'`)
|
|
8
|
+
|
|
9
|
+
* `Outbound` (value: `'OUTBOUND'`)
|
|
10
|
+
|
|
11
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# ListMessageItem
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**messageId** | **string** | The message id | [optional] [default to undefined]
|
|
9
|
+
**accountId** | **string** | The account id associated with this message. | [optional] [default to undefined]
|
|
10
|
+
**sourceTn** | **string** | The source phone number of the message. | [optional] [default to undefined]
|
|
11
|
+
**destinationTn** | **string** | The recipient phone number of the message. | [optional] [default to undefined]
|
|
12
|
+
**messageStatus** | [**MessageStatusEnum**](MessageStatusEnum.md) | | [optional] [default to undefined]
|
|
13
|
+
**messageDirection** | [**ListMessageDirectionEnum**](ListMessageDirectionEnum.md) | | [optional] [default to undefined]
|
|
14
|
+
**messageType** | [**MessageTypeEnum**](MessageTypeEnum.md) | | [optional] [default to undefined]
|
|
15
|
+
**segmentCount** | **number** | The number of segments the message was sent as. | [optional] [default to undefined]
|
|
16
|
+
**errorCode** | **number** | The numeric error code of the message. | [optional] [default to undefined]
|
|
17
|
+
**receiveTime** | **string** | The ISO 8601 datetime of the message. | [optional] [default to undefined]
|
|
18
|
+
**carrierName** | **string** | The name of the carrier. Not currently supported for MMS coming soon. | [optional] [default to undefined]
|
|
19
|
+
**messageSize** | **number** | The size of the message including message content and headers. | [optional] [default to undefined]
|
|
20
|
+
**messageLength** | **number** | The length of the message content. | [optional] [default to undefined]
|
|
21
|
+
**attachmentCount** | **number** | The number of attachments the message has. | [optional] [default to undefined]
|
|
22
|
+
**recipientCount** | **number** | The number of recipients the message has. | [optional] [default to undefined]
|
|
23
|
+
**campaignClass** | **string** | The campaign class of the message if it has one. | [optional] [default to undefined]
|
|
24
|
+
**campaignId** | **string** | The campaign ID of the message if it has one. | [optional] [default to undefined]
|
|
25
|
+
|
|
26
|
+
## Example
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
import { ListMessageItem } from 'bandwidth-sdk';
|
|
30
|
+
|
|
31
|
+
const instance: ListMessageItem = {
|
|
32
|
+
messageId,
|
|
33
|
+
accountId,
|
|
34
|
+
sourceTn,
|
|
35
|
+
destinationTn,
|
|
36
|
+
messageStatus,
|
|
37
|
+
messageDirection,
|
|
38
|
+
messageType,
|
|
39
|
+
segmentCount,
|
|
40
|
+
errorCode,
|
|
41
|
+
receiveTime,
|
|
42
|
+
carrierName,
|
|
43
|
+
messageSize,
|
|
44
|
+
messageLength,
|
|
45
|
+
attachmentCount,
|
|
46
|
+
recipientCount,
|
|
47
|
+
campaignClass,
|
|
48
|
+
campaignId,
|
|
49
|
+
};
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# LookupRequest
|
|
2
|
+
|
|
3
|
+
Create phone number lookup request.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**tns** | **Array<string>** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { LookupRequest } from 'bandwidth-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: LookupRequest = {
|
|
17
|
+
tns,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# LookupResult
|
|
2
|
+
|
|
3
|
+
Carrier information results for the specified telephone number.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**Response_Code** | **number** | Our vendor\'s response code. | [optional] [default to undefined]
|
|
10
|
+
**Message** | **string** | Message associated with the response code. | [optional] [default to undefined]
|
|
11
|
+
**E_164_Format** | **string** | The telephone number in E.164 format. | [optional] [default to undefined]
|
|
12
|
+
**Formatted** | **string** | The formatted version of the telephone number. | [optional] [default to undefined]
|
|
13
|
+
**Country** | **string** | The country of the telephone number. | [optional] [default to undefined]
|
|
14
|
+
**Line_Type** | **string** | The line type of the telephone number. | [optional] [default to undefined]
|
|
15
|
+
**Line_Provider** | **string** | The messaging service provider of the telephone number. | [optional] [default to undefined]
|
|
16
|
+
**Mobile_Country_Code** | **string** | The first half of the Home Network Identity (HNI). | [optional] [default to undefined]
|
|
17
|
+
**Mobile_Network_Code** | **string** | The second half of the HNI. | [optional] [default to undefined]
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { LookupResult } from 'bandwidth-sdk';
|
|
23
|
+
|
|
24
|
+
const instance: LookupResult = {
|
|
25
|
+
Response_Code,
|
|
26
|
+
Message,
|
|
27
|
+
E_164_Format,
|
|
28
|
+
Formatted,
|
|
29
|
+
Country,
|
|
30
|
+
Line_Type,
|
|
31
|
+
Line_Provider,
|
|
32
|
+
Mobile_Country_Code,
|
|
33
|
+
Mobile_Network_Code,
|
|
34
|
+
};
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# LookupStatus
|
|
2
|
+
|
|
3
|
+
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.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**requestId** | **string** | The requestId. | [optional] [default to undefined]
|
|
10
|
+
**status** | [**LookupStatusEnum**](LookupStatusEnum.md) | | [optional] [default to undefined]
|
|
11
|
+
**result** | [**Array<LookupResult>**](LookupResult.md) | The carrier information results for the specified telephone number. | [optional] [default to undefined]
|
|
12
|
+
**failedTelephoneNumbers** | **Array<string>** | The telephone numbers whose lookup failed. | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { LookupStatus } from 'bandwidth-sdk';
|
|
18
|
+
|
|
19
|
+
const instance: LookupStatus = {
|
|
20
|
+
requestId,
|
|
21
|
+
status,
|
|
22
|
+
result,
|
|
23
|
+
failedTelephoneNumbers,
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# LookupStatusEnum
|
|
2
|
+
|
|
3
|
+
The status of the request (IN_PROGRESS, COMPLETE, PARTIAL_COMPLETE, or FAILED).
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `InProgress` (value: `'IN_PROGRESS'`)
|
|
8
|
+
|
|
9
|
+
* `Complete` (value: `'COMPLETE'`)
|
|
10
|
+
|
|
11
|
+
* `PartialComplete` (value: `'PARTIAL_COMPLETE'`)
|
|
12
|
+
|
|
13
|
+
* `Failed` (value: `'FAILED'`)
|
|
14
|
+
|
|
15
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/MFAApi.md
ADDED
|
@@ -0,0 +1,188 @@
|
|
|
1
|
+
# MFAApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**generateMessagingCode**](#generatemessagingcode) | **POST** /accounts/{accountId}/code/messaging | Messaging Authentication Code|
|
|
8
|
+
|[**generateVoiceCode**](#generatevoicecode) | **POST** /accounts/{accountId}/code/voice | Voice Authentication Code|
|
|
9
|
+
|[**verifyCode**](#verifycode) | **POST** /accounts/{accountId}/code/verify | Verify Authentication Code|
|
|
10
|
+
|
|
11
|
+
# **generateMessagingCode**
|
|
12
|
+
> MessagingCodeResponse generateMessagingCode(codeRequest)
|
|
13
|
+
|
|
14
|
+
Send an MFA code via text message (SMS).
|
|
15
|
+
|
|
16
|
+
### Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import {
|
|
20
|
+
MFAApi,
|
|
21
|
+
Configuration,
|
|
22
|
+
CodeRequest
|
|
23
|
+
} from 'bandwidth-sdk';
|
|
24
|
+
|
|
25
|
+
const configuration = new Configuration();
|
|
26
|
+
const apiInstance = new MFAApi(configuration);
|
|
27
|
+
|
|
28
|
+
let accountId: string; //Your Bandwidth Account ID. (default to undefined)
|
|
29
|
+
let codeRequest: CodeRequest; //MFA code request body.
|
|
30
|
+
|
|
31
|
+
const { status, data } = await apiInstance.generateMessagingCode(
|
|
32
|
+
accountId,
|
|
33
|
+
codeRequest
|
|
34
|
+
);
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Parameters
|
|
38
|
+
|
|
39
|
+
|Name | Type | Description | Notes|
|
|
40
|
+
|------------- | ------------- | ------------- | -------------|
|
|
41
|
+
| **codeRequest** | **CodeRequest**| MFA code request body. | |
|
|
42
|
+
| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
### Return type
|
|
46
|
+
|
|
47
|
+
**MessagingCodeResponse**
|
|
48
|
+
|
|
49
|
+
### Authorization
|
|
50
|
+
|
|
51
|
+
[Basic](../README.md#Basic)
|
|
52
|
+
|
|
53
|
+
### HTTP request headers
|
|
54
|
+
|
|
55
|
+
- **Content-Type**: application/json
|
|
56
|
+
- **Accept**: application/json
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
### HTTP response details
|
|
60
|
+
| Status code | Description | Response headers |
|
|
61
|
+
|-------------|-------------|------------------|
|
|
62
|
+
|**200** | OK | - |
|
|
63
|
+
|**400** | Bad Request | - |
|
|
64
|
+
|**401** | Unauthorized | - |
|
|
65
|
+
|**403** | Forbidden | - |
|
|
66
|
+
|**500** | Internal Server Error | - |
|
|
67
|
+
|
|
68
|
+
[[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)
|
|
69
|
+
|
|
70
|
+
# **generateVoiceCode**
|
|
71
|
+
> VoiceCodeResponse generateVoiceCode(codeRequest)
|
|
72
|
+
|
|
73
|
+
Send an MFA Code via a phone call.
|
|
74
|
+
|
|
75
|
+
### Example
|
|
76
|
+
|
|
77
|
+
```typescript
|
|
78
|
+
import {
|
|
79
|
+
MFAApi,
|
|
80
|
+
Configuration,
|
|
81
|
+
CodeRequest
|
|
82
|
+
} from 'bandwidth-sdk';
|
|
83
|
+
|
|
84
|
+
const configuration = new Configuration();
|
|
85
|
+
const apiInstance = new MFAApi(configuration);
|
|
86
|
+
|
|
87
|
+
let accountId: string; //Your Bandwidth Account ID. (default to undefined)
|
|
88
|
+
let codeRequest: CodeRequest; //MFA code request body.
|
|
89
|
+
|
|
90
|
+
const { status, data } = await apiInstance.generateVoiceCode(
|
|
91
|
+
accountId,
|
|
92
|
+
codeRequest
|
|
93
|
+
);
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### Parameters
|
|
97
|
+
|
|
98
|
+
|Name | Type | Description | Notes|
|
|
99
|
+
|------------- | ------------- | ------------- | -------------|
|
|
100
|
+
| **codeRequest** | **CodeRequest**| MFA code request body. | |
|
|
101
|
+
| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
### Return type
|
|
105
|
+
|
|
106
|
+
**VoiceCodeResponse**
|
|
107
|
+
|
|
108
|
+
### Authorization
|
|
109
|
+
|
|
110
|
+
[Basic](../README.md#Basic)
|
|
111
|
+
|
|
112
|
+
### HTTP request headers
|
|
113
|
+
|
|
114
|
+
- **Content-Type**: application/json
|
|
115
|
+
- **Accept**: application/json
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
### HTTP response details
|
|
119
|
+
| Status code | Description | Response headers |
|
|
120
|
+
|-------------|-------------|------------------|
|
|
121
|
+
|**200** | OK | - |
|
|
122
|
+
|**400** | Bad Request | - |
|
|
123
|
+
|**401** | Unauthorized | - |
|
|
124
|
+
|**403** | Forbidden | - |
|
|
125
|
+
|**500** | Internal Server Error | - |
|
|
126
|
+
|
|
127
|
+
[[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)
|
|
128
|
+
|
|
129
|
+
# **verifyCode**
|
|
130
|
+
> VerifyCodeResponse verifyCode(verifyCodeRequest)
|
|
131
|
+
|
|
132
|
+
Verify a previously sent MFA code.
|
|
133
|
+
|
|
134
|
+
### Example
|
|
135
|
+
|
|
136
|
+
```typescript
|
|
137
|
+
import {
|
|
138
|
+
MFAApi,
|
|
139
|
+
Configuration,
|
|
140
|
+
VerifyCodeRequest
|
|
141
|
+
} from 'bandwidth-sdk';
|
|
142
|
+
|
|
143
|
+
const configuration = new Configuration();
|
|
144
|
+
const apiInstance = new MFAApi(configuration);
|
|
145
|
+
|
|
146
|
+
let accountId: string; //Your Bandwidth Account ID. (default to undefined)
|
|
147
|
+
let verifyCodeRequest: VerifyCodeRequest; //MFA code verify request body.
|
|
148
|
+
|
|
149
|
+
const { status, data } = await apiInstance.verifyCode(
|
|
150
|
+
accountId,
|
|
151
|
+
verifyCodeRequest
|
|
152
|
+
);
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
### Parameters
|
|
156
|
+
|
|
157
|
+
|Name | Type | Description | Notes|
|
|
158
|
+
|------------- | ------------- | ------------- | -------------|
|
|
159
|
+
| **verifyCodeRequest** | **VerifyCodeRequest**| MFA code verify request body. | |
|
|
160
|
+
| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
### Return type
|
|
164
|
+
|
|
165
|
+
**VerifyCodeResponse**
|
|
166
|
+
|
|
167
|
+
### Authorization
|
|
168
|
+
|
|
169
|
+
[Basic](../README.md#Basic)
|
|
170
|
+
|
|
171
|
+
### HTTP request headers
|
|
172
|
+
|
|
173
|
+
- **Content-Type**: application/json
|
|
174
|
+
- **Accept**: application/json
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
### HTTP response details
|
|
178
|
+
| Status code | Description | Response headers |
|
|
179
|
+
|-------------|-------------|------------------|
|
|
180
|
+
|**200** | OK | - |
|
|
181
|
+
|**400** | Bad Request | - |
|
|
182
|
+
|**401** | Unauthorized | - |
|
|
183
|
+
|**403** | Forbidden | - |
|
|
184
|
+
|**429** | Too Many Requests | - |
|
|
185
|
+
|**500** | Internal Server Error | - |
|
|
186
|
+
|
|
187
|
+
[[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)
|
|
188
|
+
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# MachineDetectionCompleteCallback
|
|
2
|
+
|
|
3
|
+
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.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**eventType** | **string** | 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. | [optional] [default to undefined]
|
|
10
|
+
**eventTime** | **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. | [optional] [default to undefined]
|
|
11
|
+
**accountId** | **string** | The user account associated with the call. | [optional] [default to undefined]
|
|
12
|
+
**applicationId** | **string** | The id of the application associated with the call. | [optional] [default to undefined]
|
|
13
|
+
**from** | **string** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] [default to undefined]
|
|
14
|
+
**to** | **string** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined]
|
|
15
|
+
**direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] [default to undefined]
|
|
16
|
+
**callId** | **string** | The call id associated with the event. | [optional] [default to undefined]
|
|
17
|
+
**callUrl** | **string** | The URL of the call associated with the event. | [optional] [default to undefined]
|
|
18
|
+
**enqueuedTime** | **string** | (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. | [optional] [default to undefined]
|
|
19
|
+
**startTime** | **string** | Time the call was started, in ISO 8601 format. | [optional] [default to undefined]
|
|
20
|
+
**answerTime** | **string** | Time the call was answered, in ISO 8601 format. | [optional] [default to undefined]
|
|
21
|
+
**tag** | **string** | (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. | [optional] [default to undefined]
|
|
22
|
+
**machineDetectionResult** | [**MachineDetectionResult**](MachineDetectionResult.md) | | [optional] [default to undefined]
|
|
23
|
+
|
|
24
|
+
## Example
|
|
25
|
+
|
|
26
|
+
```typescript
|
|
27
|
+
import { MachineDetectionCompleteCallback } from 'bandwidth-sdk';
|
|
28
|
+
|
|
29
|
+
const instance: MachineDetectionCompleteCallback = {
|
|
30
|
+
eventType,
|
|
31
|
+
eventTime,
|
|
32
|
+
accountId,
|
|
33
|
+
applicationId,
|
|
34
|
+
from,
|
|
35
|
+
to,
|
|
36
|
+
direction,
|
|
37
|
+
callId,
|
|
38
|
+
callUrl,
|
|
39
|
+
enqueuedTime,
|
|
40
|
+
startTime,
|
|
41
|
+
answerTime,
|
|
42
|
+
tag,
|
|
43
|
+
machineDetectionResult,
|
|
44
|
+
};
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# MachineDetectionConfiguration
|
|
2
|
+
|
|
3
|
+
The machine detection request used to perform <a href=\'/docs/voice/guides/machineDetection\'>machine detection</a> 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.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**mode** | [**MachineDetectionModeEnum**](MachineDetectionModeEnum.md) | | [optional] [default to undefined]
|
|
10
|
+
**detectionTimeout** | **number** | 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. | [optional] [default to 15]
|
|
11
|
+
**silenceTimeout** | **number** | If no speech is detected in this period, a callback with a \'silence\' result is sent. | [optional] [default to 10]
|
|
12
|
+
**speechThreshold** | **number** | 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\'. | [optional] [default to 10]
|
|
13
|
+
**speechEndThreshold** | **number** | Amount of silence (in seconds) before assuming the callee has finished speaking. | [optional] [default to 5]
|
|
14
|
+
**machineSpeechEndThreshold** | **number** | 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. | [optional] [default to undefined]
|
|
15
|
+
**delayResult** | **boolean** | 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. | [optional] [default to false]
|
|
16
|
+
**callbackUrl** | **string** | The URL to send the \'machineDetectionComplete\' webhook when the detection is completed. Only for \'async\' mode. | [optional] [default to undefined]
|
|
17
|
+
**callbackMethod** | [**CallbackMethodEnum**](CallbackMethodEnum.md) | | [optional] [default to undefined]
|
|
18
|
+
**username** | **string** | Basic auth username. | [optional] [default to undefined]
|
|
19
|
+
**password** | **string** | Basic auth password. | [optional] [default to undefined]
|
|
20
|
+
**fallbackUrl** | **string** | A fallback URL which, if provided, will be used to retry the machine detection complete webhook delivery in case `callbackUrl` fails to respond | [optional] [default to undefined]
|
|
21
|
+
**fallbackMethod** | [**CallbackMethodEnum**](CallbackMethodEnum.md) | | [optional] [default to undefined]
|
|
22
|
+
**fallbackUsername** | **string** | Basic auth username. | [optional] [default to undefined]
|
|
23
|
+
**fallbackPassword** | **string** | Basic auth password. | [optional] [default to undefined]
|
|
24
|
+
|
|
25
|
+
## Example
|
|
26
|
+
|
|
27
|
+
```typescript
|
|
28
|
+
import { MachineDetectionConfiguration } from 'bandwidth-sdk';
|
|
29
|
+
|
|
30
|
+
const instance: MachineDetectionConfiguration = {
|
|
31
|
+
mode,
|
|
32
|
+
detectionTimeout,
|
|
33
|
+
silenceTimeout,
|
|
34
|
+
speechThreshold,
|
|
35
|
+
speechEndThreshold,
|
|
36
|
+
machineSpeechEndThreshold,
|
|
37
|
+
delayResult,
|
|
38
|
+
callbackUrl,
|
|
39
|
+
callbackMethod,
|
|
40
|
+
username,
|
|
41
|
+
password,
|
|
42
|
+
fallbackUrl,
|
|
43
|
+
fallbackMethod,
|
|
44
|
+
fallbackUsername,
|
|
45
|
+
fallbackPassword,
|
|
46
|
+
};
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# MachineDetectionModeEnum
|
|
2
|
+
|
|
3
|
+
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.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `Sync` (value: `'sync'`)
|
|
8
|
+
|
|
9
|
+
* `Async` (value: `'async'`)
|
|
10
|
+
|
|
11
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# MachineDetectionResult
|
|
2
|
+
|
|
3
|
+
(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
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**value** | **string** | Possible values are answering-machine, human, silence, timeout, or error. | [optional] [default to undefined]
|
|
10
|
+
**duration** | **string** | The amount of time it took to determine the result. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { MachineDetectionResult } from 'bandwidth-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: MachineDetectionResult = {
|
|
18
|
+
value,
|
|
19
|
+
duration,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/Media.md
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Media
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**content** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**contentLength** | **number** | | [optional] [default to undefined]
|
|
10
|
+
**mediaName** | **string** | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { Media } from 'bandwidth-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: Media = {
|
|
18
|
+
content,
|
|
19
|
+
contentLength,
|
|
20
|
+
mediaName,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|