bandwidth-sdk 4.1.3 → 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 +640 -58
- 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,42 @@
|
|
|
1
|
+
# ConferenceRecordingMetadata
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**accountId** | **string** | The user account associated with the call. | [optional] [default to undefined]
|
|
9
|
+
**conferenceId** | **string** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] [default to undefined]
|
|
10
|
+
**name** | **string** | The user-specified name of the conference that was recorded | [optional] [default to undefined]
|
|
11
|
+
**recordingId** | **string** | The unique ID of this recording | [optional] [default to undefined]
|
|
12
|
+
**duration** | **string** | The duration of the recording in ISO-8601 format | [optional] [default to undefined]
|
|
13
|
+
**channels** | **number** | Always `1` for conference recordings; multi-channel recordings are not supported on conferences. | [optional] [default to undefined]
|
|
14
|
+
**startTime** | **string** | Time the call was started, in ISO 8601 format. | [optional] [default to undefined]
|
|
15
|
+
**endTime** | **string** | The time that the recording ended in ISO-8601 format | [optional] [default to undefined]
|
|
16
|
+
**fileFormat** | [**FileFormatEnum**](FileFormatEnum.md) | | [optional] [default to undefined]
|
|
17
|
+
**status** | **string** | The current status of the process. For recording, current possible values are \'processing\', \'partial\', \'complete\', \'deleted\', and \'error\'. For transcriptions, current possible values are \'none\', \'processing\', \'available\', \'error\', \'timeout\', \'file-size-too-big\', and \'file-size-too-small\'. Additional states may be added in the future, so your application must be tolerant of unknown values. | [optional] [default to undefined]
|
|
18
|
+
**mediaUrl** | **string** | The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded. | [optional] [default to undefined]
|
|
19
|
+
**recordingName** | **string** | A name to identify this recording. | [optional] [default to undefined]
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
import { ConferenceRecordingMetadata } from 'bandwidth-sdk';
|
|
25
|
+
|
|
26
|
+
const instance: ConferenceRecordingMetadata = {
|
|
27
|
+
accountId,
|
|
28
|
+
conferenceId,
|
|
29
|
+
name,
|
|
30
|
+
recordingId,
|
|
31
|
+
duration,
|
|
32
|
+
channels,
|
|
33
|
+
startTime,
|
|
34
|
+
endTime,
|
|
35
|
+
fileFormat,
|
|
36
|
+
status,
|
|
37
|
+
mediaUrl,
|
|
38
|
+
recordingName,
|
|
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,29 @@
|
|
|
1
|
+
# ConferenceRedirectCallback
|
|
2
|
+
|
|
3
|
+
The Conference Redirect event is fired whenever an existing conference is modified via a POST request made to the /conferences/{conferenceId} endpoint. The response may be either empty or a BXML document. Only the following verbs are valid for conferences: PlayAudio, SpeakSentence, StartRecording, StopRecording, PauseRecording, ResumeRecording. Audio verbs will be heard by all members of the conference. Recordings capture audio from all members who are not muted or on hold, as well as any audio verbs that are played into the conference.
|
|
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
|
+
**conferenceId** | **string** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] [default to undefined]
|
|
12
|
+
**name** | **string** | The user-specified name of the conference that was recorded | [optional] [default to undefined]
|
|
13
|
+
**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]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { ConferenceRedirectCallback } from 'bandwidth-sdk';
|
|
19
|
+
|
|
20
|
+
const instance: ConferenceRedirectCallback = {
|
|
21
|
+
eventType,
|
|
22
|
+
eventTime,
|
|
23
|
+
conferenceId,
|
|
24
|
+
name,
|
|
25
|
+
tag,
|
|
26
|
+
};
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
[[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
|
+
# ConferenceStateEnum
|
|
2
|
+
|
|
3
|
+
Setting the conference state to `completed` ends the conference and ejects all members.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `Active` (value: `'active'`)
|
|
8
|
+
|
|
9
|
+
* `Completed` (value: `'completed'`)
|
|
10
|
+
|
|
11
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,609 @@
|
|
|
1
|
+
# ConferencesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**downloadConferenceRecording**](#downloadconferencerecording) | **GET** /accounts/{accountId}/conferences/{conferenceId}/recordings/{recordingId}/media | Download Conference Recording|
|
|
8
|
+
|[**getConference**](#getconference) | **GET** /accounts/{accountId}/conferences/{conferenceId} | Get Conference Information|
|
|
9
|
+
|[**getConferenceMember**](#getconferencemember) | **GET** /accounts/{accountId}/conferences/{conferenceId}/members/{memberId} | Get Conference Member|
|
|
10
|
+
|[**getConferenceRecording**](#getconferencerecording) | **GET** /accounts/{accountId}/conferences/{conferenceId}/recordings/{recordingId} | Get Conference Recording Information|
|
|
11
|
+
|[**listConferenceRecordings**](#listconferencerecordings) | **GET** /accounts/{accountId}/conferences/{conferenceId}/recordings | Get Conference Recordings|
|
|
12
|
+
|[**listConferences**](#listconferences) | **GET** /accounts/{accountId}/conferences | Get Conferences|
|
|
13
|
+
|[**updateConference**](#updateconference) | **POST** /accounts/{accountId}/conferences/{conferenceId} | Update Conference|
|
|
14
|
+
|[**updateConferenceBxml**](#updateconferencebxml) | **PUT** /accounts/{accountId}/conferences/{conferenceId}/bxml | Update Conference BXML|
|
|
15
|
+
|[**updateConferenceMember**](#updateconferencemember) | **PUT** /accounts/{accountId}/conferences/{conferenceId}/members/{memberId} | Update Conference Member|
|
|
16
|
+
|
|
17
|
+
# **downloadConferenceRecording**
|
|
18
|
+
> File downloadConferenceRecording()
|
|
19
|
+
|
|
20
|
+
Downloads the specified recording file.
|
|
21
|
+
|
|
22
|
+
### Example
|
|
23
|
+
|
|
24
|
+
```typescript
|
|
25
|
+
import {
|
|
26
|
+
ConferencesApi,
|
|
27
|
+
Configuration
|
|
28
|
+
} from 'bandwidth-sdk';
|
|
29
|
+
|
|
30
|
+
const configuration = new Configuration();
|
|
31
|
+
const apiInstance = new ConferencesApi(configuration);
|
|
32
|
+
|
|
33
|
+
let accountId: string; //Your Bandwidth Account ID. (default to undefined)
|
|
34
|
+
let conferenceId: string; //Programmable Voice API Conference ID. (default to undefined)
|
|
35
|
+
let recordingId: string; //Programmable Voice API Recording ID. (default to undefined)
|
|
36
|
+
|
|
37
|
+
const { status, data } = await apiInstance.downloadConferenceRecording(
|
|
38
|
+
accountId,
|
|
39
|
+
conferenceId,
|
|
40
|
+
recordingId
|
|
41
|
+
);
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### Parameters
|
|
45
|
+
|
|
46
|
+
|Name | Type | Description | Notes|
|
|
47
|
+
|------------- | ------------- | ------------- | -------------|
|
|
48
|
+
| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
|
|
49
|
+
| **conferenceId** | [**string**] | Programmable Voice API Conference ID. | defaults to undefined|
|
|
50
|
+
| **recordingId** | [**string**] | Programmable Voice API Recording ID. | defaults to undefined|
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
### Return type
|
|
54
|
+
|
|
55
|
+
**File**
|
|
56
|
+
|
|
57
|
+
### Authorization
|
|
58
|
+
|
|
59
|
+
[Basic](../README.md#Basic)
|
|
60
|
+
|
|
61
|
+
### HTTP request headers
|
|
62
|
+
|
|
63
|
+
- **Content-Type**: Not defined
|
|
64
|
+
- **Accept**: audio/vnd.wave, audio/mpeg, application/json
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
### HTTP response details
|
|
68
|
+
| Status code | Description | Response headers |
|
|
69
|
+
|-------------|-------------|------------------|
|
|
70
|
+
|**200** | OK | - |
|
|
71
|
+
|**400** | Bad Request | - |
|
|
72
|
+
|**401** | Unauthorized | - |
|
|
73
|
+
|**403** | Forbidden | - |
|
|
74
|
+
|**404** | Not Found | - |
|
|
75
|
+
|**405** | Method Not Allowed | - |
|
|
76
|
+
|**415** | Unsupported Media Type | - |
|
|
77
|
+
|**429** | Too Many Requests | * Retry-After - When you should try your request again. <br> |
|
|
78
|
+
|**500** | Internal Server Error | - |
|
|
79
|
+
|
|
80
|
+
[[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)
|
|
81
|
+
|
|
82
|
+
# **getConference**
|
|
83
|
+
> Conference getConference()
|
|
84
|
+
|
|
85
|
+
Returns information about the specified conference.
|
|
86
|
+
|
|
87
|
+
### Example
|
|
88
|
+
|
|
89
|
+
```typescript
|
|
90
|
+
import {
|
|
91
|
+
ConferencesApi,
|
|
92
|
+
Configuration
|
|
93
|
+
} from 'bandwidth-sdk';
|
|
94
|
+
|
|
95
|
+
const configuration = new Configuration();
|
|
96
|
+
const apiInstance = new ConferencesApi(configuration);
|
|
97
|
+
|
|
98
|
+
let accountId: string; //Your Bandwidth Account ID. (default to undefined)
|
|
99
|
+
let conferenceId: string; //Programmable Voice API Conference ID. (default to undefined)
|
|
100
|
+
|
|
101
|
+
const { status, data } = await apiInstance.getConference(
|
|
102
|
+
accountId,
|
|
103
|
+
conferenceId
|
|
104
|
+
);
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
### Parameters
|
|
108
|
+
|
|
109
|
+
|Name | Type | Description | Notes|
|
|
110
|
+
|------------- | ------------- | ------------- | -------------|
|
|
111
|
+
| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
|
|
112
|
+
| **conferenceId** | [**string**] | Programmable Voice API Conference ID. | defaults to undefined|
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
### Return type
|
|
116
|
+
|
|
117
|
+
**Conference**
|
|
118
|
+
|
|
119
|
+
### Authorization
|
|
120
|
+
|
|
121
|
+
[Basic](../README.md#Basic)
|
|
122
|
+
|
|
123
|
+
### HTTP request headers
|
|
124
|
+
|
|
125
|
+
- **Content-Type**: Not defined
|
|
126
|
+
- **Accept**: application/json
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
### HTTP response details
|
|
130
|
+
| Status code | Description | Response headers |
|
|
131
|
+
|-------------|-------------|------------------|
|
|
132
|
+
|**200** | OK | - |
|
|
133
|
+
|**400** | Bad Request | - |
|
|
134
|
+
|**401** | Unauthorized | - |
|
|
135
|
+
|**403** | Forbidden | - |
|
|
136
|
+
|**404** | Not Found | - |
|
|
137
|
+
|**405** | Method Not Allowed | - |
|
|
138
|
+
|**415** | Unsupported Media Type | - |
|
|
139
|
+
|**429** | Too Many Requests | * Retry-After - When you should try your request again. <br> |
|
|
140
|
+
|**500** | Internal Server Error | - |
|
|
141
|
+
|
|
142
|
+
[[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)
|
|
143
|
+
|
|
144
|
+
# **getConferenceMember**
|
|
145
|
+
> ConferenceMember getConferenceMember()
|
|
146
|
+
|
|
147
|
+
Returns information about the specified conference member.
|
|
148
|
+
|
|
149
|
+
### Example
|
|
150
|
+
|
|
151
|
+
```typescript
|
|
152
|
+
import {
|
|
153
|
+
ConferencesApi,
|
|
154
|
+
Configuration
|
|
155
|
+
} from 'bandwidth-sdk';
|
|
156
|
+
|
|
157
|
+
const configuration = new Configuration();
|
|
158
|
+
const apiInstance = new ConferencesApi(configuration);
|
|
159
|
+
|
|
160
|
+
let accountId: string; //Your Bandwidth Account ID. (default to undefined)
|
|
161
|
+
let conferenceId: string; //Programmable Voice API Conference ID. (default to undefined)
|
|
162
|
+
let memberId: string; //Programmable Voice API Conference Member ID. (default to undefined)
|
|
163
|
+
|
|
164
|
+
const { status, data } = await apiInstance.getConferenceMember(
|
|
165
|
+
accountId,
|
|
166
|
+
conferenceId,
|
|
167
|
+
memberId
|
|
168
|
+
);
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
### Parameters
|
|
172
|
+
|
|
173
|
+
|Name | Type | Description | Notes|
|
|
174
|
+
|------------- | ------------- | ------------- | -------------|
|
|
175
|
+
| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
|
|
176
|
+
| **conferenceId** | [**string**] | Programmable Voice API Conference ID. | defaults to undefined|
|
|
177
|
+
| **memberId** | [**string**] | Programmable Voice API Conference Member ID. | defaults to undefined|
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
### Return type
|
|
181
|
+
|
|
182
|
+
**ConferenceMember**
|
|
183
|
+
|
|
184
|
+
### Authorization
|
|
185
|
+
|
|
186
|
+
[Basic](../README.md#Basic)
|
|
187
|
+
|
|
188
|
+
### HTTP request headers
|
|
189
|
+
|
|
190
|
+
- **Content-Type**: Not defined
|
|
191
|
+
- **Accept**: application/json
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
### HTTP response details
|
|
195
|
+
| Status code | Description | Response headers |
|
|
196
|
+
|-------------|-------------|------------------|
|
|
197
|
+
|**200** | OK | - |
|
|
198
|
+
|**400** | Bad Request | - |
|
|
199
|
+
|**401** | Unauthorized | - |
|
|
200
|
+
|**403** | Forbidden | - |
|
|
201
|
+
|**404** | Not Found | - |
|
|
202
|
+
|**405** | Method Not Allowed | - |
|
|
203
|
+
|**415** | Unsupported Media Type | - |
|
|
204
|
+
|**429** | Too Many Requests | * Retry-After - When you should try your request again. <br> |
|
|
205
|
+
|**500** | Internal Server Error | - |
|
|
206
|
+
|
|
207
|
+
[[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)
|
|
208
|
+
|
|
209
|
+
# **getConferenceRecording**
|
|
210
|
+
> ConferenceRecordingMetadata getConferenceRecording()
|
|
211
|
+
|
|
212
|
+
Returns metadata for the specified recording.
|
|
213
|
+
|
|
214
|
+
### Example
|
|
215
|
+
|
|
216
|
+
```typescript
|
|
217
|
+
import {
|
|
218
|
+
ConferencesApi,
|
|
219
|
+
Configuration
|
|
220
|
+
} from 'bandwidth-sdk';
|
|
221
|
+
|
|
222
|
+
const configuration = new Configuration();
|
|
223
|
+
const apiInstance = new ConferencesApi(configuration);
|
|
224
|
+
|
|
225
|
+
let accountId: string; //Your Bandwidth Account ID. (default to undefined)
|
|
226
|
+
let conferenceId: string; //Programmable Voice API Conference ID. (default to undefined)
|
|
227
|
+
let recordingId: string; //Programmable Voice API Recording ID. (default to undefined)
|
|
228
|
+
|
|
229
|
+
const { status, data } = await apiInstance.getConferenceRecording(
|
|
230
|
+
accountId,
|
|
231
|
+
conferenceId,
|
|
232
|
+
recordingId
|
|
233
|
+
);
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
### Parameters
|
|
237
|
+
|
|
238
|
+
|Name | Type | Description | Notes|
|
|
239
|
+
|------------- | ------------- | ------------- | -------------|
|
|
240
|
+
| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
|
|
241
|
+
| **conferenceId** | [**string**] | Programmable Voice API Conference ID. | defaults to undefined|
|
|
242
|
+
| **recordingId** | [**string**] | Programmable Voice API Recording ID. | defaults to undefined|
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
### Return type
|
|
246
|
+
|
|
247
|
+
**ConferenceRecordingMetadata**
|
|
248
|
+
|
|
249
|
+
### Authorization
|
|
250
|
+
|
|
251
|
+
[Basic](../README.md#Basic)
|
|
252
|
+
|
|
253
|
+
### HTTP request headers
|
|
254
|
+
|
|
255
|
+
- **Content-Type**: Not defined
|
|
256
|
+
- **Accept**: application/json
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
### HTTP response details
|
|
260
|
+
| Status code | Description | Response headers |
|
|
261
|
+
|-------------|-------------|------------------|
|
|
262
|
+
|**200** | OK | - |
|
|
263
|
+
|**400** | Bad Request | - |
|
|
264
|
+
|**401** | Unauthorized | - |
|
|
265
|
+
|**403** | Forbidden | - |
|
|
266
|
+
|**404** | Not Found | - |
|
|
267
|
+
|**405** | Method Not Allowed | - |
|
|
268
|
+
|**415** | Unsupported Media Type | - |
|
|
269
|
+
|**429** | Too Many Requests | * Retry-After - When you should try your request again. <br> |
|
|
270
|
+
|**500** | Internal Server Error | - |
|
|
271
|
+
|
|
272
|
+
[[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)
|
|
273
|
+
|
|
274
|
+
# **listConferenceRecordings**
|
|
275
|
+
> Array<ConferenceRecordingMetadata> listConferenceRecordings()
|
|
276
|
+
|
|
277
|
+
Returns a (potentially empty) list of metadata for the recordings that took place during the specified conference.
|
|
278
|
+
|
|
279
|
+
### Example
|
|
280
|
+
|
|
281
|
+
```typescript
|
|
282
|
+
import {
|
|
283
|
+
ConferencesApi,
|
|
284
|
+
Configuration
|
|
285
|
+
} from 'bandwidth-sdk';
|
|
286
|
+
|
|
287
|
+
const configuration = new Configuration();
|
|
288
|
+
const apiInstance = new ConferencesApi(configuration);
|
|
289
|
+
|
|
290
|
+
let accountId: string; //Your Bandwidth Account ID. (default to undefined)
|
|
291
|
+
let conferenceId: string; //Programmable Voice API Conference ID. (default to undefined)
|
|
292
|
+
|
|
293
|
+
const { status, data } = await apiInstance.listConferenceRecordings(
|
|
294
|
+
accountId,
|
|
295
|
+
conferenceId
|
|
296
|
+
);
|
|
297
|
+
```
|
|
298
|
+
|
|
299
|
+
### Parameters
|
|
300
|
+
|
|
301
|
+
|Name | Type | Description | Notes|
|
|
302
|
+
|------------- | ------------- | ------------- | -------------|
|
|
303
|
+
| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
|
|
304
|
+
| **conferenceId** | [**string**] | Programmable Voice API Conference ID. | defaults to undefined|
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
### Return type
|
|
308
|
+
|
|
309
|
+
**Array<ConferenceRecordingMetadata>**
|
|
310
|
+
|
|
311
|
+
### Authorization
|
|
312
|
+
|
|
313
|
+
[Basic](../README.md#Basic)
|
|
314
|
+
|
|
315
|
+
### HTTP request headers
|
|
316
|
+
|
|
317
|
+
- **Content-Type**: Not defined
|
|
318
|
+
- **Accept**: application/json
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
### HTTP response details
|
|
322
|
+
| Status code | Description | Response headers |
|
|
323
|
+
|-------------|-------------|------------------|
|
|
324
|
+
|**200** | OK | - |
|
|
325
|
+
|**400** | Bad Request | - |
|
|
326
|
+
|**401** | Unauthorized | - |
|
|
327
|
+
|**403** | Forbidden | - |
|
|
328
|
+
|**404** | Not Found | - |
|
|
329
|
+
|**405** | Method Not Allowed | - |
|
|
330
|
+
|**415** | Unsupported Media Type | - |
|
|
331
|
+
|**429** | Too Many Requests | * Retry-After - When you should try your request again. <br> |
|
|
332
|
+
|**500** | Internal Server Error | - |
|
|
333
|
+
|
|
334
|
+
[[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)
|
|
335
|
+
|
|
336
|
+
# **listConferences**
|
|
337
|
+
> Array<Conference> listConferences()
|
|
338
|
+
|
|
339
|
+
Returns a max of 1000 conferences, sorted by `createdTime` from oldest to newest. **NOTE:** If the number of conferences in the account is bigger than `pageSize`, a `Link` header (with format `<{url}>; rel=\"next\"`) will be returned in the response. The url can be used to retrieve the next page of conference records.
|
|
340
|
+
|
|
341
|
+
### Example
|
|
342
|
+
|
|
343
|
+
```typescript
|
|
344
|
+
import {
|
|
345
|
+
ConferencesApi,
|
|
346
|
+
Configuration
|
|
347
|
+
} from 'bandwidth-sdk';
|
|
348
|
+
|
|
349
|
+
const configuration = new Configuration();
|
|
350
|
+
const apiInstance = new ConferencesApi(configuration);
|
|
351
|
+
|
|
352
|
+
let accountId: string; //Your Bandwidth Account ID. (default to undefined)
|
|
353
|
+
let name: string; //Filter results by the `name` field. (optional) (default to undefined)
|
|
354
|
+
let minCreatedTime: string; //Filter results to conferences which have a `createdTime` after or at `minCreatedTime` (in ISO8601 format). (optional) (default to undefined)
|
|
355
|
+
let maxCreatedTime: string; //Filter results to conferences which have a `createdTime` before or at `maxCreatedTime` (in ISO8601 format). (optional) (default to undefined)
|
|
356
|
+
let pageSize: number; //Specifies the max number of conferences that will be returned. (optional) (default to 1000)
|
|
357
|
+
let pageToken: string; //Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description. (optional) (default to undefined)
|
|
358
|
+
|
|
359
|
+
const { status, data } = await apiInstance.listConferences(
|
|
360
|
+
accountId,
|
|
361
|
+
name,
|
|
362
|
+
minCreatedTime,
|
|
363
|
+
maxCreatedTime,
|
|
364
|
+
pageSize,
|
|
365
|
+
pageToken
|
|
366
|
+
);
|
|
367
|
+
```
|
|
368
|
+
|
|
369
|
+
### Parameters
|
|
370
|
+
|
|
371
|
+
|Name | Type | Description | Notes|
|
|
372
|
+
|------------- | ------------- | ------------- | -------------|
|
|
373
|
+
| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
|
|
374
|
+
| **name** | [**string**] | Filter results by the `name` field. | (optional) defaults to undefined|
|
|
375
|
+
| **minCreatedTime** | [**string**] | Filter results to conferences which have a `createdTime` after or at `minCreatedTime` (in ISO8601 format). | (optional) defaults to undefined|
|
|
376
|
+
| **maxCreatedTime** | [**string**] | Filter results to conferences which have a `createdTime` before or at `maxCreatedTime` (in ISO8601 format). | (optional) defaults to undefined|
|
|
377
|
+
| **pageSize** | [**number**] | Specifies the max number of conferences that will be returned. | (optional) defaults to 1000|
|
|
378
|
+
| **pageToken** | [**string**] | Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description. | (optional) defaults to undefined|
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
### Return type
|
|
382
|
+
|
|
383
|
+
**Array<Conference>**
|
|
384
|
+
|
|
385
|
+
### Authorization
|
|
386
|
+
|
|
387
|
+
[Basic](../README.md#Basic)
|
|
388
|
+
|
|
389
|
+
### HTTP request headers
|
|
390
|
+
|
|
391
|
+
- **Content-Type**: Not defined
|
|
392
|
+
- **Accept**: application/json
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
### HTTP response details
|
|
396
|
+
| Status code | Description | Response headers |
|
|
397
|
+
|-------------|-------------|------------------|
|
|
398
|
+
|**200** | OK | - |
|
|
399
|
+
|**400** | Bad Request | - |
|
|
400
|
+
|**401** | Unauthorized | - |
|
|
401
|
+
|**403** | Forbidden | - |
|
|
402
|
+
|**404** | Not Found | - |
|
|
403
|
+
|**405** | Method Not Allowed | - |
|
|
404
|
+
|**415** | Unsupported Media Type | - |
|
|
405
|
+
|**429** | Too Many Requests | * Retry-After - When you should try your request again. <br> |
|
|
406
|
+
|**500** | Internal Server Error | - |
|
|
407
|
+
|
|
408
|
+
[[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)
|
|
409
|
+
|
|
410
|
+
# **updateConference**
|
|
411
|
+
> updateConference(updateConference)
|
|
412
|
+
|
|
413
|
+
Update the conference state.
|
|
414
|
+
|
|
415
|
+
### Example
|
|
416
|
+
|
|
417
|
+
```typescript
|
|
418
|
+
import {
|
|
419
|
+
ConferencesApi,
|
|
420
|
+
Configuration,
|
|
421
|
+
UpdateConference
|
|
422
|
+
} from 'bandwidth-sdk';
|
|
423
|
+
|
|
424
|
+
const configuration = new Configuration();
|
|
425
|
+
const apiInstance = new ConferencesApi(configuration);
|
|
426
|
+
|
|
427
|
+
let accountId: string; //Your Bandwidth Account ID. (default to undefined)
|
|
428
|
+
let conferenceId: string; //Programmable Voice API Conference ID. (default to undefined)
|
|
429
|
+
let updateConference: UpdateConference; //
|
|
430
|
+
|
|
431
|
+
const { status, data } = await apiInstance.updateConference(
|
|
432
|
+
accountId,
|
|
433
|
+
conferenceId,
|
|
434
|
+
updateConference
|
|
435
|
+
);
|
|
436
|
+
```
|
|
437
|
+
|
|
438
|
+
### Parameters
|
|
439
|
+
|
|
440
|
+
|Name | Type | Description | Notes|
|
|
441
|
+
|------------- | ------------- | ------------- | -------------|
|
|
442
|
+
| **updateConference** | **UpdateConference**| | |
|
|
443
|
+
| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
|
|
444
|
+
| **conferenceId** | [**string**] | Programmable Voice API Conference ID. | defaults to undefined|
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
### Return type
|
|
448
|
+
|
|
449
|
+
void (empty response body)
|
|
450
|
+
|
|
451
|
+
### Authorization
|
|
452
|
+
|
|
453
|
+
[Basic](../README.md#Basic)
|
|
454
|
+
|
|
455
|
+
### HTTP request headers
|
|
456
|
+
|
|
457
|
+
- **Content-Type**: application/json
|
|
458
|
+
- **Accept**: application/json
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
### HTTP response details
|
|
462
|
+
| Status code | Description | Response headers |
|
|
463
|
+
|-------------|-------------|------------------|
|
|
464
|
+
|**204** | Conference was successfully modified. | - |
|
|
465
|
+
|**400** | Bad Request | - |
|
|
466
|
+
|**401** | Unauthorized | - |
|
|
467
|
+
|**403** | Forbidden | - |
|
|
468
|
+
|**404** | Not Found | - |
|
|
469
|
+
|**405** | Method Not Allowed | - |
|
|
470
|
+
|**415** | Unsupported Media Type | - |
|
|
471
|
+
|**429** | Too Many Requests | * Retry-After - When you should try your request again. <br> |
|
|
472
|
+
|**500** | Internal Server Error | - |
|
|
473
|
+
|
|
474
|
+
[[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)
|
|
475
|
+
|
|
476
|
+
# **updateConferenceBxml**
|
|
477
|
+
> updateConferenceBxml(body)
|
|
478
|
+
|
|
479
|
+
Update the conference BXML document.
|
|
480
|
+
|
|
481
|
+
### Example
|
|
482
|
+
|
|
483
|
+
```typescript
|
|
484
|
+
import {
|
|
485
|
+
ConferencesApi,
|
|
486
|
+
Configuration
|
|
487
|
+
} from 'bandwidth-sdk';
|
|
488
|
+
|
|
489
|
+
const configuration = new Configuration();
|
|
490
|
+
const apiInstance = new ConferencesApi(configuration);
|
|
491
|
+
|
|
492
|
+
let accountId: string; //Your Bandwidth Account ID. (default to undefined)
|
|
493
|
+
let conferenceId: string; //Programmable Voice API Conference ID. (default to undefined)
|
|
494
|
+
let body: string; //
|
|
495
|
+
|
|
496
|
+
const { status, data } = await apiInstance.updateConferenceBxml(
|
|
497
|
+
accountId,
|
|
498
|
+
conferenceId,
|
|
499
|
+
body
|
|
500
|
+
);
|
|
501
|
+
```
|
|
502
|
+
|
|
503
|
+
### Parameters
|
|
504
|
+
|
|
505
|
+
|Name | Type | Description | Notes|
|
|
506
|
+
|------------- | ------------- | ------------- | -------------|
|
|
507
|
+
| **body** | **string**| | |
|
|
508
|
+
| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
|
|
509
|
+
| **conferenceId** | [**string**] | Programmable Voice API Conference ID. | defaults to undefined|
|
|
510
|
+
|
|
511
|
+
|
|
512
|
+
### Return type
|
|
513
|
+
|
|
514
|
+
void (empty response body)
|
|
515
|
+
|
|
516
|
+
### Authorization
|
|
517
|
+
|
|
518
|
+
[Basic](../README.md#Basic)
|
|
519
|
+
|
|
520
|
+
### HTTP request headers
|
|
521
|
+
|
|
522
|
+
- **Content-Type**: application/xml
|
|
523
|
+
- **Accept**: application/json
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
### HTTP response details
|
|
527
|
+
| Status code | Description | Response headers |
|
|
528
|
+
|-------------|-------------|------------------|
|
|
529
|
+
|**204** | Conference successfully modified. | - |
|
|
530
|
+
|**400** | Bad Request | - |
|
|
531
|
+
|**401** | Unauthorized | - |
|
|
532
|
+
|**403** | Forbidden | - |
|
|
533
|
+
|**404** | Not Found | - |
|
|
534
|
+
|**405** | Method Not Allowed | - |
|
|
535
|
+
|**415** | Unsupported Media Type | - |
|
|
536
|
+
|**429** | Too Many Requests | * Retry-After - When you should try your request again. <br> |
|
|
537
|
+
|**500** | Internal Server Error | - |
|
|
538
|
+
|
|
539
|
+
[[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)
|
|
540
|
+
|
|
541
|
+
# **updateConferenceMember**
|
|
542
|
+
> updateConferenceMember(updateConferenceMember)
|
|
543
|
+
|
|
544
|
+
Updates settings for a particular conference member.
|
|
545
|
+
|
|
546
|
+
### Example
|
|
547
|
+
|
|
548
|
+
```typescript
|
|
549
|
+
import {
|
|
550
|
+
ConferencesApi,
|
|
551
|
+
Configuration,
|
|
552
|
+
UpdateConferenceMember
|
|
553
|
+
} from 'bandwidth-sdk';
|
|
554
|
+
|
|
555
|
+
const configuration = new Configuration();
|
|
556
|
+
const apiInstance = new ConferencesApi(configuration);
|
|
557
|
+
|
|
558
|
+
let accountId: string; //Your Bandwidth Account ID. (default to undefined)
|
|
559
|
+
let conferenceId: string; //Programmable Voice API Conference ID. (default to undefined)
|
|
560
|
+
let memberId: string; //Programmable Voice API Conference Member ID. (default to undefined)
|
|
561
|
+
let updateConferenceMember: UpdateConferenceMember; //
|
|
562
|
+
|
|
563
|
+
const { status, data } = await apiInstance.updateConferenceMember(
|
|
564
|
+
accountId,
|
|
565
|
+
conferenceId,
|
|
566
|
+
memberId,
|
|
567
|
+
updateConferenceMember
|
|
568
|
+
);
|
|
569
|
+
```
|
|
570
|
+
|
|
571
|
+
### Parameters
|
|
572
|
+
|
|
573
|
+
|Name | Type | Description | Notes|
|
|
574
|
+
|------------- | ------------- | ------------- | -------------|
|
|
575
|
+
| **updateConferenceMember** | **UpdateConferenceMember**| | |
|
|
576
|
+
| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
|
|
577
|
+
| **conferenceId** | [**string**] | Programmable Voice API Conference ID. | defaults to undefined|
|
|
578
|
+
| **memberId** | [**string**] | Programmable Voice API Conference Member ID. | defaults to undefined|
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
### Return type
|
|
582
|
+
|
|
583
|
+
void (empty response body)
|
|
584
|
+
|
|
585
|
+
### Authorization
|
|
586
|
+
|
|
587
|
+
[Basic](../README.md#Basic)
|
|
588
|
+
|
|
589
|
+
### HTTP request headers
|
|
590
|
+
|
|
591
|
+
- **Content-Type**: application/json
|
|
592
|
+
- **Accept**: application/json
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
### HTTP response details
|
|
596
|
+
| Status code | Description | Response headers |
|
|
597
|
+
|-------------|-------------|------------------|
|
|
598
|
+
|**204** | Conference member was successfully modified. | - |
|
|
599
|
+
|**400** | Bad Request | - |
|
|
600
|
+
|**401** | Unauthorized | - |
|
|
601
|
+
|**403** | Forbidden | - |
|
|
602
|
+
|**404** | Not Found | - |
|
|
603
|
+
|**405** | Method Not Allowed | - |
|
|
604
|
+
|**415** | Unsupported Media Type | - |
|
|
605
|
+
|**429** | Too Many Requests | * Retry-After - When you should try your request again. <br> |
|
|
606
|
+
|**500** | Internal Server Error | - |
|
|
607
|
+
|
|
608
|
+
[[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)
|
|
609
|
+
|