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
package/docs/Contact.md
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Contact
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**firstName** | **string** | The first name of the business contact using the toll-free number. | [default to undefined]
|
|
9
|
+
**lastName** | **string** | The last name of the business contact using the toll-free number. | [default to undefined]
|
|
10
|
+
**email** | **string** | | [default to undefined]
|
|
11
|
+
**phoneNumber** | **string** | Contact telephone number | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { Contact } from 'bandwidth-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: Contact = {
|
|
19
|
+
firstName,
|
|
20
|
+
lastName,
|
|
21
|
+
email,
|
|
22
|
+
phoneNumber,
|
|
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,60 @@
|
|
|
1
|
+
# CreateCall
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**to** | **string** | The destination to call (must be an E.164 formatted number (e.g. `+15555551212`) or a SIP URI (e.g. `sip:user@server.example`)). | [default to undefined]
|
|
9
|
+
**from** | **string** | A Bandwidth phone number on your account the call should come from (must be in E.164 format, like `+15555551212`) even if `privacy` is set to true. | [default to undefined]
|
|
10
|
+
**privacy** | **boolean** | Hide the calling number. The `displayName` field can be used to customize the displayed name. | [optional] [default to undefined]
|
|
11
|
+
**displayName** | **string** | The caller display name to use when the call is created. May not exceed 256 characters nor contain control characters such as new lines. If `privacy` is true, only the following values are valid: `Restricted`, `Anonymous`, `Private`, or `Unavailable`. | [optional] [default to undefined]
|
|
12
|
+
**uui** | **string** | A comma-separated list of \'User-To-User\' headers to be sent in the INVITE when calling a SIP URI. Each value must end with an \'encoding\' parameter as described in <a href=\'https://tools.ietf.org/html/rfc7433\'>RFC 7433</a>. Only \'jwt\', \'base64\' and \'hex\' encodings are allowed. The entire value cannot exceed 350 characters, including parameters and separators. | [optional] [default to undefined]
|
|
13
|
+
**applicationId** | **string** | The id of the application associated with the `from` number. | [default to undefined]
|
|
14
|
+
**answerUrl** | **string** | The full URL to send the <a href=\'/docs/voice/webhooks/answer\'>Answer</a> event to when the called party answers. This endpoint should return the first <a href=\'/docs/voice/bxml\'>BXML document</a> to be executed in the call. Must use `https` if specifying `username` and `password`. | [default to undefined]
|
|
15
|
+
**answerMethod** | [**CallbackMethodEnum**](CallbackMethodEnum.md) | | [optional] [default to undefined]
|
|
16
|
+
**username** | **string** | Basic auth username. | [optional] [default to undefined]
|
|
17
|
+
**password** | **string** | Basic auth password. | [optional] [default to undefined]
|
|
18
|
+
**answerFallbackUrl** | **string** | A fallback url which, if provided, will be used to retry the `answer` webhook delivery in case `answerUrl` fails to respond Must use `https` if specifying `fallbackUsername` and `fallbackPassword`. | [optional] [default to undefined]
|
|
19
|
+
**answerFallbackMethod** | [**CallbackMethodEnum**](CallbackMethodEnum.md) | | [optional] [default to undefined]
|
|
20
|
+
**fallbackUsername** | **string** | Basic auth username. | [optional] [default to undefined]
|
|
21
|
+
**fallbackPassword** | **string** | Basic auth password. | [optional] [default to undefined]
|
|
22
|
+
**disconnectUrl** | **string** | The URL to send the <a href=\'/docs/voice/webhooks/disconnect\'>Disconnect</a> event to when the call ends. This event does not expect a BXML response. | [optional] [default to undefined]
|
|
23
|
+
**disconnectMethod** | [**CallbackMethodEnum**](CallbackMethodEnum.md) | | [optional] [default to undefined]
|
|
24
|
+
**callTimeout** | **number** | The timeout (in seconds) for the callee to answer the call after it starts ringing. If the call does not start ringing within 30s, the call will be cancelled regardless of this value. Can be any numeric value (including decimals) between 1 and 300. | [optional] [default to 30]
|
|
25
|
+
**callbackTimeout** | **number** | This is the timeout (in seconds) to use when delivering webhooks for the call. Can be any numeric value (including decimals) between 1 and 25. | [optional] [default to 15]
|
|
26
|
+
**machineDetection** | [**MachineDetectionConfiguration**](MachineDetectionConfiguration.md) | | [optional] [default to undefined]
|
|
27
|
+
**priority** | **number** | The priority of this call over other calls from your account. For example, if during a call your application needs to place a new call and bridge it with the current call, you might want to create the call with priority 1 so that it will be the next call picked off your queue, ahead of other less time sensitive calls. A lower value means higher priority, so a priority 1 call takes precedence over a priority 2 call. | [optional] [default to 5]
|
|
28
|
+
**tag** | **string** | A custom string that will be sent with all webhooks for this call unless overwritten by a future <a href=\'/docs/voice/bxml/tag\'>`<Tag>`</a> verb or `tag` attribute on another verb, or cleared. May be cleared by setting `tag=\"\"` Max length 256 characters. | [optional] [default to undefined]
|
|
29
|
+
|
|
30
|
+
## Example
|
|
31
|
+
|
|
32
|
+
```typescript
|
|
33
|
+
import { CreateCall } from 'bandwidth-sdk';
|
|
34
|
+
|
|
35
|
+
const instance: CreateCall = {
|
|
36
|
+
to,
|
|
37
|
+
from,
|
|
38
|
+
privacy,
|
|
39
|
+
displayName,
|
|
40
|
+
uui,
|
|
41
|
+
applicationId,
|
|
42
|
+
answerUrl,
|
|
43
|
+
answerMethod,
|
|
44
|
+
username,
|
|
45
|
+
password,
|
|
46
|
+
answerFallbackUrl,
|
|
47
|
+
answerFallbackMethod,
|
|
48
|
+
fallbackUsername,
|
|
49
|
+
fallbackPassword,
|
|
50
|
+
disconnectUrl,
|
|
51
|
+
disconnectMethod,
|
|
52
|
+
callTimeout,
|
|
53
|
+
callbackTimeout,
|
|
54
|
+
machineDetection,
|
|
55
|
+
priority,
|
|
56
|
+
tag,
|
|
57
|
+
};
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
[[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,60 @@
|
|
|
1
|
+
# CreateCallResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**applicationId** | **string** | The id of the application associated with the `from` number. | [default to undefined]
|
|
9
|
+
**accountId** | **string** | The bandwidth account ID associated with the call. | [default to undefined]
|
|
10
|
+
**callId** | **string** | Programmable Voice API Call ID. | [default to undefined]
|
|
11
|
+
**to** | **string** | Recipient of the outgoing call. | [default to undefined]
|
|
12
|
+
**from** | **string** | Phone number that created the outbound call. | [default to undefined]
|
|
13
|
+
**enqueuedTime** | **string** | The time at which the call was accepted into the queue. | [optional] [default to undefined]
|
|
14
|
+
**callUrl** | **string** | The URL to update this call\'s state. | [default to undefined]
|
|
15
|
+
**callTimeout** | **number** | The timeout (in seconds) for the callee to answer the call after it starts ringing. | [optional] [default to undefined]
|
|
16
|
+
**callbackTimeout** | **number** | This is the timeout (in seconds) to use when delivering webhooks for the call. | [optional] [default to undefined]
|
|
17
|
+
**tag** | **string** | Custom tag value. | [optional] [default to undefined]
|
|
18
|
+
**answerMethod** | [**CallbackMethodEnum**](CallbackMethodEnum.md) | | [default to undefined]
|
|
19
|
+
**answerUrl** | **string** | URL to deliver the `answer` event webhook. | [default to undefined]
|
|
20
|
+
**answerFallbackMethod** | [**CallbackMethodEnum**](CallbackMethodEnum.md) | | [optional] [default to undefined]
|
|
21
|
+
**answerFallbackUrl** | **string** | Fallback URL to deliver the `answer` event webhook. | [optional] [default to undefined]
|
|
22
|
+
**disconnectMethod** | [**CallbackMethodEnum**](CallbackMethodEnum.md) | | [default to undefined]
|
|
23
|
+
**disconnectUrl** | **string** | URL to deliver the `disconnect` event webhook. | [optional] [default to undefined]
|
|
24
|
+
**username** | **string** | Basic auth username. | [optional] [default to undefined]
|
|
25
|
+
**password** | **string** | Basic auth password. | [optional] [default to undefined]
|
|
26
|
+
**fallbackUsername** | **string** | Basic auth username. | [optional] [default to undefined]
|
|
27
|
+
**fallbackPassword** | **string** | Basic auth password. | [optional] [default to undefined]
|
|
28
|
+
**priority** | **number** | The priority of this call over other calls from your account. | [optional] [default to undefined]
|
|
29
|
+
|
|
30
|
+
## Example
|
|
31
|
+
|
|
32
|
+
```typescript
|
|
33
|
+
import { CreateCallResponse } from 'bandwidth-sdk';
|
|
34
|
+
|
|
35
|
+
const instance: CreateCallResponse = {
|
|
36
|
+
applicationId,
|
|
37
|
+
accountId,
|
|
38
|
+
callId,
|
|
39
|
+
to,
|
|
40
|
+
from,
|
|
41
|
+
enqueuedTime,
|
|
42
|
+
callUrl,
|
|
43
|
+
callTimeout,
|
|
44
|
+
callbackTimeout,
|
|
45
|
+
tag,
|
|
46
|
+
answerMethod,
|
|
47
|
+
answerUrl,
|
|
48
|
+
answerFallbackMethod,
|
|
49
|
+
answerFallbackUrl,
|
|
50
|
+
disconnectMethod,
|
|
51
|
+
disconnectUrl,
|
|
52
|
+
username,
|
|
53
|
+
password,
|
|
54
|
+
fallbackUsername,
|
|
55
|
+
fallbackPassword,
|
|
56
|
+
priority,
|
|
57
|
+
};
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# CreateLookupResponse
|
|
2
|
+
|
|
3
|
+
The request has been accepted for processing but not yet finished and in a terminal state (COMPLETE, PARTIAL_COMPLETE, or FAILED).
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**requestId** | **string** | The phone number lookup request ID from Bandwidth. | [optional] [default to undefined]
|
|
10
|
+
**status** | [**LookupStatusEnum**](LookupStatusEnum.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { CreateLookupResponse } from 'bandwidth-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: CreateLookupResponse = {
|
|
18
|
+
requestId,
|
|
19
|
+
status,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# CreateMessageRequestError
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**type** | **string** | | [default to undefined]
|
|
9
|
+
**description** | **string** | | [default to undefined]
|
|
10
|
+
**fieldErrors** | [**Array<FieldError>**](FieldError.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { CreateMessageRequestError } from 'bandwidth-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: CreateMessageRequestError = {
|
|
18
|
+
type,
|
|
19
|
+
description,
|
|
20
|
+
fieldErrors,
|
|
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,24 @@
|
|
|
1
|
+
# CreateMultiChannelMessageResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**links** | [**Array<Link>**](Link.md) | | [optional] [default to undefined]
|
|
9
|
+
**data** | [**MultiChannelMessageData**](MultiChannelMessageData.md) | | [optional] [default to undefined]
|
|
10
|
+
**errors** | [**Array<ErrorObject>**](ErrorObject.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { CreateMultiChannelMessageResponse } from 'bandwidth-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: CreateMultiChannelMessageResponse = {
|
|
18
|
+
links,
|
|
19
|
+
data,
|
|
20
|
+
errors,
|
|
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,22 @@
|
|
|
1
|
+
# DeferredResult
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**result** | **object** | | [optional] [default to undefined]
|
|
9
|
+
**setOrExpired** | **boolean** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { DeferredResult } from 'bandwidth-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: DeferredResult = {
|
|
17
|
+
result,
|
|
18
|
+
setOrExpired,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[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,53 @@
|
|
|
1
|
+
# DisconnectCallback
|
|
2
|
+
|
|
3
|
+
The Disconnect event is fired when a call ends, for any reason.
|
|
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
|
+
**callId** | **string** | The call id associated with the event. | [optional] [default to undefined]
|
|
16
|
+
**direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [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
|
+
**endTime** | **string** | The time that the recording ended in ISO-8601 format | [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
|
+
**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]
|
|
26
|
+
|
|
27
|
+
## Example
|
|
28
|
+
|
|
29
|
+
```typescript
|
|
30
|
+
import { DisconnectCallback } from 'bandwidth-sdk';
|
|
31
|
+
|
|
32
|
+
const instance: DisconnectCallback = {
|
|
33
|
+
eventType,
|
|
34
|
+
eventTime,
|
|
35
|
+
accountId,
|
|
36
|
+
applicationId,
|
|
37
|
+
from,
|
|
38
|
+
to,
|
|
39
|
+
callId,
|
|
40
|
+
direction,
|
|
41
|
+
callUrl,
|
|
42
|
+
enqueuedTime,
|
|
43
|
+
startTime,
|
|
44
|
+
answerTime,
|
|
45
|
+
endTime,
|
|
46
|
+
cause,
|
|
47
|
+
errorMessage,
|
|
48
|
+
errorId,
|
|
49
|
+
tag,
|
|
50
|
+
};
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
[[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,32 @@
|
|
|
1
|
+
# Diversion
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**reason** | **string** | The reason for the diversion. Common values: unknown, user-busy, no-answer, unavailable, unconditional, time-of-day, do-not-disturb, deflection, follow-me, out-of-service, away. | [optional] [default to undefined]
|
|
9
|
+
**privacy** | **string** | off or full | [optional] [default to undefined]
|
|
10
|
+
**screen** | **string** | No if the number was provided by the user, yes if the number was provided by the network | [optional] [default to undefined]
|
|
11
|
+
**counter** | **string** | The number of diversions that have occurred | [optional] [default to undefined]
|
|
12
|
+
**limit** | **string** | The maximum number of diversions allowed for this session | [optional] [default to undefined]
|
|
13
|
+
**unknown** | **string** | The normal list of values is not exhaustive. Your application must be tolerant of unlisted keys and unlisted values of those keys. | [optional] [default to undefined]
|
|
14
|
+
**origTo** | **string** | Always present. Indicates the last telephone number that the call was diverted from. | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { Diversion } from 'bandwidth-sdk';
|
|
20
|
+
|
|
21
|
+
const instance: Diversion = {
|
|
22
|
+
reason,
|
|
23
|
+
privacy,
|
|
24
|
+
screen,
|
|
25
|
+
counter,
|
|
26
|
+
limit,
|
|
27
|
+
unknown,
|
|
28
|
+
origTo,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[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,53 @@
|
|
|
1
|
+
# DtmfCallback
|
|
2
|
+
|
|
3
|
+
The DTMF event is sent for every digit detected after a <StartGather> verb is executed. You may not respond to this event with BXML.
|
|
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
|
+
**callId** | **string** | The call id associated with the event. | [optional] [default to undefined]
|
|
16
|
+
**direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] [default to undefined]
|
|
17
|
+
**digit** | **string** | The digit collected in the call. | [optional] [default to undefined]
|
|
18
|
+
**callUrl** | **string** | The URL of the call associated with the event. | [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
|
+
**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]
|
|
23
|
+
**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]
|
|
24
|
+
**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]
|
|
25
|
+
**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]
|
|
26
|
+
|
|
27
|
+
## Example
|
|
28
|
+
|
|
29
|
+
```typescript
|
|
30
|
+
import { DtmfCallback } from 'bandwidth-sdk';
|
|
31
|
+
|
|
32
|
+
const instance: DtmfCallback = {
|
|
33
|
+
eventType,
|
|
34
|
+
eventTime,
|
|
35
|
+
accountId,
|
|
36
|
+
applicationId,
|
|
37
|
+
from,
|
|
38
|
+
to,
|
|
39
|
+
callId,
|
|
40
|
+
direction,
|
|
41
|
+
digit,
|
|
42
|
+
callUrl,
|
|
43
|
+
enqueuedTime,
|
|
44
|
+
startTime,
|
|
45
|
+
answerTime,
|
|
46
|
+
parentCallId,
|
|
47
|
+
transferCallerId,
|
|
48
|
+
transferTo,
|
|
49
|
+
tag,
|
|
50
|
+
};
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/Error.md
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ModelError
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**code** | **number** | | [optional] [default to undefined]
|
|
9
|
+
**description** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**telephoneNumbers** | [**Array<TelephoneNumber>**](TelephoneNumber.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ModelError } from 'bandwidth-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: ModelError = {
|
|
18
|
+
code,
|
|
19
|
+
description,
|
|
20
|
+
telephoneNumbers,
|
|
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,22 @@
|
|
|
1
|
+
# ErrorObject
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**code** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**message** | **string** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { ErrorObject } from 'bandwidth-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: ErrorObject = {
|
|
17
|
+
code,
|
|
18
|
+
message,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[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,30 @@
|
|
|
1
|
+
# FailureWebhook
|
|
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
|
+
**errorCode** | **string** | An error code indicating what error was encountered. This code can be interpreted as an HTTP status code in regards to the error that was encountered. | [optional] [default to undefined]
|
|
11
|
+
**errorDescription** | **string** | A description of the error that was encountered. | [optional] [default to undefined]
|
|
12
|
+
**errors** | **Array<string>** | Details of the errors that were encountered when processing the request. | [optional] [default to undefined]
|
|
13
|
+
**internalTicketNumber** | **string** | Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number. | [optional] [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { FailureWebhook } from 'bandwidth-sdk';
|
|
19
|
+
|
|
20
|
+
const instance: FailureWebhook = {
|
|
21
|
+
accountId,
|
|
22
|
+
phoneNumber,
|
|
23
|
+
errorCode,
|
|
24
|
+
errorDescription,
|
|
25
|
+
errors,
|
|
26
|
+
internalTicketNumber,
|
|
27
|
+
};
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
[[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,22 @@
|
|
|
1
|
+
# FieldError
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**fieldName** | **string** | The name of the field that contains the error | [optional] [default to undefined]
|
|
9
|
+
**description** | **string** | The error associated with the field | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { FieldError } from 'bandwidth-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: FieldError = {
|
|
17
|
+
fieldName,
|
|
18
|
+
description,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[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
|
+
# FileFormatEnum
|
|
2
|
+
|
|
3
|
+
The format that the recording is stored in.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `Mp3` (value: `'mp3'`)
|
|
8
|
+
|
|
9
|
+
* `Wav` (value: `'wav'`)
|
|
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,55 @@
|
|
|
1
|
+
# GatherCallback
|
|
2
|
+
|
|
3
|
+
The gather event is sent after a <Gather> verb is executed. Its purpose is to report the gathered digits to the calling application.
|
|
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
|
+
**digits** | **string** | (optional) The digits, letters, and/or symbols entered by the user. The string is empty if a timeout occurred before any buttons were pressed. | [optional] [default to undefined]
|
|
18
|
+
**callUrl** | **string** | The URL of the call associated with the event. | [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
|
+
**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]
|
|
23
|
+
**terminatingDigit** | **string** | (optional) The digit the user pressed to end the gather. Empty string value if no terminating digit was pressed. | [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
|
+
**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]
|
|
27
|
+
|
|
28
|
+
## Example
|
|
29
|
+
|
|
30
|
+
```typescript
|
|
31
|
+
import { GatherCallback } from 'bandwidth-sdk';
|
|
32
|
+
|
|
33
|
+
const instance: GatherCallback = {
|
|
34
|
+
eventType,
|
|
35
|
+
eventTime,
|
|
36
|
+
accountId,
|
|
37
|
+
applicationId,
|
|
38
|
+
from,
|
|
39
|
+
to,
|
|
40
|
+
direction,
|
|
41
|
+
callId,
|
|
42
|
+
digits,
|
|
43
|
+
callUrl,
|
|
44
|
+
enqueuedTime,
|
|
45
|
+
startTime,
|
|
46
|
+
answerTime,
|
|
47
|
+
parentCallId,
|
|
48
|
+
terminatingDigit,
|
|
49
|
+
transferCallerId,
|
|
50
|
+
transferTo,
|
|
51
|
+
tag,
|
|
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,45 @@
|
|
|
1
|
+
# InitiateCallback
|
|
2
|
+
|
|
3
|
+
The Initiate event is fired when an inbound call is received for a Telephone Number on your Account. It is sent to the URL specified in the application associated with the location (sip-peer) that the called telephone number belongs to.
|
|
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
|
+
**startTime** | **string** | Time the call was started, in ISO 8601 format. | [optional] [default to undefined]
|
|
19
|
+
**diversion** | [**Diversion**](Diversion.md) | | [optional] [default to undefined]
|
|
20
|
+
**stirShaken** | [**StirShaken**](StirShaken.md) | | [optional] [default to undefined]
|
|
21
|
+
**uui** | **string** | The value of the `User-To-User` header to send within the initial `INVITE`. Must include the encoding parameter as specified in RFC 7433. Only `base64`, `jwt` and `hex` encoding are currently allowed. This value, including the encoding specifier, may not exceed 256 characters. | [optional] [default to undefined]
|
|
22
|
+
|
|
23
|
+
## Example
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
import { InitiateCallback } from 'bandwidth-sdk';
|
|
27
|
+
|
|
28
|
+
const instance: InitiateCallback = {
|
|
29
|
+
eventType,
|
|
30
|
+
eventTime,
|
|
31
|
+
accountId,
|
|
32
|
+
applicationId,
|
|
33
|
+
from,
|
|
34
|
+
to,
|
|
35
|
+
direction,
|
|
36
|
+
callId,
|
|
37
|
+
callUrl,
|
|
38
|
+
startTime,
|
|
39
|
+
diversion,
|
|
40
|
+
stirShaken,
|
|
41
|
+
uui,
|
|
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)
|
package/docs/Link.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Link
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**rel** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**href** | **string** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { Link } from 'bandwidth-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: Link = {
|
|
17
|
+
rel,
|
|
18
|
+
href,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|