@unboundcx/sdk-internal 2.2.0 → 2.3.1

package/index.js

@@ -1,6 +1,7 @@
 /* eslint-disable indent */
 /* eslint-disable prettier/prettier */
 
+import { internalRequest } from './utils/sdkRequest.js';
 import { InternalSipService } from './services/sip.js';
 import { InternalEmailService } from './services/email.js';
 import { InternalProgrammableVoiceService } from './services/programmableVoice.js';
@@ -9,6 +10,9 @@ import { InternalSocketService } from './services/socket.js';
 import { InternalMasterAuthService } from './services/masterAuth.js';
 import { InternalBrandingService } from './services/branding.js';
 import { InternalPhoneNumbersService } from './services/phoneNumbers.js';
+import { InternalVideoService } from './services/video.js';
+import { InternalVoicemailService } from './services/voicemail.js';
+import { InternalVoiceService } from './services/voice.js';
 import { buildObjectEventV2 } from './utils/buildObjectEventV2.js';
 
 export class InternalSDK {
@@ -25,6 +29,9 @@ export class InternalSDK {
     this.masterAuth = new InternalMasterAuthService(sdk);
     this.branding = new InternalBrandingService(sdk);
     this.phoneNumbers = new InternalPhoneNumbersService(sdk);
+    this.video = new InternalVideoService(sdk);
+    this.voicemail = new InternalVoicemailService(sdk);
+    this.voice = new InternalVoiceService(sdk);
 
     // Proxy all base SDK properties and methods
     this._proxyBaseSDK();
@@ -98,6 +105,51 @@ export class InternalSDK {
     }
     return this.sdk.token;
   }
+
+  /**
+   * Governed escape hatch for internal routes reached by path-as-data
+   * mechanisms (e.g. a voice-app webhook command that carries its target
+   * `url` at runtime), where a typed per-route method isn't possible
+   * because the caller doesn't know the route ahead of time. This is the
+   * ONLY sanctioned way to hit an internal route this way — if you know
+   * the route at write time, add (or use) a typed method on the matching
+   * service instead of calling this directly.
+   *
+   * @param {string} path - Must start with '/internal/'.
+   * @param {object} body
+   * @param {object} [options]
+   * @param {number} [options.timeoutMs]
+   */
+  async post(path, body, { timeoutMs } = {}) {
+    if (typeof path !== 'string' || !path.startsWith('/internal/')) {
+      throw new Error(
+        `InternalSDK.post: path must be a string starting with '/internal/', got: ${path}`,
+      );
+    }
+
+    const params = { body };
+    if (timeoutMs) params.timeoutMs = timeoutMs;
+
+    const result = await internalRequest(this.sdk, path, 'POST', params);
+    return result;
+  }
+
+  /**
+   * Compile a UOQL string via app1-api internal analyze.
+   * POST /internal/objects/uoql/analyze
+   */
+  async analyzeUoql({ uoql, accountId }) {
+    this.sdk.validateParams(
+      { uoql, accountId },
+      {
+        uoql: { type: 'string', required: true },
+        accountId: { type: 'string', required: true },
+      },
+    );
+    return internalRequest(this.sdk, '/internal/objects/uoql/analyze', 'POST', {
+      body: { uoql, accountId },
+    });
+  }
 }
 
 // Extension pattern for the main SDK
@@ -127,4 +179,7 @@ export { InternalSocketService } from './services/socket.js';
 export { InternalMasterAuthService } from './services/masterAuth.js';
 export { InternalBrandingService } from './services/branding.js';
 export { InternalPhoneNumbersService } from './services/phoneNumbers.js';
+export { InternalVideoService } from './services/video.js';
+export { InternalVoicemailService } from './services/voicemail.js';
+export { InternalVoiceService } from './services/voice.js';
 export { buildObjectEventV2 } from './utils/buildObjectEventV2.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unboundcx/sdk-internal",
