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,202 @@
|
|
|
1
|
+
# TranscriptionsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**deleteRealTimeTranscription**](#deleterealtimetranscription) | **DELETE** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete a specific transcription|
|
|
8
|
+
|[**getRealTimeTranscription**](#getrealtimetranscription) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Retrieve a specific transcription|
|
|
9
|
+
|[**listRealTimeTranscriptions**](#listrealtimetranscriptions) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions | Enumerate transcriptions made with StartTranscription|
|
|
10
|
+
|
|
11
|
+
# **deleteRealTimeTranscription**
|
|
12
|
+
> deleteRealTimeTranscription()
|
|
13
|
+
|
|
14
|
+
Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `200` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
|
|
15
|
+
|
|
16
|
+
### Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import {
|
|
20
|
+
TranscriptionsApi,
|
|
21
|
+
Configuration
|
|
22
|
+
} from 'bandwidth-sdk';
|
|
23
|
+
|
|
24
|
+
const configuration = new Configuration();
|
|
25
|
+
const apiInstance = new TranscriptionsApi(configuration);
|
|
26
|
+
|
|
27
|
+
let accountId: string; //Your Bandwidth Account ID. (default to undefined)
|
|
28
|
+
let callId: string; //Programmable Voice API Call ID. (default to undefined)
|
|
29
|
+
let transcriptionId: string; //Programmable Voice API Transcription ID. (default to undefined)
|
|
30
|
+
|
|
31
|
+
const { status, data } = await apiInstance.deleteRealTimeTranscription(
|
|
32
|
+
accountId,
|
|
33
|
+
callId,
|
|
34
|
+
transcriptionId
|
|
35
|
+
);
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### Parameters
|
|
39
|
+
|
|
40
|
+
|Name | Type | Description | Notes|
|
|
41
|
+
|------------- | ------------- | ------------- | -------------|
|
|
42
|
+
| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
|
|
43
|
+
| **callId** | [**string**] | Programmable Voice API Call ID. | defaults to undefined|
|
|
44
|
+
| **transcriptionId** | [**string**] | Programmable Voice API Transcription ID. | defaults to undefined|
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
### Return type
|
|
48
|
+
|
|
49
|
+
void (empty response body)
|
|
50
|
+
|
|
51
|
+
### Authorization
|
|
52
|
+
|
|
53
|
+
[Basic](../README.md#Basic)
|
|
54
|
+
|
|
55
|
+
### HTTP request headers
|
|
56
|
+
|
|
57
|
+
- **Content-Type**: Not defined
|
|
58
|
+
- **Accept**: application/json
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
### HTTP response details
|
|
62
|
+
| Status code | Description | Response headers |
|
|
63
|
+
|-------------|-------------|------------------|
|
|
64
|
+
|**200** | No Content | - |
|
|
65
|
+
|**400** | Bad Request | - |
|
|
66
|
+
|**401** | Unauthorized | - |
|
|
67
|
+
|**403** | Forbidden | - |
|
|
68
|
+
|**404** | Not Found | - |
|
|
69
|
+
|**405** | Method Not Allowed | - |
|
|
70
|
+
|**415** | Unsupported Media Type | - |
|
|
71
|
+
|**429** | Too Many Requests | * Retry-After - When you should try your request again. <br> |
|
|
72
|
+
|**500** | Internal Server Error | - |
|
|
73
|
+
|
|
74
|
+
[[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)
|
|
75
|
+
|
|
76
|
+
# **getRealTimeTranscription**
|
|
77
|
+
> CallTranscriptionResponse getRealTimeTranscription()
|
|
78
|
+
|
|
79
|
+
Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
|
|
80
|
+
|
|
81
|
+
### Example
|
|
82
|
+
|
|
83
|
+
```typescript
|
|
84
|
+
import {
|
|
85
|
+
TranscriptionsApi,
|
|
86
|
+
Configuration
|
|
87
|
+
} from 'bandwidth-sdk';
|
|
88
|
+
|
|
89
|
+
const configuration = new Configuration();
|
|
90
|
+
const apiInstance = new TranscriptionsApi(configuration);
|
|
91
|
+
|
|
92
|
+
let accountId: string; //Your Bandwidth Account ID. (default to undefined)
|
|
93
|
+
let callId: string; //Programmable Voice API Call ID. (default to undefined)
|
|
94
|
+
let transcriptionId: string; //Programmable Voice API Transcription ID. (default to undefined)
|
|
95
|
+
|
|
96
|
+
const { status, data } = await apiInstance.getRealTimeTranscription(
|
|
97
|
+
accountId,
|
|
98
|
+
callId,
|
|
99
|
+
transcriptionId
|
|
100
|
+
);
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### Parameters
|
|
104
|
+
|
|
105
|
+
|Name | Type | Description | Notes|
|
|
106
|
+
|------------- | ------------- | ------------- | -------------|
|
|
107
|
+
| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
|
|
108
|
+
| **callId** | [**string**] | Programmable Voice API Call ID. | defaults to undefined|
|
|
109
|
+
| **transcriptionId** | [**string**] | Programmable Voice API Transcription ID. | defaults to undefined|
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
### Return type
|
|
113
|
+
|
|
114
|
+
**CallTranscriptionResponse**
|
|
115
|
+
|
|
116
|
+
### Authorization
|
|
117
|
+
|
|
118
|
+
[Basic](../README.md#Basic)
|
|
119
|
+
|
|
120
|
+
### HTTP request headers
|
|
121
|
+
|
|
122
|
+
- **Content-Type**: Not defined
|
|
123
|
+
- **Accept**: application/json
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
### HTTP response details
|
|
127
|
+
| Status code | Description | Response headers |
|
|
128
|
+
|-------------|-------------|------------------|
|
|
129
|
+
|**200** | OK | - |
|
|
130
|
+
|**400** | Bad Request | - |
|
|
131
|
+
|**401** | Unauthorized | - |
|
|
132
|
+
|**403** | Forbidden | - |
|
|
133
|
+
|**404** | Not Found | - |
|
|
134
|
+
|**405** | Method Not Allowed | - |
|
|
135
|
+
|**415** | Unsupported Media Type | - |
|
|
136
|
+
|**429** | Too Many Requests | * Retry-After - When you should try your request again. <br> |
|
|
137
|
+
|**500** | Internal Server Error | - |
|
|
138
|
+
|
|
139
|
+
[[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)
|
|
140
|
+
|
|
141
|
+
# **listRealTimeTranscriptions**
|
|
142
|
+
> Array<CallTranscriptionMetadata> listRealTimeTranscriptions()
|
|
143
|
+
|
|
144
|
+
Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
|
|
145
|
+
|
|
146
|
+
### Example
|
|
147
|
+
|
|
148
|
+
```typescript
|
|
149
|
+
import {
|
|
150
|
+
TranscriptionsApi,
|
|
151
|
+
Configuration
|
|
152
|
+
} from 'bandwidth-sdk';
|
|
153
|
+
|
|
154
|
+
const configuration = new Configuration();
|
|
155
|
+
const apiInstance = new TranscriptionsApi(configuration);
|
|
156
|
+
|
|
157
|
+
let accountId: string; //Your Bandwidth Account ID. (default to undefined)
|
|
158
|
+
let callId: string; //Programmable Voice API Call ID. (default to undefined)
|
|
159
|
+
|
|
160
|
+
const { status, data } = await apiInstance.listRealTimeTranscriptions(
|
|
161
|
+
accountId,
|
|
162
|
+
callId
|
|
163
|
+
);
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
### Parameters
|
|
167
|
+
|
|
168
|
+
|Name | Type | Description | Notes|
|
|
169
|
+
|------------- | ------------- | ------------- | -------------|
|
|
170
|
+
| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
|
|
171
|
+
| **callId** | [**string**] | Programmable Voice API Call ID. | defaults to undefined|
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
### Return type
|
|
175
|
+
|
|
176
|
+
**Array<CallTranscriptionMetadata>**
|
|
177
|
+
|
|
178
|
+
### Authorization
|
|
179
|
+
|
|
180
|
+
[Basic](../README.md#Basic)
|
|
181
|
+
|
|
182
|
+
### HTTP request headers
|
|
183
|
+
|
|
184
|
+
- **Content-Type**: Not defined
|
|
185
|
+
- **Accept**: application/json
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
### HTTP response details
|
|
189
|
+
| Status code | Description | Response headers |
|
|
190
|
+
|-------------|-------------|------------------|
|
|
191
|
+
|**200** | OK | - |
|
|
192
|
+
|**400** | Bad Request | - |
|
|
193
|
+
|**401** | Unauthorized | - |
|
|
194
|
+
|**403** | Forbidden | - |
|
|
195
|
+
|**404** | Not Found | - |
|
|
196
|
+
|**405** | Method Not Allowed | - |
|
|
197
|
+
|**415** | Unsupported Media Type | - |
|
|
198
|
+
|**429** | Too Many Requests | * Retry-After - When you should try your request again. <br> |
|
|
199
|
+
|**500** | Internal Server Error | - |
|
|
200
|
+
|
|
201
|
+
[[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)
|
|
202
|
+
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# TransferAnswerCallback
|
|
2
|
+
|
|
3
|
+
When processing a <Transfer> verb, this event is sent when a called party (B-leg) answers. The event is sent to the endpoint specified in the transferAnswerUrl attribute of the <PhoneNumber> tag that answered. BXML returned by this callback will be executed for the called party only. After all BXML has been executed, the called party will be bridged to the original call. Most BXML verbs are allowed in response to a transferAnswer event, but some are not allowed.
|
|
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
|
+
**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]
|
|
23
|
+
**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]
|
|
24
|
+
|
|
25
|
+
## Example
|
|
26
|
+
|
|
27
|
+
```typescript
|
|
28
|
+
import { TransferAnswerCallback } from 'bandwidth-sdk';
|
|
29
|
+
|
|
30
|
+
const instance: TransferAnswerCallback = {
|
|
31
|
+
eventType,
|
|
32
|
+
eventTime,
|
|
33
|
+
accountId,
|
|
34
|
+
applicationId,
|
|
35
|
+
from,
|
|
36
|
+
to,
|
|
37
|
+
direction,
|
|
38
|
+
callId,
|
|
39
|
+
callUrl,
|
|
40
|
+
enqueuedTime,
|
|
41
|
+
startTime,
|
|
42
|
+
answerTime,
|
|
43
|
+
tag,
|
|
44
|
+
transferCallerId,
|
|
45
|
+
transferTo,
|
|
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,55 @@
|
|
|
1
|
+
# TransferCompleteCallback
|
|
2
|
+
|
|
3
|
+
This event is sent to the transferCompleteUrl of the A-leg\'s <Transfer> verb when the transferred call (B-leg) completes. In a simultaneous ringing scenario, only one B-leg succeeds and this event corresponds to that successful leg. If none of the calls were answered, the transferComplete event corresponds to one of the legs.
|
|
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
|
+
**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]
|
|
23
|
+
**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]
|
|
24
|
+
**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]
|
|
25
|
+
**errorMessage** | **string** | Text explaining the reason that caused the call to fail in case of errors. | [optional] [default to undefined]
|
|
26
|
+
**errorId** | **string** | Bandwidth\'s internal id that references the error event. | [optional] [default to undefined]
|
|
27
|
+
|
|
28
|
+
## Example
|
|
29
|
+
|
|
30
|
+
```typescript
|
|
31
|
+
import { TransferCompleteCallback } from 'bandwidth-sdk';
|
|
32
|
+
|
|
33
|
+
const instance: TransferCompleteCallback = {
|
|
34
|
+
eventType,
|
|
35
|
+
eventTime,
|
|
36
|
+
accountId,
|
|
37
|
+
applicationId,
|
|
38
|
+
from,
|
|
39
|
+
to,
|
|
40
|
+
direction,
|
|
41
|
+
callId,
|
|
42
|
+
callUrl,
|
|
43
|
+
enqueuedTime,
|
|
44
|
+
startTime,
|
|
45
|
+
answerTime,
|
|
46
|
+
tag,
|
|
47
|
+
transferCallerId,
|
|
48
|
+
transferTo,
|
|
49
|
+
cause,
|
|
50
|
+
errorMessage,
|
|
51
|
+
errorId,
|
|
52
|
+
};
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
[[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,59 @@
|
|
|
1
|
+
# TransferDisconnectCallback
|
|
2
|
+
|
|
3
|
+
This event is sent to the transferDisconnectUrl of each <PhoneNumber> tag when its respective call leg ends for any reason. The event is sent in the normal case, when the transferred leg is answered and later hung up, but is also sent if the new leg was never answered in the first place, if it was rejected, and if the original call leg hung up before the transferred leg.
|
|
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
|
+
**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]
|
|
19
|
+
**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]
|
|
20
|
+
**startTime** | **string** | Time the call was started, in ISO 8601 format. | [optional] [default to undefined]
|
|
21
|
+
**answerTime** | **string** | Time the call was answered, in ISO 8601 format. | [optional] [default to undefined]
|
|
22
|
+
**endTime** | **string** | The time that the recording ended in ISO-8601 format | [optional] [default to undefined]
|
|
23
|
+
**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]
|
|
24
|
+
**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]
|
|
25
|
+
**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]
|
|
26
|
+
**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]
|
|
27
|
+
**errorMessage** | **string** | Text explaining the reason that caused the call to fail in case of errors. | [optional] [default to undefined]
|
|
28
|
+
**errorId** | **string** | Bandwidth\'s internal id that references the error event. | [optional] [default to undefined]
|
|
29
|
+
|
|
30
|
+
## Example
|
|
31
|
+
|
|
32
|
+
```typescript
|
|
33
|
+
import { TransferDisconnectCallback } from 'bandwidth-sdk';
|
|
34
|
+
|
|
35
|
+
const instance: TransferDisconnectCallback = {
|
|
36
|
+
eventType,
|
|
37
|
+
eventTime,
|
|
38
|
+
accountId,
|
|
39
|
+
applicationId,
|
|
40
|
+
from,
|
|
41
|
+
to,
|
|
42
|
+
direction,
|
|
43
|
+
callId,
|
|
44
|
+
callUrl,
|
|
45
|
+
parentCallId,
|
|
46
|
+
enqueuedTime,
|
|
47
|
+
startTime,
|
|
48
|
+
answerTime,
|
|
49
|
+
endTime,
|
|
50
|
+
tag,
|
|
51
|
+
transferCallerId,
|
|
52
|
+
transferTo,
|
|
53
|
+
cause,
|
|
54
|
+
errorMessage,
|
|
55
|
+
errorId,
|
|
56
|
+
};
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
[[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,38 @@
|
|
|
1
|
+
# UpdateCall
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**state** | [**CallStateEnum**](CallStateEnum.md) | | [optional] [default to undefined]
|
|
9
|
+
**redirectUrl** | **string** | The URL to send the [Redirect](/docs/voice/bxml/redirect) event to which will provide new BXML. Required if `state` is `active`. Not allowed if `state` is `completed`. | [optional] [default to undefined]
|
|
10
|
+
**redirectMethod** | [**RedirectMethodEnum**](RedirectMethodEnum.md) | | [optional] [default to undefined]
|
|
11
|
+
**username** | **string** | Basic auth username. | [optional] [default to undefined]
|
|
12
|
+
**password** | **string** | Basic auth password. | [optional] [default to undefined]
|
|
13
|
+
**redirectFallbackUrl** | **string** | A fallback url which, if provided, will be used to retry the redirect callback delivery in case `redirectUrl` fails to respond. | [optional] [default to undefined]
|
|
14
|
+
**redirectFallbackMethod** | [**RedirectMethodEnum**](RedirectMethodEnum.md) | | [optional] [default to undefined]
|
|
15
|
+
**fallbackUsername** | **string** | Basic auth username. | [optional] [default to undefined]
|
|
16
|
+
**fallbackPassword** | **string** | Basic auth password. | [optional] [default to undefined]
|
|
17
|
+
**tag** | **string** | A custom string that will be sent with this and all future callbacks unless overwritten by a future `tag` attribute or [`<Tag>`](/docs/voice/bxml/tag) verb, or cleared. May be cleared by setting `tag=\"\"`. Max length 256 characters. Not allowed if `state` is `completed`. | [optional] [default to undefined]
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { UpdateCall } from 'bandwidth-sdk';
|
|
23
|
+
|
|
24
|
+
const instance: UpdateCall = {
|
|
25
|
+
state,
|
|
26
|
+
redirectUrl,
|
|
27
|
+
redirectMethod,
|
|
28
|
+
username,
|
|
29
|
+
password,
|
|
30
|
+
redirectFallbackUrl,
|
|
31
|
+
redirectFallbackMethod,
|
|
32
|
+
fallbackUsername,
|
|
33
|
+
fallbackPassword,
|
|
34
|
+
tag,
|
|
35
|
+
};
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
[[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,20 @@
|
|
|
1
|
+
# UpdateCallRecording
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**state** | [**RecordingStateEnum**](RecordingStateEnum.md) | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { UpdateCallRecording } from 'bandwidth-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: UpdateCallRecording = {
|
|
16
|
+
state,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[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,36 @@
|
|
|
1
|
+
# UpdateConference
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | [**ConferenceStateEnum**](ConferenceStateEnum.md) | | [optional] [default to undefined]
|
|
9
|
+
**redirectUrl** | **string** | The URL to send the [conferenceRedirect](/docs/voice/webhooks/conferenceRedirect) event which will provide new BXML. Not allowed if `state` is `completed`, but required if `state` is `active`. | [optional] [default to undefined]
|
|
10
|
+
**redirectMethod** | [**RedirectMethodEnum**](RedirectMethodEnum.md) | | [optional] [default to undefined]
|
|
11
|
+
**username** | **string** | Basic auth username. | [optional] [default to undefined]
|
|
12
|
+
**password** | **string** | Basic auth password. | [optional] [default to undefined]
|
|
13
|
+
**redirectFallbackUrl** | **string** | A fallback url which, if provided, will be used to retry the `conferenceRedirect` webhook delivery in case `redirectUrl` fails to respond. Not allowed if `state` is `completed`. | [optional] [default to undefined]
|
|
14
|
+
**redirectFallbackMethod** | [**RedirectMethodEnum**](RedirectMethodEnum.md) | | [optional] [default to undefined]
|
|
15
|
+
**fallbackUsername** | **string** | Basic auth username. | [optional] [default to undefined]
|
|
16
|
+
**fallbackPassword** | **string** | Basic auth password. | [optional] [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { UpdateConference } from 'bandwidth-sdk';
|
|
22
|
+
|
|
23
|
+
const instance: UpdateConference = {
|
|
24
|
+
status,
|
|
25
|
+
redirectUrl,
|
|
26
|
+
redirectMethod,
|
|
27
|
+
username,
|
|
28
|
+
password,
|
|
29
|
+
redirectFallbackUrl,
|
|
30
|
+
redirectFallbackMethod,
|
|
31
|
+
fallbackUsername,
|
|
32
|
+
fallbackPassword,
|
|
33
|
+
};
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[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
|
+
# UpdateConferenceMember
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**mute** | **boolean** | Whether or not this member is currently muted. Members who are muted are still able to hear other participants. Updates this member\'s mute status. Has no effect if omitted. | [optional] [default to undefined]
|
|
9
|
+
**hold** | **boolean** | Whether or not this member is currently on hold. Members who are on hold are not able to hear or speak in the conference. Updates this member\'s hold status. Has no effect if omitted. | [optional] [default to undefined]
|
|
10
|
+
**callIdsToCoach** | **Array<string>** | If this member had a value set for `callIdsToCoach` in its [Conference](/docs/voice/bxml/conference) verb or this list was added with a previous PUT request to modify the member, this is that list of calls. Modifies the calls that this member is coaching. Has no effect if omitted. See the documentation for the [Conference](/docs/voice/bxml/conference) verb for more details about coaching. Note that this will not add the matching calls to the conference; each call must individually execute a Conference verb to join. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { UpdateConferenceMember } from 'bandwidth-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: UpdateConferenceMember = {
|
|
18
|
+
mute,
|
|
19
|
+
hold,
|
|
20
|
+
callIdsToCoach,
|
|
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,38 @@
|
|
|
1
|
+
# VerificationDenialWebhook
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**accountId** | **string** | User\'s account ID. | [optional] [default to undefined]
|
|
9
|
+
**additionalDenialReasons** | [**Array<AdditionalDenialReason>**](AdditionalDenialReason.md) | An optional list of denial reasons in addition to declineReasonDescription when multiple reasons apply. | [optional] [default to undefined]
|
|
10
|
+
**declineReasonDescription** | **string** | Explanation for why a verification request was declined. | [optional] [default to undefined]
|
|
11
|
+
**denialStatusCode** | **number** | Reason code for denial. | [optional] [default to undefined]
|
|
12
|
+
**internalTicketNumber** | **string** | Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number. | [optional] [default to undefined]
|
|
13
|
+
**phoneNumber** | **string** | Toll-free telephone number in E.164 format. | [optional] [default to undefined]
|
|
14
|
+
**resubmitAllowed** | **boolean** | Whether a Toll-Free Verification request qualifies for resubmission via PUT. | [optional] [default to undefined]
|
|
15
|
+
**status** | **string** | | [optional] [default to 'UNVERIFIED']
|
|
16
|
+
**blocked** | **boolean** | Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional] [default to undefined]
|
|
17
|
+
**blockedReason** | **string** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional] [default to undefined]
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { VerificationDenialWebhook } from 'bandwidth-sdk';
|
|
23
|
+
|
|
24
|
+
const instance: VerificationDenialWebhook = {
|
|
25
|
+
accountId,
|
|
26
|
+
additionalDenialReasons,
|
|
27
|
+
declineReasonDescription,
|
|
28
|
+
denialStatusCode,
|
|
29
|
+
internalTicketNumber,
|
|
30
|
+
phoneNumber,
|
|
31
|
+
resubmitAllowed,
|
|
32
|
+
status,
|
|
33
|
+
blocked,
|
|
34
|
+
blockedReason,
|
|
35
|
+
};
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
[[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,44 @@
|
|
|
1
|
+
# VerificationRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**businessAddress** | [**Address**](Address.md) | | [default to undefined]
|
|
9
|
+
**businessContact** | [**Contact**](Contact.md) | | [default to undefined]
|
|
10
|
+
**messageVolume** | **number** | Estimated monthly volume of messages from the toll-free number. | [default to undefined]
|
|
11
|
+
**phoneNumbers** | **Array<string>** | | [default to undefined]
|
|
12
|
+
**useCase** | **string** | The category of the use case. | [default to undefined]
|
|
13
|
+
**useCaseSummary** | **string** | A general idea of the use case and customer. | [default to undefined]
|
|
14
|
+
**productionMessageContent** | **string** | Example of message content. | [default to undefined]
|
|
15
|
+
**optInWorkflow** | [**OptInWorkflow**](OptInWorkflow.md) | | [default to undefined]
|
|
16
|
+
**additionalInformation** | **string** | Any additional information. | [optional] [default to undefined]
|
|
17
|
+
**isvReseller** | **string** | ISV name. | [optional] [default to undefined]
|
|
18
|
+
**privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) | [optional] [default to undefined]
|
|
19
|
+
**termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025) | [optional] [default to undefined]
|
|
20
|
+
**businessDBA** | **string** | The company \'Doing Business As\'. (Not Available Until 5/28/2025) | [optional] [default to undefined]
|
|
21
|
+
|
|
22
|
+
## Example
|
|
23
|
+
|
|
24
|
+
```typescript
|
|
25
|
+
import { VerificationRequest } from 'bandwidth-sdk';
|
|
26
|
+
|
|
27
|
+
const instance: VerificationRequest = {
|
|
28
|
+
businessAddress,
|
|
29
|
+
businessContact,
|
|
30
|
+
messageVolume,
|
|
31
|
+
phoneNumbers,
|
|
32
|
+
useCase,
|
|
33
|
+
useCaseSummary,
|
|
34
|
+
productionMessageContent,
|
|
35
|
+
optInWorkflow,
|
|
36
|
+
additionalInformation,
|
|
37
|
+
isvReseller,
|
|
38
|
+
privacyPolicyUrl,
|
|
39
|
+
termsAndConditionsUrl,
|
|
40
|
+
businessDBA,
|
|
41
|
+
};
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
[[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,42 @@
|
|
|
1
|
+
# VerificationUpdateRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**businessAddress** | [**Address**](Address.md) | | [default to undefined]
|
|
9
|
+
**businessContact** | [**Contact**](Contact.md) | | [default to undefined]
|
|
10
|
+
**messageVolume** | **number** | Estimated monthly volume of messages from the toll-free number. | [default to undefined]
|
|
11
|
+
**useCase** | **string** | The category of the use case. | [default to undefined]
|
|
12
|
+
**useCaseSummary** | **string** | A general idea of the use case and customer. | [default to undefined]
|
|
13
|
+
**productionMessageContent** | **string** | Example of message content. | [default to undefined]
|
|
14
|
+
**optInWorkflow** | [**OptInWorkflow**](OptInWorkflow.md) | | [default to undefined]
|
|
15
|
+
**additionalInformation** | **string** | Any additional information. | [optional] [default to undefined]
|
|
16
|
+
**isvReseller** | **string** | ISV name. | [optional] [default to undefined]
|
|
17
|
+
**privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) | [optional] [default to undefined]
|
|
18
|
+
**termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025) | [optional] [default to undefined]
|
|
19
|
+
**businessDBA** | **string** | The company \'Doing Business As\'. (Not Available Until 5/28/2025) | [optional] [default to undefined]
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
import { VerificationUpdateRequest } from 'bandwidth-sdk';
|
|
25
|
+
|
|
26
|
+
const instance: VerificationUpdateRequest = {
|
|
27
|
+
businessAddress,
|
|
28
|
+
businessContact,
|
|
29
|
+
messageVolume,
|
|
30
|
+
useCase,
|
|
31
|
+
useCaseSummary,
|
|
32
|
+
productionMessageContent,
|
|
33
|
+
optInWorkflow,
|
|
34
|
+
additionalInformation,
|
|
35
|
+
isvReseller,
|
|
36
|
+
privacyPolicyUrl,
|
|
37
|
+
termsAndConditionsUrl,
|
|
38
|
+
businessDBA,
|
|
39
|
+
};
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
[[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
|
+
# VerificationWebhook
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**accountId** | **string** | User\'s account ID. | [optional] [default to undefined]
|
|
9
|
+
**phoneNumber** | **string** | Toll-free telephone number in E.164 format. | [optional] [default to undefined]
|
|
10
|
+
**status** | [**TfvCallbackStatusEnum**](TfvCallbackStatusEnum.md) | | [optional] [default to undefined]
|
|
11
|
+
**internalTicketNumber** | **string** | Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number. | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { VerificationWebhook } from 'bandwidth-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: VerificationWebhook = {
|
|
19
|
+
accountId,
|
|
20
|
+
phoneNumber,
|
|
21
|
+
status,
|
|
22
|
+
internalTicketNumber,
|
|
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)
|