bandwidth-sdk 7.1.0 → 7.2.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.
Files changed (132) hide show
  1. package/.github/workflows/deploy.yml +9 -4
  2. package/.openapi-generator/FILES +4 -0
  3. package/README.md +2 -0
  4. package/bandwidth.yml +51 -0
  5. package/configuration.ts +1 -1
  6. package/coverage/clover.xml +16 -6
  7. package/coverage/coverage-final.json +4 -2
  8. package/coverage/lcov-report/index.html +7 -7
  9. package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +1 -1
  10. package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +1 -1
  11. package/coverage/lcov-report/node-sdk/api/index.html +1 -1
  12. package/coverage/lcov-report/node-sdk/api/media-api.ts.html +1 -1
  13. package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +1 -1
  14. package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +1 -1
  15. package/coverage/lcov-report/node-sdk/api/multi-channel-api.ts.html +1 -1
  16. package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +1 -1
  17. package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +1 -1
  18. package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +1 -1
  19. package/coverage/lcov-report/node-sdk/api/toll-free-verification-api.ts.html +1 -1
  20. package/coverage/lcov-report/node-sdk/api/transcriptions-api.ts.html +1 -1
  21. package/coverage/lcov-report/node-sdk/api.ts.html +1 -1
  22. package/coverage/lcov-report/node-sdk/base.ts.html +1 -1
  23. package/coverage/lcov-report/node-sdk/common.ts.html +2 -2
  24. package/coverage/lcov-report/node-sdk/configuration.ts.html +2 -2
  25. package/coverage/lcov-report/node-sdk/index.html +1 -1
  26. package/coverage/lcov-report/node-sdk/models/business-entity-type-enum.ts.html +1 -1
  27. package/coverage/lcov-report/node-sdk/models/business-registration-type-enum.ts.html +1 -1
  28. package/coverage/lcov-report/node-sdk/models/bxml/Bxml.ts.html +1 -1
  29. package/coverage/lcov-report/node-sdk/models/bxml/NestableVerb.ts.html +1 -1
  30. package/coverage/lcov-report/node-sdk/models/bxml/Response.ts.html +1 -1
  31. package/coverage/lcov-report/node-sdk/models/bxml/Root.ts.html +1 -1
  32. package/coverage/lcov-report/node-sdk/models/bxml/Verb.ts.html +1 -1
  33. package/coverage/lcov-report/node-sdk/models/bxml/index.html +1 -1
  34. package/coverage/lcov-report/node-sdk/models/bxml/index.ts.html +1 -1
  35. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Bridge.ts.html +1 -1
  36. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Conference.ts.html +1 -1
  37. package/coverage/lcov-report/node-sdk/models/bxml/verbs/CustomParam.ts.html +1 -1
  38. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Forward.ts.html +1 -1
  39. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Gather.ts.html +1 -1
  40. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Hangup.ts.html +1 -1
  41. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Pause.ts.html +1 -1
  42. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PauseRecording.ts.html +1 -1
  43. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PhoneNumber.ts.html +1 -1
  44. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PlayAudio.ts.html +1 -1
  45. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Record.ts.html +1 -1
  46. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Redirect.ts.html +1 -1
  47. package/coverage/lcov-report/node-sdk/models/bxml/verbs/ResumeRecording.ts.html +1 -1
  48. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Ring.ts.html +1 -1
  49. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SendDtmf.ts.html +1 -1
  50. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SipUri.ts.html +1 -1
  51. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SpeakSentence.ts.html +1 -1
  52. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartGather.ts.html +1 -1
  53. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartRecording.ts.html +1 -1
  54. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartStream.ts.html +1 -1
  55. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartTranscription.ts.html +1 -1
  56. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopGather.ts.html +1 -1
  57. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopRecording.ts.html +1 -1
  58. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopStream.ts.html +1 -1
  59. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopTranscription.ts.html +1 -1
  60. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StreamParam.ts.html +1 -1
  61. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Tag.ts.html +1 -1
  62. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Transfer.ts.html +1 -1
  63. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.html +1 -1
  64. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.ts.html +1 -1
  65. package/coverage/lcov-report/node-sdk/models/call-direction-enum.ts.html +1 -1
  66. package/coverage/lcov-report/node-sdk/models/call-state-enum.ts.html +1 -1
  67. package/coverage/lcov-report/node-sdk/models/call-transcription-detected-language-enum.ts.html +1 -1
  68. package/coverage/lcov-report/node-sdk/models/call-transcription-track-enum.ts.html +1 -1
  69. package/coverage/lcov-report/node-sdk/models/callback-method-enum.ts.html +1 -1
  70. package/coverage/lcov-report/node-sdk/models/card-width-enum.ts.html +1 -1
  71. package/coverage/lcov-report/node-sdk/models/completed-lookup-status-enum.ts.html +1 -1
  72. package/coverage/lcov-report/node-sdk/models/conference-state-enum.ts.html +1 -1
  73. package/coverage/lcov-report/node-sdk/models/deactivation-event-enum.ts.html +1 -1
  74. package/coverage/lcov-report/node-sdk/models/file-format-enum.ts.html +1 -1
  75. package/coverage/lcov-report/node-sdk/models/in-progress-lookup-status-enum.ts.html +1 -1
  76. package/coverage/lcov-report/node-sdk/models/inbound-callback-type-enum.ts.html +1 -1
  77. package/coverage/lcov-report/node-sdk/models/index.html +35 -5
  78. package/coverage/lcov-report/node-sdk/models/index.ts.html +10 -4
  79. package/coverage/lcov-report/node-sdk/models/latest-message-delivery-status-enum.ts.html +1 -1
  80. package/coverage/lcov-report/node-sdk/models/line-type-enum.ts.html +1 -1
  81. package/coverage/lcov-report/node-sdk/models/list-message-direction-enum.ts.html +1 -1
  82. package/coverage/lcov-report/node-sdk/models/machine-detection-mode-enum.ts.html +1 -1
  83. package/coverage/lcov-report/node-sdk/models/message-direction-enum.ts.html +1 -1
  84. package/coverage/lcov-report/node-sdk/models/message-status-enum.ts.html +1 -1
  85. package/coverage/lcov-report/node-sdk/models/message-type-enum.ts.html +1 -1
  86. package/coverage/lcov-report/node-sdk/models/multi-channel-message-channel-enum.ts.html +1 -1
  87. package/coverage/lcov-report/node-sdk/models/priority-enum.ts.html +1 -1
  88. package/coverage/lcov-report/node-sdk/models/product-type-enum.ts.html +1 -1
  89. package/coverage/lcov-report/node-sdk/models/rbm-action-type-enum.ts.html +1 -1
  90. package/coverage/lcov-report/node-sdk/models/rbm-media-height-enum.ts.html +1 -1
  91. package/coverage/lcov-report/node-sdk/models/rbm-open-url-enum.ts.html +172 -0
  92. package/coverage/lcov-report/node-sdk/models/rbm-web-view-enum.ts.html +175 -0
  93. package/coverage/lcov-report/node-sdk/models/recording-state-enum.ts.html +1 -1
  94. package/coverage/lcov-report/node-sdk/models/redirect-method-enum.ts.html +1 -1
  95. package/coverage/lcov-report/node-sdk/models/standalone-card-orientation-enum.ts.html +1 -1
  96. package/coverage/lcov-report/node-sdk/models/status-callback-type-enum.ts.html +1 -1
  97. package/coverage/lcov-report/node-sdk/models/tfv-callback-status-enum.ts.html +1 -1
  98. package/coverage/lcov-report/node-sdk/models/tfv-status-enum.ts.html +1 -1
  99. package/coverage/lcov-report/node-sdk/models/thumbnail-alignment-enum.ts.html +1 -1
  100. package/coverage/lcov-report/node-sdk/models/webhook-subscription-type-enum.ts.html +1 -1
  101. package/coverage/lcov.info +27 -5
  102. package/custom_templates/package.mustache +6 -7
  103. package/dist/configuration.js +1 -1
  104. package/dist/models/index.d.ts +2 -0
  105. package/dist/models/index.js +2 -0
  106. package/dist/models/multi-channel-action.d.ts +4 -0
  107. package/dist/models/rbm-open-url-enum.d.ts +19 -0
  108. package/dist/models/rbm-open-url-enum.js +23 -0
  109. package/dist/models/rbm-web-view-enum.d.ts +20 -0
  110. package/dist/models/rbm-web-view-enum.js +24 -0
  111. package/dist/models/tfv-status.d.ts +4 -0
  112. package/dist/models/verification-request.d.ts +4 -0
  113. package/dist/models/verification-update-request.d.ts +4 -0
  114. package/docs/MultiChannelAction.md +4 -0
  115. package/docs/RbmActionOpenUrl.md +4 -0
  116. package/docs/RbmOpenUrlEnum.md +11 -0
  117. package/docs/RbmWebViewEnum.md +13 -0
  118. package/docs/TfvStatus.md +2 -0
  119. package/docs/VerificationRequest.md +2 -0
  120. package/docs/VerificationUpdateRequest.md +2 -0
  121. package/models/index.ts +2 -0
  122. package/models/multi-channel-action.ts +8 -0
  123. package/models/rbm-action-open-url.ts +6 -0
  124. package/models/rbm-open-url-enum.ts +29 -0
  125. package/models/rbm-web-view-enum.ts +30 -0
  126. package/models/tfv-status.ts +4 -0
  127. package/models/verification-request.ts +4 -0
  128. package/models/verification-update-request.ts +4 -0
  129. package/package.json +7 -3
  130. package/tests/unit/api/toll-free-verification-api.test.ts +15 -2
  131. package/tests/unit/models/rbm-open-url-enum.test.ts +8 -0
  132. package/tests/unit/models/rbm-veb-view-enum.test.ts +9 -0
