bandwidth-sdk 6.2.1 → 7.0.1
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 +56 -16
- package/.openapi-generator/VERSION +1 -1
- package/README.md +253 -6
- package/api/calls-api.ts +0 -11
- package/api/conferences-api.ts +0 -15
- package/api/media-api.ts +0 -10
- package/api/messages-api.ts +0 -8
- package/api/mfaapi.ts +0 -9
- package/api/multi-channel-api.ts +0 -7
- package/api/phone-number-lookup-api.ts +145 -76
- package/api/recordings-api.ts +0 -16
- package/api/statistics-api.ts +0 -7
- package/api/toll-free-verification-api.ts +0 -15
- package/api/transcriptions-api.ts +0 -9
- package/bandwidth.yml +629 -299
- package/base.ts +10 -28
- package/common.ts +5 -42
- package/configuration.ts +26 -20
- package/coverage/clover.xml +1344 -1283
- package/coverage/coverage-final.json +49 -45
- package/coverage/lcov-report/index.html +26 -26
- 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 +28 -28
- 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 +65 -86
- package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +338 -131
- package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +2 -50
- package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +2 -23
- package/coverage/lcov-report/node-sdk/api/toll-free-verification-api.ts.html +2 -47
- package/coverage/lcov-report/node-sdk/api/transcriptions-api.ts.html +2 -29
- package/coverage/lcov-report/node-sdk/api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/base.ts.html +19 -73
- package/coverage/lcov-report/node-sdk/common.ts.html +13 -124
- package/coverage/lcov-report/node-sdk/configuration.ts.html +54 -36
- 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 +72 -12
- 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 +2959 -2835
- package/custom_templates/README.mustache +56 -6
- package/custom_templates/common.mustache +29 -44
- package/custom_templates/configuration.mustache +26 -19
- package/custom_templates/package.mustache +1 -1
- package/dist/api/calls-api.d.ts +0 -11
- package/dist/api/calls-api.js +0 -11
- package/dist/api/conferences-api.d.ts +0 -15
- package/dist/api/conferences-api.js +0 -15
- package/dist/api/media-api.d.ts +0 -10
- package/dist/api/media-api.js +0 -10
- package/dist/api/messages-api.d.ts +0 -8
- package/dist/api/messages-api.js +0 -8
- package/dist/api/mfaapi.d.ts +0 -9
- package/dist/api/mfaapi.js +0 -9
- package/dist/api/multi-channel-api.d.ts +0 -7
- package/dist/api/multi-channel-api.js +0 -7
- package/dist/api/phone-number-lookup-api.d.ts +81 -59
- package/dist/api/phone-number-lookup-api.js +149 -73
- package/dist/api/recordings-api.d.ts +0 -16
- package/dist/api/recordings-api.js +0 -16
- package/dist/api/statistics-api.d.ts +0 -7
- package/dist/api/statistics-api.js +0 -7
- package/dist/api/toll-free-verification-api.d.ts +0 -15
- package/dist/api/toll-free-verification-api.js +0 -15
- package/dist/api/transcriptions-api.d.ts +0 -9
- package/dist/api/transcriptions-api.js +0 -9
- package/dist/base.d.ts +0 -24
- package/dist/base.js +10 -23
- package/dist/common.d.ts +0 -37
- package/dist/common.js +0 -37
- package/dist/configuration.d.ts +24 -17
- package/dist/configuration.js +2 -2
- package/dist/models/account-statistics.d.ts +0 -9
- package/dist/models/additional-denial-reason.d.ts +0 -11
- package/dist/models/address.d.ts +0 -19
- package/dist/models/answer-callback.d.ts +0 -36
- package/dist/models/async-lookup-request.d.ts +17 -0
- package/dist/models/blocked-webhook.d.ts +0 -20
- package/dist/models/bridge-complete-callback.d.ts +0 -37
- package/dist/models/bridge-target-complete-callback.d.ts +0 -31
- package/dist/models/business-entity-type-enum.d.ts +0 -2
- package/dist/models/business-entity-type-enum.js +0 -2
- package/dist/models/business-registration-type-enum.d.ts +0 -2
- package/dist/models/business-registration-type-enum.js +0 -2
- package/dist/models/call-direction-enum.d.ts +0 -2
- package/dist/models/call-direction-enum.js +0 -2
- package/dist/models/call-recording-metadata.d.ts +0 -52
- package/dist/models/call-state-enum.d.ts +0 -2
- package/dist/models/call-state-enum.js +0 -2
- package/dist/models/call-state.d.ts +0 -44
- package/dist/models/call-transcription-detected-language-enum.d.ts +0 -2
- package/dist/models/call-transcription-detected-language-enum.js +0 -2
- package/dist/models/call-transcription-metadata.d.ts +0 -11
- package/dist/models/call-transcription-response.d.ts +0 -16
- package/dist/models/call-transcription-track-enum.d.ts +0 -2
- package/dist/models/call-transcription-track-enum.js +0 -2
- package/dist/models/call-transcription.d.ts +0 -19
- package/dist/models/callback-method-enum.d.ts +0 -2
- package/dist/models/callback-method-enum.js +0 -2
- package/dist/models/callback.d.ts +0 -1
- package/dist/models/card-width-enum.d.ts +0 -5
- package/dist/models/card-width-enum.js +0 -5
- package/dist/models/code-request.d.ts +0 -17
- package/dist/models/completed-lookup-status-enum.d.ts +17 -0
- package/dist/models/completed-lookup-status-enum.js +21 -0
- package/dist/models/conference-completed-callback.d.ts +0 -12
- package/dist/models/conference-created-callback.d.ts +0 -12
- package/dist/models/conference-member-exit-callback.d.ts +0 -18
- package/dist/models/conference-member-join-callback.d.ts +0 -18
- package/dist/models/conference-member.d.ts +0 -17
- package/dist/models/conference-recording-available-callback.d.ts +0 -33
- package/dist/models/conference-recording-metadata.d.ts +0 -32
- package/dist/models/conference-redirect-callback.d.ts +0 -12
- package/dist/models/conference-state-enum.d.ts +0 -2
- package/dist/models/conference-state-enum.js +0 -2
- package/dist/models/conference.d.ts +0 -24
- package/dist/models/contact.d.ts +0 -16
- package/dist/models/create-async-bulk-lookup-response-data.d.ts +22 -0
- package/dist/models/create-async-bulk-lookup-response.d.ts +22 -0
- package/dist/models/create-call-response.d.ts +0 -56
- package/dist/models/create-call.d.ts +0 -59
- package/dist/models/create-message-request-error.d.ts +0 -20
- package/dist/models/create-multi-channel-message-response.d.ts +0 -20
- package/dist/models/create-sync-lookup-response-data.d.ts +27 -0
- package/dist/models/create-sync-lookup-response.d.ts +19 -0
- package/dist/models/{multi-channel-message-response-data-channel-list-inner.d.ts → deactivation-event-enum.d.ts} +5 -4
- 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.d.ts +19 -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 +28 -8
- package/dist/models/index.js +28 -8
- 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/link-schema.d.ts +25 -0
- 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 +48 -22
- package/dist/models/{lookup-request.d.ts → multi-channel-channel-list-mmsobject.d.ts} +3 -11
- package/dist/models/multi-channel-channel-list-mmsobject.js +15 -0
- package/dist/models/multi-channel-channel-list-mmsresponse-object.d.ts +17 -0
- package/dist/models/multi-channel-channel-list-mmsresponse-object.js +15 -0
- package/dist/models/multi-channel-channel-list-object-base.d.ts +23 -0
- package/dist/models/multi-channel-channel-list-object-base.js +15 -0
- package/dist/models/multi-channel-channel-list-owner-object.d.ts +17 -0
- package/dist/models/multi-channel-channel-list-owner-object.js +15 -0
- package/dist/models/{multi-channel-channel-list-object-content.d.ts → multi-channel-channel-list-rbmobject-all-of-content.d.ts} +2 -5
- package/dist/models/multi-channel-channel-list-rbmobject-all-of-content.js +15 -0
- package/dist/models/multi-channel-channel-list-rbmobject.d.ts +16 -0
- package/dist/models/multi-channel-channel-list-rbmobject.js +15 -0
- package/dist/models/multi-channel-channel-list-rbmresponse-object.d.ts +17 -0
- package/dist/models/multi-channel-channel-list-rbmresponse-object.js +15 -0
- package/dist/models/multi-channel-channel-list-request-object.d.ts +25 -0
- package/dist/models/multi-channel-channel-list-request-object.js +15 -0
- package/dist/models/{multi-channel-channel-list-object.d.ts → multi-channel-channel-list-response-object.d.ts} +5 -20
- package/dist/models/multi-channel-channel-list-response-object.js +15 -0
- package/dist/models/multi-channel-channel-list-smsobject.d.ts +16 -0
- package/dist/models/multi-channel-channel-list-smsobject.js +15 -0
- package/dist/models/multi-channel-channel-list-smsresponse-object.d.ts +17 -0
- package/dist/models/multi-channel-channel-list-smsresponse-object.js +15 -0
- 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 +2 -17
- package/dist/models/multi-channel-message-response-data.d.ts +2 -26
- package/dist/models/opt-in-workflow.d.ts +0 -20
- package/dist/models/page-info.d.ts +0 -13
- package/dist/models/priority-enum.d.ts +0 -2
- package/dist/models/priority-enum.js +0 -2
- package/dist/models/product-type-enum.d.ts +0 -2
- package/dist/models/product-type-enum.js +0 -2
- package/dist/models/rbm-action-base.d.ts +0 -14
- package/dist/models/rbm-action-dial.d.ts +0 -1
- package/dist/models/rbm-action-open-url.d.ts +0 -1
- package/dist/models/rbm-action-type-enum.d.ts +0 -5
- package/dist/models/rbm-action-type-enum.js +0 -5
- package/dist/models/rbm-action-view-location.d.ts +0 -1
- package/dist/models/rbm-card-content-media.d.ts +0 -1
- package/dist/models/rbm-card-content.d.ts +0 -16
- package/dist/models/rbm-location-response.d.ts +0 -9
- package/dist/models/rbm-media-height-enum.d.ts +0 -2
- package/dist/models/rbm-media-height-enum.js +0 -2
- package/dist/models/rbm-message-carousel-card.d.ts +0 -17
- package/dist/models/rbm-message-content-file.d.ts +0 -9
- package/dist/models/rbm-message-content-rich-card.d.ts +0 -1
- package/dist/models/rbm-message-content-text.d.ts +0 -9
- package/dist/models/rbm-message-media.d.ts +0 -12
- package/dist/models/rbm-standalone-card.d.ts +0 -22
- package/dist/models/rbm-suggestion-response.d.ts +0 -9
- package/dist/models/recording-available-callback.d.ts +0 -52
- package/dist/models/recording-complete-callback.d.ts +0 -52
- package/dist/models/recording-state-enum.d.ts +0 -2
- package/dist/models/recording-state-enum.js +0 -2
- package/dist/models/recording-transcription-metadata.d.ts +0 -10
- package/dist/models/recording-transcriptions.d.ts +0 -10
- package/dist/models/redirect-callback.d.ts +0 -37
- package/dist/models/redirect-method-enum.d.ts +0 -2
- package/dist/models/redirect-method-enum.js +0 -2
- package/dist/models/sms-message-content.d.ts +0 -7
- package/dist/models/standalone-card-orientation-enum.d.ts +0 -5
- package/dist/models/standalone-card-orientation-enum.js +0 -5
- package/dist/models/status-callback-message.d.ts +0 -43
- package/dist/models/status-callback-type-enum.d.ts +0 -2
- package/dist/models/status-callback-type-enum.js +0 -2
- package/dist/models/status-callback.d.ts +0 -27
- package/dist/models/stir-shaken.d.ts +0 -11
- package/dist/models/sync-lookup-request.d.ts +17 -0
- package/dist/models/sync-lookup-request.js +15 -0
- package/dist/models/telephone-number.d.ts +0 -7
- package/dist/models/tfv-basic-authentication.d.ts +0 -15
- package/dist/models/tfv-callback-status-enum.d.ts +0 -5
- package/dist/models/tfv-callback-status-enum.js +0 -5
- package/dist/models/tfv-error.d.ts +0 -14
- package/dist/models/tfv-status-enum.d.ts +0 -5
- package/dist/models/tfv-status-enum.js +0 -5
- package/dist/models/tfv-status.d.ts +0 -31
- package/dist/models/tfv-submission-info.d.ts +0 -50
- package/dist/models/tfv-submission-wrapper.d.ts +0 -10
- package/dist/models/thumbnail-alignment-enum.d.ts +0 -2
- package/dist/models/thumbnail-alignment-enum.js +0 -2
- package/dist/models/transcribe-recording.d.ts +0 -22
- package/dist/models/transcription-available-callback.d.ts +0 -53
- package/dist/models/transcription.d.ts +0 -9
- package/dist/models/transfer-answer-callback.d.ts +0 -35
- package/dist/models/transfer-complete-callback.d.ts +0 -41
- package/dist/models/transfer-disconnect-callback.d.ts +0 -45
- package/dist/models/update-call-recording.d.ts +0 -10
- package/dist/models/update-call.d.ts +0 -34
- package/dist/models/update-conference-member.d.ts +0 -11
- package/dist/models/update-conference.d.ts +0 -32
- package/dist/models/verification-denial-webhook.d.ts +0 -28
- package/dist/models/verification-request.d.ts +0 -59
- package/dist/models/verification-update-request.d.ts +0 -54
- package/dist/models/verification-webhook.d.ts +0 -16
- package/dist/models/verify-code-request.d.ts +0 -13
- package/dist/models/verify-code-response.d.ts +0 -7
- package/dist/models/voice-api-error.d.ts +0 -20
- package/dist/models/voice-code-response.d.ts +0 -7
- package/dist/models/webhook-subscription-basic-authentication.d.ts +0 -12
- package/dist/models/webhook-subscription-request-schema.d.ts +0 -14
- package/dist/models/webhook-subscription-type-enum.d.ts +0 -5
- package/dist/models/webhook-subscription-type-enum.js +0 -5
- package/dist/models/webhook-subscription.d.ts +0 -34
- package/dist/models/webhook-subscriptions-list-body.d.ts +0 -17
- package/docs/{TnLookupRequestError.md → AsyncLookupRequest.md} +5 -5
- package/docs/CompletedLookupStatusEnum.md +12 -0
- package/docs/CreateAsyncBulkLookupResponse.md +24 -0
- package/docs/{CreateLookupResponse.md → CreateAsyncBulkLookupResponseData.md} +5 -5
- package/docs/CreateSyncLookupResponse.md +24 -0
- package/docs/CreateSyncLookupResponseData.md +25 -0
- package/docs/DeactivationEventEnum.md +9 -0
- package/docs/GetAsyncBulkLookupResponse.md +24 -0
- package/docs/GetAsyncBulkLookupResponseData.md +25 -0
- package/docs/{LookupStatusEnum.md → InProgressLookupStatusEnum.md} +1 -2
- package/docs/LatestMessageDeliveryStatusEnum.md +13 -0
- package/docs/LineTypeEnum.md +14 -0
- package/docs/LinkSchema.md +24 -0
- package/docs/LookupErrorResponse.md +24 -0
- package/docs/LookupErrorSchema.md +26 -0
- package/docs/LookupErrorSchemaMeta.md +24 -0
- package/docs/LookupResult.md +22 -18
- package/docs/{MultiChannelChannelListObject.md → MultiChannelChannelListMMSObject.md} +4 -4
- package/docs/{MultiChannelMessageResponseDataChannelListInner.md → MultiChannelChannelListMMSResponseObject.md} +4 -4
- package/docs/MultiChannelChannelListObjectBase.md +24 -0
- package/docs/MultiChannelChannelListOwnerObject.md +20 -0
- package/docs/MultiChannelChannelListRBMObject.md +26 -0
- package/docs/{MultiChannelChannelListObjectContent.md → MultiChannelChannelListRBMObjectAllOfContent.md} +5 -5
- package/docs/MultiChannelChannelListRBMResponseObject.md +28 -0
- package/docs/MultiChannelChannelListRequestObject.md +26 -0
- package/docs/MultiChannelChannelListResponseObject.md +28 -0
- package/docs/MultiChannelChannelListSMSObject.md +26 -0
- package/docs/MultiChannelChannelListSMSResponseObject.md +28 -0
- package/docs/MultiChannelMessageRequest.md +1 -1
- package/docs/MultiChannelMessageResponseData.md +1 -1
- package/docs/PhoneNumberLookupApi.md +81 -34
- package/docs/{LookupRequest.md → SyncLookupRequest.md} +5 -6
- package/models/account-statistics.ts +0 -9
- package/models/additional-denial-reason.ts +0 -11
- package/models/address.ts +0 -19
- package/models/answer-callback.ts +0 -36
- package/models/async-lookup-request.ts +23 -0
- package/models/blocked-webhook.ts +0 -20
- package/models/bridge-complete-callback.ts +0 -37
- package/models/bridge-target-complete-callback.ts +0 -31
- package/models/business-entity-type-enum.ts +0 -2
- package/models/business-registration-type-enum.ts +0 -2
- package/models/call-direction-enum.ts +0 -2
- package/models/call-recording-metadata.ts +0 -52
- package/models/call-state-enum.ts +0 -2
- package/models/call-state.ts +0 -44
- package/models/call-transcription-detected-language-enum.ts +0 -2
- package/models/call-transcription-metadata.ts +0 -11
- package/models/call-transcription-response.ts +0 -16
- package/models/call-transcription-track-enum.ts +0 -2
- package/models/call-transcription.ts +0 -19
- package/models/callback-method-enum.ts +0 -2
- package/models/callback.ts +0 -1
- package/models/card-width-enum.ts +0 -5
- package/models/code-request.ts +0 -17
- package/models/completed-lookup-status-enum.ts +27 -0
- package/models/conference-completed-callback.ts +0 -12
- package/models/conference-created-callback.ts +0 -12
- package/models/conference-member-exit-callback.ts +0 -18
- package/models/conference-member-join-callback.ts +0 -18
- package/models/conference-member.ts +0 -17
- package/models/conference-recording-available-callback.ts +0 -33
- package/models/conference-recording-metadata.ts +0 -32
- package/models/conference-redirect-callback.ts +0 -12
- package/models/conference-state-enum.ts +0 -2
- package/models/conference.ts +0 -24
- package/models/contact.ts +0 -16
- package/models/create-async-bulk-lookup-response-data.ts +32 -0
- package/models/create-async-bulk-lookup-response.ts +34 -0
- package/models/create-call-response.ts +0 -56
- package/models/create-call.ts +0 -59
- package/models/create-message-request-error.ts +0 -20
- package/models/create-multi-channel-message-response.ts +0 -20
- package/models/{create-lookup-response.ts → create-sync-lookup-response-data.ts} +9 -11
- package/models/create-sync-lookup-response.ts +31 -0
- package/models/deactivation-event-enum.ts +28 -0
- package/models/disconnect-callback.ts +0 -39
- package/models/diversion.ts +0 -19
- package/models/dtmf-callback.ts +0 -39
- package/models/error-object.ts +0 -14
- package/models/error-source.ts +0 -10
- package/models/failure-webhook.ts +0 -17
- package/models/field-error.ts +0 -9
- package/models/file-format-enum.ts +0 -2
- package/models/gather-callback.ts +0 -41
- package/models/get-async-bulk-lookup-response-data.ts +39 -0
- package/models/get-async-bulk-lookup-response.ts +31 -0
- package/models/{lookup-status-enum.ts → in-progress-lookup-status-enum.ts} +2 -7
- package/models/inbound-callback-message.ts +0 -1
- package/models/inbound-callback-type-enum.ts +0 -2
- package/models/inbound-callback.ts +0 -23
- package/models/index.ts +28 -8
- 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 +48 -5
- package/models/{multi-channel-message-response-data-channel-list-inner.ts → multi-channel-channel-list-mmsobject.ts} +4 -5
- package/models/multi-channel-channel-list-mmsresponse-object.ts +34 -0
- package/models/multi-channel-channel-list-object-base.ts +33 -0
- package/models/multi-channel-channel-list-owner-object.ts +23 -0
- package/models/{multi-channel-channel-list-object-content.ts → multi-channel-channel-list-rbmobject-all-of-content.ts} +5 -12
- package/models/multi-channel-channel-list-rbmobject.ts +31 -0
- package/models/multi-channel-channel-list-rbmresponse-object.ts +34 -0
- package/models/{multi-channel-channel-list-object.ts → multi-channel-channel-list-request-object.ts} +12 -22
- package/models/multi-channel-channel-list-response-object.ts +50 -0
- package/models/multi-channel-channel-list-smsobject.ts +31 -0
- package/models/multi-channel-channel-list-smsresponse-object.ts +34 -0
- 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 +2 -17
- package/models/multi-channel-message-response-data.ts +2 -26
- package/models/opt-in-workflow.ts +0 -20
- package/models/page-info.ts +0 -13
- package/models/priority-enum.ts +0 -2
- package/models/product-type-enum.ts +0 -2
- package/models/rbm-action-base.ts +0 -14
- package/models/rbm-action-dial.ts +0 -1
- package/models/rbm-action-open-url.ts +0 -1
- package/models/rbm-action-type-enum.ts +0 -5
- package/models/rbm-action-view-location.ts +0 -1
- package/models/rbm-card-content-media.ts +0 -1
- package/models/rbm-card-content.ts +0 -16
- package/models/rbm-location-response.ts +0 -9
- package/models/rbm-media-height-enum.ts +0 -2
- package/models/rbm-message-carousel-card.ts +0 -17
- package/models/rbm-message-content-file.ts +0 -9
- package/models/rbm-message-content-rich-card.ts +0 -1
- package/models/rbm-message-content-text.ts +0 -9
- package/models/rbm-message-media.ts +0 -12
- package/models/rbm-standalone-card.ts +0 -22
- package/models/rbm-suggestion-response.ts +0 -9
- package/models/recording-available-callback.ts +0 -52
- package/models/recording-complete-callback.ts +0 -52
- package/models/recording-state-enum.ts +0 -2
- package/models/recording-transcription-metadata.ts +0 -10
- package/models/recording-transcriptions.ts +0 -10
- package/models/redirect-callback.ts +0 -37
- package/models/redirect-method-enum.ts +0 -2
- package/models/sms-message-content.ts +0 -7
- package/models/standalone-card-orientation-enum.ts +0 -5
- package/models/status-callback-message.ts +0 -43
- package/models/status-callback-type-enum.ts +0 -2
- package/models/status-callback.ts +0 -27
- package/models/stir-shaken.ts +0 -11
- package/models/sync-lookup-request.ts +23 -0
- package/models/telephone-number.ts +0 -7
- package/models/tfv-basic-authentication.ts +0 -15
- package/models/tfv-callback-status-enum.ts +0 -5
- package/models/tfv-error.ts +0 -14
- package/models/tfv-status-enum.ts +0 -5
- package/models/tfv-status.ts +0 -31
- package/models/tfv-submission-info.ts +0 -50
- package/models/tfv-submission-wrapper.ts +0 -10
- package/models/thumbnail-alignment-enum.ts +0 -2
- package/models/transcribe-recording.ts +0 -22
- package/models/transcription-available-callback.ts +0 -53
- package/models/transcription.ts +0 -9
- package/models/transfer-answer-callback.ts +0 -35
- package/models/transfer-complete-callback.ts +0 -41
- package/models/transfer-disconnect-callback.ts +0 -45
- package/models/update-call-recording.ts +0 -10
- package/models/update-call.ts +0 -34
- package/models/update-conference-member.ts +0 -11
- package/models/update-conference.ts +0 -32
- package/models/verification-denial-webhook.ts +0 -28
- package/models/verification-request.ts +0 -59
- package/models/verification-update-request.ts +0 -54
- package/models/verification-webhook.ts +0 -16
- package/models/verify-code-request.ts +0 -13
- package/models/verify-code-response.ts +0 -7
- package/models/voice-api-error.ts +0 -20
- package/models/voice-code-response.ts +0 -7
- package/models/webhook-subscription-basic-authentication.ts +0 -12
- package/models/webhook-subscription-request-schema.ts +0 -14
- package/models/webhook-subscription-type-enum.ts +0 -5
- package/models/webhook-subscription.ts +0 -34
- package/models/webhook-subscriptions-list-body.ts +0 -17
- package/openapitools.json +1 -1
- package/package.json +2 -2
- package/tests/smoke/multi-channel-api.test.ts +117 -10
- package/tests/smoke/phone-number-lookup-api.test.ts +64 -61
- package/tests/unit/api/multi-channel-api.test.ts +27 -10
- 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/{multi-channel-channel-list-object-content.js → create-sync-lookup-response-data.js} +0 -0
- /package/dist/models/{multi-channel-channel-list-object.js → create-sync-lookup-response.js} +0 -0
- /package/dist/models/{multi-channel-message-response-data-channel-list-inner.js → get-async-bulk-lookup-response-data.js} +0 -0
- /package/dist/models/{tn-lookup-request-error.js → get-async-bulk-lookup-response.js} +0 -0
|
@@ -16,8 +16,6 @@
|
|
|
16
16
|
|
|
17
17
|
/**
|
|
18
18
|
* The type of business registration number. Optional until early 2026; required if `businessRegistrationNumber` is provided. Available starting October 1st, 2025.
|
|
19
|
-
* @export
|
|
20
|
-
* @enum {string}
|
|
21
19
|
*/
|
|
22
20
|
|
|
23
21
|
export const BusinessRegistrationTypeEnum = {
|
|
@@ -23,124 +23,72 @@ import type { FileFormatEnum } from './file-format-enum';
|
|
|
23
23
|
// @ts-ignore
|
|
24
24
|
import type { RecordingTranscriptionMetadata } from './recording-transcription-metadata';
|
|
25
25
|
|
|
26
|
-
/**
|
|
27
|
-
*
|
|
28
|
-
* @export
|
|
29
|
-
* @interface CallRecordingMetadata
|
|
30
|
-
*/
|
|
31
26
|
export interface CallRecordingMetadata {
|
|
32
27
|
/**
|
|
33
28
|
* The id of the application associated with the call.
|
|
34
|
-
* @type {string}
|
|
35
|
-
* @memberof CallRecordingMetadata
|
|
36
29
|
*/
|
|
37
30
|
'applicationId'?: string;
|
|
38
31
|
/**
|
|
39
32
|
* The user account associated with the call.
|
|
40
|
-
* @type {string}
|
|
41
|
-
* @memberof CallRecordingMetadata
|
|
42
33
|
*/
|
|
43
34
|
'accountId'?: string;
|
|
44
35
|
/**
|
|
45
36
|
* The call id associated with the event.
|
|
46
|
-
* @type {string}
|
|
47
|
-
* @memberof CallRecordingMetadata
|
|
48
37
|
*/
|
|
49
38
|
'callId'?: string;
|
|
50
39
|
/**
|
|
51
40
|
* (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.
|
|
52
|
-
* @type {string}
|
|
53
|
-
* @memberof CallRecordingMetadata
|
|
54
41
|
*/
|
|
55
42
|
'parentCallId'?: string;
|
|
56
43
|
/**
|
|
57
44
|
* The unique ID of this recording
|
|
58
|
-
* @type {string}
|
|
59
|
-
* @memberof CallRecordingMetadata
|
|
60
45
|
*/
|
|
61
46
|
'recordingId'?: string;
|
|
62
47
|
/**
|
|
63
48
|
* The phone number that received the call, in E.164 format (e.g. +15555555555).
|
|
64
|
-
* @type {string}
|
|
65
|
-
* @memberof CallRecordingMetadata
|
|
66
49
|
*/
|
|
67
50
|
'to'?: string;
|
|
68
51
|
/**
|
|
69
52
|
* The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555).
|
|
70
|
-
* @type {string}
|
|
71
|
-
* @memberof CallRecordingMetadata
|
|
72
53
|
*/
|
|
73
54
|
'from'?: string;
|
|
74
55
|
/**
|
|
75
56
|
* The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555).
|
|
76
|
-
* @type {string}
|
|
77
|
-
* @memberof CallRecordingMetadata
|
|
78
57
|
*/
|
|
79
58
|
'transferCallerId'?: string;
|
|
80
59
|
/**
|
|
81
60
|
* The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555).
|
|
82
|
-
* @type {string}
|
|
83
|
-
* @memberof CallRecordingMetadata
|
|
84
61
|
*/
|
|
85
62
|
'transferTo'?: string;
|
|
86
63
|
/**
|
|
87
64
|
* The duration of the recording in ISO-8601 format
|
|
88
|
-
* @type {string}
|
|
89
|
-
* @memberof CallRecordingMetadata
|
|
90
65
|
*/
|
|
91
66
|
'duration'?: string;
|
|
92
|
-
/**
|
|
93
|
-
*
|
|
94
|
-
* @type {CallDirectionEnum}
|
|
95
|
-
* @memberof CallRecordingMetadata
|
|
96
|
-
*/
|
|
97
67
|
'direction'?: CallDirectionEnum;
|
|
98
68
|
/**
|
|
99
69
|
* Always `1` for conference recordings; multi-channel recordings are not supported on conferences.
|
|
100
|
-
* @type {number}
|
|
101
|
-
* @memberof CallRecordingMetadata
|
|
102
70
|
*/
|
|
103
71
|
'channels'?: number;
|
|
104
72
|
/**
|
|
105
73
|
* Time the call was started, in ISO 8601 format.
|
|
106
|
-
* @type {string}
|
|
107
|
-
* @memberof CallRecordingMetadata
|
|
108
74
|
*/
|
|
109
75
|
'startTime'?: string;
|
|
110
76
|
/**
|
|
111
77
|
* The time that the recording ended in ISO-8601 format
|
|
112
|
-
* @type {string}
|
|
113
|
-
* @memberof CallRecordingMetadata
|
|
114
78
|
*/
|
|
115
79
|
'endTime'?: string;
|
|
116
|
-
/**
|
|
117
|
-
*
|
|
118
|
-
* @type {FileFormatEnum}
|
|
119
|
-
* @memberof CallRecordingMetadata
|
|
120
|
-
*/
|
|
121
80
|
'fileFormat'?: FileFormatEnum;
|
|
122
81
|
/**
|
|
123
82
|
* The current status of the process. For recording, current possible values are \'processing\', \'partial\', \'complete\', \'deleted\', and \'error\'. For transcriptions, current possible values are \'none\', \'processing\', \'available\', \'error\', \'timeout\', \'file-size-too-big\', and \'file-size-too-small\'. Additional states may be added in the future, so your application must be tolerant of unknown values.
|
|
124
|
-
* @type {string}
|
|
125
|
-
* @memberof CallRecordingMetadata
|
|
126
83
|
*/
|
|
127
84
|
'status'?: string;
|
|
128
85
|
/**
|
|
129
86
|
* The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded.
|
|
130
|
-
* @type {string}
|
|
131
|
-
* @memberof CallRecordingMetadata
|
|
132
87
|
*/
|
|
133
88
|
'mediaUrl'?: string | null;
|
|
134
|
-
/**
|
|
135
|
-
*
|
|
136
|
-
* @type {RecordingTranscriptionMetadata}
|
|
137
|
-
* @memberof CallRecordingMetadata
|
|
138
|
-
*/
|
|
139
89
|
'transcription'?: RecordingTranscriptionMetadata | null;
|
|
140
90
|
/**
|
|
141
91
|
* A name to identify this recording.
|
|
142
|
-
* @type {string}
|
|
143
|
-
* @memberof CallRecordingMetadata
|
|
144
92
|
*/
|
|
145
93
|
'recordingName'?: string;
|
|
146
94
|
}
|
|
@@ -16,8 +16,6 @@
|
|
|
16
16
|
|
|
17
17
|
/**
|
|
18
18
|
* The call state. Possible values:<br>`active` to redirect the call (default)<br>`completed` to hang up the call if it is answered, cancel it if it is an unanswered outbound call, or reject it if it an unanswered inbound call
|
|
19
|
-
* @export
|
|
20
|
-
* @enum {string}
|
|
21
19
|
*/
|
|
22
20
|
|
|
23
21
|
export const CallStateEnum = {
|
package/models/call-state.ts
CHANGED
|
@@ -17,118 +17,74 @@
|
|
|
17
17
|
// @ts-ignore
|
|
18
18
|
import type { CallDirectionEnum } from './call-direction-enum';
|
|
19
19
|
|
|
20
|
-
/**
|
|
21
|
-
*
|
|
22
|
-
* @export
|
|
23
|
-
* @interface CallState
|
|
24
|
-
*/
|
|
25
20
|
export interface CallState {
|
|
26
21
|
/**
|
|
27
22
|
* The application id associated with the call.
|
|
28
|
-
* @type {string}
|
|
29
|
-
* @memberof CallState
|
|
30
23
|
*/
|
|
31
24
|
'applicationId'?: string;
|
|
32
25
|
/**
|
|
33
26
|
* The account id associated with the call.
|
|
34
|
-
* @type {string}
|
|
35
|
-
* @memberof CallState
|
|
36
27
|
*/
|
|
37
28
|
'accountId'?: string;
|
|
38
29
|
/**
|
|
39
30
|
* The programmable voice API call ID.
|
|
40
|
-
* @type {string}
|
|
41
|
-
* @memberof CallState
|
|
42
31
|
*/
|
|
43
32
|
'callId'?: string;
|
|
44
33
|
/**
|
|
45
34
|
* The A-leg call id, set only if this call is the B-leg of a [`<Transfer>`](/docs/voice/bxml/transfer).
|
|
46
|
-
* @type {string}
|
|
47
|
-
* @memberof CallState
|
|
48
35
|
*/
|
|
49
36
|
'parentCallId'?: string | null;
|
|
50
37
|
/**
|
|
51
38
|
* The phone number that received the call, in E.164 format (e.g. +15555555555), or if the call was to a SIP URI, the SIP URI.
|
|
52
|
-
* @type {string}
|
|
53
|
-
* @memberof CallState
|
|
54
39
|
*/
|
|
55
40
|
'to'?: string;
|
|
56
41
|
/**
|
|
57
42
|
* The phone number that made the call, in E.164 format (e.g. +15555555555).
|
|
58
|
-
* @type {string}
|
|
59
|
-
* @memberof CallState
|
|
60
43
|
*/
|
|
61
44
|
'from'?: string;
|
|
62
|
-
/**
|
|
63
|
-
*
|
|
64
|
-
* @type {CallDirectionEnum}
|
|
65
|
-
* @memberof CallState
|
|
66
|
-
*/
|
|
67
45
|
'direction'?: CallDirectionEnum;
|
|
68
46
|
/**
|
|
69
47
|
* 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.
|
|
70
|
-
* @type {string}
|
|
71
|
-
* @memberof CallState
|
|
72
48
|
*/
|
|
73
49
|
'state'?: string;
|
|
74
50
|
/**
|
|
75
51
|
* 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).
|
|
76
|
-
* @type {{ [key: string]: string; }}
|
|
77
|
-
* @memberof CallState
|
|
78
52
|
*/
|
|
79
53
|
'stirShaken'?: { [key: string]: string; } | null;
|
|
80
54
|
/**
|
|
81
55
|
* 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.
|
|
82
|
-
* @type {string}
|
|
83
|
-
* @memberof CallState
|
|
84
56
|
*/
|
|
85
57
|
'identity'?: string | null;
|
|
86
58
|
/**
|
|
87
59
|
* The time this call was placed in queue.
|
|
88
|
-
* @type {string}
|
|
89
|
-
* @memberof CallState
|
|
90
60
|
*/
|
|
91
61
|
'enqueuedTime'?: string | null;
|
|
92
62
|
/**
|
|
93
63
|
* The time the call was initiated, in ISO 8601 format. `null` if the call is still in your queue.
|
|
94
|
-
* @type {string}
|
|
95
|
-
* @memberof CallState
|
|
96
64
|
*/
|
|
97
65
|
'startTime'?: string | null;
|
|
98
66
|
/**
|
|
99
67
|
* Populated once the call has been answered, with the time in ISO 8601 format.
|
|
100
|
-
* @type {string}
|
|
101
|
-
* @memberof CallState
|
|
102
68
|
*/
|
|
103
69
|
'answerTime'?: string | null;
|
|
104
70
|
/**
|
|
105
71
|
* Populated once the call has ended, with the time in ISO 8601 format.
|
|
106
|
-
* @type {string}
|
|
107
|
-
* @memberof CallState
|
|
108
72
|
*/
|
|
109
73
|
'endTime'?: string | null;
|
|
110
74
|
/**
|
|
111
75
|
* | Cause | Description | |:------|:------------| | `hangup`| One party hung up the call, a [`<Hangup>`](../../bxml/verbs/hangup.md) verb was executed, or there was no more BXML to execute; it indicates that the call ended normally. | | `busy` | Callee was busy. | | `timeout` | Call wasn\'t answered before the `callTimeout` was reached. | | `cancel` | Call was cancelled by its originator while it was ringing. | | `rejected` | Call was rejected by the callee. | | `callback-error` | BXML callback couldn\'t be delivered to your callback server. | | `invalid-bxml` | Invalid BXML was returned in response to a callback. | | `application-error` | An unsupported action was tried on the call, e.g. trying to play a .ogg audio. | | `account-limit` | Account rate limits were reached. | | `node-capacity-exceeded` | System maximum capacity was reached. | | `error` | Some error not described in any of the other causes happened on the call. | | `unknown` | Unknown error happened on the call. | Note: This list is not exhaustive and other values can appear in the future.
|
|
112
|
-
* @type {string}
|
|
113
|
-
* @memberof CallState
|
|
114
76
|
*/
|
|
115
77
|
'disconnectCause'?: string | null;
|
|
116
78
|
/**
|
|
117
79
|
* Populated only if the call ended with an error, with text explaining the reason.
|
|
118
|
-
* @type {string}
|
|
119
|
-
* @memberof CallState
|
|
120
80
|
*/
|
|
121
81
|
'errorMessage'?: string | null;
|
|
122
82
|
/**
|
|
123
83
|
* Populated only if the call ended with an error, with a Bandwidth internal id that references the error event.
|
|
124
|
-
* @type {string}
|
|
125
|
-
* @memberof CallState
|
|
126
84
|
*/
|
|
127
85
|
'errorId'?: string | null;
|
|
128
86
|
/**
|
|
129
87
|
* The last time the call had a state update, in ISO 8601 format.
|
|
130
|
-
* @type {string}
|
|
131
|
-
* @memberof CallState
|
|
132
88
|
*/
|
|
133
89
|
'lastUpdate'?: string;
|
|
134
90
|
}
|
|
@@ -14,28 +14,17 @@
|
|
|
14
14
|
|
|
15
15
|
|
|
16
16
|
|
|
17
|
-
/**
|
|
18
|
-
*
|
|
19
|
-
* @export
|
|
20
|
-
* @interface CallTranscriptionMetadata
|
|
21
|
-
*/
|
|
22
17
|
export interface CallTranscriptionMetadata {
|
|
23
18
|
/**
|
|
24
19
|
* The programmable voice API transcription ID.
|
|
25
|
-
* @type {string}
|
|
26
|
-
* @memberof CallTranscriptionMetadata
|
|
27
20
|
*/
|
|
28
21
|
'transcriptionId'?: string;
|
|
29
22
|
/**
|
|
30
23
|
* The programmable voice API transcription name. This name could be provided by the user when creating the transcription.
|
|
31
|
-
* @type {string}
|
|
32
|
-
* @memberof CallTranscriptionMetadata
|
|
33
24
|
*/
|
|
34
25
|
'transcriptionName'?: string;
|
|
35
26
|
/**
|
|
36
27
|
* A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice-apis/voice/#tag/Transcriptions/operation/getRealTimeTranscription) endpoint.
|
|
37
|
-
* @type {string}
|
|
38
|
-
* @memberof CallTranscriptionMetadata
|
|
39
28
|
*/
|
|
40
29
|
'transcriptionUrl'?: string;
|
|
41
30
|
}
|
|
@@ -17,35 +17,19 @@
|
|
|
17
17
|
// @ts-ignore
|
|
18
18
|
import type { CallTranscription } from './call-transcription';
|
|
19
19
|
|
|
20
|
-
/**
|
|
21
|
-
*
|
|
22
|
-
* @export
|
|
23
|
-
* @interface CallTranscriptionResponse
|
|
24
|
-
*/
|
|
25
20
|
export interface CallTranscriptionResponse {
|
|
26
21
|
/**
|
|
27
22
|
* The user account associated with the call.
|
|
28
|
-
* @type {string}
|
|
29
|
-
* @memberof CallTranscriptionResponse
|
|
30
23
|
*/
|
|
31
24
|
'accountId'?: string;
|
|
32
25
|
/**
|
|
33
26
|
* The call id associated with the event.
|
|
34
|
-
* @type {string}
|
|
35
|
-
* @memberof CallTranscriptionResponse
|
|
36
27
|
*/
|
|
37
28
|
'callId'?: string;
|
|
38
29
|
/**
|
|
39
30
|
* The programmable voice API transcription ID.
|
|
40
|
-
* @type {string}
|
|
41
|
-
* @memberof CallTranscriptionResponse
|
|
42
31
|
*/
|
|
43
32
|
'transcriptionId'?: string;
|
|
44
|
-
/**
|
|
45
|
-
*
|
|
46
|
-
* @type {Array<CallTranscription>}
|
|
47
|
-
* @memberof CallTranscriptionResponse
|
|
48
|
-
*/
|
|
49
33
|
'tracks'?: Array<CallTranscription>;
|
|
50
34
|
}
|
|
51
35
|
|
|
@@ -20,34 +20,15 @@ import type { CallTranscriptionDetectedLanguageEnum } from './call-transcription
|
|
|
20
20
|
// @ts-ignore
|
|
21
21
|
import type { CallTranscriptionTrackEnum } from './call-transcription-track-enum';
|
|
22
22
|
|
|
23
|
-
/**
|
|
24
|
-
*
|
|
25
|
-
* @export
|
|
26
|
-
* @interface CallTranscription
|
|
27
|
-
*/
|
|
28
23
|
export interface CallTranscription {
|
|
29
|
-
/**
|
|
30
|
-
*
|
|
31
|
-
* @type {CallTranscriptionDetectedLanguageEnum}
|
|
32
|
-
* @memberof CallTranscription
|
|
33
|
-
*/
|
|
34
24
|
'detectedLanguage'?: CallTranscriptionDetectedLanguageEnum;
|
|
35
|
-
/**
|
|
36
|
-
*
|
|
37
|
-
* @type {CallTranscriptionTrackEnum}
|
|
38
|
-
* @memberof CallTranscription
|
|
39
|
-
*/
|
|
40
25
|
'track'?: CallTranscriptionTrackEnum;
|
|
41
26
|
/**
|
|
42
27
|
* The transcription itself.
|
|
43
|
-
* @type {string}
|
|
44
|
-
* @memberof CallTranscription
|
|
45
28
|
*/
|
|
46
29
|
'transcript'?: string;
|
|
47
30
|
/**
|
|
48
31
|
* How confident the transcription engine was in transcribing the associated audio (from `0` to `1`).
|
|
49
|
-
* @type {number}
|
|
50
|
-
* @memberof CallTranscription
|
|
51
32
|
*/
|
|
52
33
|
'confidence'?: number;
|
|
53
34
|
}
|
package/models/callback.ts
CHANGED
|
@@ -29,7 +29,6 @@ import type { StatusCallback } from './status-callback';
|
|
|
29
29
|
/**
|
|
30
30
|
* @type Callback
|
|
31
31
|
* Callbacks are divided into two types based on direction of the related message: - `statusCallback` indicates status of an outbound MT SMS, MMS, or RBM message. - `inboundCallback` indicates an inbound MO message or a multichannel message client\'s response to a suggestion or location request.
|
|
32
|
-
* @export
|
|
33
32
|
*/
|
|
34
33
|
export type Callback = { type: 'message-delivered' } & StatusCallback | { type: 'message-failed' } & StatusCallback | { type: 'message-read' } & StatusCallback | { type: 'message-received' } & InboundCallback | { type: 'message-sent' } & StatusCallback | { type: 'request-location-response' } & InboundCallback | { type: 'suggestion-response' } & InboundCallback;
|
|
35
34
|
|
package/models/code-request.ts
CHANGED
|
@@ -14,46 +14,29 @@
|
|
|
14
14
|
|
|
15
15
|
|
|
16
16
|
|
|
17
|
-
/**
|
|
18
|
-
*
|
|
19
|
-
* @export
|
|
20
|
-
* @interface CodeRequest
|
|
21
|
-
*/
|
|
22
17
|
export interface CodeRequest {
|
|
23
18
|
/**
|
|
24
19
|
* The phone number to send the mfa code to.
|
|
25
|
-
* @type {string}
|
|
26
|
-
* @memberof CodeRequest
|
|
27
20
|
*/
|
|
28
21
|
'to': string;
|
|
29
22
|
/**
|
|
30
23
|
* The application phone number, the sender of the mfa code.
|
|
31
|
-
* @type {string}
|
|
32
|
-
* @memberof CodeRequest
|
|
33
24
|
*/
|
|
34
25
|
'from': string;
|
|
35
26
|
/**
|
|
36
27
|
* The application unique ID, obtained from Bandwidth.
|
|
37
|
-
* @type {string}
|
|
38
|
-
* @memberof CodeRequest
|
|
39
28
|
*/
|
|
40
29
|
'applicationId': string;
|
|
41
30
|
/**
|
|
42
31
|
* An optional field to denote what scope or action the mfa code is addressing. If not supplied, defaults to \"2FA\".
|
|
43
|
-
* @type {string}
|
|
44
|
-
* @memberof CodeRequest
|
|
45
32
|
*/
|
|
46
33
|
'scope'?: string;
|
|
47
34
|
/**
|
|
48
35
|
* The message format of the mfa code. There are three values that the system will replace \"{CODE}\", \"{NAME}\", \"{SCOPE}\". The \"{SCOPE}\" and \"{NAME} value template are optional, while \"{CODE}\" must be supplied. As the name would suggest, code will be replace with the actual mfa code. Name is replaced with the application name, configured during provisioning of mfa. The scope value is the same value sent during the call and partitioned by the server.
|
|
49
|
-
* @type {string}
|
|
50
|
-
* @memberof CodeRequest
|
|
51
36
|
*/
|
|
52
37
|
'message': string;
|
|
53
38
|
/**
|
|
54
39
|
* The number of digits for your mfa code. The valid number ranges from 2 to 8, inclusively.
|
|
55
|
-
* @type {number}
|
|
56
|
-
* @memberof CodeRequest
|
|
57
40
|
*/
|
|
58
41
|
'digits': number;
|
|
59
42
|
}
|
|
@@ -0,0 +1,27 @@
|
|
|
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
|
+
|
|
18
|
+
export const CompletedLookupStatusEnum = {
|
|
19
|
+
Complete: 'COMPLETE',
|
|
20
|
+
PartialComplete: 'PARTIAL_COMPLETE',
|
|
21
|
+
Failed: 'FAILED'
|
|
22
|
+
} as const;
|
|
23
|
+
|
|
24
|
+
export type CompletedLookupStatusEnum = typeof CompletedLookupStatusEnum[keyof typeof CompletedLookupStatusEnum];
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
|
|
@@ -16,38 +16,26 @@
|
|
|
16
16
|
|
|
17
17
|
/**
|
|
18
18
|
* The Conference Completed event is fired when the last member leaves the conference. The response to this event may not contain BXML.
|
|
19
|
-
* @export
|
|
20
|
-
* @interface ConferenceCompletedCallback
|
|
21
19
|
*/
|
|
22
20
|
export interface ConferenceCompletedCallback {
|
|
23
21
|
/**
|
|
24
22
|
* 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.
|
|
25
|
-
* @type {string}
|
|
26
|
-
* @memberof ConferenceCompletedCallback
|
|
27
23
|
*/
|
|
28
24
|
'eventType'?: string;
|
|
29
25
|
/**
|
|
30
26
|
* 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.
|
|
31
|
-
* @type {string}
|
|
32
|
-
* @memberof ConferenceCompletedCallback
|
|
33
27
|
*/
|
|
34
28
|
'eventTime'?: string;
|
|
35
29
|
/**
|
|
36
30
|
* The unique, Bandwidth-generated ID of the conference that was recorded
|
|
37
|
-
* @type {string}
|
|
38
|
-
* @memberof ConferenceCompletedCallback
|
|
39
31
|
*/
|
|
40
32
|
'conferenceId'?: string;
|
|
41
33
|
/**
|
|
42
34
|
* The user-specified name of the conference that was recorded
|
|
43
|
-
* @type {string}
|
|
44
|
-
* @memberof ConferenceCompletedCallback
|
|
45
35
|
*/
|
|
46
36
|
'name'?: string;
|
|
47
37
|
/**
|
|
48
38
|
* (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present.
|
|
49
|
-
* @type {string}
|
|
50
|
-
* @memberof ConferenceCompletedCallback
|
|
51
39
|
*/
|
|
52
40
|
'tag'?: string | null;
|
|
53
41
|
}
|
|
@@ -16,38 +16,26 @@
|
|
|
16
16
|
|
|
17
17
|
/**
|
|
18
18
|
* The Conference Created event is fired whenever a new conference that specified a callbackUrl is created. The response may be either empty or a BXML document. Only the following verbs are valid for conferences: PlayAudio, SpeakSentence, StartRecording, StopRecording, PauseRecording, ResumeRecording. Audio verbs will be heard by all members of the conference. Recordings capture audio from all members who are not muted or on hold, as well as any audio verbs that are played into the conference.
|
|
19
|
-
* @export
|
|
20
|
-
* @interface ConferenceCreatedCallback
|
|
21
19
|
*/
|
|
22
20
|
export interface ConferenceCreatedCallback {
|
|
23
21
|
/**
|
|
24
22
|
* 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.
|
|
25
|
-
* @type {string}
|
|
26
|
-
* @memberof ConferenceCreatedCallback
|
|
27
23
|
*/
|
|
28
24
|
'eventType'?: string;
|
|
29
25
|
/**
|
|
30
26
|
* 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.
|
|
31
|
-
* @type {string}
|
|
32
|
-
* @memberof ConferenceCreatedCallback
|
|
33
27
|
*/
|
|
34
28
|
'eventTime'?: string;
|
|
35
29
|
/**
|
|
36
30
|
* The unique, Bandwidth-generated ID of the conference that was recorded
|
|
37
|
-
* @type {string}
|
|
38
|
-
* @memberof ConferenceCreatedCallback
|
|
39
31
|
*/
|
|
40
32
|
'conferenceId'?: string;
|
|
41
33
|
/**
|
|
42
34
|
* The user-specified name of the conference that was recorded
|
|
43
|
-
* @type {string}
|
|
44
|
-
* @memberof ConferenceCreatedCallback
|
|
45
35
|
*/
|
|
46
36
|
'name'?: string;
|
|
47
37
|
/**
|
|
48
38
|
* (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present.
|
|
49
|
-
* @type {string}
|
|
50
|
-
* @memberof ConferenceCreatedCallback
|
|
51
39
|
*/
|
|
52
40
|
'tag'?: string | null;
|
|
53
41
|
}
|
|
@@ -16,56 +16,38 @@
|
|
|
16
16
|
|
|
17
17
|
/**
|
|
18
18
|
* The Conference Member Exit event is fired whenever a caller exits a conference that specified a callbackUrl. The response may be either empty or a BXML document. Only the following verbs are valid for conferences: PlayAudio, SpeakSentence, StartRecording, StopRecording, PauseRecording, ResumeRecording. Audio verbs will be heard by all members of the conference. Recordings capture audio from all members who are not muted or on hold, as well as any audio verbs that are played into the conference.
|
|
19
|
-
* @export
|
|
20
|
-
* @interface ConferenceMemberExitCallback
|
|
21
19
|
*/
|
|
22
20
|
export interface ConferenceMemberExitCallback {
|
|
23
21
|
/**
|
|
24
22
|
* 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.
|
|
25
|
-
* @type {string}
|
|
26
|
-
* @memberof ConferenceMemberExitCallback
|
|
27
23
|
*/
|
|
28
24
|
'eventType'?: string;
|
|
29
25
|
/**
|
|
30
26
|
* 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.
|
|
31
|
-
* @type {string}
|
|
32
|
-
* @memberof ConferenceMemberExitCallback
|
|
33
27
|
*/
|
|
34
28
|
'eventTime'?: string;
|
|
35
29
|
/**
|
|
36
30
|
* The unique, Bandwidth-generated ID of the conference that was recorded
|
|
37
|
-
* @type {string}
|
|
38
|
-
* @memberof ConferenceMemberExitCallback
|
|
39
31
|
*/
|
|
40
32
|
'conferenceId'?: string;
|
|
41
33
|
/**
|
|
42
34
|
* The user-specified name of the conference that was recorded
|
|
43
|
-
* @type {string}
|
|
44
|
-
* @memberof ConferenceMemberExitCallback
|
|
45
35
|
*/
|
|
46
36
|
'name'?: string;
|
|
47
37
|
/**
|
|
48
38
|
* The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555).
|
|
49
|
-
* @type {string}
|
|
50
|
-
* @memberof ConferenceMemberExitCallback
|
|
51
39
|
*/
|
|
52
40
|
'from'?: string;
|
|
53
41
|
/**
|
|
54
42
|
* The phone number that received the call, in E.164 format (e.g. +15555555555).
|
|
55
|
-
* @type {string}
|
|
56
|
-
* @memberof ConferenceMemberExitCallback
|
|
57
43
|
*/
|
|
58
44
|
'to'?: string;
|
|
59
45
|
/**
|
|
60
46
|
* The call id associated with the event.
|
|
61
|
-
* @type {string}
|
|
62
|
-
* @memberof ConferenceMemberExitCallback
|
|
63
47
|
*/
|
|
64
48
|
'callId'?: string;
|
|
65
49
|
/**
|
|
66
50
|
* (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present.
|
|
67
|
-
* @type {string}
|
|
68
|
-
* @memberof ConferenceMemberExitCallback
|
|
69
51
|
*/
|
|
70
52
|
'tag'?: string | null;
|
|
71
53
|
}
|