bandwidth-sdk 2.1.0 → 3.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 +4 -2
- package/.github/workflows/test-pr.yml +4 -2
- package/.github/workflows/{test-nightly.yml → test-smoke.yml} +6 -3
- package/.openapi-generator/FILES +2 -0
- package/README.md +22 -5
- package/api/transcriptions-api.ts +4 -4
- package/bandwidth.yml +28 -22
- package/coverage/clover.xml +1501 -138
- package/coverage/coverage-final.json +65 -47
- package/coverage/lcov-report/index.html +51 -21
- package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +1702 -0
- package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +2725 -0
- package/coverage/lcov-report/node-sdk/api/index.html +236 -0
- package/coverage/lcov-report/node-sdk/api/media-api.ts.html +1315 -0
- package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +1138 -0
- package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +1051 -0
- package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +775 -0
- package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +2971 -0
- package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +496 -0
- package/coverage/lcov-report/node-sdk/api/transcriptions-api.ts.html +1045 -0
- package/coverage/lcov-report/node-sdk/api.ts.html +163 -0
- package/coverage/lcov-report/node-sdk/base.ts.html +1045 -0
- package/coverage/lcov-report/node-sdk/common.ts.html +535 -0
- package/coverage/lcov-report/node-sdk/configuration.ts.html +415 -0
- package/coverage/lcov-report/node-sdk/index.html +161 -0
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/Bxml.ts.html +13 -13
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/NestableVerb.ts.html +15 -15
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/Response.ts.html +13 -13
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/Root.ts.html +17 -17
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/Verb.ts.html +15 -15
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/index.html +29 -14
- package/coverage/lcov-report/node-sdk/models/bxml/index.ts.html +94 -0
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/Bridge.ts.html +13 -13
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/Conference.ts.html +13 -13
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/CustomParam.ts.html +13 -13
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/Forward.ts.html +13 -13
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/Gather.ts.html +16 -16
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/Hangup.ts.html +13 -13
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/Pause.ts.html +13 -13
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/PauseRecording.ts.html +13 -13
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/PhoneNumber.ts.html +13 -13
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/PlayAudio.ts.html +13 -13
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/Record.ts.html +13 -13
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/Redirect.ts.html +13 -13
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/ResumeRecording.ts.html +13 -13
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/Ring.ts.html +13 -13
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/SendDtmf.ts.html +13 -13
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/SipUri.ts.html +13 -13
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/SpeakSentence.ts.html +15 -15
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/StartGather.ts.html +13 -13
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/StartRecording.ts.html +13 -13
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/StartStream.ts.html +14 -14
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/StartTranscription.ts.html +14 -14
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/StopGather.ts.html +13 -13
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/StopRecording.ts.html +13 -13
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/StopStream.ts.html +13 -13
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/StopTranscription.ts.html +13 -13
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/StreamParam.ts.html +13 -13
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/Tag.ts.html +13 -13
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/Transfer.ts.html +14 -14
- package/coverage/lcov-report/{models → node-sdk/models}/bxml/verbs/index.html +27 -12
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.ts.html +175 -0
- package/coverage/lcov-report/{models → node-sdk/models}/call-direction-enum.ts.html +11 -11
- package/coverage/lcov-report/{models → node-sdk/models}/call-state-enum.ts.html +11 -11
- package/coverage/lcov-report/node-sdk/models/call-transcription-detected-language-enum.ts.html +181 -0
- package/coverage/lcov-report/node-sdk/models/call-transcription-track-enum.ts.html +178 -0
- package/coverage/lcov-report/{models → node-sdk/models}/callback-method-enum.ts.html +11 -11
- package/coverage/lcov-report/{models → node-sdk/models}/conference-state-enum.ts.html +11 -11
- package/coverage/lcov-report/{models → node-sdk/models}/file-format-enum.ts.html +11 -11
- package/coverage/lcov-report/{models → node-sdk/models}/index.html +57 -12
- package/coverage/lcov-report/node-sdk/models/index.ts.html +367 -0
- package/coverage/lcov-report/{models → node-sdk/models}/list-message-direction-enum.ts.html +11 -11
- package/coverage/lcov-report/{models → node-sdk/models}/lookup-status-enum.ts.html +11 -11
- package/coverage/lcov-report/{models → node-sdk/models}/machine-detection-mode-enum.ts.html +11 -11
- package/coverage/lcov-report/{models → node-sdk/models}/message-direction-enum.ts.html +11 -11
- package/coverage/lcov-report/{models → node-sdk/models}/message-status-enum.ts.html +11 -11
- package/coverage/lcov-report/{models → node-sdk/models}/message-type-enum.ts.html +11 -11
- package/coverage/lcov-report/{models → node-sdk/models}/priority-enum.ts.html +11 -11
- package/coverage/lcov-report/{models → node-sdk/models}/recording-state-enum.ts.html +11 -11
- package/coverage/lcov-report/{models → node-sdk/models}/redirect-method-enum.ts.html +11 -11
- package/coverage/lcov.info +3366 -162
- package/custom_templates/README.mustache +22 -5
- package/custom_templates/package.mustache +2 -1
- package/custom_templates/tsconfig.mustache +2 -1
- package/global.d.ts +1 -0
- package/jest.config.js +1 -0
- package/{dist/models/call-transcription.js → models/call-transcription-detected-language-enum.ts} +16 -9
- package/{dist/models/call-direction-enum.js → models/call-transcription-track-enum.ts} +12 -6
- package/models/call-transcription.ts +11 -18
- package/models/index.ts +2 -0
- package/package.json +3 -2
- package/tests/callUtils.ts +11 -11
- package/tests/smoke/bxml.test.ts +17 -17
- package/tests/smoke/calls-api.test.ts +38 -38
- package/tests/smoke/conferences-api.test.ts +19 -19
- package/tests/smoke/media-api.test.ts +11 -11
- package/tests/smoke/messages-api.test.ts +26 -26
- package/tests/smoke/mfaapi.test.ts +18 -18
- package/tests/smoke/phone-number-lookup-api.test.ts +16 -6
- package/tests/smoke/recordings-api.test.ts +31 -31
- package/tests/smoke/statistics-api.test.ts +7 -7
- package/tests/smoke/transcriptions-api.test.ts +15 -15
- package/tests/unit/api/calls-api.test.ts +180 -0
- package/tests/unit/api/conferences-api.test.ts +160 -0
- package/tests/unit/api/media-api.test.ts +59 -0
- package/tests/unit/api/messages-api.test.ts +122 -0
- package/tests/unit/api/mfaapi.test.ts +76 -0
- package/tests/unit/api/phone-number-lookup-api.test.ts +96 -0
- package/tests/unit/api/recordings-api.test.ts +175 -0
- package/tests/unit/api/statistics-api.test.ts +35 -0
- package/tests/unit/api/transcriptions-api.test.ts +60 -0
- package/tests/unit/models/call-transcription-detected-language-enum.test.ts +9 -0
- package/tests/unit/models/call-transcription-track-enum.test.ts +8 -0
- package/tsconfig.json +2 -1
- package/dist/api/calls-api.d.ts +0 -261
- package/dist/api/calls-api.js +0 -656
- package/dist/api/conferences-api.d.ts +0 -422
- package/dist/api/conferences-api.js +0 -1045
- package/dist/api/media-api.d.ts +0 -201
- package/dist/api/media-api.js +0 -527
- package/dist/api/messages-api.d.ts +0 -176
- package/dist/api/messages-api.js +0 -420
- package/dist/api/mfaapi.d.ts +0 -156
- package/dist/api/mfaapi.js +0 -416
- package/dist/api/phone-number-lookup-api.d.ts +0 -117
- package/dist/api/phone-number-lookup-api.js +0 -322
- package/dist/api/recordings-api.d.ts +0 -462
- package/dist/api/recordings-api.js +0 -1143
- package/dist/api/statistics-api.d.ts +0 -74
- package/dist/api/statistics-api.js +0 -222
- package/dist/api/transcriptions-api.d.ts +0 -161
- package/dist/api/transcriptions-api.js +0 -427
- package/dist/api.d.ts +0 -20
- package/dist/api.js +0 -38
- package/dist/base.d.ts +0 -66
- package/dist/base.js +0 -321
- package/dist/common.d.ts +0 -65
- package/dist/common.js +0 -253
- package/dist/configuration.d.ts +0 -91
- package/dist/configuration.js +0 -45
- package/dist/index.d.ts +0 -14
- package/dist/index.js +0 -32
- package/dist/models/account-statistics.d.ts +0 -30
- package/dist/models/account-statistics.js +0 -15
- package/dist/models/answer-callback.d.ts +0 -104
- package/dist/models/answer-callback.js +0 -15
- package/dist/models/bridge-complete-callback.d.ts +0 -115
- package/dist/models/bridge-complete-callback.js +0 -15
- package/dist/models/bridge-target-complete-callback.d.ts +0 -97
- package/dist/models/bridge-target-complete-callback.js +0 -15
- package/dist/models/bxml/Bxml.d.ts +0 -17
- package/dist/models/bxml/Bxml.js +0 -37
- package/dist/models/bxml/NestableVerb.d.ts +0 -26
- package/dist/models/bxml/NestableVerb.js +0 -62
- package/dist/models/bxml/Response.d.ts +0 -17
- package/dist/models/bxml/Response.js +0 -37
- package/dist/models/bxml/Root.d.ts +0 -33
- package/dist/models/bxml/Root.js +0 -57
- package/dist/models/bxml/Verb.d.ts +0 -27
- package/dist/models/bxml/Verb.js +0 -38
- package/dist/models/bxml/index.d.ts +0 -2
- package/dist/models/bxml/index.js +0 -5
- package/dist/models/bxml/verbs/Bridge.d.ts +0 -32
- package/dist/models/bxml/verbs/Bridge.js +0 -38
- package/dist/models/bxml/verbs/Conference.d.ts +0 -32
- package/dist/models/bxml/verbs/Conference.js +0 -38
- package/dist/models/bxml/verbs/CustomParam.d.ts +0 -19
- package/dist/models/bxml/verbs/CustomParam.js +0 -37
- package/dist/models/bxml/verbs/Forward.d.ts +0 -23
- package/dist/models/bxml/verbs/Forward.js +0 -37
- package/dist/models/bxml/verbs/Gather.d.ts +0 -47
- package/dist/models/bxml/verbs/Gather.js +0 -53
- package/dist/models/bxml/verbs/Hangup.d.ts +0 -13
- package/dist/models/bxml/verbs/Hangup.js +0 -36
- package/dist/models/bxml/verbs/Pause.d.ts +0 -18
- package/dist/models/bxml/verbs/Pause.js +0 -37
- package/dist/models/bxml/verbs/PauseRecording.d.ts +0 -13
- package/dist/models/bxml/verbs/PauseRecording.js +0 -36
- package/dist/models/bxml/verbs/PhoneNumber.d.ts +0 -30
- package/dist/models/bxml/verbs/PhoneNumber.js +0 -38
- package/dist/models/bxml/verbs/PlayAudio.d.ts +0 -21
- package/dist/models/bxml/verbs/PlayAudio.js +0 -38
- package/dist/models/bxml/verbs/Record.d.ts +0 -35
- package/dist/models/bxml/verbs/Record.js +0 -37
- package/dist/models/bxml/verbs/Redirect.d.ts +0 -26
- package/dist/models/bxml/verbs/Redirect.js +0 -37
- package/dist/models/bxml/verbs/ResumeRecording.d.ts +0 -13
- package/dist/models/bxml/verbs/ResumeRecording.js +0 -36
- package/dist/models/bxml/verbs/Ring.d.ts +0 -19
- package/dist/models/bxml/verbs/Ring.js +0 -37
- package/dist/models/bxml/verbs/SendDtmf.d.ts +0 -21
- package/dist/models/bxml/verbs/SendDtmf.js +0 -38
- package/dist/models/bxml/verbs/SipUri.d.ts +0 -31
- package/dist/models/bxml/verbs/SipUri.js +0 -38
- package/dist/models/bxml/verbs/SpeakSentence.d.ts +0 -28
- package/dist/models/bxml/verbs/SpeakSentence.js +0 -46
- package/dist/models/bxml/verbs/StartGather.d.ts +0 -22
- package/dist/models/bxml/verbs/StartGather.js +0 -37
- package/dist/models/bxml/verbs/StartRecording.d.ts +0 -27
- package/dist/models/bxml/verbs/StartRecording.js +0 -37
- package/dist/models/bxml/verbs/StartStream.d.ts +0 -31
- package/dist/models/bxml/verbs/StartStream.js +0 -45
- package/dist/models/bxml/verbs/StartTranscription.d.ts +0 -32
- package/dist/models/bxml/verbs/StartTranscription.js +0 -45
- package/dist/models/bxml/verbs/StopGather.d.ts +0 -13
- package/dist/models/bxml/verbs/StopGather.js +0 -36
- package/dist/models/bxml/verbs/StopRecording.d.ts +0 -13
- package/dist/models/bxml/verbs/StopRecording.js +0 -36
- package/dist/models/bxml/verbs/StopStream.d.ts +0 -18
- package/dist/models/bxml/verbs/StopStream.js +0 -37
- package/dist/models/bxml/verbs/StopTranscription.d.ts +0 -18
- package/dist/models/bxml/verbs/StopTranscription.js +0 -37
- package/dist/models/bxml/verbs/StreamParam.d.ts +0 -19
- package/dist/models/bxml/verbs/StreamParam.js +0 -37
- package/dist/models/bxml/verbs/Tag.d.ts +0 -15
- package/dist/models/bxml/verbs/Tag.js +0 -37
- package/dist/models/bxml/verbs/Transfer.d.ts +0 -41
- package/dist/models/bxml/verbs/Transfer.js +0 -45
- package/dist/models/bxml/verbs/index.d.ts +0 -30
- package/dist/models/bxml/verbs/index.js +0 -46
- package/dist/models/call-direction-enum.d.ts +0 -21
- package/dist/models/call-recording-metadata.d.ts +0 -129
- package/dist/models/call-recording-metadata.js +0 -15
- package/dist/models/call-state-enum.d.ts +0 -21
- package/dist/models/call-state-enum.js +0 -25
- package/dist/models/call-state.d.ts +0 -129
- package/dist/models/call-state.js +0 -15
- package/dist/models/call-transcription-metadata.d.ts +0 -30
- package/dist/models/call-transcription-metadata.js +0 -15
- package/dist/models/call-transcription-response.d.ts +0 -43
- package/dist/models/call-transcription-response.js +0 -15
- package/dist/models/call-transcription.d.ts +0 -53
- package/dist/models/callback-method-enum.d.ts +0 -21
- package/dist/models/callback-method-enum.js +0 -25
- package/dist/models/code-request.d.ts +0 -54
- package/dist/models/code-request.js +0 -15
- package/dist/models/conference-completed-callback.d.ts +0 -48
- package/dist/models/conference-completed-callback.js +0 -15
- package/dist/models/conference-created-callback.d.ts +0 -48
- package/dist/models/conference-created-callback.js +0 -15
- package/dist/models/conference-member-exit-callback.d.ts +0 -66
- package/dist/models/conference-member-exit-callback.js +0 -15
- package/dist/models/conference-member-join-callback.d.ts +0 -66
- package/dist/models/conference-member-join-callback.js +0 -15
- package/dist/models/conference-member.d.ts +0 -54
- package/dist/models/conference-member.js +0 -15
- package/dist/models/conference-recording-available-callback.d.ts +0 -103
- package/dist/models/conference-recording-available-callback.js +0 -15
- package/dist/models/conference-recording-metadata.d.ts +0 -85
- package/dist/models/conference-recording-metadata.js +0 -15
- package/dist/models/conference-redirect-callback.d.ts +0 -48
- package/dist/models/conference-redirect-callback.js +0 -15
- package/dist/models/conference-state-enum.d.ts +0 -21
- package/dist/models/conference-state-enum.js +0 -25
- package/dist/models/conference.d.ts +0 -68
- package/dist/models/conference.js +0 -15
- package/dist/models/create-call-response.d.ts +0 -145
- package/dist/models/create-call-response.js +0 -15
- package/dist/models/create-call.d.ts +0 -146
- package/dist/models/create-call.js +0 -15
- package/dist/models/create-lookup-response.d.ts +0 -31
- package/dist/models/create-lookup-response.js +0 -15
- package/dist/models/create-message-request-error.d.ts +0 -37
- package/dist/models/create-message-request-error.js +0 -15
- package/dist/models/deferred-result.d.ts +0 -30
- package/dist/models/deferred-result.js +0 -15
- package/dist/models/disconnect-callback.d.ts +0 -121
- package/dist/models/disconnect-callback.js +0 -15
- package/dist/models/diversion.d.ts +0 -60
- package/dist/models/diversion.js +0 -15
- package/dist/models/dtmf-callback.d.ts +0 -121
- package/dist/models/dtmf-callback.js +0 -15
- package/dist/models/field-error.d.ts +0 -30
- package/dist/models/field-error.js +0 -15
- package/dist/models/file-format-enum.d.ts +0 -21
- package/dist/models/file-format-enum.js +0 -25
- package/dist/models/gather-callback.d.ts +0 -127
- package/dist/models/gather-callback.js +0 -15
- package/dist/models/inbound-message-callback-message.d.ts +0 -92
- package/dist/models/inbound-message-callback-message.js +0 -15
- package/dist/models/inbound-message-callback.d.ts +0 -49
- package/dist/models/inbound-message-callback.js +0 -15
- package/dist/models/index.d.ts +0 -92
- package/dist/models/index.js +0 -108
- package/dist/models/initiate-callback.d.ts +0 -93
- package/dist/models/initiate-callback.js +0 -15
- package/dist/models/list-message-direction-enum.d.ts +0 -21
- package/dist/models/list-message-direction-enum.js +0 -25
- package/dist/models/list-message-item.d.ts +0 -123
- package/dist/models/list-message-item.js +0 -15
- package/dist/models/lookup-request.d.ts +0 -24
- package/dist/models/lookup-request.js +0 -15
- package/dist/models/lookup-result.d.ts +0 -72
- package/dist/models/lookup-result.js +0 -15
- package/dist/models/lookup-status-enum.d.ts +0 -23
- package/dist/models/lookup-status-enum.js +0 -27
- package/dist/models/lookup-status.d.ts +0 -44
- package/dist/models/lookup-status.js +0 -15
- package/dist/models/machine-detection-complete-callback.d.ts +0 -104
- package/dist/models/machine-detection-complete-callback.js +0 -15
- package/dist/models/machine-detection-configuration.d.ts +0 -110
- package/dist/models/machine-detection-configuration.js +0 -15
- package/dist/models/machine-detection-mode-enum.d.ts +0 -21
- package/dist/models/machine-detection-mode-enum.js +0 -25
- package/dist/models/machine-detection-result.d.ts +0 -30
- package/dist/models/machine-detection-result.js +0 -15
- package/dist/models/media.d.ts +0 -36
- package/dist/models/media.js +0 -15
- package/dist/models/message-delivered-callback-message.d.ts +0 -92
- package/dist/models/message-delivered-callback-message.js +0 -15
- package/dist/models/message-delivered-callback.d.ts +0 -49
- package/dist/models/message-delivered-callback.js +0 -15
- package/dist/models/message-direction-enum.d.ts +0 -21
- package/dist/models/message-direction-enum.js +0 -25
- package/dist/models/message-failed-callback-message.d.ts +0 -92
- package/dist/models/message-failed-callback-message.js +0 -15
- package/dist/models/message-failed-callback.d.ts +0 -55
- package/dist/models/message-failed-callback.js +0 -15
- package/dist/models/message-request.d.ts +0 -67
- package/dist/models/message-request.js +0 -15
- package/dist/models/message-sending-callback-message.d.ts +0 -92
- package/dist/models/message-sending-callback-message.js +0 -15
- package/dist/models/message-sending-callback.d.ts +0 -49
- package/dist/models/message-sending-callback.js +0 -15
- package/dist/models/message-status-enum.d.ts +0 -27
- package/dist/models/message-status-enum.js +0 -31
- package/dist/models/message-type-enum.d.ts +0 -21
- package/dist/models/message-type-enum.js +0 -25
- package/dist/models/message.d.ts +0 -98
- package/dist/models/message.js +0 -15
- package/dist/models/messages-list.d.ts +0 -38
- package/dist/models/messages-list.js +0 -15
- package/dist/models/messaging-code-response.d.ts +0 -24
- package/dist/models/messaging-code-response.js +0 -15
- package/dist/models/messaging-request-error.d.ts +0 -30
- package/dist/models/messaging-request-error.js +0 -15
- package/dist/models/mfa-forbidden-request-error.d.ts +0 -24
- package/dist/models/mfa-forbidden-request-error.js +0 -15
- package/dist/models/mfa-request-error.d.ts +0 -30
- package/dist/models/mfa-request-error.js +0 -15
- package/dist/models/mfa-unauthorized-request-error.d.ts +0 -24
- package/dist/models/mfa-unauthorized-request-error.js +0 -15
- package/dist/models/page-info.d.ts +0 -42
- package/dist/models/page-info.js +0 -15
- package/dist/models/priority-enum.d.ts +0 -21
- package/dist/models/priority-enum.js +0 -25
- package/dist/models/recording-available-callback.d.ts +0 -152
- package/dist/models/recording-available-callback.js +0 -15
- package/dist/models/recording-complete-callback.d.ts +0 -152
- package/dist/models/recording-complete-callback.js +0 -15
- package/dist/models/recording-state-enum.d.ts +0 -21
- package/dist/models/recording-state-enum.js +0 -25
- package/dist/models/recording-transcription-metadata.d.ts +0 -42
- package/dist/models/recording-transcription-metadata.js +0 -15
- package/dist/models/recording-transcriptions.d.ts +0 -25
- package/dist/models/recording-transcriptions.js +0 -15
- package/dist/models/redirect-callback.d.ts +0 -115
- package/dist/models/redirect-callback.js +0 -15
- package/dist/models/redirect-method-enum.d.ts +0 -21
- package/dist/models/redirect-method-enum.js +0 -25
- package/dist/models/stir-shaken.d.ts +0 -36
- package/dist/models/stir-shaken.js +0 -15
- package/dist/models/tag.d.ts +0 -30
- package/dist/models/tag.js +0 -15
- package/dist/models/tn-lookup-request-error.d.ts +0 -24
- package/dist/models/tn-lookup-request-error.js +0 -15
- package/dist/models/transcribe-recording.d.ts +0 -61
- package/dist/models/transcribe-recording.js +0 -15
- package/dist/models/transcription-available-callback.d.ts +0 -147
- package/dist/models/transcription-available-callback.js +0 -15
- package/dist/models/transcription-list.d.ts +0 -25
- package/dist/models/transcription-list.js +0 -15
- package/dist/models/transcription-metadata.d.ts +0 -42
- package/dist/models/transcription-metadata.js +0 -15
- package/dist/models/transcription.d.ts +0 -30
- package/dist/models/transcription.js +0 -15
- package/dist/models/transfer-answer-callback.d.ts +0 -109
- package/dist/models/transfer-answer-callback.js +0 -15
- package/dist/models/transfer-complete-callback.d.ts +0 -127
- package/dist/models/transfer-complete-callback.js +0 -15
- package/dist/models/transfer-disconnect-callback.d.ts +0 -139
- package/dist/models/transfer-disconnect-callback.js +0 -15
- package/dist/models/update-call-recording.d.ts +0 -25
- package/dist/models/update-call-recording.js +0 -15
- package/dist/models/update-call.d.ts +0 -80
- package/dist/models/update-call.js +0 -15
- package/dist/models/update-conference-member.d.ts +0 -36
- package/dist/models/update-conference-member.js +0 -15
- package/dist/models/update-conference.d.ts +0 -74
- package/dist/models/update-conference.js +0 -15
- package/dist/models/verify-code-request.d.ts +0 -42
- package/dist/models/verify-code-request.js +0 -15
- package/dist/models/verify-code-response.d.ts +0 -24
- package/dist/models/verify-code-response.js +0 -15
- package/dist/models/voice-api-error.d.ts +0 -36
- package/dist/models/voice-api-error.js +0 -15
- package/dist/models/voice-code-response.d.ts +0 -24
- package/dist/models/voice-code-response.js +0 -15
|
@@ -1,176 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Bandwidth
|
|
3
|
-
* Bandwidth\'s Communication APIs
|
|
4
|
-
*
|
|
5
|
-
* The version of the OpenAPI document: 1.0.0
|
|
6
|
-
* Contact: letstalk@bandwidth.com
|
|
7
|
-
*
|
|
8
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
-
* https://openapi-generator.tech
|
|
10
|
-
* Do not edit the class manually.
|
|
11
|
-
*/
|
|
12
|
-
import type { Configuration } from '../configuration';
|
|
13
|
-
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
|
-
import { type RequestArgs, BaseAPI } from '../base';
|
|
15
|
-
import type { ListMessageDirectionEnum } from '../models';
|
|
16
|
-
import type { Message } from '../models';
|
|
17
|
-
import type { MessageRequest } from '../models';
|
|
18
|
-
import type { MessageStatusEnum } from '../models';
|
|
19
|
-
import type { MessageTypeEnum } from '../models';
|
|
20
|
-
import type { MessagesList } from '../models';
|
|
21
|
-
/**
|
|
22
|
-
* MessagesApi - axios parameter creator
|
|
23
|
-
* @export
|
|
24
|
-
*/
|
|
25
|
-
export declare const MessagesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
26
|
-
/**
|
|
27
|
-
* Endpoint for sending text messages and picture messages using V2 messaging.
|
|
28
|
-
* @summary Create Message
|
|
29
|
-
* @param {string} accountId Your Bandwidth Account ID.
|
|
30
|
-
* @param {MessageRequest} messageRequest
|
|
31
|
-
* @param {*} [options] Override http request option.
|
|
32
|
-
* @throws {RequiredError}
|
|
33
|
-
*/
|
|
34
|
-
createMessage: (accountId: string, messageRequest: MessageRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35
|
-
/**
|
|
36
|
-
* Returns a list of messages based on query parameters.
|
|
37
|
-
* @summary List Messages
|
|
38
|
-
* @param {string} accountId Your Bandwidth Account ID.
|
|
39
|
-
* @param {string} [messageId] The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter.
|
|
40
|
-
* @param {string} [sourceTn] The phone number that sent the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. \'%2B1919\').
|
|
41
|
-
* @param {string} [destinationTn] The phone number that received the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. \'%2B1919\').
|
|
42
|
-
* @param {MessageStatusEnum} [messageStatus] The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED.
|
|
43
|
-
* @param {ListMessageDirectionEnum} [messageDirection] The direction of the message. One of INBOUND OUTBOUND.
|
|
44
|
-
* @param {string} [carrierName] The name of the carrier used for this message. Possible values include but are not limited to Verizon and TMobile. Special characters need to be encoded using URL encoding (i.e. AT&T should be passed as AT%26T).
|
|
45
|
-
* @param {MessageTypeEnum} [messageType] The type of message. Either sms or mms.
|
|
46
|
-
* @param {number} [errorCode] The error code of the message.
|
|
47
|
-
* @param {string} [fromDateTime] The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
|
|
48
|
-
* @param {string} [toDateTime] The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
|
|
49
|
-
* @param {string} [campaignId] The campaign ID of the message.
|
|
50
|
-
* @param {string} [sort] The field and direction to sort by combined with a colon. Direction is either asc or desc.
|
|
51
|
-
* @param {string} [pageToken] A base64 encoded value used for pagination of results.
|
|
52
|
-
* @param {number} [limit] The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000.
|
|
53
|
-
* @param {boolean} [limitTotalCount] When set to true, the response\'s totalCount field will have a maximum value of 10,000. When set to false, or excluded, this will give an accurate totalCount of all messages that match the provided filters. If you are experiencing latency, try using this parameter to limit your results.
|
|
54
|
-
* @param {*} [options] Override http request option.
|
|
55
|
-
* @throws {RequiredError}
|
|
56
|
-
*/
|
|
57
|
-
listMessages: (accountId: string, messageId?: string, sourceTn?: string, destinationTn?: string, messageStatus?: MessageStatusEnum, messageDirection?: ListMessageDirectionEnum, carrierName?: string, messageType?: MessageTypeEnum, errorCode?: number, fromDateTime?: string, toDateTime?: string, campaignId?: string, sort?: string, pageToken?: string, limit?: number, limitTotalCount?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
58
|
-
};
|
|
59
|
-
/**
|
|
60
|
-
* MessagesApi - functional programming interface
|
|
61
|
-
* @export
|
|
62
|
-
*/
|
|
63
|
-
export declare const MessagesApiFp: (configuration?: Configuration) => {
|
|
64
|
-
/**
|
|
65
|
-
* Endpoint for sending text messages and picture messages using V2 messaging.
|
|
66
|
-
* @summary Create Message
|
|
67
|
-
* @param {string} accountId Your Bandwidth Account ID.
|
|
68
|
-
* @param {MessageRequest} messageRequest
|
|
69
|
-
* @param {*} [options] Override http request option.
|
|
70
|
-
* @throws {RequiredError}
|
|
71
|
-
*/
|
|
72
|
-
createMessage(accountId: string, messageRequest: MessageRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Message>>;
|
|
73
|
-
/**
|
|
74
|
-
* Returns a list of messages based on query parameters.
|
|
75
|
-
* @summary List Messages
|
|
76
|
-
* @param {string} accountId Your Bandwidth Account ID.
|
|
77
|
-
* @param {string} [messageId] The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter.
|
|
78
|
-
* @param {string} [sourceTn] The phone number that sent the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. \'%2B1919\').
|
|
79
|
-
* @param {string} [destinationTn] The phone number that received the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. \'%2B1919\').
|
|
80
|
-
* @param {MessageStatusEnum} [messageStatus] The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED.
|
|
81
|
-
* @param {ListMessageDirectionEnum} [messageDirection] The direction of the message. One of INBOUND OUTBOUND.
|
|
82
|
-
* @param {string} [carrierName] The name of the carrier used for this message. Possible values include but are not limited to Verizon and TMobile. Special characters need to be encoded using URL encoding (i.e. AT&T should be passed as AT%26T).
|
|
83
|
-
* @param {MessageTypeEnum} [messageType] The type of message. Either sms or mms.
|
|
84
|
-
* @param {number} [errorCode] The error code of the message.
|
|
85
|
-
* @param {string} [fromDateTime] The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
|
|
86
|
-
* @param {string} [toDateTime] The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
|
|
87
|
-
* @param {string} [campaignId] The campaign ID of the message.
|
|
88
|
-
* @param {string} [sort] The field and direction to sort by combined with a colon. Direction is either asc or desc.
|
|
89
|
-
* @param {string} [pageToken] A base64 encoded value used for pagination of results.
|
|
90
|
-
* @param {number} [limit] The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000.
|
|
91
|
-
* @param {boolean} [limitTotalCount] When set to true, the response\'s totalCount field will have a maximum value of 10,000. When set to false, or excluded, this will give an accurate totalCount of all messages that match the provided filters. If you are experiencing latency, try using this parameter to limit your results.
|
|
92
|
-
* @param {*} [options] Override http request option.
|
|
93
|
-
* @throws {RequiredError}
|
|
94
|
-
*/
|
|
95
|
-
listMessages(accountId: string, messageId?: string, sourceTn?: string, destinationTn?: string, messageStatus?: MessageStatusEnum, messageDirection?: ListMessageDirectionEnum, carrierName?: string, messageType?: MessageTypeEnum, errorCode?: number, fromDateTime?: string, toDateTime?: string, campaignId?: string, sort?: string, pageToken?: string, limit?: number, limitTotalCount?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessagesList>>;
|
|
96
|
-
};
|
|
97
|
-
/**
|
|
98
|
-
* MessagesApi - factory interface
|
|
99
|
-
* @export
|
|
100
|
-
*/
|
|
101
|
-
export declare const MessagesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
102
|
-
/**
|
|
103
|
-
* Endpoint for sending text messages and picture messages using V2 messaging.
|
|
104
|
-
* @summary Create Message
|
|
105
|
-
* @param {string} accountId Your Bandwidth Account ID.
|
|
106
|
-
* @param {MessageRequest} messageRequest
|
|
107
|
-
* @param {*} [options] Override http request option.
|
|
108
|
-
* @throws {RequiredError}
|
|
109
|
-
*/
|
|
110
|
-
createMessage(accountId: string, messageRequest: MessageRequest, options?: any): AxiosPromise<Message>;
|
|
111
|
-
/**
|
|
112
|
-
* Returns a list of messages based on query parameters.
|
|
113
|
-
* @summary List Messages
|
|
114
|
-
* @param {string} accountId Your Bandwidth Account ID.
|
|
115
|
-
* @param {string} [messageId] The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter.
|
|
116
|
-
* @param {string} [sourceTn] The phone number that sent the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. \'%2B1919\').
|
|
117
|
-
* @param {string} [destinationTn] The phone number that received the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. \'%2B1919\').
|
|
118
|
-
* @param {MessageStatusEnum} [messageStatus] The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED.
|
|
119
|
-
* @param {ListMessageDirectionEnum} [messageDirection] The direction of the message. One of INBOUND OUTBOUND.
|
|
120
|
-
* @param {string} [carrierName] The name of the carrier used for this message. Possible values include but are not limited to Verizon and TMobile. Special characters need to be encoded using URL encoding (i.e. AT&T should be passed as AT%26T).
|
|
121
|
-
* @param {MessageTypeEnum} [messageType] The type of message. Either sms or mms.
|
|
122
|
-
* @param {number} [errorCode] The error code of the message.
|
|
123
|
-
* @param {string} [fromDateTime] The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
|
|
124
|
-
* @param {string} [toDateTime] The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
|
|
125
|
-
* @param {string} [campaignId] The campaign ID of the message.
|
|
126
|
-
* @param {string} [sort] The field and direction to sort by combined with a colon. Direction is either asc or desc.
|
|
127
|
-
* @param {string} [pageToken] A base64 encoded value used for pagination of results.
|
|
128
|
-
* @param {number} [limit] The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000.
|
|
129
|
-
* @param {boolean} [limitTotalCount] When set to true, the response\'s totalCount field will have a maximum value of 10,000. When set to false, or excluded, this will give an accurate totalCount of all messages that match the provided filters. If you are experiencing latency, try using this parameter to limit your results.
|
|
130
|
-
* @param {*} [options] Override http request option.
|
|
131
|
-
* @throws {RequiredError}
|
|
132
|
-
*/
|
|
133
|
-
listMessages(accountId: string, messageId?: string, sourceTn?: string, destinationTn?: string, messageStatus?: MessageStatusEnum, messageDirection?: ListMessageDirectionEnum, carrierName?: string, messageType?: MessageTypeEnum, errorCode?: number, fromDateTime?: string, toDateTime?: string, campaignId?: string, sort?: string, pageToken?: string, limit?: number, limitTotalCount?: boolean, options?: any): AxiosPromise<MessagesList>;
|
|
134
|
-
};
|
|
135
|
-
/**
|
|
136
|
-
* MessagesApi - object-oriented interface
|
|
137
|
-
* @export
|
|
138
|
-
* @class MessagesApi
|
|
139
|
-
* @extends {BaseAPI}
|
|
140
|
-
*/
|
|
141
|
-
export declare class MessagesApi extends BaseAPI {
|
|
142
|
-
/**
|
|
143
|
-
* Endpoint for sending text messages and picture messages using V2 messaging.
|
|
144
|
-
* @summary Create Message
|
|
145
|
-
* @param {string} accountId Your Bandwidth Account ID.
|
|
146
|
-
* @param {MessageRequest} messageRequest
|
|
147
|
-
* @param {*} [options] Override http request option.
|
|
148
|
-
* @throws {RequiredError}
|
|
149
|
-
* @memberof MessagesApi
|
|
150
|
-
*/
|
|
151
|
-
createMessage(accountId: string, messageRequest: MessageRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Message, any>>;
|
|
152
|
-
/**
|
|
153
|
-
* Returns a list of messages based on query parameters.
|
|
154
|
-
* @summary List Messages
|
|
155
|
-
* @param {string} accountId Your Bandwidth Account ID.
|
|
156
|
-
* @param {string} [messageId] The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter.
|
|
157
|
-
* @param {string} [sourceTn] The phone number that sent the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. \'%2B1919\').
|
|
158
|
-
* @param {string} [destinationTn] The phone number that received the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. \'%2B1919\').
|
|
159
|
-
* @param {MessageStatusEnum} [messageStatus] The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED.
|
|
160
|
-
* @param {ListMessageDirectionEnum} [messageDirection] The direction of the message. One of INBOUND OUTBOUND.
|
|
161
|
-
* @param {string} [carrierName] The name of the carrier used for this message. Possible values include but are not limited to Verizon and TMobile. Special characters need to be encoded using URL encoding (i.e. AT&T should be passed as AT%26T).
|
|
162
|
-
* @param {MessageTypeEnum} [messageType] The type of message. Either sms or mms.
|
|
163
|
-
* @param {number} [errorCode] The error code of the message.
|
|
164
|
-
* @param {string} [fromDateTime] The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
|
|
165
|
-
* @param {string} [toDateTime] The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
|
|
166
|
-
* @param {string} [campaignId] The campaign ID of the message.
|
|
167
|
-
* @param {string} [sort] The field and direction to sort by combined with a colon. Direction is either asc or desc.
|
|
168
|
-
* @param {string} [pageToken] A base64 encoded value used for pagination of results.
|
|
169
|
-
* @param {number} [limit] The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000.
|
|
170
|
-
* @param {boolean} [limitTotalCount] When set to true, the response\'s totalCount field will have a maximum value of 10,000. When set to false, or excluded, this will give an accurate totalCount of all messages that match the provided filters. If you are experiencing latency, try using this parameter to limit your results.
|
|
171
|
-
* @param {*} [options] Override http request option.
|
|
172
|
-
* @throws {RequiredError}
|
|
173
|
-
* @memberof MessagesApi
|
|
174
|
-
*/
|
|
175
|
-
listMessages(accountId: string, messageId?: string, sourceTn?: string, destinationTn?: string, messageStatus?: MessageStatusEnum, messageDirection?: ListMessageDirectionEnum, carrierName?: string, messageType?: MessageTypeEnum, errorCode?: number, fromDateTime?: string, toDateTime?: string, campaignId?: string, sort?: string, pageToken?: string, limit?: number, limitTotalCount?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessagesList, any>>;
|
|
176
|
-
}
|
package/dist/api/messages-api.js
DELETED
|
@@ -1,420 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/* tslint:disable */
|
|
3
|
-
/* eslint-disable */
|
|
4
|
-
/**
|
|
5
|
-
* Bandwidth
|
|
6
|
-
* Bandwidth\'s Communication APIs
|
|
7
|
-
*
|
|
8
|
-
* The version of the OpenAPI document: 1.0.0
|
|
9
|
-
* Contact: letstalk@bandwidth.com
|
|
10
|
-
*
|
|
11
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
-
* https://openapi-generator.tech
|
|
13
|
-
* Do not edit the class manually.
|
|
14
|
-
*/
|
|
15
|
-
var __extends = (this && this.__extends) || (function () {
|
|
16
|
-
var extendStatics = function (d, b) {
|
|
17
|
-
extendStatics = Object.setPrototypeOf ||
|
|
18
|
-
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
|
19
|
-
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
|
|
20
|
-
return extendStatics(d, b);
|
|
21
|
-
};
|
|
22
|
-
return function (d, b) {
|
|
23
|
-
if (typeof b !== "function" && b !== null)
|
|
24
|
-
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
|
|
25
|
-
extendStatics(d, b);
|
|
26
|
-
function __() { this.constructor = d; }
|
|
27
|
-
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
|
28
|
-
};
|
|
29
|
-
})();
|
|
30
|
-
var __assign = (this && this.__assign) || function () {
|
|
31
|
-
__assign = Object.assign || function(t) {
|
|
32
|
-
for (var s, i = 1, n = arguments.length; i < n; i++) {
|
|
33
|
-
s = arguments[i];
|
|
34
|
-
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
|
|
35
|
-
t[p] = s[p];
|
|
36
|
-
}
|
|
37
|
-
return t;
|
|
38
|
-
};
|
|
39
|
-
return __assign.apply(this, arguments);
|
|
40
|
-
};
|
|
41
|
-
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
42
|
-
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
43
|
-
return new (P || (P = Promise))(function (resolve, reject) {
|
|
44
|
-
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
45
|
-
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
46
|
-
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
47
|
-
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
48
|
-
});
|
|
49
|
-
};
|
|
50
|
-
var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
51
|
-
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
|
|
52
|
-
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
|
|
53
|
-
function verb(n) { return function (v) { return step([n, v]); }; }
|
|
54
|
-
function step(op) {
|
|
55
|
-
if (f) throw new TypeError("Generator is already executing.");
|
|
56
|
-
while (g && (g = 0, op[0] && (_ = 0)), _) try {
|
|
57
|
-
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
|
|
58
|
-
if (y = 0, t) op = [op[0] & 2, t.value];
|
|
59
|
-
switch (op[0]) {
|
|
60
|
-
case 0: case 1: t = op; break;
|
|
61
|
-
case 4: _.label++; return { value: op[1], done: false };
|
|
62
|
-
case 5: _.label++; y = op[1]; op = [0]; continue;
|
|
63
|
-
case 7: op = _.ops.pop(); _.trys.pop(); continue;
|
|
64
|
-
default:
|
|
65
|
-
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
|
|
66
|
-
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
|
|
67
|
-
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
|
|
68
|
-
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
|
|
69
|
-
if (t[2]) _.ops.pop();
|
|
70
|
-
_.trys.pop(); continue;
|
|
71
|
-
}
|
|
72
|
-
op = body.call(thisArg, _);
|
|
73
|
-
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
|
|
74
|
-
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
|
|
75
|
-
}
|
|
76
|
-
};
|
|
77
|
-
var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
|
|
78
|
-
if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
|
|
79
|
-
if (ar || !(i in from)) {
|
|
80
|
-
if (!ar) ar = Array.prototype.slice.call(from, 0, i);
|
|
81
|
-
ar[i] = from[i];
|
|
82
|
-
}
|
|
83
|
-
}
|
|
84
|
-
return to.concat(ar || Array.prototype.slice.call(from));
|
|
85
|
-
};
|
|
86
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
87
|
-
exports.MessagesApi = exports.MessagesApiFactory = exports.MessagesApiFp = exports.MessagesApiAxiosParamCreator = void 0;
|
|
88
|
-
var axios_1 = require("axios");
|
|
89
|
-
// Some imports not used depending on template conditions
|
|
90
|
-
// @ts-ignore
|
|
91
|
-
var common_1 = require("../common");
|
|
92
|
-
// @ts-ignore
|
|
93
|
-
var base_1 = require("../base");
|
|
94
|
-
/**
|
|
95
|
-
* MessagesApi - axios parameter creator
|
|
96
|
-
* @export
|
|
97
|
-
*/
|
|
98
|
-
var MessagesApiAxiosParamCreator = function (configuration) {
|
|
99
|
-
var _this = this;
|
|
100
|
-
return {
|
|
101
|
-
/**
|
|
102
|
-
* Endpoint for sending text messages and picture messages using V2 messaging.
|
|
103
|
-
* @summary Create Message
|
|
104
|
-
* @param {string} accountId Your Bandwidth Account ID.
|
|
105
|
-
* @param {MessageRequest} messageRequest
|
|
106
|
-
* @param {*} [options] Override http request option.
|
|
107
|
-
* @throws {RequiredError}
|
|
108
|
-
*/
|
|
109
|
-
createMessage: function (accountId_1, messageRequest_1) {
|
|
110
|
-
var args_1 = [];
|
|
111
|
-
for (var _i = 2; _i < arguments.length; _i++) {
|
|
112
|
-
args_1[_i - 2] = arguments[_i];
|
|
113
|
-
}
|
|
114
|
-
return __awaiter(_this, __spreadArray([accountId_1, messageRequest_1], args_1, true), void 0, function (accountId, messageRequest, options) {
|
|
115
|
-
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
116
|
-
if (options === void 0) { options = {}; }
|
|
117
|
-
return __generator(this, function (_a) {
|
|
118
|
-
// verify required parameter 'accountId' is not null or undefined
|
|
119
|
-
(0, common_1.assertParamExists)('createMessage', 'accountId', accountId);
|
|
120
|
-
// verify required parameter 'messageRequest' is not null or undefined
|
|
121
|
-
(0, common_1.assertParamExists)('createMessage', 'messageRequest', messageRequest);
|
|
122
|
-
localVarPath = "/users/{accountId}/messages"
|
|
123
|
-
.replace("{".concat("accountId", "}"), encodeURIComponent(String(accountId)));
|
|
124
|
-
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
125
|
-
if (configuration) {
|
|
126
|
-
baseOptions = configuration.baseOptions;
|
|
127
|
-
}
|
|
128
|
-
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
129
|
-
localVarHeaderParameter = {};
|
|
130
|
-
localVarQueryParameter = {};
|
|
131
|
-
// authentication Basic required
|
|
132
|
-
// http basic authentication required
|
|
133
|
-
(0, common_1.setBasicAuthToObject)(localVarRequestOptions, configuration);
|
|
134
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
135
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
136
|
-
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
137
|
-
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
138
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(messageRequest, localVarRequestOptions, configuration);
|
|
139
|
-
return [2 /*return*/, {
|
|
140
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
141
|
-
options: localVarRequestOptions,
|
|
142
|
-
}];
|
|
143
|
-
});
|
|
144
|
-
});
|
|
145
|
-
},
|
|
146
|
-
/**
|
|
147
|
-
* Returns a list of messages based on query parameters.
|
|
148
|
-
* @summary List Messages
|
|
149
|
-
* @param {string} accountId Your Bandwidth Account ID.
|
|
150
|
-
* @param {string} [messageId] The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter.
|
|
151
|
-
* @param {string} [sourceTn] The phone number that sent the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. \'%2B1919\').
|
|
152
|
-
* @param {string} [destinationTn] The phone number that received the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. \'%2B1919\').
|
|
153
|
-
* @param {MessageStatusEnum} [messageStatus] The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED.
|
|
154
|
-
* @param {ListMessageDirectionEnum} [messageDirection] The direction of the message. One of INBOUND OUTBOUND.
|
|
155
|
-
* @param {string} [carrierName] The name of the carrier used for this message. Possible values include but are not limited to Verizon and TMobile. Special characters need to be encoded using URL encoding (i.e. AT&T should be passed as AT%26T).
|
|
156
|
-
* @param {MessageTypeEnum} [messageType] The type of message. Either sms or mms.
|
|
157
|
-
* @param {number} [errorCode] The error code of the message.
|
|
158
|
-
* @param {string} [fromDateTime] The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
|
|
159
|
-
* @param {string} [toDateTime] The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
|
|
160
|
-
* @param {string} [campaignId] The campaign ID of the message.
|
|
161
|
-
* @param {string} [sort] The field and direction to sort by combined with a colon. Direction is either asc or desc.
|
|
162
|
-
* @param {string} [pageToken] A base64 encoded value used for pagination of results.
|
|
163
|
-
* @param {number} [limit] The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000.
|
|
164
|
-
* @param {boolean} [limitTotalCount] When set to true, the response\'s totalCount field will have a maximum value of 10,000. When set to false, or excluded, this will give an accurate totalCount of all messages that match the provided filters. If you are experiencing latency, try using this parameter to limit your results.
|
|
165
|
-
* @param {*} [options] Override http request option.
|
|
166
|
-
* @throws {RequiredError}
|
|
167
|
-
*/
|
|
168
|
-
listMessages: function (accountId_1, messageId_1, sourceTn_1, destinationTn_1, messageStatus_1, messageDirection_1, carrierName_1, messageType_1, errorCode_1, fromDateTime_1, toDateTime_1, campaignId_1, sort_1, pageToken_1, limit_1, limitTotalCount_1) {
|
|
169
|
-
var args_1 = [];
|
|
170
|
-
for (var _i = 16; _i < arguments.length; _i++) {
|
|
171
|
-
args_1[_i - 16] = arguments[_i];
|
|
172
|
-
}
|
|
173
|
-
return __awaiter(_this, __spreadArray([accountId_1, messageId_1, sourceTn_1, destinationTn_1, messageStatus_1, messageDirection_1, carrierName_1, messageType_1, errorCode_1, fromDateTime_1, toDateTime_1, campaignId_1, sort_1, pageToken_1, limit_1, limitTotalCount_1], args_1, true), void 0, function (accountId, messageId, sourceTn, destinationTn, messageStatus, messageDirection, carrierName, messageType, errorCode, fromDateTime, toDateTime, campaignId, sort, pageToken, limit, limitTotalCount, options) {
|
|
174
|
-
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
175
|
-
if (options === void 0) { options = {}; }
|
|
176
|
-
return __generator(this, function (_a) {
|
|
177
|
-
// verify required parameter 'accountId' is not null or undefined
|
|
178
|
-
(0, common_1.assertParamExists)('listMessages', 'accountId', accountId);
|
|
179
|
-
localVarPath = "/users/{accountId}/messages"
|
|
180
|
-
.replace("{".concat("accountId", "}"), encodeURIComponent(String(accountId)));
|
|
181
|
-
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
182
|
-
if (configuration) {
|
|
183
|
-
baseOptions = configuration.baseOptions;
|
|
184
|
-
}
|
|
185
|
-
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
186
|
-
localVarHeaderParameter = {};
|
|
187
|
-
localVarQueryParameter = {};
|
|
188
|
-
// authentication Basic required
|
|
189
|
-
// http basic authentication required
|
|
190
|
-
(0, common_1.setBasicAuthToObject)(localVarRequestOptions, configuration);
|
|
191
|
-
if (messageId !== undefined) {
|
|
192
|
-
localVarQueryParameter['messageId'] = messageId;
|
|
193
|
-
}
|
|
194
|
-
if (sourceTn !== undefined) {
|
|
195
|
-
localVarQueryParameter['sourceTn'] = sourceTn;
|
|
196
|
-
}
|
|
197
|
-
if (destinationTn !== undefined) {
|
|
198
|
-
localVarQueryParameter['destinationTn'] = destinationTn;
|
|
199
|
-
}
|
|
200
|
-
if (messageStatus !== undefined) {
|
|
201
|
-
localVarQueryParameter['messageStatus'] = messageStatus;
|
|
202
|
-
}
|
|
203
|
-
if (messageDirection !== undefined) {
|
|
204
|
-
localVarQueryParameter['messageDirection'] = messageDirection;
|
|
205
|
-
}
|
|
206
|
-
if (carrierName !== undefined) {
|
|
207
|
-
localVarQueryParameter['carrierName'] = carrierName;
|
|
208
|
-
}
|
|
209
|
-
if (messageType !== undefined) {
|
|
210
|
-
localVarQueryParameter['messageType'] = messageType;
|
|
211
|
-
}
|
|
212
|
-
if (errorCode !== undefined) {
|
|
213
|
-
localVarQueryParameter['errorCode'] = errorCode;
|
|
214
|
-
}
|
|
215
|
-
if (fromDateTime !== undefined) {
|
|
216
|
-
localVarQueryParameter['fromDateTime'] = fromDateTime;
|
|
217
|
-
}
|
|
218
|
-
if (toDateTime !== undefined) {
|
|
219
|
-
localVarQueryParameter['toDateTime'] = toDateTime;
|
|
220
|
-
}
|
|
221
|
-
if (campaignId !== undefined) {
|
|
222
|
-
localVarQueryParameter['campaignId'] = campaignId;
|
|
223
|
-
}
|
|
224
|
-
if (sort !== undefined) {
|
|
225
|
-
localVarQueryParameter['sort'] = sort;
|
|
226
|
-
}
|
|
227
|
-
if (pageToken !== undefined) {
|
|
228
|
-
localVarQueryParameter['pageToken'] = pageToken;
|
|
229
|
-
}
|
|
230
|
-
if (limit !== undefined) {
|
|
231
|
-
localVarQueryParameter['limit'] = limit;
|
|
232
|
-
}
|
|
233
|
-
if (limitTotalCount !== undefined) {
|
|
234
|
-
localVarQueryParameter['limitTotalCount'] = limitTotalCount;
|
|
235
|
-
}
|
|
236
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
237
|
-
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
238
|
-
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
239
|
-
return [2 /*return*/, {
|
|
240
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
241
|
-
options: localVarRequestOptions,
|
|
242
|
-
}];
|
|
243
|
-
});
|
|
244
|
-
});
|
|
245
|
-
},
|
|
246
|
-
};
|
|
247
|
-
};
|
|
248
|
-
exports.MessagesApiAxiosParamCreator = MessagesApiAxiosParamCreator;
|
|
249
|
-
/**
|
|
250
|
-
* MessagesApi - functional programming interface
|
|
251
|
-
* @export
|
|
252
|
-
*/
|
|
253
|
-
var MessagesApiFp = function (configuration) {
|
|
254
|
-
var localVarAxiosParamCreator = (0, exports.MessagesApiAxiosParamCreator)(configuration);
|
|
255
|
-
return {
|
|
256
|
-
/**
|
|
257
|
-
* Endpoint for sending text messages and picture messages using V2 messaging.
|
|
258
|
-
* @summary Create Message
|
|
259
|
-
* @param {string} accountId Your Bandwidth Account ID.
|
|
260
|
-
* @param {MessageRequest} messageRequest
|
|
261
|
-
* @param {*} [options] Override http request option.
|
|
262
|
-
* @throws {RequiredError}
|
|
263
|
-
*/
|
|
264
|
-
createMessage: function (accountId, messageRequest, options) {
|
|
265
|
-
return __awaiter(this, void 0, void 0, function () {
|
|
266
|
-
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
267
|
-
var _a, _b, _c;
|
|
268
|
-
return __generator(this, function (_d) {
|
|
269
|
-
switch (_d.label) {
|
|
270
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.createMessage(accountId, messageRequest, options)];
|
|
271
|
-
case 1:
|
|
272
|
-
localVarAxiosArgs = _d.sent();
|
|
273
|
-
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
274
|
-
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['MessagesApi.createMessage']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
275
|
-
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
276
|
-
}
|
|
277
|
-
});
|
|
278
|
-
});
|
|
279
|
-
},
|
|
280
|
-
/**
|
|
281
|
-
* Returns a list of messages based on query parameters.
|
|
282
|
-
* @summary List Messages
|
|
283
|
-
* @param {string} accountId Your Bandwidth Account ID.
|
|
284
|
-
* @param {string} [messageId] The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter.
|
|
285
|
-
* @param {string} [sourceTn] The phone number that sent the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. \'%2B1919\').
|
|
286
|
-
* @param {string} [destinationTn] The phone number that received the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. \'%2B1919\').
|
|
287
|
-
* @param {MessageStatusEnum} [messageStatus] The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED.
|
|
288
|
-
* @param {ListMessageDirectionEnum} [messageDirection] The direction of the message. One of INBOUND OUTBOUND.
|
|
289
|
-
* @param {string} [carrierName] The name of the carrier used for this message. Possible values include but are not limited to Verizon and TMobile. Special characters need to be encoded using URL encoding (i.e. AT&T should be passed as AT%26T).
|
|
290
|
-
* @param {MessageTypeEnum} [messageType] The type of message. Either sms or mms.
|
|
291
|
-
* @param {number} [errorCode] The error code of the message.
|
|
292
|
-
* @param {string} [fromDateTime] The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
|
|
293
|
-
* @param {string} [toDateTime] The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
|
|
294
|
-
* @param {string} [campaignId] The campaign ID of the message.
|
|
295
|
-
* @param {string} [sort] The field and direction to sort by combined with a colon. Direction is either asc or desc.
|
|
296
|
-
* @param {string} [pageToken] A base64 encoded value used for pagination of results.
|
|
297
|
-
* @param {number} [limit] The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000.
|
|
298
|
-
* @param {boolean} [limitTotalCount] When set to true, the response\'s totalCount field will have a maximum value of 10,000. When set to false, or excluded, this will give an accurate totalCount of all messages that match the provided filters. If you are experiencing latency, try using this parameter to limit your results.
|
|
299
|
-
* @param {*} [options] Override http request option.
|
|
300
|
-
* @throws {RequiredError}
|
|
301
|
-
*/
|
|
302
|
-
listMessages: function (accountId, messageId, sourceTn, destinationTn, messageStatus, messageDirection, carrierName, messageType, errorCode, fromDateTime, toDateTime, campaignId, sort, pageToken, limit, limitTotalCount, options) {
|
|
303
|
-
return __awaiter(this, void 0, void 0, function () {
|
|
304
|
-
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
305
|
-
var _a, _b, _c;
|
|
306
|
-
return __generator(this, function (_d) {
|
|
307
|
-
switch (_d.label) {
|
|
308
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listMessages(accountId, messageId, sourceTn, destinationTn, messageStatus, messageDirection, carrierName, messageType, errorCode, fromDateTime, toDateTime, campaignId, sort, pageToken, limit, limitTotalCount, options)];
|
|
309
|
-
case 1:
|
|
310
|
-
localVarAxiosArgs = _d.sent();
|
|
311
|
-
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
312
|
-
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['MessagesApi.listMessages']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
313
|
-
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
314
|
-
}
|
|
315
|
-
});
|
|
316
|
-
});
|
|
317
|
-
},
|
|
318
|
-
};
|
|
319
|
-
};
|
|
320
|
-
exports.MessagesApiFp = MessagesApiFp;
|
|
321
|
-
/**
|
|
322
|
-
* MessagesApi - factory interface
|
|
323
|
-
* @export
|
|
324
|
-
*/
|
|
325
|
-
var MessagesApiFactory = function (configuration, basePath, axios) {
|
|
326
|
-
var localVarFp = (0, exports.MessagesApiFp)(configuration);
|
|
327
|
-
return {
|
|
328
|
-
/**
|
|
329
|
-
* Endpoint for sending text messages and picture messages using V2 messaging.
|
|
330
|
-
* @summary Create Message
|
|
331
|
-
* @param {string} accountId Your Bandwidth Account ID.
|
|
332
|
-
* @param {MessageRequest} messageRequest
|
|
333
|
-
* @param {*} [options] Override http request option.
|
|
334
|
-
* @throws {RequiredError}
|
|
335
|
-
*/
|
|
336
|
-
createMessage: function (accountId, messageRequest, options) {
|
|
337
|
-
return localVarFp.createMessage(accountId, messageRequest, options).then(function (request) { return request(axios, basePath); });
|
|
338
|
-
},
|
|
339
|
-
/**
|
|
340
|
-
* Returns a list of messages based on query parameters.
|
|
341
|
-
* @summary List Messages
|
|
342
|
-
* @param {string} accountId Your Bandwidth Account ID.
|
|
343
|
-
* @param {string} [messageId] The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter.
|
|
344
|
-
* @param {string} [sourceTn] The phone number that sent the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. \'%2B1919\').
|
|
345
|
-
* @param {string} [destinationTn] The phone number that received the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. \'%2B1919\').
|
|
346
|
-
* @param {MessageStatusEnum} [messageStatus] The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED.
|
|
347
|
-
* @param {ListMessageDirectionEnum} [messageDirection] The direction of the message. One of INBOUND OUTBOUND.
|
|
348
|
-
* @param {string} [carrierName] The name of the carrier used for this message. Possible values include but are not limited to Verizon and TMobile. Special characters need to be encoded using URL encoding (i.e. AT&T should be passed as AT%26T).
|
|
349
|
-
* @param {MessageTypeEnum} [messageType] The type of message. Either sms or mms.
|
|
350
|
-
* @param {number} [errorCode] The error code of the message.
|
|
351
|
-
* @param {string} [fromDateTime] The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
|
|
352
|
-
* @param {string} [toDateTime] The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
|
|
353
|
-
* @param {string} [campaignId] The campaign ID of the message.
|
|
354
|
-
* @param {string} [sort] The field and direction to sort by combined with a colon. Direction is either asc or desc.
|
|
355
|
-
* @param {string} [pageToken] A base64 encoded value used for pagination of results.
|
|
356
|
-
* @param {number} [limit] The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000.
|
|
357
|
-
* @param {boolean} [limitTotalCount] When set to true, the response\'s totalCount field will have a maximum value of 10,000. When set to false, or excluded, this will give an accurate totalCount of all messages that match the provided filters. If you are experiencing latency, try using this parameter to limit your results.
|
|
358
|
-
* @param {*} [options] Override http request option.
|
|
359
|
-
* @throws {RequiredError}
|
|
360
|
-
*/
|
|
361
|
-
listMessages: function (accountId, messageId, sourceTn, destinationTn, messageStatus, messageDirection, carrierName, messageType, errorCode, fromDateTime, toDateTime, campaignId, sort, pageToken, limit, limitTotalCount, options) {
|
|
362
|
-
return localVarFp.listMessages(accountId, messageId, sourceTn, destinationTn, messageStatus, messageDirection, carrierName, messageType, errorCode, fromDateTime, toDateTime, campaignId, sort, pageToken, limit, limitTotalCount, options).then(function (request) { return request(axios, basePath); });
|
|
363
|
-
},
|
|
364
|
-
};
|
|
365
|
-
};
|
|
366
|
-
exports.MessagesApiFactory = MessagesApiFactory;
|
|
367
|
-
/**
|
|
368
|
-
* MessagesApi - object-oriented interface
|
|
369
|
-
* @export
|
|
370
|
-
* @class MessagesApi
|
|
371
|
-
* @extends {BaseAPI}
|
|
372
|
-
*/
|
|
373
|
-
var MessagesApi = /** @class */ (function (_super) {
|
|
374
|
-
__extends(MessagesApi, _super);
|
|
375
|
-
function MessagesApi() {
|
|
376
|
-
return _super !== null && _super.apply(this, arguments) || this;
|
|
377
|
-
}
|
|
378
|
-
/**
|
|
379
|
-
* Endpoint for sending text messages and picture messages using V2 messaging.
|
|
380
|
-
* @summary Create Message
|
|
381
|
-
* @param {string} accountId Your Bandwidth Account ID.
|
|
382
|
-
* @param {MessageRequest} messageRequest
|
|
383
|
-
* @param {*} [options] Override http request option.
|
|
384
|
-
* @throws {RequiredError}
|
|
385
|
-
* @memberof MessagesApi
|
|
386
|
-
*/
|
|
387
|
-
MessagesApi.prototype.createMessage = function (accountId, messageRequest, options) {
|
|
388
|
-
var _this = this;
|
|
389
|
-
return (0, exports.MessagesApiFp)(this.configuration).createMessage(accountId, messageRequest, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
390
|
-
};
|
|
391
|
-
/**
|
|
392
|
-
* Returns a list of messages based on query parameters.
|
|
393
|
-
* @summary List Messages
|
|
394
|
-
* @param {string} accountId Your Bandwidth Account ID.
|
|
395
|
-
* @param {string} [messageId] The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter.
|
|
396
|
-
* @param {string} [sourceTn] The phone number that sent the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. \'%2B1919\').
|
|
397
|
-
* @param {string} [destinationTn] The phone number that received the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. \'%2B1919\').
|
|
398
|
-
* @param {MessageStatusEnum} [messageStatus] The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED.
|
|
399
|
-
* @param {ListMessageDirectionEnum} [messageDirection] The direction of the message. One of INBOUND OUTBOUND.
|
|
400
|
-
* @param {string} [carrierName] The name of the carrier used for this message. Possible values include but are not limited to Verizon and TMobile. Special characters need to be encoded using URL encoding (i.e. AT&T should be passed as AT%26T).
|
|
401
|
-
* @param {MessageTypeEnum} [messageType] The type of message. Either sms or mms.
|
|
402
|
-
* @param {number} [errorCode] The error code of the message.
|
|
403
|
-
* @param {string} [fromDateTime] The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
|
|
404
|
-
* @param {string} [toDateTime] The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
|
|
405
|
-
* @param {string} [campaignId] The campaign ID of the message.
|
|
406
|
-
* @param {string} [sort] The field and direction to sort by combined with a colon. Direction is either asc or desc.
|
|
407
|
-
* @param {string} [pageToken] A base64 encoded value used for pagination of results.
|
|
408
|
-
* @param {number} [limit] The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000.
|
|
409
|
-
* @param {boolean} [limitTotalCount] When set to true, the response\'s totalCount field will have a maximum value of 10,000. When set to false, or excluded, this will give an accurate totalCount of all messages that match the provided filters. If you are experiencing latency, try using this parameter to limit your results.
|
|
410
|
-
* @param {*} [options] Override http request option.
|
|
411
|
-
* @throws {RequiredError}
|
|
412
|
-
* @memberof MessagesApi
|
|
413
|
-
*/
|
|
414
|
-
MessagesApi.prototype.listMessages = function (accountId, messageId, sourceTn, destinationTn, messageStatus, messageDirection, carrierName, messageType, errorCode, fromDateTime, toDateTime, campaignId, sort, pageToken, limit, limitTotalCount, options) {
|
|
415
|
-
var _this = this;
|
|
416
|
-
return (0, exports.MessagesApiFp)(this.configuration).listMessages(accountId, messageId, sourceTn, destinationTn, messageStatus, messageDirection, carrierName, messageType, errorCode, fromDateTime, toDateTime, campaignId, sort, pageToken, limit, limitTotalCount, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
417
|
-
};
|
|
418
|
-
return MessagesApi;
|
|
419
|
-
}(base_1.BaseAPI));
|
|
420
|
-
exports.MessagesApi = MessagesApi;
|