bandwidth-sdk 6.1.0 → 6.2.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/.openapi-generator/FILES +6 -0
- package/api/messages-api.ts +105 -7
- package/api/phone-number-lookup-api.ts +8 -0
- package/api/transcriptions-api.ts +16 -16
- package/bandwidth.yml +272 -15
- package/configuration.ts +1 -1
- package/coverage/clover.xml +175 -136
- package/coverage/coverage-final.json +8 -5
- package/coverage/lcov-report/block-navigation.js +1 -1
- package/coverage/lcov-report/index.html +17 -17
- package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/index.html +15 -15
- package/coverage/lcov-report/node-sdk/api/media-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +309 -15
- package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/multi-channel-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +26 -2
- package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/toll-free-verification-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/transcriptions-api.ts.html +17 -17
- package/coverage/lcov-report/node-sdk/api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/base.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/common.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/configuration.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/index.html +1 -1
- package/coverage/lcov-report/node-sdk/models/business-entity-type-enum.ts.html +187 -0
- package/coverage/lcov-report/node-sdk/models/business-registration-type-enum.ts.html +178 -0
- 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 +5 -2
- 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 +1 -1
- package/coverage/lcov-report/node-sdk/models/call-state-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/call-transcription-detected-language-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/call-transcription-track-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/callback-method-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/card-width-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/conference-state-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/file-format-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/inbound-callback-type-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/index.html +50 -5
- package/coverage/lcov-report/node-sdk/models/index.ts.html +13 -4
- package/coverage/lcov-report/node-sdk/models/list-message-direction-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/lookup-status-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/machine-detection-mode-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/message-direction-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/message-status-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/message-type-enum.ts.html +6 -3
- package/coverage/lcov-report/node-sdk/models/multi-channel-message-channel-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/priority-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/product-type-enum.ts.html +199 -0
- package/coverage/lcov-report/node-sdk/models/rbm-action-type-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/rbm-media-height-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/recording-state-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/redirect-method-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/standalone-card-orientation-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/status-callback-type-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/tfv-callback-status-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/tfv-status-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/thumbnail-alignment-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/webhook-subscription-type-enum.ts.html +1 -1
- package/coverage/lcov-report/sorter.js +21 -7
- package/coverage/lcov.info +343 -274
- package/dist/api/calls-api.d.ts +5 -5
- package/dist/api/conferences-api.d.ts +9 -9
- package/dist/api/media-api.d.ts +4 -4
- package/dist/api/messages-api.d.ts +54 -5
- package/dist/api/messages-api.js +94 -10
- package/dist/api/mfaapi.d.ts +3 -3
- package/dist/api/multi-channel-api.d.ts +1 -1
- package/dist/api/phone-number-lookup-api.d.ts +10 -2
- package/dist/api/phone-number-lookup-api.js +8 -0
- package/dist/api/recordings-api.d.ts +10 -10
- package/dist/api/statistics-api.d.ts +1 -1
- package/dist/api/toll-free-verification-api.d.ts +9 -9
- package/dist/api/transcriptions-api.d.ts +19 -19
- package/dist/api/transcriptions-api.js +16 -16
- package/dist/configuration.js +1 -1
- package/dist/models/business-entity-type-enum.d.ts +24 -0
- package/dist/models/business-entity-type-enum.js +28 -0
- package/dist/models/business-registration-type-enum.d.ts +21 -0
- package/dist/models/business-registration-type-enum.js +25 -0
- package/dist/models/bxml/verbs/StopStream.d.ts +1 -0
- package/dist/models/call-state.d.ts +1 -1
- package/dist/models/call-transcription-metadata.d.ts +1 -1
- package/dist/models/conference-member.d.ts +1 -1
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/dist/models/list-message-item.d.ts +36 -0
- package/dist/models/message-type-enum.d.ts +1 -0
- package/dist/models/message-type-enum.js +2 -1
- package/dist/models/multi-channel-message-response-data.d.ts +1 -1
- package/dist/models/opt-in-workflow.d.ts +6 -0
- package/dist/models/product-type-enum.d.ts +28 -0
- package/dist/models/product-type-enum.js +32 -0
- package/dist/models/stir-shaken.d.ts +1 -1
- package/dist/models/tfv-submission-info.d.ts +20 -0
- package/dist/models/verification-request.d.ts +32 -0
- package/dist/models/verification-update-request.d.ts +32 -0
- package/docs/BusinessEntityTypeEnum.md +17 -0
- package/docs/BusinessRegistrationTypeEnum.md +11 -0
- package/docs/CallState.md +1 -1
- package/docs/CallTranscriptionMetadata.md +1 -1
- package/docs/ConferenceMember.md +1 -1
- package/docs/ListMessageItem.md +12 -0
- package/docs/MessageTypeEnum.md +2 -0
- package/docs/MessagesApi.md +36 -0
- package/docs/MultiChannelMessageResponseData.md +2 -2
- package/docs/OptInWorkflow.md +2 -0
- package/docs/ProductTypeEnum.md +25 -0
- package/docs/StirShaken.md +1 -1
- package/docs/TfvSubmissionInfo.md +6 -0
- package/docs/TranscriptionsApi.md +4 -4
- package/docs/VerificationRequest.md +10 -0
- package/docs/VerificationUpdateRequest.md +10 -0
- package/models/business-entity-type-enum.ts +34 -0
- package/models/business-registration-type-enum.ts +31 -0
- package/models/bxml/verbs/StopStream.ts +1 -0
- package/models/call-state.ts +1 -1
- package/models/call-transcription-metadata.ts +1 -1
- package/models/conference-member.ts +1 -1
- package/models/index.ts +3 -0
- package/models/list-message-item.ts +36 -0
- package/models/message-type-enum.ts +2 -1
- package/models/multi-channel-message-response-data.ts +1 -1
- package/models/opt-in-workflow.ts +6 -0
- package/models/product-type-enum.ts +38 -0
- package/models/stir-shaken.ts +1 -1
- package/models/tfv-submission-info.ts +26 -0
- package/models/verification-request.ts +38 -0
- package/models/verification-update-request.ts +38 -0
- package/package.json +1 -1
- package/tests/smoke/bxml.test.ts +2 -1
- package/tests/smoke/messages-api.test.ts +6 -1
- package/tests/unit/api/messages-api.test.ts +6 -0
- package/tests/unit/models/business-entity-type-enum.test.ts +11 -0
- package/tests/unit/models/business-registration-type-enum.test.ts +8 -0
- package/tests/unit/models/bxml/verbs/StopStream.test.ts +3 -2
- package/tests/unit/models/message-type-enum.test.ts +1 -0
- package/tests/unit/models/product-type-enum.test.ts +15 -0
package/bandwidth.yml
CHANGED
|
@@ -179,6 +179,18 @@ paths:
|
|
|
179
179
|
- $ref: '#/components/parameters/fromDateTime'
|
|
180
180
|
- $ref: '#/components/parameters/toDateTime'
|
|
181
181
|
- $ref: '#/components/parameters/campaignId'
|
|
182
|
+
- $ref: '#/components/parameters/fromBwLatency'
|
|
183
|
+
- $ref: '#/components/parameters/bwQueued'
|
|
184
|
+
- $ref: '#/components/parameters/product'
|
|
185
|
+
- $ref: '#/components/parameters/location'
|
|
186
|
+
- $ref: '#/components/parameters/carrierQueued'
|
|
187
|
+
- $ref: '#/components/parameters/fromCarrierLatency'
|
|
188
|
+
- $ref: '#/components/parameters/callingNumberCountryA3'
|
|
189
|
+
- $ref: '#/components/parameters/calledNumberCountryA3'
|
|
190
|
+
- $ref: '#/components/parameters/fromSegmentCount'
|
|
191
|
+
- $ref: '#/components/parameters/toSegmentCount'
|
|
192
|
+
- $ref: '#/components/parameters/fromMessageSize'
|
|
193
|
+
- $ref: '#/components/parameters/toMessageSize'
|
|
182
194
|
- $ref: '#/components/parameters/sort'
|
|
183
195
|
- $ref: '#/components/parameters/pageToken'
|
|
184
196
|
- $ref: '#/components/parameters/limit'
|
|
@@ -1145,9 +1157,9 @@ paths:
|
|
|
1145
1157
|
get:
|
|
1146
1158
|
tags:
|
|
1147
1159
|
- Transcriptions
|
|
1148
|
-
summary:
|
|
1160
|
+
summary: List Real-time Transcriptions
|
|
1149
1161
|
description: >-
|
|
1150
|
-
|
|
1162
|
+
List the transcriptions created on this call via
|
|
1151
1163
|
[startTranscription](/docs/voice/bxml/startTranscription).
|
|
1152
1164
|
operationId: listRealTimeTranscriptions
|
|
1153
1165
|
parameters:
|
|
@@ -1177,7 +1189,7 @@ paths:
|
|
|
1177
1189
|
get:
|
|
1178
1190
|
tags:
|
|
1179
1191
|
- Transcriptions
|
|
1180
|
-
summary:
|
|
1192
|
+
summary: Get Real-time Transcription
|
|
1181
1193
|
description: >-
|
|
1182
1194
|
Retrieve the specified transcription that was created on this call via
|
|
1183
1195
|
[startTranscription](/docs/voice/bxml/startTranscription).
|
|
@@ -1208,7 +1220,7 @@ paths:
|
|
|
1208
1220
|
delete:
|
|
1209
1221
|
tags:
|
|
1210
1222
|
- Transcriptions
|
|
1211
|
-
summary: Delete
|
|
1223
|
+
summary: Delete Real-time Transcription
|
|
1212
1224
|
description: >-
|
|
1213
1225
|
Delete the specified transcription that was created on this call via
|
|
1214
1226
|
[startTranscription](/docs/voice/bxml/startTranscription).
|
|
@@ -1318,6 +1330,7 @@ paths:
|
|
|
1318
1330
|
servers: *ref_2
|
|
1319
1331
|
/accounts/{accountId}/tnlookup:
|
|
1320
1332
|
post:
|
|
1333
|
+
deprecated: true
|
|
1321
1334
|
summary: Create Lookup
|
|
1322
1335
|
description: Create a Phone Number Lookup Request.
|
|
1323
1336
|
operationId: createLookup
|
|
@@ -1347,6 +1360,7 @@ paths:
|
|
|
1347
1360
|
description: Production
|
|
1348
1361
|
/accounts/{accountId}/tnlookup/{requestId}:
|
|
1349
1362
|
get:
|
|
1363
|
+
deprecated: true
|
|
1350
1364
|
summary: Get Lookup Request Status
|
|
1351
1365
|
description: Get an existing Phone Number Lookup Request.
|
|
1352
1366
|
operationId: getLookupStatus
|
|
@@ -1716,7 +1730,22 @@ components:
|
|
|
1716
1730
|
enum:
|
|
1717
1731
|
- sms
|
|
1718
1732
|
- mms
|
|
1733
|
+
- rcs
|
|
1719
1734
|
example: sms
|
|
1735
|
+
productTypeEnum:
|
|
1736
|
+
type: string
|
|
1737
|
+
description: The type of product associated with the message.
|
|
1738
|
+
enum:
|
|
1739
|
+
- LOCAL_A2P
|
|
1740
|
+
- P2P
|
|
1741
|
+
- SHORT_CODE_REACH
|
|
1742
|
+
- TOLL_FREE
|
|
1743
|
+
- HOSTED_SHORT_CODE
|
|
1744
|
+
- ALPHA_NUMERIC
|
|
1745
|
+
- RBM_MEDIA
|
|
1746
|
+
- RBM_RICH
|
|
1747
|
+
- RBM_CONVERSATIONAL
|
|
1748
|
+
example: P2P
|
|
1720
1749
|
fieldError:
|
|
1721
1750
|
type: object
|
|
1722
1751
|
properties:
|
|
@@ -1819,6 +1848,41 @@ components:
|
|
|
1819
1848
|
description: The campaign ID of the message if it has one.
|
|
1820
1849
|
nullable: true
|
|
1821
1850
|
example: CJEUMDK
|
|
1851
|
+
bwLatency:
|
|
1852
|
+
type: integer
|
|
1853
|
+
description: >-
|
|
1854
|
+
The Bandwidth latency of the message in seconds. Only available for
|
|
1855
|
+
accounts with the Advanced Quality Metrics feature enabled.
|
|
1856
|
+
nullable: true
|
|
1857
|
+
example: 20
|
|
1858
|
+
carrierLatency:
|
|
1859
|
+
type: integer
|
|
1860
|
+
description: >-
|
|
1861
|
+
The carrier latency of the message in seconds. Only available for
|
|
1862
|
+
OUTBOUND messages from accounts with the Advanced Quality Metrics
|
|
1863
|
+
feature enabled.
|
|
1864
|
+
nullable: true
|
|
1865
|
+
example: 20
|
|
1866
|
+
callingNumberCountryA3:
|
|
1867
|
+
type: string
|
|
1868
|
+
description: The A3 country code of the calling number.
|
|
1869
|
+
nullable: true
|
|
1870
|
+
example: USA
|
|
1871
|
+
calledNumberCountryA3:
|
|
1872
|
+
type: string
|
|
1873
|
+
description: The A3 country code of the called number.
|
|
1874
|
+
nullable: true
|
|
1875
|
+
example: USA
|
|
1876
|
+
product:
|
|
1877
|
+
type: string
|
|
1878
|
+
description: The messaging product associated with the message.
|
|
1879
|
+
nullable: true
|
|
1880
|
+
example: P2P
|
|
1881
|
+
location:
|
|
1882
|
+
type: string
|
|
1883
|
+
description: The location ID associated with this message.
|
|
1884
|
+
nullable: true
|
|
1885
|
+
example: 123ID
|
|
1822
1886
|
pageInfo:
|
|
1823
1887
|
title: PageInfo
|
|
1824
1888
|
type: object
|
|
@@ -1867,7 +1931,7 @@ components:
|
|
|
1867
1931
|
required:
|
|
1868
1932
|
- type
|
|
1869
1933
|
- description
|
|
1870
|
-
|
|
1934
|
+
id:
|
|
1871
1935
|
type: string
|
|
1872
1936
|
description: The ID of the message.
|
|
1873
1937
|
example: 1589228074636lm4k2je7j7jklbn2
|
|
@@ -2487,8 +2551,8 @@ components:
|
|
|
2487
2551
|
description: The data returned in a multichannel message response.
|
|
2488
2552
|
type: object
|
|
2489
2553
|
properties:
|
|
2490
|
-
|
|
2491
|
-
$ref: '#/components/schemas/
|
|
2554
|
+
id:
|
|
2555
|
+
$ref: '#/components/schemas/id'
|
|
2492
2556
|
time:
|
|
2493
2557
|
description: The time the message was received by the Bandwidth API.
|
|
2494
2558
|
type: string
|
|
@@ -2524,7 +2588,7 @@ components:
|
|
|
2524
2588
|
expiration:
|
|
2525
2589
|
$ref: '#/components/schemas/expiration'
|
|
2526
2590
|
required:
|
|
2527
|
-
-
|
|
2591
|
+
- id
|
|
2528
2592
|
- time
|
|
2529
2593
|
- direction
|
|
2530
2594
|
- to
|
|
@@ -3295,7 +3359,7 @@ components:
|
|
|
3295
3359
|
|
|
3296
3360
|
| verstat | (optional) The verification status indicating whether
|
|
3297
3361
|
the verification was successful or not. Possible values are
|
|
3298
|
-
`TN-
|
|
3362
|
+
`TN-Validation-Passed` or `TN-Validation-Failed`. |
|
|
3299
3363
|
|
|
3300
3364
|
| attestationIndicator | (optional) The attestation level verified
|
|
3301
3365
|
by Bandwidth. Possible values are `A` (full), `B` (partial) or `C`
|
|
@@ -3313,7 +3377,7 @@ components:
|
|
|
3313
3377
|
additionalProperties:
|
|
3314
3378
|
type: string
|
|
3315
3379
|
example:
|
|
3316
|
-
verstat: TN-
|
|
3380
|
+
verstat: TN-Validation-Passed
|
|
3317
3381
|
attestationIndicator: A
|
|
3318
3382
|
originatingId: abc123
|
|
3319
3383
|
identity:
|
|
@@ -3676,11 +3740,12 @@ components:
|
|
|
3676
3740
|
the state of this conference member. This is the URL of this
|
|
3677
3741
|
member's
|
|
3678
3742
|
|
|
3679
|
-
[Get Conference
|
|
3743
|
+
[Get Conference
|
|
3744
|
+
Member](/apis/voice-apis/voice/#tag/Conferences/operation/getConferenceMember)
|
|
3680
3745
|
endpoint
|
|
3681
3746
|
|
|
3682
3747
|
and [Modify Conference
|
|
3683
|
-
Member](/apis/voice/#operation/updateConferenceMember)
|
|
3748
|
+
Member](/apis/voice-apis/voice/#tag/Conferences/operation/updateConferenceMember)
|
|
3684
3749
|
|
|
3685
3750
|
endpoint.
|
|
3686
3751
|
example: >-
|
|
@@ -4032,7 +4097,7 @@ components:
|
|
|
4032
4097
|
points to the
|
|
4033
4098
|
|
|
4034
4099
|
[Get Call
|
|
4035
|
-
Transcription](/apis/voice/#operation/
|
|
4100
|
+
Transcription](/apis/voice-apis/voice/#tag/Transcriptions/operation/getRealTimeTranscription)
|
|
4036
4101
|
endpoint.
|
|
4037
4102
|
example: >-
|
|
4038
4103
|
https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-fef240ff-5cfc9091-8069-4863-a8c0-a4dcbbf1f1a4/transcriptions/t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b
|
|
@@ -5148,8 +5213,8 @@ components:
|
|
|
5148
5213
|
description: >-
|
|
5149
5214
|
(optional) The verification status indicating whether the
|
|
5150
5215
|
verification was successful or not. Possible values are
|
|
5151
|
-
TN-
|
|
5152
|
-
example: Tn-
|
|
5216
|
+
TN-Validation-Passed and TN-Validation-Failed.
|
|
5217
|
+
example: Tn-Validation-Passed
|
|
5153
5218
|
attestationIndicator:
|
|
5154
5219
|
type: string
|
|
5155
5220
|
description: >-
|
|
@@ -5478,6 +5543,50 @@ components:
|
|
|
5478
5543
|
description: The company 'Doing Business As'.
|
|
5479
5544
|
example: Another Company Name Inc.
|
|
5480
5545
|
type: string
|
|
5546
|
+
businessRegistrationNumber:
|
|
5547
|
+
type: string
|
|
5548
|
+
description: >-
|
|
5549
|
+
US Federal Tax ID Number (EIN) or Canada Business Number (CBN). Optional
|
|
5550
|
+
until early 2026. If a value is provided for this field, a value must be
|
|
5551
|
+
provided for `businessRegistrationType` and `businessEntityType`.
|
|
5552
|
+
Available starting October 1st, 2025.
|
|
5553
|
+
nullable: true
|
|
5554
|
+
maxLength: 500
|
|
5555
|
+
example: 12-3456789
|
|
5556
|
+
businessRegistrationTypeEnum:
|
|
5557
|
+
type: string
|
|
5558
|
+
description: >-
|
|
5559
|
+
The type of business registration number. Optional until early 2026;
|
|
5560
|
+
required if `businessRegistrationNumber` is provided. Available starting
|
|
5561
|
+
October 1st, 2025.
|
|
5562
|
+
enum:
|
|
5563
|
+
- EIN
|
|
5564
|
+
- CBN
|
|
5565
|
+
nullable: true
|
|
5566
|
+
businessEntityTypeEnum:
|
|
5567
|
+
type: string
|
|
5568
|
+
description: >-
|
|
5569
|
+
The type of registered business. If no option is applicable, please
|
|
5570
|
+
provide "SOLE_PROPRIETOR" as a value. Optional until early 2026;
|
|
5571
|
+
required if `businessRegistrationNumber` is provided. Available starting
|
|
5572
|
+
October 1st, 2025.
|
|
5573
|
+
enum:
|
|
5574
|
+
- SOLE_PROPRIETOR
|
|
5575
|
+
- PRIVATE_PROFIT
|
|
5576
|
+
- PUBLIC_PROFIT
|
|
5577
|
+
- NON_PROFIT
|
|
5578
|
+
- GOVERNMENT
|
|
5579
|
+
nullable: true
|
|
5580
|
+
helpMessageResponse:
|
|
5581
|
+
type: string
|
|
5582
|
+
description: A message that gets sent to users requesting help.
|
|
5583
|
+
nullable: true
|
|
5584
|
+
maxLength: 500
|
|
5585
|
+
example: Please contact support for assistance.
|
|
5586
|
+
ageGatedContent:
|
|
5587
|
+
type: boolean
|
|
5588
|
+
description: Indicates whether the content is age-gated.
|
|
5589
|
+
example: false
|
|
5481
5590
|
additionalDenialReason:
|
|
5482
5591
|
properties:
|
|
5483
5592
|
statusCode:
|
|
@@ -5564,6 +5673,16 @@ components:
|
|
|
5564
5673
|
$ref: '#/components/schemas/termsAndConditionsUrl'
|
|
5565
5674
|
businessDba:
|
|
5566
5675
|
$ref: '#/components/schemas/businessDba'
|
|
5676
|
+
businessRegistrationNumber:
|
|
5677
|
+
$ref: '#/components/schemas/businessRegistrationNumber'
|
|
5678
|
+
businessRegistrationType:
|
|
5679
|
+
$ref: '#/components/schemas/businessRegistrationTypeEnum'
|
|
5680
|
+
businessEntityType:
|
|
5681
|
+
$ref: '#/components/schemas/businessEntityTypeEnum'
|
|
5682
|
+
helpMessageResponse:
|
|
5683
|
+
$ref: '#/components/schemas/helpMessageResponse'
|
|
5684
|
+
ageGatedContent:
|
|
5685
|
+
$ref: '#/components/schemas/ageGatedContent'
|
|
5567
5686
|
verificationUpdateRequest:
|
|
5568
5687
|
type: object
|
|
5569
5688
|
required:
|
|
@@ -5603,6 +5722,16 @@ components:
|
|
|
5603
5722
|
$ref: '#/components/schemas/termsAndConditionsUrl'
|
|
5604
5723
|
businessDba:
|
|
5605
5724
|
$ref: '#/components/schemas/businessDba'
|
|
5725
|
+
businessRegistrationNumber:
|
|
5726
|
+
$ref: '#/components/schemas/businessRegistrationNumber'
|
|
5727
|
+
businessRegistrationType:
|
|
5728
|
+
$ref: '#/components/schemas/businessRegistrationTypeEnum'
|
|
5729
|
+
businessEntityType:
|
|
5730
|
+
$ref: '#/components/schemas/businessEntityTypeEnum'
|
|
5731
|
+
helpMessageResponse:
|
|
5732
|
+
$ref: '#/components/schemas/helpMessageResponse'
|
|
5733
|
+
ageGatedContent:
|
|
5734
|
+
$ref: '#/components/schemas/ageGatedContent'
|
|
5606
5735
|
tfvBasicAuthentication:
|
|
5607
5736
|
type: object
|
|
5608
5737
|
properties:
|
|
@@ -5806,6 +5935,12 @@ components:
|
|
|
5806
5935
|
example: https://www.example.com/path/to/resource
|
|
5807
5936
|
pattern: >-
|
|
5808
5937
|
^$|(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,253}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#()?&//=]*)
|
|
5938
|
+
confirmationResponse:
|
|
5939
|
+
type: string
|
|
5940
|
+
minLength: 0
|
|
5941
|
+
maxLength: 500
|
|
5942
|
+
nullable: true
|
|
5943
|
+
example: Thank you for opting in!
|
|
5809
5944
|
isvReseller:
|
|
5810
5945
|
type: string
|
|
5811
5946
|
description: ISV name.
|
|
@@ -6079,6 +6214,22 @@ components:
|
|
|
6079
6214
|
$ref: '#/components/schemas/termsAndConditionsUrl'
|
|
6080
6215
|
businessDba:
|
|
6081
6216
|
$ref: '#/components/schemas/businessDba'
|
|
6217
|
+
businessRegistrationNumber:
|
|
6218
|
+
$ref: '#/components/schemas/businessRegistrationNumber'
|
|
6219
|
+
description: >-
|
|
6220
|
+
US Federal Tax ID Number (EIN) or Canada Business Number (CBN).
|
|
6221
|
+
Available starting October 1st, 2025.
|
|
6222
|
+
businessRegistrationType:
|
|
6223
|
+
$ref: '#/components/schemas/businessRegistrationTypeEnum'
|
|
6224
|
+
description: >-
|
|
6225
|
+
The type of business registration number. Available starting October
|
|
6226
|
+
1st, 2025.
|
|
6227
|
+
businessEntityType:
|
|
6228
|
+
$ref: '#/components/schemas/businessEntityTypeEnum'
|
|
6229
|
+
description: >-
|
|
6230
|
+
The type of registered business. If no option is applicable, please
|
|
6231
|
+
provide "SOLE_PROPRIETOR" as a value. Available starting October
|
|
6232
|
+
1st, 2025.
|
|
6082
6233
|
tfvStatusEnum:
|
|
6083
6234
|
type: string
|
|
6084
6235
|
enum:
|
|
@@ -6940,6 +7091,112 @@ components:
|
|
|
6940
7091
|
example: CJEUMDK
|
|
6941
7092
|
schema:
|
|
6942
7093
|
type: string
|
|
7094
|
+
fromBwLatency:
|
|
7095
|
+
in: query
|
|
7096
|
+
name: fromBwLatency
|
|
7097
|
+
required: false
|
|
7098
|
+
description: >-
|
|
7099
|
+
The minimum Bandwidth latency of the message in seconds. Only available
|
|
7100
|
+
for accounts with the Advanced Quality Metrics feature enabled.
|
|
7101
|
+
example: 5
|
|
7102
|
+
schema:
|
|
7103
|
+
type: integer
|
|
7104
|
+
bwQueued:
|
|
7105
|
+
in: query
|
|
7106
|
+
name: bwQueued
|
|
7107
|
+
required: false
|
|
7108
|
+
description: >-
|
|
7109
|
+
A boolean value indicating whether the message is queued in the
|
|
7110
|
+
Bandwidth network.
|
|
7111
|
+
example: true
|
|
7112
|
+
schema:
|
|
7113
|
+
type: boolean
|
|
7114
|
+
product:
|
|
7115
|
+
in: query
|
|
7116
|
+
name: product
|
|
7117
|
+
required: false
|
|
7118
|
+
description: Messaging product associated with the message.
|
|
7119
|
+
example: P2P
|
|
7120
|
+
schema:
|
|
7121
|
+
$ref: '#/components/schemas/productTypeEnum'
|
|
7122
|
+
location:
|
|
7123
|
+
in: query
|
|
7124
|
+
name: location
|
|
7125
|
+
required: false
|
|
7126
|
+
description: Location Id associated with the message.
|
|
7127
|
+
example: 123ABC
|
|
7128
|
+
schema:
|
|
7129
|
+
type: string
|
|
7130
|
+
carrierQueued:
|
|
7131
|
+
in: query
|
|
7132
|
+
name: carrierQueued
|
|
7133
|
+
required: false
|
|
7134
|
+
description: >-
|
|
7135
|
+
A boolean value indicating whether the message is queued in the carrier
|
|
7136
|
+
network. Only available for OUTBOUND messages from accounts with the
|
|
7137
|
+
Advanced Quality Metrics feature enabled.
|
|
7138
|
+
example: true
|
|
7139
|
+
schema:
|
|
7140
|
+
type: boolean
|
|
7141
|
+
fromCarrierLatency:
|
|
7142
|
+
in: query
|
|
7143
|
+
name: fromCarrierLatency
|
|
7144
|
+
required: false
|
|
7145
|
+
description: >-
|
|
7146
|
+
The minimum carrier latency of the message in seconds. Only available
|
|
7147
|
+
for OUTBOUND messages from accounts with the Advanced Quality Metrics
|
|
7148
|
+
feature enabled.
|
|
7149
|
+
example: 50
|
|
7150
|
+
schema:
|
|
7151
|
+
type: integer
|
|
7152
|
+
callingNumberCountryA3:
|
|
7153
|
+
in: query
|
|
7154
|
+
name: callingNumberCountryA3
|
|
7155
|
+
required: false
|
|
7156
|
+
description: Calling number country in A3 format.
|
|
7157
|
+
example: USA
|
|
7158
|
+
schema:
|
|
7159
|
+
type: string
|
|
7160
|
+
calledNumberCountryA3:
|
|
7161
|
+
in: query
|
|
7162
|
+
name: calledNumberCountryA3
|
|
7163
|
+
required: false
|
|
7164
|
+
description: Called number country in A3 format.
|
|
7165
|
+
example: USA
|
|
7166
|
+
schema:
|
|
7167
|
+
type: string
|
|
7168
|
+
fromSegmentCount:
|
|
7169
|
+
in: query
|
|
7170
|
+
name: fromSegmentCount
|
|
7171
|
+
required: false
|
|
7172
|
+
description: Segment count (start range).
|
|
7173
|
+
example: 1
|
|
7174
|
+
schema:
|
|
7175
|
+
type: integer
|
|
7176
|
+
toSegmentCount:
|
|
7177
|
+
in: query
|
|
7178
|
+
name: toSegmentCount
|
|
7179
|
+
required: false
|
|
7180
|
+
description: Segment count (end range).
|
|
7181
|
+
example: 3
|
|
7182
|
+
schema:
|
|
7183
|
+
type: integer
|
|
7184
|
+
fromMessageSize:
|
|
7185
|
+
in: query
|
|
7186
|
+
name: fromMessageSize
|
|
7187
|
+
required: false
|
|
7188
|
+
description: Message size (start range).
|
|
7189
|
+
example: 100
|
|
7190
|
+
schema:
|
|
7191
|
+
type: integer
|
|
7192
|
+
toMessageSize:
|
|
7193
|
+
in: query
|
|
7194
|
+
name: toMessageSize
|
|
7195
|
+
required: false
|
|
7196
|
+
description: Message size (end range).
|
|
7197
|
+
example: 120
|
|
7198
|
+
schema:
|
|
7199
|
+
type: integer
|
|
6943
7200
|
sort:
|
|
6944
7201
|
in: query
|
|
6945
7202
|
name: sort
|
package/configuration.ts
CHANGED
|
@@ -93,7 +93,7 @@ export class Configuration {
|
|
|
93
93
|
...param.baseOptions,
|
|
94
94
|
headers: {
|
|
95
95
|
...param.baseOptions?.headers,
|
|
96
|
-
'User-Agent': "OpenAPI-Generator/6.1
|
|
96
|
+
'User-Agent': "OpenAPI-Generator/6.2.1/typescript-axios"
|
|
97
97
|
}
|
|
98
98
|
};
|
|
99
99
|
this.formDataCtor = param.formDataCtor;
|