VAPI-2823 Implement BRTC Endpoints API with models, controllers, and tests by smoghe-bw · Pull Request #87 · Bandwidth/php-sdk

smoghe-bw · 2026-03-11T16:43:34Z

No description provided.

bwappsec · 2026-03-11T16:52:27Z

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

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

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

…dd integration test for endpoint management

…pointsController and update tests accordingly

…int URLs

…ability

… update APIController to use new auth method

…eController; update APIController to use generic auth method

…thod and using direct exception messages

…nagement

…o implement configureBrtcAuth for BRTC endpoints

…equest errors in BaseController

…ication

…and remove global basic auth interference

…prove cURL initialization

…d streamline authorization header setup

…uth to prevent interference with API requests

…e APIController references

…ve array for clarity

…ody::form for improved request handling

…g format for consistency

…ride during token requests

…sistency

…pe in BaseController

ckoegel · 2026-03-25T17:04:33Z

src/Controllers/BaseController.php

     */
    protected function configureAuth(&$headers, $authType)
    {
-        if (!empty($this->config->getAccessToken()) && 


why is all of this deleted? removing this is essentially removing OAuth support from every endpoint in the SDK, which we definitely do not want to do. All of this needs to be brought back, BRTC should be able to use this in its API calls to also support OAuth. We'll probably need to set up the username/password stuff in the configuration and then add logic to the configure auth function to set those as a fallback

ckoegel · 2026-03-25T17:05:40Z

src/Controllers/BaseController.php

+     *
+     * @param array $headers The headers for the request (passed by reference)
+     */
+    protected function configureOAuth2Auth(&$headers)


this is unnecessary, the SDK already supports OAuth, so we don't need a BRTC specific oauth function, we need to remove this and use the pre-existing logic that was in the configureAuth function

ckoegel · 2026-03-26T18:59:01Z

src/Voice/Bxml/Connect.php

+
+require_once "Verb.php";
+
+class Connect extends Verb {


this is missing the eventCallbackUrl attribute

ckoegel · 2026-03-26T19:00:17Z

src/Voice/Bxml/Connect.php

+
+class Connect extends Verb {
+    /**
+     * @var array


Suggested change

* @var array

* @var array(Endpoint)

ckoegel · 2026-03-26T19:00:58Z

src/Voice/Bxml/Connect.php

+     */
+    public function toBxml(DOMDocument $doc): DOMElement {
+        $element = $doc->createElement("Connect");
+        foreach ($this->endpoints as $endpoint) {


id like to add the isset check we do in other verbs here

ckoegel · 2026-03-26T21:05:21Z

tests/ApiTest.php

+        $this->assertNotNull($createResp->endpointId);
+        $this->assertEquals('WEBRTC', $createResp->type);


we need to be asserting as many fields on the response as possible, feel free to copy what i did for the tn lookup tests

ckoegel · 2026-03-26T21:09:42Z

tests/ApiTest.php

+        $this->assertEquals('WEBRTC', $createResp->type);
+
+        // List endpoints
+        try {


same as above for the try catch and including more assertions

ckoegel · 2026-03-26T21:09:49Z

tests/ApiTest.php

+        $this->assertContains($createResp->endpointId, $ids, 'Created endpoint should be in list');
+
+        // Get endpoint
+        try {


same as above

ckoegel · 2026-03-26T21:10:01Z

tests/ApiTest.php

+        // $voiceClient->updateEndpointBxml($accountId, $createResp->endpointId, $bxml);
+
+        // Delete endpoint
+        try {


can remove try catch

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

tests/ApiTest.php

+        $this->assertEquals(204, $deleteResp->getStatusCode());
+    }
+
+    public function testCreateEndpointResponseFields() {


this and every test after are all unnecessary, we need to be asserting as many fields as possible in our 1 test run, like I mentioned in one of the other SDKs, these tests are strictly to test the SDK functionality, not the API.

@var

- Restore original configureAuth with OAuth2 client_credentials support that was accidentally deleted; remove redundant configureOAuth2Auth - Move all BRTC endpoints out of Voice controller into new src/BRTC/ module with its own BRTCClient and APIController - Add BRTCDEFAULT server URL constant and configuration mapping - Register getBRTC() accessor on BandwidthClient - Fix Connect BXML: add eventCallbackUrl attribute, isset guards, correct @var doc to array(Endpoint) - Fix Endpoint BXML: rename property to endpointId, render as text content (createTextNode) instead of XML attribute - Fix BXML test expected output for Endpoint text content - Create proper response wrapper models matching API spec: CreateEndpointResponse (links/data/errors), CreateEndpointResponseData (with token field), EndpointResponse, ListEndpointsResponse (with page), Endpoints (list summary without devices) - Fix Device model fields: deviceId, deviceName, status, creationTimestamp (matching Python SDK spec) - Fix Endpoint model fields to match spec: endpointId, type, status, creationTimestamp, expirationTimestamp, tag, devices - Fix EndpointEvent model to match spec: add eventTime, eventType, device; remove fabricated fields - Fix CreateEndpointRequest: direction is required (no null default), add connectionMetadata field - Replace ErrorResponse with ErrorObject (type, description) - Replace Page with spec-correct fields (pageSize, totalElements, totalPages, pageNumber) - Remove Enums.php (use plain strings per SDK convention) - Add Link model for BRTC responses - Fix listEndpoints to accept explicit query params (type, status, direction, pageToken, pageSize) following getMessages pattern - All BRTC API methods use configureAuth and BRTCDEFAULT server URL - Update smoke tests to use BRTC client and wrapped response models Generated from Claude9 with Claude Code Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

- Removed all try/catch wrappers from BRTC API calls — let tests fail naturally on exceptions, matching the pattern used by TN lookup and other existing smoke tests - Removed 6 redundant test methods (testCreateEndpointResponseFields, testGetEndpointFields, testListEndpointsContainsCreated, testListEndpointsEachItemIsEndpointsInstance, testCreateMultipleEndpointsAndDeleteAll, testDeleteEndpointRemovedFromList) - Consolidated all assertions into testCreateListGetDeleteEndpoint following the create → list → get → delete flow - Added thorough field assertions on each response (status, creationTimestamp, expirationTimestamp, tag, first list element) Generated from Claude9 with Claude Code Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Implement BRTC Endpoints API with models, controllers, and tests

bf81c1a

smoghe-bw requested review from a team as code owners March 11, 2026 16:43

smoghe-bw changed the title ~~Implement BRTC Endpoints API with models, controllers, and tests~~ VAPI-2823 Implement BRTC Endpoints API with models, controllers, and tests Mar 11, 2026

smoghe-bw added 23 commits March 11, 2026 12:53

Refactor Connect and Endpoint classes to make toBxml method public; a…

e4e4382

…dd integration test for endpoint management

Refactor APIController to integrate BRTC endpoint methods; remove End…

69f3305

…pointsController and update tests accordingly

Update APIController to use PHONENUMBERLOOKUPDEFAULT server for endpo…

3c425ff

…int URLs

Add error handling for createEndpoint in ApiTest to improve test reli…

e77d05d

…ability

Refactor ApiTest to use endpointClient for endpoint-related tests

8bcf942

Trigger build

c5a405a

Add BRTC OAuth2 token management to Configuration and BaseController;…

8ceb7c7

… update APIController to use new auth method

Remove BRTC OAuth2 access token management from Configuration and Bas…

b404ff9

…eController; update APIController to use generic auth method

Refactor ApiTest to simplify error handling by removing apiFailMsg me…

2424fa7

…thod and using direct exception messages

Trigger build

f625ed8

Fix authorization header configuration in BaseController for token ma…

d477bd1

…nagement

Refactor authentication methods in BaseController and APIController t…

13f7408

…o implement configureBrtcAuth for BRTC endpoints

Clear global basic auth before BRTC token exchange and handle token r…

c516d6d

…equest errors in BaseController

Simplify token request body format in BaseController for BRTC authent…

ef6edf9

…ication

Refactor BRTC token exchange to use cURL for improved error handling …

3d8f45a

…and remove global basic auth interference

Refactor configureBrtcAuth to streamline access token handling and im…

741accb

…prove cURL initialization

Refactor configureBrtcAuth to remove access token expiration check an…

8eb21da

…d streamline authorization header setup

Clear global Basic auth before setting Bearer token in configureBrtcA…

d4b7b47

…uth to prevent interference with API requests

Rename configureBrtcAuth to configureOAuth2Auth for clarity and updat…

d7d9913

…e APIController references

Refactor grant_type parameter in configureOAuth2Auth to use associati…

dcd3fee

…ve array for clarity

Remove User-Agent header from OAuth2 token request for cleaner API calls

486744b

Refactor grant_type parameter in configureOAuth2Auth to use Request\B…

f21f31a

…ody::form for improved request handling

Update grant_type parameter in configureOAuth2Auth to use query strin…

c7f870b

…g format for consistency

smoghe-bw added 3 commits March 18, 2026 10:22

Clear global Basic auth in configureOAuth2Auth to prevent header over…

c7433fb

…ride during token requests

Refactor endpoint properties and update API response handling for con…

ad2c358

…sistency

Update authentication handling to use Request\Body::form for grant_ty…

107f54f

…pe in BaseController

ckoegel reviewed Mar 26, 2026

View reviewed changes

smoghe-bw and others added 2 commits March 27, 2026 14:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

VAPI-2823 Implement BRTC Endpoints API with models, controllers, and tests#87

VAPI-2823 Implement BRTC Endpoints API with models, controllers, and tests#87
smoghe-bw wants to merge 29 commits intomainfrom
brtc-sdks

smoghe-bw commented Mar 11, 2026

Uh oh!

bwappsec commented Mar 11, 2026 •

edited

Loading

Uh oh!

ckoegel Mar 25, 2026

Uh oh!

ckoegel Mar 25, 2026

Uh oh!

ckoegel Mar 26, 2026

Uh oh!

ckoegel Mar 26, 2026

Uh oh!

ckoegel Mar 26, 2026

Uh oh!

ckoegel Mar 26, 2026

Uh oh!

ckoegel Mar 26, 2026

Uh oh!

ckoegel Mar 26, 2026

Uh oh!

ckoegel Mar 26, 2026

Uh oh!

ckoegel Mar 26, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		$this->assertNotNull($createResp->endpointId);
		$this->assertEquals('WEBRTC', $createResp->type);

Conversation

smoghe-bw commented Mar 11, 2026

Uh oh!

bwappsec commented Mar 11, 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 Mar 11, 2026 •

edited

Loading