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
|
@@ -9,16 +9,9 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
/**
|
|
13
|
-
*
|
|
14
|
-
* @export
|
|
15
|
-
* @interface VerifyCodeResponse
|
|
16
|
-
*/
|
|
17
12
|
export interface VerifyCodeResponse {
|
|
18
13
|
/**
|
|
19
14
|
* Whether or not the supplied code is valid.
|
|
20
|
-
* @type {boolean}
|
|
21
|
-
* @memberof VerifyCodeResponse
|
|
22
15
|
*/
|
|
23
16
|
'valid'?: boolean;
|
|
24
17
|
}
|
|
@@ -9,28 +9,8 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
/**
|
|
13
|
-
*
|
|
14
|
-
* @export
|
|
15
|
-
* @interface VoiceApiError
|
|
16
|
-
*/
|
|
17
12
|
export interface VoiceApiError {
|
|
18
|
-
/**
|
|
19
|
-
*
|
|
20
|
-
* @type {string}
|
|
21
|
-
* @memberof VoiceApiError
|
|
22
|
-
*/
|
|
23
13
|
'type'?: string;
|
|
24
|
-
/**
|
|
25
|
-
*
|
|
26
|
-
* @type {string}
|
|
27
|
-
* @memberof VoiceApiError
|
|
28
|
-
*/
|
|
29
14
|
'description'?: string;
|
|
30
|
-
/**
|
|
31
|
-
*
|
|
32
|
-
* @type {string}
|
|
33
|
-
* @memberof VoiceApiError
|
|
34
|
-
*/
|
|
35
15
|
'id'?: string | null;
|
|
36
16
|
}
|
|
@@ -9,16 +9,9 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
/**
|
|
13
|
-
*
|
|
14
|
-
* @export
|
|
15
|
-
* @interface VoiceCodeResponse
|
|
16
|
-
*/
|
|
17
12
|
export interface VoiceCodeResponse {
|
|
18
13
|
/**
|
|
19
14
|
* Programmable Voice API Call ID.
|
|
20
|
-
* @type {string}
|
|
21
|
-
* @memberof VoiceCodeResponse
|
|
22
15
|
*/
|
|
23
16
|
'callId'?: string;
|
|
24
17
|
}
|
|
@@ -11,20 +11,8 @@
|
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
13
|
* Basic authentication credentials are not required, but if present, both username and password must be provided.
|
|
14
|
-
* @export
|
|
15
|
-
* @interface WebhookSubscriptionBasicAuthentication
|
|
16
14
|
*/
|
|
17
15
|
export interface WebhookSubscriptionBasicAuthentication {
|
|
18
|
-
/**
|
|
19
|
-
*
|
|
20
|
-
* @type {string}
|
|
21
|
-
* @memberof WebhookSubscriptionBasicAuthentication
|
|
22
|
-
*/
|
|
23
16
|
'username': string;
|
|
24
|
-
/**
|
|
25
|
-
*
|
|
26
|
-
* @type {string}
|
|
27
|
-
* @memberof WebhookSubscriptionBasicAuthentication
|
|
28
|
-
*/
|
|
29
17
|
'password': string;
|
|
30
18
|
}
|
|
@@ -10,28 +10,14 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { TfvBasicAuthentication } from './tfv-basic-authentication';
|
|
13
|
-
/**
|
|
14
|
-
*
|
|
15
|
-
* @export
|
|
16
|
-
* @interface WebhookSubscriptionRequestSchema
|
|
17
|
-
*/
|
|
18
13
|
export interface WebhookSubscriptionRequestSchema {
|
|
19
|
-
/**
|
|
20
|
-
*
|
|
21
|
-
* @type {TfvBasicAuthentication}
|
|
22
|
-
* @memberof WebhookSubscriptionRequestSchema
|
|
23
|
-
*/
|
|
24
14
|
'basicAuthentication'?: TfvBasicAuthentication;
|
|
25
15
|
/**
|
|
26
16
|
* Callback URL to receive status updates from Bandwidth. When a webhook subscription is registered with Bandwidth under a given account ID, it will be used to send status updates for all requests submitted under that account ID.
|
|
27
|
-
* @type {string}
|
|
28
|
-
* @memberof WebhookSubscriptionRequestSchema
|
|
29
17
|
*/
|
|
30
18
|
'callbackUrl': string | null;
|
|
31
19
|
/**
|
|
32
20
|
* An ASCII string submitted by the user as a shared secret key for generating an HMAC header for callbacks.
|
|
33
|
-
* @type {string}
|
|
34
|
-
* @memberof WebhookSubscriptionRequestSchema
|
|
35
21
|
*/
|
|
36
22
|
'sharedSecretKey'?: string | null;
|
|
37
23
|
}
|
|
@@ -9,11 +9,6 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
/**
|
|
13
|
-
*
|
|
14
|
-
* @export
|
|
15
|
-
* @enum {string}
|
|
16
|
-
*/
|
|
17
12
|
export declare const WebhookSubscriptionTypeEnum: {
|
|
18
13
|
readonly TollfreeVerificationStatus: "TOLLFREE_VERIFICATION_STATUS";
|
|
19
14
|
readonly MessagingPortoutApprovalStatus: "MESSAGING_PORTOUT_APPROVAL_STATUS";
|
|
@@ -14,11 +14,6 @@
|
|
|
14
14
|
*/
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
16
|
exports.WebhookSubscriptionTypeEnum = void 0;
|
|
17
|
-
/**
|
|
18
|
-
*
|
|
19
|
-
* @export
|
|
20
|
-
* @enum {string}
|
|
21
|
-
*/
|
|
22
17
|
exports.WebhookSubscriptionTypeEnum = {
|
|
23
18
|
TollfreeVerificationStatus: 'TOLLFREE_VERIFICATION_STATUS',
|
|
24
19
|
MessagingPortoutApprovalStatus: 'MESSAGING_PORTOUT_APPROVAL_STATUS'
|
|
@@ -13,50 +13,16 @@ import type { WebhookSubscriptionBasicAuthentication } from './webhook-subscript
|
|
|
13
13
|
import type { WebhookSubscriptionTypeEnum } from './webhook-subscription-type-enum';
|
|
14
14
|
/**
|
|
15
15
|
* Information about a webhook that Bandwidth should send upon the completion of event customer has subscribed to.
|
|
16
|
-
* @export
|
|
17
|
-
* @interface WebhookSubscription
|
|
18
16
|
*/
|
|
19
17
|
export interface WebhookSubscription {
|
|
20
|
-
/**
|
|
21
|
-
*
|
|
22
|
-
* @type {string}
|
|
23
|
-
* @memberof WebhookSubscription
|
|
24
|
-
*/
|
|
25
18
|
'id'?: string;
|
|
26
|
-
/**
|
|
27
|
-
*
|
|
28
|
-
* @type {string}
|
|
29
|
-
* @memberof WebhookSubscription
|
|
30
|
-
*/
|
|
31
19
|
'accountId'?: string;
|
|
32
20
|
/**
|
|
33
21
|
* Callback URL to receive status updates from Bandwidth. When a webhook subscription is registered with Bandwidth under a given account ID, it will be used to send status updates for all requests submitted under that account ID.
|
|
34
|
-
* @type {string}
|
|
35
|
-
* @memberof WebhookSubscription
|
|
36
22
|
*/
|
|
37
23
|
'callbackUrl': string | null;
|
|
38
|
-
/**
|
|
39
|
-
*
|
|
40
|
-
* @type {WebhookSubscriptionTypeEnum}
|
|
41
|
-
* @memberof WebhookSubscription
|
|
42
|
-
*/
|
|
43
24
|
'type'?: WebhookSubscriptionTypeEnum;
|
|
44
|
-
/**
|
|
45
|
-
*
|
|
46
|
-
* @type {WebhookSubscriptionBasicAuthentication}
|
|
47
|
-
* @memberof WebhookSubscription
|
|
48
|
-
*/
|
|
49
25
|
'basicAuthentication'?: WebhookSubscriptionBasicAuthentication;
|
|
50
|
-
/**
|
|
51
|
-
*
|
|
52
|
-
* @type {string}
|
|
53
|
-
* @memberof WebhookSubscription
|
|
54
|
-
*/
|
|
55
26
|
'createdDate'?: string;
|
|
56
|
-
/**
|
|
57
|
-
*
|
|
58
|
-
* @type {string}
|
|
59
|
-
* @memberof WebhookSubscription
|
|
60
|
-
*/
|
|
61
27
|
'modifiedDate'?: string;
|
|
62
28
|
}
|
|
@@ -14,26 +14,9 @@ import type { ModelError } from './model-error';
|
|
|
14
14
|
import type { WebhookSubscription } from './webhook-subscription';
|
|
15
15
|
/**
|
|
16
16
|
* A list of all webhook subscriptions registered for this account ID for this particular feature (unpaginated).
|
|
17
|
-
* @export
|
|
18
|
-
* @interface WebhookSubscriptionsListBody
|
|
19
17
|
*/
|
|
20
18
|
export interface WebhookSubscriptionsListBody {
|
|
21
|
-
/**
|
|
22
|
-
*
|
|
23
|
-
* @type {LinksObject}
|
|
24
|
-
* @memberof WebhookSubscriptionsListBody
|
|
25
|
-
*/
|
|
26
19
|
'links'?: LinksObject;
|
|
27
|
-
/**
|
|
28
|
-
*
|
|
29
|
-
* @type {Array<ModelError>}
|
|
30
|
-
* @memberof WebhookSubscriptionsListBody
|
|
31
|
-
*/
|
|
32
20
|
'errors'?: Array<ModelError>;
|
|
33
|
-
/**
|
|
34
|
-
*
|
|
35
|
-
* @type {Array<WebhookSubscription>}
|
|
36
|
-
* @memberof WebhookSubscriptionsListBody
|
|
37
|
-
*/
|
|
38
21
|
'data': Array<WebhookSubscription>;
|
|
39
22
|
}
|
|
@@ -1,19 +1,19 @@
|
|
|
1
|
-
#
|
|
1
|
+
# AsyncLookupRequest
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**
|
|
8
|
+
**phoneNumbers** | **Array<string>** | Telephone numbers in E.164 format. | [default to undefined]
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
13
|
-
import {
|
|
13
|
+
import { AsyncLookupRequest } from 'bandwidth-sdk';
|
|
14
14
|
|
|
15
|
-
const instance:
|
|
16
|
-
|
|
15
|
+
const instance: AsyncLookupRequest = {
|
|
16
|
+
phoneNumbers,
|
|
17
17
|
};
|
|
18
18
|
```
|
|
19
19
|
|
package/docs/CallState.md
CHANGED
|
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**from** | **string** | The phone number that made the call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined]
|
|
14
14
|
**direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] [default to undefined]
|
|
15
15
|
**state** | **string** | The current state of the call. Current possible values are `queued`, `initiated`, `answered` and `disconnected`. Additional states may be added in the future, so your application must be tolerant of unknown values. | [optional] [default to undefined]
|
|
16
|
-
**stirShaken** | **{ [key: string]: string; }** | For inbound calls, the Bandwidth STIR/SHAKEN implementation will verify the information provided in the inbound invite request `Identity` header. The verification status is stored in the call state `stirShaken` property as follows. | Property | Description | |:------------------|:------------| | verstat | (optional) The verification status indicating whether the verification was successful or not. Possible values are `TN-
|
|
16
|
+
**stirShaken** | **{ [key: string]: string; }** | For inbound calls, the Bandwidth STIR/SHAKEN implementation will verify the information provided in the inbound invite request `Identity` header. The verification status is stored in the call state `stirShaken` property as follows. | Property | Description | |:------------------|:------------| | verstat | (optional) The verification status indicating whether the verification was successful or not. Possible values are `TN-Validation-Passed` or `TN-Validation-Failed`. | | attestationIndicator | (optional) The attestation level verified by Bandwidth. Possible values are `A` (full), `B` (partial) or `C` (gateway). | | originatingId | (optional) A unique origination identifier. | Note that these are common properties but that the `stirShaken` object is free form and can contain other key-value pairs. More information: [Understanding STIR/SHAKEN](https://www.bandwidth.com/regulations/stir-shaken). | [optional] [default to undefined]
|
|
17
17
|
**identity** | **string** | The value of the `Identity` header from the inbound invite request. Only present for inbound calls and if the account is configured to forward this header. | [optional] [default to undefined]
|
|
18
18
|
**enqueuedTime** | **string** | The time this call was placed in queue. | [optional] [default to undefined]
|
|
19
19
|
**startTime** | **string** | The time the call was initiated, in ISO 8601 format. `null` if the call is still in your queue. | [optional] [default to undefined]
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# CompletedLookupStatusEnum
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `Complete` (value: `'COMPLETE'`)
|
|
7
|
+
|
|
8
|
+
* `PartialComplete` (value: `'PARTIAL_COMPLETE'`)
|
|
9
|
+
|
|
10
|
+
* `Failed` (value: `'FAILED'`)
|
|
11
|
+
|
|
12
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# CreateAsyncBulkLookupResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**links** | [**Array<LinkSchema>**](LinkSchema.md) | Links for pagination (if applicable) | [optional] [default to undefined]
|
|
9
|
+
**data** | [**CreateAsyncBulkLookupResponseData**](CreateAsyncBulkLookupResponseData.md) | | [optional] [default to undefined]
|
|
10
|
+
**errors** | [**Array<LookupErrorSchema>**](LookupErrorSchema.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { CreateAsyncBulkLookupResponse } from 'bandwidth-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: CreateAsyncBulkLookupResponse = {
|
|
18
|
+
links,
|
|
19
|
+
data,
|
|
20
|
+
errors,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,20 +1,20 @@
|
|
|
1
|
-
#
|
|
1
|
+
# CreateAsyncBulkLookupResponseData
|
|
2
2
|
|
|
3
|
-
The
|
|
3
|
+
The phone number lookup response data
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**requestId** | **string** | The phone number lookup request ID from Bandwidth. | [optional] [default to undefined]
|
|
10
|
-
**status** | [**
|
|
10
|
+
**status** | [**InProgressLookupStatusEnum**](InProgressLookupStatusEnum.md) | | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
14
14
|
```typescript
|
|
15
|
-
import {
|
|
15
|
+
import { CreateAsyncBulkLookupResponseData } from 'bandwidth-sdk';
|
|
16
16
|
|
|
17
|
-
const instance:
|
|
17
|
+
const instance: CreateAsyncBulkLookupResponseData = {
|
|
18
18
|
requestId,
|
|
19
19
|
status,
|
|
20
20
|
};
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# CreateSyncLookupResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**links** | [**Array<LinkSchema>**](LinkSchema.md) | | [optional] [default to undefined]
|
|
9
|
+
**data** | [**CreateSyncLookupResponseData**](CreateSyncLookupResponseData.md) | | [optional] [default to undefined]
|
|
10
|
+
**errors** | [**Array<LookupErrorSchema>**](LookupErrorSchema.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { CreateSyncLookupResponse } from 'bandwidth-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: CreateSyncLookupResponse = {
|
|
18
|
+
links,
|
|
19
|
+
data,
|
|
20
|
+
errors,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# CreateSyncLookupResponseData
|
|
2
|
+
|
|
3
|
+
The phone number lookup response data
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**requestId** | **string** | The phone number lookup request ID from Bandwidth. | [optional] [default to undefined]
|
|
10
|
+
**status** | [**CompletedLookupStatusEnum**](CompletedLookupStatusEnum.md) | | [optional] [default to undefined]
|
|
11
|
+
**results** | [**Array<LookupResult>**](LookupResult.md) | The carrier information results for the specified telephone numbers. | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { CreateSyncLookupResponseData } from 'bandwidth-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: CreateSyncLookupResponseData = {
|
|
19
|
+
requestId,
|
|
20
|
+
status,
|
|
21
|
+
results,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# DeactivationEventEnum
|
|
2
|
+
|
|
3
|
+
[DNI-Only](#section/DNI-Only). `DEACTIVATED` if the carrier reported a deactivation event for this phone number.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `Deactivated` (value: `'DEACTIVATED'`)
|
|
8
|
+
|
|
9
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# GetAsyncBulkLookupResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**links** | [**Array<LinkSchema>**](LinkSchema.md) | | [optional] [default to undefined]
|
|
9
|
+
**data** | [**GetAsyncBulkLookupResponseData**](GetAsyncBulkLookupResponseData.md) | | [optional] [default to undefined]
|
|
10
|
+
**errors** | [**Array<LookupErrorSchema>**](LookupErrorSchema.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { GetAsyncBulkLookupResponse } from 'bandwidth-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: GetAsyncBulkLookupResponse = {
|
|
18
|
+
links,
|
|
19
|
+
data,
|
|
20
|
+
errors,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# GetAsyncBulkLookupResponseData
|
|
2
|
+
|
|
3
|
+
The phone number lookup response data
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**requestId** | **string** | The phone number lookup request ID from Bandwidth. | [optional] [default to undefined]
|
|
10
|
+
**status** | [**InProgressLookupStatusEnum**](InProgressLookupStatusEnum.md) | | [optional] [default to undefined]
|
|
11
|
+
**results** | [**Array<LookupResult>**](LookupResult.md) | The carrier information results for the specified telephone number. | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { GetAsyncBulkLookupResponseData } from 'bandwidth-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: GetAsyncBulkLookupResponseData = {
|
|
19
|
+
requestId,
|
|
20
|
+
status,
|
|
21
|
+
results,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# LatestMessageDeliveryStatusEnum
|
|
2
|
+
|
|
3
|
+
[DNI-Only](#section/DNI-Only). The current delivery status of the phone number. - ACTIVE: A message was successfully sent to the number (delivery code 0). - DEACTIVATED: A message was not delivered to a number (delivery code 720) - UNKNOWN: Bandwidth cannot find an delivery status entry for the number.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `Active` (value: `'ACTIVE'`)
|
|
8
|
+
|
|
9
|
+
* `Deactivated` (value: `'DEACTIVATED'`)
|
|
10
|
+
|
|
11
|
+
* `Unknown` (value: `'UNKNOWN'`)
|
|
12
|
+
|
|
13
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# LineTypeEnum
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `Fixed` (value: `'FIXED'`)
|
|
7
|
+
|
|
8
|
+
* `VoipFixed` (value: `'VOIP-FIXED'`)
|
|
9
|
+
|
|
10
|
+
* `Mobile` (value: `'MOBILE'`)
|
|
11
|
+
|
|
12
|
+
* `Voip` (value: `'VOIP'`)
|
|
13
|
+
|
|
14
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# LinkSchema
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**href** | **string** | URI of the link. | [optional] [default to undefined]
|
|
9
|
+
**rel** | **string** | Specifies the relationship between this link and the resource. | [optional] [default to undefined]
|
|
10
|
+
**method** | **string** | HTTP method to be used. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { LinkSchema } from 'bandwidth-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: LinkSchema = {
|
|
18
|
+
href,
|
|
19
|
+
rel,
|
|
20
|
+
method,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# LookupErrorResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**links** | [**Array<LinkSchema>**](LinkSchema.md) | | [optional] [default to undefined]
|
|
9
|
+
**data** | **object** | The phone number lookup response data | [optional] [default to undefined]
|
|
10
|
+
**errors** | [**Array<LookupErrorSchema>**](LookupErrorSchema.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { LookupErrorResponse } from 'bandwidth-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: LookupErrorResponse = {
|
|
18
|
+
links,
|
|
19
|
+
data,
|
|
20
|
+
errors,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# LookupErrorSchema
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**code** | **string** | Validation error code | [optional] [default to undefined]
|
|
9
|
+
**description** | **string** | Description of validation error | [optional] [default to undefined]
|
|
10
|
+
**type** | **string** | Type of validation error | [optional] [default to undefined]
|
|
11
|
+
**meta** | [**LookupErrorSchemaMeta**](LookupErrorSchemaMeta.md) | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { LookupErrorSchema } from 'bandwidth-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: LookupErrorSchema = {
|
|
19
|
+
code,
|
|
20
|
+
description,
|
|
21
|
+
type,
|
|
22
|
+
meta,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# LookupErrorSchemaMeta
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**phoneNumbers** | **Array<string>** | | [optional] [default to undefined]
|
|
9
|
+
**message** | **string** | Message describing the error | [optional] [default to undefined]
|
|
10
|
+
**code** | **number** | Error code associated with the message | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { LookupErrorSchemaMeta } from 'bandwidth-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: LookupErrorSchemaMeta = {
|
|
18
|
+
phoneNumbers,
|
|
19
|
+
message,
|
|
20
|
+
code,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/LookupResult.md
CHANGED
|
@@ -6,15 +6,17 @@ Carrier information results for the specified telephone number.
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**
|
|
10
|
-
**
|
|
11
|
-
**
|
|
12
|
-
**
|
|
13
|
-
**
|
|
14
|
-
**
|
|
15
|
-
**
|
|
16
|
-
**
|
|
17
|
-
**
|
|
9
|
+
**phoneNumber** | **string** | The telephone number in E.164 format. | [optional] [default to undefined]
|
|
10
|
+
**lineType** | [**LineTypeEnum**](LineTypeEnum.md) | | [optional] [default to undefined]
|
|
11
|
+
**messagingProvider** | **string** | The messaging service provider of the telephone number. | [optional] [default to undefined]
|
|
12
|
+
**voiceProvider** | **string** | The voice service provider of the telephone number. | [optional] [default to undefined]
|
|
13
|
+
**countryCodeA3** | **string** | The country code of the telephone number in ISO 3166-1 alpha-3 format. | [optional] [default to undefined]
|
|
14
|
+
**deactivationReporter** | **string** | [DNI-Only](#section/DNI-Only). The carrier that reported a deactivation event for this phone number. | [optional] [default to undefined]
|
|
15
|
+
**deactivationDate** | **string** | [DNI-Only](#section/DNI-Only). The datetime the carrier reported a deactivation event. | [optional] [default to undefined]
|
|
16
|
+
**deactivationEvent** | [**DeactivationEventEnum**](DeactivationEventEnum.md) | | [optional] [default to undefined]
|
|
17
|
+
**latestMessageDeliveryStatus** | [**LatestMessageDeliveryStatusEnum**](LatestMessageDeliveryStatusEnum.md) | | [optional] [default to undefined]
|
|
18
|
+
**initialMessageDeliveryStatusDate** | **string** | [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. | [optional] [default to undefined]
|
|
19
|
+
**latestMessageDeliveryStatusDate** | **string** | [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. | [optional] [default to undefined]
|
|
18
20
|
|
|
19
21
|
## Example
|
|
20
22
|
|
|
@@ -22,15 +24,17 @@ Name | Type | Description | Notes
|
|
|
22
24
|
import { LookupResult } from 'bandwidth-sdk';
|
|
23
25
|
|
|
24
26
|
const instance: LookupResult = {
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
27
|
+
phoneNumber,
|
|
28
|
+
lineType,
|
|
29
|
+
messagingProvider,
|
|
30
|
+
voiceProvider,
|
|
31
|
+
countryCodeA3,
|
|
32
|
+
deactivationReporter,
|
|
33
|
+
deactivationDate,
|
|
34
|
+
deactivationEvent,
|
|
35
|
+
latestMessageDeliveryStatus,
|
|
36
|
+
initialMessageDeliveryStatusDate,
|
|
37
|
+
latestMessageDeliveryStatusDate,
|
|
34
38
|
};
|
|
35
39
|
```
|
|
36
40
|
|