bandwidth-sdk 0.1.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/.bandwidth/catalog-info.yaml +13 -0
- package/.bandwidth/component.yaml +20 -0
- package/.github/CODEOWNERS +5 -0
- package/.github/ISSUE_TEMPLATE/bug_report.md +40 -0
- package/.github/ISSUE_TEMPLATE/config.yml +5 -0
- package/.github/workflows/deploy.yml +69 -0
- package/.github/workflows/test-nightly.yml +64 -0
- package/.github/workflows/test-pr.yml +48 -0
- package/.github/workflows/update-sdk.yml +95 -0
- package/.openapi-generator/FILES +107 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +4 -0
- package/README.md +45 -0
- package/api/calls-api.ts +539 -0
- package/api/conferences-api.ts +880 -0
- package/api/media-api.ts +410 -0
- package/api/messages-api.ts +351 -0
- package/api/mfaapi.ts +322 -0
- package/api/phone-number-lookup-api.ts +230 -0
- package/api/recordings-api.ts +962 -0
- package/api/statistics-api.ts +137 -0
- package/api.ts +25 -0
- package/bandwidth.yml +5726 -0
- package/base.ts +302 -0
- package/common.ts +150 -0
- package/configuration.ts +110 -0
- package/coverage/clover.xml +1636 -0
- package/coverage/coverage-final.json +63 -0
- package/coverage/lcov-report/base.css +224 -0
- package/coverage/lcov-report/block-navigation.js +87 -0
- package/coverage/lcov-report/favicon.png +0 -0
- package/coverage/lcov-report/index.html +191 -0
- package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +1702 -0
- package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +2725 -0
- package/coverage/lcov-report/node-sdk/api/index.html +221 -0
- package/coverage/lcov-report/node-sdk/api/media-api.ts.html +1315 -0
- package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +1138 -0
- package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +1051 -0
- package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +775 -0
- package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +2971 -0
- package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +496 -0
- package/coverage/lcov-report/node-sdk/base.ts.html +991 -0
- package/coverage/lcov-report/node-sdk/common.ts.html +535 -0
- package/coverage/lcov-report/node-sdk/configuration.ts.html +415 -0
- package/coverage/lcov-report/node-sdk/index.html +146 -0
- package/coverage/lcov-report/node-sdk/models/bxml/Bxml.ts.html +148 -0
- package/coverage/lcov-report/node-sdk/models/bxml/NestableVerb.ts.html +196 -0
- package/coverage/lcov-report/node-sdk/models/bxml/Response.ts.html +148 -0
- package/coverage/lcov-report/node-sdk/models/bxml/Root.ts.html +214 -0
- package/coverage/lcov-report/node-sdk/models/bxml/Verb.ts.html +208 -0
- package/coverage/lcov-report/node-sdk/models/bxml/index.html +191 -0
- package/coverage/lcov-report/node-sdk/models/bxml/index.ts.html +94 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Bridge.ts.html +196 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Conference.ts.html +196 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/CustomParam.ts.html +160 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Forward.ts.html +169 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Gather.ts.html +262 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Hangup.ts.html +133 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Pause.ts.html +154 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PauseRecording.ts.html +133 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PhoneNumber.ts.html +190 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PlayAudio.ts.html +163 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Record.ts.html +205 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Redirect.ts.html +178 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/ResumeRecording.ts.html +133 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Ring.ts.html +157 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SendDtmf.ts.html +163 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SipUri.ts.html +193 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SpeakSentence.ts.html +196 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartGather.ts.html +166 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartRecording.ts.html +181 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartStream.ts.html +202 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartTranscription.ts.html +205 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopGather.ts.html +133 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopRecording.ts.html +133 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopStream.ts.html +154 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopTranscription.ts.html +154 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StreamParam.ts.html +157 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Tag.ts.html +142 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Transfer.ts.html +229 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.html +536 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.ts.html +175 -0
- package/coverage/lcov-report/node-sdk/models/call-direction-enum.ts.html +178 -0
- package/coverage/lcov-report/node-sdk/models/call-state-enum.ts.html +178 -0
- package/coverage/lcov-report/node-sdk/models/callback-method-enum.ts.html +178 -0
- package/coverage/lcov-report/node-sdk/models/conference-state-enum.ts.html +178 -0
- package/coverage/lcov-report/node-sdk/models/file-format-enum.ts.html +178 -0
- package/coverage/lcov-report/node-sdk/models/index.html +326 -0
- package/coverage/lcov-report/node-sdk/models/index.ts.html +352 -0
- package/coverage/lcov-report/node-sdk/models/list-message-direction-enum.ts.html +178 -0
- package/coverage/lcov-report/node-sdk/models/lookup-status-enum.ts.html +184 -0
- package/coverage/lcov-report/node-sdk/models/machine-detection-mode-enum.ts.html +178 -0
- package/coverage/lcov-report/node-sdk/models/message-direction-enum.ts.html +178 -0
- package/coverage/lcov-report/node-sdk/models/message-status-enum.ts.html +196 -0
- package/coverage/lcov-report/node-sdk/models/message-type-enum.ts.html +178 -0
- package/coverage/lcov-report/node-sdk/models/priority-enum.ts.html +178 -0
- package/coverage/lcov-report/node-sdk/models/recording-state-enum.ts.html +178 -0
- package/coverage/lcov-report/node-sdk/models/redirect-method-enum.ts.html +178 -0
- package/coverage/lcov-report/node-sdk/tests/callUtils.js.html +334 -0
- package/coverage/lcov-report/node-sdk/tests/index.html +116 -0
- package/coverage/lcov-report/prettify.css +1 -0
- package/coverage/lcov-report/prettify.js +2 -0
- package/coverage/lcov-report/sort-arrow-sprite.png +0 -0
- package/coverage/lcov-report/sorter.js +196 -0
- package/coverage/lcov.info +3845 -0
- package/custom_templates/modelIndex.mustache +3 -0
- package/custom_templates/package.mustache +44 -0
- package/custom_templates/tsconfig.mustache +27 -0
- package/dist/api/calls-api.d.ts +261 -0
- package/dist/api/calls-api.js +627 -0
- package/dist/api/conferences-api.d.ts +422 -0
- package/dist/api/conferences-api.js +1000 -0
- package/dist/api/media-api.d.ts +201 -0
- package/dist/api/media-api.js +502 -0
- package/dist/api/messages-api.d.ts +176 -0
- package/dist/api/messages-api.js +403 -0
- package/dist/api/mfaapi.d.ts +156 -0
- package/dist/api/mfaapi.js +395 -0
- package/dist/api/phone-number-lookup-api.d.ts +117 -0
- package/dist/api/phone-number-lookup-api.js +305 -0
- package/dist/api/recordings-api.d.ts +462 -0
- package/dist/api/recordings-api.js +1094 -0
- package/dist/api/statistics-api.d.ts +74 -0
- package/dist/api/statistics-api.js +209 -0
- package/dist/api.d.ts +19 -0
- package/dist/api.js +37 -0
- package/dist/base.d.ts +66 -0
- package/dist/base.js +303 -0
- package/dist/common.d.ts +65 -0
- package/dist/common.js +252 -0
- package/dist/configuration.d.ts +91 -0
- package/dist/configuration.js +45 -0
- package/dist/index.d.ts +14 -0
- package/dist/index.js +32 -0
- package/dist/models/account-statistics.d.ts +30 -0
- package/dist/models/account-statistics.js +15 -0
- package/dist/models/answer-callback.d.ts +104 -0
- package/dist/models/answer-callback.js +15 -0
- package/dist/models/bridge-complete-callback.d.ts +115 -0
- package/dist/models/bridge-complete-callback.js +15 -0
- package/dist/models/bridge-target-complete-callback.d.ts +97 -0
- package/dist/models/bridge-target-complete-callback.js +15 -0
- package/dist/models/bxml/Bxml.d.ts +17 -0
- package/dist/models/bxml/Bxml.js +37 -0
- package/dist/models/bxml/NestableVerb.d.ts +26 -0
- package/dist/models/bxml/NestableVerb.js +52 -0
- package/dist/models/bxml/Response.d.ts +17 -0
- package/dist/models/bxml/Response.js +37 -0
- package/dist/models/bxml/Root.d.ts +28 -0
- package/dist/models/bxml/Root.js +40 -0
- package/dist/models/bxml/Verb.d.ts +27 -0
- package/dist/models/bxml/Verb.js +38 -0
- package/dist/models/bxml/index.d.ts +2 -0
- package/dist/models/bxml/index.js +5 -0
- package/dist/models/bxml/verbs/Bridge.d.ts +31 -0
- package/dist/models/bxml/verbs/Bridge.js +38 -0
- package/dist/models/bxml/verbs/Conference.d.ts +33 -0
- package/dist/models/bxml/verbs/Conference.js +38 -0
- package/dist/models/bxml/verbs/CustomParam.d.ts +20 -0
- package/dist/models/bxml/verbs/CustomParam.js +37 -0
- package/dist/models/bxml/verbs/Forward.d.ts +24 -0
- package/dist/models/bxml/verbs/Forward.js +37 -0
- package/dist/models/bxml/verbs/Gather.d.ts +47 -0
- package/dist/models/bxml/verbs/Gather.js +53 -0
- package/dist/models/bxml/verbs/Hangup.d.ts +13 -0
- package/dist/models/bxml/verbs/Hangup.js +36 -0
- package/dist/models/bxml/verbs/Pause.d.ts +19 -0
- package/dist/models/bxml/verbs/Pause.js +37 -0
- package/dist/models/bxml/verbs/PauseRecording.d.ts +13 -0
- package/dist/models/bxml/verbs/PauseRecording.js +36 -0
- package/dist/models/bxml/verbs/PhoneNumber.d.ts +31 -0
- package/dist/models/bxml/verbs/PhoneNumber.js +38 -0
- package/dist/models/bxml/verbs/PlayAudio.d.ts +22 -0
- package/dist/models/bxml/verbs/PlayAudio.js +38 -0
- package/dist/models/bxml/verbs/Record.d.ts +36 -0
- package/dist/models/bxml/verbs/Record.js +37 -0
- package/dist/models/bxml/verbs/Redirect.d.ts +27 -0
- package/dist/models/bxml/verbs/Redirect.js +37 -0
- package/dist/models/bxml/verbs/ResumeRecording.d.ts +13 -0
- package/dist/models/bxml/verbs/ResumeRecording.js +36 -0
- package/dist/models/bxml/verbs/Ring.d.ts +20 -0
- package/dist/models/bxml/verbs/Ring.js +37 -0
- package/dist/models/bxml/verbs/SendDtmf.d.ts +22 -0
- package/dist/models/bxml/verbs/SendDtmf.js +38 -0
- package/dist/models/bxml/verbs/SipUri.d.ts +32 -0
- package/dist/models/bxml/verbs/SipUri.js +38 -0
- package/dist/models/bxml/verbs/SpeakSentence.d.ts +29 -0
- package/dist/models/bxml/verbs/SpeakSentence.js +46 -0
- package/dist/models/bxml/verbs/StartGather.d.ts +23 -0
- package/dist/models/bxml/verbs/StartGather.js +37 -0
- package/dist/models/bxml/verbs/StartRecording.d.ts +28 -0
- package/dist/models/bxml/verbs/StartRecording.js +37 -0
- package/dist/models/bxml/verbs/StartStream.d.ts +32 -0
- package/dist/models/bxml/verbs/StartStream.js +45 -0
- package/dist/models/bxml/verbs/StartTranscription.d.ts +33 -0
- package/dist/models/bxml/verbs/StartTranscription.js +45 -0
- package/dist/models/bxml/verbs/StopGather.d.ts +13 -0
- package/dist/models/bxml/verbs/StopGather.js +36 -0
- package/dist/models/bxml/verbs/StopRecording.d.ts +13 -0
- package/dist/models/bxml/verbs/StopRecording.js +36 -0
- package/dist/models/bxml/verbs/StopStream.d.ts +19 -0
- package/dist/models/bxml/verbs/StopStream.js +37 -0
- package/dist/models/bxml/verbs/StopTranscription.d.ts +19 -0
- package/dist/models/bxml/verbs/StopTranscription.js +37 -0
- package/dist/models/bxml/verbs/StreamParam.d.ts +20 -0
- package/dist/models/bxml/verbs/StreamParam.js +37 -0
- package/dist/models/bxml/verbs/Tag.d.ts +15 -0
- package/dist/models/bxml/verbs/Tag.js +37 -0
- package/dist/models/bxml/verbs/Transfer.d.ts +40 -0
- package/dist/models/bxml/verbs/Transfer.js +45 -0
- package/dist/models/bxml/verbs/index.d.ts +30 -0
- package/dist/models/bxml/verbs/index.js +46 -0
- package/dist/models/call-direction-enum.d.ts +21 -0
- package/dist/models/call-direction-enum.js +25 -0
- package/dist/models/call-recording-metadata.d.ts +129 -0
- package/dist/models/call-recording-metadata.js +15 -0
- package/dist/models/call-state-enum.d.ts +21 -0
- package/dist/models/call-state-enum.js +25 -0
- package/dist/models/call-state.d.ts +129 -0
- package/dist/models/call-state.js +15 -0
- package/dist/models/callback-method-enum.d.ts +21 -0
- package/dist/models/callback-method-enum.js +25 -0
- package/dist/models/code-request.d.ts +54 -0
- package/dist/models/code-request.js +15 -0
- package/dist/models/conference-completed-callback.d.ts +48 -0
- package/dist/models/conference-completed-callback.js +15 -0
- package/dist/models/conference-created-callback.d.ts +48 -0
- package/dist/models/conference-created-callback.js +15 -0
- package/dist/models/conference-member-exit-callback.d.ts +66 -0
- package/dist/models/conference-member-exit-callback.js +15 -0
- package/dist/models/conference-member-join-callback.d.ts +66 -0
- package/dist/models/conference-member-join-callback.js +15 -0
- package/dist/models/conference-member.d.ts +54 -0
- package/dist/models/conference-member.js +15 -0
- package/dist/models/conference-recording-available-callback.d.ts +103 -0
- package/dist/models/conference-recording-available-callback.js +15 -0
- package/dist/models/conference-recording-metadata.d.ts +85 -0
- package/dist/models/conference-recording-metadata.js +15 -0
- package/dist/models/conference-redirect-callback.d.ts +48 -0
- package/dist/models/conference-redirect-callback.js +15 -0
- package/dist/models/conference-state-enum.d.ts +21 -0
- package/dist/models/conference-state-enum.js +25 -0
- package/dist/models/conference.d.ts +68 -0
- package/dist/models/conference.js +15 -0
- package/dist/models/create-call-response.d.ts +145 -0
- package/dist/models/create-call-response.js +15 -0
- package/dist/models/create-call.d.ts +140 -0
- package/dist/models/create-call.js +15 -0
- package/dist/models/create-lookup-response.d.ts +31 -0
- package/dist/models/create-lookup-response.js +15 -0
- package/dist/models/create-message-request-error.d.ts +37 -0
- package/dist/models/create-message-request-error.js +15 -0
- package/dist/models/deferred-result.d.ts +30 -0
- package/dist/models/deferred-result.js +15 -0
- package/dist/models/disconnect-callback.d.ts +121 -0
- package/dist/models/disconnect-callback.js +15 -0
- package/dist/models/diversion.d.ts +60 -0
- package/dist/models/diversion.js +15 -0
- package/dist/models/dtmf-callback.d.ts +121 -0
- package/dist/models/dtmf-callback.js +15 -0
- package/dist/models/field-error.d.ts +30 -0
- package/dist/models/field-error.js +15 -0
- package/dist/models/file-format-enum.d.ts +21 -0
- package/dist/models/file-format-enum.js +25 -0
- package/dist/models/gather-callback.d.ts +127 -0
- package/dist/models/gather-callback.js +15 -0
- package/dist/models/inbound-message-callback-message.d.ts +92 -0
- package/dist/models/inbound-message-callback-message.js +15 -0
- package/dist/models/inbound-message-callback.d.ts +49 -0
- package/dist/models/inbound-message-callback.js +15 -0
- package/dist/models/index.d.ts +89 -0
- package/dist/models/index.js +105 -0
- package/dist/models/initiate-callback.d.ts +93 -0
- package/dist/models/initiate-callback.js +15 -0
- package/dist/models/list-message-direction-enum.d.ts +21 -0
- package/dist/models/list-message-direction-enum.js +25 -0
- package/dist/models/list-message-item.d.ts +123 -0
- package/dist/models/list-message-item.js +15 -0
- package/dist/models/lookup-request.d.ts +24 -0
- package/dist/models/lookup-request.js +15 -0
- package/dist/models/lookup-result.d.ts +72 -0
- package/dist/models/lookup-result.js +15 -0
- package/dist/models/lookup-status-enum.d.ts +23 -0
- package/dist/models/lookup-status-enum.js +27 -0
- package/dist/models/lookup-status.d.ts +44 -0
- package/dist/models/lookup-status.js +15 -0
- package/dist/models/machine-detection-complete-callback.d.ts +104 -0
- package/dist/models/machine-detection-complete-callback.js +15 -0
- package/dist/models/machine-detection-configuration.d.ts +110 -0
- package/dist/models/machine-detection-configuration.js +15 -0
- package/dist/models/machine-detection-mode-enum.d.ts +21 -0
- package/dist/models/machine-detection-mode-enum.js +25 -0
- package/dist/models/machine-detection-result.d.ts +30 -0
- package/dist/models/machine-detection-result.js +15 -0
- package/dist/models/media.d.ts +36 -0
- package/dist/models/media.js +15 -0
- package/dist/models/message-delivered-callback-message.d.ts +92 -0
- package/dist/models/message-delivered-callback-message.js +15 -0
- package/dist/models/message-delivered-callback.d.ts +49 -0
- package/dist/models/message-delivered-callback.js +15 -0
- package/dist/models/message-direction-enum.d.ts +21 -0
- package/dist/models/message-direction-enum.js +25 -0
- package/dist/models/message-failed-callback-message.d.ts +92 -0
- package/dist/models/message-failed-callback-message.js +15 -0
- package/dist/models/message-failed-callback.d.ts +55 -0
- package/dist/models/message-failed-callback.js +15 -0
- package/dist/models/message-request.d.ts +67 -0
- package/dist/models/message-request.js +15 -0
- package/dist/models/message-sending-callback-message.d.ts +92 -0
- package/dist/models/message-sending-callback-message.js +15 -0
- package/dist/models/message-sending-callback.d.ts +49 -0
- package/dist/models/message-sending-callback.js +15 -0
- package/dist/models/message-status-enum.d.ts +27 -0
- package/dist/models/message-status-enum.js +31 -0
- package/dist/models/message-type-enum.d.ts +21 -0
- package/dist/models/message-type-enum.js +25 -0
- package/dist/models/message.d.ts +98 -0
- package/dist/models/message.js +15 -0
- package/dist/models/messages-list.d.ts +38 -0
- package/dist/models/messages-list.js +15 -0
- package/dist/models/messaging-code-response.d.ts +24 -0
- package/dist/models/messaging-code-response.js +15 -0
- package/dist/models/messaging-request-error.d.ts +30 -0
- package/dist/models/messaging-request-error.js +15 -0
- package/dist/models/mfa-forbidden-request-error.d.ts +24 -0
- package/dist/models/mfa-forbidden-request-error.js +15 -0
- package/dist/models/mfa-request-error.d.ts +30 -0
- package/dist/models/mfa-request-error.js +15 -0
- package/dist/models/mfa-unauthorized-request-error.d.ts +24 -0
- package/dist/models/mfa-unauthorized-request-error.js +15 -0
- package/dist/models/page-info.d.ts +42 -0
- package/dist/models/page-info.js +15 -0
- package/dist/models/priority-enum.d.ts +21 -0
- package/dist/models/priority-enum.js +25 -0
- package/dist/models/recording-available-callback.d.ts +152 -0
- package/dist/models/recording-available-callback.js +15 -0
- package/dist/models/recording-complete-callback.d.ts +152 -0
- package/dist/models/recording-complete-callback.js +15 -0
- package/dist/models/recording-state-enum.d.ts +21 -0
- package/dist/models/recording-state-enum.js +25 -0
- package/dist/models/redirect-callback.d.ts +115 -0
- package/dist/models/redirect-callback.js +15 -0
- package/dist/models/redirect-method-enum.d.ts +21 -0
- package/dist/models/redirect-method-enum.js +25 -0
- package/dist/models/stir-shaken.d.ts +36 -0
- package/dist/models/stir-shaken.js +15 -0
- package/dist/models/tag.d.ts +30 -0
- package/dist/models/tag.js +15 -0
- package/dist/models/tn-lookup-request-error.d.ts +24 -0
- package/dist/models/tn-lookup-request-error.js +15 -0
- package/dist/models/transcribe-recording.d.ts +61 -0
- package/dist/models/transcribe-recording.js +15 -0
- package/dist/models/transcription-available-callback.d.ts +147 -0
- package/dist/models/transcription-available-callback.js +15 -0
- package/dist/models/transcription-list.d.ts +25 -0
- package/dist/models/transcription-list.js +15 -0
- package/dist/models/transcription-metadata.d.ts +42 -0
- package/dist/models/transcription-metadata.js +15 -0
- package/dist/models/transcription.d.ts +30 -0
- package/dist/models/transcription.js +15 -0
- package/dist/models/transfer-answer-callback.d.ts +109 -0
- package/dist/models/transfer-answer-callback.js +15 -0
- package/dist/models/transfer-complete-callback.d.ts +127 -0
- package/dist/models/transfer-complete-callback.js +15 -0
- package/dist/models/transfer-disconnect-callback.d.ts +139 -0
- package/dist/models/transfer-disconnect-callback.js +15 -0
- package/dist/models/update-call-recording.d.ts +25 -0
- package/dist/models/update-call-recording.js +15 -0
- package/dist/models/update-call.d.ts +80 -0
- package/dist/models/update-call.js +15 -0
- package/dist/models/update-conference-member.d.ts +36 -0
- package/dist/models/update-conference-member.js +15 -0
- package/dist/models/update-conference.d.ts +74 -0
- package/dist/models/update-conference.js +15 -0
- package/dist/models/verify-code-request.d.ts +42 -0
- package/dist/models/verify-code-request.js +15 -0
- package/dist/models/verify-code-response.d.ts +24 -0
- package/dist/models/verify-code-response.js +15 -0
- package/dist/models/voice-api-error.d.ts +36 -0
- package/dist/models/voice-api-error.js +15 -0
- package/dist/models/voice-code-response.d.ts +24 -0
- package/dist/models/voice-code-response.js +15 -0
- package/git_push.sh +57 -0
- package/index.ts +18 -0
- package/jest.config.js +26 -0
- package/models/account-statistics.ts +36 -0
- package/models/answer-callback.ts +116 -0
- package/models/bridge-complete-callback.ts +125 -0
- package/models/bridge-target-complete-callback.ts +107 -0
- package/models/bxml/Bxml.ts +21 -0
- package/models/bxml/NestableVerb.ts +37 -0
- package/models/bxml/Response.ts +21 -0
- package/models/bxml/Root.ts +43 -0
- package/models/bxml/Verb.ts +41 -0
- package/models/bxml/index.ts +3 -0
- package/models/bxml/verbs/Bridge.ts +37 -0
- package/models/bxml/verbs/Conference.ts +37 -0
- package/models/bxml/verbs/CustomParam.ts +25 -0
- package/models/bxml/verbs/Forward.ts +28 -0
- package/models/bxml/verbs/Gather.ts +59 -0
- package/models/bxml/verbs/Hangup.ts +16 -0
- package/models/bxml/verbs/Pause.ts +23 -0
- package/models/bxml/verbs/PauseRecording.ts +16 -0
- package/models/bxml/verbs/PhoneNumber.ts +35 -0
- package/models/bxml/verbs/PlayAudio.ts +26 -0
- package/models/bxml/verbs/Record.ts +40 -0
- package/models/bxml/verbs/Redirect.ts +31 -0
- package/models/bxml/verbs/ResumeRecording.ts +16 -0
- package/models/bxml/verbs/Ring.ts +24 -0
- package/models/bxml/verbs/SendDtmf.ts +26 -0
- package/models/bxml/verbs/SipUri.ts +36 -0
- package/models/bxml/verbs/SpeakSentence.ts +37 -0
- package/models/bxml/verbs/StartGather.ts +27 -0
- package/models/bxml/verbs/StartRecording.ts +32 -0
- package/models/bxml/verbs/StartStream.ts +39 -0
- package/models/bxml/verbs/StartTranscription.ts +40 -0
- package/models/bxml/verbs/StopGather.ts +16 -0
- package/models/bxml/verbs/StopRecording.ts +16 -0
- package/models/bxml/verbs/StopStream.ts +23 -0
- package/models/bxml/verbs/StopTranscription.ts +23 -0
- package/models/bxml/verbs/StreamParam.ts +24 -0
- package/models/bxml/verbs/Tag.ts +19 -0
- package/models/bxml/verbs/Transfer.ts +48 -0
- package/models/bxml/verbs/index.ts +30 -0
- package/models/call-direction-enum.ts +31 -0
- package/models/call-recording-metadata.ts +143 -0
- package/models/call-state-enum.ts +31 -0
- package/models/call-state.ts +137 -0
- package/models/callback-method-enum.ts +31 -0
- package/models/code-request.ts +60 -0
- package/models/conference-completed-callback.ts +54 -0
- package/models/conference-created-callback.ts +54 -0
- package/models/conference-member-exit-callback.ts +72 -0
- package/models/conference-member-join-callback.ts +72 -0
- package/models/conference-member.ts +60 -0
- package/models/conference-recording-available-callback.ts +113 -0
- package/models/conference-recording-metadata.ts +95 -0
- package/models/conference-redirect-callback.ts +54 -0
- package/models/conference-state-enum.ts +31 -0
- package/models/conference.ts +80 -0
- package/models/create-call-response.ts +155 -0
- package/models/create-call.ts +152 -0
- package/models/create-lookup-response.ts +41 -0
- package/models/create-message-request-error.ts +45 -0
- package/models/deferred-result.ts +36 -0
- package/models/disconnect-callback.ts +131 -0
- package/models/diversion.ts +66 -0
- package/models/dtmf-callback.ts +131 -0
- package/models/field-error.ts +36 -0
- package/models/file-format-enum.ts +31 -0
- package/models/gather-callback.ts +137 -0
- package/models/inbound-message-callback-message.ts +104 -0
- package/models/inbound-message-callback.ts +57 -0
- package/models/index.ts +89 -0
- package/models/initiate-callback.ts +107 -0
- package/models/list-message-direction-enum.ts +31 -0
- package/models/list-message-item.ts +137 -0
- package/models/lookup-request.ts +30 -0
- package/models/lookup-result.ts +78 -0
- package/models/lookup-status-enum.ts +33 -0
- package/models/lookup-status.ts +56 -0
- package/models/machine-detection-complete-callback.ts +116 -0
- package/models/machine-detection-configuration.ts +122 -0
- package/models/machine-detection-mode-enum.ts +31 -0
- package/models/machine-detection-result.ts +36 -0
- package/models/media.ts +42 -0
- package/models/message-delivered-callback-message.ts +104 -0
- package/models/message-delivered-callback.ts +57 -0
- package/models/message-direction-enum.ts +31 -0
- package/models/message-failed-callback-message.ts +104 -0
- package/models/message-failed-callback.ts +63 -0
- package/models/message-request.ts +77 -0
- package/models/message-sending-callback-message.ts +104 -0
- package/models/message-sending-callback.ts +57 -0
- package/models/message-status-enum.ts +37 -0
- package/models/message-type-enum.ts +31 -0
- package/models/message.ts +110 -0
- package/models/messages-list.ts +48 -0
- package/models/messaging-code-response.ts +30 -0
- package/models/messaging-request-error.ts +36 -0
- package/models/mfa-forbidden-request-error.ts +30 -0
- package/models/mfa-request-error.ts +36 -0
- package/models/mfa-unauthorized-request-error.ts +30 -0
- package/models/page-info.ts +48 -0
- package/models/priority-enum.ts +31 -0
- package/models/recording-available-callback.ts +164 -0
- package/models/recording-complete-callback.ts +164 -0
- package/models/recording-state-enum.ts +31 -0
- package/models/redirect-callback.ts +125 -0
- package/models/redirect-method-enum.ts +31 -0
- package/models/stir-shaken.ts +42 -0
- package/models/tag.ts +36 -0
- package/models/tn-lookup-request-error.ts +30 -0
- package/models/transcribe-recording.ts +71 -0
- package/models/transcription-available-callback.ts +161 -0
- package/models/transcription-list.ts +33 -0
- package/models/transcription-metadata.ts +48 -0
- package/models/transcription.ts +36 -0
- package/models/transfer-answer-callback.ts +119 -0
- package/models/transfer-complete-callback.ts +137 -0
- package/models/transfer-disconnect-callback.ts +149 -0
- package/models/update-call-recording.ts +35 -0
- package/models/update-call.ts +92 -0
- package/models/update-conference-member.ts +42 -0
- package/models/update-conference.ts +86 -0
- package/models/verify-code-request.ts +48 -0
- package/models/verify-code-response.ts +30 -0
- package/models/voice-api-error.ts +42 -0
- package/models/voice-code-response.ts +30 -0
- package/openapi-config.yml +8 -0
- package/openapitools.json +7 -0
- package/package.json +35 -0
- package/tests/callUtils.js +83 -0
- package/tests/fixtures/nodejs_cat.jpeg +0 -0
- package/tests/integration/bxml.test.js +294 -0
- package/tests/integration/calls-api.test.js +194 -0
- package/tests/integration/conferences-api.test.js +159 -0
- package/tests/integration/media-api.test.js +88 -0
- package/tests/integration/messages-api.test.js +114 -0
- package/tests/integration/mfaapi.test.js +97 -0
- package/tests/integration/phone-number-lookup-api.test.js +80 -0
- package/tests/integration/recordings-api.test.js +174 -0
- package/tests/integration/statistics-api.test.js +41 -0
- package/tests/unit/bxml/Bxml.test.js +13 -0
- package/tests/unit/bxml/NestableVerb.test.js +13 -0
- package/tests/unit/bxml/Response.test.js +13 -0
- package/tests/unit/bxml/Verb.test.js +11 -0
- package/tests/unit/bxml/verbs/Bridge.test.js +30 -0
- package/tests/unit/bxml/verbs/Conference.test.js +30 -0
- package/tests/unit/bxml/verbs/CustomParam.test.js +19 -0
- package/tests/unit/bxml/verbs/Forward.test.js +23 -0
- package/tests/unit/bxml/verbs/Gather.test.js +52 -0
- package/tests/unit/bxml/verbs/Hangup.test.js +14 -0
- package/tests/unit/bxml/verbs/Pause.test.js +18 -0
- package/tests/unit/bxml/verbs/PauseRecording.test.js +14 -0
- package/tests/unit/bxml/verbs/PhoneNumber.test.js +28 -0
- package/tests/unit/bxml/verbs/PlayAudio.test.js +19 -0
- package/tests/unit/bxml/verbs/Record.test.js +35 -0
- package/tests/unit/bxml/verbs/Redirect.test.js +26 -0
- package/tests/unit/bxml/verbs/ResumeRecording.test.js +14 -0
- package/tests/unit/bxml/verbs/Ring.test.js +19 -0
- package/tests/unit/bxml/verbs/SendDtmf.test.js +19 -0
- package/tests/unit/bxml/verbs/SipUri.test.js +29 -0
- package/tests/unit/bxml/verbs/SpeakSentence.test.js +20 -0
- package/tests/unit/bxml/verbs/StartGather.test.js +22 -0
- package/tests/unit/bxml/verbs/StartRecording.test.js +27 -0
- package/tests/unit/bxml/verbs/StartStream.test.js +44 -0
- package/tests/unit/bxml/verbs/StartTranscription.test.js +45 -0
- package/tests/unit/bxml/verbs/StopGather.test.js +14 -0
- package/tests/unit/bxml/verbs/StopRecording.test.js +14 -0
- package/tests/unit/bxml/verbs/StopStream.test.js +18 -0
- package/tests/unit/bxml/verbs/StopTranscription.test.js +18 -0
- package/tests/unit/bxml/verbs/StreamParam.test.js +19 -0
- package/tests/unit/bxml/verbs/Tag.test.js +14 -0
- package/tests/unit/bxml/verbs/Transfer.test.js +51 -0
- package/tests/unit/call-direction-enum.test.js +8 -0
- package/tests/unit/call-state-enum.test.js +8 -0
- package/tests/unit/callback-method-enum.test.js +8 -0
- package/tests/unit/conference-state-enum.test.js +8 -0
- package/tests/unit/file-format-enum.test.js +8 -0
- package/tests/unit/list-message-direction-enum.test.js +8 -0
- package/tests/unit/lookup-status-enum.test.js +10 -0
- package/tests/unit/machine-detection-mode-enum.test.js +8 -0
- package/tests/unit/message-direction-enum.test.js +8 -0
- package/tests/unit/message-status-enum.test.js +14 -0
- package/tests/unit/message-type-enum.test.js +8 -0
- package/tests/unit/priority-enum.test.js +8 -0
- package/tests/unit/recording-state-enum.test.js +8 -0
- package/tests/unit/redirect-method-enum.test.js +8 -0
- package/tsconfig.json +22 -0
|
@@ -0,0 +1,962 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Bandwidth
|
|
5
|
+
* Bandwidth\'s Communication APIs
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
* Contact: letstalk@bandwidth.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
import type { Configuration } from '../configuration';
|
|
17
|
+
import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
18
|
+
import globalAxios from 'axios';
|
|
19
|
+
// Some imports not used depending on template conditions
|
|
20
|
+
// @ts-ignore
|
|
21
|
+
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
|
|
22
|
+
// @ts-ignore
|
|
23
|
+
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
|
|
24
|
+
// @ts-ignore
|
|
25
|
+
import { CallRecordingMetadata } from '../models';
|
|
26
|
+
// @ts-ignore
|
|
27
|
+
import { TranscribeRecording } from '../models';
|
|
28
|
+
// @ts-ignore
|
|
29
|
+
import { TranscriptionList } from '../models';
|
|
30
|
+
// @ts-ignore
|
|
31
|
+
import { UpdateCallRecording } from '../models';
|
|
32
|
+
// @ts-ignore
|
|
33
|
+
import { VoiceApiError } from '../models';
|
|
34
|
+
/**
|
|
35
|
+
* RecordingsApi - axios parameter creator
|
|
36
|
+
* @export
|
|
37
|
+
*/
|
|
38
|
+
export const RecordingsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
39
|
+
return {
|
|
40
|
+
/**
|
|
41
|
+
* Deletes the specified recording\'s transcription. Note: After the deletion is requested and a `204` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
|
|
42
|
+
* @summary Delete Transcription
|
|
43
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
44
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
45
|
+
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
46
|
+
* @param {*} [options] Override http request option.
|
|
47
|
+
* @throws {RequiredError}
|
|
48
|
+
*/
|
|
49
|
+
deleteCallTranscription: async (accountId: string, callId: string, recordingId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
50
|
+
// verify required parameter 'accountId' is not null or undefined
|
|
51
|
+
assertParamExists('deleteCallTranscription', 'accountId', accountId)
|
|
52
|
+
// verify required parameter 'callId' is not null or undefined
|
|
53
|
+
assertParamExists('deleteCallTranscription', 'callId', callId)
|
|
54
|
+
// verify required parameter 'recordingId' is not null or undefined
|
|
55
|
+
assertParamExists('deleteCallTranscription', 'recordingId', recordingId)
|
|
56
|
+
const localVarPath = `/accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription`
|
|
57
|
+
.replace(`{${"accountId"}}`, encodeURIComponent(String(accountId)))
|
|
58
|
+
.replace(`{${"callId"}}`, encodeURIComponent(String(callId)))
|
|
59
|
+
.replace(`{${"recordingId"}}`, encodeURIComponent(String(recordingId)));
|
|
60
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
61
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
62
|
+
let baseOptions;
|
|
63
|
+
if (configuration) {
|
|
64
|
+
baseOptions = configuration.baseOptions;
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
68
|
+
const localVarHeaderParameter = {} as any;
|
|
69
|
+
const localVarQueryParameter = {} as any;
|
|
70
|
+
|
|
71
|
+
// authentication Basic required
|
|
72
|
+
// http basic authentication required
|
|
73
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
78
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
79
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
80
|
+
|
|
81
|
+
return {
|
|
82
|
+
url: toPathString(localVarUrlObj),
|
|
83
|
+
options: localVarRequestOptions,
|
|
84
|
+
};
|
|
85
|
+
},
|
|
86
|
+
/**
|
|
87
|
+
* Delete the recording information, media and transcription. Note: After the deletion is requested and a `204` is returned, neither the recording metadata nor the actual media nor its transcription will be accessible anymore. However, the media of the specified recording is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
|
|
88
|
+
* @summary Delete Recording
|
|
89
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
90
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
91
|
+
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
92
|
+
* @param {*} [options] Override http request option.
|
|
93
|
+
* @throws {RequiredError}
|
|
94
|
+
*/
|
|
95
|
+
deleteRecording: async (accountId: string, callId: string, recordingId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
96
|
+
// verify required parameter 'accountId' is not null or undefined
|
|
97
|
+
assertParamExists('deleteRecording', 'accountId', accountId)
|
|
98
|
+
// verify required parameter 'callId' is not null or undefined
|
|
99
|
+
assertParamExists('deleteRecording', 'callId', callId)
|
|
100
|
+
// verify required parameter 'recordingId' is not null or undefined
|
|
101
|
+
assertParamExists('deleteRecording', 'recordingId', recordingId)
|
|
102
|
+
const localVarPath = `/accounts/{accountId}/calls/{callId}/recordings/{recordingId}`
|
|
103
|
+
.replace(`{${"accountId"}}`, encodeURIComponent(String(accountId)))
|
|
104
|
+
.replace(`{${"callId"}}`, encodeURIComponent(String(callId)))
|
|
105
|
+
.replace(`{${"recordingId"}}`, encodeURIComponent(String(recordingId)));
|
|
106
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
107
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
108
|
+
let baseOptions;
|
|
109
|
+
if (configuration) {
|
|
110
|
+
baseOptions = configuration.baseOptions;
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
114
|
+
const localVarHeaderParameter = {} as any;
|
|
115
|
+
const localVarQueryParameter = {} as any;
|
|
116
|
+
|
|
117
|
+
// authentication Basic required
|
|
118
|
+
// http basic authentication required
|
|
119
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
124
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
125
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
126
|
+
|
|
127
|
+
return {
|
|
128
|
+
url: toPathString(localVarUrlObj),
|
|
129
|
+
options: localVarRequestOptions,
|
|
130
|
+
};
|
|
131
|
+
},
|
|
132
|
+
/**
|
|
133
|
+
* Deletes the specified recording\'s media.
|
|
134
|
+
* @summary Delete Recording Media
|
|
135
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
136
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
137
|
+
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
138
|
+
* @param {*} [options] Override http request option.
|
|
139
|
+
* @throws {RequiredError}
|
|
140
|
+
*/
|
|
141
|
+
deleteRecordingMedia: async (accountId: string, callId: string, recordingId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
142
|
+
// verify required parameter 'accountId' is not null or undefined
|
|
143
|
+
assertParamExists('deleteRecordingMedia', 'accountId', accountId)
|
|
144
|
+
// verify required parameter 'callId' is not null or undefined
|
|
145
|
+
assertParamExists('deleteRecordingMedia', 'callId', callId)
|
|
146
|
+
// verify required parameter 'recordingId' is not null or undefined
|
|
147
|
+
assertParamExists('deleteRecordingMedia', 'recordingId', recordingId)
|
|
148
|
+
const localVarPath = `/accounts/{accountId}/calls/{callId}/recordings/{recordingId}/media`
|
|
149
|
+
.replace(`{${"accountId"}}`, encodeURIComponent(String(accountId)))
|
|
150
|
+
.replace(`{${"callId"}}`, encodeURIComponent(String(callId)))
|
|
151
|
+
.replace(`{${"recordingId"}}`, encodeURIComponent(String(recordingId)));
|
|
152
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
153
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
154
|
+
let baseOptions;
|
|
155
|
+
if (configuration) {
|
|
156
|
+
baseOptions = configuration.baseOptions;
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
160
|
+
const localVarHeaderParameter = {} as any;
|
|
161
|
+
const localVarQueryParameter = {} as any;
|
|
162
|
+
|
|
163
|
+
// authentication Basic required
|
|
164
|
+
// http basic authentication required
|
|
165
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
170
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
171
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
172
|
+
|
|
173
|
+
return {
|
|
174
|
+
url: toPathString(localVarUrlObj),
|
|
175
|
+
options: localVarRequestOptions,
|
|
176
|
+
};
|
|
177
|
+
},
|
|
178
|
+
/**
|
|
179
|
+
* Downloads the specified recording.
|
|
180
|
+
* @summary Download Recording
|
|
181
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
182
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
183
|
+
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
184
|
+
* @param {*} [options] Override http request option.
|
|
185
|
+
* @throws {RequiredError}
|
|
186
|
+
*/
|
|
187
|
+
downloadCallRecording: async (accountId: string, callId: string, recordingId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
188
|
+
// verify required parameter 'accountId' is not null or undefined
|
|
189
|
+
assertParamExists('downloadCallRecording', 'accountId', accountId)
|
|
190
|
+
// verify required parameter 'callId' is not null or undefined
|
|
191
|
+
assertParamExists('downloadCallRecording', 'callId', callId)
|
|
192
|
+
// verify required parameter 'recordingId' is not null or undefined
|
|
193
|
+
assertParamExists('downloadCallRecording', 'recordingId', recordingId)
|
|
194
|
+
const localVarPath = `/accounts/{accountId}/calls/{callId}/recordings/{recordingId}/media`
|
|
195
|
+
.replace(`{${"accountId"}}`, encodeURIComponent(String(accountId)))
|
|
196
|
+
.replace(`{${"callId"}}`, encodeURIComponent(String(callId)))
|
|
197
|
+
.replace(`{${"recordingId"}}`, encodeURIComponent(String(recordingId)));
|
|
198
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
199
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
200
|
+
let baseOptions;
|
|
201
|
+
if (configuration) {
|
|
202
|
+
baseOptions = configuration.baseOptions;
|
|
203
|
+
}
|
|
204
|
+
|
|
205
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
206
|
+
const localVarHeaderParameter = {} as any;
|
|
207
|
+
const localVarQueryParameter = {} as any;
|
|
208
|
+
|
|
209
|
+
// authentication Basic required
|
|
210
|
+
// http basic authentication required
|
|
211
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
216
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
217
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
218
|
+
|
|
219
|
+
return {
|
|
220
|
+
url: toPathString(localVarUrlObj),
|
|
221
|
+
options: localVarRequestOptions,
|
|
222
|
+
};
|
|
223
|
+
},
|
|
224
|
+
/**
|
|
225
|
+
* Returns metadata for the specified recording.
|
|
226
|
+
* @summary Get Call Recording
|
|
227
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
228
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
229
|
+
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
230
|
+
* @param {*} [options] Override http request option.
|
|
231
|
+
* @throws {RequiredError}
|
|
232
|
+
*/
|
|
233
|
+
getCallRecording: async (accountId: string, callId: string, recordingId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
234
|
+
// verify required parameter 'accountId' is not null or undefined
|
|
235
|
+
assertParamExists('getCallRecording', 'accountId', accountId)
|
|
236
|
+
// verify required parameter 'callId' is not null or undefined
|
|
237
|
+
assertParamExists('getCallRecording', 'callId', callId)
|
|
238
|
+
// verify required parameter 'recordingId' is not null or undefined
|
|
239
|
+
assertParamExists('getCallRecording', 'recordingId', recordingId)
|
|
240
|
+
const localVarPath = `/accounts/{accountId}/calls/{callId}/recordings/{recordingId}`
|
|
241
|
+
.replace(`{${"accountId"}}`, encodeURIComponent(String(accountId)))
|
|
242
|
+
.replace(`{${"callId"}}`, encodeURIComponent(String(callId)))
|
|
243
|
+
.replace(`{${"recordingId"}}`, encodeURIComponent(String(recordingId)));
|
|
244
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
245
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
246
|
+
let baseOptions;
|
|
247
|
+
if (configuration) {
|
|
248
|
+
baseOptions = configuration.baseOptions;
|
|
249
|
+
}
|
|
250
|
+
|
|
251
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
252
|
+
const localVarHeaderParameter = {} as any;
|
|
253
|
+
const localVarQueryParameter = {} as any;
|
|
254
|
+
|
|
255
|
+
// authentication Basic required
|
|
256
|
+
// http basic authentication required
|
|
257
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
262
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
263
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
264
|
+
|
|
265
|
+
return {
|
|
266
|
+
url: toPathString(localVarUrlObj),
|
|
267
|
+
options: localVarRequestOptions,
|
|
268
|
+
};
|
|
269
|
+
},
|
|
270
|
+
/**
|
|
271
|
+
* Downloads the specified transcription. If the transcribed recording was multi-channel, then there will be 2 transcripts. The caller/called party transcript will be the first item while [`<PlayAudio>`](/docs/voice/bxml/playAudio) and [`<SpeakSentence>`](/docs/voice/bxml/speakSentence) transcript will be the second item. During a [`<Transfer>`](/docs/voice/bxml/transfer) the A-leg transcript will be the first item while the B-leg transcript will be the second item.
|
|
272
|
+
* @summary Get Transcription
|
|
273
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
274
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
275
|
+
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
276
|
+
* @param {*} [options] Override http request option.
|
|
277
|
+
* @throws {RequiredError}
|
|
278
|
+
*/
|
|
279
|
+
getCallTranscription: async (accountId: string, callId: string, recordingId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
280
|
+
// verify required parameter 'accountId' is not null or undefined
|
|
281
|
+
assertParamExists('getCallTranscription', 'accountId', accountId)
|
|
282
|
+
// verify required parameter 'callId' is not null or undefined
|
|
283
|
+
assertParamExists('getCallTranscription', 'callId', callId)
|
|
284
|
+
// verify required parameter 'recordingId' is not null or undefined
|
|
285
|
+
assertParamExists('getCallTranscription', 'recordingId', recordingId)
|
|
286
|
+
const localVarPath = `/accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription`
|
|
287
|
+
.replace(`{${"accountId"}}`, encodeURIComponent(String(accountId)))
|
|
288
|
+
.replace(`{${"callId"}}`, encodeURIComponent(String(callId)))
|
|
289
|
+
.replace(`{${"recordingId"}}`, encodeURIComponent(String(recordingId)));
|
|
290
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
291
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
292
|
+
let baseOptions;
|
|
293
|
+
if (configuration) {
|
|
294
|
+
baseOptions = configuration.baseOptions;
|
|
295
|
+
}
|
|
296
|
+
|
|
297
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
298
|
+
const localVarHeaderParameter = {} as any;
|
|
299
|
+
const localVarQueryParameter = {} as any;
|
|
300
|
+
|
|
301
|
+
// authentication Basic required
|
|
302
|
+
// http basic authentication required
|
|
303
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
308
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
309
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
310
|
+
|
|
311
|
+
return {
|
|
312
|
+
url: toPathString(localVarUrlObj),
|
|
313
|
+
options: localVarRequestOptions,
|
|
314
|
+
};
|
|
315
|
+
},
|
|
316
|
+
/**
|
|
317
|
+
* Returns a list of metadata for the recordings associated with the specified account. The list can be filtered by the optional from, to, minStartTime, and maxStartTime arguments. The list is capped at 1000 entries and may be empty if no recordings match the specified criteria.
|
|
318
|
+
* @summary Get Call Recordings
|
|
319
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
320
|
+
* @param {string} [to] Filter results by the `to` field.
|
|
321
|
+
* @param {string} [from] Filter results by the `from` field.
|
|
322
|
+
* @param {string} [minStartTime] Filter results to recordings which have a `startTime` after or including `minStartTime` (in ISO8601 format).
|
|
323
|
+
* @param {string} [maxStartTime] Filter results to recordings which have a `startTime` before `maxStartTime` (in ISO8601 format).
|
|
324
|
+
* @param {*} [options] Override http request option.
|
|
325
|
+
* @throws {RequiredError}
|
|
326
|
+
*/
|
|
327
|
+
listAccountCallRecordings: async (accountId: string, to?: string, from?: string, minStartTime?: string, maxStartTime?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
328
|
+
// verify required parameter 'accountId' is not null or undefined
|
|
329
|
+
assertParamExists('listAccountCallRecordings', 'accountId', accountId)
|
|
330
|
+
const localVarPath = `/accounts/{accountId}/recordings`
|
|
331
|
+
.replace(`{${"accountId"}}`, encodeURIComponent(String(accountId)));
|
|
332
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
333
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
334
|
+
let baseOptions;
|
|
335
|
+
if (configuration) {
|
|
336
|
+
baseOptions = configuration.baseOptions;
|
|
337
|
+
}
|
|
338
|
+
|
|
339
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
340
|
+
const localVarHeaderParameter = {} as any;
|
|
341
|
+
const localVarQueryParameter = {} as any;
|
|
342
|
+
|
|
343
|
+
// authentication Basic required
|
|
344
|
+
// http basic authentication required
|
|
345
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
346
|
+
|
|
347
|
+
if (to !== undefined) {
|
|
348
|
+
localVarQueryParameter['to'] = to;
|
|
349
|
+
}
|
|
350
|
+
|
|
351
|
+
if (from !== undefined) {
|
|
352
|
+
localVarQueryParameter['from'] = from;
|
|
353
|
+
}
|
|
354
|
+
|
|
355
|
+
if (minStartTime !== undefined) {
|
|
356
|
+
localVarQueryParameter['minStartTime'] = minStartTime;
|
|
357
|
+
}
|
|
358
|
+
|
|
359
|
+
if (maxStartTime !== undefined) {
|
|
360
|
+
localVarQueryParameter['maxStartTime'] = maxStartTime;
|
|
361
|
+
}
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
366
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
367
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
368
|
+
|
|
369
|
+
return {
|
|
370
|
+
url: toPathString(localVarUrlObj),
|
|
371
|
+
options: localVarRequestOptions,
|
|
372
|
+
};
|
|
373
|
+
},
|
|
374
|
+
/**
|
|
375
|
+
* Returns a (potentially empty) list of metadata for the recordings that took place during the specified call.
|
|
376
|
+
* @summary List Call Recordings
|
|
377
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
378
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
379
|
+
* @param {*} [options] Override http request option.
|
|
380
|
+
* @throws {RequiredError}
|
|
381
|
+
*/
|
|
382
|
+
listCallRecordings: async (accountId: string, callId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
383
|
+
// verify required parameter 'accountId' is not null or undefined
|
|
384
|
+
assertParamExists('listCallRecordings', 'accountId', accountId)
|
|
385
|
+
// verify required parameter 'callId' is not null or undefined
|
|
386
|
+
assertParamExists('listCallRecordings', 'callId', callId)
|
|
387
|
+
const localVarPath = `/accounts/{accountId}/calls/{callId}/recordings`
|
|
388
|
+
.replace(`{${"accountId"}}`, encodeURIComponent(String(accountId)))
|
|
389
|
+
.replace(`{${"callId"}}`, encodeURIComponent(String(callId)));
|
|
390
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
391
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
392
|
+
let baseOptions;
|
|
393
|
+
if (configuration) {
|
|
394
|
+
baseOptions = configuration.baseOptions;
|
|
395
|
+
}
|
|
396
|
+
|
|
397
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
398
|
+
const localVarHeaderParameter = {} as any;
|
|
399
|
+
const localVarQueryParameter = {} as any;
|
|
400
|
+
|
|
401
|
+
// authentication Basic required
|
|
402
|
+
// http basic authentication required
|
|
403
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
408
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
409
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
410
|
+
|
|
411
|
+
return {
|
|
412
|
+
url: toPathString(localVarUrlObj),
|
|
413
|
+
options: localVarRequestOptions,
|
|
414
|
+
};
|
|
415
|
+
},
|
|
416
|
+
/**
|
|
417
|
+
* Generate the transcription for a specific recording. Transcription can succeed only for recordings of length greater than 500 milliseconds and less than 4 hours.
|
|
418
|
+
* @summary Create Transcription Request
|
|
419
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
420
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
421
|
+
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
422
|
+
* @param {TranscribeRecording} transcribeRecording
|
|
423
|
+
* @param {*} [options] Override http request option.
|
|
424
|
+
* @throws {RequiredError}
|
|
425
|
+
*/
|
|
426
|
+
transcribeCallRecording: async (accountId: string, callId: string, recordingId: string, transcribeRecording: TranscribeRecording, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
427
|
+
// verify required parameter 'accountId' is not null or undefined
|
|
428
|
+
assertParamExists('transcribeCallRecording', 'accountId', accountId)
|
|
429
|
+
// verify required parameter 'callId' is not null or undefined
|
|
430
|
+
assertParamExists('transcribeCallRecording', 'callId', callId)
|
|
431
|
+
// verify required parameter 'recordingId' is not null or undefined
|
|
432
|
+
assertParamExists('transcribeCallRecording', 'recordingId', recordingId)
|
|
433
|
+
// verify required parameter 'transcribeRecording' is not null or undefined
|
|
434
|
+
assertParamExists('transcribeCallRecording', 'transcribeRecording', transcribeRecording)
|
|
435
|
+
const localVarPath = `/accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription`
|
|
436
|
+
.replace(`{${"accountId"}}`, encodeURIComponent(String(accountId)))
|
|
437
|
+
.replace(`{${"callId"}}`, encodeURIComponent(String(callId)))
|
|
438
|
+
.replace(`{${"recordingId"}}`, encodeURIComponent(String(recordingId)));
|
|
439
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
440
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
441
|
+
let baseOptions;
|
|
442
|
+
if (configuration) {
|
|
443
|
+
baseOptions = configuration.baseOptions;
|
|
444
|
+
}
|
|
445
|
+
|
|
446
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
447
|
+
const localVarHeaderParameter = {} as any;
|
|
448
|
+
const localVarQueryParameter = {} as any;
|
|
449
|
+
|
|
450
|
+
// authentication Basic required
|
|
451
|
+
// http basic authentication required
|
|
452
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
457
|
+
|
|
458
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
459
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
460
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
461
|
+
localVarRequestOptions.data = serializeDataIfNeeded(transcribeRecording, localVarRequestOptions, configuration)
|
|
462
|
+
|
|
463
|
+
return {
|
|
464
|
+
url: toPathString(localVarUrlObj),
|
|
465
|
+
options: localVarRequestOptions,
|
|
466
|
+
};
|
|
467
|
+
},
|
|
468
|
+
/**
|
|
469
|
+
* Pause or resume a recording on an active phone call.
|
|
470
|
+
* @summary Update Recording
|
|
471
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
472
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
473
|
+
* @param {UpdateCallRecording} updateCallRecording
|
|
474
|
+
* @param {*} [options] Override http request option.
|
|
475
|
+
* @throws {RequiredError}
|
|
476
|
+
*/
|
|
477
|
+
updateCallRecordingState: async (accountId: string, callId: string, updateCallRecording: UpdateCallRecording, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
478
|
+
// verify required parameter 'accountId' is not null or undefined
|
|
479
|
+
assertParamExists('updateCallRecordingState', 'accountId', accountId)
|
|
480
|
+
// verify required parameter 'callId' is not null or undefined
|
|
481
|
+
assertParamExists('updateCallRecordingState', 'callId', callId)
|
|
482
|
+
// verify required parameter 'updateCallRecording' is not null or undefined
|
|
483
|
+
assertParamExists('updateCallRecordingState', 'updateCallRecording', updateCallRecording)
|
|
484
|
+
const localVarPath = `/accounts/{accountId}/calls/{callId}/recording`
|
|
485
|
+
.replace(`{${"accountId"}}`, encodeURIComponent(String(accountId)))
|
|
486
|
+
.replace(`{${"callId"}}`, encodeURIComponent(String(callId)));
|
|
487
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
488
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
489
|
+
let baseOptions;
|
|
490
|
+
if (configuration) {
|
|
491
|
+
baseOptions = configuration.baseOptions;
|
|
492
|
+
}
|
|
493
|
+
|
|
494
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
495
|
+
const localVarHeaderParameter = {} as any;
|
|
496
|
+
const localVarQueryParameter = {} as any;
|
|
497
|
+
|
|
498
|
+
// authentication Basic required
|
|
499
|
+
// http basic authentication required
|
|
500
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
505
|
+
|
|
506
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
507
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
508
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
509
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateCallRecording, localVarRequestOptions, configuration)
|
|
510
|
+
|
|
511
|
+
return {
|
|
512
|
+
url: toPathString(localVarUrlObj),
|
|
513
|
+
options: localVarRequestOptions,
|
|
514
|
+
};
|
|
515
|
+
},
|
|
516
|
+
}
|
|
517
|
+
};
|
|
518
|
+
|
|
519
|
+
/**
|
|
520
|
+
* RecordingsApi - functional programming interface
|
|
521
|
+
* @export
|
|
522
|
+
*/
|
|
523
|
+
export const RecordingsApiFp = function(configuration?: Configuration) {
|
|
524
|
+
const localVarAxiosParamCreator = RecordingsApiAxiosParamCreator(configuration)
|
|
525
|
+
return {
|
|
526
|
+
/**
|
|
527
|
+
* Deletes the specified recording\'s transcription. Note: After the deletion is requested and a `204` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
|
|
528
|
+
* @summary Delete Transcription
|
|
529
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
530
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
531
|
+
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
532
|
+
* @param {*} [options] Override http request option.
|
|
533
|
+
* @throws {RequiredError}
|
|
534
|
+
*/
|
|
535
|
+
async deleteCallTranscription(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
536
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCallTranscription(accountId, callId, recordingId, options);
|
|
537
|
+
const index = configuration?.serverIndex ?? 0;
|
|
538
|
+
const operationBasePath = operationServerMap['RecordingsApi.deleteCallTranscription']?.[index]?.url;
|
|
539
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
|
|
540
|
+
},
|
|
541
|
+
/**
|
|
542
|
+
* Delete the recording information, media and transcription. Note: After the deletion is requested and a `204` is returned, neither the recording metadata nor the actual media nor its transcription will be accessible anymore. However, the media of the specified recording is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
|
|
543
|
+
* @summary Delete Recording
|
|
544
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
545
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
546
|
+
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
547
|
+
* @param {*} [options] Override http request option.
|
|
548
|
+
* @throws {RequiredError}
|
|
549
|
+
*/
|
|
550
|
+
async deleteRecording(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
551
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteRecording(accountId, callId, recordingId, options);
|
|
552
|
+
const index = configuration?.serverIndex ?? 0;
|
|
553
|
+
const operationBasePath = operationServerMap['RecordingsApi.deleteRecording']?.[index]?.url;
|
|
554
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
|
|
555
|
+
},
|
|
556
|
+
/**
|
|
557
|
+
* Deletes the specified recording\'s media.
|
|
558
|
+
* @summary Delete Recording Media
|
|
559
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
560
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
561
|
+
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
562
|
+
* @param {*} [options] Override http request option.
|
|
563
|
+
* @throws {RequiredError}
|
|
564
|
+
*/
|
|
565
|
+
async deleteRecordingMedia(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
566
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteRecordingMedia(accountId, callId, recordingId, options);
|
|
567
|
+
const index = configuration?.serverIndex ?? 0;
|
|
568
|
+
const operationBasePath = operationServerMap['RecordingsApi.deleteRecordingMedia']?.[index]?.url;
|
|
569
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
|
|
570
|
+
},
|
|
571
|
+
/**
|
|
572
|
+
* Downloads the specified recording.
|
|
573
|
+
* @summary Download Recording
|
|
574
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
575
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
576
|
+
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
577
|
+
* @param {*} [options] Override http request option.
|
|
578
|
+
* @throws {RequiredError}
|
|
579
|
+
*/
|
|
580
|
+
async downloadCallRecording(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
581
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.downloadCallRecording(accountId, callId, recordingId, options);
|
|
582
|
+
const index = configuration?.serverIndex ?? 0;
|
|
583
|
+
const operationBasePath = operationServerMap['RecordingsApi.downloadCallRecording']?.[index]?.url;
|
|
584
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
|
|
585
|
+
},
|
|
586
|
+
/**
|
|
587
|
+
* Returns metadata for the specified recording.
|
|
588
|
+
* @summary Get Call Recording
|
|
589
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
590
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
591
|
+
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
592
|
+
* @param {*} [options] Override http request option.
|
|
593
|
+
* @throws {RequiredError}
|
|
594
|
+
*/
|
|
595
|
+
async getCallRecording(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CallRecordingMetadata>> {
|
|
596
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getCallRecording(accountId, callId, recordingId, options);
|
|
597
|
+
const index = configuration?.serverIndex ?? 0;
|
|
598
|
+
const operationBasePath = operationServerMap['RecordingsApi.getCallRecording']?.[index]?.url;
|
|
599
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
|
|
600
|
+
},
|
|
601
|
+
/**
|
|
602
|
+
* Downloads the specified transcription. If the transcribed recording was multi-channel, then there will be 2 transcripts. The caller/called party transcript will be the first item while [`<PlayAudio>`](/docs/voice/bxml/playAudio) and [`<SpeakSentence>`](/docs/voice/bxml/speakSentence) transcript will be the second item. During a [`<Transfer>`](/docs/voice/bxml/transfer) the A-leg transcript will be the first item while the B-leg transcript will be the second item.
|
|
603
|
+
* @summary Get Transcription
|
|
604
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
605
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
606
|
+
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
607
|
+
* @param {*} [options] Override http request option.
|
|
608
|
+
* @throws {RequiredError}
|
|
609
|
+
*/
|
|
610
|
+
async getCallTranscription(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TranscriptionList>> {
|
|
611
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getCallTranscription(accountId, callId, recordingId, options);
|
|
612
|
+
const index = configuration?.serverIndex ?? 0;
|
|
613
|
+
const operationBasePath = operationServerMap['RecordingsApi.getCallTranscription']?.[index]?.url;
|
|
614
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
|
|
615
|
+
},
|
|
616
|
+
/**
|
|
617
|
+
* Returns a list of metadata for the recordings associated with the specified account. The list can be filtered by the optional from, to, minStartTime, and maxStartTime arguments. The list is capped at 1000 entries and may be empty if no recordings match the specified criteria.
|
|
618
|
+
* @summary Get Call Recordings
|
|
619
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
620
|
+
* @param {string} [to] Filter results by the `to` field.
|
|
621
|
+
* @param {string} [from] Filter results by the `from` field.
|
|
622
|
+
* @param {string} [minStartTime] Filter results to recordings which have a `startTime` after or including `minStartTime` (in ISO8601 format).
|
|
623
|
+
* @param {string} [maxStartTime] Filter results to recordings which have a `startTime` before `maxStartTime` (in ISO8601 format).
|
|
624
|
+
* @param {*} [options] Override http request option.
|
|
625
|
+
* @throws {RequiredError}
|
|
626
|
+
*/
|
|
627
|
+
async listAccountCallRecordings(accountId: string, to?: string, from?: string, minStartTime?: string, maxStartTime?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CallRecordingMetadata>>> {
|
|
628
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listAccountCallRecordings(accountId, to, from, minStartTime, maxStartTime, options);
|
|
629
|
+
const index = configuration?.serverIndex ?? 0;
|
|
630
|
+
const operationBasePath = operationServerMap['RecordingsApi.listAccountCallRecordings']?.[index]?.url;
|
|
631
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
|
|
632
|
+
},
|
|
633
|
+
/**
|
|
634
|
+
* Returns a (potentially empty) list of metadata for the recordings that took place during the specified call.
|
|
635
|
+
* @summary List Call Recordings
|
|
636
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
637
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
638
|
+
* @param {*} [options] Override http request option.
|
|
639
|
+
* @throws {RequiredError}
|
|
640
|
+
*/
|
|
641
|
+
async listCallRecordings(accountId: string, callId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CallRecordingMetadata>>> {
|
|
642
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listCallRecordings(accountId, callId, options);
|
|
643
|
+
const index = configuration?.serverIndex ?? 0;
|
|
644
|
+
const operationBasePath = operationServerMap['RecordingsApi.listCallRecordings']?.[index]?.url;
|
|
645
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
|
|
646
|
+
},
|
|
647
|
+
/**
|
|
648
|
+
* Generate the transcription for a specific recording. Transcription can succeed only for recordings of length greater than 500 milliseconds and less than 4 hours.
|
|
649
|
+
* @summary Create Transcription Request
|
|
650
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
651
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
652
|
+
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
653
|
+
* @param {TranscribeRecording} transcribeRecording
|
|
654
|
+
* @param {*} [options] Override http request option.
|
|
655
|
+
* @throws {RequiredError}
|
|
656
|
+
*/
|
|
657
|
+
async transcribeCallRecording(accountId: string, callId: string, recordingId: string, transcribeRecording: TranscribeRecording, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
658
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.transcribeCallRecording(accountId, callId, recordingId, transcribeRecording, options);
|
|
659
|
+
const index = configuration?.serverIndex ?? 0;
|
|
660
|
+
const operationBasePath = operationServerMap['RecordingsApi.transcribeCallRecording']?.[index]?.url;
|
|
661
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
|
|
662
|
+
},
|
|
663
|
+
/**
|
|
664
|
+
* Pause or resume a recording on an active phone call.
|
|
665
|
+
* @summary Update Recording
|
|
666
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
667
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
668
|
+
* @param {UpdateCallRecording} updateCallRecording
|
|
669
|
+
* @param {*} [options] Override http request option.
|
|
670
|
+
* @throws {RequiredError}
|
|
671
|
+
*/
|
|
672
|
+
async updateCallRecordingState(accountId: string, callId: string, updateCallRecording: UpdateCallRecording, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
673
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateCallRecordingState(accountId, callId, updateCallRecording, options);
|
|
674
|
+
const index = configuration?.serverIndex ?? 0;
|
|
675
|
+
const operationBasePath = operationServerMap['RecordingsApi.updateCallRecordingState']?.[index]?.url;
|
|
676
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
|
|
677
|
+
},
|
|
678
|
+
}
|
|
679
|
+
};
|
|
680
|
+
|
|
681
|
+
/**
|
|
682
|
+
* RecordingsApi - factory interface
|
|
683
|
+
* @export
|
|
684
|
+
*/
|
|
685
|
+
export const RecordingsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
686
|
+
const localVarFp = RecordingsApiFp(configuration)
|
|
687
|
+
return {
|
|
688
|
+
/**
|
|
689
|
+
* Deletes the specified recording\'s transcription. Note: After the deletion is requested and a `204` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
|
|
690
|
+
* @summary Delete Transcription
|
|
691
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
692
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
693
|
+
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
694
|
+
* @param {*} [options] Override http request option.
|
|
695
|
+
* @throws {RequiredError}
|
|
696
|
+
*/
|
|
697
|
+
deleteCallTranscription(accountId: string, callId: string, recordingId: string, options?: any): AxiosPromise<void> {
|
|
698
|
+
return localVarFp.deleteCallTranscription(accountId, callId, recordingId, options).then((request) => request(axios, basePath));
|
|
699
|
+
},
|
|
700
|
+
/**
|
|
701
|
+
* Delete the recording information, media and transcription. Note: After the deletion is requested and a `204` is returned, neither the recording metadata nor the actual media nor its transcription will be accessible anymore. However, the media of the specified recording is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
|
|
702
|
+
* @summary Delete Recording
|
|
703
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
704
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
705
|
+
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
706
|
+
* @param {*} [options] Override http request option.
|
|
707
|
+
* @throws {RequiredError}
|
|
708
|
+
*/
|
|
709
|
+
deleteRecording(accountId: string, callId: string, recordingId: string, options?: any): AxiosPromise<void> {
|
|
710
|
+
return localVarFp.deleteRecording(accountId, callId, recordingId, options).then((request) => request(axios, basePath));
|
|
711
|
+
},
|
|
712
|
+
/**
|
|
713
|
+
* Deletes the specified recording\'s media.
|
|
714
|
+
* @summary Delete Recording Media
|
|
715
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
716
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
717
|
+
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
718
|
+
* @param {*} [options] Override http request option.
|
|
719
|
+
* @throws {RequiredError}
|
|
720
|
+
*/
|
|
721
|
+
deleteRecordingMedia(accountId: string, callId: string, recordingId: string, options?: any): AxiosPromise<void> {
|
|
722
|
+
return localVarFp.deleteRecordingMedia(accountId, callId, recordingId, options).then((request) => request(axios, basePath));
|
|
723
|
+
},
|
|
724
|
+
/**
|
|
725
|
+
* Downloads the specified recording.
|
|
726
|
+
* @summary Download Recording
|
|
727
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
728
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
729
|
+
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
730
|
+
* @param {*} [options] Override http request option.
|
|
731
|
+
* @throws {RequiredError}
|
|
732
|
+
*/
|
|
733
|
+
downloadCallRecording(accountId: string, callId: string, recordingId: string, options?: any): AxiosPromise<File> {
|
|
734
|
+
return localVarFp.downloadCallRecording(accountId, callId, recordingId, options).then((request) => request(axios, basePath));
|
|
735
|
+
},
|
|
736
|
+
/**
|
|
737
|
+
* Returns metadata for the specified recording.
|
|
738
|
+
* @summary Get Call Recording
|
|
739
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
740
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
741
|
+
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
742
|
+
* @param {*} [options] Override http request option.
|
|
743
|
+
* @throws {RequiredError}
|
|
744
|
+
*/
|
|
745
|
+
getCallRecording(accountId: string, callId: string, recordingId: string, options?: any): AxiosPromise<CallRecordingMetadata> {
|
|
746
|
+
return localVarFp.getCallRecording(accountId, callId, recordingId, options).then((request) => request(axios, basePath));
|
|
747
|
+
},
|
|
748
|
+
/**
|
|
749
|
+
* Downloads the specified transcription. If the transcribed recording was multi-channel, then there will be 2 transcripts. The caller/called party transcript will be the first item while [`<PlayAudio>`](/docs/voice/bxml/playAudio) and [`<SpeakSentence>`](/docs/voice/bxml/speakSentence) transcript will be the second item. During a [`<Transfer>`](/docs/voice/bxml/transfer) the A-leg transcript will be the first item while the B-leg transcript will be the second item.
|
|
750
|
+
* @summary Get Transcription
|
|
751
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
752
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
753
|
+
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
754
|
+
* @param {*} [options] Override http request option.
|
|
755
|
+
* @throws {RequiredError}
|
|
756
|
+
*/
|
|
757
|
+
getCallTranscription(accountId: string, callId: string, recordingId: string, options?: any): AxiosPromise<TranscriptionList> {
|
|
758
|
+
return localVarFp.getCallTranscription(accountId, callId, recordingId, options).then((request) => request(axios, basePath));
|
|
759
|
+
},
|
|
760
|
+
/**
|
|
761
|
+
* Returns a list of metadata for the recordings associated with the specified account. The list can be filtered by the optional from, to, minStartTime, and maxStartTime arguments. The list is capped at 1000 entries and may be empty if no recordings match the specified criteria.
|
|
762
|
+
* @summary Get Call Recordings
|
|
763
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
764
|
+
* @param {string} [to] Filter results by the `to` field.
|
|
765
|
+
* @param {string} [from] Filter results by the `from` field.
|
|
766
|
+
* @param {string} [minStartTime] Filter results to recordings which have a `startTime` after or including `minStartTime` (in ISO8601 format).
|
|
767
|
+
* @param {string} [maxStartTime] Filter results to recordings which have a `startTime` before `maxStartTime` (in ISO8601 format).
|
|
768
|
+
* @param {*} [options] Override http request option.
|
|
769
|
+
* @throws {RequiredError}
|
|
770
|
+
*/
|
|
771
|
+
listAccountCallRecordings(accountId: string, to?: string, from?: string, minStartTime?: string, maxStartTime?: string, options?: any): AxiosPromise<Array<CallRecordingMetadata>> {
|
|
772
|
+
return localVarFp.listAccountCallRecordings(accountId, to, from, minStartTime, maxStartTime, options).then((request) => request(axios, basePath));
|
|
773
|
+
},
|
|
774
|
+
/**
|
|
775
|
+
* Returns a (potentially empty) list of metadata for the recordings that took place during the specified call.
|
|
776
|
+
* @summary List Call Recordings
|
|
777
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
778
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
779
|
+
* @param {*} [options] Override http request option.
|
|
780
|
+
* @throws {RequiredError}
|
|
781
|
+
*/
|
|
782
|
+
listCallRecordings(accountId: string, callId: string, options?: any): AxiosPromise<Array<CallRecordingMetadata>> {
|
|
783
|
+
return localVarFp.listCallRecordings(accountId, callId, options).then((request) => request(axios, basePath));
|
|
784
|
+
},
|
|
785
|
+
/**
|
|
786
|
+
* Generate the transcription for a specific recording. Transcription can succeed only for recordings of length greater than 500 milliseconds and less than 4 hours.
|
|
787
|
+
* @summary Create Transcription Request
|
|
788
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
789
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
790
|
+
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
791
|
+
* @param {TranscribeRecording} transcribeRecording
|
|
792
|
+
* @param {*} [options] Override http request option.
|
|
793
|
+
* @throws {RequiredError}
|
|
794
|
+
*/
|
|
795
|
+
transcribeCallRecording(accountId: string, callId: string, recordingId: string, transcribeRecording: TranscribeRecording, options?: any): AxiosPromise<void> {
|
|
796
|
+
return localVarFp.transcribeCallRecording(accountId, callId, recordingId, transcribeRecording, options).then((request) => request(axios, basePath));
|
|
797
|
+
},
|
|
798
|
+
/**
|
|
799
|
+
* Pause or resume a recording on an active phone call.
|
|
800
|
+
* @summary Update Recording
|
|
801
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
802
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
803
|
+
* @param {UpdateCallRecording} updateCallRecording
|
|
804
|
+
* @param {*} [options] Override http request option.
|
|
805
|
+
* @throws {RequiredError}
|
|
806
|
+
*/
|
|
807
|
+
updateCallRecordingState(accountId: string, callId: string, updateCallRecording: UpdateCallRecording, options?: any): AxiosPromise<void> {
|
|
808
|
+
return localVarFp.updateCallRecordingState(accountId, callId, updateCallRecording, options).then((request) => request(axios, basePath));
|
|
809
|
+
},
|
|
810
|
+
};
|
|
811
|
+
};
|
|
812
|
+
|
|
813
|
+
/**
|
|
814
|
+
* RecordingsApi - object-oriented interface
|
|
815
|
+
* @export
|
|
816
|
+
* @class RecordingsApi
|
|
817
|
+
* @extends {BaseAPI}
|
|
818
|
+
*/
|
|
819
|
+
export class RecordingsApi extends BaseAPI {
|
|
820
|
+
/**
|
|
821
|
+
* Deletes the specified recording\'s transcription. Note: After the deletion is requested and a `204` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
|
|
822
|
+
* @summary Delete Transcription
|
|
823
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
824
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
825
|
+
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
826
|
+
* @param {*} [options] Override http request option.
|
|
827
|
+
* @throws {RequiredError}
|
|
828
|
+
* @memberof RecordingsApi
|
|
829
|
+
*/
|
|
830
|
+
public deleteCallTranscription(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig) {
|
|
831
|
+
return RecordingsApiFp(this.configuration).deleteCallTranscription(accountId, callId, recordingId, options).then((request) => request(this.axios, this.basePath));
|
|
832
|
+
}
|
|
833
|
+
|
|
834
|
+
/**
|
|
835
|
+
* Delete the recording information, media and transcription. Note: After the deletion is requested and a `204` is returned, neither the recording metadata nor the actual media nor its transcription will be accessible anymore. However, the media of the specified recording is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
|
|
836
|
+
* @summary Delete Recording
|
|
837
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
838
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
839
|
+
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
840
|
+
* @param {*} [options] Override http request option.
|
|
841
|
+
* @throws {RequiredError}
|
|
842
|
+
* @memberof RecordingsApi
|
|
843
|
+
*/
|
|
844
|
+
public deleteRecording(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig) {
|
|
845
|
+
return RecordingsApiFp(this.configuration).deleteRecording(accountId, callId, recordingId, options).then((request) => request(this.axios, this.basePath));
|
|
846
|
+
}
|
|
847
|
+
|
|
848
|
+
/**
|
|
849
|
+
* Deletes the specified recording\'s media.
|
|
850
|
+
* @summary Delete Recording Media
|
|
851
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
852
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
853
|
+
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
854
|
+
* @param {*} [options] Override http request option.
|
|
855
|
+
* @throws {RequiredError}
|
|
856
|
+
* @memberof RecordingsApi
|
|
857
|
+
*/
|
|
858
|
+
public deleteRecordingMedia(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig) {
|
|
859
|
+
return RecordingsApiFp(this.configuration).deleteRecordingMedia(accountId, callId, recordingId, options).then((request) => request(this.axios, this.basePath));
|
|
860
|
+
}
|
|
861
|
+
|
|
862
|
+
/**
|
|
863
|
+
* Downloads the specified recording.
|
|
864
|
+
* @summary Download Recording
|
|
865
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
866
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
867
|
+
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
868
|
+
* @param {*} [options] Override http request option.
|
|
869
|
+
* @throws {RequiredError}
|
|
870
|
+
* @memberof RecordingsApi
|
|
871
|
+
*/
|
|
872
|
+
public downloadCallRecording(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig) {
|
|
873
|
+
return RecordingsApiFp(this.configuration).downloadCallRecording(accountId, callId, recordingId, options).then((request) => request(this.axios, this.basePath));
|
|
874
|
+
}
|
|
875
|
+
|
|
876
|
+
/**
|
|
877
|
+
* Returns metadata for the specified recording.
|
|
878
|
+
* @summary Get Call Recording
|
|
879
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
880
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
881
|
+
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
882
|
+
* @param {*} [options] Override http request option.
|
|
883
|
+
* @throws {RequiredError}
|
|
884
|
+
* @memberof RecordingsApi
|
|
885
|
+
*/
|
|
886
|
+
public getCallRecording(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig) {
|
|
887
|
+
return RecordingsApiFp(this.configuration).getCallRecording(accountId, callId, recordingId, options).then((request) => request(this.axios, this.basePath));
|
|
888
|
+
}
|
|
889
|
+
|
|
890
|
+
/**
|
|
891
|
+
* Downloads the specified transcription. If the transcribed recording was multi-channel, then there will be 2 transcripts. The caller/called party transcript will be the first item while [`<PlayAudio>`](/docs/voice/bxml/playAudio) and [`<SpeakSentence>`](/docs/voice/bxml/speakSentence) transcript will be the second item. During a [`<Transfer>`](/docs/voice/bxml/transfer) the A-leg transcript will be the first item while the B-leg transcript will be the second item.
|
|
892
|
+
* @summary Get Transcription
|
|
893
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
894
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
895
|
+
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
896
|
+
* @param {*} [options] Override http request option.
|
|
897
|
+
* @throws {RequiredError}
|
|
898
|
+
* @memberof RecordingsApi
|
|
899
|
+
*/
|
|
900
|
+
public getCallTranscription(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig) {
|
|
901
|
+
return RecordingsApiFp(this.configuration).getCallTranscription(accountId, callId, recordingId, options).then((request) => request(this.axios, this.basePath));
|
|
902
|
+
}
|
|
903
|
+
|
|
904
|
+
/**
|
|
905
|
+
* Returns a list of metadata for the recordings associated with the specified account. The list can be filtered by the optional from, to, minStartTime, and maxStartTime arguments. The list is capped at 1000 entries and may be empty if no recordings match the specified criteria.
|
|
906
|
+
* @summary Get Call Recordings
|
|
907
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
908
|
+
* @param {string} [to] Filter results by the `to` field.
|
|
909
|
+
* @param {string} [from] Filter results by the `from` field.
|
|
910
|
+
* @param {string} [minStartTime] Filter results to recordings which have a `startTime` after or including `minStartTime` (in ISO8601 format).
|
|
911
|
+
* @param {string} [maxStartTime] Filter results to recordings which have a `startTime` before `maxStartTime` (in ISO8601 format).
|
|
912
|
+
* @param {*} [options] Override http request option.
|
|
913
|
+
* @throws {RequiredError}
|
|
914
|
+
* @memberof RecordingsApi
|
|
915
|
+
*/
|
|
916
|
+
public listAccountCallRecordings(accountId: string, to?: string, from?: string, minStartTime?: string, maxStartTime?: string, options?: AxiosRequestConfig) {
|
|
917
|
+
return RecordingsApiFp(this.configuration).listAccountCallRecordings(accountId, to, from, minStartTime, maxStartTime, options).then((request) => request(this.axios, this.basePath));
|
|
918
|
+
}
|
|
919
|
+
|
|
920
|
+
/**
|
|
921
|
+
* Returns a (potentially empty) list of metadata for the recordings that took place during the specified call.
|
|
922
|
+
* @summary List Call Recordings
|
|
923
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
924
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
925
|
+
* @param {*} [options] Override http request option.
|
|
926
|
+
* @throws {RequiredError}
|
|
927
|
+
* @memberof RecordingsApi
|
|
928
|
+
*/
|
|
929
|
+
public listCallRecordings(accountId: string, callId: string, options?: AxiosRequestConfig) {
|
|
930
|
+
return RecordingsApiFp(this.configuration).listCallRecordings(accountId, callId, options).then((request) => request(this.axios, this.basePath));
|
|
931
|
+
}
|
|
932
|
+
|
|
933
|
+
/**
|
|
934
|
+
* Generate the transcription for a specific recording. Transcription can succeed only for recordings of length greater than 500 milliseconds and less than 4 hours.
|
|
935
|
+
* @summary Create Transcription Request
|
|
936
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
937
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
938
|
+
* @param {string} recordingId Programmable Voice API Recording ID.
|
|
939
|
+
* @param {TranscribeRecording} transcribeRecording
|
|
940
|
+
* @param {*} [options] Override http request option.
|
|
941
|
+
* @throws {RequiredError}
|
|
942
|
+
* @memberof RecordingsApi
|
|
943
|
+
*/
|
|
944
|
+
public transcribeCallRecording(accountId: string, callId: string, recordingId: string, transcribeRecording: TranscribeRecording, options?: AxiosRequestConfig) {
|
|
945
|
+
return RecordingsApiFp(this.configuration).transcribeCallRecording(accountId, callId, recordingId, transcribeRecording, options).then((request) => request(this.axios, this.basePath));
|
|
946
|
+
}
|
|
947
|
+
|
|
948
|
+
/**
|
|
949
|
+
* Pause or resume a recording on an active phone call.
|
|
950
|
+
* @summary Update Recording
|
|
951
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
952
|
+
* @param {string} callId Programmable Voice API Call ID.
|
|
953
|
+
* @param {UpdateCallRecording} updateCallRecording
|
|
954
|
+
* @param {*} [options] Override http request option.
|
|
955
|
+
* @throws {RequiredError}
|
|
956
|
+
* @memberof RecordingsApi
|
|
957
|
+
*/
|
|
958
|
+
public updateCallRecordingState(accountId: string, callId: string, updateCallRecording: UpdateCallRecording, options?: AxiosRequestConfig) {
|
|
959
|
+
return RecordingsApiFp(this.configuration).updateCallRecordingState(accountId, callId, updateCallRecording, options).then((request) => request(this.axios, this.basePath));
|
|
960
|
+
}
|
|
961
|
+
}
|
|
962
|
+
|