bandwidth-sdk 6.2.0 → 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 -68
- 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 +555 -279
- package/base.ts +10 -28
- package/common.ts +5 -42
- package/configuration.ts +26 -20
- package/coverage/clover.xml +1331 -1278
- 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 +352 -121
- 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 +2939 -2823
- 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 +5 -16
- package/dist/api/calls-api.js +0 -11
- package/dist/api/conferences-api.d.ts +9 -24
- package/dist/api/conferences-api.js +0 -15
- package/dist/api/media-api.d.ts +4 -14
- package/dist/api/media-api.js +0 -10
- package/dist/api/messages-api.d.ts +2 -10
- package/dist/api/messages-api.js +0 -8
- package/dist/api/mfaapi.d.ts +3 -12
- package/dist/api/mfaapi.js +0 -9
- package/dist/api/multi-channel-api.d.ts +1 -8
- package/dist/api/multi-channel-api.js +0 -7
- package/dist/api/phone-number-lookup-api.d.ts +81 -51
- package/dist/api/phone-number-lookup-api.js +149 -65
- package/dist/api/recordings-api.d.ts +10 -26
- package/dist/api/recordings-api.js +0 -16
- package/dist/api/statistics-api.d.ts +1 -8
- package/dist/api/statistics-api.js +0 -7
- package/dist/api/toll-free-verification-api.d.ts +9 -24
- package/dist/api/toll-free-verification-api.js +0 -15
- package/dist/api/transcriptions-api.d.ts +3 -12
- 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 +1 -45
- 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 +1 -12
- 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/CallState.md +1 -1
- 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/StirShaken.md +1 -1
- 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 +1 -45
- 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 +1 -12
- 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
|
@@ -14,100 +14,50 @@ import type { BusinessEntityTypeEnum } from './business-entity-type-enum';
|
|
|
14
14
|
import type { BusinessRegistrationTypeEnum } from './business-registration-type-enum';
|
|
15
15
|
import type { Contact } from './contact';
|
|
16
16
|
import type { OptInWorkflow } from './opt-in-workflow';
|
|
17
|
-
/**
|
|
18
|
-
*
|
|
19
|
-
* @export
|
|
20
|
-
* @interface TfvSubmissionInfo
|
|
21
|
-
*/
|
|
22
17
|
export interface TfvSubmissionInfo {
|
|
23
|
-
/**
|
|
24
|
-
*
|
|
25
|
-
* @type {Address}
|
|
26
|
-
* @memberof TfvSubmissionInfo
|
|
27
|
-
*/
|
|
28
18
|
'businessAddress'?: Address;
|
|
29
|
-
/**
|
|
30
|
-
*
|
|
31
|
-
* @type {Contact}
|
|
32
|
-
* @memberof TfvSubmissionInfo
|
|
33
|
-
*/
|
|
34
19
|
'businessContact'?: Contact;
|
|
35
20
|
/**
|
|
36
21
|
* Estimated monthly volume of messages from the toll-free number.
|
|
37
|
-
* @type {number}
|
|
38
|
-
* @memberof TfvSubmissionInfo
|
|
39
22
|
*/
|
|
40
23
|
'messageVolume'?: number;
|
|
41
24
|
/**
|
|
42
25
|
* The category of the use case.
|
|
43
|
-
* @type {string}
|
|
44
|
-
* @memberof TfvSubmissionInfo
|
|
45
26
|
*/
|
|
46
27
|
'useCase'?: string;
|
|
47
28
|
/**
|
|
48
29
|
* A general idea of the use case and customer.
|
|
49
|
-
* @type {string}
|
|
50
|
-
* @memberof TfvSubmissionInfo
|
|
51
30
|
*/
|
|
52
31
|
'useCaseSummary'?: string;
|
|
53
32
|
/**
|
|
54
33
|
* Example of message content.
|
|
55
|
-
* @type {string}
|
|
56
|
-
* @memberof TfvSubmissionInfo
|
|
57
34
|
*/
|
|
58
35
|
'productionMessageContent'?: string;
|
|
59
|
-
/**
|
|
60
|
-
*
|
|
61
|
-
* @type {OptInWorkflow}
|
|
62
|
-
* @memberof TfvSubmissionInfo
|
|
63
|
-
*/
|
|
64
36
|
'optInWorkflow'?: OptInWorkflow;
|
|
65
37
|
/**
|
|
66
38
|
* Any additional information.
|
|
67
|
-
* @type {string}
|
|
68
|
-
* @memberof TfvSubmissionInfo
|
|
69
39
|
*/
|
|
70
40
|
'additionalInformation'?: string | null;
|
|
71
41
|
/**
|
|
72
42
|
* ISV name.
|
|
73
|
-
* @type {string}
|
|
74
|
-
* @memberof TfvSubmissionInfo
|
|
75
43
|
*/
|
|
76
44
|
'isvReseller'?: string | null;
|
|
77
45
|
/**
|
|
78
46
|
* The Toll-Free Verification request privacy policy URL.
|
|
79
|
-
* @type {string}
|
|
80
|
-
* @memberof TfvSubmissionInfo
|
|
81
47
|
*/
|
|
82
48
|
'privacyPolicyUrl'?: string;
|
|
83
49
|
/**
|
|
84
50
|
* The Toll-Free Verification request terms and conditions policy URL.
|
|
85
|
-
* @type {string}
|
|
86
|
-
* @memberof TfvSubmissionInfo
|
|
87
51
|
*/
|
|
88
52
|
'termsAndConditionsUrl'?: string;
|
|
89
53
|
/**
|
|
90
54
|
* The company \'Doing Business As\'.
|
|
91
|
-
* @type {string}
|
|
92
|
-
* @memberof TfvSubmissionInfo
|
|
93
55
|
*/
|
|
94
56
|
'businessDba'?: string;
|
|
95
57
|
/**
|
|
96
58
|
* US Federal Tax ID Number (EIN) or Canada Business Number (CBN). Optional until early 2026. If a value is provided for this field, a value must be provided for `businessRegistrationType` and `businessEntityType`. Available starting October 1st, 2025.
|
|
97
|
-
* @type {string}
|
|
98
|
-
* @memberof TfvSubmissionInfo
|
|
99
59
|
*/
|
|
100
60
|
'businessRegistrationNumber'?: string | null;
|
|
101
|
-
/**
|
|
102
|
-
*
|
|
103
|
-
* @type {BusinessRegistrationTypeEnum}
|
|
104
|
-
* @memberof TfvSubmissionInfo
|
|
105
|
-
*/
|
|
106
61
|
'businessRegistrationType'?: BusinessRegistrationTypeEnum | null;
|
|
107
|
-
/**
|
|
108
|
-
*
|
|
109
|
-
* @type {BusinessEntityTypeEnum}
|
|
110
|
-
* @memberof TfvSubmissionInfo
|
|
111
|
-
*/
|
|
112
62
|
'businessEntityType'?: BusinessEntityTypeEnum | null;
|
|
113
63
|
}
|
|
@@ -10,16 +10,6 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { VerificationUpdateRequest } from './verification-update-request';
|
|
13
|
-
/**
|
|
14
|
-
*
|
|
15
|
-
* @export
|
|
16
|
-
* @interface TfvSubmissionWrapper
|
|
17
|
-
*/
|
|
18
13
|
export interface TfvSubmissionWrapper {
|
|
19
|
-
/**
|
|
20
|
-
*
|
|
21
|
-
* @type {VerificationUpdateRequest}
|
|
22
|
-
* @memberof TfvSubmissionWrapper
|
|
23
|
-
*/
|
|
24
14
|
'submission'?: VerificationUpdateRequest;
|
|
25
15
|
}
|
|
@@ -16,8 +16,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
16
16
|
exports.ThumbnailAlignmentEnum = void 0;
|
|
17
17
|
/**
|
|
18
18
|
* The alignment of the thumbnail image in the card. Only applicable if the card using horizontal orientation.
|
|
19
|
-
* @export
|
|
20
|
-
* @enum {string}
|
|
21
19
|
*/
|
|
22
20
|
exports.ThumbnailAlignmentEnum = {
|
|
23
21
|
Left: 'LEFT',
|
|
@@ -10,52 +10,30 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { CallbackMethodEnum } from './callback-method-enum';
|
|
13
|
-
/**
|
|
14
|
-
*
|
|
15
|
-
* @export
|
|
16
|
-
* @interface TranscribeRecording
|
|
17
|
-
*/
|
|
18
13
|
export interface TranscribeRecording {
|
|
19
14
|
/**
|
|
20
15
|
* The URL to send the [TranscriptionAvailable](/docs/voice/webhooks/transcriptionAvailable) event to. You should not include sensitive or personally-identifiable information in the callbackUrl field! Always use the proper username and password fields for authorization.
|
|
21
|
-
* @type {string}
|
|
22
|
-
* @memberof TranscribeRecording
|
|
23
16
|
*/
|
|
24
17
|
'callbackUrl'?: string;
|
|
25
|
-
/**
|
|
26
|
-
*
|
|
27
|
-
* @type {CallbackMethodEnum}
|
|
28
|
-
* @memberof TranscribeRecording
|
|
29
|
-
*/
|
|
30
18
|
'callbackMethod'?: CallbackMethodEnum | null;
|
|
31
19
|
/**
|
|
32
20
|
* Basic auth username.
|
|
33
|
-
* @type {string}
|
|
34
|
-
* @memberof TranscribeRecording
|
|
35
21
|
*/
|
|
36
22
|
'username'?: string | null;
|
|
37
23
|
/**
|
|
38
24
|
* Basic auth password.
|
|
39
|
-
* @type {string}
|
|
40
|
-
* @memberof TranscribeRecording
|
|
41
25
|
*/
|
|
42
26
|
'password'?: string | null;
|
|
43
27
|
/**
|
|
44
28
|
* (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present.
|
|
45
|
-
* @type {string}
|
|
46
|
-
* @memberof TranscribeRecording
|
|
47
29
|
*/
|
|
48
30
|
'tag'?: string | null;
|
|
49
31
|
/**
|
|
50
32
|
* This is the timeout (in seconds) to use when delivering the webhook to `callbackUrl`. Can be any numeric value (including decimals) between 1 and 25.
|
|
51
|
-
* @type {number}
|
|
52
|
-
* @memberof TranscribeRecording
|
|
53
33
|
*/
|
|
54
34
|
'callbackTimeout'?: number | null;
|
|
55
35
|
/**
|
|
56
36
|
* A boolean value to indicate that the recording may not be in English, and the transcription service will need to detect the dominant language the recording is in and transcribe accordingly. Current supported languages are English, French, and Spanish.
|
|
57
|
-
* @type {boolean}
|
|
58
|
-
* @memberof TranscribeRecording
|
|
59
37
|
*/
|
|
60
38
|
'detectLanguage'?: boolean | null;
|
|
61
39
|
}
|
|
@@ -14,134 +14,81 @@ import type { FileFormatEnum } from './file-format-enum';
|
|
|
14
14
|
import type { Transcription } from './transcription';
|
|
15
15
|
/**
|
|
16
16
|
* The Transcription Available event is sent when the recording transcription is available to be downloaded.
|
|
17
|
-
* @export
|
|
18
|
-
* @interface TranscriptionAvailableCallback
|
|
19
17
|
*/
|
|
20
18
|
export interface TranscriptionAvailableCallback {
|
|
21
19
|
/**
|
|
22
20
|
* 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.
|
|
23
|
-
* @type {string}
|
|
24
|
-
* @memberof TranscriptionAvailableCallback
|
|
25
21
|
*/
|
|
26
22
|
'eventType'?: string;
|
|
27
23
|
/**
|
|
28
24
|
* 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.
|
|
29
|
-
* @type {string}
|
|
30
|
-
* @memberof TranscriptionAvailableCallback
|
|
31
25
|
*/
|
|
32
26
|
'eventTime'?: string;
|
|
33
27
|
/**
|
|
34
28
|
* The user account associated with the call.
|
|
35
|
-
* @type {string}
|
|
36
|
-
* @memberof TranscriptionAvailableCallback
|
|
37
29
|
*/
|
|
38
30
|
'accountId'?: string;
|
|
39
31
|
/**
|
|
40
32
|
* The id of the application associated with the call.
|
|
41
|
-
* @type {string}
|
|
42
|
-
* @memberof TranscriptionAvailableCallback
|
|
43
33
|
*/
|
|
44
34
|
'applicationId'?: string;
|
|
45
35
|
/**
|
|
46
36
|
* The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555).
|
|
47
|
-
* @type {string}
|
|
48
|
-
* @memberof TranscriptionAvailableCallback
|
|
49
37
|
*/
|
|
50
38
|
'from'?: string;
|
|
51
39
|
/**
|
|
52
40
|
* The phone number that received the call, in E.164 format (e.g. +15555555555).
|
|
53
|
-
* @type {string}
|
|
54
|
-
* @memberof TranscriptionAvailableCallback
|
|
55
41
|
*/
|
|
56
42
|
'to'?: string;
|
|
57
|
-
/**
|
|
58
|
-
*
|
|
59
|
-
* @type {CallDirectionEnum}
|
|
60
|
-
* @memberof TranscriptionAvailableCallback
|
|
61
|
-
*/
|
|
62
43
|
'direction'?: CallDirectionEnum;
|
|
63
44
|
/**
|
|
64
45
|
* The call id associated with the event.
|
|
65
|
-
* @type {string}
|
|
66
|
-
* @memberof TranscriptionAvailableCallback
|
|
67
46
|
*/
|
|
68
47
|
'callId'?: string;
|
|
69
48
|
/**
|
|
70
49
|
* The URL of the call associated with the event.
|
|
71
|
-
* @type {string}
|
|
72
|
-
* @memberof TranscriptionAvailableCallback
|
|
73
50
|
*/
|
|
74
51
|
'callUrl'?: string;
|
|
75
52
|
/**
|
|
76
53
|
* The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded.
|
|
77
|
-
* @type {string}
|
|
78
|
-
* @memberof TranscriptionAvailableCallback
|
|
79
54
|
*/
|
|
80
55
|
'mediaUrl'?: string | null;
|
|
81
56
|
/**
|
|
82
57
|
* (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.
|
|
83
|
-
* @type {string}
|
|
84
|
-
* @memberof TranscriptionAvailableCallback
|
|
85
58
|
*/
|
|
86
59
|
'parentCallId'?: string;
|
|
87
60
|
/**
|
|
88
61
|
* The unique ID of this recording
|
|
89
|
-
* @type {string}
|
|
90
|
-
* @memberof TranscriptionAvailableCallback
|
|
91
62
|
*/
|
|
92
63
|
'recordingId'?: string;
|
|
93
64
|
/**
|
|
94
65
|
* (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format.
|
|
95
|
-
* @type {string}
|
|
96
|
-
* @memberof TranscriptionAvailableCallback
|
|
97
66
|
*/
|
|
98
67
|
'enqueuedTime'?: string | null;
|
|
99
68
|
/**
|
|
100
69
|
* Time the call was started, in ISO 8601 format.
|
|
101
|
-
* @type {string}
|
|
102
|
-
* @memberof TranscriptionAvailableCallback
|
|
103
70
|
*/
|
|
104
71
|
'startTime'?: string;
|
|
105
72
|
/**
|
|
106
73
|
* The time that the recording ended in ISO-8601 format
|
|
107
|
-
* @type {string}
|
|
108
|
-
* @memberof TranscriptionAvailableCallback
|
|
109
74
|
*/
|
|
110
75
|
'endTime'?: string;
|
|
111
76
|
/**
|
|
112
77
|
* The duration of the recording in ISO-8601 format
|
|
113
|
-
* @type {string}
|
|
114
|
-
* @memberof TranscriptionAvailableCallback
|
|
115
78
|
*/
|
|
116
79
|
'duration'?: string;
|
|
117
|
-
/**
|
|
118
|
-
*
|
|
119
|
-
* @type {FileFormatEnum}
|
|
120
|
-
* @memberof TranscriptionAvailableCallback
|
|
121
|
-
*/
|
|
122
80
|
'fileFormat'?: FileFormatEnum;
|
|
123
81
|
/**
|
|
124
82
|
* (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present.
|
|
125
|
-
* @type {string}
|
|
126
|
-
* @memberof TranscriptionAvailableCallback
|
|
127
83
|
*/
|
|
128
84
|
'tag'?: string | null;
|
|
129
|
-
/**
|
|
130
|
-
*
|
|
131
|
-
* @type {Transcription}
|
|
132
|
-
* @memberof TranscriptionAvailableCallback
|
|
133
|
-
*/
|
|
134
85
|
'transcription'?: Transcription;
|
|
135
86
|
/**
|
|
136
87
|
* The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555).
|
|
137
|
-
* @type {string}
|
|
138
|
-
* @memberof TranscriptionAvailableCallback
|
|
139
88
|
*/
|
|
140
89
|
'transferCallerId'?: string;
|
|
141
90
|
/**
|
|
142
91
|
* The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555).
|
|
143
|
-
* @type {string}
|
|
144
|
-
* @memberof TranscriptionAvailableCallback
|
|
145
92
|
*/
|
|
146
93
|
'transferTo'?: string;
|
|
147
94
|
}
|
|
@@ -9,22 +9,13 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
/**
|
|
13
|
-
*
|
|
14
|
-
* @export
|
|
15
|
-
* @interface Transcription
|
|
16
|
-
*/
|
|
17
12
|
export interface Transcription {
|
|
18
13
|
/**
|
|
19
14
|
* The transcribed text
|
|
20
|
-
* @type {string}
|
|
21
|
-
* @memberof Transcription
|
|
22
15
|
*/
|
|
23
16
|
'text'?: string;
|
|
24
17
|
/**
|
|
25
18
|
* The confidence on the recognized content, ranging from `0.0` to `1.0` with `1.0` being the highest confidence.
|
|
26
|
-
* @type {number}
|
|
27
|
-
* @memberof Transcription
|
|
28
19
|
*/
|
|
29
20
|
'confidence'?: number;
|
|
30
21
|
}
|
|
@@ -12,98 +12,63 @@
|
|
|
12
12
|
import type { CallDirectionEnum } from './call-direction-enum';
|
|
13
13
|
/**
|
|
14
14
|
* When processing a <Transfer> verb, this event is sent when a called party (B-leg) answers. The event is sent to the endpoint specified in the transferAnswerUrl attribute of the <PhoneNumber> tag that answered. BXML returned by this callback will be executed for the called party only. After all BXML has been executed, the called party will be bridged to the original call. Most BXML verbs are allowed in response to a transferAnswer event, but some are not allowed.
|
|
15
|
-
* @export
|
|
16
|
-
* @interface TransferAnswerCallback
|
|
17
15
|
*/
|
|
18
16
|
export interface TransferAnswerCallback {
|
|
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 TransferAnswerCallback
|
|
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 TransferAnswerCallback
|
|
29
23
|
*/
|
|
30
24
|
'eventTime'?: string;
|
|
31
25
|
/**
|
|
32
26
|
* The user account associated with the call.
|
|
33
|
-
* @type {string}
|
|
34
|
-
* @memberof TransferAnswerCallback
|
|
35
27
|
*/
|
|
36
28
|
'accountId'?: string;
|
|
37
29
|
/**
|
|
38
30
|
* The id of the application associated with the call.
|
|
39
|
-
* @type {string}
|
|
40
|
-
* @memberof TransferAnswerCallback
|
|
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 TransferAnswerCallback
|
|
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 TransferAnswerCallback
|
|
53
39
|
*/
|
|
54
40
|
'to'?: string;
|
|
55
|
-
/**
|
|
56
|
-
*
|
|
57
|
-
* @type {CallDirectionEnum}
|
|
58
|
-
* @memberof TransferAnswerCallback
|
|
59
|
-
*/
|
|
60
41
|
'direction'?: CallDirectionEnum;
|
|
61
42
|
/**
|
|
62
43
|
* The call id associated with the event.
|
|
63
|
-
* @type {string}
|
|
64
|
-
* @memberof TransferAnswerCallback
|
|
65
44
|
*/
|
|
66
45
|
'callId'?: string;
|
|
67
46
|
/**
|
|
68
47
|
* The URL of the call associated with the event.
|
|
69
|
-
* @type {string}
|
|
70
|
-
* @memberof TransferAnswerCallback
|
|
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 TransferAnswerCallback
|
|
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 TransferAnswerCallback
|
|
83
56
|
*/
|
|
84
57
|
'startTime'?: string;
|
|
85
58
|
/**
|
|
86
59
|
* Time the call was answered, in ISO 8601 format.
|
|
87
|
-
* @type {string}
|
|
88
|
-
* @memberof TransferAnswerCallback
|
|
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 TransferAnswerCallback
|
|
95
64
|
*/
|
|
96
65
|
'tag'?: string | null;
|
|
97
66
|
/**
|
|
98
67
|
* The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555).
|
|
99
|
-
* @type {string}
|
|
100
|
-
* @memberof TransferAnswerCallback
|
|
101
68
|
*/
|
|
102
69
|
'transferCallerId'?: string;
|
|
103
70
|
/**
|
|
104
71
|
* The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555).
|
|
105
|
-
* @type {string}
|
|
106
|
-
* @memberof TransferAnswerCallback
|
|
107
72
|
*/
|
|
108
73
|
'transferTo'?: string;
|
|
109
74
|
}
|
|
@@ -12,116 +12,75 @@
|
|
|
12
12
|
import type { CallDirectionEnum } from './call-direction-enum';
|
|
13
13
|
/**
|
|
14
14
|
* This event is sent to the transferCompleteUrl of the A-leg\'s <Transfer> verb when the transferred call (B-leg) completes. In a simultaneous ringing scenario, only one B-leg succeeds and this event corresponds to that successful leg. If none of the calls were answered, the transferComplete event corresponds to one of the legs.
|
|
15
|
-
* @export
|
|
16
|
-
* @interface TransferCompleteCallback
|
|
17
15
|
*/
|
|
18
16
|
export interface TransferCompleteCallback {
|
|
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 TransferCompleteCallback
|
|
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 TransferCompleteCallback
|
|
29
23
|
*/
|
|
30
24
|
'eventTime'?: string;
|
|
31
25
|
/**
|
|
32
26
|
* The user account associated with the call.
|
|
33
|
-
* @type {string}
|
|
34
|
-
* @memberof TransferCompleteCallback
|
|
35
27
|
*/
|
|
36
28
|
'accountId'?: string;
|
|
37
29
|
/**
|
|
38
30
|
* The id of the application associated with the call.
|
|
39
|
-
* @type {string}
|
|
40
|
-
* @memberof TransferCompleteCallback
|
|
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 TransferCompleteCallback
|
|
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 TransferCompleteCallback
|
|
53
39
|
*/
|
|
54
40
|
'to'?: string;
|
|
55
|
-
/**
|
|
56
|
-
*
|
|
57
|
-
* @type {CallDirectionEnum}
|
|
58
|
-
* @memberof TransferCompleteCallback
|
|
59
|
-
*/
|
|
60
41
|
'direction'?: CallDirectionEnum;
|
|
61
42
|
/**
|
|
62
43
|
* The call id associated with the event.
|
|
63
|
-
* @type {string}
|
|
64
|
-
* @memberof TransferCompleteCallback
|
|
65
44
|
*/
|
|
66
45
|
'callId'?: string;
|
|
67
46
|
/**
|
|
68
47
|
* The URL of the call associated with the event.
|
|
69
|
-
* @type {string}
|
|
70
|
-
* @memberof TransferCompleteCallback
|
|
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 TransferCompleteCallback
|
|
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 TransferCompleteCallback
|
|
83
56
|
*/
|
|
84
57
|
'startTime'?: string;
|
|
85
58
|
/**
|
|
86
59
|
* Time the call was answered, in ISO 8601 format.
|
|
87
|
-
* @type {string}
|
|
88
|
-
* @memberof TransferCompleteCallback
|
|
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 TransferCompleteCallback
|
|
95
64
|
*/
|
|
96
65
|
'tag'?: string | null;
|
|
97
66
|
/**
|
|
98
67
|
* The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555).
|
|
99
|
-
* @type {string}
|
|
100
|
-
* @memberof TransferCompleteCallback
|
|
101
68
|
*/
|
|
102
69
|
'transferCallerId'?: string;
|
|
103
70
|
/**
|
|
104
71
|
* The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555).
|
|
105
|
-
* @type {string}
|
|
106
|
-
* @memberof TransferCompleteCallback
|
|
107
72
|
*/
|
|
108
73
|
'transferTo'?: string;
|
|
109
74
|
/**
|
|
110
75
|
* Reason the call failed - hangup, busy, timeout, cancel, rejected, callback-error, invalid-bxml, application-error, account-limit, node-capacity-exceeded, error, or unknown.
|
|
111
|
-
* @type {string}
|
|
112
|
-
* @memberof TransferCompleteCallback
|
|
113
76
|
*/
|
|
114
77
|
'cause'?: string;
|
|
115
78
|
/**
|
|
116
79
|
* Text explaining the reason that caused the call to fail in case of errors.
|
|
117
|
-
* @type {string}
|
|
118
|
-
* @memberof TransferCompleteCallback
|
|
119
80
|
*/
|
|
120
81
|
'errorMessage'?: string | null;
|
|
121
82
|
/**
|
|
122
83
|
* Bandwidth\'s internal id that references the error event.
|
|
123
|
-
* @type {string}
|
|
124
|
-
* @memberof TransferCompleteCallback
|
|
125
84
|
*/
|
|
126
85
|
'errorId'?: string | null;
|
|
127
86
|
}
|