bandwidth-sdk 7.1.0 → 7.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/deploy.yml +9 -4
- package/.openapi-generator/FILES +4 -0
- package/README.md +2 -0
- package/api/messages-api.ts +4 -4
- package/bandwidth.yml +81 -5
- package/configuration.ts +1 -1
- package/coverage/clover.xml +16 -6
- package/coverage/coverage-final.json +4 -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 +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 +1 -1
- package/coverage/lcov-report/node-sdk/models/business-registration-type-enum.ts.html +1 -1
- 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 +35 -5
- package/coverage/lcov-report/node-sdk/models/index.ts.html +10 -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 +172 -0
- package/coverage/lcov-report/node-sdk/models/rbm-web-view-enum.ts.html +175 -0
- 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 +27 -5
- package/custom_templates/package.mustache +6 -7
- 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/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/dist/models/multi-channel-action.d.ts +4 -0
- package/dist/models/rbm-message-media.d.ts +1 -1
- package/dist/models/rbm-open-url-enum.d.ts +19 -0
- package/dist/models/rbm-open-url-enum.js +23 -0
- package/dist/models/rbm-web-view-enum.d.ts +20 -0
- package/dist/models/rbm-web-view-enum.js +24 -0
- package/dist/models/tfv-status.d.ts +4 -0
- package/dist/models/verification-request.d.ts +4 -0
- package/dist/models/verification-update-request.d.ts +4 -0
- package/docs/MessagesApi.md +3 -2
- package/docs/MultiChannelAction.md +4 -0
- package/docs/MultiChannelChannelListRBMObjectAllOfContent.md +1 -1
- package/docs/RbmActionOpenUrl.md +4 -0
- package/docs/RbmMessageMedia.md +1 -1
- package/docs/RbmOpenUrlEnum.md +11 -0
- package/docs/RbmWebViewEnum.md +13 -0
- package/docs/TfvStatus.md +2 -0
- package/docs/VerificationRequest.md +2 -0
- package/docs/VerificationUpdateRequest.md +2 -0
- package/models/index.ts +2 -0
- package/models/multi-channel-action.ts +8 -0
- package/models/rbm-action-open-url.ts +6 -0
- package/models/rbm-message-media.ts +1 -1
- package/models/rbm-open-url-enum.ts +29 -0
- package/models/rbm-web-view-enum.ts +30 -0
- package/models/tfv-status.ts +4 -0
- package/models/verification-request.ts +4 -0
- package/models/verification-update-request.ts +4 -0
- package/package.json +7 -3
- package/tests/smoke/multi-channel-api.test.ts +240 -4
- package/tests/unit/api/toll-free-verification-api.test.ts +15 -2
- package/tests/unit/models/rbm-open-url-enum.test.ts +8 -0
- package/tests/unit/models/rbm-veb-view-enum.test.ts +9 -0
|
@@ -10,6 +10,8 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { RbmActionTypeEnum } from './rbm-action-type-enum';
|
|
13
|
+
import type { RbmOpenUrlEnum } from './rbm-open-url-enum';
|
|
14
|
+
import type { RbmWebViewEnum } from './rbm-web-view-enum';
|
|
13
15
|
export interface MultiChannelAction {
|
|
14
16
|
'type': RbmActionTypeEnum;
|
|
15
17
|
/**
|
|
@@ -56,4 +58,6 @@ export interface MultiChannelAction {
|
|
|
56
58
|
* The URL to open in browser.
|
|
57
59
|
*/
|
|
58
60
|
'url': string;
|
|
61
|
+
'application'?: RbmOpenUrlEnum;
|
|
62
|
+
'webviewViewMode'?: RbmWebViewEnum;
|
|
59
63
|
}
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
import type { MultiChannelAction } from './multi-channel-action';
|
|
13
13
|
import type { RbmMessageContentFile } from './rbm-message-content-file';
|
|
14
14
|
export interface RbmMessageMedia {
|
|
15
|
-
'media': RbmMessageContentFile
|
|
15
|
+
'media': Array<RbmMessageContentFile>;
|
|
16
16
|
/**
|
|
17
17
|
* An array of suggested actions for the recipient.
|
|
18
18
|
*/
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Bandwidth
|
|
3
|
+
* Bandwidth\'s Communication APIs
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
* Contact: letstalk@bandwidth.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Specifies how the URL should be opened on a mobile device. - `BROWSER` Opens the URL in the device\'s default browser. If application is not set or the device doesn’t support WebView, this option is used by default. - `WEBVIEW` Opens the URL in an in-app WebView.
|
|
14
|
+
*/
|
|
15
|
+
export declare const RbmOpenUrlEnum: {
|
|
16
|
+
readonly Browser: "BROWSER";
|
|
17
|
+
readonly Webview: "WEBVIEW";
|
|
18
|
+
};
|
|
19
|
+
export type RbmOpenUrlEnum = typeof RbmOpenUrlEnum[keyof typeof RbmOpenUrlEnum];
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Bandwidth
|
|
6
|
+
* Bandwidth\'s Communication APIs
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
* Contact: letstalk@bandwidth.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.RbmOpenUrlEnum = void 0;
|
|
17
|
+
/**
|
|
18
|
+
* Specifies how the URL should be opened on a mobile device. - `BROWSER` Opens the URL in the device\'s default browser. If application is not set or the device doesn’t support WebView, this option is used by default. - `WEBVIEW` Opens the URL in an in-app WebView.
|
|
19
|
+
*/
|
|
20
|
+
exports.RbmOpenUrlEnum = {
|
|
21
|
+
Browser: 'BROWSER',
|
|
22
|
+
Webview: 'WEBVIEW'
|
|
23
|
+
};
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Bandwidth
|
|
3
|
+
* Bandwidth\'s Communication APIs
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
* Contact: letstalk@bandwidth.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Defines the layout of the WebView on a mobile device. It must be defined when application is set to `WEBVIEW` - `FULL` WebView takes the full screen. - `HALF` WebView takes half of the screen. - `TALL` WebView takes three-quarters of the screen.
|
|
14
|
+
*/
|
|
15
|
+
export declare const RbmWebViewEnum: {
|
|
16
|
+
readonly Full: "FULL";
|
|
17
|
+
readonly Half: "HALF";
|
|
18
|
+
readonly Tall: "TALL";
|
|
19
|
+
};
|
|
20
|
+
export type RbmWebViewEnum = typeof RbmWebViewEnum[keyof typeof RbmWebViewEnum];
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Bandwidth
|
|
6
|
+
* Bandwidth\'s Communication APIs
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
* Contact: letstalk@bandwidth.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.RbmWebViewEnum = void 0;
|
|
17
|
+
/**
|
|
18
|
+
* Defines the layout of the WebView on a mobile device. It must be defined when application is set to `WEBVIEW` - `FULL` WebView takes the full screen. - `HALF` WebView takes half of the screen. - `TALL` WebView takes three-quarters of the screen.
|
|
19
|
+
*/
|
|
20
|
+
exports.RbmWebViewEnum = {
|
|
21
|
+
Full: 'FULL',
|
|
22
|
+
Half: 'HALF',
|
|
23
|
+
Tall: 'TALL'
|
|
24
|
+
};
|
|
@@ -46,4 +46,8 @@ export interface TfvStatus {
|
|
|
46
46
|
* The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked.
|
|
47
47
|
*/
|
|
48
48
|
'blockedReason'?: string;
|
|
49
|
+
/**
|
|
50
|
+
* 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. If you pass an empty string, it will be passed along and potentially rejected.
|
|
51
|
+
*/
|
|
52
|
+
'cvToken'?: string | null;
|
|
49
53
|
}
|
|
@@ -69,4 +69,8 @@ export interface VerificationRequest {
|
|
|
69
69
|
* Indicates whether the content is age-gated.
|
|
70
70
|
*/
|
|
71
71
|
'ageGatedContent'?: boolean;
|
|
72
|
+
/**
|
|
73
|
+
* 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. If you pass an empty string, it will be passed along and potentially rejected.
|
|
74
|
+
*/
|
|
75
|
+
'cvToken'?: string | null;
|
|
72
76
|
}
|
|
@@ -68,4 +68,8 @@ export interface VerificationUpdateRequest {
|
|
|
68
68
|
* Indicates whether the content is age-gated.
|
|
69
69
|
*/
|
|
70
70
|
'ageGatedContent'?: boolean;
|
|
71
|
+
/**
|
|
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. If you pass an empty string, it will be passed along and potentially rejected.
|
|
73
|
+
*/
|
|
74
|
+
'cvToken'?: string | null;
|
|
71
75
|
}
|
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)
|
|
@@ -17,6 +17,8 @@ Name | Type | Description | Notes
|
|
|
17
17
|
**endTime** | **string** | The end time of the event. | [default to undefined]
|
|
18
18
|
**description** | **string** | The description of the event. | [optional] [default to undefined]
|
|
19
19
|
**url** | **string** | The URL to open in browser. | [default to undefined]
|
|
20
|
+
**application** | [**RbmOpenUrlEnum**](RbmOpenUrlEnum.md) | | [optional] [default to undefined]
|
|
21
|
+
**webviewViewMode** | [**RbmWebViewEnum**](RbmWebViewEnum.md) | | [optional] [default to undefined]
|
|
20
22
|
|
|
21
23
|
## Example
|
|
22
24
|
|
|
@@ -36,6 +38,8 @@ const instance: MultiChannelAction = {
|
|
|
36
38
|
endTime,
|
|
37
39
|
description,
|
|
38
40
|
url,
|
|
41
|
+
application,
|
|
42
|
+
webviewViewMode,
|
|
39
43
|
};
|
|
40
44
|
```
|
|
41
45
|
|
|
@@ -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/RbmActionOpenUrl.md
CHANGED
|
@@ -9,6 +9,8 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**text** | **string** | Displayed text for user to click | [default to undefined]
|
|
10
10
|
**postbackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [default to undefined]
|
|
11
11
|
**url** | **string** | The URL to open in browser. | [default to undefined]
|
|
12
|
+
**application** | [**RbmOpenUrlEnum**](RbmOpenUrlEnum.md) | | [optional] [default to undefined]
|
|
13
|
+
**webviewViewMode** | [**RbmWebViewEnum**](RbmWebViewEnum.md) | | [optional] [default to undefined]
|
|
12
14
|
|
|
13
15
|
## Example
|
|
14
16
|
|
|
@@ -20,6 +22,8 @@ const instance: RbmActionOpenUrl = {
|
|
|
20
22
|
text,
|
|
21
23
|
postbackData,
|
|
22
24
|
url,
|
|
25
|
+
application,
|
|
26
|
+
webviewViewMode,
|
|
23
27
|
};
|
|
24
28
|
```
|
|
25
29
|
|
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
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# RbmOpenUrlEnum
|
|
2
|
+
|
|
3
|
+
Specifies how the URL should be opened on a mobile device. - `BROWSER` Opens the URL in the device\'s default browser. If application is not set or the device doesn’t support WebView, this option is used by default. - `WEBVIEW` Opens the URL in an in-app WebView.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `Browser` (value: `'BROWSER'`)
|
|
8
|
+
|
|
9
|
+
* `Webview` (value: `'WEBVIEW'`)
|
|
10
|
+
|
|
11
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# RbmWebViewEnum
|
|
2
|
+
|
|
3
|
+
Defines the layout of the WebView on a mobile device. It must be defined when application is set to `WEBVIEW` - `FULL` WebView takes the full screen. - `HALF` WebView takes half of the screen. - `TALL` WebView takes three-quarters of the screen.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `Full` (value: `'FULL'`)
|
|
8
|
+
|
|
9
|
+
* `Half` (value: `'HALF'`)
|
|
10
|
+
|
|
11
|
+
* `Tall` (value: `'TALL'`)
|
|
12
|
+
|
|
13
|
+
[[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/TfvStatus.md
CHANGED
|
@@ -15,6 +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. If you pass an empty string, it will be passed along and potentially rejected. | [optional] [default to undefined]
|
|
18
19
|
|
|
19
20
|
## Example
|
|
20
21
|
|
|
@@ -32,6 +33,7 @@ const instance: TfvStatus = {
|
|
|
32
33
|
submission,
|
|
33
34
|
blocked,
|
|
34
35
|
blockedReason,
|
|
36
|
+
cvToken,
|
|
35
37
|
};
|
|
36
38
|
```
|
|
37
39
|
|
|
@@ -23,6 +23,7 @@ Name | Type | Description | Notes
|
|
|
23
23
|
**businessEntityType** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] [default to undefined]
|
|
24
24
|
**helpMessageResponse** | **string** | A message that gets sent to users requesting help. | [optional] [default to undefined]
|
|
25
25
|
**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. If you pass an empty string, it will be passed along and potentially rejected. | [optional] [default to undefined]
|
|
26
27
|
|
|
27
28
|
## Example
|
|
28
29
|
|
|
@@ -48,6 +49,7 @@ const instance: VerificationRequest = {
|
|
|
48
49
|
businessEntityType,
|
|
49
50
|
helpMessageResponse,
|
|
50
51
|
ageGatedContent,
|
|
52
|
+
cvToken,
|
|
51
53
|
};
|
|
52
54
|
```
|
|
53
55
|
|
|
@@ -22,6 +22,7 @@ Name | Type | Description | Notes
|
|
|
22
22
|
**businessEntityType** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] [default to undefined]
|
|
23
23
|
**helpMessageResponse** | **string** | A message that gets sent to users requesting help. | [optional] [default to undefined]
|
|
24
24
|
**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. If you pass an empty string, it will be passed along and potentially rejected. | [optional] [default to undefined]
|
|
25
26
|
|
|
26
27
|
## Example
|
|
27
28
|
|
|
@@ -46,6 +47,7 @@ const instance: VerificationUpdateRequest = {
|
|
|
46
47
|
businessEntityType,
|
|
47
48
|
helpMessageResponse,
|
|
48
49
|
ageGatedContent,
|
|
50
|
+
cvToken,
|
|
49
51
|
};
|
|
50
52
|
```
|
|
51
53
|
|
package/models/index.ts
CHANGED
|
@@ -124,8 +124,10 @@ export * from './rbm-message-content-file';
|
|
|
124
124
|
export * from './rbm-message-content-rich-card';
|
|
125
125
|
export * from './rbm-message-content-text';
|
|
126
126
|
export * from './rbm-message-media';
|
|
127
|
+
export * from './rbm-open-url-enum';
|
|
127
128
|
export * from './rbm-standalone-card';
|
|
128
129
|
export * from './rbm-suggestion-response';
|
|
130
|
+
export * from './rbm-web-view-enum';
|
|
129
131
|
export * from './recording-available-callback';
|
|
130
132
|
export * from './recording-complete-callback';
|
|
131
133
|
export * from './recording-state-enum';
|
|
@@ -31,6 +31,12 @@ import type { RbmActionTypeEnum } from './rbm-action-type-enum';
|
|
|
31
31
|
// May contain unused imports in some cases
|
|
32
32
|
// @ts-ignore
|
|
33
33
|
import type { RbmActionViewLocation } from './rbm-action-view-location';
|
|
34
|
+
// May contain unused imports in some cases
|
|
35
|
+
// @ts-ignore
|
|
36
|
+
import type { RbmOpenUrlEnum } from './rbm-open-url-enum';
|
|
37
|
+
// May contain unused imports in some cases
|
|
38
|
+
// @ts-ignore
|
|
39
|
+
import type { RbmWebViewEnum } from './rbm-web-view-enum';
|
|
34
40
|
|
|
35
41
|
export interface MultiChannelAction {
|
|
36
42
|
'type': RbmActionTypeEnum;
|
|
@@ -78,6 +84,8 @@ export interface MultiChannelAction {
|
|
|
78
84
|
* The URL to open in browser.
|
|
79
85
|
*/
|
|
80
86
|
'url': string;
|
|
87
|
+
'application'?: RbmOpenUrlEnum;
|
|
88
|
+
'webviewViewMode'?: RbmWebViewEnum;
|
|
81
89
|
}
|
|
82
90
|
|
|
83
91
|
|
|
@@ -19,6 +19,12 @@ import type { RbmActionBase } from './rbm-action-base';
|
|
|
19
19
|
// May contain unused imports in some cases
|
|
20
20
|
// @ts-ignore
|
|
21
21
|
import type { RbmActionTypeEnum } from './rbm-action-type-enum';
|
|
22
|
+
// May contain unused imports in some cases
|
|
23
|
+
// @ts-ignore
|
|
24
|
+
import type { RbmOpenUrlEnum } from './rbm-open-url-enum';
|
|
25
|
+
// May contain unused imports in some cases
|
|
26
|
+
// @ts-ignore
|
|
27
|
+
import type { RbmWebViewEnum } from './rbm-web-view-enum';
|
|
22
28
|
|
|
23
29
|
/**
|
|
24
30
|
* @type RbmActionOpenUrl
|
|
@@ -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
|
*/
|
|
@@ -0,0 +1,29 @@
|
|
|
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
|
+
* Specifies how the URL should be opened on a mobile device. - `BROWSER` Opens the URL in the device\'s default browser. If application is not set or the device doesn’t support WebView, this option is used by default. - `WEBVIEW` Opens the URL in an in-app WebView.
|
|
19
|
+
*/
|
|
20
|
+
|
|
21
|
+
export const RbmOpenUrlEnum = {
|
|
22
|
+
Browser: 'BROWSER',
|
|
23
|
+
Webview: 'WEBVIEW'
|
|
24
|
+
} as const;
|
|
25
|
+
|
|
26
|
+
export type RbmOpenUrlEnum = typeof RbmOpenUrlEnum[keyof typeof RbmOpenUrlEnum];
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
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
|
+
* Defines the layout of the WebView on a mobile device. It must be defined when application is set to `WEBVIEW` - `FULL` WebView takes the full screen. - `HALF` WebView takes half of the screen. - `TALL` WebView takes three-quarters of the screen.
|
|
19
|
+
*/
|
|
20
|
+
|
|
21
|
+
export const RbmWebViewEnum = {
|
|
22
|
+
Full: 'FULL',
|
|
23
|
+
Half: 'HALF',
|
|
24
|
+
Tall: 'TALL'
|
|
25
|
+
} as const;
|
|
26
|
+
|
|
27
|
+
export type RbmWebViewEnum = typeof RbmWebViewEnum[keyof typeof RbmWebViewEnum];
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
|
package/models/tfv-status.ts
CHANGED
|
@@ -55,6 +55,10 @@ export interface TfvStatus {
|
|
|
55
55
|
* The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked.
|
|
56
56
|
*/
|
|
57
57
|
'blockedReason'?: string;
|
|
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. If you pass an empty string, it will be passed along and potentially rejected.
|
|
60
|
+
*/
|
|
61
|
+
'cvToken'?: string | null;
|
|
58
62
|
}
|
|
59
63
|
|
|
60
64
|
|
|
@@ -84,6 +84,10 @@ export interface VerificationRequest {
|
|
|
84
84
|
* Indicates whether the content is age-gated.
|
|
85
85
|
*/
|
|
86
86
|
'ageGatedContent'?: boolean;
|
|
87
|
+
/**
|
|
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. If you pass an empty string, it will be passed along and potentially rejected.
|
|
89
|
+
*/
|
|
90
|
+
'cvToken'?: string | null;
|
|
87
91
|
}
|
|
88
92
|
|
|
89
93
|
|
|
@@ -83,6 +83,10 @@ export interface VerificationUpdateRequest {
|
|
|
83
83
|
* Indicates whether the content is age-gated.
|
|
84
84
|
*/
|
|
85
85
|
'ageGatedContent'?: boolean;
|
|
86
|
+
/**
|
|
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. If you pass an empty string, it will be passed along and potentially rejected.
|
|
88
|
+
*/
|
|
89
|
+
'cvToken'?: string | null;
|
|
86
90
|
}
|
|
87
91
|
|
|
88
92
|
|
package/package.json
CHANGED
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "bandwidth-sdk",
|
|
3
|
-
"version": "7.
|
|
3
|
+
"version": "7.3.0",
|
|
4
4
|
"description": "OpenAPI client for bandwidth-sdk",
|
|
5
5
|
"author": "OpenAPI-Generator Contributors",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
8
|
-
"url": "
|
|
8
|
+
"url": "https://github.com/Bandwidth/node-sdk"
|
|
9
9
|
},
|
|
10
|
+
"homepage": "https://github.com/bandwidth/node-numbers",
|
|
10
11
|
"keywords": [
|
|
11
12
|
"axios",
|
|
12
13
|
"typescript",
|
|
@@ -14,7 +15,7 @@
|
|
|
14
15
|
"openapi-generator",
|
|
15
16
|
"bandwidth-sdk"
|
|
16
17
|
],
|
|
17
|
-
"license": "
|
|
18
|
+
"license": "MIT",
|
|
18
19
|
"main": "./dist/index.js",
|
|
19
20
|
"typings": "./dist/index.d.ts",
|
|
20
21
|
"scripts": {
|
|
@@ -38,5 +39,8 @@
|
|
|
38
39
|
"jest-extended": "^4.0.2",
|
|
39
40
|
"ts-jest": "^29.1.1",
|
|
40
41
|
"typescript": "^5.9.0"
|
|
42
|
+
},
|
|
43
|
+
"publishConfig": {
|
|
44
|
+
"access": "public"
|
|
41
45
|
}
|
|
42
46
|
}
|