Merge branch 'main' of https://github.com/Bandwidth/node-sdk into SWI-9204

ckoegel · ckoegel · commit 8e728ed4999e · 2025-12-09T16:54:22.000-05:00
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -13,6 +13,8 @@ jobs:
       BW_ACCOUNT_ID: ${{ secrets.BW_ACCOUNT_ID }}
       BW_USERNAME: ${{ secrets.BW_USERNAME }}
       BW_PASSWORD: ${{ secrets.BW_PASSWORD }}
+      BW_CLIENT_ID: ${{ secrets.BW_CLIENT_ID }}
+      BW_CLIENT_SECRET: ${{ secrets.BW_CLIENT_SECRET }}
       BW_USERNAME_FORBIDDEN: ${{ secrets.BW_USERNAME_FORBIDDEN }}
       BW_PASSWORD_FORBIDDEN: ${{ secrets.BW_PASSWORD_FORBIDDEN }}
       BW_VOICE_APPLICATION_ID: ${{ secrets.BW_VOICE_APPLICATION_ID }}
@@ -46,7 +48,7 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v6
         with:
-          node-version: 22
+          node-version: 24
           registry-url: "https://registry.npmjs.org"
 
       - name: Set OpenAPI Generator Version
diff --git a/.github/workflows/test-pr.yml b/.github/workflows/test-pr.yml
@@ -13,6 +13,8 @@ env:
   BW_ACCOUNT_ID: ${{ secrets.BW_ACCOUNT_ID }}
   BW_USERNAME: ${{ secrets.BW_USERNAME }}
   BW_PASSWORD: ${{ secrets.BW_PASSWORD }}
+  BW_CLIENT_ID: ${{ secrets.BW_CLIENT_ID }}
+  BW_CLIENT_SECRET: ${{ secrets.BW_CLIENT_SECRET }}
   BW_USERNAME_FORBIDDEN: ${{ secrets.BW_USERNAME_FORBIDDEN }}
   BW_PASSWORD_FORBIDDEN: ${{ secrets.BW_PASSWORD_FORBIDDEN }}
   BW_VOICE_APPLICATION_ID: ${{ secrets.BW_VOICE_APPLICATION_ID }}
@@ -32,7 +34,7 @@ jobs:
     strategy:
       matrix:
         os: [windows-2022, windows-2025, ubuntu-22.04, ubuntu-24.04]
-        node-version: [18, 20, 22, 24]
+        node-version: [20, 22, 24]
       fail-fast: false
     steps:
       - name: Checkout
diff --git a/.github/workflows/test-smoke.yml b/.github/workflows/test-smoke.yml
@@ -15,6 +15,8 @@ concurrency:
 env:
   BW_USERNAME: ${{ secrets.BW_USERNAME }}
   BW_PASSWORD: ${{ secrets.BW_PASSWORD }}
+  BW_CLIENT_ID: ${{ secrets.BW_CLIENT_ID }}
+  BW_CLIENT_SECRET: ${{ secrets.BW_CLIENT_SECRET }}
   BW_USERNAME_FORBIDDEN: ${{ secrets.BW_USERNAME_FORBIDDEN }}
   BW_PASSWORD_FORBIDDEN: ${{ secrets.BW_PASSWORD_FORBIDDEN }}
   USER_NUMBER: ${{ secrets.USER_NUMBER }}
@@ -40,7 +42,7 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v6
         with:
-          node-version: 22
+          node-version: 24
 
       - name: Install Packages and Test
         run: |
@@ -67,7 +69,7 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v6
         with:
-          node-version: 22
+          node-version: 24
 
       - name: Install Packages and Test
         run: |
diff --git a/README.md b/README.md
@@ -84,8 +84,8 @@ The following is a simple example of how to use this module:
 import { CallsApi, Configuration } from 'bandwidth-sdk';
 
 const config = new Configuration({
-    username: BW_USERNAME,
-    password: BW_PASSWORD
+    clientId: BW_CLIENT_ID,
+    clientSecret: BW_CLIENT_SECRET
 });
 const callsApi = new CallsApi(config);
 
diff --git a/common.ts b/common.ts
@@ -58,7 +58,9 @@ export const setOAuthToObject = async function (object: any, name: string, scope
         const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
             ? await configuration.accessToken(name, scopes)
             : await configuration.accessToken;
-        object["Authorization"] = "Bearer " + localVarAccessTokenValue;
+        if (localVarAccessTokenValue) {
+            object["Authorization"] = "Bearer " + localVarAccessTokenValue;
+        }
     }
 }
 
diff --git a/configuration.ts b/configuration.ts
@@ -11,6 +11,8 @@
  * Do not edit the class manually.
  */
 
