bandwidth-sdk 7.4.1 → 8.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/.openapi-generator/FILES +0 -2
- package/README.md +0 -1
- package/api/media-api.ts +4 -4
- package/bandwidth.yml +157 -64
- package/configuration.ts +1 -1
- package/coverage/clover.xml +5 -10
- package/coverage/coverage-final.json +1 -2
- package/coverage/lcov-report/index.html +7 -7
- 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 +1 -1
- package/coverage/lcov-report/node-sdk/api/media-api.ts.html +5 -5
- package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +2 -2
- package/coverage/lcov-report/node-sdk/models/business-registration-type-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/bxml/Bxml.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/NestableVerb.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/Response.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/Root.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/Verb.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/index.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/index.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Bridge.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Conference.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/CustomParam.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Forward.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Gather.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Hangup.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Pause.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PauseRecording.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PhoneNumber.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PlayAudio.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Record.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Redirect.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/ResumeRecording.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Ring.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SendDtmf.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SipUri.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SpeakSentence.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartGather.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartRecording.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartStream.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartTranscription.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopGather.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopRecording.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopStream.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopTranscription.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StreamParam.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Tag.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Transfer.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/call-direction-enum.ts.html +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/completed-lookup-status-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/deactivation-event-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/in-progress-lookup-status-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 +5 -20
- package/coverage/lcov-report/node-sdk/models/index.ts.html +4 -7
- package/coverage/lcov-report/node-sdk/models/latest-message-delivery-status-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/line-type-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/list-message-direction-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 +1 -1
- 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 +1 -1
- 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/rbm-open-url-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/rbm-web-view-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.info +2 -13
- package/dist/api/media-api.d.ts +4 -4
- package/dist/api/media-api.js +4 -4
- package/dist/configuration.js +1 -1
- package/dist/models/business-entity-type-enum.d.ts +1 -1
- package/dist/models/business-entity-type-enum.js +1 -1
- package/dist/models/business-registration-type-enum.d.ts +1 -1
- package/dist/models/business-registration-type-enum.js +1 -1
- package/dist/models/index.d.ts +0 -1
- package/dist/models/index.js +0 -1
- package/dist/models/lookup-error-schema.d.ts +3 -3
- package/dist/models/lookup-result.d.ts +5 -1
- package/dist/models/mms-message-content-file.d.ts +1 -1
- package/dist/models/tfv-submission-info.d.ts +5 -3
- package/dist/models/verification-request.d.ts +5 -3
- package/dist/models/verification-update-request.d.ts +5 -3
- package/docs/BusinessEntityTypeEnum.md +1 -1
- package/docs/BusinessRegistrationTypeEnum.md +1 -1
- package/docs/LookupErrorSchema.md +3 -3
- package/docs/LookupResult.md +3 -1
- package/docs/MediaApi.md +1 -1
- package/docs/MmsMessageContentFile.md +1 -1
- package/docs/TfvSubmissionInfo.md +2 -2
- package/docs/VerificationRequest.md +2 -2
- package/docs/VerificationUpdateRequest.md +2 -2
- package/models/business-entity-type-enum.ts +1 -1
- package/models/business-registration-type-enum.ts +1 -1
- package/models/index.ts +0 -1
- package/models/lookup-error-schema.ts +3 -3
- package/models/lookup-result.ts +5 -1
- package/models/mms-message-content-file.ts +1 -1
- package/models/tfv-submission-info.ts +5 -5
- package/models/verification-request.ts +5 -5
- package/models/verification-update-request.ts +5 -5
- package/package.json +1 -1
- package/tests/smoke/phone-number-lookup-api.test.ts +2 -10
- package/tests/unit/api/phone-number-lookup-api.test.ts +0 -8
- package/tests/unit/api/toll-free-verification-api.test.ts +1 -1
- package/coverage/lcov-report/node-sdk/models/business-registration-issuing-country-enum.ts.html +0 -217
- package/dist/models/business-registration-issuing-country-enum.d.ts +0 -34
- package/dist/models/business-registration-issuing-country-enum.js +0 -38
- package/docs/BusinessRegistrationIssuingCountryEnum.md +0 -41
- package/models/business-registration-issuing-country-enum.ts +0 -44
- package/tests/unit/models/business-registration-issuing-country-enum.test.ts +0 -23
package/.openapi-generator/FILES
CHANGED
|
@@ -24,7 +24,6 @@ docs/BlockedWebhook.md
|
|
|
24
24
|
docs/BridgeCompleteCallback.md
|
|
25
25
|
docs/BridgeTargetCompleteCallback.md
|
|
26
26
|
docs/BusinessEntityTypeEnum.md
|
|
27
|
-
docs/BusinessRegistrationIssuingCountryEnum.md
|
|
28
27
|
docs/BusinessRegistrationTypeEnum.md
|
|
29
28
|
docs/CallDirectionEnum.md
|
|
30
29
|
docs/CallRecordingMetadata.md
|
|
@@ -214,7 +213,6 @@ models/blocked-webhook.ts
|
|
|
214
213
|
models/bridge-complete-callback.ts
|
|
215
214
|
models/bridge-target-complete-callback.ts
|
|
216
215
|
models/business-entity-type-enum.ts
|
|
217
|
-
models/business-registration-issuing-country-enum.ts
|
|
218
216
|
models/business-registration-type-enum.ts
|
|
219
217
|
models/call-direction-enum.ts
|
|
220
218
|
models/call-recording-metadata.ts
|
package/README.md
CHANGED
|
@@ -169,7 +169,6 @@ Class | Method | HTTP request | Description
|
|
|
169
169
|
- [BridgeCompleteCallback](docs/BridgeCompleteCallback.md)
|
|
170
170
|
- [BridgeTargetCompleteCallback](docs/BridgeTargetCompleteCallback.md)
|
|
171
171
|
- [BusinessEntityTypeEnum](docs/BusinessEntityTypeEnum.md)
|
|
172
|
-
- [BusinessRegistrationIssuingCountryEnum](docs/BusinessRegistrationIssuingCountryEnum.md)
|
|
173
172
|
- [BusinessRegistrationTypeEnum](docs/BusinessRegistrationTypeEnum.md)
|
|
174
173
|
- [CallDirectionEnum](docs/CallDirectionEnum.md)
|
|
175
174
|
- [CallRecordingMetadata](docs/CallRecordingMetadata.md)
|
package/api/media-api.ts
CHANGED
|
@@ -169,7 +169,7 @@ export const MediaApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
169
169
|
};
|
|
170
170
|
},
|
|
171
171
|
/**
|
|
172
|
-
* Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found [
|
|
172
|
+
* Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
|
|
173
173
|
* @summary Upload Media
|
|
174
174
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
175
175
|
* @param {string} mediaId Media ID to retrieve.
|
|
@@ -280,7 +280,7 @@ export const MediaApiFp = function(configuration?: Configuration) {
|
|
|
280
280
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
281
281
|
},
|
|
282
282
|
/**
|
|
283
|
-
* Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found [
|
|
283
|
+
* Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
|
|
284
284
|
* @summary Upload Media
|
|
285
285
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
286
286
|
* @param {string} mediaId Media ID to retrieve.
|
|
@@ -339,7 +339,7 @@ export const MediaApiFactory = function (configuration?: Configuration, basePath
|
|
|
339
339
|
return localVarFp.listMedia(accountId, continuationToken, options).then((request) => request(axios, basePath));
|
|
340
340
|
},
|
|
341
341
|
/**
|
|
342
|
-
* Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found [
|
|
342
|
+
* Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
|
|
343
343
|
* @summary Upload Media
|
|
344
344
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
345
345
|
* @param {string} mediaId Media ID to retrieve.
|
|
@@ -396,7 +396,7 @@ export class MediaApi extends BaseAPI {
|
|
|
396
396
|
}
|
|
397
397
|
|
|
398
398
|
/**
|
|
399
|
-
* Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found [
|
|
399
|
+
* Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
|
|
400
400
|
* @summary Upload Media
|
|
401
401
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
402
402
|
* @param {string} mediaId Media ID to retrieve.
|
package/bandwidth.yml
CHANGED
|
@@ -95,8 +95,8 @@ paths:
|
|
|
95
95
|
under this account, the previous file will be overwritten.
|
|
96
96
|
|
|
97
97
|
|
|
98
|
-
A list of supported media types can be found
|
|
99
|
-
|
|
98
|
+
A list of supported media types can be found at [Bandwidth
|
|
99
|
+
Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
|
|
100
100
|
operationId: uploadMedia
|
|
101
101
|
tags:
|
|
102
102
|
- Media
|
|
@@ -2255,8 +2255,8 @@ components:
|
|
|
2255
2255
|
|
|
2256
2256
|
For MMS, the API limits file size to 3.5MB. Specific carriers and
|
|
2257
2257
|
channels may have a smaller limit that could cause a large file to
|
|
2258
|
-
fail, see
|
|
2259
|
-
|
|
2258
|
+
fail, see more at [Bandwidth
|
|
2259
|
+
Support](https://www.bandwidth.com/support/en/articles/12823216-what-are-the-mms-file-size-limits)
|
|
2260
2260
|
for more details.
|
|
2261
2261
|
example: https://dev.bandwidth.com/images/bandwidth-logo.png
|
|
2262
2262
|
maxLength: 1000
|
|
@@ -5552,6 +5552,10 @@ components:
|
|
|
5552
5552
|
example: GET
|
|
5553
5553
|
lookupErrorSchema:
|
|
5554
5554
|
type: object
|
|
5555
|
+
required:
|
|
5556
|
+
- code
|
|
5557
|
+
- type
|
|
5558
|
+
- description
|
|
5555
5559
|
properties:
|
|
5556
5560
|
code:
|
|
5557
5561
|
type: string
|
|
@@ -5699,6 +5703,39 @@ components:
|
|
|
5699
5703
|
type: array
|
|
5700
5704
|
items:
|
|
5701
5705
|
$ref: '#/components/schemas/lookupErrorSchema'
|
|
5706
|
+
rcsErrorEnum:
|
|
5707
|
+
type: string
|
|
5708
|
+
description: >-
|
|
5709
|
+
[RCS-Only](#section/RCS-Only). Error encountered during RCS capability
|
|
5710
|
+
lookup. Appears as the `code` field in the top-level `errors` array.
|
|
5711
|
+
|
|
5712
|
+
|
|
5713
|
+
**RCS service pass-through codes:**
|
|
5714
|
+
|
|
5715
|
+
- `REQUEST_FAILED`: The RCS service returned this error code.
|
|
5716
|
+
|
|
5717
|
+
- `UNKNOWN_CODE`: The RCS service returned this error code.
|
|
5718
|
+
|
|
5719
|
+
- `INVALID_DESTINATION_ADDRESS`: The RCS service returned this error
|
|
5720
|
+
code.
|
|
5721
|
+
|
|
5722
|
+
- `UNKNOWN_STATUS: <code>`: The RCS service returned an unrecognized
|
|
5723
|
+
status code, where `<code>` is the raw value.
|
|
5724
|
+
|
|
5725
|
+
|
|
5726
|
+
**Service-level errors:**
|
|
5727
|
+
|
|
5728
|
+
- `MISSING_FROM_RESPONSE`: The phone number was absent from the RCS
|
|
5729
|
+
service response.
|
|
5730
|
+
|
|
5731
|
+
- `RCS_SERVICE_UNAVAILABLE`: An exception was thrown during the async
|
|
5732
|
+
RCS service call.
|
|
5733
|
+
|
|
5734
|
+
- `RCS_SERVICE_DISABLED`: RCS lookup is disabled in configuration.
|
|
5735
|
+
|
|
5736
|
+
- `EMPTY_RESPONSE`: The RCS service returned a null or empty response
|
|
5737
|
+
body.
|
|
5738
|
+
example: RCS_SERVICE_UNAVAILABLE
|
|
5702
5739
|
lookupResult:
|
|
5703
5740
|
type: object
|
|
5704
5741
|
description: Carrier information results for the specified telephone number.
|
|
@@ -5757,13 +5794,21 @@ components:
|
|
|
5757
5794
|
format: date
|
|
5758
5795
|
description: >-
|
|
5759
5796
|
[DNI-Only](#section/DNI-Only). The date bandwidth last received
|
|
5760
|
-
delivery status information for this phone number.
|
|
5797
|
+
delivery status information for this phone number.
|
|
5761
5798
|
|
|
5762
5799
|
Use this field to understand how up-to-date the
|
|
5763
5800
|
`latestMessageDeliveryStatus` is.
|
|
5764
5801
|
|
|
5765
5802
|
Value resets every time the `latestMessageDeliveryStatus` changes.
|
|
5766
5803
|
example: '2025-06-21'
|
|
5804
|
+
rcsEnabled:
|
|
5805
|
+
type: boolean
|
|
5806
|
+
description: >
|
|
5807
|
+
[RCS-Only](#section/RCS-Only). Indicates whether the phone number is
|
|
5808
|
+
capable of receiving RCS messages. Value will be null if account has
|
|
5809
|
+
RCS, but no value was returned. Absent when account does not have
|
|
5810
|
+
RCS.
|
|
5811
|
+
example: true
|
|
5767
5812
|
accountId1:
|
|
5768
5813
|
type: string
|
|
5769
5814
|
description: User's account ID.
|
|
@@ -5842,17 +5887,21 @@ components:
|
|
|
5842
5887
|
Government-issued business identifying number.
|
|
5843
5888
|
|
|
5844
5889
|
|
|
5845
|
-
**Note
|
|
5846
|
-
|
|
5847
|
-
`
|
|
5848
|
-
|
|
5890
|
+
**Note: As of October 19th, 2026 this field will be required when
|
|
5891
|
+
`businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is
|
|
5892
|
+
provided, `businessRegistrationType` and
|
|
5893
|
+
`businessRegistrationIssuingCountry` are also required.**
|
|
5849
5894
|
nullable: true
|
|
5850
5895
|
maxLength: 500
|
|
5851
5896
|
example: 12-3456789
|
|
5852
5897
|
businessRegistrationTypeEnum:
|
|
5853
5898
|
type: string
|
|
5854
|
-
description:
|
|
5899
|
+
description: >
|
|
5855
5900
|
The type of business registration number.
|
|
5901
|
+
|
|
5902
|
+
|
|
5903
|
+
**Note: As of October 19th, 2026 this field will be required when
|
|
5904
|
+
`businessRegistrationNumber` is provided.**
|
|
5856
5905
|
enum:
|
|
5857
5906
|
- EIN
|
|
5858
5907
|
- CBN
|
|
@@ -5874,20 +5923,16 @@ components:
|
|
|
5874
5923
|
- OTHER
|
|
5875
5924
|
example: EIN
|
|
5876
5925
|
nullable: true
|
|
5877
|
-
|
|
5926
|
+
businessRegistrationIssuingCountry:
|
|
5878
5927
|
type: string
|
|
5879
5928
|
description: >-
|
|
5880
5929
|
The country issuing the business registration in ISO-3166-1 alpha-3
|
|
5881
|
-
format. Alpha-2
|
|
5882
|
-
|
|
5930
|
+
format. Alpha-2 format is accepted by the API, but alpha-3 is highly
|
|
5931
|
+
encouraged.
|
|
5883
5932
|
|
|
5884
5933
|
|
|
5885
|
-
**Note
|
|
5886
|
-
|
|
5887
|
-
registration type. However, if the application cannot confidently infer
|
|
5888
|
-
the country, the submission may be rejected. To ensure the highest
|
|
5889
|
-
likelihood of acceptance, it is recommended to provide both
|
|
5890
|
-
`businessRegistrationType` and `businessRegistrationIssuingCountry`.
|
|
5934
|
+
**Note: As of October 19th, 2026 this field will be required when
|
|
5935
|
+
`businessRegistrationNumber` is provided.**
|
|
5891
5936
|
|
|
5892
5937
|
|
|
5893
5938
|
| Registration Type | Supported Countries |
|
|
@@ -5929,30 +5974,22 @@ components:
|
|
|
5929
5974
|
| UID | CHE |
|
|
5930
5975
|
|
|
5931
5976
|
| OTHER | Must Provide Country Code |
|
|
5932
|
-
enum:
|
|
5933
|
-
- USA
|
|
5934
|
-
- CAN
|
|
5935
|
-
- HKG
|
|
5936
|
-
- GBR
|
|
5937
|
-
- IRL
|
|
5938
|
-
- BRA
|
|
5939
|
-
- NLD
|
|
5940
|
-
- AUS
|
|
5941
|
-
- FRA
|
|
5942
|
-
- NZL
|
|
5943
|
-
- DEU
|
|
5944
|
-
- ESP
|
|
5945
|
-
- CHE
|
|
5946
|
-
- CYP
|
|
5947
|
-
- IND
|
|
5948
|
-
- CHN
|
|
5949
|
-
- BGR
|
|
5950
5977
|
example: USA
|
|
5951
|
-
nullable:
|
|
5978
|
+
nullable: true
|
|
5952
5979
|
businessEntityTypeEnum:
|
|
5953
5980
|
type: string
|
|
5954
|
-
description:
|
|
5981
|
+
description: >
|
|
5955
5982
|
The type of registered business.
|
|
5983
|
+
|
|
5984
|
+
|
|
5985
|
+
**Note: As of October 19th, 2026 submissions using a value other than
|
|
5986
|
+
`SOLE_PROPRIETOR` must provide a value for `businessRegistrationNumber`,
|
|
5987
|
+
`businessRegistrationType`, and `businessRegistrationIssuingCountry`.
|
|
5988
|
+
|
|
5989
|
+
Submissions using `SOLE_PROPRIETOR` must _omit_
|
|
5990
|
+
`businessRegistrationNumber`, `businessRegistrationType`, and
|
|
5991
|
+
`businessRegistrationIssuingCountry`. Failure to adhere to these
|
|
5992
|
+
constraints will result in a 400 Bad Request rejection.**
|
|
5956
5993
|
enum:
|
|
5957
5994
|
- SOLE_PROPRIETOR
|
|
5958
5995
|
- PRIVATE_PROFIT
|
|
@@ -6061,7 +6098,7 @@ components:
|
|
|
6061
6098
|
businessRegistrationType:
|
|
6062
6099
|
$ref: '#/components/schemas/businessRegistrationTypeEnum'
|
|
6063
6100
|
businessRegistrationIssuingCountry:
|
|
6064
|
-
$ref: '#/components/schemas/
|
|
6101
|
+
$ref: '#/components/schemas/businessRegistrationIssuingCountry'
|
|
6065
6102
|
businessEntityType:
|
|
6066
6103
|
$ref: '#/components/schemas/businessEntityTypeEnum'
|
|
6067
6104
|
helpMessageResponse:
|
|
@@ -6116,7 +6153,7 @@ components:
|
|
|
6116
6153
|
businessEntityType:
|
|
6117
6154
|
$ref: '#/components/schemas/businessEntityTypeEnum'
|
|
6118
6155
|
businessRegistrationIssuingCountry:
|
|
6119
|
-
$ref: '#/components/schemas/
|
|
6156
|
+
$ref: '#/components/schemas/businessRegistrationIssuingCountry'
|
|
6120
6157
|
helpMessageResponse:
|
|
6121
6158
|
$ref: '#/components/schemas/helpMessageResponse'
|
|
6122
6159
|
ageGatedContent:
|
|
@@ -6612,13 +6649,15 @@ components:
|
|
|
6612
6649
|
description: Government-issued business identifying number.
|
|
6613
6650
|
businessRegistrationType:
|
|
6614
6651
|
$ref: '#/components/schemas/businessRegistrationTypeEnum'
|
|
6652
|
+
description: The type of business registration number.
|
|
6615
6653
|
businessRegistrationIssuingCountry:
|
|
6616
|
-
$ref: '#/components/schemas/
|
|
6654
|
+
$ref: '#/components/schemas/businessRegistrationIssuingCountry'
|
|
6617
6655
|
description: >-
|
|
6618
6656
|
The country issuing the business registration in ISO-3166-1 alpha-3
|
|
6619
6657
|
format.
|
|
6620
6658
|
businessEntityType:
|
|
6621
6659
|
$ref: '#/components/schemas/businessEntityTypeEnum'
|
|
6660
|
+
description: The type of registered business.
|
|
6622
6661
|
tfvStatusEnum:
|
|
6623
6662
|
type: string
|
|
6624
6663
|
enum:
|
|
@@ -7149,6 +7188,10 @@ components:
|
|
|
7149
7188
|
$ref: '#/components/examples/lookupCompleteWithDniExample'
|
|
7150
7189
|
lookupCompleteExample:
|
|
7151
7190
|
$ref: '#/components/examples/lookupCompleteExample'
|
|
7191
|
+
lookupCompleteWithRcsExample:
|
|
7192
|
+
$ref: '#/components/examples/lookupCompleteWithRcsExample'
|
|
7193
|
+
lookupCompleteWithRcsErrorExample:
|
|
7194
|
+
$ref: '#/components/examples/lookupCompleteWithRcsErrorExample'
|
|
7152
7195
|
lookupPartialExample:
|
|
7153
7196
|
$ref: '#/components/examples/lookupPartialExample'
|
|
7154
7197
|
lookupFailedExample:
|
|
@@ -7160,8 +7203,8 @@ components:
|
|
|
7160
7203
|
schema:
|
|
7161
7204
|
$ref: '#/components/schemas/createAsyncBulkLookupResponse'
|
|
7162
7205
|
examples:
|
|
7163
|
-
|
|
7164
|
-
$ref: '#/components/examples/
|
|
7206
|
+
lookupAcceptedExample:
|
|
7207
|
+
$ref: '#/components/examples/lookupAcceptedExample'
|
|
7165
7208
|
getAsyncBulkLookupResponse:
|
|
7166
7209
|
description: OK
|
|
7167
7210
|
content:
|
|
@@ -8049,25 +8092,32 @@ components:
|
|
|
8049
8092
|
phoneNumbers:
|
|
8050
8093
|
- '+19196104423'
|
|
8051
8094
|
- '+19196104424'
|
|
8052
|
-
|
|
8053
|
-
summary: Numbers Lookup
|
|
8095
|
+
lookupAcceptedExample:
|
|
8096
|
+
summary: Numbers Lookup Accepted
|
|
8054
8097
|
value:
|
|
8055
8098
|
links:
|
|
8056
|
-
- href:
|
|
8057
|
-
|
|
8099
|
+
- href: >-
|
|
8100
|
+
/accounts/9912345/phoneNumberLookup/bulk/004223a0-8b17-41b1-bf81-20732adf5590
|
|
8101
|
+
rel: createdRequest
|
|
8058
8102
|
method: GET
|
|
8059
8103
|
data:
|
|
8060
8104
|
requestId: 004223a0-8b17-41b1-bf81-20732adf5590
|
|
8061
8105
|
status: IN_PROGRESS
|
|
8062
8106
|
results: []
|
|
8063
8107
|
errors: []
|
|
8108
|
+
lookupInProgressExample:
|
|
8109
|
+
summary: Numbers Lookup In Progress
|
|
8110
|
+
value:
|
|
8111
|
+
links: []
|
|
8112
|
+
data:
|
|
8113
|
+
requestId: 004223a0-8b17-41b1-bf81-20732adf5590
|
|
8114
|
+
status: IN_PROGRESS
|
|
8115
|
+
results: []
|
|
8116
|
+
errors: []
|
|
8064
8117
|
lookupFailedExample:
|
|
8065
8118
|
summary: Numbers Lookup Failed
|
|
8066
8119
|
value:
|
|
8067
|
-
links:
|
|
8068
|
-
- href: href
|
|
8069
|
-
rel: rel
|
|
8070
|
-
method: GET
|
|
8120
|
+
links: []
|
|
8071
8121
|
data:
|
|
8072
8122
|
requestId: 004223a0-8b17-41b1-bf81-20732adf5590
|
|
8073
8123
|
status: FAILED
|
|
@@ -8084,10 +8134,7 @@ components:
|
|
|
8084
8134
|
lookupPartialExample:
|
|
8085
8135
|
summary: Numbers Lookup Partial Complete
|
|
8086
8136
|
value:
|
|
8087
|
-
links:
|
|
8088
|
-
- href: href
|
|
8089
|
-
rel: rel
|
|
8090
|
-
method: GET
|
|
8137
|
+
links: []
|
|
8091
8138
|
data:
|
|
8092
8139
|
requestId: 004223a0-8b17-41b1-bf81-20732adf5590
|
|
8093
8140
|
status: PARTIAL_COMPLETE
|
|
@@ -8114,10 +8161,7 @@ components:
|
|
|
8114
8161
|
lookupCompleteExample:
|
|
8115
8162
|
summary: Numbers Lookup Complete (without DNI)
|
|
8116
8163
|
value:
|
|
8117
|
-
links:
|
|
8118
|
-
- href: href
|
|
8119
|
-
rel: rel
|
|
8120
|
-
method: GET
|
|
8164
|
+
links: []
|
|
8121
8165
|
data:
|
|
8122
8166
|
requestId: 004223a0-8b17-41b1-bf81-20732adf5590
|
|
8123
8167
|
status: COMPLETE
|
|
@@ -8136,10 +8180,7 @@ components:
|
|
|
8136
8180
|
lookupCompleteWithDniExample:
|
|
8137
8181
|
summary: Numbers Lookup Complete (with DNI)
|
|
8138
8182
|
value:
|
|
8139
|
-
links:
|
|
8140
|
-
- href: href
|
|
8141
|
-
rel: rel
|
|
8142
|
-
method: GET
|
|
8183
|
+
links: []
|
|
8143
8184
|
data:
|
|
8144
8185
|
requestId: 20732adf-bf81-8b17-41b1-004223a05590
|
|
8145
8186
|
status: COMPLETE
|
|
@@ -8177,6 +8218,58 @@ components:
|
|
|
8177
8218
|
deactivationEvent: DEACTIVATED
|
|
8178
8219
|
latestMessageDeliveryStatus: NOT_ENABLED
|
|
8179
8220
|
errors: []
|
|
8221
|
+
lookupCompleteWithRcsExample:
|
|
8222
|
+
summary: Numbers Lookup Complete (with RCS)
|
|
8223
|
+
value:
|
|
8224
|
+
links: []
|
|
8225
|
+
data:
|
|
8226
|
+
requestId: 004223a0-8b17-41b1-bf81-20732adf5590
|
|
8227
|
+
status: COMPLETE
|
|
8228
|
+
results:
|
|
8229
|
+
- phoneNumber: '+10072904497'
|
|
8230
|
+
lineType: MOBILE
|
|
8231
|
+
messagingProvider: Verizon Wireless
|
|
8232
|
+
voiceProvider: Verizon Wireless
|
|
8233
|
+
countryCodeA3: USA
|
|
8234
|
+
rcsEnabled: true
|
|
8235
|
+
- phoneNumber: '+10072904498'
|
|
8236
|
+
lineType: MOBILE
|
|
8237
|
+
messagingProvider: T-Mobile USA
|
|
8238
|
+
voiceProvider: T-Mobile USA
|
|
8239
|
+
countryCodeA3: USA
|
|
8240
|
+
rcsEnabled: false
|
|
8241
|
+
errors: []
|
|
8242
|
+
lookupCompleteWithRcsErrorExample:
|
|
8243
|
+
summary: Numbers Lookup Complete (with RCS error)
|
|
8244
|
+
value:
|
|
8245
|
+
links: []
|
|
8246
|
+
data:
|
|
8247
|
+
requestId: 004223a0-8b17-41b1-bf81-20732adf5590
|
|
8248
|
+
status: COMPLETE
|
|
8249
|
+
results:
|
|
8250
|
+
- phoneNumber: '+10072904497'
|
|
8251
|
+
lineType: MOBILE
|
|
8252
|
+
messagingProvider: Verizon Wireless
|
|
8253
|
+
voiceProvider: Verizon Wireless
|
|
8254
|
+
countryCodeA3: USA
|
|
8255
|
+
- phoneNumber: '+10072904498'
|
|
8256
|
+
lineType: MOBILE
|
|
8257
|
+
messagingProvider: T-Mobile USA
|
|
8258
|
+
voiceProvider: T-Mobile USA
|
|
8259
|
+
countryCodeA3: USA
|
|
8260
|
+
errors:
|
|
8261
|
+
- code: RCS_SERVICE_UNAVAILABLE
|
|
8262
|
+
type: rcs-error
|
|
8263
|
+
description: An exception was thrown during the async RCS service call.
|
|
8264
|
+
meta:
|
|
8265
|
+
phoneNumbers:
|
|
8266
|
+
- '+10072904497'
|
|
8267
|
+
- code: MISSING_FROM_RESPONSE
|
|
8268
|
+
type: rcs-error
|
|
8269
|
+
description: The phone number was absent from the RCS service response.
|
|
8270
|
+
meta:
|
|
8271
|
+
phoneNumbers:
|
|
8272
|
+
- '+10072904498'
|
|
8180
8273
|
badRequestExample:
|
|
8181
8274
|
summary: Example Bad Request Error
|
|
8182
8275
|
value:
|
package/configuration.ts
CHANGED
|
@@ -141,7 +141,7 @@ export class Configuration {
|
|
|
141
141
|
...param.baseOptions,
|
|
142
142
|
headers: {
|
|
143
143
|
...param.baseOptions?.headers,
|
|
144
|
-
'User-Agent': "OpenAPI-Generator/
|
|
144
|
+
'User-Agent': "OpenAPI-Generator/8.0.0/typescript-axios"
|
|
145
145
|
},
|
|
146
146
|
};
|
|
147
147
|
this.formDataCtor = param.formDataCtor;
|
package/coverage/clover.xml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
<?xml version="1.0" encoding="UTF-8"?>
|
|
2
|
-
<coverage generated="
|
|
3
|
-
<project timestamp="
|
|
4
|
-
<metrics statements="
|
|
2
|
+
<coverage generated="1775593355420" clover="3.2.0">
|
|
3
|
+
<project timestamp="1775593355420" name="All files">
|
|
4
|
+
<metrics statements="1970" coveredstatements="1807" conditionals="1466" coveredconditionals="1055" methods="497" coveredmethods="378" elements="3933" coveredelements="3240" complexity="0" loc="1970" ncloc="1970" packages="5" files="87" classes="87"/>
|
|
5
5
|
<package name="node-sdk">
|
|
6
6
|
<metrics statements="108" coveredstatements="85" conditionals="91" coveredconditionals="52" methods="23" coveredmethods="20"/>
|
|
7
7
|
<file name="api.ts" path="/home/runner/work/node-sdk/node-sdk/api.ts">
|
|
@@ -1601,15 +1601,11 @@
|
|
|
1601
1601
|
</file>
|
|
1602
1602
|
</package>
|
|
1603
1603
|
<package name="node-sdk.models">
|
|
1604
|
-
<metrics statements="
|
|
1604
|
+
<metrics statements="213" coveredstatements="213" conditionals="0" coveredconditionals="0" methods="0" coveredmethods="0"/>
|
|
1605
1605
|
<file name="business-entity-type-enum.ts" path="/home/runner/work/node-sdk/node-sdk/models/business-entity-type-enum.ts">
|
|
1606
1606
|
<metrics statements="1" coveredstatements="1" conditionals="0" coveredconditionals="0" methods="0" coveredmethods="0"/>
|
|
1607
1607
|
<line num="21" count="9" type="stmt"/>
|
|
1608
1608
|
</file>
|
|
1609
|
-
<file name="business-registration-issuing-country-enum.ts" path="/home/runner/work/node-sdk/node-sdk/models/business-registration-issuing-country-enum.ts">
|
|
1610
|
-
<metrics statements="1" coveredstatements="1" conditionals="0" coveredconditionals="0" methods="0" coveredmethods="0"/>
|
|
1611
|
-
<line num="21" count="9" type="stmt"/>
|
|
1612
|
-
</file>
|
|
1613
1609
|
<file name="business-registration-type-enum.ts" path="/home/runner/work/node-sdk/node-sdk/models/business-registration-type-enum.ts">
|
|
1614
1610
|
<metrics statements="1" coveredstatements="1" conditionals="0" coveredconditionals="0" methods="0" coveredmethods="0"/>
|
|
1615
1611
|
<line num="21" count="9" type="stmt"/>
|
|
@@ -1663,7 +1659,7 @@
|
|
|
1663
1659
|
<line num="21" count="9" type="stmt"/>
|
|
1664
1660
|
</file>
|
|
1665
1661
|
<file name="index.ts" path="/home/runner/work/node-sdk/node-sdk/models/index.ts">
|
|
1666
|
-
<metrics statements="
|
|
1662
|
+
<metrics statements="177" coveredstatements="177" conditionals="0" coveredconditionals="0" methods="0" coveredmethods="0"/>
|
|
1667
1663
|
<line num="1" count="8" type="stmt"/>
|
|
1668
1664
|
<line num="2" count="8" type="stmt"/>
|
|
1669
1665
|
<line num="3" count="8" type="stmt"/>
|
|
@@ -1841,7 +1837,6 @@
|
|
|
1841
1837
|
<line num="175" count="8" type="stmt"/>
|
|
1842
1838
|
<line num="176" count="8" type="stmt"/>
|
|
1843
1839
|
<line num="177" count="8" type="stmt"/>
|
|
1844
|
-
<line num="178" count="8" type="stmt"/>
|
|
1845
1840
|
</file>
|
|
1846
1841
|
<file name="latest-message-delivery-status-enum.ts" path="/home/runner/work/node-sdk/node-sdk/models/latest-message-delivery-status-enum.ts">
|
|
1847
1842
|
<metrics statements="1" coveredstatements="1" conditionals="0" coveredconditionals="0" methods="0" coveredmethods="0"/>
|