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
|
@@ -17,52 +17,30 @@
|
|
|
17
17
|
// @ts-ignore
|
|
18
18
|
import type { CallbackMethodEnum } from './callback-method-enum';
|
|
19
19
|
|
|
20
|
-
/**
|
|
21
|
-
*
|
|
22
|
-
* @export
|
|
23
|
-
* @interface TranscribeRecording
|
|
24
|
-
*/
|
|
25
20
|
export interface TranscribeRecording {
|
|
26
21
|
/**
|
|
27
22
|
* 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.
|
|
28
|
-
* @type {string}
|
|
29
|
-
* @memberof TranscribeRecording
|
|
30
23
|
*/
|
|
31
24
|
'callbackUrl'?: string;
|
|
32
|
-
/**
|
|
33
|
-
*
|
|
34
|
-
* @type {CallbackMethodEnum}
|
|
35
|
-
* @memberof TranscribeRecording
|
|
36
|
-
*/
|
|
37
25
|
'callbackMethod'?: CallbackMethodEnum | null;
|
|
38
26
|
/**
|
|
39
27
|
* Basic auth username.
|
|
40
|
-
* @type {string}
|
|
41
|
-
* @memberof TranscribeRecording
|
|
42
28
|
*/
|
|
43
29
|
'username'?: string | null;
|
|
44
30
|
/**
|
|
45
31
|
* Basic auth password.
|
|
46
|
-
* @type {string}
|
|
47
|
-
* @memberof TranscribeRecording
|
|
48
32
|
*/
|
|
49
33
|
'password'?: string | null;
|
|
50
34
|
/**
|
|
51
35
|
* (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present.
|
|
52
|
-
* @type {string}
|
|
53
|
-
* @memberof TranscribeRecording
|
|
54
36
|
*/
|
|
55
37
|
'tag'?: string | null;
|
|
56
38
|
/**
|
|
57
39
|
* 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.
|
|
58
|
-
* @type {number}
|
|
59
|
-
* @memberof TranscribeRecording
|
|
60
40
|
*/
|
|
61
41
|
'callbackTimeout'?: number | null;
|
|
62
42
|
/**
|
|
63
43
|
* 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.
|
|
64
|
-
* @type {boolean}
|
|
65
|
-
* @memberof TranscribeRecording
|
|
66
44
|
*/
|
|
67
45
|
'detectLanguage'?: boolean | null;
|
|
68
46
|
}
|
|
@@ -25,134 +25,81 @@ import type { Transcription } from './transcription';
|
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* The Transcription Available event is sent when the recording transcription is available to be downloaded.
|
|
28
|
-
* @export
|
|
29
|
-
* @interface TranscriptionAvailableCallback
|
|
30
28
|
*/
|
|
31
29
|
export interface TranscriptionAvailableCallback {
|
|
32
30
|
/**
|
|
33
31
|
* 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.
|
|
34
|
-
* @type {string}
|
|
35
|
-
* @memberof TranscriptionAvailableCallback
|
|
36
32
|
*/
|
|
37
33
|
'eventType'?: string;
|
|
38
34
|
/**
|
|
39
35
|
* 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.
|
|
40
|
-
* @type {string}
|
|
41
|
-
* @memberof TranscriptionAvailableCallback
|
|
42
36
|
*/
|
|
43
37
|
'eventTime'?: string;
|
|
44
38
|
/**
|
|
45
39
|
* The user account associated with the call.
|
|
46
|
-
* @type {string}
|
|
47
|
-
* @memberof TranscriptionAvailableCallback
|
|
48
40
|
*/
|
|
49
41
|
'accountId'?: string;
|
|
50
42
|
/**
|
|
51
43
|
* The id of the application associated with the call.
|
|
52
|
-
* @type {string}
|
|
53
|
-
* @memberof TranscriptionAvailableCallback
|
|
54
44
|
*/
|
|
55
45
|
'applicationId'?: string;
|
|
56
46
|
/**
|
|
57
47
|
* The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555).
|
|
58
|
-
* @type {string}
|
|
59
|
-
* @memberof TranscriptionAvailableCallback
|
|
60
48
|
*/
|
|
61
49
|
'from'?: string;
|
|
62
50
|
/**
|
|
63
51
|
* The phone number that received the call, in E.164 format (e.g. +15555555555).
|
|
64
|
-
* @type {string}
|
|
65
|
-
* @memberof TranscriptionAvailableCallback
|
|
66
52
|
*/
|
|
67
53
|
'to'?: string;
|
|
68
|
-
/**
|
|
69
|
-
*
|
|
70
|
-
* @type {CallDirectionEnum}
|
|
71
|
-
* @memberof TranscriptionAvailableCallback
|
|
72
|
-
*/
|
|
73
54
|
'direction'?: CallDirectionEnum;
|
|
74
55
|
/**
|
|
75
56
|
* The call id associated with the event.
|
|
76
|
-
* @type {string}
|
|
77
|
-
* @memberof TranscriptionAvailableCallback
|
|
78
57
|
*/
|
|
79
58
|
'callId'?: string;
|
|
80
59
|
/**
|
|
81
60
|
* The URL of the call associated with the event.
|
|
82
|
-
* @type {string}
|
|
83
|
-
* @memberof TranscriptionAvailableCallback
|
|
84
61
|
*/
|
|
85
62
|
'callUrl'?: string;
|
|
86
63
|
/**
|
|
87
64
|
* The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded.
|
|
88
|
-
* @type {string}
|
|
89
|
-
* @memberof TranscriptionAvailableCallback
|
|
90
65
|
*/
|
|
91
66
|
'mediaUrl'?: string | null;
|
|
92
67
|
/**
|
|
93
68
|
* (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.
|
|
94
|
-
* @type {string}
|
|
95
|
-
* @memberof TranscriptionAvailableCallback
|
|
96
69
|
*/
|
|
97
70
|
'parentCallId'?: string;
|
|
98
71
|
/**
|
|
99
72
|
* The unique ID of this recording
|
|
100
|
-
* @type {string}
|
|
101
|
-
* @memberof TranscriptionAvailableCallback
|
|
102
73
|
*/
|
|
103
74
|
'recordingId'?: string;
|
|
104
75
|
/**
|
|
105
76
|
* (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format.
|
|
106
|
-
* @type {string}
|
|
107
|
-
* @memberof TranscriptionAvailableCallback
|
|
108
77
|
*/
|
|
109
78
|
'enqueuedTime'?: string | null;
|
|
110
79
|
/**
|
|
111
80
|
* Time the call was started, in ISO 8601 format.
|
|
112
|
-
* @type {string}
|
|
113
|
-
* @memberof TranscriptionAvailableCallback
|
|
114
81
|
*/
|
|
115
82
|
'startTime'?: string;
|
|
116
83
|
/**
|
|
117
84
|
* The time that the recording ended in ISO-8601 format
|
|
118
|
-
* @type {string}
|
|
119
|
-
* @memberof TranscriptionAvailableCallback
|
|
120
85
|
*/
|
|
121
86
|
'endTime'?: string;
|
|
122
87
|
/**
|
|
123
88
|
* The duration of the recording in ISO-8601 format
|
|
124
|
-
* @type {string}
|
|
125
|
-
* @memberof TranscriptionAvailableCallback
|
|
126
89
|
*/
|
|
127
90
|
'duration'?: string;
|
|
128
|
-
/**
|
|
129
|
-
*
|
|
130
|
-
* @type {FileFormatEnum}
|
|
131
|
-
* @memberof TranscriptionAvailableCallback
|
|
132
|
-
*/
|
|
133
91
|
'fileFormat'?: FileFormatEnum;
|
|
134
92
|
/**
|
|
135
93
|
* (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present.
|
|
136
|
-
* @type {string}
|
|
137
|
-
* @memberof TranscriptionAvailableCallback
|
|
138
94
|
*/
|
|
139
95
|
'tag'?: string | null;
|
|
140
|
-
/**
|
|
141
|
-
*
|
|
142
|
-
* @type {Transcription}
|
|
143
|
-
* @memberof TranscriptionAvailableCallback
|
|
144
|
-
*/
|
|
145
96
|
'transcription'?: Transcription;
|
|
146
97
|
/**
|
|
147
98
|
* The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555).
|
|
148
|
-
* @type {string}
|
|
149
|
-
* @memberof TranscriptionAvailableCallback
|
|
150
99
|
*/
|
|
151
100
|
'transferCallerId'?: string;
|
|
152
101
|
/**
|
|
153
102
|
* The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555).
|
|
154
|
-
* @type {string}
|
|
155
|
-
* @memberof TranscriptionAvailableCallback
|
|
156
103
|
*/
|
|
157
104
|
'transferTo'?: string;
|
|
158
105
|
}
|
package/models/transcription.ts
CHANGED
|
@@ -14,22 +14,13 @@
|
|
|
14
14
|
|
|
15
15
|
|
|
16
16
|
|
|
17
|
-
/**
|
|
18
|
-
*
|
|
19
|
-
* @export
|
|
20
|
-
* @interface Transcription
|
|
21
|
-
*/
|
|
22
17
|
export interface Transcription {
|
|
23
18
|
/**
|
|
24
19
|
* The transcribed text
|
|
25
|
-
* @type {string}
|
|
26
|
-
* @memberof Transcription
|
|
27
20
|
*/
|
|
28
21
|
'text'?: string;
|
|
29
22
|
/**
|
|
30
23
|
* The confidence on the recognized content, ranging from `0.0` to `1.0` with `1.0` being the highest confidence.
|
|
31
|
-
* @type {number}
|
|
32
|
-
* @memberof Transcription
|
|
33
24
|
*/
|
|
34
25
|
'confidence'?: number;
|
|
35
26
|
}
|
|
@@ -19,98 +19,63 @@ import type { CallDirectionEnum } from './call-direction-enum';
|
|
|
19
19
|
|
|
20
20
|
/**
|
|
21
21
|
* 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.
|
|
22
|
-
* @export
|
|
23
|
-
* @interface TransferAnswerCallback
|
|
24
22
|
*/
|
|
25
23
|
export interface TransferAnswerCallback {
|
|
26
24
|
/**
|
|
27
25
|
* 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.
|
|
28
|
-
* @type {string}
|
|
29
|
-
* @memberof TransferAnswerCallback
|
|
30
26
|
*/
|
|
31
27
|
'eventType'?: string;
|
|
32
28
|
/**
|
|
33
29
|
* 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.
|
|
34
|
-
* @type {string}
|
|
35
|
-
* @memberof TransferAnswerCallback
|
|
36
30
|
*/
|
|
37
31
|
'eventTime'?: string;
|
|
38
32
|
/**
|
|
39
33
|
* The user account associated with the call.
|
|
40
|
-
* @type {string}
|
|
41
|
-
* @memberof TransferAnswerCallback
|
|
42
34
|
*/
|
|
43
35
|
'accountId'?: string;
|
|
44
36
|
/**
|
|
45
37
|
* The id of the application associated with the call.
|
|
46
|
-
* @type {string}
|
|
47
|
-
* @memberof TransferAnswerCallback
|
|
48
38
|
*/
|
|
49
39
|
'applicationId'?: string;
|
|
50
40
|
/**
|
|
51
41
|
* The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555).
|
|
52
|
-
* @type {string}
|
|
53
|
-
* @memberof TransferAnswerCallback
|
|
54
42
|
*/
|
|
55
43
|
'from'?: string;
|
|
56
44
|
/**
|
|
57
45
|
* The phone number that received the call, in E.164 format (e.g. +15555555555).
|
|
58
|
-
* @type {string}
|
|
59
|
-
* @memberof TransferAnswerCallback
|
|
60
46
|
*/
|
|
61
47
|
'to'?: string;
|
|
62
|
-
/**
|
|
63
|
-
*
|
|
64
|
-
* @type {CallDirectionEnum}
|
|
65
|
-
* @memberof TransferAnswerCallback
|
|
66
|
-
*/
|
|
67
48
|
'direction'?: CallDirectionEnum;
|
|
68
49
|
/**
|
|
69
50
|
* The call id associated with the event.
|
|
70
|
-
* @type {string}
|
|
71
|
-
* @memberof TransferAnswerCallback
|
|
72
51
|
*/
|
|
73
52
|
'callId'?: string;
|
|
74
53
|
/**
|
|
75
54
|
* The URL of the call associated with the event.
|
|
76
|
-
* @type {string}
|
|
77
|
-
* @memberof TransferAnswerCallback
|
|
78
55
|
*/
|
|
79
56
|
'callUrl'?: string;
|
|
80
57
|
/**
|
|
81
58
|
* (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format.
|
|
82
|
-
* @type {string}
|
|
83
|
-
* @memberof TransferAnswerCallback
|
|
84
59
|
*/
|
|
85
60
|
'enqueuedTime'?: string | null;
|
|
86
61
|
/**
|
|
87
62
|
* Time the call was started, in ISO 8601 format.
|
|
88
|
-
* @type {string}
|
|
89
|
-
* @memberof TransferAnswerCallback
|
|
90
63
|
*/
|
|
91
64
|
'startTime'?: string;
|
|
92
65
|
/**
|
|
93
66
|
* Time the call was answered, in ISO 8601 format.
|
|
94
|
-
* @type {string}
|
|
95
|
-
* @memberof TransferAnswerCallback
|
|
96
67
|
*/
|
|
97
68
|
'answerTime'?: string | null;
|
|
98
69
|
/**
|
|
99
70
|
* (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present.
|
|
100
|
-
* @type {string}
|
|
101
|
-
* @memberof TransferAnswerCallback
|
|
102
71
|
*/
|
|
103
72
|
'tag'?: string | null;
|
|
104
73
|
/**
|
|
105
74
|
* The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555).
|
|
106
|
-
* @type {string}
|
|
107
|
-
* @memberof TransferAnswerCallback
|
|
108
75
|
*/
|
|
109
76
|
'transferCallerId'?: string;
|
|
110
77
|
/**
|
|
111
78
|
* The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555).
|
|
112
|
-
* @type {string}
|
|
113
|
-
* @memberof TransferAnswerCallback
|
|
114
79
|
*/
|
|
115
80
|
'transferTo'?: string;
|
|
116
81
|
}
|
|
@@ -19,116 +19,75 @@ import type { CallDirectionEnum } from './call-direction-enum';
|
|
|
19
19
|
|
|
20
20
|
/**
|
|
21
21
|
* 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.
|
|
22
|
-
* @export
|
|
23
|
-
* @interface TransferCompleteCallback
|
|
24
22
|
*/
|
|
25
23
|
export interface TransferCompleteCallback {
|
|
26
24
|
/**
|
|
27
25
|
* 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.
|
|
28
|
-
* @type {string}
|
|
29
|
-
* @memberof TransferCompleteCallback
|
|
30
26
|
*/
|
|
31
27
|
'eventType'?: string;
|
|
32
28
|
/**
|
|
33
29
|
* 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.
|
|
34
|
-
* @type {string}
|
|
35
|
-
* @memberof TransferCompleteCallback
|
|
36
30
|
*/
|
|
37
31
|
'eventTime'?: string;
|
|
38
32
|
/**
|
|
39
33
|
* The user account associated with the call.
|
|
40
|
-
* @type {string}
|
|
41
|
-
* @memberof TransferCompleteCallback
|
|
42
34
|
*/
|
|
43
35
|
'accountId'?: string;
|
|
44
36
|
/**
|
|
45
37
|
* The id of the application associated with the call.
|
|
46
|
-
* @type {string}
|
|
47
|
-
* @memberof TransferCompleteCallback
|
|
48
38
|
*/
|
|
49
39
|
'applicationId'?: string;
|
|
50
40
|
/**
|
|
51
41
|
* The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555).
|
|
52
|
-
* @type {string}
|
|
53
|
-
* @memberof TransferCompleteCallback
|
|
54
42
|
*/
|
|
55
43
|
'from'?: string;
|
|
56
44
|
/**
|
|
57
45
|
* The phone number that received the call, in E.164 format (e.g. +15555555555).
|
|
58
|
-
* @type {string}
|
|
59
|
-
* @memberof TransferCompleteCallback
|
|
60
46
|
*/
|
|
61
47
|
'to'?: string;
|
|
62
|
-
/**
|
|
63
|
-
*
|
|
64
|
-
* @type {CallDirectionEnum}
|
|
65
|
-
* @memberof TransferCompleteCallback
|
|
66
|
-
*/
|
|
67
48
|
'direction'?: CallDirectionEnum;
|
|
68
49
|
/**
|
|
69
50
|
* The call id associated with the event.
|
|
70
|
-
* @type {string}
|
|
71
|
-
* @memberof TransferCompleteCallback
|
|
72
51
|
*/
|
|
73
52
|
'callId'?: string;
|
|
74
53
|
/**
|
|
75
54
|
* The URL of the call associated with the event.
|
|
76
|
-
* @type {string}
|
|
77
|
-
* @memberof TransferCompleteCallback
|
|
78
55
|
*/
|
|
79
56
|
'callUrl'?: string;
|
|
80
57
|
/**
|
|
81
58
|
* (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format.
|
|
82
|
-
* @type {string}
|
|
83
|
-
* @memberof TransferCompleteCallback
|
|
84
59
|
*/
|
|
85
60
|
'enqueuedTime'?: string | null;
|
|
86
61
|
/**
|
|
87
62
|
* Time the call was started, in ISO 8601 format.
|
|
88
|
-
* @type {string}
|
|
89
|
-
* @memberof TransferCompleteCallback
|
|
90
63
|
*/
|
|
91
64
|
'startTime'?: string;
|
|
92
65
|
/**
|
|
93
66
|
* Time the call was answered, in ISO 8601 format.
|
|
94
|
-
* @type {string}
|
|
95
|
-
* @memberof TransferCompleteCallback
|
|
96
67
|
*/
|
|
97
68
|
'answerTime'?: string | null;
|
|
98
69
|
/**
|
|
99
70
|
* (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present.
|
|
100
|
-
* @type {string}
|
|
101
|
-
* @memberof TransferCompleteCallback
|
|
102
71
|
*/
|
|
103
72
|
'tag'?: string | null;
|
|
104
73
|
/**
|
|
105
74
|
* The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555).
|
|
106
|
-
* @type {string}
|
|
107
|
-
* @memberof TransferCompleteCallback
|
|
108
75
|
*/
|
|
109
76
|
'transferCallerId'?: string;
|
|
110
77
|
/**
|
|
111
78
|
* The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555).
|
|
112
|
-
* @type {string}
|
|
113
|
-
* @memberof TransferCompleteCallback
|
|
114
79
|
*/
|
|
115
80
|
'transferTo'?: string;
|
|
116
81
|
/**
|
|
117
82
|
* Reason the call failed - hangup, busy, timeout, cancel, rejected, callback-error, invalid-bxml, application-error, account-limit, node-capacity-exceeded, error, or unknown.
|
|
118
|
-
* @type {string}
|
|
119
|
-
* @memberof TransferCompleteCallback
|
|
120
83
|
*/
|
|
121
84
|
'cause'?: string;
|
|
122
85
|
/**
|
|
123
86
|
* Text explaining the reason that caused the call to fail in case of errors.
|
|
124
|
-
* @type {string}
|
|
125
|
-
* @memberof TransferCompleteCallback
|
|
126
87
|
*/
|
|
127
88
|
'errorMessage'?: string | null;
|
|
128
89
|
/**
|
|
129
90
|
* Bandwidth\'s internal id that references the error event.
|
|
130
|
-
* @type {string}
|
|
131
|
-
* @memberof TransferCompleteCallback
|
|
132
91
|
*/
|
|
133
92
|
'errorId'?: string | null;
|
|
134
93
|
}
|
|
@@ -19,128 +19,83 @@ import type { CallDirectionEnum } from './call-direction-enum';
|
|
|
19
19
|
|
|
20
20
|
/**
|
|
21
21
|
* This event is sent to the transferDisconnectUrl of each <PhoneNumber> tag when its respective call leg ends for any reason. The event is sent in the normal case, when the transferred leg is answered and later hung up, but is also sent if the new leg was never answered in the first place, if it was rejected, and if the original call leg hung up before the transferred leg.
|
|
22
|
-
* @export
|
|
23
|
-
* @interface TransferDisconnectCallback
|
|
24
22
|
*/
|
|
25
23
|
export interface TransferDisconnectCallback {
|
|
26
24
|
/**
|
|
27
25
|
* 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.
|
|
28
|
-
* @type {string}
|
|
29
|
-
* @memberof TransferDisconnectCallback
|
|
30
26
|
*/
|
|
31
27
|
'eventType'?: string;
|
|
32
28
|
/**
|
|
33
29
|
* 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.
|
|
34
|
-
* @type {string}
|
|
35
|
-
* @memberof TransferDisconnectCallback
|
|
36
30
|
*/
|
|
37
31
|
'eventTime'?: string;
|
|
38
32
|
/**
|
|
39
33
|
* The user account associated with the call.
|
|
40
|
-
* @type {string}
|
|
41
|
-
* @memberof TransferDisconnectCallback
|
|
42
34
|
*/
|
|
43
35
|
'accountId'?: string;
|
|
44
36
|
/**
|
|
45
37
|
* The id of the application associated with the call.
|
|
46
|
-
* @type {string}
|
|
47
|
-
* @memberof TransferDisconnectCallback
|
|
48
38
|
*/
|
|
49
39
|
'applicationId'?: string;
|
|
50
40
|
/**
|
|
51
41
|
* The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555).
|
|
52
|
-
* @type {string}
|
|
53
|
-
* @memberof TransferDisconnectCallback
|
|
54
42
|
*/
|
|
55
43
|
'from'?: string;
|
|
56
44
|
/**
|
|
57
45
|
* The phone number that received the call, in E.164 format (e.g. +15555555555).
|
|
58
|
-
* @type {string}
|
|
59
|
-
* @memberof TransferDisconnectCallback
|
|
60
46
|
*/
|
|
61
47
|
'to'?: string;
|
|
62
|
-
/**
|
|
63
|
-
*
|
|
64
|
-
* @type {CallDirectionEnum}
|
|
65
|
-
* @memberof TransferDisconnectCallback
|
|
66
|
-
*/
|
|
67
48
|
'direction'?: CallDirectionEnum;
|
|
68
49
|
/**
|
|
69
50
|
* The call id associated with the event.
|
|
70
|
-
* @type {string}
|
|
71
|
-
* @memberof TransferDisconnectCallback
|
|
72
51
|
*/
|
|
73
52
|
'callId'?: string;
|
|
74
53
|
/**
|
|
75
54
|
* The URL of the call associated with the event.
|
|
76
|
-
* @type {string}
|
|
77
|
-
* @memberof TransferDisconnectCallback
|
|
78
55
|
*/
|
|
79
56
|
'callUrl'?: string;
|
|
80
57
|
/**
|
|
81
58
|
* (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.
|
|
82
|
-
* @type {string}
|
|
83
|
-
* @memberof TransferDisconnectCallback
|
|
84
59
|
*/
|
|
85
60
|
'parentCallId'?: string;
|
|
86
61
|
/**
|
|
87
62
|
* (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format.
|
|
88
|
-
* @type {string}
|
|
89
|
-
* @memberof TransferDisconnectCallback
|
|
90
63
|
*/
|
|
91
64
|
'enqueuedTime'?: string | null;
|
|
92
65
|
/**
|
|
93
66
|
* Time the call was started, in ISO 8601 format.
|
|
94
|
-
* @type {string}
|
|
95
|
-
* @memberof TransferDisconnectCallback
|
|
96
67
|
*/
|
|
97
68
|
'startTime'?: string;
|
|
98
69
|
/**
|
|
99
70
|
* Time the call was answered, in ISO 8601 format.
|
|
100
|
-
* @type {string}
|
|
101
|
-
* @memberof TransferDisconnectCallback
|
|
102
71
|
*/
|
|
103
72
|
'answerTime'?: string | null;
|
|
104
73
|
/**
|
|
105
74
|
* The time that the recording ended in ISO-8601 format
|
|
106
|
-
* @type {string}
|
|
107
|
-
* @memberof TransferDisconnectCallback
|
|
108
75
|
*/
|
|
109
76
|
'endTime'?: string;
|
|
110
77
|
/**
|
|
111
78
|
* (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present.
|
|
112
|
-
* @type {string}
|
|
113
|
-
* @memberof TransferDisconnectCallback
|
|
114
79
|
*/
|
|
115
80
|
'tag'?: string | null;
|
|
116
81
|
/**
|
|
117
82
|
* The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555).
|
|
118
|
-
* @type {string}
|
|
119
|
-
* @memberof TransferDisconnectCallback
|
|
120
83
|
*/
|
|
121
84
|
'transferCallerId'?: string;
|
|
122
85
|
/**
|
|
123
86
|
* The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555).
|
|
124
|
-
* @type {string}
|
|
125
|
-
* @memberof TransferDisconnectCallback
|
|
126
87
|
*/
|
|
127
88
|
'transferTo'?: string;
|
|
128
89
|
/**
|
|
129
90
|
* Reason the call failed - hangup, busy, timeout, cancel, rejected, callback-error, invalid-bxml, application-error, account-limit, node-capacity-exceeded, error, or unknown.
|
|
130
|
-
* @type {string}
|
|
131
|
-
* @memberof TransferDisconnectCallback
|
|
132
91
|
*/
|
|
133
92
|
'cause'?: string;
|
|
134
93
|
/**
|
|
135
94
|
* Text explaining the reason that caused the call to fail in case of errors.
|
|
136
|
-
* @type {string}
|
|
137
|
-
* @memberof TransferDisconnectCallback
|
|
138
95
|
*/
|
|
139
96
|
'errorMessage'?: string | null;
|
|
140
97
|
/**
|
|
141
98
|
* Bandwidth\'s internal id that references the error event.
|
|
142
|
-
* @type {string}
|
|
143
|
-
* @memberof TransferDisconnectCallback
|
|
144
99
|
*/
|
|
145
100
|
'errorId'?: string | null;
|
|
146
101
|
}
|
|
@@ -17,17 +17,7 @@
|
|
|
17
17
|
// @ts-ignore
|
|
18
18
|
import type { RecordingStateEnum } from './recording-state-enum';
|
|
19
19
|
|
|
20
|
-
/**
|
|
21
|
-
*
|
|
22
|
-
* @export
|
|
23
|
-
* @interface UpdateCallRecording
|
|
24
|
-
*/
|
|
25
20
|
export interface UpdateCallRecording {
|
|
26
|
-
/**
|
|
27
|
-
*
|
|
28
|
-
* @type {RecordingStateEnum}
|
|
29
|
-
* @memberof UpdateCallRecording
|
|
30
|
-
*/
|
|
31
21
|
'state': RecordingStateEnum;
|
|
32
22
|
}
|
|
33
23
|
|
package/models/update-call.ts
CHANGED
|
@@ -20,70 +20,36 @@ import type { CallStateEnum } from './call-state-enum';
|
|
|
20
20
|
// @ts-ignore
|
|
21
21
|
import type { RedirectMethodEnum } from './redirect-method-enum';
|
|
22
22
|
|
|
23
|
-
/**
|
|
24
|
-
*
|
|
25
|
-
* @export
|
|
26
|
-
* @interface UpdateCall
|
|
27
|
-
*/
|
|
28
23
|
export interface UpdateCall {
|
|
29
|
-
/**
|
|
30
|
-
*
|
|
31
|
-
* @type {CallStateEnum}
|
|
32
|
-
* @memberof UpdateCall
|
|
33
|
-
*/
|
|
34
24
|
'state'?: CallStateEnum | null;
|
|
35
25
|
/**
|
|
36
26
|
* The URL to send the [Redirect](/docs/voice/bxml/redirect) event to which will provide new BXML. Required if `state` is `active`. Not allowed if `state` is `completed`.
|
|
37
|
-
* @type {string}
|
|
38
|
-
* @memberof UpdateCall
|
|
39
27
|
*/
|
|
40
28
|
'redirectUrl'?: string | null;
|
|
41
|
-
/**
|
|
42
|
-
*
|
|
43
|
-
* @type {RedirectMethodEnum}
|
|
44
|
-
* @memberof UpdateCall
|
|
45
|
-
*/
|
|
46
29
|
'redirectMethod'?: RedirectMethodEnum | null;
|
|
47
30
|
/**
|
|
48
31
|
* Basic auth username.
|
|
49
|
-
* @type {string}
|
|
50
|
-
* @memberof UpdateCall
|
|
51
32
|
*/
|
|
52
33
|
'username'?: string | null;
|
|
53
34
|
/**
|
|
54
35
|
* Basic auth password.
|
|
55
|
-
* @type {string}
|
|
56
|
-
* @memberof UpdateCall
|
|
57
36
|
*/
|
|
58
37
|
'password'?: string | null;
|
|
59
38
|
/**
|
|
60
39
|
* A fallback url which, if provided, will be used to retry the redirect callback delivery in case `redirectUrl` fails to respond.
|
|
61
|
-
* @type {string}
|
|
62
|
-
* @memberof UpdateCall
|
|
63
40
|
*/
|
|
64
41
|
'redirectFallbackUrl'?: string | null;
|
|
65
|
-
/**
|
|
66
|
-
*
|
|
67
|
-
* @type {RedirectMethodEnum}
|
|
68
|
-
* @memberof UpdateCall
|
|
69
|
-
*/
|
|
70
42
|
'redirectFallbackMethod'?: RedirectMethodEnum | null;
|
|
71
43
|
/**
|
|
72
44
|
* Basic auth username.
|
|
73
|
-
* @type {string}
|
|
74
|
-
* @memberof UpdateCall
|
|
75
45
|
*/
|
|
76
46
|
'fallbackUsername'?: string | null;
|
|
77
47
|
/**
|
|
78
48
|
* Basic auth password.
|
|
79
|
-
* @type {string}
|
|
80
|
-
* @memberof UpdateCall
|
|
81
49
|
*/
|
|
82
50
|
'fallbackPassword'?: string | null;
|
|
83
51
|
/**
|
|
84
52
|
* A custom string that will be sent with this and all future callbacks unless overwritten by a future `tag` attribute or [`<Tag>`](/docs/voice/bxml/tag) verb, or cleared. May be cleared by setting `tag=\"\"`. Max length 256 characters. Not allowed if `state` is `completed`.
|
|
85
|
-
* @type {string}
|
|
86
|
-
* @memberof UpdateCall
|
|
87
53
|
*/
|
|
88
54
|
'tag'?: string | null;
|
|
89
55
|
}
|
|
@@ -14,28 +14,17 @@
|
|
|
14
14
|
|
|
15
15
|
|
|
16
16
|
|
|
17
|
-
/**
|
|
18
|
-
*
|
|
19
|
-
* @export
|
|
20
|
-
* @interface UpdateConferenceMember
|
|
21
|
-
*/
|
|
22
17
|
export interface UpdateConferenceMember {
|
|
23
18
|
/**
|
|
24
19
|
* Whether or not this member is currently muted. Members who are muted are still able to hear other participants. Updates this member\'s mute status. Has no effect if omitted.
|
|
25
|
-
* @type {boolean}
|
|
26
|
-
* @memberof UpdateConferenceMember
|
|
27
20
|
*/
|
|
28
21
|
'mute'?: boolean;
|
|
29
22
|
/**
|
|
30
23
|
* Whether or not this member is currently on hold. Members who are on hold are not able to hear or speak in the conference. Updates this member\'s hold status. Has no effect if omitted.
|
|
31
|
-
* @type {boolean}
|
|
32
|
-
* @memberof UpdateConferenceMember
|
|
33
24
|
*/
|
|
34
25
|
'hold'?: boolean;
|
|
35
26
|
/**
|
|
36
27
|
* If this member had a value set for `callIdsToCoach` in its [Conference](/docs/voice/bxml/conference) verb or this list was added with a previous PUT request to modify the member, this is that list of calls. Modifies the calls that this member is coaching. Has no effect if omitted. See the documentation for the [Conference](/docs/voice/bxml/conference) verb for more details about coaching. Note that this will not add the matching calls to the conference; each call must individually execute a Conference verb to join.
|
|
37
|
-
* @type {Array<string>}
|
|
38
|
-
* @memberof UpdateConferenceMember
|
|
39
28
|
*/
|
|
40
29
|
'callIdsToCoach'?: Array<string> | null;
|
|
41
30
|
}
|