bandwidth-sdk 7.4.0 → 7.4.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/bandwidth.yml +53 -8
- package/configuration.ts +1 -1
- package/coverage/clover.xml +2 -2
- package/coverage/coverage-final.json +2 -2
- package/coverage/lcov-report/index.html +1 -1
- 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 +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-issuing-country-enum.ts.html +16 -4
- 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 +1 -1
- package/coverage/lcov-report/node-sdk/models/index.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/latest-message-delivery-status-enum.ts.html +7 -4
- 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/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 +5 -1
- package/dist/models/business-registration-issuing-country-enum.js +6 -2
- package/dist/models/callback.d.ts +2 -0
- package/dist/models/latest-message-delivery-status-enum.d.ts +2 -1
- package/dist/models/latest-message-delivery-status-enum.js +3 -2
- package/dist/models/message-request.d.ts +1 -1
- package/dist/models/message.d.ts +1 -1
- package/dist/models/multi-channel-channel-list-object-base.d.ts +1 -1
- package/dist/models/multi-channel-channel-list-request-object.d.ts +1 -1
- package/dist/models/multi-channel-channel-list-response-object.d.ts +1 -1
- package/dist/models/status-callback-message.d.ts +1 -1
- package/dist/models/tfv-submission-info.d.ts +1 -1
- package/dist/models/verification-request.d.ts +1 -1
- package/dist/models/verification-update-request.d.ts +1 -1
- package/docs/BusinessEntityTypeEnum.md +1 -1
- package/docs/BusinessRegistrationIssuingCountryEnum.md +9 -1
- package/docs/BusinessRegistrationTypeEnum.md +1 -1
- package/docs/InboundCallbackMessage.md +1 -1
- package/docs/LatestMessageDeliveryStatusEnum.md +3 -1
- package/docs/Message.md +1 -1
- package/docs/MessageRequest.md +1 -1
- package/docs/MultiChannelChannelListMMSObject.md +1 -1
- package/docs/MultiChannelChannelListMMSResponseObject.md +1 -1
- package/docs/MultiChannelChannelListObjectBase.md +1 -1
- package/docs/MultiChannelChannelListRBMObject.md +1 -1
- package/docs/MultiChannelChannelListRBMResponseObject.md +1 -1
- package/docs/MultiChannelChannelListRequestObject.md +1 -1
- package/docs/MultiChannelChannelListResponseObject.md +1 -1
- package/docs/MultiChannelChannelListSMSObject.md +1 -1
- package/docs/MultiChannelChannelListSMSResponseObject.md +1 -1
- package/docs/StatusCallbackMessage.md +1 -1
- package/docs/TfvSubmissionInfo.md +1 -1
- package/docs/VerificationRequest.md +1 -1
- package/docs/VerificationUpdateRequest.md +1 -1
- package/models/business-entity-type-enum.ts +1 -1
- package/models/business-registration-issuing-country-enum.ts +6 -2
- package/models/business-registration-type-enum.ts +1 -1
- package/models/callback.ts +1 -1
- package/models/latest-message-delivery-status-enum.ts +3 -2
- package/models/message-request.ts +1 -1
- package/models/message.ts +1 -1
- package/models/multi-channel-channel-list-object-base.ts +1 -1
- package/models/multi-channel-channel-list-request-object.ts +1 -1
- package/models/multi-channel-channel-list-response-object.ts +1 -1
- package/models/status-callback-message.ts +1 -1
- package/models/tfv-submission-info.ts +1 -1
- package/models/verification-request.ts +1 -1
- package/models/verification-update-request.ts +1 -1
- package/package.json +1 -1
- package/tests/smoke/phone-number-lookup-api.test.ts +0 -2
- package/tests/unit/models/business-registration-issuing-country-enum.test.ts +4 -0
- package/tests/unit/models/latest-message-delivery-status-enum.test.ts +1 -0
|
@@ -56,7 +56,7 @@ export interface VerificationUpdateRequest {
|
|
|
56
56
|
*/
|
|
57
57
|
'businessDba'?: string;
|
|
58
58
|
/**
|
|
59
|
-
* Government-issued business identifying number.
|
|
59
|
+
* Government-issued business identifying number. **Note:** If this field is provided, it is strongly recommended to also provide `businessRegistrationType` and `businessRegistrationIssuingCountry`. Submissions missing these fields have a high likelihood of rejection.
|
|
60
60
|
*/
|
|
61
61
|
'businessRegistrationNumber'?: string | null;
|
|
62
62
|
'businessRegistrationType'?: BusinessRegistrationTypeEnum | null;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# BusinessRegistrationIssuingCountryEnum
|
|
2
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 |
|
|
3
|
+
The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 country codes are acceptable, but the application will convert them to alpha-3 when received, so alpha-3 is encouraged. **Note:** If this field is omitted but `businessRegistrationType` is provided, the application will attempt to infer the country based on the registration type. However, if the application cannot confidently infer the country, the submission may be rejected. To ensure the highest likelihood of acceptance, it is recommended to provide both `businessRegistrationType` and `businessRegistrationIssuingCountry`. | 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
4
|
|
|
5
5
|
## Enum
|
|
6
6
|
|
|
@@ -30,4 +30,12 @@ The country issuing the business registration in ISO-3166-1 alpha-3 format. | R
|
|
|
30
30
|
|
|
31
31
|
* `Che` (value: `'CHE'`)
|
|
32
32
|
|
|
33
|
+
* `Cyp` (value: `'CYP'`)
|
|
34
|
+
|
|
35
|
+
* `Ind` (value: `'IND'`)
|
|
36
|
+
|
|
37
|
+
* `Chn` (value: `'CHN'`)
|
|
38
|
+
|
|
39
|
+
* `Bgr` (value: `'BGR'`)
|
|
40
|
+
|
|
33
41
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**id** | **string** | A unique identifier of the message. | [default to undefined]
|
|
9
9
|
**owner** | **string** | The Bandwidth phone number or alphanumeric identifier associated with the message. | [default to undefined]
|
|
10
|
-
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth
|
|
10
|
+
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth App. | [default to undefined]
|
|
11
11
|
**time** | **string** | | [default to undefined]
|
|
12
12
|
**segmentCount** | **number** | The number of segments the user\'s message is broken into before sending over carrier networks. | [default to undefined]
|
|
13
13
|
**direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) | | [default to undefined]
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# LatestMessageDeliveryStatusEnum
|
|
2
2
|
|
|
3
|
-
[DNI-Only](#section/DNI-Only). The current delivery status of the phone number. - ACTIVE: A message was successfully sent to the number (delivery code 0). - DEACTIVATED: A message was not delivered to a number (delivery code 720) - UNKNOWN: Bandwidth cannot find an delivery status entry for the number.
|
|
3
|
+
[DNI-Only](#section/DNI-Only). The current delivery status of the phone number. - ACTIVE: A message was successfully sent to the number (delivery code 0). - DEACTIVATED: A message was not delivered to a number (delivery code 720) - UNKNOWN: Bandwidth cannot find an delivery status entry for the number. - NOT_ENABLED: The phone number is not enabled for messaging, so there is no delivery status information.
|
|
4
4
|
|
|
5
5
|
## Enum
|
|
6
6
|
|
|
@@ -10,4 +10,6 @@
|
|
|
10
10
|
|
|
11
11
|
* `Unknown` (value: `'UNKNOWN'`)
|
|
12
12
|
|
|
13
|
+
* `NotEnabled` (value: `'NOT_ENABLED'`)
|
|
14
|
+
|
|
13
15
|
[[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/Message.md
CHANGED
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**id** | **string** | The id of the message. | [optional] [default to undefined]
|
|
9
9
|
**owner** | **string** | The Bandwidth phone number associated with the message. | [optional] [default to undefined]
|
|
10
|
-
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth
|
|
10
|
+
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth App. | [optional] [default to undefined]
|
|
11
11
|
**time** | **string** | The datetime stamp of the message in ISO 8601 | [optional] [default to undefined]
|
|
12
12
|
**segmentCount** | **number** | The number of segments the user\'s message is broken into before sending over carrier networks. | [optional] [default to undefined]
|
|
13
13
|
**direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) | | [optional] [default to undefined]
|
package/docs/MessageRequest.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth
|
|
8
|
+
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth App. | [default to undefined]
|
|
9
9
|
**to** | **Set<string>** | The phone number(s) the message should be sent to in E164 format. | [default to undefined]
|
|
10
10
|
**from** | **string** | Either an alphanumeric sender ID or the sender\'s Bandwidth phone number in E.164 format, which must be hosted within Bandwidth and linked to the account that is generating the message. Alphanumeric Sender IDs can contain up to 11 characters, upper-case letters A-Z, lower-case letters a-z, numbers 0-9, space, hyphen -, plus +, underscore _ and ampersand &. Alphanumeric Sender IDs must contain at least one letter. | [default to undefined]
|
|
11
11
|
**text** | **string** | The contents of the text message. Must be 2048 characters or less. | [optional] [default to undefined]
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**from** | **string** | The sender ID of the message. This could be an alphanumeric sender ID. | [default to undefined]
|
|
9
|
-
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth
|
|
9
|
+
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth App. | [default to undefined]
|
|
10
10
|
**channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [default to undefined]
|
|
11
11
|
**content** | [**MmsMessageContent**](MmsMessageContent.md) | | [default to undefined]
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**from** | **string** | The sender ID of the message. This could be an alphanumeric sender ID. | [default to undefined]
|
|
9
|
-
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth
|
|
9
|
+
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth App. | [default to undefined]
|
|
10
10
|
**channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [default to undefined]
|
|
11
11
|
**content** | [**MmsMessageContent**](MmsMessageContent.md) | | [default to undefined]
|
|
12
12
|
**owner** | **string** | The Bandwidth senderId associated with the message. Identical to \'from\'. | [default to undefined]
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**from** | **string** | The sender ID of the message. This could be an alphanumeric sender ID. | [default to undefined]
|
|
9
|
-
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth
|
|
9
|
+
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth App. | [default to undefined]
|
|
10
10
|
**channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**from** | **string** | The sender ID of the message. This could be an alphanumeric sender ID. | [default to undefined]
|
|
9
|
-
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth
|
|
9
|
+
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth App. | [default to undefined]
|
|
10
10
|
**channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [default to undefined]
|
|
11
11
|
**content** | [**MultiChannelChannelListRBMObjectAllOfContent**](MultiChannelChannelListRBMObjectAllOfContent.md) | | [default to undefined]
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**from** | **string** | The sender ID of the message. This could be an alphanumeric sender ID. | [default to undefined]
|
|
9
|
-
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth
|
|
9
|
+
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth App. | [default to undefined]
|
|
10
10
|
**channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [default to undefined]
|
|
11
11
|
**content** | [**MultiChannelChannelListRBMObjectAllOfContent**](MultiChannelChannelListRBMObjectAllOfContent.md) | | [default to undefined]
|
|
12
12
|
**owner** | **string** | The Bandwidth senderId associated with the message. Identical to \'from\'. | [default to undefined]
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**from** | **string** | The sender ID of the message. This could be an alphanumeric sender ID. | [default to undefined]
|
|
9
|
-
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth
|
|
9
|
+
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth App. | [default to undefined]
|
|
10
10
|
**channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [default to undefined]
|
|
11
11
|
**content** | [**MmsMessageContent**](MmsMessageContent.md) | | [default to undefined]
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**from** | **string** | The sender ID of the message. This could be an alphanumeric sender ID. | [default to undefined]
|
|
9
|
-
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth
|
|
9
|
+
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth App. | [default to undefined]
|
|
10
10
|
**channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [default to undefined]
|
|
11
11
|
**content** | [**MmsMessageContent**](MmsMessageContent.md) | | [default to undefined]
|
|
12
12
|
**owner** | **string** | The Bandwidth senderId associated with the message. Identical to \'from\'. | [default to undefined]
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**from** | **string** | The sender ID of the message. This could be an alphanumeric sender ID. | [default to undefined]
|
|
9
|
-
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth
|
|
9
|
+
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth App. | [default to undefined]
|
|
10
10
|
**channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [default to undefined]
|
|
11
11
|
**content** | [**SmsMessageContent**](SmsMessageContent.md) | | [default to undefined]
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**from** | **string** | The sender ID of the message. This could be an alphanumeric sender ID. | [default to undefined]
|
|
9
|
-
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth
|
|
9
|
+
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth App. | [default to undefined]
|
|
10
10
|
**channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [default to undefined]
|
|
11
11
|
**content** | [**SmsMessageContent**](SmsMessageContent.md) | | [default to undefined]
|
|
12
12
|
**owner** | **string** | The Bandwidth senderId associated with the message. Identical to \'from\'. | [default to undefined]
|
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**id** | **string** | A unique identifier of the message. | [default to undefined]
|
|
10
10
|
**owner** | **string** | The Bandwidth phone number or alphanumeric identifier associated with the message. | [default to undefined]
|
|
11
|
-
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth
|
|
11
|
+
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth App. | [default to undefined]
|
|
12
12
|
**time** | **string** | | [default to undefined]
|
|
13
13
|
**segmentCount** | **number** | The number of segments the user\'s message is broken into before sending over carrier networks. | [default to undefined]
|
|
14
14
|
**direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) | | [default to undefined]
|
|
@@ -17,7 +17,7 @@ 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** | Government-issued business identifying number. | [optional] [default to undefined]
|
|
20
|
+
**businessRegistrationNumber** | **string** | Government-issued business identifying number. **Note:** If this field is provided, it is strongly recommended to also provide `businessRegistrationType` and `businessRegistrationIssuingCountry`. Submissions missing these fields have a high likelihood of rejection. | [optional] [default to undefined]
|
|
21
21
|
**businessRegistrationType** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] [default to undefined]
|
|
22
22
|
**businessRegistrationIssuingCountry** | [**BusinessRegistrationIssuingCountryEnum**](BusinessRegistrationIssuingCountryEnum.md) | | [optional] [default to undefined]
|
|
23
23
|
**businessEntityType** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] [default to undefined]
|
|
@@ -18,7 +18,7 @@ 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** | Government-issued business identifying number. | [optional] [default to undefined]
|
|
21
|
+
**businessRegistrationNumber** | **string** | Government-issued business identifying number. **Note:** If this field is provided, it is strongly recommended to also provide `businessRegistrationType` and `businessRegistrationIssuingCountry`. Submissions missing these fields have a high likelihood of rejection. | [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
24
|
**businessEntityType** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [default to undefined]
|
|
@@ -17,7 +17,7 @@ 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** | Government-issued business identifying number. | [optional] [default to undefined]
|
|
20
|
+
**businessRegistrationNumber** | **string** | Government-issued business identifying number. **Note:** If this field is provided, it is strongly recommended to also provide `businessRegistrationType` and `businessRegistrationIssuingCountry`. Submissions missing these fields have a high likelihood of rejection. | [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
23
|
**businessRegistrationIssuingCountry** | [**BusinessRegistrationIssuingCountryEnum**](BusinessRegistrationIssuingCountryEnum.md) | | [optional] [default to undefined]
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
|
|
16
16
|
|
|
17
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 |
|
|
18
|
+
* The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 country codes are acceptable, but the application will convert them to alpha-3 when received, so alpha-3 is encouraged. **Note:** If this field is omitted but `businessRegistrationType` is provided, the application will attempt to infer the country based on the registration type. However, if the application cannot confidently infer the country, the submission may be rejected. To ensure the highest likelihood of acceptance, it is recommended to provide both `businessRegistrationType` and `businessRegistrationIssuingCountry`. | 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
19
|
*/
|
|
20
20
|
|
|
21
21
|
export const BusinessRegistrationIssuingCountryEnum = {
|
|
@@ -31,7 +31,11 @@ export const BusinessRegistrationIssuingCountryEnum = {
|
|
|
31
31
|
Nzl: 'NZL',
|
|
32
32
|
Deu: 'DEU',
|
|
33
33
|
Esp: 'ESP',
|
|
34
|
-
Che: 'CHE'
|
|
34
|
+
Che: 'CHE',
|
|
35
|
+
Cyp: 'CYP',
|
|
36
|
+
Ind: 'IND',
|
|
37
|
+
Chn: 'CHN',
|
|
38
|
+
Bgr: 'BGR'
|
|
35
39
|
} as const;
|
|
36
40
|
|
|
37
41
|
export type BusinessRegistrationIssuingCountryEnum = typeof BusinessRegistrationIssuingCountryEnum[keyof typeof BusinessRegistrationIssuingCountryEnum];
|
package/models/callback.ts
CHANGED
|
@@ -30,6 +30,6 @@ import type { StatusCallback } from './status-callback';
|
|
|
30
30
|
* @type Callback
|
|
31
31
|
* Callbacks are divided into two types based on direction of the related message: - `statusCallback` indicates status of an outbound MT SMS, MMS, or RBM message. - `inboundCallback` indicates an inbound MO message or a multichannel message client\'s response to a suggestion or location request.
|
|
32
32
|
*/
|
|
33
|
-
export type Callback = { type: 'message-delivered' } & StatusCallback | { type: 'message-failed' } & StatusCallback | { type: 'message-read' } & StatusCallback | { type: 'message-received' } & InboundCallback | { type: 'message-sent' } & StatusCallback | { type: 'request-location-response' } & InboundCallback | { type: 'suggestion-response' } & InboundCallback;
|
|
33
|
+
export type Callback = { type: 'message-delivered' } & StatusCallback | { type: 'message-failed' } & StatusCallback | { type: 'message-read' } & StatusCallback | { type: 'message-received' } & InboundCallback | { type: 'message-sending' } & StatusCallback | { type: 'message-sent' } & StatusCallback | { type: 'request-location-response' } & InboundCallback | { type: 'suggestion-response' } & InboundCallback;
|
|
34
34
|
|
|
35
35
|
|
|
@@ -15,13 +15,14 @@
|
|
|
15
15
|
|
|
16
16
|
|
|
17
17
|
/**
|
|
18
|
-
* [DNI-Only](#section/DNI-Only). The current delivery status of the phone number. - ACTIVE: A message was successfully sent to the number (delivery code 0). - DEACTIVATED: A message was not delivered to a number (delivery code 720) - UNKNOWN: Bandwidth cannot find an delivery status entry for the number.
|
|
18
|
+
* [DNI-Only](#section/DNI-Only). The current delivery status of the phone number. - ACTIVE: A message was successfully sent to the number (delivery code 0). - DEACTIVATED: A message was not delivered to a number (delivery code 720) - UNKNOWN: Bandwidth cannot find an delivery status entry for the number. - NOT_ENABLED: The phone number is not enabled for messaging, so there is no delivery status information.
|
|
19
19
|
*/
|
|
20
20
|
|
|
21
21
|
export const LatestMessageDeliveryStatusEnum = {
|
|
22
22
|
Active: 'ACTIVE',
|
|
23
23
|
Deactivated: 'DEACTIVATED',
|
|
24
|
-
Unknown: 'UNKNOWN'
|
|
24
|
+
Unknown: 'UNKNOWN',
|
|
25
|
+
NotEnabled: 'NOT_ENABLED'
|
|
25
26
|
} as const;
|
|
26
27
|
|
|
27
28
|
export type LatestMessageDeliveryStatusEnum = typeof LatestMessageDeliveryStatusEnum[keyof typeof LatestMessageDeliveryStatusEnum];
|
|
@@ -19,7 +19,7 @@ import type { PriorityEnum } from './priority-enum';
|
|
|
19
19
|
|
|
20
20
|
export interface MessageRequest {
|
|
21
21
|
/**
|
|
22
|
-
* The ID of the Application your from number or senderId is associated with in the Bandwidth
|
|
22
|
+
* The ID of the Application your from number or senderId is associated with in the Bandwidth App.
|
|
23
23
|
*/
|
|
24
24
|
'applicationId': string;
|
|
25
25
|
/**
|
package/models/message.ts
CHANGED
|
@@ -30,7 +30,7 @@ export interface Message {
|
|
|
30
30
|
*/
|
|
31
31
|
'owner'?: string;
|
|
32
32
|
/**
|
|
33
|
-
* The ID of the Application your from number or senderId is associated with in the Bandwidth
|
|
33
|
+
* The ID of the Application your from number or senderId is associated with in the Bandwidth App.
|
|
34
34
|
*/
|
|
35
35
|
'applicationId'?: string;
|
|
36
36
|
/**
|
|
@@ -23,7 +23,7 @@ export interface MultiChannelChannelListObjectBase {
|
|
|
23
23
|
*/
|
|
24
24
|
'from': string;
|
|
25
25
|
/**
|
|
26
|
-
* The ID of the Application your from number or senderId is associated with in the Bandwidth
|
|
26
|
+
* The ID of the Application your from number or senderId is associated with in the Bandwidth App.
|
|
27
27
|
*/
|
|
28
28
|
'applicationId': string;
|
|
29
29
|
'channel': MultiChannelMessageChannelEnum;
|
|
@@ -35,7 +35,7 @@ export interface MultiChannelChannelListRequestObject {
|
|
|
35
35
|
*/
|
|
36
36
|
'from': string;
|
|
37
37
|
/**
|
|
38
|
-
* The ID of the Application your from number or senderId is associated with in the Bandwidth
|
|
38
|
+
* The ID of the Application your from number or senderId is associated with in the Bandwidth App.
|
|
39
39
|
*/
|
|
40
40
|
'applicationId': string;
|
|
41
41
|
'channel': MultiChannelMessageChannelEnum;
|
|
@@ -35,7 +35,7 @@ export interface MultiChannelChannelListResponseObject {
|
|
|
35
35
|
*/
|
|
36
36
|
'from': string;
|
|
37
37
|
/**
|
|
38
|
-
* The ID of the Application your from number or senderId is associated with in the Bandwidth
|
|
38
|
+
* The ID of the Application your from number or senderId is associated with in the Bandwidth App.
|
|
39
39
|
*/
|
|
40
40
|
'applicationId': string;
|
|
41
41
|
'channel': MultiChannelMessageChannelEnum;
|
|
@@ -36,7 +36,7 @@ export interface StatusCallbackMessage {
|
|
|
36
36
|
*/
|
|
37
37
|
'owner': string;
|
|
38
38
|
/**
|
|
39
|
-
* The ID of the Application your from number or senderId is associated with in the Bandwidth
|
|
39
|
+
* The ID of the Application your from number or senderId is associated with in the Bandwidth App.
|
|
40
40
|
*/
|
|
41
41
|
'applicationId': string;
|
|
42
42
|
'time': string;
|
|
@@ -73,7 +73,7 @@ export interface TfvSubmissionInfo {
|
|
|
73
73
|
*/
|
|
74
74
|
'businessDba'?: string;
|
|
75
75
|
/**
|
|
76
|
-
* Government-issued business identifying number.
|
|
76
|
+
* Government-issued business identifying number. **Note:** If this field is provided, it is strongly recommended to also provide `businessRegistrationType` and `businessRegistrationIssuingCountry`. Submissions missing these fields have a high likelihood of rejection.
|
|
77
77
|
*/
|
|
78
78
|
'businessRegistrationNumber'?: string | null;
|
|
79
79
|
'businessRegistrationType'?: BusinessRegistrationTypeEnum | null;
|
|
@@ -74,7 +74,7 @@ export interface VerificationRequest {
|
|
|
74
74
|
*/
|
|
75
75
|
'businessDba'?: string;
|
|
76
76
|
/**
|
|
77
|
-
* Government-issued business identifying number.
|
|
77
|
+
* Government-issued business identifying number. **Note:** If this field is provided, it is strongly recommended to also provide `businessRegistrationType` and `businessRegistrationIssuingCountry`. Submissions missing these fields have a high likelihood of rejection.
|
|
78
78
|
*/
|
|
79
79
|
'businessRegistrationNumber'?: string | null;
|
|
80
80
|
'businessRegistrationType'?: BusinessRegistrationTypeEnum | null;
|
|
@@ -73,7 +73,7 @@ export interface VerificationUpdateRequest {
|
|
|
73
73
|
*/
|
|
74
74
|
'businessDba'?: string;
|
|
75
75
|
/**
|
|
76
|
-
* Government-issued business identifying number.
|
|
76
|
+
* Government-issued business identifying number. **Note:** If this field is provided, it is strongly recommended to also provide `businessRegistrationType` and `businessRegistrationIssuingCountry`. Submissions missing these fields have a high likelihood of rejection.
|
|
77
77
|
*/
|
|
78
78
|
'businessRegistrationNumber'?: string | null;
|
|
79
79
|
'businessRegistrationType'?: BusinessRegistrationTypeEnum | null;
|
package/package.json
CHANGED
|
@@ -54,7 +54,6 @@ describe('PhoneNumberLookupApi', () => {
|
|
|
54
54
|
expect(getData.data.results[0]).toBeDefined();
|
|
55
55
|
expect(getData.data.results[0].phoneNumber).toBeString();
|
|
56
56
|
expect(getData.data.results[0].lineType).toBeOneOf(Object.values(LineTypeEnum));
|
|
57
|
-
expect(getData.data.results[0].messagingProvider).toBeString();
|
|
58
57
|
expect(getData.data.results[0].voiceProvider).toBeString();
|
|
59
58
|
expect(getData.data.results[0].countryCodeA3).toBeString();
|
|
60
59
|
});
|
|
@@ -77,7 +76,6 @@ describe('PhoneNumberLookupApi', () => {
|
|
|
77
76
|
expect(data.data.results[0]).toBeDefined();
|
|
78
77
|
expect(data.data.results[0].phoneNumber).toBeString();
|
|
79
78
|
expect(data.data.results[0].lineType).toBeOneOf(Object.values(LineTypeEnum));
|
|
80
|
-
expect(data.data.results[0].messagingProvider).toBeString();
|
|
81
79
|
expect(data.data.results[0].voiceProvider).toBeString();
|
|
82
80
|
expect(data.data.results[0].countryCodeA3).toBeString();
|
|
83
81
|
});
|
|
@@ -15,5 +15,9 @@ describe('BusinessRegistrationIssuingCountryEnum', () => {
|
|
|
15
15
|
expect(BusinessRegistrationIssuingCountryEnum.Deu).toBe('DEU');
|
|
16
16
|
expect(BusinessRegistrationIssuingCountryEnum.Esp).toBe('ESP');
|
|
17
17
|
expect(BusinessRegistrationIssuingCountryEnum.Che).toBe('CHE');
|
|
18
|
+
expect(BusinessRegistrationIssuingCountryEnum.Cyp).toBe('CYP');
|
|
19
|
+
expect(BusinessRegistrationIssuingCountryEnum.Ind).toBe('IND');
|
|
20
|
+
expect(BusinessRegistrationIssuingCountryEnum.Chn).toBe('CHN');
|
|
21
|
+
expect(BusinessRegistrationIssuingCountryEnum.Bgr).toBe('BGR');
|
|
18
22
|
});
|
|
19
23
|
});
|
|
@@ -5,6 +5,7 @@ describe('LatestMessageDeliveryStatusEnum', () => {
|
|
|
5
5
|
expect(LatestMessageDeliveryStatusEnum.Active).toBe('ACTIVE');
|
|
6
6
|
expect(LatestMessageDeliveryStatusEnum.Deactivated).toBe('DEACTIVATED');
|
|
7
7
|
expect(LatestMessageDeliveryStatusEnum.Unknown).toBe('UNKNOWN');
|
|
8
|
+
expect(LatestMessageDeliveryStatusEnum.NotEnabled).toBe('NOT_ENABLED');
|
|
8
9
|
});
|
|
9
10
|
});
|
|
10
11
|
|