VAPI-2755 Update documentation and models for various API endpoints by smoghe-bw · Pull Request #104 · Bandwidth/node-sdk

smoghe-bw · 2026-02-18T20:13:12Z

Modified LookupResult.md to correct field names and descriptions.
Updated MachineDetectionConfiguration.md to improve clarity in descriptions.
Revised MessageRequest.md for consistency in formatting.
Added new Page.md documentation for pagination support.
Adjusted RbmOpenUrlEnum.md and RbmWebViewEnum.md for better readability.
Introduced new SipConnectionMetadata.md and SipCredentials.md models.
Enhanced StatusCallback.md to clarify the carrierName field description.
Created new models for endpoint management including CreateEndpointRequestBase, CreateEndpointResponse, and related types.
Added device-related models including Device, DeviceStatusEnum, and Endpoint management types.
Implemented error handling models such as ErrorResponse and updated InboundCallback types.
Added list-endpoints response model for better API response handling.

- Modified LookupResult.md to correct field names and descriptions. - Updated MachineDetectionConfiguration.md to improve clarity in descriptions. - Revised MessageRequest.md for consistency in formatting. - Added new Page.md documentation for pagination support. - Adjusted RbmOpenUrlEnum.md and RbmWebViewEnum.md for better readability. - Introduced new SipConnectionMetadata.md and SipCredentials.md models. - Enhanced StatusCallback.md to clarify the carrierName field description. - Created new models for endpoint management including CreateEndpointRequestBase, CreateEndpointResponse, and related types. - Added device-related models including Device, DeviceStatusEnum, and Endpoint management types. - Implemented error handling models such as ErrorResponse and updated InboundCallback types. - Added list-endpoints response model for better API response handling.

bwappsec · 2026-02-18T20:13:25Z

✅ Snyk checks have passed. No issues have been found so far.

Status	Scan Engine	Critical	High	Medium	Low	Total (0)
✅	Open Source Security	0	0	0	0	0 issues
✅	Licenses	0	0	0	0	0 issues
✅	Code Security	0	0	0	0	0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

…perty; update tests to validate new structure and behavior

…ses; ensure proper validation of endpoint properties

…o brtc-sdks

ckoegel · 2026-03-24T20:40:16Z

tests/unit/models/create-endpoint-response.test.ts