+import globalAxios from 'axios';
+
 interface AWSv4Configuration {
   options?: {
     region?: string
@@ -27,6 +29,8 @@ export interface ConfigurationParameters {
     apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
     username?: string;
     password?: string;
+    clientId?: string;
+    clientSecret?: string;
     accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
     awsv4?: AWSv4Configuration;
     basePath?: string;
@@ -49,12 +53,28 @@ export class Configuration {
      * parameter for basic security
      */
     password?: string;
+    /**
+     * parameter for client ID
+     */
+    clientId?: string;
+    /**
+     * parameter for client secret
+     */
+    clientSecret?: string;
     /**
      * parameter for oauth2 security
      * @param name security name
      * @param scopes oauth2 scope
      */
     accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    /**
+     * temporary access token storage
+     */
+    tempAccessToken?: string;
+    /**
+     * when the temporary access token expires
+     */
+    tempAccessTokenExpiration?: number;
     /**
      * parameter for aws4 signature security
      * @param {Object} AWS4Signature - AWS4 Signature security
@@ -91,7 +111,29 @@ export class Configuration {
         this.apiKey = param.apiKey;
         this.username = param.username;
         this.password = param.password;
-        this.accessToken = param.accessToken;
+        this.clientId = param.clientId;
+        this.clientSecret = param.clientSecret;
+        this.tempAccessToken;
+        this.tempAccessTokenExpiration;
+        this.accessToken = param.accessToken ?? (async (name, scopes) => {
+            const now = Math.floor(Date.now() / 1000);
+            if (this.tempAccessToken && (!this.tempAccessTokenExpiration || this.tempAccessTokenExpiration > now + 60)) {
+                return this.tempAccessToken;
+            } else if (this.clientId && this.clientSecret) {
+                const tokenRequestArgs = {
+                    method: 'POST',
+                    headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
+                    auth: { username: this.clientId || '', password: this.clientSecret || '' },
+                    data: 'grant_type=client_credentials',
+                    url: 'https://api.bandwidth.com/api/v1/oauth2/token'
+                };
+                const response = await globalAxios.request(tokenRequestArgs);
+                this.tempAccessToken = response.data.access_token;
+                this.tempAccessTokenExpiration = now + response.data.expires_in;
+                return this.tempAccessToken!;
+            }
+            return undefined;
+        });
         this.awsv4 = param.awsv4;
         this.basePath = param.basePath;
         this.serverIndex = param.serverIndex;
diff --git a/custom_templates/README.mustache b/custom_templates/README.mustache
@@ -84,8 +84,8 @@ The following is a simple example of how to use this module:
 import { CallsApi, Configuration } from '{{npmName}}';
 
 const config = new Configuration({
-    username: BW_USERNAME,
-    password: BW_PASSWORD
+    clientId: BW_CLIENT_ID,
+    clientSecret: BW_CLIENT_SECRET
 });
 const callsApi = new CallsApi(config);
 
diff --git a/custom_templates/common.mustache b/custom_templates/common.mustache
@@ -54,7 +54,9 @@ export const setOAuthToObject = async function (object: any, name: string, scope
         const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
             ? await configuration.accessToken(name, scopes)
             : await configuration.accessToken;
-        object["Authorization"] = "Bearer " + localVarAccessTokenValue;
+        if (localVarAccessTokenValue) {
+            object["Authorization"] = "Bearer " + localVarAccessTokenValue;
+        }
     }
 }
 
diff --git a/custom_templates/configuration.mustache b/custom_templates/configuration.mustache
@@ -1,6 +1,8 @@
 /* tslint:disable */
 {{>licenseInfo}}
 
+import globalAxios from 'axios';
+
 interface AWSv4Configuration {
   options?: {
     region?: string
@@ -17,6 +19,8 @@ export interface ConfigurationParameters {
     apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
     username?: string;
     password?: string;
+    clientId?: string;
+    clientSecret?: string;
     accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
     awsv4?: AWSv4Configuration;
     basePath?: string;
@@ -39,12 +43,28 @@ export class Configuration {
      * parameter for basic security
      */
     password?: string;
+    /**
+     * parameter for client ID
+     */
+    clientId?: string;
+    /**
+     * parameter for client secret
+     */
+    clientSecret?: string;
     /**
      * parameter for oauth2 security
      * @param name security name
      * @param scopes oauth2 scope
      */
     accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    /**
+     * temporary access token storage
+     */
+    tempAccessToken?: string;
+    /**
+     * when the temporary access token expires
+     */
+    tempAccessTokenExpiration?: number;
     /**
      * parameter for aws4 signature security
      * @param {Object} AWS4Signature - AWS4 Signature security
@@ -81,7 +101,29 @@ export class Configuration {
         this.apiKey = param.apiKey;
         this.username = param.username;
         this.password = param.password;
-        this.accessToken = param.accessToken;
+        this.clientId = param.clientId;
+        this.clientSecret = param.clientSecret;
+        this.tempAccessToken;
+        this.tempAccessTokenExpiration;
+        this.accessToken = param.accessToken ?? (async (name, scopes) => {
+            const now = Math.floor(Date.now() / 1000);
+            if (this.tempAccessToken && (!this.tempAccessTokenExpiration || this.tempAccessTokenExpiration > now + 60)) {
+                return this.tempAccessToken;
+            } else if (this.clientId && this.clientSecret) {
+                const tokenRequestArgs = {
+                    method: 'POST',
+                    headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
+                    auth: { username: this.clientId || '', password: this.clientSecret || '' },
+                    data: 'grant_type=client_credentials',
+                    url: 'https://api.bandwidth.com/api/v1/oauth2/token'
+                };
+                const response = await globalAxios.request(tokenRequestArgs);
+                this.tempAccessToken = response.data.access_token;
+                this.tempAccessTokenExpiration = now + response.data.expires_in;
+                return this.tempAccessToken!;
+            }
+            return undefined;
+        });
         this.awsv4 = param.awsv4;
         this.basePath = param.basePath;
         this.serverIndex = param.serverIndex;
diff --git a/custom_templates/package.mustache b/custom_templates/package.mustache
@@ -28,17 +28,20 @@
     "test-smoke": "jest --coverage --detectOpenHandles --testPathPattern=tests/smoke",
     "test": "jest --coverage --detectOpenHandles"
   },
+  "engines": {
+    "node": ">=20.0.0"
+  },
   "dependencies": {
     "axios": "^1.7.2",
-    "xmlbuilder2": "^3.1.1"
+    "xmlbuilder2": "^4.0.0"
   },
   "devDependencies": {
     "@types/jest": "^29.5.12",
     "@types/node": "^12.11.5",
     "jest": "^29.7.0",
     "jest-extended": "^4.0.2",
     "ts-jest": "^29.1.1",
-    "typescript": "^5.0"
+    "typescript": "^5.9.0"
   }{{#npmRepository}},{{/npmRepository}}
 {{#npmRepository}}
   "publishConfig": {
diff --git a/jest.config.js b/jest.config.js
@@ -6,6 +6,8 @@ module.exports = {
     globals: {
         'BW_USERNAME': process.env.BW_USERNAME,
         'BW_PASSWORD': process.env.BW_PASSWORD,
+        'BW_CLIENT_ID': process.env.BW_CLIENT_ID,
+        'BW_CLIENT_SECRET': process.env.BW_CLIENT_SECRET,
         'BW_ACCOUNT_ID': process.env.BW_ACCOUNT_ID,
         'BW_NUMBER': process.env.BW_NUMBER,
         'USER_NUMBER': process.env.USER_NUMBER,
diff --git a/package.json b/package.json
@@ -24,16 +24,19 @@
     "test-smoke": "jest --coverage --detectOpenHandles --testPathPattern=tests/smoke",
     "test": "jest --coverage --detectOpenHandles"
   },
+  "engines": {
+    "node": ">=20.0.0"
+  },
   "dependencies": {
     "axios": "^1.7.2",
-    "xmlbuilder2": "^3.1.1"
+    "xmlbuilder2": "^4.0.0"
   },
   "devDependencies": {
     "@types/jest": "^29.5.12",
     "@types/node": "^12.11.5",
     "jest": "^29.7.0",
     "jest-extended": "^4.0.2",
     "ts-jest": "^29.1.1",
-    "typescript": "^5.0"
+    "typescript": "^5.9.0"
   }
 }
diff --git a/tests/smoke/bxml.test.ts b/tests/smoke/bxml.test.ts
@@ -25,7 +25,10 @@ import { sleep, createMantecaCall, cleanupCalls } from '../callUtils';
 describe('BXML Integration Tests', () => {
     jest.setTimeout(20000);
     
-    const config = new Configuration({username: BW_USERNAME, password: BW_PASSWORD});
+    const config = new Configuration({
+        clientId: BW_CLIENT_ID,
+        clientSecret: BW_CLIENT_SECRET
+    });
     const callsApi = new CallsApi(config);
     let activeCalls: string[] = [];
     
diff --git a/tests/smoke/calls-api.test.ts b/tests/smoke/calls-api.test.ts
@@ -13,7 +13,10 @@ import { createMantecaCall, sleep, cleanupCalls } from '../callUtils';
 
 describe('CallsApi', () => {
     jest.setTimeout(45000);
-    const config = new Configuration({username: BW_USERNAME, password: BW_PASSWORD});
+    const config = new Configuration({
+        clientId: BW_CLIENT_ID,
+        clientSecret: BW_CLIENT_SECRET
+    });
     const callsApi = new CallsApi(config);
 
     const displayName = 'NodeJS SDK';
diff --git a/tests/smoke/conferences-api.test.ts b/tests/smoke/conferences-api.test.ts
@@ -6,7 +6,10 @@ import { setupManteca, createMantecaCall, cleanupCalls, getMantecaTestStatus, sl
 
 describe('ConferencesApi', () => {
     jest.setTimeout(125000);
-    const config = new Configuration({username: BW_USERNAME, password: BW_PASSWORD});
+    const config = new Configuration({
+        username: BW_USERNAME,
+        password: BW_PASSWORD
+    });
     const callsApi = new CallsApi(config);
     const conferencesApi = new ConferencesApi(config);
 
diff --git a/tests/smoke/phone-number-lookup-api.test.ts b/tests/smoke/phone-number-lookup-api.test.ts
@@ -14,8 +14,8 @@ import { sleep } from '../callUtils';
 describe('PhoneNumberLookupApi', () => {
     jest.setTimeout(40000);
     const config = new Configuration({
-        username: BW_USERNAME,
-        password: BW_PASSWORD
+        clientId: BW_CLIENT_ID,
+        clientSecret: BW_CLIENT_SECRET
     });
     const phoneNumberLookupApi = new PhoneNumberLookupApi(config);
 
diff --git a/tests/smoke/recordings-api.test.ts b/tests/smoke/recordings-api.test.ts
@@ -6,7 +6,10 @@ import { getMantecaTestStatus, setupManteca, createMantecaCall, cleanupCalls, sl
 
 describe('RecordingsApi', () => {
     jest.setTimeout(240000);
-    const config = new Configuration({username: BW_USERNAME, password: BW_PASSWORD});
+    const config = new Configuration({
+        clientId: BW_CLIENT_ID,
+        clientSecret: BW_CLIENT_SECRET
+    });
     const callsApi = new CallsApi(config);
     const recordingsApi = new RecordingsApi(config);
 
diff --git a/tests/smoke/statistics-api.test.ts b/tests/smoke/statistics-api.test.ts
@@ -3,7 +3,10 @@ import { StatisticsApi } from '../../api';
 import { Configuration } from '../../configuration';
 
 describe('StatisticsApi', () => {
-    const config = new Configuration({username: BW_USERNAME, password: BW_PASSWORD});
+    const config = new Configuration({
+        clientId: BW_CLIENT_ID,
+        clientSecret: BW_CLIENT_SECRET
+    });
     const statisticsApi = new StatisticsApi(config);
 
     describe('getStatistics', () => {
diff --git a/tests/smoke/toll-free-verification-api.test.ts b/tests/smoke/toll-free-verification-api.test.ts
@@ -3,7 +3,10 @@ import { TollFreeVerificationApi } from '../../api';
 import { Configuration } from '../../configuration';
 
 describe('TollFreeVerificationApi', () => {
-    const config = new Configuration({username: BW_USERNAME, password: BW_PASSWORD});
+    const config = new Configuration({
+        clientId: BW_CLIENT_ID,
+        clientSecret: BW_CLIENT_SECRET
+    });
     const tfvApi = new TollFreeVerificationApi(config);
 
     describe('listTollFreeUseCases', () => {
diff --git a/tests/smoke/transcriptions-api.test.ts b/tests/smoke/transcriptions-api.test.ts

Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,9 @@ export const setOAuthToObject = async function (object: any, name: string, scope`
`58`	`58`	`const localVarAccessTokenValue = typeof configuration.accessToken === 'function'`
`59`	`59`	`? await configuration.accessToken(name, scopes)`
`60`	`60`	`: await configuration.accessToken;`
`61`		`- object["Authorization"] = "Bearer " + localVarAccessTokenValue;`
	`61`	`+ if (localVarAccessTokenValue) {`
	`62`	`+ object["Authorization"] = "Bearer " + localVarAccessTokenValue;`
	`63`	`+ }`
`62`	`64`	`}`
`63`	`65`	`}`
`64`	`66`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,9 @@ export const setOAuthToObject = async function (object: any, name: string, scope`
`54`	`54`	`const localVarAccessTokenValue = typeof configuration.accessToken === 'function'`
`55`	`55`	`? await configuration.accessToken(name, scopes)`
`56`	`56`	`: await configuration.accessToken;`
`57`		`- object["Authorization"] = "Bearer " + localVarAccessTokenValue;`
	`57`	`+ if (localVarAccessTokenValue) {`
	`58`	`+ object["Authorization"] = "Bearer " + localVarAccessTokenValue;`
	`59`	`+ }`
`58`	`60`	`}`
`59`	`61`	`}`
`60`	`62`