bandwidth-sdk 6.2.1 → 7.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/deploy.yml +2 -2
- package/.github/workflows/test-pr.yml +2 -2
- package/.github/workflows/test-smoke.yml +4 -4
- package/.openapi-generator/FILES +34 -10
- package/.openapi-generator/VERSION +1 -1
- package/README.md +245 -6
- package/api/calls-api.ts +0 -11
- package/api/conferences-api.ts +0 -15
- package/api/media-api.ts +0 -10
- package/api/messages-api.ts +0 -8
- package/api/mfaapi.ts +0 -9
- package/api/multi-channel-api.ts +0 -7
- package/api/phone-number-lookup-api.ts +145 -76
- package/api/recordings-api.ts +0 -16
- package/api/statistics-api.ts +0 -7
- package/api/toll-free-verification-api.ts +0 -15
- package/api/transcriptions-api.ts +0 -9
- package/bandwidth.yml +551 -277
- package/base.ts +10 -28
- package/common.ts +5 -42
- package/configuration.ts +26 -20
- package/coverage/clover.xml +1332 -1279
- package/coverage/coverage-final.json +49 -45
- package/coverage/lcov-report/index.html +25 -25
- package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +2 -35
- package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +2 -47
- package/coverage/lcov-report/node-sdk/api/index.html +17 -17
- package/coverage/lcov-report/node-sdk/api/media-api.ts.html +2 -32
- package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +2 -26
- package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +2 -29
- package/coverage/lcov-report/node-sdk/api/multi-channel-api.ts.html +2 -23
- package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +338 -131
- package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +2 -50
- package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +2 -23
- package/coverage/lcov-report/node-sdk/api/toll-free-verification-api.ts.html +2 -47
- package/coverage/lcov-report/node-sdk/api/transcriptions-api.ts.html +2 -29
- package/coverage/lcov-report/node-sdk/api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/base.ts.html +19 -73
- package/coverage/lcov-report/node-sdk/common.ts.html +25 -136
- package/coverage/lcov-report/node-sdk/configuration.ts.html +52 -34
- package/coverage/lcov-report/node-sdk/index.html +7 -7
- package/coverage/lcov-report/node-sdk/models/business-entity-type-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/business-registration-type-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/bxml/Bxml.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/NestableVerb.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/Response.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/Root.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/Verb.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/index.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/index.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Bridge.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Conference.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/CustomParam.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Forward.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Gather.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Hangup.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Pause.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PauseRecording.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PhoneNumber.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PlayAudio.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Record.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Redirect.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/ResumeRecording.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Ring.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SendDtmf.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SipUri.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SpeakSentence.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartGather.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartRecording.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartStream.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartTranscription.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopGather.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopRecording.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopStream.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopTranscription.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StreamParam.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Tag.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Transfer.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/call-direction-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/call-state-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/call-transcription-detected-language-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/call-transcription-track-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/callback-method-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/card-width-enum.ts.html +2 -17
- package/coverage/lcov-report/node-sdk/models/completed-lookup-status-enum.ts.html +166 -0
- package/coverage/lcov-report/node-sdk/models/conference-state-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/deactivation-event-enum.ts.html +169 -0
- package/coverage/lcov-report/node-sdk/models/file-format-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/in-progress-lookup-status-enum.ts.html +169 -0
- package/coverage/lcov-report/node-sdk/models/inbound-callback-type-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/index.html +67 -7
- package/coverage/lcov-report/node-sdk/models/index.ts.html +45 -9
- package/coverage/lcov-report/node-sdk/models/{lookup-status-enum.ts.html → latest-message-delivery-status-enum.ts.html} +10 -19
- package/coverage/lcov-report/node-sdk/models/line-type-enum.ts.html +169 -0
- package/coverage/lcov-report/node-sdk/models/list-message-direction-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/machine-detection-mode-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/message-direction-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/message-status-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/message-type-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/multi-channel-message-channel-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/priority-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/product-type-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/rbm-action-type-enum.ts.html +2 -17
- package/coverage/lcov-report/node-sdk/models/rbm-media-height-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/recording-state-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/redirect-method-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/standalone-card-orientation-enum.ts.html +2 -17
- package/coverage/lcov-report/node-sdk/models/status-callback-type-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/tfv-callback-status-enum.ts.html +2 -17
- package/coverage/lcov-report/node-sdk/models/tfv-status-enum.ts.html +2 -17
- package/coverage/lcov-report/node-sdk/models/thumbnail-alignment-enum.ts.html +2 -8
- package/coverage/lcov-report/node-sdk/models/webhook-subscription-type-enum.ts.html +2 -17
- package/coverage/lcov.info +2940 -2824
- package/custom_templates/README.mustache +56 -6
- package/custom_templates/common.mustache +29 -44
- package/custom_templates/configuration.mustache +26 -19
- package/custom_templates/package.mustache +1 -1
- package/dist/api/calls-api.d.ts +0 -11
- package/dist/api/calls-api.js +0 -11
- package/dist/api/conferences-api.d.ts +0 -15
- package/dist/api/conferences-api.js +0 -15
- package/dist/api/media-api.d.ts +0 -10
- package/dist/api/media-api.js +0 -10
- package/dist/api/messages-api.d.ts +0 -8
- package/dist/api/messages-api.js +0 -8
- package/dist/api/mfaapi.d.ts +0 -9
- package/dist/api/mfaapi.js +0 -9
- package/dist/api/multi-channel-api.d.ts +0 -7
- package/dist/api/multi-channel-api.js +0 -7
- package/dist/api/phone-number-lookup-api.d.ts +81 -59
- package/dist/api/phone-number-lookup-api.js +149 -73
- package/dist/api/recordings-api.d.ts +0 -16
- package/dist/api/recordings-api.js +0 -16
- package/dist/api/statistics-api.d.ts +0 -7
- package/dist/api/statistics-api.js +0 -7
- package/dist/api/toll-free-verification-api.d.ts +0 -15
- package/dist/api/toll-free-verification-api.js +0 -15
- package/dist/api/transcriptions-api.d.ts +0 -9
- package/dist/api/transcriptions-api.js +0 -9
- package/dist/base.d.ts +0 -24
- package/dist/base.js +10 -23
- package/dist/common.d.ts +0 -37
- package/dist/common.js +0 -37
- package/dist/configuration.d.ts +24 -17
- package/dist/configuration.js +2 -2
- package/dist/models/account-statistics.d.ts +0 -9
- package/dist/models/additional-denial-reason.d.ts +0 -11
- package/dist/models/address.d.ts +0 -19
- package/dist/models/answer-callback.d.ts +0 -36
- package/dist/models/async-lookup-request.d.ts +17 -0
- package/dist/models/blocked-webhook.d.ts +0 -20
- package/dist/models/bridge-complete-callback.d.ts +0 -37
- package/dist/models/bridge-target-complete-callback.d.ts +0 -31
- package/dist/models/business-entity-type-enum.d.ts +0 -2
- package/dist/models/business-entity-type-enum.js +0 -2
- package/dist/models/business-registration-type-enum.d.ts +0 -2
- package/dist/models/business-registration-type-enum.js +0 -2
- package/dist/models/call-direction-enum.d.ts +0 -2
- package/dist/models/call-direction-enum.js +0 -2
- package/dist/models/call-recording-metadata.d.ts +0 -52
- package/dist/models/call-state-enum.d.ts +0 -2
- package/dist/models/call-state-enum.js +0 -2
- package/dist/models/call-state.d.ts +0 -44
- package/dist/models/call-transcription-detected-language-enum.d.ts +0 -2
- package/dist/models/call-transcription-detected-language-enum.js +0 -2
- package/dist/models/call-transcription-metadata.d.ts +0 -11
- package/dist/models/call-transcription-response.d.ts +0 -16
- package/dist/models/call-transcription-track-enum.d.ts +0 -2
- package/dist/models/call-transcription-track-enum.js +0 -2
- package/dist/models/call-transcription.d.ts +0 -19
- package/dist/models/callback-method-enum.d.ts +0 -2
- package/dist/models/callback-method-enum.js +0 -2
- package/dist/models/callback.d.ts +0 -1
- package/dist/models/card-width-enum.d.ts +0 -5
- package/dist/models/card-width-enum.js +0 -5
- package/dist/models/code-request.d.ts +0 -17
- package/dist/models/completed-lookup-status-enum.d.ts +17 -0
- package/dist/models/completed-lookup-status-enum.js +21 -0
- package/dist/models/conference-completed-callback.d.ts +0 -12
- package/dist/models/conference-created-callback.d.ts +0 -12
- package/dist/models/conference-member-exit-callback.d.ts +0 -18
- package/dist/models/conference-member-join-callback.d.ts +0 -18
- package/dist/models/conference-member.d.ts +0 -17
- package/dist/models/conference-recording-available-callback.d.ts +0 -33
- package/dist/models/conference-recording-metadata.d.ts +0 -32
- package/dist/models/conference-redirect-callback.d.ts +0 -12
- package/dist/models/conference-state-enum.d.ts +0 -2
- package/dist/models/conference-state-enum.js +0 -2
- package/dist/models/conference.d.ts +0 -24
- package/dist/models/contact.d.ts +0 -16
- package/dist/models/create-async-bulk-lookup-response-data.d.ts +22 -0
- package/dist/models/create-async-bulk-lookup-response.d.ts +22 -0
- package/dist/models/create-call-response.d.ts +0 -56
- package/dist/models/create-call.d.ts +0 -59
- package/dist/models/create-message-request-error.d.ts +0 -20
- package/dist/models/create-multi-channel-message-response.d.ts +0 -20
- package/dist/models/create-sync-lookup-response-data.d.ts +27 -0
- package/dist/models/create-sync-lookup-response.d.ts +19 -0
- package/dist/models/create-sync-lookup-response.js +15 -0
- package/dist/models/deactivation-event-enum.d.ts +18 -0
- package/dist/models/deactivation-event-enum.js +22 -0
- package/dist/models/disconnect-callback.d.ts +0 -39
- package/dist/models/diversion.d.ts +0 -19
- package/dist/models/dtmf-callback.d.ts +0 -39
- package/dist/models/error-object.d.ts +0 -14
- package/dist/models/error-source.d.ts +0 -10
- package/dist/models/failure-webhook.d.ts +0 -17
- package/dist/models/field-error.d.ts +0 -9
- package/dist/models/file-format-enum.d.ts +0 -2
- package/dist/models/file-format-enum.js +0 -2
- package/dist/models/gather-callback.d.ts +0 -41
- package/dist/models/get-async-bulk-lookup-response-data.d.ts +27 -0
- package/dist/models/get-async-bulk-lookup-response-data.js +15 -0
- package/dist/models/get-async-bulk-lookup-response.d.ts +19 -0
- package/dist/models/get-async-bulk-lookup-response.js +15 -0
- package/dist/models/{lookup-status-enum.d.ts → in-progress-lookup-status-enum.d.ts} +2 -7
- package/dist/models/{lookup-status-enum.js → in-progress-lookup-status-enum.js} +2 -7
- package/dist/models/inbound-callback-message.d.ts +0 -1
- package/dist/models/inbound-callback-type-enum.d.ts +0 -2
- package/dist/models/inbound-callback-type-enum.js +0 -2
- package/dist/models/inbound-callback.d.ts +0 -23
- package/dist/models/index.d.ts +17 -5
- package/dist/models/index.js +17 -5
- package/dist/models/initiate-callback.d.ts +0 -37
- package/dist/models/latest-message-delivery-status-enum.d.ts +20 -0
- package/dist/models/latest-message-delivery-status-enum.js +24 -0
- package/dist/models/line-type-enum.d.ts +18 -0
- package/dist/models/line-type-enum.js +22 -0
- package/dist/models/{lookup-request.d.ts → link-schema.d.ts} +11 -10
- package/dist/models/link-schema.js +15 -0
- package/dist/models/link.d.ts +0 -15
- package/dist/models/links-object.d.ts +0 -13
- package/dist/models/list-message-direction-enum.d.ts +0 -2
- package/dist/models/list-message-direction-enum.js +0 -2
- package/dist/models/list-message-item.d.ts +0 -60
- package/dist/models/lookup-error-response.d.ts +21 -0
- package/dist/models/lookup-error-response.js +15 -0
- package/dist/models/{tn-lookup-request-error.d.ts → lookup-error-schema-meta.d.ts} +7 -9
- package/dist/models/lookup-error-schema-meta.js +15 -0
- package/dist/models/lookup-error-schema.d.ts +27 -0
- package/dist/models/lookup-error-schema.js +15 -0
- package/dist/models/lookup-result.d.ts +22 -40
- package/dist/models/machine-detection-complete-callback.d.ts +0 -36
- package/dist/models/machine-detection-configuration.d.ts +0 -41
- package/dist/models/machine-detection-mode-enum.d.ts +0 -2
- package/dist/models/machine-detection-mode-enum.js +0 -2
- package/dist/models/machine-detection-result.d.ts +0 -6
- package/dist/models/media.d.ts +0 -20
- package/dist/models/message-direction-enum.d.ts +0 -2
- package/dist/models/message-direction-enum.js +0 -2
- package/dist/models/message-request.d.ts +0 -24
- package/dist/models/message-status-enum.d.ts +0 -2
- package/dist/models/message-status-enum.js +0 -2
- package/dist/models/message-type-enum.d.ts +0 -2
- package/dist/models/message-type-enum.js +0 -2
- package/dist/models/message.d.ts +0 -37
- package/dist/models/messages-list.d.ts +0 -17
- package/dist/models/messaging-code-response.d.ts +0 -7
- package/dist/models/messaging-request-error.d.ts +0 -15
- package/dist/models/mfa-forbidden-request-error.d.ts +0 -7
- package/dist/models/mfa-request-error.d.ts +0 -9
- package/dist/models/mfa-unauthorized-request-error.d.ts +0 -7
- package/dist/models/mms-message-content-file.d.ts +0 -7
- package/dist/models/mms-message-content.d.ts +0 -12
- package/dist/models/model-error.d.ts +0 -20
- package/dist/models/multi-channel-action-calendar-event.d.ts +0 -1
- package/dist/models/multi-channel-action.d.ts +0 -1
- package/dist/models/multi-channel-channel-list-object-content.d.ts +0 -1
- package/dist/models/multi-channel-channel-list-object.d.ts +0 -19
- package/dist/models/multi-channel-error.d.ts +0 -20
- package/dist/models/multi-channel-message-channel-enum.d.ts +0 -2
- package/dist/models/multi-channel-message-channel-enum.js +0 -2
- package/dist/models/multi-channel-message-content.d.ts +0 -12
- package/dist/models/multi-channel-message-request.d.ts +0 -15
- package/dist/models/multi-channel-message-response-data-channel-list-inner.d.ts +0 -1
- package/dist/models/multi-channel-message-response-data.d.ts +0 -24
- package/dist/models/opt-in-workflow.d.ts +0 -20
- package/dist/models/page-info.d.ts +0 -13
- package/dist/models/priority-enum.d.ts +0 -2
- package/dist/models/priority-enum.js +0 -2
- package/dist/models/product-type-enum.d.ts +0 -2
- package/dist/models/product-type-enum.js +0 -2
- package/dist/models/rbm-action-base.d.ts +0 -14
- package/dist/models/rbm-action-dial.d.ts +0 -1
- package/dist/models/rbm-action-open-url.d.ts +0 -1
- package/dist/models/rbm-action-type-enum.d.ts +0 -5
- package/dist/models/rbm-action-type-enum.js +0 -5
- package/dist/models/rbm-action-view-location.d.ts +0 -1
- package/dist/models/rbm-card-content-media.d.ts +0 -1
- package/dist/models/rbm-card-content.d.ts +0 -16
- package/dist/models/rbm-location-response.d.ts +0 -9
- package/dist/models/rbm-media-height-enum.d.ts +0 -2
- package/dist/models/rbm-media-height-enum.js +0 -2
- package/dist/models/rbm-message-carousel-card.d.ts +0 -17
- package/dist/models/rbm-message-content-file.d.ts +0 -9
- package/dist/models/rbm-message-content-rich-card.d.ts +0 -1
- package/dist/models/rbm-message-content-text.d.ts +0 -9
- package/dist/models/rbm-message-media.d.ts +0 -12
- package/dist/models/rbm-standalone-card.d.ts +0 -22
- package/dist/models/rbm-suggestion-response.d.ts +0 -9
- package/dist/models/recording-available-callback.d.ts +0 -52
- package/dist/models/recording-complete-callback.d.ts +0 -52
- package/dist/models/recording-state-enum.d.ts +0 -2
- package/dist/models/recording-state-enum.js +0 -2
- package/dist/models/recording-transcription-metadata.d.ts +0 -10
- package/dist/models/recording-transcriptions.d.ts +0 -10
- package/dist/models/redirect-callback.d.ts +0 -37
- package/dist/models/redirect-method-enum.d.ts +0 -2
- package/dist/models/redirect-method-enum.js +0 -2
- package/dist/models/sms-message-content.d.ts +0 -7
- package/dist/models/standalone-card-orientation-enum.d.ts +0 -5
- package/dist/models/standalone-card-orientation-enum.js +0 -5
- package/dist/models/status-callback-message.d.ts +0 -43
- package/dist/models/status-callback-type-enum.d.ts +0 -2
- package/dist/models/status-callback-type-enum.js +0 -2
- package/dist/models/status-callback.d.ts +0 -27
- package/dist/models/stir-shaken.d.ts +0 -11
- package/dist/models/sync-lookup-request.d.ts +17 -0
- package/dist/models/sync-lookup-request.js +15 -0
- package/dist/models/telephone-number.d.ts +0 -7
- package/dist/models/tfv-basic-authentication.d.ts +0 -15
- package/dist/models/tfv-callback-status-enum.d.ts +0 -5
- package/dist/models/tfv-callback-status-enum.js +0 -5
- package/dist/models/tfv-error.d.ts +0 -14
- package/dist/models/tfv-status-enum.d.ts +0 -5
- package/dist/models/tfv-status-enum.js +0 -5
- package/dist/models/tfv-status.d.ts +0 -31
- package/dist/models/tfv-submission-info.d.ts +0 -50
- package/dist/models/tfv-submission-wrapper.d.ts +0 -10
- package/dist/models/thumbnail-alignment-enum.d.ts +0 -2
- package/dist/models/thumbnail-alignment-enum.js +0 -2
- package/dist/models/transcribe-recording.d.ts +0 -22
- package/dist/models/transcription-available-callback.d.ts +0 -53
- package/dist/models/transcription.d.ts +0 -9
- package/dist/models/transfer-answer-callback.d.ts +0 -35
- package/dist/models/transfer-complete-callback.d.ts +0 -41
- package/dist/models/transfer-disconnect-callback.d.ts +0 -45
- package/dist/models/update-call-recording.d.ts +0 -10
- package/dist/models/update-call.d.ts +0 -34
- package/dist/models/update-conference-member.d.ts +0 -11
- package/dist/models/update-conference.d.ts +0 -32
- package/dist/models/verification-denial-webhook.d.ts +0 -28
- package/dist/models/verification-request.d.ts +0 -59
- package/dist/models/verification-update-request.d.ts +0 -54
- package/dist/models/verification-webhook.d.ts +0 -16
- package/dist/models/verify-code-request.d.ts +0 -13
- package/dist/models/verify-code-response.d.ts +0 -7
- package/dist/models/voice-api-error.d.ts +0 -20
- package/dist/models/voice-code-response.d.ts +0 -7
- package/dist/models/webhook-subscription-basic-authentication.d.ts +0 -12
- package/dist/models/webhook-subscription-request-schema.d.ts +0 -14
- package/dist/models/webhook-subscription-type-enum.d.ts +0 -5
- package/dist/models/webhook-subscription-type-enum.js +0 -5
- package/dist/models/webhook-subscription.d.ts +0 -34
- package/dist/models/webhook-subscriptions-list-body.d.ts +0 -17
- package/docs/{TnLookupRequestError.md → AsyncLookupRequest.md} +5 -5
- package/docs/CompletedLookupStatusEnum.md +12 -0
- package/docs/CreateAsyncBulkLookupResponse.md +24 -0
- package/docs/{CreateLookupResponse.md → CreateAsyncBulkLookupResponseData.md} +5 -5
- package/docs/CreateSyncLookupResponse.md +24 -0
- package/docs/CreateSyncLookupResponseData.md +25 -0
- package/docs/DeactivationEventEnum.md +9 -0
- package/docs/GetAsyncBulkLookupResponse.md +24 -0
- package/docs/GetAsyncBulkLookupResponseData.md +25 -0
- package/docs/{LookupStatusEnum.md → InProgressLookupStatusEnum.md} +1 -2
- package/docs/LatestMessageDeliveryStatusEnum.md +13 -0
- package/docs/LineTypeEnum.md +14 -0
- package/docs/LinkSchema.md +24 -0
- package/docs/LookupErrorResponse.md +24 -0
- package/docs/LookupErrorSchema.md +26 -0
- package/docs/LookupErrorSchemaMeta.md +24 -0
- package/docs/LookupResult.md +22 -18
- package/docs/PhoneNumberLookupApi.md +81 -34
- package/docs/{LookupRequest.md → SyncLookupRequest.md} +5 -6
- package/models/account-statistics.ts +0 -9
- package/models/additional-denial-reason.ts +0 -11
- package/models/address.ts +0 -19
- package/models/answer-callback.ts +0 -36
- package/models/async-lookup-request.ts +23 -0
- package/models/blocked-webhook.ts +0 -20
- package/models/bridge-complete-callback.ts +0 -37
- package/models/bridge-target-complete-callback.ts +0 -31
- package/models/business-entity-type-enum.ts +0 -2
- package/models/business-registration-type-enum.ts +0 -2
- package/models/call-direction-enum.ts +0 -2
- package/models/call-recording-metadata.ts +0 -52
- package/models/call-state-enum.ts +0 -2
- package/models/call-state.ts +0 -44
- package/models/call-transcription-detected-language-enum.ts +0 -2
- package/models/call-transcription-metadata.ts +0 -11
- package/models/call-transcription-response.ts +0 -16
- package/models/call-transcription-track-enum.ts +0 -2
- package/models/call-transcription.ts +0 -19
- package/models/callback-method-enum.ts +0 -2
- package/models/callback.ts +0 -1
- package/models/card-width-enum.ts +0 -5
- package/models/code-request.ts +0 -17
- package/models/completed-lookup-status-enum.ts +27 -0
- package/models/conference-completed-callback.ts +0 -12
- package/models/conference-created-callback.ts +0 -12
- package/models/conference-member-exit-callback.ts +0 -18
- package/models/conference-member-join-callback.ts +0 -18
- package/models/conference-member.ts +0 -17
- package/models/conference-recording-available-callback.ts +0 -33
- package/models/conference-recording-metadata.ts +0 -32
- package/models/conference-redirect-callback.ts +0 -12
- package/models/conference-state-enum.ts +0 -2
- package/models/conference.ts +0 -24
- package/models/contact.ts +0 -16
- package/models/create-async-bulk-lookup-response-data.ts +32 -0
- package/models/create-async-bulk-lookup-response.ts +34 -0
- package/models/create-call-response.ts +0 -56
- package/models/create-call.ts +0 -59
- package/models/create-message-request-error.ts +0 -20
- package/models/create-multi-channel-message-response.ts +0 -20
- package/models/{create-lookup-response.ts → create-sync-lookup-response-data.ts} +9 -11
- package/models/create-sync-lookup-response.ts +31 -0
- package/models/deactivation-event-enum.ts +28 -0
- package/models/disconnect-callback.ts +0 -39
- package/models/diversion.ts +0 -19
- package/models/dtmf-callback.ts +0 -39
- package/models/error-object.ts +0 -14
- package/models/error-source.ts +0 -10
- package/models/failure-webhook.ts +0 -17
- package/models/field-error.ts +0 -9
- package/models/file-format-enum.ts +0 -2
- package/models/gather-callback.ts +0 -41
- package/models/get-async-bulk-lookup-response-data.ts +39 -0
- package/models/get-async-bulk-lookup-response.ts +31 -0
- package/models/{lookup-status-enum.ts → in-progress-lookup-status-enum.ts} +2 -7
- package/models/inbound-callback-message.ts +0 -1
- package/models/inbound-callback-type-enum.ts +0 -2
- package/models/inbound-callback.ts +0 -23
- package/models/index.ts +17 -5
- package/models/initiate-callback.ts +0 -37
- package/models/latest-message-delivery-status-enum.ts +30 -0
- package/models/line-type-enum.ts +28 -0
- package/models/{lookup-request.ts → link-schema.ts} +11 -10
- package/models/link.ts +0 -15
- package/models/links-object.ts +0 -13
- package/models/list-message-direction-enum.ts +0 -2
- package/models/list-message-item.ts +0 -60
- package/models/lookup-error-response.ts +31 -0
- package/models/{tn-lookup-request-error.ts → lookup-error-schema-meta.ts} +7 -9
- package/models/lookup-error-schema.ts +35 -0
- package/models/lookup-result.ts +30 -40
- package/models/machine-detection-complete-callback.ts +0 -36
- package/models/machine-detection-configuration.ts +0 -41
- package/models/machine-detection-mode-enum.ts +0 -2
- package/models/machine-detection-result.ts +0 -6
- package/models/media.ts +0 -20
- package/models/message-direction-enum.ts +0 -2
- package/models/message-request.ts +0 -24
- package/models/message-status-enum.ts +0 -2
- package/models/message-type-enum.ts +0 -2
- package/models/message.ts +0 -37
- package/models/messages-list.ts +0 -17
- package/models/messaging-code-response.ts +0 -7
- package/models/messaging-request-error.ts +0 -15
- package/models/mfa-forbidden-request-error.ts +0 -7
- package/models/mfa-request-error.ts +0 -9
- package/models/mfa-unauthorized-request-error.ts +0 -7
- package/models/mms-message-content-file.ts +0 -7
- package/models/mms-message-content.ts +0 -12
- package/models/model-error.ts +0 -20
- package/models/multi-channel-action-calendar-event.ts +0 -1
- package/models/multi-channel-action.ts +0 -1
- package/models/multi-channel-channel-list-object-content.ts +0 -1
- package/models/multi-channel-channel-list-object.ts +0 -19
- package/models/multi-channel-error.ts +0 -20
- package/models/multi-channel-message-channel-enum.ts +0 -2
- package/models/multi-channel-message-content.ts +0 -12
- package/models/multi-channel-message-request.ts +0 -15
- package/models/multi-channel-message-response-data-channel-list-inner.ts +0 -1
- package/models/multi-channel-message-response-data.ts +0 -24
- package/models/opt-in-workflow.ts +0 -20
- package/models/page-info.ts +0 -13
- package/models/priority-enum.ts +0 -2
- package/models/product-type-enum.ts +0 -2
- package/models/rbm-action-base.ts +0 -14
- package/models/rbm-action-dial.ts +0 -1
- package/models/rbm-action-open-url.ts +0 -1
- package/models/rbm-action-type-enum.ts +0 -5
- package/models/rbm-action-view-location.ts +0 -1
- package/models/rbm-card-content-media.ts +0 -1
- package/models/rbm-card-content.ts +0 -16
- package/models/rbm-location-response.ts +0 -9
- package/models/rbm-media-height-enum.ts +0 -2
- package/models/rbm-message-carousel-card.ts +0 -17
- package/models/rbm-message-content-file.ts +0 -9
- package/models/rbm-message-content-rich-card.ts +0 -1
- package/models/rbm-message-content-text.ts +0 -9
- package/models/rbm-message-media.ts +0 -12
- package/models/rbm-standalone-card.ts +0 -22
- package/models/rbm-suggestion-response.ts +0 -9
- package/models/recording-available-callback.ts +0 -52
- package/models/recording-complete-callback.ts +0 -52
- package/models/recording-state-enum.ts +0 -2
- package/models/recording-transcription-metadata.ts +0 -10
- package/models/recording-transcriptions.ts +0 -10
- package/models/redirect-callback.ts +0 -37
- package/models/redirect-method-enum.ts +0 -2
- package/models/sms-message-content.ts +0 -7
- package/models/standalone-card-orientation-enum.ts +0 -5
- package/models/status-callback-message.ts +0 -43
- package/models/status-callback-type-enum.ts +0 -2
- package/models/status-callback.ts +0 -27
- package/models/stir-shaken.ts +0 -11
- package/models/sync-lookup-request.ts +23 -0
- package/models/telephone-number.ts +0 -7
- package/models/tfv-basic-authentication.ts +0 -15
- package/models/tfv-callback-status-enum.ts +0 -5
- package/models/tfv-error.ts +0 -14
- package/models/tfv-status-enum.ts +0 -5
- package/models/tfv-status.ts +0 -31
- package/models/tfv-submission-info.ts +0 -50
- package/models/tfv-submission-wrapper.ts +0 -10
- package/models/thumbnail-alignment-enum.ts +0 -2
- package/models/transcribe-recording.ts +0 -22
- package/models/transcription-available-callback.ts +0 -53
- package/models/transcription.ts +0 -9
- package/models/transfer-answer-callback.ts +0 -35
- package/models/transfer-complete-callback.ts +0 -41
- package/models/transfer-disconnect-callback.ts +0 -45
- package/models/update-call-recording.ts +0 -10
- package/models/update-call.ts +0 -34
- package/models/update-conference-member.ts +0 -11
- package/models/update-conference.ts +0 -32
- package/models/verification-denial-webhook.ts +0 -28
- package/models/verification-request.ts +0 -59
- package/models/verification-update-request.ts +0 -54
- package/models/verification-webhook.ts +0 -16
- package/models/verify-code-request.ts +0 -13
- package/models/verify-code-response.ts +0 -7
- package/models/voice-api-error.ts +0 -20
- package/models/voice-code-response.ts +0 -7
- package/models/webhook-subscription-basic-authentication.ts +0 -12
- package/models/webhook-subscription-request-schema.ts +0 -14
- package/models/webhook-subscription-type-enum.ts +0 -5
- package/models/webhook-subscription.ts +0 -34
- package/models/webhook-subscriptions-list-body.ts +0 -17
- package/openapitools.json +1 -1
- package/package.json +2 -2
- package/tests/smoke/phone-number-lookup-api.test.ts +64 -61
- package/tests/unit/api/phone-number-lookup-api.test.ts +64 -58
- package/tests/unit/models/completed-lookup-status-enum.test.ts +9 -0
- package/tests/unit/models/deactivation-event-enum.test.ts +7 -0
- package/tests/unit/models/in-progress-lookup-status-enum.test.ts +11 -0
- package/tests/unit/models/latest-message-delivery-status-enum.test.ts +10 -0
- package/tests/unit/models/line-type-enum.test.ts +11 -0
- package/dist/models/create-lookup-response.d.ts +0 -31
- package/dist/models/lookup-status.d.ts +0 -44
- package/docs/LookupStatus.md +0 -27
- package/models/lookup-status.ts +0 -56
- package/tests/unit/models/lookup-status-enum.test.ts +0 -10
- /package/dist/models/{create-lookup-response.js → async-lookup-request.js} +0 -0
- /package/dist/models/{lookup-request.js → create-async-bulk-lookup-response-data.js} +0 -0
- /package/dist/models/{lookup-status.js → create-async-bulk-lookup-response.js} +0 -0
- /package/dist/models/{tn-lookup-request-error.js → create-sync-lookup-response-data.js} +0 -0
package/models/lookup-result.ts
CHANGED
|
@@ -13,66 +13,56 @@
|
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
15
|
|
|
16
|
+
// May contain unused imports in some cases
|
|
17
|
+
// @ts-ignore
|
|
18
|
+
import type { DeactivationEventEnum } from './deactivation-event-enum';
|
|
19
|
+
// May contain unused imports in some cases
|
|
20
|
+
// @ts-ignore
|
|
21
|
+
import type { LatestMessageDeliveryStatusEnum } from './latest-message-delivery-status-enum';
|
|
22
|
+
// May contain unused imports in some cases
|
|
23
|
+
// @ts-ignore
|
|
24
|
+
import type { LineTypeEnum } from './line-type-enum';
|
|
16
25
|
|
|
17
26
|
/**
|
|
18
27
|
* Carrier information results for the specified telephone number.
|
|
19
|
-
* @export
|
|
20
|
-
* @interface LookupResult
|
|
21
28
|
*/
|
|
22
29
|
export interface LookupResult {
|
|
23
30
|
/**
|
|
24
|
-
*
|
|
25
|
-
* @type {number}
|
|
26
|
-
* @memberof LookupResult
|
|
27
|
-
*/
|
|
28
|
-
'Response Code'?: number;
|
|
29
|
-
/**
|
|
30
|
-
* Message associated with the response code.
|
|
31
|
-
* @type {string}
|
|
32
|
-
* @memberof LookupResult
|
|
31
|
+
* The telephone number in E.164 format.
|
|
33
32
|
*/
|
|
34
|
-
'
|
|
33
|
+
'phoneNumber'?: string;
|
|
34
|
+
'lineType'?: LineTypeEnum;
|
|
35
35
|
/**
|
|
36
|
-
* The
|
|
37
|
-
* @type {string}
|
|
38
|
-
* @memberof LookupResult
|
|
36
|
+
* The messaging service provider of the telephone number.
|
|
39
37
|
*/
|
|
40
|
-
'
|
|
38
|
+
'messagingProvider'?: string;
|
|
41
39
|
/**
|
|
42
|
-
* The
|
|
43
|
-
* @type {string}
|
|
44
|
-
* @memberof LookupResult
|
|
40
|
+
* The voice service provider of the telephone number.
|
|
45
41
|
*/
|
|
46
|
-
'
|
|
42
|
+
'voiceProvider'?: string;
|
|
47
43
|
/**
|
|
48
|
-
* The country of the telephone number.
|
|
49
|
-
* @type {string}
|
|
50
|
-
* @memberof LookupResult
|
|
44
|
+
* The country code of the telephone number in ISO 3166-1 alpha-3 format.
|
|
51
45
|
*/
|
|
52
|
-
'
|
|
46
|
+
'countryCodeA3'?: string;
|
|
53
47
|
/**
|
|
54
|
-
* The
|
|
55
|
-
* @type {string}
|
|
56
|
-
* @memberof LookupResult
|
|
48
|
+
* [DNI-Only](#section/DNI-Only). The carrier that reported a deactivation event for this phone number.
|
|
57
49
|
*/
|
|
58
|
-
'
|
|
50
|
+
'deactivationReporter'?: string;
|
|
59
51
|
/**
|
|
60
|
-
* The
|
|
61
|
-
* @type {string}
|
|
62
|
-
* @memberof LookupResult
|
|
52
|
+
* [DNI-Only](#section/DNI-Only). The datetime the carrier reported a deactivation event.
|
|
63
53
|
*/
|
|
64
|
-
'
|
|
54
|
+
'deactivationDate'?: string;
|
|
55
|
+
'deactivationEvent'?: DeactivationEventEnum;
|
|
56
|
+
'latestMessageDeliveryStatus'?: LatestMessageDeliveryStatusEnum;
|
|
65
57
|
/**
|
|
66
|
-
* The
|
|
67
|
-
* @type {string}
|
|
68
|
-
* @memberof LookupResult
|
|
58
|
+
* [DNI-Only](#section/DNI-Only). The date the phone number entered the status described in `latestMessageDeliveryStatus`. Think of this as the \"start time\" for that status. Value resets every time the `latestMessageDeliveryStatus` changes.
|
|
69
59
|
*/
|
|
70
|
-
'
|
|
60
|
+
'initialMessageDeliveryStatusDate'?: string;
|
|
71
61
|
/**
|
|
72
|
-
* The
|
|
73
|
-
* @type {string}
|
|
74
|
-
* @memberof LookupResult
|
|
62
|
+
* [DNI-Only](#section/DNI-Only). The date bandwidth last received delivery status information for this phone number. Use this field to understand how up-to-date the `latestMessageDeliveryStatus` is. Value resets every time the `latestMessageDeliveryStatus` changes.
|
|
75
63
|
*/
|
|
76
|
-
'
|
|
64
|
+
'latestMessageDeliveryStatusDate'?: string;
|
|
77
65
|
}
|
|
78
66
|
|
|
67
|
+
|
|
68
|
+
|
|
@@ -22,93 +22,57 @@ import type { MachineDetectionResult } from './machine-detection-result';
|
|
|
22
22
|
|
|
23
23
|
/**
|
|
24
24
|
* This event is sent to the url informed when requesting a machine detection operation. It contains the machine detection operation result, which can be: human, answering-machine, silence, timeout, error. This event is not sent when sync answering machine detection mode is chosen.
|
|
25
|
-
* @export
|
|
26
|
-
* @interface MachineDetectionCompleteCallback
|
|
27
25
|
*/
|
|
28
26
|
export interface MachineDetectionCompleteCallback {
|
|
29
27
|
/**
|
|
30
28
|
* 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.
|
|
31
|
-
* @type {string}
|
|
32
|
-
* @memberof MachineDetectionCompleteCallback
|
|
33
29
|
*/
|
|
34
30
|
'eventType'?: string;
|
|
35
31
|
/**
|
|
36
32
|
* 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.
|
|
37
|
-
* @type {string}
|
|
38
|
-
* @memberof MachineDetectionCompleteCallback
|
|
39
33
|
*/
|
|
40
34
|
'eventTime'?: string;
|
|
41
35
|
/**
|
|
42
36
|
* The user account associated with the call.
|
|
43
|
-
* @type {string}
|
|
44
|
-
* @memberof MachineDetectionCompleteCallback
|
|
45
37
|
*/
|
|
46
38
|
'accountId'?: string;
|
|
47
39
|
/**
|
|
48
40
|
* The id of the application associated with the call.
|
|
49
|
-
* @type {string}
|
|
50
|
-
* @memberof MachineDetectionCompleteCallback
|
|
51
41
|
*/
|
|
52
42
|
'applicationId'?: string;
|
|
53
43
|
/**
|
|
54
44
|
* The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555).
|
|
55
|
-
* @type {string}
|
|
56
|
-
* @memberof MachineDetectionCompleteCallback
|
|
57
45
|
*/
|
|
58
46
|
'from'?: string;
|
|
59
47
|
/**
|
|
60
48
|
* The phone number that received the call, in E.164 format (e.g. +15555555555).
|
|
61
|
-
* @type {string}
|
|
62
|
-
* @memberof MachineDetectionCompleteCallback
|
|
63
49
|
*/
|
|
64
50
|
'to'?: string;
|
|
65
|
-
/**
|
|
66
|
-
*
|
|
67
|
-
* @type {CallDirectionEnum}
|
|
68
|
-
* @memberof MachineDetectionCompleteCallback
|
|
69
|
-
*/
|
|
70
51
|
'direction'?: CallDirectionEnum;
|
|
71
52
|
/**
|
|
72
53
|
* The call id associated with the event.
|
|
73
|
-
* @type {string}
|
|
74
|
-
* @memberof MachineDetectionCompleteCallback
|
|
75
54
|
*/
|
|
76
55
|
'callId'?: string;
|
|
77
56
|
/**
|
|
78
57
|
* The URL of the call associated with the event.
|
|
79
|
-
* @type {string}
|
|
80
|
-
* @memberof MachineDetectionCompleteCallback
|
|
81
58
|
*/
|
|
82
59
|
'callUrl'?: string;
|
|
83
60
|
/**
|
|
84
61
|
* (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format.
|
|
85
|
-
* @type {string}
|
|
86
|
-
* @memberof MachineDetectionCompleteCallback
|
|
87
62
|
*/
|
|
88
63
|
'enqueuedTime'?: string | null;
|
|
89
64
|
/**
|
|
90
65
|
* Time the call was started, in ISO 8601 format.
|
|
91
|
-
* @type {string}
|
|
92
|
-
* @memberof MachineDetectionCompleteCallback
|
|
93
66
|
*/
|
|
94
67
|
'startTime'?: string;
|
|
95
68
|
/**
|
|
96
69
|
* Time the call was answered, in ISO 8601 format.
|
|
97
|
-
* @type {string}
|
|
98
|
-
* @memberof MachineDetectionCompleteCallback
|
|
99
70
|
*/
|
|
100
71
|
'answerTime'?: string | null;
|
|
101
72
|
/**
|
|
102
73
|
* (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present.
|
|
103
|
-
* @type {string}
|
|
104
|
-
* @memberof MachineDetectionCompleteCallback
|
|
105
74
|
*/
|
|
106
75
|
'tag'?: string | null;
|
|
107
|
-
/**
|
|
108
|
-
*
|
|
109
|
-
* @type {MachineDetectionResult}
|
|
110
|
-
* @memberof MachineDetectionCompleteCallback
|
|
111
|
-
*/
|
|
112
76
|
'machineDetectionResult'?: MachineDetectionResult | null;
|
|
113
77
|
}
|
|
114
78
|
|
|
@@ -22,98 +22,57 @@ import type { MachineDetectionModeEnum } from './machine-detection-mode-enum';
|
|
|
22
22
|
|
|
23
23
|
/**
|
|
24
24
|
* The machine detection request used to perform <a href=\'/docs/voice/guides/machineDetection\'>machine detection</a> on the call. Currently, there is an issue where decimal values are not getting processed correctly. Please use whole number values. We are working to resolve this issue. Please contact Bandwidth Support if you need more information.
|
|
25
|
-
* @export
|
|
26
|
-
* @interface MachineDetectionConfiguration
|
|
27
25
|
*/
|
|
28
26
|
export interface MachineDetectionConfiguration {
|
|
29
|
-
/**
|
|
30
|
-
*
|
|
31
|
-
* @type {MachineDetectionModeEnum}
|
|
32
|
-
* @memberof MachineDetectionConfiguration
|
|
33
|
-
*/
|
|
34
27
|
'mode'?: MachineDetectionModeEnum;
|
|
35
28
|
/**
|
|
36
29
|
* The timeout used for the whole operation, in seconds. If no result is determined in this period, a callback with a `timeout` result is sent.
|
|
37
|
-
* @type {number}
|
|
38
|
-
* @memberof MachineDetectionConfiguration
|
|
39
30
|
*/
|
|
40
31
|
'detectionTimeout'?: number | null;
|
|
41
32
|
/**
|
|
42
33
|
* If no speech is detected in this period, a callback with a \'silence\' result is sent.
|
|
43
|
-
* @type {number}
|
|
44
|
-
* @memberof MachineDetectionConfiguration
|
|
45
34
|
*/
|
|
46
35
|
'silenceTimeout'?: number | null;
|
|
47
36
|
/**
|
|
48
37
|
* When speech has ended and a result couldn\'t be determined based on the audio content itself, this value is used to determine if the speaker is a machine based on the speech duration. If the length of the speech detected is greater than or equal to this threshold, the result will be \'answering-machine\'. If the length of speech detected is below this threshold, the result will be \'human\'.
|
|
49
|
-
* @type {number}
|
|
50
|
-
* @memberof MachineDetectionConfiguration
|
|
51
38
|
*/
|
|
52
39
|
'speechThreshold'?: number | null;
|
|
53
40
|
/**
|
|
54
41
|
* Amount of silence (in seconds) before assuming the callee has finished speaking.
|
|
55
|
-
* @type {number}
|
|
56
|
-
* @memberof MachineDetectionConfiguration
|
|
57
42
|
*/
|
|
58
43
|
'speechEndThreshold'?: number | null;
|
|
59
44
|
/**
|
|
60
45
|
* When an answering machine is detected, the amount of silence (in seconds) before assuming the message has finished playing. If not provided it will default to the speechEndThreshold value.
|
|
61
|
-
* @type {number}
|
|
62
|
-
* @memberof MachineDetectionConfiguration
|
|
63
46
|
*/
|
|
64
47
|
'machineSpeechEndThreshold'?: number | null;
|
|
65
48
|
/**
|
|
66
49
|
* If set to \'true\' and if an answering machine is detected, the \'answering-machine\' callback will be delayed until the machine is done speaking, or an end of message tone is detected, or until the \'detectionTimeout\' is exceeded. If false, the \'answering-machine\' result is sent immediately.
|
|
67
|
-
* @type {boolean}
|
|
68
|
-
* @memberof MachineDetectionConfiguration
|
|
69
50
|
*/
|
|
70
51
|
'delayResult'?: boolean | null;
|
|
71
52
|
/**
|
|
72
53
|
* The URL to send the \'machineDetectionComplete\' webhook when the detection is completed. Only for \'async\' mode.
|
|
73
|
-
* @type {string}
|
|
74
|
-
* @memberof MachineDetectionConfiguration
|
|
75
54
|
*/
|
|
76
55
|
'callbackUrl'?: string | null;
|
|
77
|
-
/**
|
|
78
|
-
*
|
|
79
|
-
* @type {CallbackMethodEnum}
|
|
80
|
-
* @memberof MachineDetectionConfiguration
|
|
81
|
-
*/
|
|
82
56
|
'callbackMethod'?: CallbackMethodEnum | null;
|
|
83
57
|
/**
|
|
84
58
|
* Basic auth username.
|
|
85
|
-
* @type {string}
|
|
86
|
-
* @memberof MachineDetectionConfiguration
|
|
87
59
|
*/
|
|
88
60
|
'username'?: string | null;
|
|
89
61
|
/**
|
|
90
62
|
* Basic auth password.
|
|
91
|
-
* @type {string}
|
|
92
|
-
* @memberof MachineDetectionConfiguration
|
|
93
63
|
*/
|
|
94
64
|
'password'?: string | null;
|
|
95
65
|
/**
|
|
96
66
|
* A fallback URL which, if provided, will be used to retry the machine detection complete webhook delivery in case `callbackUrl` fails to respond
|
|
97
|
-
* @type {string}
|
|
98
|
-
* @memberof MachineDetectionConfiguration
|
|
99
67
|
*/
|
|
100
68
|
'fallbackUrl'?: string | null;
|
|
101
|
-
/**
|
|
102
|
-
*
|
|
103
|
-
* @type {CallbackMethodEnum}
|
|
104
|
-
* @memberof MachineDetectionConfiguration
|
|
105
|
-
*/
|
|
106
69
|
'fallbackMethod'?: CallbackMethodEnum | null;
|
|
107
70
|
/**
|
|
108
71
|
* Basic auth username.
|
|
109
|
-
* @type {string}
|
|
110
|
-
* @memberof MachineDetectionConfiguration
|
|
111
72
|
*/
|
|
112
73
|
'fallbackUsername'?: string | null;
|
|
113
74
|
/**
|
|
114
75
|
* Basic auth password.
|
|
115
|
-
* @type {string}
|
|
116
|
-
* @memberof MachineDetectionConfiguration
|
|
117
76
|
*/
|
|
118
77
|
'fallbackPassword'?: string | null;
|
|
119
78
|
}
|
|
@@ -16,8 +16,6 @@
|
|
|
16
16
|
|
|
17
17
|
/**
|
|
18
18
|
* The machine detection mode. If set to \'async\', the detection result will be sent in a \'machineDetectionComplete\' callback. If set to \'sync\', the \'answer\' callback will wait for the machine detection to complete and will include its result.
|
|
19
|
-
* @export
|
|
20
|
-
* @enum {string}
|
|
21
19
|
*/
|
|
22
20
|
|
|
23
21
|
export const MachineDetectionModeEnum = {
|
|
@@ -16,20 +16,14 @@
|
|
|
16
16
|
|
|
17
17
|
/**
|
|
18
18
|
* (optional) if machine detection was requested in sync mode, the result will be specified here. Possible values are the same as the async counterpart: Machine Detection Complete
|
|
19
|
-
* @export
|
|
20
|
-
* @interface MachineDetectionResult
|
|
21
19
|
*/
|
|
22
20
|
export interface MachineDetectionResult {
|
|
23
21
|
/**
|
|
24
22
|
* Possible values are answering-machine, human, silence, timeout, or error.
|
|
25
|
-
* @type {string}
|
|
26
|
-
* @memberof MachineDetectionResult
|
|
27
23
|
*/
|
|
28
24
|
'value'?: string;
|
|
29
25
|
/**
|
|
30
26
|
* The amount of time it took to determine the result.
|
|
31
|
-
* @type {string}
|
|
32
|
-
* @memberof MachineDetectionResult
|
|
33
27
|
*/
|
|
34
28
|
'duration'?: string;
|
|
35
29
|
}
|
package/models/media.ts
CHANGED
|
@@ -14,29 +14,9 @@
|
|
|
14
14
|
|
|
15
15
|
|
|
16
16
|
|
|
17
|
-
/**
|
|
18
|
-
*
|
|
19
|
-
* @export
|
|
20
|
-
* @interface Media
|
|
21
|
-
*/
|
|
22
17
|
export interface Media {
|
|
23
|
-
/**
|
|
24
|
-
*
|
|
25
|
-
* @type {string}
|
|
26
|
-
* @memberof Media
|
|
27
|
-
*/
|
|
28
18
|
'content'?: string;
|
|
29
|
-
/**
|
|
30
|
-
*
|
|
31
|
-
* @type {number}
|
|
32
|
-
* @memberof Media
|
|
33
|
-
*/
|
|
34
19
|
'contentLength'?: number;
|
|
35
|
-
/**
|
|
36
|
-
*
|
|
37
|
-
* @type {string}
|
|
38
|
-
* @memberof Media
|
|
39
|
-
*/
|
|
40
20
|
'mediaName'?: string;
|
|
41
21
|
}
|
|
42
22
|
|
|
@@ -17,58 +17,34 @@
|
|
|
17
17
|
// @ts-ignore
|
|
18
18
|
import type { PriorityEnum } from './priority-enum';
|
|
19
19
|
|
|
20
|
-
/**
|
|
21
|
-
*
|
|
22
|
-
* @export
|
|
23
|
-
* @interface MessageRequest
|
|
24
|
-
*/
|
|
25
20
|
export interface MessageRequest {
|
|
26
21
|
/**
|
|
27
22
|
* The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard.
|
|
28
|
-
* @type {string}
|
|
29
|
-
* @memberof MessageRequest
|
|
30
23
|
*/
|
|
31
24
|
'applicationId': string;
|
|
32
25
|
/**
|
|
33
26
|
* The phone number(s) the message should be sent to in E164 format.
|
|
34
|
-
* @type {Set<string>}
|
|
35
|
-
* @memberof MessageRequest
|
|
36
27
|
*/
|
|
37
28
|
'to': Set<string>;
|
|
38
29
|
/**
|
|
39
30
|
* Either an alphanumeric sender ID or the sender\'s Bandwidth phone number in E.164 format, which must be hosted within Bandwidth and linked to the account that is generating the message. Alphanumeric Sender IDs can contain up to 11 characters, upper-case letters A-Z, lower-case letters a-z, numbers 0-9, space, hyphen -, plus +, underscore _ and ampersand &. Alphanumeric Sender IDs must contain at least one letter.
|
|
40
|
-
* @type {string}
|
|
41
|
-
* @memberof MessageRequest
|
|
42
31
|
*/
|
|
43
32
|
'from': string;
|
|
44
33
|
/**
|
|
45
34
|
* The contents of the text message. Must be 2048 characters or less.
|
|
46
|
-
* @type {string}
|
|
47
|
-
* @memberof MessageRequest
|
|
48
35
|
*/
|
|
49
36
|
'text'?: string;
|
|
50
37
|
/**
|
|
51
38
|
* A list of URLs to include as media attachments as part of the message. Each URL can be at most 4096 characters.
|
|
52
|
-
* @type {Array<string>}
|
|
53
|
-
* @memberof MessageRequest
|
|
54
39
|
*/
|
|
55
40
|
'media'?: Array<string>;
|
|
56
41
|
/**
|
|
57
42
|
* A custom string that will be included in callback events of the message. Max 1024 characters.
|
|
58
|
-
* @type {string}
|
|
59
|
-
* @memberof MessageRequest
|
|
60
43
|
*/
|
|
61
44
|
'tag'?: string;
|
|
62
|
-
/**
|
|
63
|
-
*
|
|
64
|
-
* @type {PriorityEnum}
|
|
65
|
-
* @memberof MessageRequest
|
|
66
|
-
*/
|
|
67
45
|
'priority'?: PriorityEnum;
|
|
68
46
|
/**
|
|
69
47
|
* A string with the date/time value that the message will automatically expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future.
|
|
70
|
-
* @type {string}
|
|
71
|
-
* @memberof MessageRequest
|
|
72
48
|
*/
|
|
73
49
|
'expiration'?: string;
|
|
74
50
|
}
|
package/models/message.ts
CHANGED
|
@@ -20,88 +20,51 @@ import type { MessageDirectionEnum } from './message-direction-enum';
|
|
|
20
20
|
// @ts-ignore
|
|
21
21
|
import type { PriorityEnum } from './priority-enum';
|
|
22
22
|
|
|
23
|
-
/**
|
|
24
|
-
*
|
|
25
|
-
* @export
|
|
26
|
-
* @interface Message
|
|
27
|
-
*/
|
|
28
23
|
export interface Message {
|
|
29
24
|
/**
|
|
30
25
|
* The id of the message.
|
|
31
|
-
* @type {string}
|
|
32
|
-
* @memberof Message
|
|
33
26
|
*/
|
|
34
27
|
'id'?: string;
|
|
35
28
|
/**
|
|
36
29
|
* The Bandwidth phone number associated with the message.
|
|
37
|
-
* @type {string}
|
|
38
|
-
* @memberof Message
|
|
39
30
|
*/
|
|
40
31
|
'owner'?: string;
|
|
41
32
|
/**
|
|
42
33
|
* The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard.
|
|
43
|
-
* @type {string}
|
|
44
|
-
* @memberof Message
|
|
45
34
|
*/
|
|
46
35
|
'applicationId'?: string;
|
|
47
36
|
/**
|
|
48
37
|
* The datetime stamp of the message in ISO 8601
|
|
49
|
-
* @type {string}
|
|
50
|
-
* @memberof Message
|
|
51
38
|
*/
|
|
52
39
|
'time'?: string;
|
|
53
40
|
/**
|
|
54
41
|
* The number of segments the user\'s message is broken into before sending over carrier networks.
|
|
55
|
-
* @type {number}
|
|
56
|
-
* @memberof Message
|
|
57
42
|
*/
|
|
58
43
|
'segmentCount'?: number;
|
|
59
|
-
/**
|
|
60
|
-
*
|
|
61
|
-
* @type {MessageDirectionEnum}
|
|
62
|
-
* @memberof Message
|
|
63
|
-
*/
|
|
64
44
|
'direction'?: MessageDirectionEnum;
|
|
65
45
|
/**
|
|
66
46
|
* The phone number recipients of the message.
|
|
67
|
-
* @type {Set<string>}
|
|
68
|
-
* @memberof Message
|
|
69
47
|
*/
|
|
70
48
|
'to'?: Set<string>;
|
|
71
49
|
/**
|
|
72
50
|
* The phone number the message was sent from.
|
|
73
|
-
* @type {string}
|
|
74
|
-
* @memberof Message
|
|
75
51
|
*/
|
|
76
52
|
'from'?: string;
|
|
77
53
|
/**
|
|
78
54
|
* The list of media URLs sent in the message. Including a `filename` field in the `Content-Disposition` header of the media linked with a URL will set the displayed file name. This is a best practice to ensure that your media has a readable file name.
|
|
79
|
-
* @type {Set<string>}
|
|
80
|
-
* @memberof Message
|
|
81
55
|
*/
|
|
82
56
|
'media'?: Set<string>;
|
|
83
57
|
/**
|
|
84
58
|
* The contents of the message.
|
|
85
|
-
* @type {string}
|
|
86
|
-
* @memberof Message
|
|
87
59
|
*/
|
|
88
60
|
'text'?: string;
|
|
89
61
|
/**
|
|
90
62
|
* A custom string that will be included in callback events of the message. Max 1024 characters.
|
|
91
|
-
* @type {string}
|
|
92
|
-
* @memberof Message
|
|
93
63
|
*/
|
|
94
64
|
'tag'?: string;
|
|
95
|
-
/**
|
|
96
|
-
*
|
|
97
|
-
* @type {PriorityEnum}
|
|
98
|
-
* @memberof Message
|
|
99
|
-
*/
|
|
100
65
|
'priority'?: PriorityEnum;
|
|
101
66
|
/**
|
|
102
67
|
* A string with the date/time value that the message will automatically expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future.
|
|
103
|
-
* @type {string}
|
|
104
|
-
* @memberof Message
|
|
105
68
|
*/
|
|
106
69
|
'expiration'?: string;
|
|
107
70
|
}
|
package/models/messages-list.ts
CHANGED
|
@@ -20,29 +20,12 @@ import type { ListMessageItem } from './list-message-item';
|
|
|
20
20
|
// @ts-ignore
|
|
21
21
|
import type { PageInfo } from './page-info';
|
|
22
22
|
|
|
23
|
-
/**
|
|
24
|
-
*
|
|
25
|
-
* @export
|
|
26
|
-
* @interface MessagesList
|
|
27
|
-
*/
|
|
28
23
|
export interface MessagesList {
|
|
29
24
|
/**
|
|
30
25
|
* The total number of messages matched by the search. When the request has limitTotalCount set to true this value is limited to 10,000.
|
|
31
|
-
* @type {number}
|
|
32
|
-
* @memberof MessagesList
|
|
33
26
|
*/
|
|
34
27
|
'totalCount'?: number;
|
|
35
|
-
/**
|
|
36
|
-
*
|
|
37
|
-
* @type {PageInfo}
|
|
38
|
-
* @memberof MessagesList
|
|
39
|
-
*/
|
|
40
28
|
'pageInfo'?: PageInfo;
|
|
41
|
-
/**
|
|
42
|
-
*
|
|
43
|
-
* @type {Array<ListMessageItem>}
|
|
44
|
-
* @memberof MessagesList
|
|
45
|
-
*/
|
|
46
29
|
'messages'?: Array<ListMessageItem>;
|
|
47
30
|
}
|
|
48
31
|
|
|
@@ -14,16 +14,9 @@
|
|
|
14
14
|
|
|
15
15
|
|
|
16
16
|
|
|
17
|
-
/**
|
|
18
|
-
*
|
|
19
|
-
* @export
|
|
20
|
-
* @interface MessagingCodeResponse
|
|
21
|
-
*/
|
|
22
17
|
export interface MessagingCodeResponse {
|
|
23
18
|
/**
|
|
24
19
|
* Messaging API Message ID.
|
|
25
|
-
* @type {string}
|
|
26
|
-
* @memberof MessagingCodeResponse
|
|
27
20
|
*/
|
|
28
21
|
'messageId'?: string;
|
|
29
22
|
}
|
|
@@ -14,23 +14,8 @@
|
|
|
14
14
|
|
|
15
15
|
|
|
16
16
|
|
|
17
|
-
/**
|
|
18
|
-
*
|
|
19
|
-
* @export
|
|
20
|
-
* @interface MessagingRequestError
|
|
21
|
-
*/
|
|
22
17
|
export interface MessagingRequestError {
|
|
23
|
-
/**
|
|
24
|
-
*
|
|
25
|
-
* @type {string}
|
|
26
|
-
* @memberof MessagingRequestError
|
|
27
|
-
*/
|
|
28
18
|
'type': string;
|
|
29
|
-
/**
|
|
30
|
-
*
|
|
31
|
-
* @type {string}
|
|
32
|
-
* @memberof MessagingRequestError
|
|
33
|
-
*/
|
|
34
19
|
'description': string;
|
|
35
20
|
}
|
|
36
21
|
|
|
@@ -14,16 +14,9 @@
|
|
|
14
14
|
|
|
15
15
|
|
|
16
16
|
|
|
17
|
-
/**
|
|
18
|
-
*
|
|
19
|
-
* @export
|
|
20
|
-
* @interface MfaForbiddenRequestError
|
|
21
|
-
*/
|
|
22
17
|
export interface MfaForbiddenRequestError {
|
|
23
18
|
/**
|
|
24
19
|
* The message containing the reason behind the request being forbidden.
|
|
25
|
-
* @type {string}
|
|
26
|
-
* @memberof MfaForbiddenRequestError
|
|
27
20
|
*/
|
|
28
21
|
'message'?: string;
|
|
29
22
|
}
|
|
@@ -14,22 +14,13 @@
|
|
|
14
14
|
|
|
15
15
|
|
|
16
16
|
|
|
17
|
-
/**
|
|
18
|
-
*
|
|
19
|
-
* @export
|
|
20
|
-
* @interface MfaRequestError
|
|
21
|
-
*/
|
|
22
17
|
export interface MfaRequestError {
|
|
23
18
|
/**
|
|
24
19
|
* A message describing the error with your request.
|
|
25
|
-
* @type {string}
|
|
26
|
-
* @memberof MfaRequestError
|
|
27
20
|
*/
|
|
28
21
|
'error'?: string;
|
|
29
22
|
/**
|
|
30
23
|
* The associated requestId from AWS.
|
|
31
|
-
* @type {string}
|
|
32
|
-
* @memberof MfaRequestError
|
|
33
24
|
*/
|
|
34
25
|
'requestId'?: string;
|
|
35
26
|
}
|
|
@@ -14,16 +14,9 @@
|
|
|
14
14
|
|
|
15
15
|
|
|
16
16
|
|
|
17
|
-
/**
|
|
18
|
-
*
|
|
19
|
-
* @export
|
|
20
|
-
* @interface MfaUnauthorizedRequestError
|
|
21
|
-
*/
|
|
22
17
|
export interface MfaUnauthorizedRequestError {
|
|
23
18
|
/**
|
|
24
19
|
* Unauthorized
|
|
25
|
-
* @type {string}
|
|
26
|
-
* @memberof MfaUnauthorizedRequestError
|
|
27
20
|
*/
|
|
28
21
|
'message'?: string;
|
|
29
22
|
}
|
|
@@ -14,16 +14,9 @@
|
|
|
14
14
|
|
|
15
15
|
|
|
16
16
|
|
|
17
|
-
/**
|
|
18
|
-
*
|
|
19
|
-
* @export
|
|
20
|
-
* @interface MmsMessageContentFile
|
|
21
|
-
*/
|
|
22
17
|
export interface MmsMessageContentFile {
|
|
23
18
|
/**
|
|
24
19
|
* The URL of a media attachment. For MMS, the API limits file size to 3.5MB. Specific carriers and channels may have a smaller limit that could cause a large file to fail, see [here](https://support.bandwidth.com/hc/en-us/articles/360014235473-What-are-the-MMS-file-size-limits) for more details.
|
|
25
|
-
* @type {string}
|
|
26
|
-
* @memberof MmsMessageContentFile
|
|
27
20
|
*/
|
|
28
21
|
'fileUrl': string;
|
|
29
22
|
}
|