-  "version": "2.2.0",
+  "version": "2.3.1",
   "description": "Internal SDK extension for Unbound - Provides access to internal APIs and administrative functions",
   "main": "index.js",
   "type": "module",

package/services/branding.js

@@ -1,3 +1,4 @@
+import { internalRequest } from '../utils/sdkRequest.js';
 export class InternalBrandingService {
   constructor(sdk) {
     this.sdk = sdk;
@@ -14,7 +15,7 @@ export class InternalBrandingService {
    * @returns {Promise<{ trustedDomains: string[] }>}
    */
   async listTrustedDomains() {
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       '/internal/branding/trustedDomains',
       'GET',
       {},

package/services/email.js

@@ -1,3 +1,4 @@
+import { internalRequest } from '../utils/sdkRequest.js';
 export class InternalEmailService {
   constructor(sdk) {
     this.sdk = sdk;
@@ -11,7 +12,7 @@ export class InternalEmailService {
       },
     );
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       `/internal/email/open/${emailId}`,
       'POST',
     );
@@ -31,7 +32,7 @@ export class InternalEmailService {
       body: { trackingCookie },
     };
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       `/internal/email/click/${linkId}`,
       'POST',
       params,
@@ -52,7 +53,7 @@ export class InternalEmailService {
       body: { to },
     };
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       `/internal/email/unsubscribe/${emailId}`,
       'POST',
       params,

package/services/masterAuth.js

@@ -1,3 +1,4 @@
+import { internalRequest } from '../utils/sdkRequest.js';
 export class InternalMasterAuthService {
   constructor(sdk) {
     this.sdk = sdk;
@@ -25,7 +26,7 @@ export class InternalMasterAuthService {
       },
     };
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       '/internal/masterAuth/',
       'POST',
       params,
@@ -58,7 +59,7 @@ export class InternalMasterAuthService {
     const body = { service };
     if (expiresIn !== undefined) body.expiresIn = expiresIn;
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       '/internal/masterAuth/internal-token',
       'POST',
       { body },

package/services/phoneNumbers.js

@@ -1,3 +1,4 @@
+import { internalRequest } from '../utils/sdkRequest.js';
 export class InternalPhoneNumbersService {
   constructor(sdk) {
     this.sdk = sdk;
@@ -19,7 +20,7 @@ export class InternalPhoneNumbersService {
       },
     );
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       '/internal/phoneNumbers/inventory',
       'POST',
       {

package/services/programmableVoice.js

@@ -1,3 +1,4 @@
+import { internalRequest } from '../utils/sdkRequest.js';
 export class InternalProgrammableVoiceService {
   constructor(sdk) {
     this.sdk = sdk;
@@ -17,7 +18,7 @@ export class InternalProgrammableVoiceService {
       body: streamData,
     };
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       '/internal/programmableVoice/streamProxy',
       'POST',
       params,
@@ -37,7 +38,7 @@ export class InternalProgrammableVoiceService {
       body: webhookData,
     };
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       '/internal/programmableVoice/proxy',
       'POST',
       params,
@@ -69,7 +70,7 @@ export class InternalProgrammableVoiceService {
       },
     };
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       '/internal/programmableVoice/setVariable',
       'POST',
       params,
@@ -99,7 +100,7 @@ export class InternalProgrammableVoiceService {
       },
     };
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       '/internal/programmableVoice/getVariable',
       'POST',
       params,
@@ -151,7 +152,7 @@ export class InternalProgrammableVoiceService {
       body: meetingData,
     };
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       '/internal/programmableVoice/joinMeetingRoom',
       'POST',
       params,
@@ -172,7 +173,7 @@ export class InternalProgrammableVoiceService {
       body: sessionData,
     };
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       `/internal/programmableVoice/${location}`,
       'POST',
       params,
@@ -248,7 +249,7 @@ export class VoiceChannelService {
       },
     };
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       '/internal/programmableVoice/voiceChannel',
       'POST',
       params,
@@ -322,7 +323,7 @@ export class VoiceChannelService {
       },
     };
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       '/internal/programmableVoice/voiceChannel',
       'PUT',
       params,
@@ -375,7 +376,7 @@ export class TranscriptionService {
       body: transcriptionData,
     };
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       '/internal/programmableVoice/transcription/',
       'POST',
       params,
@@ -396,7 +397,7 @@ export class TranscriptionService {
       body: completionData,
     };
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       `/internal/programmableVoice/transcription/${id}`,
       'PUT',
       params,
@@ -417,7 +418,7 @@ export class TranscriptionService {
       body: messageData,
     };
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       `/internal/programmableVoice/transcription/${id}`,
       'POST',
       params,

package/services/servers.js

@@ -1,3 +1,4 @@
+import { internalRequest } from '../utils/sdkRequest.js';
 export class InternalServersService {
   constructor(sdk) {
     this.sdk = sdk;
@@ -59,7 +60,7 @@ export class InternalServersService {
       body: serverData,
     };
 
-    const result = await this.sdk._fetch('/internal/servers/', 'POST', params);
+    const result = await internalRequest(this.sdk, '/internal/servers/', 'POST', params);
     return result;
   }
 
@@ -100,7 +101,7 @@ export class InternalServersService {
       body: updateData,
     };
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       `/internal/servers/${id}`,
       'PUT',
       params,
@@ -116,7 +117,7 @@ export class InternalServersService {
       },
     );
 
-    const result = await this.sdk._fetch(`/internal/servers/${id}`, 'DELETE');
+    const result = await internalRequest(this.sdk, `/internal/servers/${id}`, 'DELETE');
     return result;
   }
 
@@ -128,7 +129,7 @@ export class InternalServersService {
       },
     );
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       `/internal/servers/${id}/shutdownCheck`,
       'GET',
     );
@@ -153,7 +154,7 @@ export class AwsServersService {
       body: assignmentData,
     };
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       '/internal/servers/aws/assignElasticIp',
       'POST',
       params,

package/services/sip.js

@@ -1,3 +1,4 @@
+import { internalRequest } from '../utils/sdkRequest.js';
 export class InternalSipService {
   constructor(sdk) {
     this.sdk = sdk;
@@ -19,7 +20,7 @@ export class InternalSipService {
     const options = {
       body: { to, from, callId, auth, peerDirection, contact },
     };
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       `/internal/sip/router/${to}?from=${from}&callId=${callId}`,
       'POST',
       options,
@@ -39,7 +40,7 @@ export class InternalSipService {
     );
 
     const options = {};
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       `/internal/sip/server/${type}?regionCode=${regionCode}&callId=${callId}`,
       'GET',
       options,
@@ -54,7 +55,7 @@ export class InternalSipService {
         ...params,
       },
     };
-    const result = await this.sdk._fetch(`/internal/sip/log`, 'POST', options);
+    const result = await internalRequest(this.sdk, `/internal/sip/log`, 'POST', options);
     return result;
   }
 
@@ -130,7 +131,7 @@ export class InternalSipService {
       },
     };
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       `/internal/sip/register`,
       'POST',
       options,
@@ -155,7 +156,7 @@ export class InternalSipService {
         accountId,
       },
     };
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       `/internal/sip/register/`,
       'DELETE',
       options,
@@ -232,7 +233,7 @@ export class InternalSipService {
         connectionType,
       },
     };
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       `/internal/sip/register/validate`,
       'POST',
       options,

package/services/socket.js

@@ -1,3 +1,4 @@
+import { internalRequest } from '../utils/sdkRequest.js';
 export class InternalSocketService {
   constructor(sdk) {
     this.sdk = sdk;
@@ -43,7 +44,7 @@ export class InternalSocketService {
       body: connectionData,
     };
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       '/internal/socket/connection',
       'POST',
       params,
@@ -73,7 +74,7 @@ export class InternalSocketService {
       body: updateData,
     };
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       `/internal/socket/connection/${id}`,
       'PUT',
       params,
@@ -89,7 +90,7 @@ export class InternalSocketService {
       },
     );
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       `/internal/socket/connection/${id}`,
       'DELETE',
     );
@@ -108,7 +109,7 @@ export class InternalSocketService {
       body: { serverId },
     };
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       '/internal/socket/connection/byServerId',
       'DELETE',
       params,

package/services/video.js

@@ -0,0 +1,130 @@
+import { internalRequest } from '../utils/sdkRequest.js';
+export class InternalVideoService {
+  constructor(sdk) {
+    this.sdk = sdk;
+  }
+
+  /**
+   * Meet PSTN bridge join (D2/D3/D10). Called by media-manager's `webhook`
+   * v2 command from the meetDialIn app once the caller has DTMF'd a
+   * meetingId + PIN. Matches
+   * app1-api/src/services/INTERNAL/video/controllers/meetJoin.js.
+   *
+   * POST /internal/video/meetJoin
+   * Body: { callId, from, variables: { meetingId, meetingPin, attempt? } }
+   */
+  async meetJoin({ callId, from, variables }) {
+    this.sdk.validateParams(
+      { callId },
+      {
+        callId: { type: 'string', required: true },
+        from: { type: 'string', required: false },
+        variables: { type: 'object', required: false },
+      },
+    );
+
+    const body = { callId };
+    if (from) body.from = from;
+    if (variables) body.variables = variables;
+
+    const params = {
+      body,
+    };
+
+    const result = await internalRequest(this.sdk, 
+      '/internal/video/meetJoin',
+      'POST',
+      params,
+    );
+    return result;
+  }
+
+  /**
+   * Meet PSTN bridge D9 (phone-hangs-up teardown). POST when a callId ==
+   * sipCallId leg observed on an active Meet participant ends. Matches
+   * app1-api/src/services/INTERNAL/video/controllers/meetCallEnded.js.
+   *
+   * POST /internal/video/meetCallEnded
+   * Body: { sipCallId, accountId }
+   */
+  async meetCallEnded({ sipCallId, accountId }) {
+    this.sdk.validateParams(
+      { sipCallId, accountId },
+      {
+        sipCallId: { type: 'string', required: true },
+        accountId: { type: 'string', required: true },
+      },
+    );
+
+    const params = {
+      body: { sipCallId, accountId },
+    };
+
+    const result = await internalRequest(this.sdk, 
+      '/internal/video/meetCallEnded',
+      'POST',
+      params,
+    );
+    return result;
+  }
+
+  /**
+   * Meet PSTN bridge dial-out status callback. media-manager's
+   * DialEventHandler posts here (fire-and-forget) for pre-answer progress
+   * ('trying' | 'ringing' | 'answered') and terminal 'failed' outcomes on a
+   * standalone-outbound leg placed via placeOutboundCall's statusWebhook.
+   * Matches
+   * app1-api/src/services/INTERNAL/video/controllers/meetOutboundStatus.js.
+   *
+   * The api controller is intentionally tolerant of unknown/extra fields
+   * (it only requires participantId, roomId, event), so this method passes
+   * the payload through as-is rather than enumerating every static field —
+   * add a typed field here if a fixed shape solidifies.
+   *
+   * POST /internal/video/meetOutboundStatus
+   * Body: { event, callId, requestId, participantId, roomId, reason? }
+   */
+  async meetOutboundStatus(payload) {
+    this.sdk.validateParams(
+      { payload },
+      {
+        payload: { type: 'object', required: true },
+      },
+    );
+    const { event, participantId, roomId } = payload || {};
+    if (!event || !participantId || !roomId) {
+      throw new Error(
+        'meetOutboundStatus requires event, participantId, and roomId.',
+      );
+    }
+
+    const params = {
+      body: payload,
+    };
+
+    const result = await internalRequest(this.sdk, 
+      '/internal/video/meetOutboundStatus',
+      'POST',
+      params,
+    );
+    return result;
+  }
+
+  /**
+   * Notify app1-api that a video session closed.
+   * POST /internal/video/:roomId/close
+   * Body: { reason }
+   */
+  async closeRoom(roomId, { reason } = {}) {
+    this.sdk.validateParams(
+      { roomId },
+      { roomId: { type: 'string', required: true } },
+    );
+    return internalRequest(
+      this.sdk,
+      `/internal/video/${roomId}/close`,
+      'POST',
+      { body: { reason } },
+    );
+  }
+}

package/services/voice.js

@@ -0,0 +1,40 @@
+import { internalRequest } from '../utils/sdkRequest.js';
+export class InternalVoiceService {
+  constructor(sdk) {
+    this.sdk = sdk;
+  }
+
+  /**
+   * Bulk write endpoint for the CDR discrete-event timeline (WP6.5).
+   * Emitters (sip-processor / media-manager / task-router) call this to
+   * report events; fire-and-forget semantics are the CALLER's job, not
+   * this method's. Matches
+   * app1-api/src/services/INTERNAL/voice/controllers/createCdrEvents.js.
+   *
+   * POST /internal/voice/cdrEvents
+   * Body: {
+   *   accountId,
+   *   events: [{ cdrId, sipCallId?, eventType, ts, actorType, actorId?, data? }]
+   * } -- max 50 events per request (enforced by the api).
+   */
+  async createCdrEvents({ accountId, events }) {
+    this.sdk.validateParams(
+      { accountId, events },
+      {
+        accountId: { type: 'string', required: true },
+        events: { type: 'array', required: true },
+      },
+    );
+
+    const params = {
+      body: { accountId, events },
+    };
+
+    const result = await internalRequest(this.sdk, 
+      '/internal/voice/cdrEvents',
+      'POST',
+      params,
+    );
+    return result;
+  }
+}

package/services/voicemail.js

@@ -0,0 +1,48 @@
+import { internalRequest } from '../utils/sdkRequest.js';
+export class InternalVoicemailService {
+  constructor(sdk) {
+    this.sdk = sdk;
+  }
+
+  /**
+   * app1-transcription reports the result of a batch voicemail
+   * transcription here after POST /transcription/voicemail finishes
+   * (success or failure). Matches
+   * app1-api/src/services/INTERNAL/voicemail/controllers/transcriptionComplete.js.
+   *
+   * POST /internal/voicemail/transcription
+   * Body: { accountId, voicemailMessageId, transcription, transcriptionStatus }
+   */
+  async transcriptionComplete({
+    accountId,
+    voicemailMessageId,
+    transcription,
+    transcriptionStatus,
+  }) {
+    this.sdk.validateParams(
+      { accountId, voicemailMessageId, transcriptionStatus },
+      {
+        accountId: { type: 'string', required: true },
+        voicemailMessageId: { type: 'string', required: true },
+        transcription: { type: 'string', required: false },
+        transcriptionStatus: { type: 'string', required: true },
+      },
+    );
+
+    const params = {
+      body: {
+        accountId,
+        voicemailMessageId,
+        transcription,
+        transcriptionStatus,
+      },
+    };
+
+    const result = await internalRequest(this.sdk, 
+      '/internal/voicemail/transcription',
+      'POST',
+      params,
+    );
+    return result;
+  }
+}

package/utils/sdkRequest.js

@@ -0,0 +1,10 @@
+const SDK_REQUEST = Symbol.for('unbound.sdk.request');
+
+/** Calls the public SDK instance request. Not an HTTP client. */
+export function internalRequest(sdk, endpoint, method, params, forceFetch) {
+  const run = sdk?.[SDK_REQUEST];
+  if (typeof run !== 'function') {
+    throw new Error('SDK request is not initialized');
+  }
+  return run(endpoint, method, params, forceFetch);
+}