bandwidth-sdk 7.2.0 → 7.4.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 +2 -0
- package/README.md +1 -0
- package/api/messages-api.ts +4 -4
- package/bandwidth.yml +127 -35
- package/configuration.ts +1 -1
- package/coverage/clover.xml +11 -6
- package/coverage/coverage-final.json +4 -3
- 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 +1 -1
- package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +5 -5
- 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 +2 -2
- 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-issuing-country-enum.ts.html +205 -0
- package/coverage/lcov-report/node-sdk/models/business-registration-type-enum.ts.html +52 -4
- 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 +20 -5
- package/coverage/lcov-report/node-sdk/models/index.ts.html +7 -4
- 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 +16 -5
- package/dist/api/messages-api.d.ts +4 -4
- package/dist/api/messages-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-issuing-country-enum.d.ts +30 -0
- package/dist/models/business-registration-issuing-country-enum.js +34 -0
- package/dist/models/business-registration-type-enum.d.ts +17 -1
- package/dist/models/business-registration-type-enum.js +18 -2
- package/dist/models/index.d.ts +1 -0
- package/dist/models/index.js +1 -0
- package/dist/models/rbm-message-media.d.ts +1 -1
- package/dist/models/tfv-status.d.ts +1 -1
- package/dist/models/tfv-submission-info.d.ts +4 -2
- 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/BusinessRegistrationIssuingCountryEnum.md +33 -0
- package/docs/BusinessRegistrationTypeEnum.md +33 -1
- package/docs/MessagesApi.md +3 -2
- package/docs/MultiChannelChannelListRBMObjectAllOfContent.md +1 -1
- package/docs/RbmMessageMedia.md +1 -1
- package/docs/TfvStatus.md +1 -1
- package/docs/TfvSubmissionInfo.md +3 -1
- package/docs/VerificationRequest.md +5 -3
- package/docs/VerificationUpdateRequest.md +4 -2
- package/models/business-entity-type-enum.ts +1 -1
- package/models/business-registration-issuing-country-enum.ts +40 -0
- package/models/business-registration-type-enum.ts +18 -2
- package/models/index.ts +1 -0
- package/models/rbm-message-media.ts +1 -1
- package/models/tfv-status.ts +1 -1
- package/models/tfv-submission-info.ts +6 -2
- package/models/verification-request.ts +7 -3
- package/models/verification-update-request.ts +7 -3
- package/package.json +1 -1
- package/tests/smoke/multi-channel-api.test.ts +240 -4
- package/tests/unit/api/toll-free-verification-api.test.ts +2 -1
- package/tests/unit/models/business-registration-issuing-country-enum.test.ts +19 -0
- package/tests/unit/models/business-registration-type-enum.test.ts +16 -0
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { Address } from './address';
|
|
13
13
|
import type { BusinessEntityTypeEnum } from './business-entity-type-enum';
|
|
14
|
+
import type { BusinessRegistrationIssuingCountryEnum } from './business-registration-issuing-country-enum';
|
|
14
15
|
import type { BusinessRegistrationTypeEnum } from './business-registration-type-enum';
|
|
15
16
|
import type { Contact } from './contact';
|
|
16
17
|
import type { OptInWorkflow } from './opt-in-workflow';
|
|
@@ -55,11 +56,12 @@ export interface VerificationUpdateRequest {
|
|
|
55
56
|
*/
|
|
56
57
|
'businessDba'?: string;
|
|
57
58
|
/**
|
|
58
|
-
*
|
|
59
|
+
* Government-issued business identifying number.
|
|
59
60
|
*/
|
|
60
61
|
'businessRegistrationNumber'?: string | null;
|
|
61
62
|
'businessRegistrationType'?: BusinessRegistrationTypeEnum | null;
|
|
62
|
-
'businessEntityType'?: BusinessEntityTypeEnum
|
|
63
|
+
'businessEntityType'?: BusinessEntityTypeEnum;
|
|
64
|
+
'businessRegistrationIssuingCountry'?: BusinessRegistrationIssuingCountryEnum;
|
|
63
65
|
/**
|
|
64
66
|
* A message that gets sent to users requesting help.
|
|
65
67
|
*/
|
|
@@ -69,7 +71,7 @@ export interface VerificationUpdateRequest {
|
|
|
69
71
|
*/
|
|
70
72
|
'ageGatedContent'?: boolean;
|
|
71
73
|
/**
|
|
72
|
-
* The token provided by Campaign Verify to validate your political use case. Only required for 527 political organizations. If you are not a 527 political organization, this field should be omitted.
|
|
74
|
+
* The token provided by Campaign Verify to validate your political use case. Only required for 527 political organizations. If you are not a 527 political organization, this field should be omitted. Supplying an empty string will likely result in rejection.
|
|
73
75
|
*/
|
|
74
76
|
'cvToken'?: string | null;
|
|
75
77
|
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# BusinessEntityTypeEnum
|
|
2
2
|
|
|
3
|
-
The type of registered business. If no option is applicable, please provide \"SOLE_PROPRIETOR\" as a value.
|
|
3
|
+
The type of registered business. If no option is applicable, please provide \"SOLE_PROPRIETOR\" as a value.
|
|
4
4
|
|
|
5
5
|
## Enum
|
|
6
6
|
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# BusinessRegistrationIssuingCountryEnum
|
|
2
|
+
|
|
3
|
+
The country issuing the business registration in ISO-3166-1 alpha-3 format. | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code |
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `Usa` (value: `'USA'`)
|
|
8
|
+
|
|
9
|
+
* `Can` (value: `'CAN'`)
|
|
10
|
+
|
|
11
|
+
* `Hkg` (value: `'HKG'`)
|
|
12
|
+
|
|
13
|
+
* `Gbr` (value: `'GBR'`)
|
|
14
|
+
|
|
15
|
+
* `Irl` (value: `'IRL'`)
|
|
16
|
+
|
|
17
|
+
* `Bra` (value: `'BRA'`)
|
|
18
|
+
|
|
19
|
+
* `Nld` (value: `'NLD'`)
|
|
20
|
+
|
|
21
|
+
* `Aus` (value: `'AUS'`)
|
|
22
|
+
|
|
23
|
+
* `Fra` (value: `'FRA'`)
|
|
24
|
+
|
|
25
|
+
* `Nzl` (value: `'NZL'`)
|
|
26
|
+
|
|
27
|
+
* `Deu` (value: `'DEU'`)
|
|
28
|
+
|
|
29
|
+
* `Esp` (value: `'ESP'`)
|
|
30
|
+
|
|
31
|
+
* `Che` (value: `'CHE'`)
|
|
32
|
+
|
|
33
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# BusinessRegistrationTypeEnum
|
|
2
2
|
|
|
3
|
-
The type of business registration number.
|
|
3
|
+
The type of business registration number.
|
|
4
4
|
|
|
5
5
|
## Enum
|
|
6
6
|
|
|
@@ -8,4 +8,36 @@ The type of business registration number. Optional until early 2026; required if
|
|
|
8
8
|
|
|
9
9
|
* `Cbn` (value: `'CBN'`)
|
|
10
10
|
|
|
11
|
+
* `Neq` (value: `'NEQ'`)
|
|
12
|
+
|
|
13
|
+
* `ProvincialNumber` (value: `'PROVINCIAL_NUMBER'`)
|
|
14
|
+
|
|
15
|
+
* `Crn` (value: `'CRN'`)
|
|
16
|
+
|
|
17
|
+
* `Vat` (value: `'VAT'`)
|
|
18
|
+
|
|
19
|
+
* `Acn` (value: `'ACN'`)
|
|
20
|
+
|
|
21
|
+
* `Abn` (value: `'ABN'`)
|
|
22
|
+
|
|
23
|
+
* `Brn` (value: `'BRN'`)
|
|
24
|
+
|
|
25
|
+
* `Siren` (value: `'SIREN'`)
|
|
26
|
+
|
|
27
|
+
* `Siret` (value: `'SIRET'`)
|
|
28
|
+
|
|
29
|
+
* `Nzbn` (value: `'NZBN'`)
|
|
30
|
+
|
|
31
|
+
* `UstIdnr` (value: `'UST_IDNR'`)
|
|
32
|
+
|
|
33
|
+
* `Cif` (value: `'CIF'`)
|
|
34
|
+
|
|
35
|
+
* `Nif` (value: `'NIF'`)
|
|
36
|
+
|
|
37
|
+
* `Cnpj` (value: `'CNPJ'`)
|
|
38
|
+
|
|
39
|
+
* `Uid` (value: `'UID'`)
|
|
40
|
+
|
|
41
|
+
* `Other` (value: `'OTHER'`)
|
|
42
|
+
|
|
11
43
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/MessagesApi.md
CHANGED
|
@@ -74,7 +74,7 @@ const { status, data } = await apiInstance.createMessage(
|
|
|
74
74
|
# **listMessages**
|
|
75
75
|
> MessagesList listMessages()
|
|
76
76
|
|
|
77
|
-
Returns a list of messages based on query parameters.
|
|
77
|
+
Returns a list of messages based on query parameters. **Rate Limit:** This endpoint is rate limited to 3500 requests per 5 minutes per Source IP address. Exceeding the limit returns HTTP 429 with a `Retry-After` header.
|
|
78
78
|
|
|
79
79
|
### Example
|
|
80
80
|
|
|
@@ -204,8 +204,9 @@ const { status, data } = await apiInstance.listMessages(
|
|
|
204
204
|
|**401** | Unauthorized | - |
|
|
205
205
|
|**403** | Forbidden | - |
|
|
206
206
|
|**404** | Not Found | - |
|
|
207
|
+
|**405** | Method Not Allowed | - |
|
|
207
208
|
|**415** | Unsupported Media Type | - |
|
|
208
|
-
|**429** | Too Many Requests | - |
|
|
209
|
+
|**429** | Too Many Requests | * Retry-After - The number of seconds to wait before retrying the request. <br> |
|
|
209
210
|
|**500** | Internal Server Error | - |
|
|
210
211
|
|
|
211
212
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**text** | **string** | The text associated with the message. Must be 3270 characters or less | [default to undefined]
|
|
10
10
|
**suggestions** | [**Array<MultiChannelAction>**](MultiChannelAction.md) | An array of suggested actions for the recipient. | [optional] [default to undefined]
|
|
11
|
-
**media** | [**RbmMessageContentFile
|
|
11
|
+
**media** | [**Array<RbmMessageContentFile>**](RbmMessageContentFile.md) | | [default to undefined]
|
|
12
12
|
**orientation** | [**StandaloneCardOrientationEnum**](StandaloneCardOrientationEnum.md) | | [default to undefined]
|
|
13
13
|
**thumbnailImageAlignment** | [**ThumbnailAlignmentEnum**](ThumbnailAlignmentEnum.md) | | [default to undefined]
|
|
14
14
|
**cardContent** | [**RbmCardContent**](RbmCardContent.md) | | [default to undefined]
|
package/docs/RbmMessageMedia.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**media** | [**RbmMessageContentFile
|
|
8
|
+
**media** | [**Array<RbmMessageContentFile>**](RbmMessageContentFile.md) | | [default to undefined]
|
|
9
9
|
**suggestions** | [**Array<MultiChannelAction>**](MultiChannelAction.md) | An array of suggested actions for the recipient. | [optional] [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
package/docs/TfvStatus.md
CHANGED
|
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
|
|
|
15
15
|
**submission** | [**TfvSubmissionInfo**](TfvSubmissionInfo.md) | | [optional] [default to undefined]
|
|
16
16
|
**blocked** | **boolean** | Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. | [optional] [default to undefined]
|
|
17
17
|
**blockedReason** | **string** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. | [optional] [default to undefined]
|
|
18
|
-
**cvToken** | **string** | The token provided by Campaign Verify to validate your political use case. Only required for 527 political organizations. If you are not a 527 political organization, this field should be omitted.
|
|
18
|
+
**cvToken** | **string** | The token provided by Campaign Verify to validate your political use case. Only required for 527 political organizations. If you are not a 527 political organization, this field should be omitted. Supplying an empty string will likely result in rejection. | [optional] [default to undefined]
|
|
19
19
|
|
|
20
20
|
## Example
|
|
21
21
|
|
|
@@ -17,8 +17,9 @@ Name | Type | Description | Notes
|
|
|
17
17
|
**privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. | [optional] [default to undefined]
|
|
18
18
|
**termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. | [optional] [default to undefined]
|
|
19
19
|
**businessDba** | **string** | The company \'Doing Business As\'. | [optional] [default to undefined]
|
|
20
|
-
**businessRegistrationNumber** | **string** |
|
|
20
|
+
**businessRegistrationNumber** | **string** | Government-issued business identifying number. | [optional] [default to undefined]
|
|
21
21
|
**businessRegistrationType** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] [default to undefined]
|
|
22
|
+
**businessRegistrationIssuingCountry** | [**BusinessRegistrationIssuingCountryEnum**](BusinessRegistrationIssuingCountryEnum.md) | | [optional] [default to undefined]
|
|
22
23
|
**businessEntityType** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] [default to undefined]
|
|
23
24
|
|
|
24
25
|
## Example
|
|
@@ -41,6 +42,7 @@ const instance: TfvSubmissionInfo = {
|
|
|
41
42
|
businessDba,
|
|
42
43
|
businessRegistrationNumber,
|
|
43
44
|
businessRegistrationType,
|
|
45
|
+
businessRegistrationIssuingCountry,
|
|
44
46
|
businessEntityType,
|
|
45
47
|
};
|
|
46
48
|
```
|
|
@@ -18,12 +18,13 @@ Name | Type | Description | Notes
|
|
|
18
18
|
**privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. | [optional] [default to undefined]
|
|
19
19
|
**termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. | [optional] [default to undefined]
|
|
20
20
|
**businessDba** | **string** | The company \'Doing Business As\'. | [optional] [default to undefined]
|
|
21
|
-
**businessRegistrationNumber** | **string** |
|
|
21
|
+
**businessRegistrationNumber** | **string** | Government-issued business identifying number. | [optional] [default to undefined]
|
|
22
22
|
**businessRegistrationType** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] [default to undefined]
|
|
23
|
-
**
|
|
23
|
+
**businessRegistrationIssuingCountry** | [**BusinessRegistrationIssuingCountryEnum**](BusinessRegistrationIssuingCountryEnum.md) | | [optional] [default to undefined]
|
|
24
|
+
**businessEntityType** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [default to undefined]
|
|
24
25
|
**helpMessageResponse** | **string** | A message that gets sent to users requesting help. | [optional] [default to undefined]
|
|
25
26
|
**ageGatedContent** | **boolean** | Indicates whether the content is age-gated. | [optional] [default to undefined]
|
|
26
|
-
**cvToken** | **string** | The token provided by Campaign Verify to validate your political use case. Only required for 527 political organizations. If you are not a 527 political organization, this field should be omitted.
|
|
27
|
+
**cvToken** | **string** | The token provided by Campaign Verify to validate your political use case. Only required for 527 political organizations. If you are not a 527 political organization, this field should be omitted. Supplying an empty string will likely result in rejection. | [optional] [default to undefined]
|
|
27
28
|
|
|
28
29
|
## Example
|
|
29
30
|
|
|
@@ -46,6 +47,7 @@ const instance: VerificationRequest = {
|
|
|
46
47
|
businessDba,
|
|
47
48
|
businessRegistrationNumber,
|
|
48
49
|
businessRegistrationType,
|
|
50
|
+
businessRegistrationIssuingCountry,
|
|
49
51
|
businessEntityType,
|
|
50
52
|
helpMessageResponse,
|
|
51
53
|
ageGatedContent,
|
|
@@ -17,12 +17,13 @@ Name | Type | Description | Notes
|
|
|
17
17
|
**privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. | [optional] [default to undefined]
|
|
18
18
|
**termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. | [optional] [default to undefined]
|
|
19
19
|
**businessDba** | **string** | The company \'Doing Business As\'. | [optional] [default to undefined]
|
|
20
|
-
**businessRegistrationNumber** | **string** |
|
|
20
|
+
**businessRegistrationNumber** | **string** | Government-issued business identifying number. | [optional] [default to undefined]
|
|
21
21
|
**businessRegistrationType** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] [default to undefined]
|
|
22
22
|
**businessEntityType** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] [default to undefined]
|
|
23
|
+
**businessRegistrationIssuingCountry** | [**BusinessRegistrationIssuingCountryEnum**](BusinessRegistrationIssuingCountryEnum.md) | | [optional] [default to undefined]
|
|
23
24
|
**helpMessageResponse** | **string** | A message that gets sent to users requesting help. | [optional] [default to undefined]
|
|
24
25
|
**ageGatedContent** | **boolean** | Indicates whether the content is age-gated. | [optional] [default to undefined]
|
|
25
|
-
**cvToken** | **string** | The token provided by Campaign Verify to validate your political use case. Only required for 527 political organizations. If you are not a 527 political organization, this field should be omitted.
|
|
26
|
+
**cvToken** | **string** | The token provided by Campaign Verify to validate your political use case. Only required for 527 political organizations. If you are not a 527 political organization, this field should be omitted. Supplying an empty string will likely result in rejection. | [optional] [default to undefined]
|
|
26
27
|
|
|
27
28
|
## Example
|
|
28
29
|
|
|
@@ -45,6 +46,7 @@ const instance: VerificationUpdateRequest = {
|
|
|
45
46
|
businessRegistrationNumber,
|
|
46
47
|
businessRegistrationType,
|
|
47
48
|
businessEntityType,
|
|
49
|
+
businessRegistrationIssuingCountry,
|
|
48
50
|
helpMessageResponse,
|
|
49
51
|
ageGatedContent,
|
|
50
52
|
cvToken,
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
|
|
16
16
|
|
|
17
17
|
/**
|
|
18
|
-
* The type of registered business. If no option is applicable, please provide \"SOLE_PROPRIETOR\" as a value.
|
|
18
|
+
* The type of registered business. If no option is applicable, please provide \"SOLE_PROPRIETOR\" as a value.
|
|
19
19
|
*/
|
|
20
20
|
|
|
21
21
|
export const BusinessEntityTypeEnum = {
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Bandwidth
|
|
5
|
+
* Bandwidth\'s Communication APIs
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
* Contact: letstalk@bandwidth.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* The country issuing the business registration in ISO-3166-1 alpha-3 format. | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code |
|
|
19
|
+
*/
|
|
20
|
+
|
|
21
|
+
export const BusinessRegistrationIssuingCountryEnum = {
|
|
22
|
+
Usa: 'USA',
|
|
23
|
+
Can: 'CAN',
|
|
24
|
+
Hkg: 'HKG',
|
|
25
|
+
Gbr: 'GBR',
|
|
26
|
+
Irl: 'IRL',
|
|
27
|
+
Bra: 'BRA',
|
|
28
|
+
Nld: 'NLD',
|
|
29
|
+
Aus: 'AUS',
|
|
30
|
+
Fra: 'FRA',
|
|
31
|
+
Nzl: 'NZL',
|
|
32
|
+
Deu: 'DEU',
|
|
33
|
+
Esp: 'ESP',
|
|
34
|
+
Che: 'CHE'
|
|
35
|
+
} as const;
|
|
36
|
+
|
|
37
|
+
export type BusinessRegistrationIssuingCountryEnum = typeof BusinessRegistrationIssuingCountryEnum[keyof typeof BusinessRegistrationIssuingCountryEnum];
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
|
|
@@ -15,12 +15,28 @@
|
|
|
15
15
|
|
|
16
16
|
|
|
17
17
|
/**
|
|
18
|
-
* The type of business registration number.
|
|
18
|
+
* The type of business registration number.
|
|
19
19
|
*/
|
|
20
20
|
|
|
21
21
|
export const BusinessRegistrationTypeEnum = {
|
|
22
22
|
Ein: 'EIN',
|
|
23
|
-
Cbn: 'CBN'
|
|
23
|
+
Cbn: 'CBN',
|
|
24
|
+
Neq: 'NEQ',
|
|
25
|
+
ProvincialNumber: 'PROVINCIAL_NUMBER',
|
|
26
|
+
Crn: 'CRN',
|
|
27
|
+
Vat: 'VAT',
|
|
28
|
+
Acn: 'ACN',
|
|
29
|
+
Abn: 'ABN',
|
|
30
|
+
Brn: 'BRN',
|
|
31
|
+
Siren: 'SIREN',
|
|
32
|
+
Siret: 'SIRET',
|
|
33
|
+
Nzbn: 'NZBN',
|
|
34
|
+
UstIdnr: 'UST_IDNR',
|
|
35
|
+
Cif: 'CIF',
|
|
36
|
+
Nif: 'NIF',
|
|
37
|
+
Cnpj: 'CNPJ',
|
|
38
|
+
Uid: 'UID',
|
|
39
|
+
Other: 'OTHER'
|
|
24
40
|
} as const;
|
|
25
41
|
|
|
26
42
|
export type BusinessRegistrationTypeEnum = typeof BusinessRegistrationTypeEnum[keyof typeof BusinessRegistrationTypeEnum];
|
package/models/index.ts
CHANGED
|
@@ -7,6 +7,7 @@ export * from './blocked-webhook';
|
|
|
7
7
|
export * from './bridge-complete-callback';
|
|
8
8
|
export * from './bridge-target-complete-callback';
|
|
9
9
|
export * from './business-entity-type-enum';
|
|
10
|
+
export * from './business-registration-issuing-country-enum';
|
|
10
11
|
export * from './business-registration-type-enum';
|
|
11
12
|
export * from './call-direction-enum';
|
|
12
13
|
export * from './call-recording-metadata';
|
|
@@ -21,7 +21,7 @@ import type { MultiChannelAction } from './multi-channel-action';
|
|
|
21
21
|
import type { RbmMessageContentFile } from './rbm-message-content-file';
|
|
22
22
|
|
|
23
23
|
export interface RbmMessageMedia {
|
|
24
|
-
'media': RbmMessageContentFile
|
|
24
|
+
'media': Array<RbmMessageContentFile>;
|
|
25
25
|
/**
|
|
26
26
|
* An array of suggested actions for the recipient.
|
|
27
27
|
*/
|
package/models/tfv-status.ts
CHANGED
|
@@ -56,7 +56,7 @@ export interface TfvStatus {
|
|
|
56
56
|
*/
|
|
57
57
|
'blockedReason'?: string;
|
|
58
58
|
/**
|
|
59
|
-
* The token provided by Campaign Verify to validate your political use case. Only required for 527 political organizations. If you are not a 527 political organization, this field should be omitted.
|
|
59
|
+
* The token provided by Campaign Verify to validate your political use case. Only required for 527 political organizations. If you are not a 527 political organization, this field should be omitted. Supplying an empty string will likely result in rejection.
|
|
60
60
|
*/
|
|
61
61
|
'cvToken'?: string | null;
|
|
62
62
|
}
|
|
@@ -21,6 +21,9 @@ import type { Address } from './address';
|
|
|
21
21
|
import type { BusinessEntityTypeEnum } from './business-entity-type-enum';
|
|
22
22
|
// May contain unused imports in some cases
|
|
23
23
|
// @ts-ignore
|
|
24
|
+
import type { BusinessRegistrationIssuingCountryEnum } from './business-registration-issuing-country-enum';
|
|
25
|
+
// May contain unused imports in some cases
|
|
26
|
+
// @ts-ignore
|
|
24
27
|
import type { BusinessRegistrationTypeEnum } from './business-registration-type-enum';
|
|
25
28
|
// May contain unused imports in some cases
|
|
26
29
|
// @ts-ignore
|
|
@@ -70,11 +73,12 @@ export interface TfvSubmissionInfo {
|
|
|
70
73
|
*/
|
|
71
74
|
'businessDba'?: string;
|
|
72
75
|
/**
|
|
73
|
-
*
|
|
76
|
+
* Government-issued business identifying number.
|
|
74
77
|
*/
|
|
75
78
|
'businessRegistrationNumber'?: string | null;
|
|
76
79
|
'businessRegistrationType'?: BusinessRegistrationTypeEnum | null;
|
|
77
|
-
'
|
|
80
|
+
'businessRegistrationIssuingCountry'?: BusinessRegistrationIssuingCountryEnum;
|
|
81
|
+
'businessEntityType'?: BusinessEntityTypeEnum;
|
|
78
82
|
}
|
|
79
83
|
|
|
80
84
|
|
|
@@ -21,6 +21,9 @@ import type { Address } from './address';
|
|
|
21
21
|
import type { BusinessEntityTypeEnum } from './business-entity-type-enum';
|
|
22
22
|
// May contain unused imports in some cases
|
|
23
23
|
// @ts-ignore
|
|
24
|
+
import type { BusinessRegistrationIssuingCountryEnum } from './business-registration-issuing-country-enum';
|
|
25
|
+
// May contain unused imports in some cases
|
|
26
|
+
// @ts-ignore
|
|
24
27
|
import type { BusinessRegistrationTypeEnum } from './business-registration-type-enum';
|
|
25
28
|
// May contain unused imports in some cases
|
|
26
29
|
// @ts-ignore
|
|
@@ -71,11 +74,12 @@ export interface VerificationRequest {
|
|
|
71
74
|
*/
|
|
72
75
|
'businessDba'?: string;
|
|
73
76
|
/**
|
|
74
|
-
*
|
|
77
|
+
* Government-issued business identifying number.
|
|
75
78
|
*/
|
|
76
79
|
'businessRegistrationNumber'?: string | null;
|
|
77
80
|
'businessRegistrationType'?: BusinessRegistrationTypeEnum | null;
|
|
78
|
-
'
|
|
81
|
+
'businessRegistrationIssuingCountry'?: BusinessRegistrationIssuingCountryEnum;
|
|
82
|
+
'businessEntityType': BusinessEntityTypeEnum;
|
|
79
83
|
/**
|
|
80
84
|
* A message that gets sent to users requesting help.
|
|
81
85
|
*/
|
|
@@ -85,7 +89,7 @@ export interface VerificationRequest {
|
|
|
85
89
|
*/
|
|
86
90
|
'ageGatedContent'?: boolean;
|
|
87
91
|
/**
|
|
88
|
-
* The token provided by Campaign Verify to validate your political use case. Only required for 527 political organizations. If you are not a 527 political organization, this field should be omitted.
|
|
92
|
+
* The token provided by Campaign Verify to validate your political use case. Only required for 527 political organizations. If you are not a 527 political organization, this field should be omitted. Supplying an empty string will likely result in rejection.
|
|
89
93
|
*/
|
|
90
94
|
'cvToken'?: string | null;
|
|
91
95
|
}
|
|
@@ -21,6 +21,9 @@ import type { Address } from './address';
|
|
|
21
21
|
import type { BusinessEntityTypeEnum } from './business-entity-type-enum';
|
|
22
22
|
// May contain unused imports in some cases
|
|
23
23
|
// @ts-ignore
|
|
24
|
+
import type { BusinessRegistrationIssuingCountryEnum } from './business-registration-issuing-country-enum';
|
|
25
|
+
// May contain unused imports in some cases
|
|
26
|
+
// @ts-ignore
|
|
24
27
|
import type { BusinessRegistrationTypeEnum } from './business-registration-type-enum';
|
|
25
28
|
// May contain unused imports in some cases
|
|
26
29
|
// @ts-ignore
|
|
@@ -70,11 +73,12 @@ export interface VerificationUpdateRequest {
|
|
|
70
73
|
*/
|
|
71
74
|
'businessDba'?: string;
|
|
72
75
|
/**
|
|
73
|
-
*
|
|
76
|
+
* Government-issued business identifying number.
|
|
74
77
|
*/
|
|
75
78
|
'businessRegistrationNumber'?: string | null;
|
|
76
79
|
'businessRegistrationType'?: BusinessRegistrationTypeEnum | null;
|
|
77
|
-
'businessEntityType'?: BusinessEntityTypeEnum
|
|
80
|
+
'businessEntityType'?: BusinessEntityTypeEnum;
|
|
81
|
+
'businessRegistrationIssuingCountry'?: BusinessRegistrationIssuingCountryEnum;
|
|
78
82
|
/**
|
|
79
83
|
* A message that gets sent to users requesting help.
|
|
80
84
|
*/
|
|
@@ -84,7 +88,7 @@ export interface VerificationUpdateRequest {
|
|
|
84
88
|
*/
|
|
85
89
|
'ageGatedContent'?: boolean;
|
|
86
90
|
/**
|
|
87
|
-
* The token provided by Campaign Verify to validate your political use case. Only required for 527 political organizations. If you are not a 527 political organization, this field should be omitted.
|
|
91
|
+
* The token provided by Campaign Verify to validate your political use case. Only required for 527 political organizations. If you are not a 527 political organization, this field should be omitted. Supplying an empty string will likely result in rejection.
|
|
88
92
|
*/
|
|
89
93
|
'cvToken'?: string | null;
|
|
90
94
|
}
|