+import { Link } from '../../../models/link';
+import { ModelError } from '../../../models/model-error';
+
+describe('CreateEndpointResponse', () => {


i like the fact that its trying to create these tests, but I think if we're going to do that, we should fully test the model in 1 test, aka, we can have one test where it fills our every possible field in the model and runs assertions for all of that, essentially combining what's going on in the 2 tests here

ckoegel · 2026-03-24T20:42:33Z

tests/unit/models/device-status-enum.test.ts

+        expect(Object.values(DeviceStatusEnum)).toEqual([
+            'CONNECTED',
+            'DISCONNECTED'
+        ]);


tbh we should probably add this to all of the other enum tests to catch when they're updated, nice

ckoegel · 2026-03-24T20:44:55Z

tests/unit/models/device.test.ts

+        expect(device.deviceId).toBe('dev-1234');
+        expect(device.deviceName).toBe('Mobile App');
+        expect(device.status).toBe(DeviceStatusEnum.Connected);
+        expect(new Date(device.creationTimestamp).toString()).not.toBe('Invalid Date');


I feel like there's probably a better way to test this, can we make sure the date it makes matches like the year or time we expect instead?

ckoegel · 2026-03-24T20:46:26Z

tests/unit/models/endpoint-direction-enum.test.ts

+    test('should define the expected values', () => {
+        expect(EndpointDirectionEnum.Inbound).toBe('INBOUND');
+        expect(EndpointDirectionEnum.Outbound).toBe('OUTBOUND');
+        expect(EndpointDirectionEnum.Bidirectional).toBe('BIDIRECTIONAL');


can add that values assertion i called out earlier

ckoegel · 2026-03-24T20:46:35Z

tests/unit/models/endpoint-event-type-enum.test.ts

+describe('EndpointEventTypeEnum', () => {
+    test('should define the expected values', () => {
+        expect(EndpointEventTypeEnum.DeviceConnected).toBe('DEVICE_CONNECTED');
+        expect(EndpointEventTypeEnum.DeviceDisconnected).toBe('DEVICE_DISCONNECTED');


values test here and for the rest of the enum tests

ckoegel · 2026-03-24T21:09:30Z

tests/unit/api/endpoints-api.test.ts

+            expect(data.errors).toBeInstanceOf(Array);
+            expect(data.errors).toHaveLength(0);
+        });
+    });


where is the delete endpoint test?

ckoegel · 2026-03-24T21:11:48Z

tests/smoke/endpoints-api.test.ts

+        test('should list endpoints filtered by type', async () => {
+            const { status, data } = await endpointsApi.listEndpoints(BW_ACCOUNT_ID, EndpointTypeEnum.Webrtc);
+
+            expect(status).toEqual(200);
+            expect(data.data).toBeInstanceOf(Array);
+            expect(data.errors).toBeInstanceOf(Array);
+            if (data.data.length > 0) {
+                expect(data.data.every((item) => item.type === EndpointTypeEnum.Webrtc)).toEqual(true);
+            }
+        });


ckoegel · 2026-03-24T21:12:02Z

tests/smoke/endpoints-api.test.ts

+            endpointId = data.data.endpointId;
+        });
+
+        test('should list endpoints for the account', async () => {


Suggested change

test('should list endpoints for the account', async () => {

test('should list endpoints, async () => {

ckoegel · 2026-03-24T21:12:14Z

tests/smoke/endpoints-api.test.ts

+    let endpointId: string;
+
+    describe('endpoint lifecycle', () => {
+        test('should create a new endpoint', async () => {


Suggested change

test('should create a new endpoint', async () => {

test('should create endpoint', async () => {

ckoegel · 2026-03-24T21:12:23Z

tests/smoke/endpoints-api.test.ts

+            }
+        });
+
+        test('should retrieve details of a specific endpoint', async () => {


Suggested change

test('should retrieve details of a specific endpoint', async () => {

test('should get endpoint', async () => {

smoghe-bw added 4 commits February 18, 2026 15:18

Add unit tests for endpoint models and responses

24b8914

Add comprehensive tests for EndpointsApi functionality

5f29a27

Fix type checks and update pagination property names in endpoint tests

b2ae627

Enhance CreateEndpointResponseData and Endpoint models with token pro…

144bc64

…perty; update tests to validate new structure and behavior

smoghe-bw changed the title ~~Update documentation and models for various API endpoints~~ VAPI-2755 Update documentation and models for various API endpoints Feb 19, 2026

smoghe-bw added 4 commits February 19, 2026 11:00

Refactor EndpointsApi tests to access nested data structure in respon…

f378616

…ses; ensure proper validation of endpoint properties

Comment out updateEndpointBxml tests until implementation is complete

6cbf9ee

empty commit

ced68ff

Add spacing for better readability before deleteEndpoint tests

8d97e4c

smoghe-bw marked this pull request as ready for review February 19, 2026 16:16

smoghe-bw requested review from a team as code owners February 19, 2026 16:16

smoghe-bw and others added 8 commits February 25, 2026 09:11

Merge branch 'main' into brtc-sdks

17e71f7

Add unit tests for EndpointsApi and related models

44937b6

Refactor endpoint tests for clarity and organization

8bd91a2

Update endpoint tests to use containKeys for link validation

8d66f70

Update endpoint tests to use containKeys for key validation

968bb4e

Merge branch 'main' into brtc-sdks

e84d3d4

Trigger build

556e3f4

Merge branch 'brtc-sdks' of https://github.com/Bandwidth/node-sdk int…

c4dfe0f

…o brtc-sdks

ckoegel reviewed Mar 24, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

VAPI-2755 Update documentation and models for various API endpoints#104

VAPI-2755 Update documentation and models for various API endpoints#104
smoghe-bw wants to merge 17 commits intomainfrom
brtc-sdks

smoghe-bw commented Feb 18, 2026

Uh oh!

bwappsec commented Feb 18, 2026 •

edited

Loading

Uh oh!

ckoegel Mar 24, 2026

Uh oh!

ckoegel Mar 24, 2026

Uh oh!

ckoegel Mar 24, 2026

Uh oh!

ckoegel Mar 24, 2026

Uh oh!

ckoegel Mar 24, 2026

Uh oh!

ckoegel Mar 24, 2026

Uh oh!

ckoegel Mar 24, 2026

Uh oh!

ckoegel Mar 24, 2026

Uh oh!

ckoegel Mar 24, 2026

Uh oh!

ckoegel Mar 24, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	test('should list endpoints for the account', async () => {
	test('should list endpoints, async () => {

	test('should create a new endpoint', async () => {
	test('should create endpoint', async () => {

	test('should retrieve details of a specific endpoint', async () => {
	test('should get endpoint', async () => {

Conversation

smoghe-bw commented Feb 18, 2026

Uh oh!

bwappsec commented Feb 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Snyk checks have passed. No issues have been found so far.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

bwappsec commented Feb 18, 2026 •

edited

Loading