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
|
@@ -19,104 +19,67 @@ import type { CallDirectionEnum } from './call-direction-enum';
|
|
|
19
19
|
|
|
20
20
|
/**
|
|
21
21
|
* The Redirect event is fired when a <Redirect> verb is executed. Its purpose is to get the next set of verbs from the calling application.
|
|
22
|
-
* @export
|
|
23
|
-
* @interface RedirectCallback
|
|
24
22
|
*/
|
|
25
23
|
export interface RedirectCallback {
|
|
26
24
|
/**
|
|
27
25
|
* The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect.
|
|
28
|
-
* @type {string}
|
|
29
|
-
* @memberof RedirectCallback
|
|
30
26
|
*/
|
|
31
27
|
'eventType'?: string;
|
|
32
28
|
/**
|
|
33
29
|
* The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution.
|
|
34
|
-
* @type {string}
|
|
35
|
-
* @memberof RedirectCallback
|
|
36
30
|
*/
|
|
37
31
|
'eventTime'?: string;
|
|
38
32
|
/**
|
|
39
33
|
* The user account associated with the call.
|
|
40
|
-
* @type {string}
|
|
41
|
-
* @memberof RedirectCallback
|
|
42
34
|
*/
|
|
43
35
|
'accountId'?: string;
|
|
44
36
|
/**
|
|
45
37
|
* The id of the application associated with the call.
|
|
46
|
-
* @type {string}
|
|
47
|
-
* @memberof RedirectCallback
|
|
48
38
|
*/
|
|
49
39
|
'applicationId'?: string;
|
|
50
40
|
/**
|
|
51
41
|
* The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555).
|
|
52
|
-
* @type {string}
|
|
53
|
-
* @memberof RedirectCallback
|
|
54
42
|
*/
|
|
55
43
|
'from'?: string;
|
|
56
44
|
/**
|
|
57
45
|
* The phone number that received the call, in E.164 format (e.g. +15555555555).
|
|
58
|
-
* @type {string}
|
|
59
|
-
* @memberof RedirectCallback
|
|
60
46
|
*/
|
|
61
47
|
'to'?: string;
|
|
62
|
-
/**
|
|
63
|
-
*
|
|
64
|
-
* @type {CallDirectionEnum}
|
|
65
|
-
* @memberof RedirectCallback
|
|
66
|
-
*/
|
|
67
48
|
'direction'?: CallDirectionEnum;
|
|
68
49
|
/**
|
|
69
50
|
* The call id associated with the event.
|
|
70
|
-
* @type {string}
|
|
71
|
-
* @memberof RedirectCallback
|
|
72
51
|
*/
|
|
73
52
|
'callId'?: string;
|
|
74
53
|
/**
|
|
75
54
|
* The URL of the call associated with the event.
|
|
76
|
-
* @type {string}
|
|
77
|
-
* @memberof RedirectCallback
|
|
78
55
|
*/
|
|
79
56
|
'callUrl'?: string;
|
|
80
57
|
/**
|
|
81
58
|
* (optional) If the event is related to the B leg of a <Transfer>, the call id of the original call leg that executed the <Transfer>. Otherwise, this field will not be present.
|
|
82
|
-
* @type {string}
|
|
83
|
-
* @memberof RedirectCallback
|
|
84
59
|
*/
|
|
85
60
|
'parentCallId'?: string;
|
|
86
61
|
/**
|
|
87
62
|
* (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format.
|
|
88
|
-
* @type {string}
|
|
89
|
-
* @memberof RedirectCallback
|
|
90
63
|
*/
|
|
91
64
|
'enqueuedTime'?: string | null;
|
|
92
65
|
/**
|
|
93
66
|
* Time the call was started, in ISO 8601 format.
|
|
94
|
-
* @type {string}
|
|
95
|
-
* @memberof RedirectCallback
|
|
96
67
|
*/
|
|
97
68
|
'startTime'?: string;
|
|
98
69
|
/**
|
|
99
70
|
* Time the call was answered, in ISO 8601 format.
|
|
100
|
-
* @type {string}
|
|
101
|
-
* @memberof RedirectCallback
|
|
102
71
|
*/
|
|
103
72
|
'answerTime'?: string | null;
|
|
104
73
|
/**
|
|
105
74
|
* (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present.
|
|
106
|
-
* @type {string}
|
|
107
|
-
* @memberof RedirectCallback
|
|
108
75
|
*/
|
|
109
76
|
'tag'?: string | null;
|
|
110
77
|
/**
|
|
111
78
|
* The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555).
|
|
112
|
-
* @type {string}
|
|
113
|
-
* @memberof RedirectCallback
|
|
114
79
|
*/
|
|
115
80
|
'transferCallerId'?: string;
|
|
116
81
|
/**
|
|
117
82
|
* The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555).
|
|
118
|
-
* @type {string}
|
|
119
|
-
* @memberof RedirectCallback
|
|
120
83
|
*/
|
|
121
84
|
'transferTo'?: string;
|
|
122
85
|
}
|
|
@@ -14,16 +14,9 @@
|
|
|
14
14
|
|
|
15
15
|
|
|
16
16
|
|
|
17
|
-
/**
|
|
18
|
-
*
|
|
19
|
-
* @export
|
|
20
|
-
* @interface SmsMessageContent
|
|
21
|
-
*/
|
|
22
17
|
export interface SmsMessageContent {
|
|
23
18
|
/**
|
|
24
19
|
* The contents of the text message. Must be 2048 characters or less.
|
|
25
|
-
* @type {string}
|
|
26
|
-
* @memberof SmsMessageContent
|
|
27
20
|
*/
|
|
28
21
|
'text': string;
|
|
29
22
|
}
|
|
@@ -25,87 +25,44 @@ import type { PriorityEnum } from './priority-enum';
|
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* Message payload schema within a callback
|
|
28
|
-
* @export
|
|
29
|
-
* @interface StatusCallbackMessage
|
|
30
28
|
*/
|
|
31
29
|
export interface StatusCallbackMessage {
|
|
32
30
|
/**
|
|
33
31
|
* A unique identifier of the message.
|
|
34
|
-
* @type {string}
|
|
35
|
-
* @memberof StatusCallbackMessage
|
|
36
32
|
*/
|
|
37
33
|
'id': string;
|
|
38
34
|
/**
|
|
39
35
|
* The Bandwidth phone number or alphanumeric identifier associated with the message.
|
|
40
|
-
* @type {string}
|
|
41
|
-
* @memberof StatusCallbackMessage
|
|
42
36
|
*/
|
|
43
37
|
'owner': string;
|
|
44
38
|
/**
|
|
45
39
|
* The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard.
|
|
46
|
-
* @type {string}
|
|
47
|
-
* @memberof StatusCallbackMessage
|
|
48
40
|
*/
|
|
49
41
|
'applicationId': string;
|
|
50
|
-
/**
|
|
51
|
-
*
|
|
52
|
-
* @type {string}
|
|
53
|
-
* @memberof StatusCallbackMessage
|
|
54
|
-
*/
|
|
55
42
|
'time': string;
|
|
56
43
|
/**
|
|
57
44
|
* The number of segments the user\'s message is broken into before sending over carrier networks.
|
|
58
|
-
* @type {number}
|
|
59
|
-
* @memberof StatusCallbackMessage
|
|
60
45
|
*/
|
|
61
46
|
'segmentCount': number;
|
|
62
|
-
/**
|
|
63
|
-
*
|
|
64
|
-
* @type {MessageDirectionEnum}
|
|
65
|
-
* @memberof StatusCallbackMessage
|
|
66
|
-
*/
|
|
67
47
|
'direction': MessageDirectionEnum;
|
|
68
48
|
/**
|
|
69
49
|
* The phone number recipients of the message.
|
|
70
|
-
* @type {Set<string>}
|
|
71
|
-
* @memberof StatusCallbackMessage
|
|
72
50
|
*/
|
|
73
51
|
'to': Set<string>;
|
|
74
52
|
/**
|
|
75
53
|
* The Bandwidth phone number or alphanumeric identifier the message was sent from.
|
|
76
|
-
* @type {string}
|
|
77
|
-
* @memberof StatusCallbackMessage
|
|
78
54
|
*/
|
|
79
55
|
'from': string;
|
|
80
|
-
/**
|
|
81
|
-
*
|
|
82
|
-
* @type {string}
|
|
83
|
-
* @memberof StatusCallbackMessage
|
|
84
|
-
*/
|
|
85
56
|
'text'?: string;
|
|
86
57
|
/**
|
|
87
58
|
* A custom string that will be included in callback events of the message. Max 1024 characters.
|
|
88
|
-
* @type {string}
|
|
89
|
-
* @memberof StatusCallbackMessage
|
|
90
59
|
*/
|
|
91
60
|
'tag'?: string;
|
|
92
61
|
/**
|
|
93
62
|
* Optional media, not applicable for sms
|
|
94
|
-
* @type {Array<string>}
|
|
95
|
-
* @memberof StatusCallbackMessage
|
|
96
63
|
*/
|
|
97
64
|
'media'?: Array<string>;
|
|
98
|
-
/**
|
|
99
|
-
*
|
|
100
|
-
* @type {PriorityEnum}
|
|
101
|
-
* @memberof StatusCallbackMessage
|
|
102
|
-
*/
|
|
103
65
|
'priority'?: PriorityEnum;
|
|
104
|
-
/**
|
|
105
|
-
*
|
|
106
|
-
* @type {MultiChannelMessageChannelEnum}
|
|
107
|
-
* @memberof StatusCallbackMessage
|
|
108
|
-
*/
|
|
109
66
|
'channel'?: MultiChannelMessageChannelEnum;
|
|
110
67
|
}
|
|
111
68
|
|
|
@@ -16,8 +16,6 @@
|
|
|
16
16
|
|
|
17
17
|
/**
|
|
18
18
|
* The possible status callbacks when sending an MT SMS or MMS or RBM message: - `message-sending` indicates that Bandwidth is sending the message to the upstream provider. - `message-delivered` indicates that the message was successfully sent. - `message-failed` indicates that the message could not be sent to the intended recipient. - `message-read` indicates that the RBM message was read by the recipient.
|
|
19
|
-
* @export
|
|
20
|
-
* @enum {string}
|
|
21
19
|
*/
|
|
22
20
|
|
|
23
21
|
export const StatusCallbackTypeEnum = {
|
|
@@ -22,56 +22,29 @@ import type { StatusCallbackTypeEnum } from './status-callback-type-enum';
|
|
|
22
22
|
|
|
23
23
|
/**
|
|
24
24
|
* Represents a status callback for an outbound MT SMS or MMS or RBM message.
|
|
25
|
-
* @export
|
|
26
|
-
* @interface StatusCallback
|
|
27
25
|
*/
|
|
28
26
|
export interface StatusCallback {
|
|
29
|
-
/**
|
|
30
|
-
*
|
|
31
|
-
* @type {string}
|
|
32
|
-
* @memberof StatusCallback
|
|
33
|
-
*/
|
|
34
27
|
'time': string;
|
|
35
28
|
/**
|
|
36
29
|
* Represents the time at which the message was read, for `message-read` callbacks.
|
|
37
|
-
* @type {string}
|
|
38
|
-
* @memberof StatusCallback
|
|
39
30
|
*/
|
|
40
31
|
'eventTime'?: string;
|
|
41
|
-
/**
|
|
42
|
-
*
|
|
43
|
-
* @type {StatusCallbackTypeEnum}
|
|
44
|
-
* @memberof StatusCallback
|
|
45
|
-
*/
|
|
46
32
|
'type': StatusCallbackTypeEnum;
|
|
47
33
|
/**
|
|
48
34
|
* The destination phone number the message was sent to. For status callbacks, this the the Bandwidth user\'s client phone number.
|
|
49
|
-
* @type {string}
|
|
50
|
-
* @memberof StatusCallback
|
|
51
35
|
*/
|
|
52
36
|
'to': string;
|
|
53
37
|
/**
|
|
54
38
|
* A detailed description of the event described by the callback.
|
|
55
|
-
* @type {string}
|
|
56
|
-
* @memberof StatusCallback
|
|
57
39
|
*/
|
|
58
40
|
'description': string;
|
|
59
|
-
/**
|
|
60
|
-
*
|
|
61
|
-
* @type {StatusCallbackMessage}
|
|
62
|
-
* @memberof StatusCallback
|
|
63
|
-
*/
|
|
64
41
|
'message': StatusCallbackMessage;
|
|
65
42
|
/**
|
|
66
43
|
* Optional error code, applicable only when type is `message-failed`.
|
|
67
|
-
* @type {number}
|
|
68
|
-
* @memberof StatusCallback
|
|
69
44
|
*/
|
|
70
45
|
'errorCode'?: number;
|
|
71
46
|
/**
|
|
72
47
|
* The name of the Authorized Message Provider (AMP) that handled this message. In the US, this is the carrier that the message was sent to. This field is present only when this account feature has been enabled.
|
|
73
|
-
* @type {string}
|
|
74
|
-
* @memberof StatusCallback
|
|
75
48
|
*/
|
|
76
49
|
'carrierName'?: string;
|
|
77
50
|
}
|
package/models/stir-shaken.ts
CHANGED
|
@@ -14,28 +14,17 @@
|
|
|
14
14
|
|
|
15
15
|
|
|
16
16
|
|
|
17
|
-
/**
|
|
18
|
-
*
|
|
19
|
-
* @export
|
|
20
|
-
* @interface StirShaken
|
|
21
|
-
*/
|
|
22
17
|
export interface StirShaken {
|
|
23
18
|
/**
|
|
24
|
-
* (optional) The verification status indicating whether the verification was successful or not. Possible values are TN-
|
|
25
|
-
* @type {string}
|
|
26
|
-
* @memberof StirShaken
|
|
19
|
+
* (optional) The verification status indicating whether the verification was successful or not. Possible values are TN-Validation-Passed and TN-Validation-Failed.
|
|
27
20
|
*/
|
|
28
21
|
'verstat'?: string;
|
|
29
22
|
/**
|
|
30
23
|
* (optional) The attestation level verified by Bandwidth. Possible values are A (full), B (partial) or C (gateway).
|
|
31
|
-
* @type {string}
|
|
32
|
-
* @memberof StirShaken
|
|
33
24
|
*/
|
|
34
25
|
'attestationIndicator'?: string;
|
|
35
26
|
/**
|
|
36
27
|
* (optional) A unique origination identifier.
|
|
37
|
-
* @type {string}
|
|
38
|
-
* @memberof StirShaken
|
|
39
28
|
*/
|
|
40
29
|
'originatingId'?: string;
|
|
41
30
|
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Bandwidth
|
|
5
|
+
* Bandwidth\'s Communication APIs
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
* Contact: letstalk@bandwidth.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
export interface SyncLookupRequest {
|
|
18
|
+
/**
|
|
19
|
+
* Telephone numbers in E.164 format.
|
|
20
|
+
*/
|
|
21
|
+
'phoneNumbers': Array<string>;
|
|
22
|
+
}
|
|
23
|
+
|
|
@@ -14,23 +14,8 @@
|
|
|
14
14
|
|
|
15
15
|
|
|
16
16
|
|
|
17
|
-
/**
|
|
18
|
-
*
|
|
19
|
-
* @export
|
|
20
|
-
* @interface TfvBasicAuthentication
|
|
21
|
-
*/
|
|
22
17
|
export interface TfvBasicAuthentication {
|
|
23
|
-
/**
|
|
24
|
-
*
|
|
25
|
-
* @type {string}
|
|
26
|
-
* @memberof TfvBasicAuthentication
|
|
27
|
-
*/
|
|
28
18
|
'username': string;
|
|
29
|
-
/**
|
|
30
|
-
*
|
|
31
|
-
* @type {string}
|
|
32
|
-
* @memberof TfvBasicAuthentication
|
|
33
|
-
*/
|
|
34
19
|
'password': string;
|
|
35
20
|
}
|
|
36
21
|
|
package/models/tfv-error.ts
CHANGED
|
@@ -16,26 +16,12 @@
|
|
|
16
16
|
|
|
17
17
|
/**
|
|
18
18
|
* A generic error object.
|
|
19
|
-
* @export
|
|
20
|
-
* @interface TfvError
|
|
21
19
|
*/
|
|
22
20
|
export interface TfvError {
|
|
23
|
-
/**
|
|
24
|
-
*
|
|
25
|
-
* @type {string}
|
|
26
|
-
* @memberof TfvError
|
|
27
|
-
*/
|
|
28
21
|
'type'?: string;
|
|
29
|
-
/**
|
|
30
|
-
*
|
|
31
|
-
* @type {string}
|
|
32
|
-
* @memberof TfvError
|
|
33
|
-
*/
|
|
34
22
|
'description'?: string;
|
|
35
23
|
/**
|
|
36
24
|
* Each key of this errors object refers to a field of the submitted object (using dot notation for nested objects), with the field being a key to an array of one or more errors for that field.
|
|
37
|
-
* @type {object}
|
|
38
|
-
* @memberof TfvError
|
|
39
25
|
*/
|
|
40
26
|
'errors'?: object;
|
|
41
27
|
}
|
package/models/tfv-status.ts
CHANGED
|
@@ -20,70 +20,39 @@ import type { TfvStatusEnum } from './tfv-status-enum';
|
|
|
20
20
|
// @ts-ignore
|
|
21
21
|
import type { TfvSubmissionInfo } from './tfv-submission-info';
|
|
22
22
|
|
|
23
|
-
/**
|
|
24
|
-
*
|
|
25
|
-
* @export
|
|
26
|
-
* @interface TfvStatus
|
|
27
|
-
*/
|
|
28
23
|
export interface TfvStatus {
|
|
29
24
|
/**
|
|
30
25
|
* Toll-free telephone number in E.164 format.
|
|
31
|
-
* @type {string}
|
|
32
|
-
* @memberof TfvStatus
|
|
33
26
|
*/
|
|
34
27
|
'phoneNumber'?: string;
|
|
35
|
-
/**
|
|
36
|
-
*
|
|
37
|
-
* @type {TfvStatusEnum}
|
|
38
|
-
* @memberof TfvStatus
|
|
39
|
-
*/
|
|
40
28
|
'status'?: TfvStatusEnum;
|
|
41
29
|
/**
|
|
42
30
|
* Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number - included in all webhook payloads.
|
|
43
|
-
* @type {string}
|
|
44
|
-
* @memberof TfvStatus
|
|
45
31
|
*/
|
|
46
32
|
'internalTicketNumber'?: string;
|
|
47
33
|
/**
|
|
48
34
|
* Explanation for why a verification request was declined.
|
|
49
|
-
* @type {string}
|
|
50
|
-
* @memberof TfvStatus
|
|
51
35
|
*/
|
|
52
36
|
'declineReasonDescription'?: string;
|
|
53
37
|
/**
|
|
54
38
|
* Whether a Toll-Free Verification request qualifies for resubmission via PUT.
|
|
55
|
-
* @type {boolean}
|
|
56
|
-
* @memberof TfvStatus
|
|
57
39
|
*/
|
|
58
40
|
'resubmitAllowed'?: boolean;
|
|
59
41
|
/**
|
|
60
42
|
* Date and time the verification request was created.
|
|
61
|
-
* @type {string}
|
|
62
|
-
* @memberof TfvStatus
|
|
63
43
|
*/
|
|
64
44
|
'createdDateTime'?: string;
|
|
65
45
|
/**
|
|
66
46
|
* Date and time the verification request was last modified.
|
|
67
|
-
* @type {string}
|
|
68
|
-
* @memberof TfvStatus
|
|
69
47
|
*/
|
|
70
48
|
'modifiedDateTime'?: string;
|
|
71
|
-
/**
|
|
72
|
-
*
|
|
73
|
-
* @type {TfvSubmissionInfo}
|
|
74
|
-
* @memberof TfvStatus
|
|
75
|
-
*/
|
|
76
49
|
'submission'?: TfvSubmissionInfo;
|
|
77
50
|
/**
|
|
78
51
|
* Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked.
|
|
79
|
-
* @type {boolean}
|
|
80
|
-
* @memberof TfvStatus
|
|
81
52
|
*/
|
|
82
53
|
'blocked'?: boolean;
|
|
83
54
|
/**
|
|
84
55
|
* The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked.
|
|
85
|
-
* @type {string}
|
|
86
|
-
* @memberof TfvStatus
|
|
87
56
|
*/
|
|
88
57
|
'blockedReason'?: string;
|
|
89
58
|
}
|
|
@@ -29,101 +29,51 @@ import type { Contact } from './contact';
|
|
|
29
29
|
// @ts-ignore
|
|
30
30
|
import type { OptInWorkflow } from './opt-in-workflow';
|
|
31
31
|
|
|
32
|
-
/**
|
|
33
|
-
*
|
|
34
|
-
* @export
|
|
35
|
-
* @interface TfvSubmissionInfo
|
|
36
|
-
*/
|
|
37
32
|
export interface TfvSubmissionInfo {
|
|
38
|
-
/**
|
|
39
|
-
*
|
|
40
|
-
* @type {Address}
|
|
41
|
-
* @memberof TfvSubmissionInfo
|
|
42
|
-
*/
|
|
43
33
|
'businessAddress'?: Address;
|
|
44
|
-
/**
|
|
45
|
-
*
|
|
46
|
-
* @type {Contact}
|
|
47
|
-
* @memberof TfvSubmissionInfo
|
|
48
|
-
*/
|
|
49
34
|
'businessContact'?: Contact;
|
|
50
35
|
/**
|
|
51
36
|
* Estimated monthly volume of messages from the toll-free number.
|
|
52
|
-
* @type {number}
|
|
53
|
-
* @memberof TfvSubmissionInfo
|
|
54
37
|
*/
|
|
55
38
|
'messageVolume'?: number;
|
|
56
39
|
/**
|
|
57
40
|
* The category of the use case.
|
|
58
|
-
* @type {string}
|
|
59
|
-
* @memberof TfvSubmissionInfo
|
|
60
41
|
*/
|
|
61
42
|
'useCase'?: string;
|
|
62
43
|
/**
|
|
63
44
|
* A general idea of the use case and customer.
|
|
64
|
-
* @type {string}
|
|
65
|
-
* @memberof TfvSubmissionInfo
|
|
66
45
|
*/
|
|
67
46
|
'useCaseSummary'?: string;
|
|
68
47
|
/**
|
|
69
48
|
* Example of message content.
|
|
70
|
-
* @type {string}
|
|
71
|
-
* @memberof TfvSubmissionInfo
|
|
72
49
|
*/
|
|
73
50
|
'productionMessageContent'?: string;
|
|
74
|
-
/**
|
|
75
|
-
*
|
|
76
|
-
* @type {OptInWorkflow}
|
|
77
|
-
* @memberof TfvSubmissionInfo
|
|
78
|
-
*/
|
|
79
51
|
'optInWorkflow'?: OptInWorkflow;
|
|
80
52
|
/**
|
|
81
53
|
* Any additional information.
|
|
82
|
-
* @type {string}
|
|
83
|
-
* @memberof TfvSubmissionInfo
|
|
84
54
|
*/
|
|
85
55
|
'additionalInformation'?: string | null;
|
|
86
56
|
/**
|
|
87
57
|
* ISV name.
|
|
88
|
-
* @type {string}
|
|
89
|
-
* @memberof TfvSubmissionInfo
|
|
90
58
|
*/
|
|
91
59
|
'isvReseller'?: string | null;
|
|
92
60
|
/**
|
|
93
61
|
* The Toll-Free Verification request privacy policy URL.
|
|
94
|
-
* @type {string}
|
|
95
|
-
* @memberof TfvSubmissionInfo
|
|
96
62
|
*/
|
|
97
63
|
'privacyPolicyUrl'?: string;
|
|
98
64
|
/**
|
|
99
65
|
* The Toll-Free Verification request terms and conditions policy URL.
|
|
100
|
-
* @type {string}
|
|
101
|
-
* @memberof TfvSubmissionInfo
|
|
102
66
|
*/
|
|
103
67
|
'termsAndConditionsUrl'?: string;
|
|
104
68
|
/**
|
|
105
69
|
* The company \'Doing Business As\'.
|
|
106
|
-
* @type {string}
|
|
107
|
-
* @memberof TfvSubmissionInfo
|
|
108
70
|
*/
|
|
109
71
|
'businessDba'?: string;
|
|
110
72
|
/**
|
|
111
73
|
* US Federal Tax ID Number (EIN) or Canada Business Number (CBN). Optional until early 2026. If a value is provided for this field, a value must be provided for `businessRegistrationType` and `businessEntityType`. Available starting October 1st, 2025.
|
|
112
|
-
* @type {string}
|
|
113
|
-
* @memberof TfvSubmissionInfo
|
|
114
74
|
*/
|
|
115
75
|
'businessRegistrationNumber'?: string | null;
|
|
116
|
-
/**
|
|
117
|
-
*
|
|
118
|
-
* @type {BusinessRegistrationTypeEnum}
|
|
119
|
-
* @memberof TfvSubmissionInfo
|
|
120
|
-
*/
|
|
121
76
|
'businessRegistrationType'?: BusinessRegistrationTypeEnum | null;
|
|
122
|
-
/**
|
|
123
|
-
*
|
|
124
|
-
* @type {BusinessEntityTypeEnum}
|
|
125
|
-
* @memberof TfvSubmissionInfo
|
|
126
|
-
*/
|
|
127
77
|
'businessEntityType'?: BusinessEntityTypeEnum | null;
|
|
128
78
|
}
|
|
129
79
|
|
|
@@ -17,17 +17,7 @@
|
|
|
17
17
|
// @ts-ignore
|
|
18
18
|
import type { VerificationUpdateRequest } from './verification-update-request';
|
|
19
19
|
|
|
20
|
-
/**
|
|
21
|
-
*
|
|
22
|
-
* @export
|
|
23
|
-
* @interface TfvSubmissionWrapper
|
|
24
|
-
*/
|
|
25
20
|
export interface TfvSubmissionWrapper {
|
|
26
|
-
/**
|
|
27
|
-
*
|
|
28
|
-
* @type {VerificationUpdateRequest}
|
|
29
|
-
* @memberof TfvSubmissionWrapper
|
|
30
|
-
*/
|
|
31
21
|
'submission'?: VerificationUpdateRequest;
|
|
32
22
|
}
|
|
33
23
|
|