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,47 @@
|
|
|
1
|
+
# AnswerCallback
|
|
2
|
+
|
|
3
|
+
The Answer event is sent to the answerUrl specified in the createCall request when an outbound call is answered.
|
|
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 { AnswerCallback } from 'bandwidth-sdk';
|
|
28
|
+
|
|
29
|
+
const instance: AnswerCallback = {
|
|
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,51 @@
|
|
|
1
|
+
# BridgeCompleteCallback
|
|
2
|
+
|
|
3
|
+
If the target call leaves the <Bridge>, 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.
|
|
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
|
+
**cause** | **string** | Reason the call failed - hangup, busy, timeout, cancel, rejected, callback-error, invalid-bxml, application-error, account-limit, node-capacity-exceeded, error, or unknown. | [optional] [default to undefined]
|
|
23
|
+
**errorMessage** | **string** | Text explaining the reason that caused the call to fail in case of errors. | [optional] [default to undefined]
|
|
24
|
+
**errorId** | **string** | Bandwidth\'s internal id that references the error event. | [optional] [default to undefined]
|
|
25
|
+
|
|
26
|
+
## Example
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
import { BridgeCompleteCallback } from 'bandwidth-sdk';
|
|
30
|
+
|
|
31
|
+
const instance: BridgeCompleteCallback = {
|
|
32
|
+
eventType,
|
|
33
|
+
eventTime,
|
|
34
|
+
accountId,
|
|
35
|
+
applicationId,
|
|
36
|
+
from,
|
|
37
|
+
to,
|
|
38
|
+
direction,
|
|
39
|
+
callId,
|
|
40
|
+
callUrl,
|
|
41
|
+
enqueuedTime,
|
|
42
|
+
startTime,
|
|
43
|
+
answerTime,
|
|
44
|
+
tag,
|
|
45
|
+
cause,
|
|
46
|
+
errorMessage,
|
|
47
|
+
errorId,
|
|
48
|
+
};
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
[[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,45 @@
|
|
|
1
|
+
# BridgeTargetCompleteCallback
|
|
2
|
+
|
|
3
|
+
If the originating call leaves the <Bridge>, 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.
|
|
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
|
+
|
|
23
|
+
## Example
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
import { BridgeTargetCompleteCallback } from 'bandwidth-sdk';
|
|
27
|
+
|
|
28
|
+
const instance: BridgeTargetCompleteCallback = {
|
|
29
|
+
eventType,
|
|
30
|
+
eventTime,
|
|
31
|
+
accountId,
|
|
32
|
+
applicationId,
|
|
33
|
+
from,
|
|
34
|
+
to,
|
|
35
|
+
direction,
|
|
36
|
+
callId,
|
|
37
|
+
callUrl,
|
|
38
|
+
enqueuedTime,
|
|
39
|
+
startTime,
|
|
40
|
+
answerTime,
|
|
41
|
+
tag,
|
|
42
|
+
};
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
[[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
|
+
# CallDirectionEnum
|
|
2
|
+
|
|
3
|
+
The direction of the call.
|
|
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,56 @@
|
|
|
1
|
+
# CallRecordingMetadata
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**applicationId** | **string** | The id of the application associated with the call. | [optional] [default to undefined]
|
|
9
|
+
**accountId** | **string** | The user account associated with the call. | [optional] [default to undefined]
|
|
10
|
+
**callId** | **string** | The call id associated with the event. | [optional] [default to undefined]
|
|
11
|
+
**parentCallId** | **string** | (optional) If the event is related to the B leg of a <Transfer>, the call id of the original call leg that executed the <Transfer>. Otherwise, this field will not be present. | [optional] [default to undefined]
|
|
12
|
+
**recordingId** | **string** | The unique ID of this recording | [optional] [default to undefined]
|
|
13
|
+
**to** | **string** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined]
|
|
14
|
+
**from** | **string** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] [default to undefined]
|
|
15
|
+
**transferCallerId** | **string** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined]
|
|
16
|
+
**transferTo** | **string** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined]
|
|
17
|
+
**duration** | **string** | The duration of the recording in ISO-8601 format | [optional] [default to undefined]
|
|
18
|
+
**direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] [default to undefined]
|
|
19
|
+
**channels** | **number** | Always `1` for conference recordings; multi-channel recordings are not supported on conferences. | [optional] [default to undefined]
|
|
20
|
+
**startTime** | **string** | Time the call was started, in ISO 8601 format. | [optional] [default to undefined]
|
|
21
|
+
**endTime** | **string** | The time that the recording ended in ISO-8601 format | [optional] [default to undefined]
|
|
22
|
+
**fileFormat** | [**FileFormatEnum**](FileFormatEnum.md) | | [optional] [default to undefined]
|
|
23
|
+
**status** | **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. | [optional] [default to undefined]
|
|
24
|
+
**mediaUrl** | **string** | The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded. | [optional] [default to undefined]
|
|
25
|
+
**transcription** | [**RecordingTranscriptionMetadata**](RecordingTranscriptionMetadata.md) | | [optional] [default to undefined]
|
|
26
|
+
**recordingName** | **string** | A name to identify this recording. | [optional] [default to undefined]
|
|
27
|
+
|
|
28
|
+
## Example
|
|
29
|
+
|
|
30
|
+
```typescript
|
|
31
|
+
import { CallRecordingMetadata } from 'bandwidth-sdk';
|
|
32
|
+
|
|
33
|
+
const instance: CallRecordingMetadata = {
|
|
34
|
+
applicationId,
|
|
35
|
+
accountId,
|
|
36
|
+
callId,
|
|
37
|
+
parentCallId,
|
|
38
|
+
recordingId,
|
|
39
|
+
to,
|
|
40
|
+
from,
|
|
41
|
+
transferCallerId,
|
|
42
|
+
transferTo,
|
|
43
|
+
duration,
|
|
44
|
+
direction,
|
|
45
|
+
channels,
|
|
46
|
+
startTime,
|
|
47
|
+
endTime,
|
|
48
|
+
fileFormat,
|
|
49
|
+
status,
|
|
50
|
+
mediaUrl,
|
|
51
|
+
transcription,
|
|
52
|
+
recordingName,
|
|
53
|
+
};
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
[[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,54 @@
|
|
|
1
|
+
# CallState
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**applicationId** | **string** | The application id associated with the call. | [optional] [default to undefined]
|
|
9
|
+
**accountId** | **string** | The account id associated with the call. | [optional] [default to undefined]
|
|
10
|
+
**callId** | **string** | The programmable voice API call ID. | [optional] [default to undefined]
|
|
11
|
+
**parentCallId** | **string** | The A-leg call id, set only if this call is the B-leg of a [`<Transfer>`](/docs/voice/bxml/transfer). | [optional] [default to undefined]
|
|
12
|
+
**to** | **string** | 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. | [optional] [default to undefined]
|
|
13
|
+
**from** | **string** | The phone number that made the call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined]
|
|
14
|
+
**direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] [default to undefined]
|
|
15
|
+
**state** | **string** | 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. | [optional] [default to undefined]
|
|
16
|
+
**stirShaken** | **{ [key: string]: 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-Verification-Passed` or `TN-Verification-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). | [optional] [default to undefined]
|
|
17
|
+
**identity** | **string** | 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. | [optional] [default to undefined]
|
|
18
|
+
**enqueuedTime** | **string** | The time this call was placed in queue. | [optional] [default to undefined]
|
|
19
|
+
**startTime** | **string** | The time the call was initiated, in ISO 8601 format. `null` if the call is still in your queue. | [optional] [default to undefined]
|
|
20
|
+
**answerTime** | **string** | Populated once the call has been answered, with the time in ISO 8601 format. | [optional] [default to undefined]
|
|
21
|
+
**endTime** | **string** | Populated once the call has ended, with the time in ISO 8601 format. | [optional] [default to undefined]
|
|
22
|
+
**disconnectCause** | **string** | | Cause | Description | |:------|:------------| | `hangup`| One party hung up the call, a [`<Hangup>`](../../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. | [optional] [default to undefined]
|
|
23
|
+
**errorMessage** | **string** | Populated only if the call ended with an error, with text explaining the reason. | [optional] [default to undefined]
|
|
24
|
+
**errorId** | **string** | Populated only if the call ended with an error, with a Bandwidth internal id that references the error event. | [optional] [default to undefined]
|
|
25
|
+
**lastUpdate** | **string** | The last time the call had a state update, in ISO 8601 format. | [optional] [default to undefined]
|
|
26
|
+
|
|
27
|
+
## Example
|
|
28
|
+
|
|
29
|
+
```typescript
|
|
30
|
+
import { CallState } from 'bandwidth-sdk';
|
|
31
|
+
|
|
32
|
+
const instance: CallState = {
|
|
33
|
+
applicationId,
|
|
34
|
+
accountId,
|
|
35
|
+
callId,
|
|
36
|
+
parentCallId,
|
|
37
|
+
to,
|
|
38
|
+
from,
|
|
39
|
+
direction,
|
|
40
|
+
state,
|
|
41
|
+
stirShaken,
|
|
42
|
+
identity,
|
|
43
|
+
enqueuedTime,
|
|
44
|
+
startTime,
|
|
45
|
+
answerTime,
|
|
46
|
+
endTime,
|
|
47
|
+
disconnectCause,
|
|
48
|
+
errorMessage,
|
|
49
|
+
errorId,
|
|
50
|
+
lastUpdate,
|
|
51
|
+
};
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
[[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
|
+
# CallStateEnum
|
|
2
|
+
|
|
3
|
+
The call state. Possible values:<br>`active` to redirect the call (default)<br>`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
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `Active` (value: `'active'`)
|
|
8
|
+
|
|
9
|
+
* `Completed` (value: `'completed'`)
|
|
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,26 @@
|
|
|
1
|
+
# CallTranscription
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**detectedLanguage** | [**CallTranscriptionDetectedLanguageEnum**](CallTranscriptionDetectedLanguageEnum.md) | | [optional] [default to undefined]
|
|
9
|
+
**track** | [**CallTranscriptionTrackEnum**](CallTranscriptionTrackEnum.md) | | [optional] [default to undefined]
|
|
10
|
+
**transcript** | **string** | The transcription itself. | [optional] [default to undefined]
|
|
11
|
+
**confidence** | **number** | How confident the transcription engine was in transcribing the associated audio (from `0` to `1`). | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { CallTranscription } from 'bandwidth-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: CallTranscription = {
|
|
19
|
+
detectedLanguage,
|
|
20
|
+
track,
|
|
21
|
+
transcript,
|
|
22
|
+
confidence,
|
|
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,13 @@
|
|
|
1
|
+
# CallTranscriptionDetectedLanguageEnum
|
|
2
|
+
|
|
3
|
+
The detected language for this transcription.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `EnUs` (value: `'en-US'`)
|
|
8
|
+
|
|
9
|
+
* `EsUs` (value: `'es-US'`)
|
|
10
|
+
|
|
11
|
+
* `FrFr` (value: `'fr-FR'`)
|
|
12
|
+
|
|
13
|
+
[[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,24 @@
|
|
|
1
|
+
# CallTranscriptionMetadata
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**transcriptionId** | **string** | The programmable voice API transcription ID. | [optional] [default to undefined]
|
|
9
|
+
**transcriptionName** | **string** | The programmable voice API transcription name. This name could be provided by the user when creating the transcription. | [optional] [default to undefined]
|
|
10
|
+
**transcriptionUrl** | **string** | A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice/#operation/getCallTranscription) endpoint. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { CallTranscriptionMetadata } from 'bandwidth-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: CallTranscriptionMetadata = {
|
|
18
|
+
transcriptionId,
|
|
19
|
+
transcriptionName,
|
|
20
|
+
transcriptionUrl,
|
|
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)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# CallTranscriptionResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**accountId** | **string** | The user account associated with the call. | [optional] [default to undefined]
|
|
9
|
+
**callId** | **string** | The call id associated with the event. | [optional] [default to undefined]
|
|
10
|
+
**transcriptionId** | **string** | The programmable voice API transcription ID. | [optional] [default to undefined]
|
|
11
|
+
**tracks** | [**Array<CallTranscription>**](CallTranscription.md) | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { CallTranscriptionResponse } from 'bandwidth-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: CallTranscriptionResponse = {
|
|
19
|
+
accountId,
|
|
20
|
+
callId,
|
|
21
|
+
transcriptionId,
|
|
22
|
+
tracks,
|
|
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
|
+
# CallTranscriptionTrackEnum
|
|
2
|
+
|
|
3
|
+
Which `track` this transcription is derived from.
|
|
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,11 @@
|
|
|
1
|
+
# CallbackMethodEnum
|
|
2
|
+
|
|
3
|
+
The HTTP method to use to deliver the callback. GET or POST. Default value is POST.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `Get` (value: `'GET'`)
|
|
8
|
+
|
|
9
|
+
* `Post` (value: `'POST'`)
|
|
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,15 @@
|
|
|
1
|
+
# CallbackTypeEnum
|
|
2
|
+
|
|
3
|
+
Indicates the type of the callback: - `message-received` for inbound callbacks. - One of `message-sending`, `message-delivered`, `message-failed` for status callbacks.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `MessageReceived` (value: `'message-received'`)
|
|
8
|
+
|
|
9
|
+
* `MessageSending` (value: `'message-sending'`)
|
|
10
|
+
|
|
11
|
+
* `MessageDelivered` (value: `'message-delivered'`)
|
|
12
|
+
|
|
13
|
+
* `MessageFailed` (value: `'message-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)
|