bandwidth-sdk 6.2.1 → 7.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/deploy.yml +2 -2
- package/.github/workflows/test-pr.yml +2 -2
- package/.github/workflows/test-smoke.yml +4 -4
- package/.openapi-generator/FILES +34 -10
- package/.openapi-generator/VERSION +1 -1
- package/README.md +245 -6
- package/api/calls-api.ts +0 -11
- package/api/conferences-api.ts +0 -15
- package/api/media-api.ts +0 -10
- package/api/messages-api.ts +0 -8
- package/api/mfaapi.ts +0 -9
- package/api/multi-channel-api.ts +0 -7
- package/api/phone-number-lookup-api.ts +145 -76
- package/api/recordings-api.ts +0 -16
- package/api/statistics-api.ts +0 -7
- package/api/toll-free-verification-api.ts +0 -15
- package/api/transcriptions-api.ts +0 -9
- package/bandwidth.yml +551 -277
- package/base.ts +10 -28
- package/common.ts +5 -42
- package/configuration.ts +26 -20
- package/coverage/clover.xml +1332 -1279
- package/coverage/coverage-final.json +49 -45
- package/coverage/lcov-report/index.html +25 -25
- package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +2 -35
- package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +2 -47
- package/coverage/lcov-report/node-sdk/api/index.html +17 -17
- package/coverage/lcov-report/node-sdk/api/media-api.ts.html +2 -32
- package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +2 -26
- package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +2 -29
- package/coverage/lcov-report/node-sdk/api/multi-channel-api.ts.html +2 -23
- package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +338 -131
- package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +2 -50
- package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +2 -23
- package/coverage/lcov-report/node-sdk/api/toll-free-verification-api.ts.html +2 -47
- package/coverage/lcov-report/node-sdk/api/transcriptions-api.ts.html +2 -29
- package/coverage/lcov-report/node-sdk/api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/base.ts.html +19 -73
- package/coverage/lcov-report/node-sdk/common.ts.html +25 -136
- package/coverage/lcov-report/node-sdk/configuration.ts.html +52 -34
- package/coverage/lcov-report/node-sdk/index.html +7 -7
- package/coverage/lcov-report/node-sdk/models/business-entity-type-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/business-registration-type-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/bxml/Bxml.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/NestableVerb.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/Response.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/Root.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/Verb.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/index.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/index.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Bridge.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Conference.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/CustomParam.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Forward.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Gather.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Hangup.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Pause.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PauseRecording.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PhoneNumber.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PlayAudio.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Record.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Redirect.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/ResumeRecording.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Ring.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SendDtmf.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SipUri.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SpeakSentence.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartGather.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartRecording.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartStream.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartTranscription.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopGather.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopRecording.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopStream.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopTranscription.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StreamParam.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Tag.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Transfer.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/call-direction-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/call-state-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/call-transcription-detected-language-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/call-transcription-track-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/callback-method-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/card-width-enum.ts.html +2 -17
- package/coverage/lcov-report/node-sdk/models/completed-lookup-status-enum.ts.html +166 -0
- package/coverage/lcov-report/node-sdk/models/conference-state-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/deactivation-event-enum.ts.html +169 -0
- package/coverage/lcov-report/node-sdk/models/file-format-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/in-progress-lookup-status-enum.ts.html +169 -0
- package/coverage/lcov-report/node-sdk/models/inbound-callback-type-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/index.html +67 -7
- package/coverage/lcov-report/node-sdk/models/index.ts.html +45 -9
- package/coverage/lcov-report/node-sdk/models/{lookup-status-enum.ts.html → latest-message-delivery-status-enum.ts.html} +10 -19
- package/coverage/lcov-report/node-sdk/models/line-type-enum.ts.html +169 -0
- package/coverage/lcov-report/node-sdk/models/list-message-direction-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/machine-detection-mode-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/message-direction-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/message-status-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/message-type-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/multi-channel-message-channel-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/priority-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/product-type-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/rbm-action-type-enum.ts.html +2 -17
- package/coverage/lcov-report/node-sdk/models/rbm-media-height-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/recording-state-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/redirect-method-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/standalone-card-orientation-enum.ts.html +2 -17
- package/coverage/lcov-report/node-sdk/models/status-callback-type-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/tfv-callback-status-enum.ts.html +2 -17
- package/coverage/lcov-report/node-sdk/models/tfv-status-enum.ts.html +2 -17
- package/coverage/lcov-report/node-sdk/models/thumbnail-alignment-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/webhook-subscription-type-enum.ts.html +2 -17
- package/coverage/lcov.info +2940 -2824
- package/custom_templates/README.mustache +56 -6
- package/custom_templates/common.mustache +29 -44
- package/custom_templates/configuration.mustache +26 -19
- package/custom_templates/package.mustache +1 -1
- package/dist/api/calls-api.d.ts +0 -11
- package/dist/api/calls-api.js +0 -11
- package/dist/api/conferences-api.d.ts +0 -15
- package/dist/api/conferences-api.js +0 -15
- package/dist/api/media-api.d.ts +0 -10
- package/dist/api/media-api.js +0 -10
- package/dist/api/messages-api.d.ts +0 -8
- package/dist/api/messages-api.js +0 -8
- package/dist/api/mfaapi.d.ts +0 -9
- package/dist/api/mfaapi.js +0 -9
- package/dist/api/multi-channel-api.d.ts +0 -7
- package/dist/api/multi-channel-api.js +0 -7
- package/dist/api/phone-number-lookup-api.d.ts +81 -59
- package/dist/api/phone-number-lookup-api.js +149 -73
- package/dist/api/recordings-api.d.ts +0 -16
- package/dist/api/recordings-api.js +0 -16
- package/dist/api/statistics-api.d.ts +0 -7
- package/dist/api/statistics-api.js +0 -7
- package/dist/api/toll-free-verification-api.d.ts +0 -15
- package/dist/api/toll-free-verification-api.js +0 -15
- package/dist/api/transcriptions-api.d.ts +0 -9
- package/dist/api/transcriptions-api.js +0 -9
- package/dist/base.d.ts +0 -24
- package/dist/base.js +10 -23
- package/dist/common.d.ts +0 -37
- package/dist/common.js +0 -37
- package/dist/configuration.d.ts +24 -17
- package/dist/configuration.js +2 -2
- package/dist/models/account-statistics.d.ts +0 -9
- package/dist/models/additional-denial-reason.d.ts +0 -11
- package/dist/models/address.d.ts +0 -19
- package/dist/models/answer-callback.d.ts +0 -36
- package/dist/models/async-lookup-request.d.ts +17 -0
- package/dist/models/blocked-webhook.d.ts +0 -20
- package/dist/models/bridge-complete-callback.d.ts +0 -37
- package/dist/models/bridge-target-complete-callback.d.ts +0 -31
- package/dist/models/business-entity-type-enum.d.ts +0 -2
- package/dist/models/business-entity-type-enum.js +0 -2
- package/dist/models/business-registration-type-enum.d.ts +0 -2
- package/dist/models/business-registration-type-enum.js +0 -2
- package/dist/models/call-direction-enum.d.ts +0 -2
- package/dist/models/call-direction-enum.js +0 -2
- package/dist/models/call-recording-metadata.d.ts +0 -52
- package/dist/models/call-state-enum.d.ts +0 -2
- package/dist/models/call-state-enum.js +0 -2
- package/dist/models/call-state.d.ts +0 -44
- package/dist/models/call-transcription-detected-language-enum.d.ts +0 -2
- package/dist/models/call-transcription-detected-language-enum.js +0 -2
- package/dist/models/call-transcription-metadata.d.ts +0 -11
- package/dist/models/call-transcription-response.d.ts +0 -16
- package/dist/models/call-transcription-track-enum.d.ts +0 -2
- package/dist/models/call-transcription-track-enum.js +0 -2
- package/dist/models/call-transcription.d.ts +0 -19
- package/dist/models/callback-method-enum.d.ts +0 -2
- package/dist/models/callback-method-enum.js +0 -2
- package/dist/models/callback.d.ts +0 -1
- package/dist/models/card-width-enum.d.ts +0 -5
- package/dist/models/card-width-enum.js +0 -5
- package/dist/models/code-request.d.ts +0 -17
- package/dist/models/completed-lookup-status-enum.d.ts +17 -0
- package/dist/models/completed-lookup-status-enum.js +21 -0
- package/dist/models/conference-completed-callback.d.ts +0 -12
- package/dist/models/conference-created-callback.d.ts +0 -12
- package/dist/models/conference-member-exit-callback.d.ts +0 -18
- package/dist/models/conference-member-join-callback.d.ts +0 -18
- package/dist/models/conference-member.d.ts +0 -17
- package/dist/models/conference-recording-available-callback.d.ts +0 -33
- package/dist/models/conference-recording-metadata.d.ts +0 -32
- package/dist/models/conference-redirect-callback.d.ts +0 -12
- package/dist/models/conference-state-enum.d.ts +0 -2
- package/dist/models/conference-state-enum.js +0 -2
- package/dist/models/conference.d.ts +0 -24
- package/dist/models/contact.d.ts +0 -16
- package/dist/models/create-async-bulk-lookup-response-data.d.ts +22 -0
- package/dist/models/create-async-bulk-lookup-response.d.ts +22 -0
- package/dist/models/create-call-response.d.ts +0 -56
- package/dist/models/create-call.d.ts +0 -59
- package/dist/models/create-message-request-error.d.ts +0 -20
- package/dist/models/create-multi-channel-message-response.d.ts +0 -20
- package/dist/models/create-sync-lookup-response-data.d.ts +27 -0
- package/dist/models/create-sync-lookup-response.d.ts +19 -0
- package/dist/models/create-sync-lookup-response.js +15 -0
- package/dist/models/deactivation-event-enum.d.ts +18 -0
- package/dist/models/deactivation-event-enum.js +22 -0
- package/dist/models/disconnect-callback.d.ts +0 -39
- package/dist/models/diversion.d.ts +0 -19
- package/dist/models/dtmf-callback.d.ts +0 -39
- package/dist/models/error-object.d.ts +0 -14
- package/dist/models/error-source.d.ts +0 -10
- package/dist/models/failure-webhook.d.ts +0 -17
- package/dist/models/field-error.d.ts +0 -9
- package/dist/models/file-format-enum.d.ts +0 -2
- package/dist/models/file-format-enum.js +0 -2
- package/dist/models/gather-callback.d.ts +0 -41
- package/dist/models/get-async-bulk-lookup-response-data.d.ts +27 -0
- package/dist/models/get-async-bulk-lookup-response-data.js +15 -0
- package/dist/models/get-async-bulk-lookup-response.d.ts +19 -0
- package/dist/models/get-async-bulk-lookup-response.js +15 -0
- package/dist/models/{lookup-status-enum.d.ts → in-progress-lookup-status-enum.d.ts} +2 -7
- package/dist/models/{lookup-status-enum.js → in-progress-lookup-status-enum.js} +2 -7
- package/dist/models/inbound-callback-message.d.ts +0 -1
- package/dist/models/inbound-callback-type-enum.d.ts +0 -2
- package/dist/models/inbound-callback-type-enum.js +0 -2
- package/dist/models/inbound-callback.d.ts +0 -23
- package/dist/models/index.d.ts +17 -5
- package/dist/models/index.js +17 -5
- package/dist/models/initiate-callback.d.ts +0 -37
- package/dist/models/latest-message-delivery-status-enum.d.ts +20 -0
- package/dist/models/latest-message-delivery-status-enum.js +24 -0
- package/dist/models/line-type-enum.d.ts +18 -0
- package/dist/models/line-type-enum.js +22 -0
- package/dist/models/{lookup-request.d.ts → link-schema.d.ts} +11 -10
- package/dist/models/link-schema.js +15 -0
- package/dist/models/link.d.ts +0 -15
- package/dist/models/links-object.d.ts +0 -13
- package/dist/models/list-message-direction-enum.d.ts +0 -2
- package/dist/models/list-message-direction-enum.js +0 -2
- package/dist/models/list-message-item.d.ts +0 -60
- package/dist/models/lookup-error-response.d.ts +21 -0
- package/dist/models/lookup-error-response.js +15 -0
- package/dist/models/{tn-lookup-request-error.d.ts → lookup-error-schema-meta.d.ts} +7 -9
- package/dist/models/lookup-error-schema-meta.js +15 -0
- package/dist/models/lookup-error-schema.d.ts +27 -0
- package/dist/models/lookup-error-schema.js +15 -0
- package/dist/models/lookup-result.d.ts +22 -40
- package/dist/models/machine-detection-complete-callback.d.ts +0 -36
- package/dist/models/machine-detection-configuration.d.ts +0 -41
- package/dist/models/machine-detection-mode-enum.d.ts +0 -2
- package/dist/models/machine-detection-mode-enum.js +0 -2
- package/dist/models/machine-detection-result.d.ts +0 -6
- package/dist/models/media.d.ts +0 -20
- package/dist/models/message-direction-enum.d.ts +0 -2
- package/dist/models/message-direction-enum.js +0 -2
- package/dist/models/message-request.d.ts +0 -24
- package/dist/models/message-status-enum.d.ts +0 -2
- package/dist/models/message-status-enum.js +0 -2
- package/dist/models/message-type-enum.d.ts +0 -2
- package/dist/models/message-type-enum.js +0 -2
- package/dist/models/message.d.ts +0 -37
- package/dist/models/messages-list.d.ts +0 -17
- package/dist/models/messaging-code-response.d.ts +0 -7
- package/dist/models/messaging-request-error.d.ts +0 -15
- package/dist/models/mfa-forbidden-request-error.d.ts +0 -7
- package/dist/models/mfa-request-error.d.ts +0 -9
- package/dist/models/mfa-unauthorized-request-error.d.ts +0 -7
- package/dist/models/mms-message-content-file.d.ts +0 -7
- package/dist/models/mms-message-content.d.ts +0 -12
- package/dist/models/model-error.d.ts +0 -20
- package/dist/models/multi-channel-action-calendar-event.d.ts +0 -1
- package/dist/models/multi-channel-action.d.ts +0 -1
- package/dist/models/multi-channel-channel-list-object-content.d.ts +0 -1
- package/dist/models/multi-channel-channel-list-object.d.ts +0 -19
- package/dist/models/multi-channel-error.d.ts +0 -20
- package/dist/models/multi-channel-message-channel-enum.d.ts +0 -2
- package/dist/models/multi-channel-message-channel-enum.js +0 -2
- package/dist/models/multi-channel-message-content.d.ts +0 -12
- package/dist/models/multi-channel-message-request.d.ts +0 -15
- package/dist/models/multi-channel-message-response-data-channel-list-inner.d.ts +0 -1
- package/dist/models/multi-channel-message-response-data.d.ts +0 -24
- package/dist/models/opt-in-workflow.d.ts +0 -20
- package/dist/models/page-info.d.ts +0 -13
- package/dist/models/priority-enum.d.ts +0 -2
- package/dist/models/priority-enum.js +0 -2
- package/dist/models/product-type-enum.d.ts +0 -2
- package/dist/models/product-type-enum.js +0 -2
- package/dist/models/rbm-action-base.d.ts +0 -14
- package/dist/models/rbm-action-dial.d.ts +0 -1
- package/dist/models/rbm-action-open-url.d.ts +0 -1
- package/dist/models/rbm-action-type-enum.d.ts +0 -5
- package/dist/models/rbm-action-type-enum.js +0 -5
- package/dist/models/rbm-action-view-location.d.ts +0 -1
- package/dist/models/rbm-card-content-media.d.ts +0 -1
- package/dist/models/rbm-card-content.d.ts +0 -16
- package/dist/models/rbm-location-response.d.ts +0 -9
- package/dist/models/rbm-media-height-enum.d.ts +0 -2
- package/dist/models/rbm-media-height-enum.js +0 -2
- package/dist/models/rbm-message-carousel-card.d.ts +0 -17
- package/dist/models/rbm-message-content-file.d.ts +0 -9
- package/dist/models/rbm-message-content-rich-card.d.ts +0 -1
- package/dist/models/rbm-message-content-text.d.ts +0 -9
- package/dist/models/rbm-message-media.d.ts +0 -12
- package/dist/models/rbm-standalone-card.d.ts +0 -22
- package/dist/models/rbm-suggestion-response.d.ts +0 -9
- package/dist/models/recording-available-callback.d.ts +0 -52
- package/dist/models/recording-complete-callback.d.ts +0 -52
- package/dist/models/recording-state-enum.d.ts +0 -2
- package/dist/models/recording-state-enum.js +0 -2
- package/dist/models/recording-transcription-metadata.d.ts +0 -10
- package/dist/models/recording-transcriptions.d.ts +0 -10
- package/dist/models/redirect-callback.d.ts +0 -37
- package/dist/models/redirect-method-enum.d.ts +0 -2
- package/dist/models/redirect-method-enum.js +0 -2
- package/dist/models/sms-message-content.d.ts +0 -7
- package/dist/models/standalone-card-orientation-enum.d.ts +0 -5
- package/dist/models/standalone-card-orientation-enum.js +0 -5
- package/dist/models/status-callback-message.d.ts +0 -43
- package/dist/models/status-callback-type-enum.d.ts +0 -2
- package/dist/models/status-callback-type-enum.js +0 -2
- package/dist/models/status-callback.d.ts +0 -27
- package/dist/models/stir-shaken.d.ts +0 -11
- package/dist/models/sync-lookup-request.d.ts +17 -0
- package/dist/models/sync-lookup-request.js +15 -0
- package/dist/models/telephone-number.d.ts +0 -7
- package/dist/models/tfv-basic-authentication.d.ts +0 -15
- package/dist/models/tfv-callback-status-enum.d.ts +0 -5
- package/dist/models/tfv-callback-status-enum.js +0 -5
- package/dist/models/tfv-error.d.ts +0 -14
- package/dist/models/tfv-status-enum.d.ts +0 -5
- package/dist/models/tfv-status-enum.js +0 -5
- package/dist/models/tfv-status.d.ts +0 -31
- package/dist/models/tfv-submission-info.d.ts +0 -50
- package/dist/models/tfv-submission-wrapper.d.ts +0 -10
- package/dist/models/thumbnail-alignment-enum.d.ts +0 -2
- package/dist/models/thumbnail-alignment-enum.js +0 -2
- package/dist/models/transcribe-recording.d.ts +0 -22
- package/dist/models/transcription-available-callback.d.ts +0 -53
- package/dist/models/transcription.d.ts +0 -9
- package/dist/models/transfer-answer-callback.d.ts +0 -35
- package/dist/models/transfer-complete-callback.d.ts +0 -41
- package/dist/models/transfer-disconnect-callback.d.ts +0 -45
- package/dist/models/update-call-recording.d.ts +0 -10
- package/dist/models/update-call.d.ts +0 -34
- package/dist/models/update-conference-member.d.ts +0 -11
- package/dist/models/update-conference.d.ts +0 -32
- package/dist/models/verification-denial-webhook.d.ts +0 -28
- package/dist/models/verification-request.d.ts +0 -59
- package/dist/models/verification-update-request.d.ts +0 -54
- package/dist/models/verification-webhook.d.ts +0 -16
- package/dist/models/verify-code-request.d.ts +0 -13
- package/dist/models/verify-code-response.d.ts +0 -7
- package/dist/models/voice-api-error.d.ts +0 -20
- package/dist/models/voice-code-response.d.ts +0 -7
- package/dist/models/webhook-subscription-basic-authentication.d.ts +0 -12
- package/dist/models/webhook-subscription-request-schema.d.ts +0 -14
- package/dist/models/webhook-subscription-type-enum.d.ts +0 -5
- package/dist/models/webhook-subscription-type-enum.js +0 -5
- package/dist/models/webhook-subscription.d.ts +0 -34
- package/dist/models/webhook-subscriptions-list-body.d.ts +0 -17
- package/docs/{TnLookupRequestError.md → AsyncLookupRequest.md} +5 -5
- package/docs/CompletedLookupStatusEnum.md +12 -0
- package/docs/CreateAsyncBulkLookupResponse.md +24 -0
- package/docs/{CreateLookupResponse.md → CreateAsyncBulkLookupResponseData.md} +5 -5
- package/docs/CreateSyncLookupResponse.md +24 -0
- package/docs/CreateSyncLookupResponseData.md +25 -0
- package/docs/DeactivationEventEnum.md +9 -0
- package/docs/GetAsyncBulkLookupResponse.md +24 -0
- package/docs/GetAsyncBulkLookupResponseData.md +25 -0
- package/docs/{LookupStatusEnum.md → InProgressLookupStatusEnum.md} +1 -2
- package/docs/LatestMessageDeliveryStatusEnum.md +13 -0
- package/docs/LineTypeEnum.md +14 -0
- package/docs/LinkSchema.md +24 -0
- package/docs/LookupErrorResponse.md +24 -0
- package/docs/LookupErrorSchema.md +26 -0
- package/docs/LookupErrorSchemaMeta.md +24 -0
- package/docs/LookupResult.md +22 -18
- package/docs/PhoneNumberLookupApi.md +81 -34
- package/docs/{LookupRequest.md → SyncLookupRequest.md} +5 -6
- package/models/account-statistics.ts +0 -9
- package/models/additional-denial-reason.ts +0 -11
- package/models/address.ts +0 -19
- package/models/answer-callback.ts +0 -36
- package/models/async-lookup-request.ts +23 -0
- package/models/blocked-webhook.ts +0 -20
- package/models/bridge-complete-callback.ts +0 -37
- package/models/bridge-target-complete-callback.ts +0 -31
- package/models/business-entity-type-enum.ts +0 -2
- package/models/business-registration-type-enum.ts +0 -2
- package/models/call-direction-enum.ts +0 -2
- package/models/call-recording-metadata.ts +0 -52
- package/models/call-state-enum.ts +0 -2
- package/models/call-state.ts +0 -44
- package/models/call-transcription-detected-language-enum.ts +0 -2
- package/models/call-transcription-metadata.ts +0 -11
- package/models/call-transcription-response.ts +0 -16
- package/models/call-transcription-track-enum.ts +0 -2
- package/models/call-transcription.ts +0 -19
- package/models/callback-method-enum.ts +0 -2
- package/models/callback.ts +0 -1
- package/models/card-width-enum.ts +0 -5
- package/models/code-request.ts +0 -17
- package/models/completed-lookup-status-enum.ts +27 -0
- package/models/conference-completed-callback.ts +0 -12
- package/models/conference-created-callback.ts +0 -12
- package/models/conference-member-exit-callback.ts +0 -18
- package/models/conference-member-join-callback.ts +0 -18
- package/models/conference-member.ts +0 -17
- package/models/conference-recording-available-callback.ts +0 -33
- package/models/conference-recording-metadata.ts +0 -32
- package/models/conference-redirect-callback.ts +0 -12
- package/models/conference-state-enum.ts +0 -2
- package/models/conference.ts +0 -24
- package/models/contact.ts +0 -16
- package/models/create-async-bulk-lookup-response-data.ts +32 -0
- package/models/create-async-bulk-lookup-response.ts +34 -0
- package/models/create-call-response.ts +0 -56
- package/models/create-call.ts +0 -59
- package/models/create-message-request-error.ts +0 -20
- package/models/create-multi-channel-message-response.ts +0 -20
- package/models/{create-lookup-response.ts → create-sync-lookup-response-data.ts} +9 -11
- package/models/create-sync-lookup-response.ts +31 -0
- package/models/deactivation-event-enum.ts +28 -0
- package/models/disconnect-callback.ts +0 -39
- package/models/diversion.ts +0 -19
- package/models/dtmf-callback.ts +0 -39
- package/models/error-object.ts +0 -14
- package/models/error-source.ts +0 -10
- package/models/failure-webhook.ts +0 -17
- package/models/field-error.ts +0 -9
- package/models/file-format-enum.ts +0 -2
- package/models/gather-callback.ts +0 -41
- package/models/get-async-bulk-lookup-response-data.ts +39 -0
- package/models/get-async-bulk-lookup-response.ts +31 -0
- package/models/{lookup-status-enum.ts → in-progress-lookup-status-enum.ts} +2 -7
- package/models/inbound-callback-message.ts +0 -1
- package/models/inbound-callback-type-enum.ts +0 -2
- package/models/inbound-callback.ts +0 -23
- package/models/index.ts +17 -5
- package/models/initiate-callback.ts +0 -37
- package/models/latest-message-delivery-status-enum.ts +30 -0
- package/models/line-type-enum.ts +28 -0
- package/models/{lookup-request.ts → link-schema.ts} +11 -10
- package/models/link.ts +0 -15
- package/models/links-object.ts +0 -13
- package/models/list-message-direction-enum.ts +0 -2
- package/models/list-message-item.ts +0 -60
- package/models/lookup-error-response.ts +31 -0
- package/models/{tn-lookup-request-error.ts → lookup-error-schema-meta.ts} +7 -9
- package/models/lookup-error-schema.ts +35 -0
- package/models/lookup-result.ts +30 -40
- package/models/machine-detection-complete-callback.ts +0 -36
- package/models/machine-detection-configuration.ts +0 -41
- package/models/machine-detection-mode-enum.ts +0 -2
- package/models/machine-detection-result.ts +0 -6
- package/models/media.ts +0 -20
- package/models/message-direction-enum.ts +0 -2
- package/models/message-request.ts +0 -24
- package/models/message-status-enum.ts +0 -2
- package/models/message-type-enum.ts +0 -2
- package/models/message.ts +0 -37
- package/models/messages-list.ts +0 -17
- package/models/messaging-code-response.ts +0 -7
- package/models/messaging-request-error.ts +0 -15
- package/models/mfa-forbidden-request-error.ts +0 -7
- package/models/mfa-request-error.ts +0 -9
- package/models/mfa-unauthorized-request-error.ts +0 -7
- package/models/mms-message-content-file.ts +0 -7
- package/models/mms-message-content.ts +0 -12
- package/models/model-error.ts +0 -20
- package/models/multi-channel-action-calendar-event.ts +0 -1
- package/models/multi-channel-action.ts +0 -1
- package/models/multi-channel-channel-list-object-content.ts +0 -1
- package/models/multi-channel-channel-list-object.ts +0 -19
- package/models/multi-channel-error.ts +0 -20
- package/models/multi-channel-message-channel-enum.ts +0 -2
- package/models/multi-channel-message-content.ts +0 -12
- package/models/multi-channel-message-request.ts +0 -15
- package/models/multi-channel-message-response-data-channel-list-inner.ts +0 -1
- package/models/multi-channel-message-response-data.ts +0 -24
- package/models/opt-in-workflow.ts +0 -20
- package/models/page-info.ts +0 -13
- package/models/priority-enum.ts +0 -2
- package/models/product-type-enum.ts +0 -2
- package/models/rbm-action-base.ts +0 -14
- package/models/rbm-action-dial.ts +0 -1
- package/models/rbm-action-open-url.ts +0 -1
- package/models/rbm-action-type-enum.ts +0 -5
- package/models/rbm-action-view-location.ts +0 -1
- package/models/rbm-card-content-media.ts +0 -1
- package/models/rbm-card-content.ts +0 -16
- package/models/rbm-location-response.ts +0 -9
- package/models/rbm-media-height-enum.ts +0 -2
- package/models/rbm-message-carousel-card.ts +0 -17
- package/models/rbm-message-content-file.ts +0 -9
- package/models/rbm-message-content-rich-card.ts +0 -1
- package/models/rbm-message-content-text.ts +0 -9
- package/models/rbm-message-media.ts +0 -12
- package/models/rbm-standalone-card.ts +0 -22
- package/models/rbm-suggestion-response.ts +0 -9
- package/models/recording-available-callback.ts +0 -52
- package/models/recording-complete-callback.ts +0 -52
- package/models/recording-state-enum.ts +0 -2
- package/models/recording-transcription-metadata.ts +0 -10
- package/models/recording-transcriptions.ts +0 -10
- package/models/redirect-callback.ts +0 -37
- package/models/redirect-method-enum.ts +0 -2
- package/models/sms-message-content.ts +0 -7
- package/models/standalone-card-orientation-enum.ts +0 -5
- package/models/status-callback-message.ts +0 -43
- package/models/status-callback-type-enum.ts +0 -2
- package/models/status-callback.ts +0 -27
- package/models/stir-shaken.ts +0 -11
- package/models/sync-lookup-request.ts +23 -0
- package/models/telephone-number.ts +0 -7
- package/models/tfv-basic-authentication.ts +0 -15
- package/models/tfv-callback-status-enum.ts +0 -5
- package/models/tfv-error.ts +0 -14
- package/models/tfv-status-enum.ts +0 -5
- package/models/tfv-status.ts +0 -31
- package/models/tfv-submission-info.ts +0 -50
- package/models/tfv-submission-wrapper.ts +0 -10
- package/models/thumbnail-alignment-enum.ts +0 -2
- package/models/transcribe-recording.ts +0 -22
- package/models/transcription-available-callback.ts +0 -53
- package/models/transcription.ts +0 -9
- package/models/transfer-answer-callback.ts +0 -35
- package/models/transfer-complete-callback.ts +0 -41
- package/models/transfer-disconnect-callback.ts +0 -45
- package/models/update-call-recording.ts +0 -10
- package/models/update-call.ts +0 -34
- package/models/update-conference-member.ts +0 -11
- package/models/update-conference.ts +0 -32
- package/models/verification-denial-webhook.ts +0 -28
- package/models/verification-request.ts +0 -59
- package/models/verification-update-request.ts +0 -54
- package/models/verification-webhook.ts +0 -16
- package/models/verify-code-request.ts +0 -13
- package/models/verify-code-response.ts +0 -7
- package/models/voice-api-error.ts +0 -20
- package/models/voice-code-response.ts +0 -7
- package/models/webhook-subscription-basic-authentication.ts +0 -12
- package/models/webhook-subscription-request-schema.ts +0 -14
- package/models/webhook-subscription-type-enum.ts +0 -5
- package/models/webhook-subscription.ts +0 -34
- package/models/webhook-subscriptions-list-body.ts +0 -17
- package/openapitools.json +1 -1
- package/package.json +2 -2
- package/tests/smoke/phone-number-lookup-api.test.ts +64 -61
- package/tests/unit/api/phone-number-lookup-api.test.ts +64 -58
- package/tests/unit/models/completed-lookup-status-enum.test.ts +9 -0
- package/tests/unit/models/deactivation-event-enum.test.ts +7 -0
- package/tests/unit/models/in-progress-lookup-status-enum.test.ts +11 -0
- package/tests/unit/models/latest-message-delivery-status-enum.test.ts +10 -0
- package/tests/unit/models/line-type-enum.test.ts +11 -0
- package/dist/models/create-lookup-response.d.ts +0 -31
- package/dist/models/lookup-status.d.ts +0 -44
- package/docs/LookupStatus.md +0 -27
- package/models/lookup-status.ts +0 -56
- package/tests/unit/models/lookup-status-enum.test.ts +0 -10
- /package/dist/models/{create-lookup-response.js → async-lookup-request.js} +0 -0
- /package/dist/models/{lookup-request.js → create-async-bulk-lookup-response-data.js} +0 -0
- /package/dist/models/{lookup-status.js → create-async-bulk-lookup-response.js} +0 -0
- /package/dist/models/{tn-lookup-request-error.js → create-sync-lookup-response-data.js} +0 -0
|
@@ -12,104 +12,67 @@
|
|
|
12
12
|
import type { CallDirectionEnum } from './call-direction-enum';
|
|
13
13
|
/**
|
|
14
14
|
* If the target call leaves the <Bridge>, then this callback is sent to the bridgeCompleteUrl, and the BXML returned in it is executed on the call. If this webhook is sent, the Bridge Target Complete webhook is NOT sent. This callback is also sent if any problem occurs that prevents the calls to be bridged.
|
|
15
|
-
* @export
|
|
16
|
-
* @interface BridgeCompleteCallback
|
|
17
15
|
*/
|
|
18
16
|
export interface BridgeCompleteCallback {
|
|
19
17
|
/**
|
|
20
18
|
* The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect.
|
|
21
|
-
* @type {string}
|
|
22
|
-
* @memberof BridgeCompleteCallback
|
|
23
19
|
*/
|
|
24
20
|
'eventType'?: string;
|
|
25
21
|
/**
|
|
26
22
|
* The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution.
|
|
27
|
-
* @type {string}
|
|
28
|
-
* @memberof BridgeCompleteCallback
|
|
29
23
|
*/
|
|
30
24
|
'eventTime'?: string;
|
|
31
25
|
/**
|
|
32
26
|
* The user account associated with the call.
|
|
33
|
-
* @type {string}
|
|
34
|
-
* @memberof BridgeCompleteCallback
|
|
35
27
|
*/
|
|
36
28
|
'accountId'?: string;
|
|
37
29
|
/**
|
|
38
30
|
* The id of the application associated with the call.
|
|
39
|
-
* @type {string}
|
|
40
|
-
* @memberof BridgeCompleteCallback
|
|
41
31
|
*/
|
|
42
32
|
'applicationId'?: string;
|
|
43
33
|
/**
|
|
44
34
|
* The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555).
|
|
45
|
-
* @type {string}
|
|
46
|
-
* @memberof BridgeCompleteCallback
|
|
47
35
|
*/
|
|
48
36
|
'from'?: string;
|
|
49
37
|
/**
|
|
50
38
|
* The phone number that received the call, in E.164 format (e.g. +15555555555).
|
|
51
|
-
* @type {string}
|
|
52
|
-
* @memberof BridgeCompleteCallback
|
|
53
39
|
*/
|
|
54
40
|
'to'?: string;
|
|
55
|
-
/**
|
|
56
|
-
*
|
|
57
|
-
* @type {CallDirectionEnum}
|
|
58
|
-
* @memberof BridgeCompleteCallback
|
|
59
|
-
*/
|
|
60
41
|
'direction'?: CallDirectionEnum;
|
|
61
42
|
/**
|
|
62
43
|
* The call id associated with the event.
|
|
63
|
-
* @type {string}
|
|
64
|
-
* @memberof BridgeCompleteCallback
|
|
65
44
|
*/
|
|
66
45
|
'callId'?: string;
|
|
67
46
|
/**
|
|
68
47
|
* The URL of the call associated with the event.
|
|
69
|
-
* @type {string}
|
|
70
|
-
* @memberof BridgeCompleteCallback
|
|
71
48
|
*/
|
|
72
49
|
'callUrl'?: string;
|
|
73
50
|
/**
|
|
74
51
|
* (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format.
|
|
75
|
-
* @type {string}
|
|
76
|
-
* @memberof BridgeCompleteCallback
|
|
77
52
|
*/
|
|
78
53
|
'enqueuedTime'?: string | null;
|
|
79
54
|
/**
|
|
80
55
|
* Time the call was started, in ISO 8601 format.
|
|
81
|
-
* @type {string}
|
|
82
|
-
* @memberof BridgeCompleteCallback
|
|
83
56
|
*/
|
|
84
57
|
'startTime'?: string;
|
|
85
58
|
/**
|
|
86
59
|
* Time the call was answered, in ISO 8601 format.
|
|
87
|
-
* @type {string}
|
|
88
|
-
* @memberof BridgeCompleteCallback
|
|
89
60
|
*/
|
|
90
61
|
'answerTime'?: string | null;
|
|
91
62
|
/**
|
|
92
63
|
* (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present.
|
|
93
|
-
* @type {string}
|
|
94
|
-
* @memberof BridgeCompleteCallback
|
|
95
64
|
*/
|
|
96
65
|
'tag'?: string | null;
|
|
97
66
|
/**
|
|
98
67
|
* Reason the call failed - hangup, busy, timeout, cancel, rejected, callback-error, invalid-bxml, application-error, account-limit, node-capacity-exceeded, error, or unknown.
|
|
99
|
-
* @type {string}
|
|
100
|
-
* @memberof BridgeCompleteCallback
|
|
101
68
|
*/
|
|
102
69
|
'cause'?: string;
|
|
103
70
|
/**
|
|
104
71
|
* Text explaining the reason that caused the call to fail in case of errors.
|
|
105
|
-
* @type {string}
|
|
106
|
-
* @memberof BridgeCompleteCallback
|
|
107
72
|
*/
|
|
108
73
|
'errorMessage'?: string | null;
|
|
109
74
|
/**
|
|
110
75
|
* Bandwidth\'s internal id that references the error event.
|
|
111
|
-
* @type {string}
|
|
112
|
-
* @memberof BridgeCompleteCallback
|
|
113
76
|
*/
|
|
114
77
|
'errorId'?: string | null;
|
|
115
78
|
}
|
|
@@ -12,86 +12,55 @@
|
|
|
12
12
|
import type { CallDirectionEnum } from './call-direction-enum';
|
|
13
13
|
/**
|
|
14
14
|
* If the originating call leaves the <Bridge>, then this callback is sent to the bridgeTargetCompleteUrl, and the BXML returned in it is executed on the target call. If this webhook is sent, the Bridge Complete webhook is NOT sent.
|
|
15
|
-
* @export
|
|
16
|
-
* @interface BridgeTargetCompleteCallback
|
|
17
15
|
*/
|
|
18
16
|
export interface BridgeTargetCompleteCallback {
|
|
19
17
|
/**
|
|
20
18
|
* The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect.
|
|
21
|
-
* @type {string}
|
|
22
|
-
* @memberof BridgeTargetCompleteCallback
|
|
23
19
|
*/
|
|
24
20
|
'eventType'?: string;
|
|
25
21
|
/**
|
|
26
22
|
* The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution.
|
|
27
|
-
* @type {string}
|
|
28
|
-
* @memberof BridgeTargetCompleteCallback
|
|
29
23
|
*/
|
|
30
24
|
'eventTime'?: string;
|
|
31
25
|
/**
|
|
32
26
|
* The user account associated with the call.
|
|
33
|
-
* @type {string}
|
|
34
|
-
* @memberof BridgeTargetCompleteCallback
|
|
35
27
|
*/
|
|
36
28
|
'accountId'?: string;
|
|
37
29
|
/**
|
|
38
30
|
* The id of the application associated with the call.
|
|
39
|
-
* @type {string}
|
|
40
|
-
* @memberof BridgeTargetCompleteCallback
|
|
41
31
|
*/
|
|
42
32
|
'applicationId'?: string;
|
|
43
33
|
/**
|
|
44
34
|
* The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555).
|
|
45
|
-
* @type {string}
|
|
46
|
-
* @memberof BridgeTargetCompleteCallback
|
|
47
35
|
*/
|
|
48
36
|
'from'?: string;
|
|
49
37
|
/**
|
|
50
38
|
* The phone number that received the call, in E.164 format (e.g. +15555555555).
|
|
51
|
-
* @type {string}
|
|
52
|
-
* @memberof BridgeTargetCompleteCallback
|
|
53
39
|
*/
|
|
54
40
|
'to'?: string;
|
|
55
|
-
/**
|
|
56
|
-
*
|
|
57
|
-
* @type {CallDirectionEnum}
|
|
58
|
-
* @memberof BridgeTargetCompleteCallback
|
|
59
|
-
*/
|
|
60
41
|
'direction'?: CallDirectionEnum;
|
|
61
42
|
/**
|
|
62
43
|
* The call id associated with the event.
|
|
63
|
-
* @type {string}
|
|
64
|
-
* @memberof BridgeTargetCompleteCallback
|
|
65
44
|
*/
|
|
66
45
|
'callId'?: string;
|
|
67
46
|
/**
|
|
68
47
|
* The URL of the call associated with the event.
|
|
69
|
-
* @type {string}
|
|
70
|
-
* @memberof BridgeTargetCompleteCallback
|
|
71
48
|
*/
|
|
72
49
|
'callUrl'?: string;
|
|
73
50
|
/**
|
|
74
51
|
* (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format.
|
|
75
|
-
* @type {string}
|
|
76
|
-
* @memberof BridgeTargetCompleteCallback
|
|
77
52
|
*/
|
|
78
53
|
'enqueuedTime'?: string | null;
|
|
79
54
|
/**
|
|
80
55
|
* Time the call was started, in ISO 8601 format.
|
|
81
|
-
* @type {string}
|
|
82
|
-
* @memberof BridgeTargetCompleteCallback
|
|
83
56
|
*/
|
|
84
57
|
'startTime'?: string;
|
|
85
58
|
/**
|
|
86
59
|
* Time the call was answered, in ISO 8601 format.
|
|
87
|
-
* @type {string}
|
|
88
|
-
* @memberof BridgeTargetCompleteCallback
|
|
89
60
|
*/
|
|
90
61
|
'answerTime'?: string | null;
|
|
91
62
|
/**
|
|
92
63
|
* (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present.
|
|
93
|
-
* @type {string}
|
|
94
|
-
* @memberof BridgeTargetCompleteCallback
|
|
95
64
|
*/
|
|
96
65
|
'tag'?: string | null;
|
|
97
66
|
}
|
|
@@ -11,8 +11,6 @@
|
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
13
|
* The type of registered business. If no option is applicable, please provide \"SOLE_PROPRIETOR\" as a value. Optional until early 2026; required if `businessRegistrationNumber` is provided. Available starting October 1st, 2025.
|
|
14
|
-
* @export
|
|
15
|
-
* @enum {string}
|
|
16
14
|
*/
|
|
17
15
|
export declare const BusinessEntityTypeEnum: {
|
|
18
16
|
readonly SoleProprietor: "SOLE_PROPRIETOR";
|
|
@@ -16,8 +16,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
16
16
|
exports.BusinessEntityTypeEnum = void 0;
|
|
17
17
|
/**
|
|
18
18
|
* The type of registered business. If no option is applicable, please provide \"SOLE_PROPRIETOR\" as a value. Optional until early 2026; required if `businessRegistrationNumber` is provided. Available starting October 1st, 2025.
|
|
19
|
-
* @export
|
|
20
|
-
* @enum {string}
|
|
21
19
|
*/
|
|
22
20
|
exports.BusinessEntityTypeEnum = {
|
|
23
21
|
SoleProprietor: 'SOLE_PROPRIETOR',
|
|
@@ -11,8 +11,6 @@
|
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
13
|
* The type of business registration number. Optional until early 2026; required if `businessRegistrationNumber` is provided. Available starting October 1st, 2025.
|
|
14
|
-
* @export
|
|
15
|
-
* @enum {string}
|
|
16
14
|
*/
|
|
17
15
|
export declare const BusinessRegistrationTypeEnum: {
|
|
18
16
|
readonly Ein: "EIN";
|
|
@@ -16,8 +16,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
16
16
|
exports.BusinessRegistrationTypeEnum = void 0;
|
|
17
17
|
/**
|
|
18
18
|
* The type of business registration number. Optional until early 2026; required if `businessRegistrationNumber` is provided. Available starting October 1st, 2025.
|
|
19
|
-
* @export
|
|
20
|
-
* @enum {string}
|
|
21
19
|
*/
|
|
22
20
|
exports.BusinessRegistrationTypeEnum = {
|
|
23
21
|
Ein: 'EIN',
|
|
@@ -12,124 +12,72 @@
|
|
|
12
12
|
import type { CallDirectionEnum } from './call-direction-enum';
|
|
13
13
|
import type { FileFormatEnum } from './file-format-enum';
|
|
14
14
|
import type { RecordingTranscriptionMetadata } from './recording-transcription-metadata';
|
|
15
|
-
/**
|
|
16
|
-
*
|
|
17
|
-
* @export
|
|
18
|
-
* @interface CallRecordingMetadata
|
|
19
|
-
*/
|
|
20
15
|
export interface CallRecordingMetadata {
|
|
21
16
|
/**
|
|
22
17
|
* The id of the application associated with the call.
|
|
23
|
-
* @type {string}
|
|
24
|
-
* @memberof CallRecordingMetadata
|
|
25
18
|
*/
|
|
26
19
|
'applicationId'?: string;
|
|
27
20
|
/**
|
|
28
21
|
* The user account associated with the call.
|
|
29
|
-
* @type {string}
|
|
30
|
-
* @memberof CallRecordingMetadata
|
|
31
22
|
*/
|
|
32
23
|
'accountId'?: string;
|
|
33
24
|
/**
|
|
34
25
|
* The call id associated with the event.
|
|
35
|
-
* @type {string}
|
|
36
|
-
* @memberof CallRecordingMetadata
|
|
37
26
|
*/
|
|
38
27
|
'callId'?: string;
|
|
39
28
|
/**
|
|
40
29
|
* (optional) If the event is related to the B leg of a <Transfer>, the call id of the original call leg that executed the <Transfer>. Otherwise, this field will not be present.
|
|
41
|
-
* @type {string}
|
|
42
|
-
* @memberof CallRecordingMetadata
|
|
43
30
|
*/
|
|
44
31
|
'parentCallId'?: string;
|
|
45
32
|
/**
|
|
46
33
|
* The unique ID of this recording
|
|
47
|
-
* @type {string}
|
|
48
|
-
* @memberof CallRecordingMetadata
|
|
49
34
|
*/
|
|
50
35
|
'recordingId'?: string;
|
|
51
36
|
/**
|
|
52
37
|
* The phone number that received the call, in E.164 format (e.g. +15555555555).
|
|
53
|
-
* @type {string}
|
|
54
|
-
* @memberof CallRecordingMetadata
|
|
55
38
|
*/
|
|
56
39
|
'to'?: string;
|
|
57
40
|
/**
|
|
58
41
|
* The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555).
|
|
59
|
-
* @type {string}
|
|
60
|
-
* @memberof CallRecordingMetadata
|
|
61
42
|
*/
|
|
62
43
|
'from'?: string;
|
|
63
44
|
/**
|
|
64
45
|
* The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555).
|
|
65
|
-
* @type {string}
|
|
66
|
-
* @memberof CallRecordingMetadata
|
|
67
46
|
*/
|
|
68
47
|
'transferCallerId'?: string;
|
|
69
48
|
/**
|
|
70
49
|
* The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555).
|
|
71
|
-
* @type {string}
|
|
72
|
-
* @memberof CallRecordingMetadata
|
|
73
50
|
*/
|
|
74
51
|
'transferTo'?: string;
|
|
75
52
|
/**
|
|
76
53
|
* The duration of the recording in ISO-8601 format
|
|
77
|
-
* @type {string}
|
|
78
|
-
* @memberof CallRecordingMetadata
|
|
79
54
|
*/
|
|
80
55
|
'duration'?: string;
|
|
81
|
-
/**
|
|
82
|
-
*
|
|
83
|
-
* @type {CallDirectionEnum}
|
|
84
|
-
* @memberof CallRecordingMetadata
|
|
85
|
-
*/
|
|
86
56
|
'direction'?: CallDirectionEnum;
|
|
87
57
|
/**
|
|
88
58
|
* Always `1` for conference recordings; multi-channel recordings are not supported on conferences.
|
|
89
|
-
* @type {number}
|
|
90
|
-
* @memberof CallRecordingMetadata
|
|
91
59
|
*/
|
|
92
60
|
'channels'?: number;
|
|
93
61
|
/**
|
|
94
62
|
* Time the call was started, in ISO 8601 format.
|
|
95
|
-
* @type {string}
|
|
96
|
-
* @memberof CallRecordingMetadata
|
|
97
63
|
*/
|
|
98
64
|
'startTime'?: string;
|
|
99
65
|
/**
|
|
100
66
|
* The time that the recording ended in ISO-8601 format
|
|
101
|
-
* @type {string}
|
|
102
|
-
* @memberof CallRecordingMetadata
|
|
103
67
|
*/
|
|
104
68
|
'endTime'?: string;
|
|
105
|
-
/**
|
|
106
|
-
*
|
|
107
|
-
* @type {FileFormatEnum}
|
|
108
|
-
* @memberof CallRecordingMetadata
|
|
109
|
-
*/
|
|
110
69
|
'fileFormat'?: FileFormatEnum;
|
|
111
70
|
/**
|
|
112
71
|
* The current status of the process. For recording, current possible values are \'processing\', \'partial\', \'complete\', \'deleted\', and \'error\'. For transcriptions, current possible values are \'none\', \'processing\', \'available\', \'error\', \'timeout\', \'file-size-too-big\', and \'file-size-too-small\'. Additional states may be added in the future, so your application must be tolerant of unknown values.
|
|
113
|
-
* @type {string}
|
|
114
|
-
* @memberof CallRecordingMetadata
|
|
115
72
|
*/
|
|
116
73
|
'status'?: string;
|
|
117
74
|
/**
|
|
118
75
|
* The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded.
|
|
119
|
-
* @type {string}
|
|
120
|
-
* @memberof CallRecordingMetadata
|
|
121
76
|
*/
|
|
122
77
|
'mediaUrl'?: string | null;
|
|
123
|
-
/**
|
|
124
|
-
*
|
|
125
|
-
* @type {RecordingTranscriptionMetadata}
|
|
126
|
-
* @memberof CallRecordingMetadata
|
|
127
|
-
*/
|
|
128
78
|
'transcription'?: RecordingTranscriptionMetadata | null;
|
|
129
79
|
/**
|
|
130
80
|
* A name to identify this recording.
|
|
131
|
-
* @type {string}
|
|
132
|
-
* @memberof CallRecordingMetadata
|
|
133
81
|
*/
|
|
134
82
|
'recordingName'?: string;
|
|
135
83
|
}
|
|
@@ -11,8 +11,6 @@
|
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
13
|
* The call state. Possible values:<br>`active` to redirect the call (default)<br>`completed` to hang up the call if it is answered, cancel it if it is an unanswered outbound call, or reject it if it an unanswered inbound call
|
|
14
|
-
* @export
|
|
15
|
-
* @enum {string}
|
|
16
14
|
*/
|
|
17
15
|
export declare const CallStateEnum: {
|
|
18
16
|
readonly Active: "active";
|
|
@@ -16,8 +16,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
16
16
|
exports.CallStateEnum = void 0;
|
|
17
17
|
/**
|
|
18
18
|
* The call state. Possible values:<br>`active` to redirect the call (default)<br>`completed` to hang up the call if it is answered, cancel it if it is an unanswered outbound call, or reject it if it an unanswered inbound call
|
|
19
|
-
* @export
|
|
20
|
-
* @enum {string}
|
|
21
19
|
*/
|
|
22
20
|
exports.CallStateEnum = {
|
|
23
21
|
Active: 'active',
|
|
@@ -10,120 +10,76 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { CallDirectionEnum } from './call-direction-enum';
|
|
13
|
-
/**
|
|
14
|
-
*
|
|
15
|
-
* @export
|
|
16
|
-
* @interface CallState
|
|
17
|
-
*/
|
|
18
13
|
export interface CallState {
|
|
19
14
|
/**
|
|
20
15
|
* The application id associated with the call.
|
|
21
|
-
* @type {string}
|
|
22
|
-
* @memberof CallState
|
|
23
16
|
*/
|
|
24
17
|
'applicationId'?: string;
|
|
25
18
|
/**
|
|
26
19
|
* The account id associated with the call.
|
|
27
|
-
* @type {string}
|
|
28
|
-
* @memberof CallState
|
|
29
20
|
*/
|
|
30
21
|
'accountId'?: string;
|
|
31
22
|
/**
|
|
32
23
|
* The programmable voice API call ID.
|
|
33
|
-
* @type {string}
|
|
34
|
-
* @memberof CallState
|
|
35
24
|
*/
|
|
36
25
|
'callId'?: string;
|
|
37
26
|
/**
|
|
38
27
|
* The A-leg call id, set only if this call is the B-leg of a [`<Transfer>`](/docs/voice/bxml/transfer).
|
|
39
|
-
* @type {string}
|
|
40
|
-
* @memberof CallState
|
|
41
28
|
*/
|
|
42
29
|
'parentCallId'?: string | null;
|
|
43
30
|
/**
|
|
44
31
|
* The phone number that received the call, in E.164 format (e.g. +15555555555), or if the call was to a SIP URI, the SIP URI.
|
|
45
|
-
* @type {string}
|
|
46
|
-
* @memberof CallState
|
|
47
32
|
*/
|
|
48
33
|
'to'?: string;
|
|
49
34
|
/**
|
|
50
35
|
* The phone number that made the call, in E.164 format (e.g. +15555555555).
|
|
51
|
-
* @type {string}
|
|
52
|
-
* @memberof CallState
|
|
53
36
|
*/
|
|
54
37
|
'from'?: string;
|
|
55
|
-
/**
|
|
56
|
-
*
|
|
57
|
-
* @type {CallDirectionEnum}
|
|
58
|
-
* @memberof CallState
|
|
59
|
-
*/
|
|
60
38
|
'direction'?: CallDirectionEnum;
|
|
61
39
|
/**
|
|
62
40
|
* The current state of the call. Current possible values are `queued`, `initiated`, `answered` and `disconnected`. Additional states may be added in the future, so your application must be tolerant of unknown values.
|
|
63
|
-
* @type {string}
|
|
64
|
-
* @memberof CallState
|
|
65
41
|
*/
|
|
66
42
|
'state'?: string;
|
|
67
43
|
/**
|
|
68
44
|
* For inbound calls, the Bandwidth STIR/SHAKEN implementation will verify the information provided in the inbound invite request `Identity` header. The verification status is stored in the call state `stirShaken` property as follows. | Property | Description | |:------------------|:------------| | verstat | (optional) The verification status indicating whether the verification was successful or not. Possible values are `TN-Validation-Passed` or `TN-Validation-Failed`. | | attestationIndicator | (optional) The attestation level verified by Bandwidth. Possible values are `A` (full), `B` (partial) or `C` (gateway). | | originatingId | (optional) A unique origination identifier. | Note that these are common properties but that the `stirShaken` object is free form and can contain other key-value pairs. More information: [Understanding STIR/SHAKEN](https://www.bandwidth.com/regulations/stir-shaken).
|
|
69
|
-
* @type {{ [key: string]: string; }}
|
|
70
|
-
* @memberof CallState
|
|
71
45
|
*/
|
|
72
46
|
'stirShaken'?: {
|
|
73
47
|
[key: string]: string;
|
|
74
48
|
} | null;
|
|
75
49
|
/**
|
|
76
50
|
* The value of the `Identity` header from the inbound invite request. Only present for inbound calls and if the account is configured to forward this header.
|
|
77
|
-
* @type {string}
|
|
78
|
-
* @memberof CallState
|
|
79
51
|
*/
|
|
80
52
|
'identity'?: string | null;
|
|
81
53
|
/**
|
|
82
54
|
* The time this call was placed in queue.
|
|
83
|
-
* @type {string}
|
|
84
|
-
* @memberof CallState
|
|
85
55
|
*/
|
|
86
56
|
'enqueuedTime'?: string | null;
|
|
87
57
|
/**
|
|
88
58
|
* The time the call was initiated, in ISO 8601 format. `null` if the call is still in your queue.
|
|
89
|
-
* @type {string}
|
|
90
|
-
* @memberof CallState
|
|
91
59
|
*/
|
|
92
60
|
'startTime'?: string | null;
|
|
93
61
|
/**
|
|
94
62
|
* Populated once the call has been answered, with the time in ISO 8601 format.
|
|
95
|
-
* @type {string}
|
|
96
|
-
* @memberof CallState
|
|
97
63
|
*/
|
|
98
64
|
'answerTime'?: string | null;
|
|
99
65
|
/**
|
|
100
66
|
* Populated once the call has ended, with the time in ISO 8601 format.
|
|
101
|
-
* @type {string}
|
|
102
|
-
* @memberof CallState
|
|
103
67
|
*/
|
|
104
68
|
'endTime'?: string | null;
|
|
105
69
|
/**
|
|
106
70
|
* | Cause | Description | |:------|:------------| | `hangup`| One party hung up the call, a [`<Hangup>`](../../bxml/verbs/hangup.md) verb was executed, or there was no more BXML to execute; it indicates that the call ended normally. | | `busy` | Callee was busy. | | `timeout` | Call wasn\'t answered before the `callTimeout` was reached. | | `cancel` | Call was cancelled by its originator while it was ringing. | | `rejected` | Call was rejected by the callee. | | `callback-error` | BXML callback couldn\'t be delivered to your callback server. | | `invalid-bxml` | Invalid BXML was returned in response to a callback. | | `application-error` | An unsupported action was tried on the call, e.g. trying to play a .ogg audio. | | `account-limit` | Account rate limits were reached. | | `node-capacity-exceeded` | System maximum capacity was reached. | | `error` | Some error not described in any of the other causes happened on the call. | | `unknown` | Unknown error happened on the call. | Note: This list is not exhaustive and other values can appear in the future.
|
|
107
|
-
* @type {string}
|
|
108
|
-
* @memberof CallState
|
|
109
71
|
*/
|
|
110
72
|
'disconnectCause'?: string | null;
|
|
111
73
|
/**
|
|
112
74
|
* Populated only if the call ended with an error, with text explaining the reason.
|
|
113
|
-
* @type {string}
|
|
114
|
-
* @memberof CallState
|
|
115
75
|
*/
|
|
116
76
|
'errorMessage'?: string | null;
|
|
117
77
|
/**
|
|
118
78
|
* Populated only if the call ended with an error, with a Bandwidth internal id that references the error event.
|
|
119
|
-
* @type {string}
|
|
120
|
-
* @memberof CallState
|
|
121
79
|
*/
|
|
122
80
|
'errorId'?: string | null;
|
|
123
81
|
/**
|
|
124
82
|
* The last time the call had a state update, in ISO 8601 format.
|
|
125
|
-
* @type {string}
|
|
126
|
-
* @memberof CallState
|
|
127
83
|
*/
|
|
128
84
|
'lastUpdate'?: string;
|
|
129
85
|
}
|
|
@@ -16,8 +16,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
16
16
|
exports.CallTranscriptionDetectedLanguageEnum = void 0;
|
|
17
17
|
/**
|
|
18
18
|
* The detected language for this transcription.
|
|
19
|
-
* @export
|
|
20
|
-
* @enum {string}
|
|
21
19
|
*/
|
|
22
20
|
exports.CallTranscriptionDetectedLanguageEnum = {
|
|
23
21
|
EnUs: 'en-US',
|
|
@@ -9,28 +9,17 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
/**
|
|
13
|
-
*
|
|
14
|
-
* @export
|
|
15
|
-
* @interface CallTranscriptionMetadata
|
|
16
|
-
*/
|
|
17
12
|
export interface CallTranscriptionMetadata {
|
|
18
13
|
/**
|
|
19
14
|
* The programmable voice API transcription ID.
|
|
20
|
-
* @type {string}
|
|
21
|
-
* @memberof CallTranscriptionMetadata
|
|
22
15
|
*/
|
|
23
16
|
'transcriptionId'?: string;
|
|
24
17
|
/**
|
|
25
18
|
* The programmable voice API transcription name. This name could be provided by the user when creating the transcription.
|
|
26
|
-
* @type {string}
|
|
27
|
-
* @memberof CallTranscriptionMetadata
|
|
28
19
|
*/
|
|
29
20
|
'transcriptionName'?: string;
|
|
30
21
|
/**
|
|
31
22
|
* A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice-apis/voice/#tag/Transcriptions/operation/getRealTimeTranscription) endpoint.
|
|
32
|
-
* @type {string}
|
|
33
|
-
* @memberof CallTranscriptionMetadata
|
|
34
23
|
*/
|
|
35
24
|
'transcriptionUrl'?: string;
|
|
36
25
|
}
|
|
@@ -10,34 +10,18 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { CallTranscription } from './call-transcription';
|
|
13
|
-
/**
|
|
14
|
-
*
|
|
15
|
-
* @export
|
|
16
|
-
* @interface CallTranscriptionResponse
|
|
17
|
-
*/
|
|
18
13
|
export interface CallTranscriptionResponse {
|
|
19
14
|
/**
|
|
20
15
|
* The user account associated with the call.
|
|
21
|
-
* @type {string}
|
|
22
|
-
* @memberof CallTranscriptionResponse
|
|
23
16
|
*/
|
|
24
17
|
'accountId'?: string;
|
|
25
18
|
/**
|
|
26
19
|
* The call id associated with the event.
|
|
27
|
-
* @type {string}
|
|
28
|
-
* @memberof CallTranscriptionResponse
|
|
29
20
|
*/
|
|
30
21
|
'callId'?: string;
|
|
31
22
|
/**
|
|
32
23
|
* The programmable voice API transcription ID.
|
|
33
|
-
* @type {string}
|
|
34
|
-
* @memberof CallTranscriptionResponse
|
|
35
24
|
*/
|
|
36
25
|
'transcriptionId'?: string;
|
|
37
|
-
/**
|
|
38
|
-
*
|
|
39
|
-
* @type {Array<CallTranscription>}
|
|
40
|
-
* @memberof CallTranscriptionResponse
|
|
41
|
-
*/
|
|
42
26
|
'tracks'?: Array<CallTranscription>;
|
|
43
27
|
}
|
|
@@ -16,8 +16,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
16
16
|
exports.CallTranscriptionTrackEnum = void 0;
|
|
17
17
|
/**
|
|
18
18
|
* Which `track` this transcription is derived from.
|
|
19
|
-
* @export
|
|
20
|
-
* @enum {string}
|
|
21
19
|
*/
|
|
22
20
|
exports.CallTranscriptionTrackEnum = {
|
|
23
21
|
Inbound: 'inbound',
|
|
@@ -11,34 +11,15 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { CallTranscriptionDetectedLanguageEnum } from './call-transcription-detected-language-enum';
|
|
13
13
|
import type { CallTranscriptionTrackEnum } from './call-transcription-track-enum';
|
|
14
|
-
/**
|
|
15
|
-
*
|
|
16
|
-
* @export
|
|
17
|
-
* @interface CallTranscription
|
|
18
|
-
*/
|
|
19
14
|
export interface CallTranscription {
|
|
20
|
-
/**
|
|
21
|
-
*
|
|
22
|
-
* @type {CallTranscriptionDetectedLanguageEnum}
|
|
23
|
-
* @memberof CallTranscription
|
|
24
|
-
*/
|
|
25
15
|
'detectedLanguage'?: CallTranscriptionDetectedLanguageEnum;
|
|
26
|
-
/**
|
|
27
|
-
*
|
|
28
|
-
* @type {CallTranscriptionTrackEnum}
|
|
29
|
-
* @memberof CallTranscription
|
|
30
|
-
*/
|
|
31
16
|
'track'?: CallTranscriptionTrackEnum;
|
|
32
17
|
/**
|
|
33
18
|
* The transcription itself.
|
|
34
|
-
* @type {string}
|
|
35
|
-
* @memberof CallTranscription
|
|
36
19
|
*/
|
|
37
20
|
'transcript'?: string;
|
|
38
21
|
/**
|
|
39
22
|
* How confident the transcription engine was in transcribing the associated audio (from `0` to `1`).
|
|
40
|
-
* @type {number}
|
|
41
|
-
* @memberof CallTranscription
|
|
42
23
|
*/
|
|
43
24
|
'confidence'?: number;
|
|
44
25
|
}
|