@@ -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
@@ -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
+
@@ -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.1.0",
3
+ "version": "7.2.0",
4
4
  "description": "OpenAPI client for bandwidth-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {
7
7
  "type": "git",
8
- "url": "git+https://github.com/Bandwidth/node-sdk.git"
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": "Unlicense",
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
  }
@@ -1,7 +1,7 @@
1
1
  //@ts-nocheck
2
2
  import { TollFreeVerificationApi } from '../../../api';
3
3
  import { Configuration } from '../../../configuration';
4
- import { CallbackTypeEnum, TfvStatusEnum, WebhookSubscriptionTypeEnum } from '../../../models';
4
+ import { BusinessEntityTypeEnum, BusinessRegistrationTypeEnum, CallbackTypeEnum, TfvStatusEnum, WebhookSubscriptionTypeEnum } from '../../../models';
5
5
 
6
6
  describe('TollFreeVerificationApi', () => {
7
7
  const config = new Configuration({
@@ -56,6 +56,10 @@ describe('TollFreeVerificationApi', () => {
56
56
  expect(data.resubmitAllowed).toBeBoolean();
57
57
  expect(data.createdDateTime).toBeDateString();
58
58
  expect(data.modifiedDateTime).toBeDateString();
59
+ expect(data.submission).toBeObject();
60
+ expect(data.blocked).toBeBoolean();
61
+ expect(data.blockedReason).toBeString();
62
+ expect(data.cvToken).toBeString();
59
63
  });
60
64
  });
61
65
 
@@ -130,7 +134,16 @@ describe('TollFreeVerificationApi', () => {
130
134
  imageUrls: ['https://example.com']
131
135
  },
132
136
  additionalInformation: 'additionalInformation',
133
- isvReseller: 'isvReseller'
137
+ isvReseller: 'isvReseller',
138
+ privacyPolicyUrl: 'https://example.com',
139
+ termsAndConditionsUrl: 'https://example.com',
140
+ businessDba: 'businessDba',
141
+ businessRegistrationNumber: 'businessRegistrationNumber',
142
+ businessRegistrationType: BusinessRegistrationTypeEnum.Ein,
143
+ businessEntityType: BusinessEntityTypeEnum.NonProfit,
144
+ helpMessageResponse: 'helpMessageResponse',
145
+ ageGatedContent: true,
146
+ cvToken: 'cvToken'
134
147
  };
135
148
  const { status } = await tfvApi.requestTollFreeVerification(BW_ACCOUNT_ID, verificationRequest);
136
149
 
@@ -0,0 +1,8 @@
1
+ import { RbmOpenUrlEnum } from '../../../models/rbm-open-url-enum';
2
+
3
+ describe('RbmOpenUrlEnum', () => {
4
+ test('should define the expected values', () => {
5
+ expect(RbmOpenUrlEnum.Browser).toBe('BROWSER');
6
+ expect(RbmOpenUrlEnum.Webview).toBe('WEBVIEW');
7
+ });
8
+ });
@@ -0,0 +1,9 @@
1
+ import { RbmWebViewEnum } from '../../../models/rbm-web-view-enum';
2
+
3
+ describe('RbmWebViewEnum', () => {
4
+ test('should define the expected values', () => {
5
+ expect(RbmWebViewEnum.Full).toBe('FULL');
6
+ expect(RbmWebViewEnum.Half).toBe('HALF');
7
+ expect(RbmWebViewEnum.Tall).toBe('TALL');
8
+ });
9
+ });