telnyx 6.71.0 → 6.73.0

package/src/client.ts

@@ -811,6 +811,11 @@ import {
   SimCardOrders,
   SimCardOrdersDefaultFlatPagination,
 } from './resources/sim-card-orders';
+import {
+  SipRegistrationStatus,
+  SipRegistrationStatusRetrieveParams,
+  SipRegistrationStatusRetrieveResponse,
+} from './resources/sip-registration-status';
 import {
   SiprecConnectorCreateParams,
   SiprecConnectorCreateResponse,
@@ -819,11 +824,6 @@ import {
   SiprecConnectorUpdateResponse,
   SiprecConnectors,
 } from './resources/siprec-connectors';
-import {
-  SpeechToText,
-  SpeechToTextListProvidersParams,
-  SpeechToTextListProvidersResponse,
-} from './resources/speech-to-text';
 import {
   SubNumberOrder,
   SubNumberOrderCancelResponse,
@@ -1536,6 +1536,13 @@ import {
   SimCardUpdateResponse,
   SimCards,
 } from './resources/sim-cards/sim-cards';
+import {
+  SpeechToText,
+  SpeechToTextListProvidersParams,
+  SpeechToTextListProvidersResponse,
+  TranscribeClientEvent,
+  TranscribeServerEvent,
+} from './resources/speech-to-text/speech-to-text';
 import { Storage, StorageListMigrationSourceCoverageResponse } from './resources/storage/storage';
 import { TermsOfService } from './resources/terms-of-service/terms-of-service';
 import {
@@ -1549,8 +1556,9 @@ import {
   StreamClientEvent,
   StreamServerEvent,
   TextToSpeech,
-  TextToSpeechGenerateParams,
-  TextToSpeechGenerateResponse,
+  TextToSpeechCreateSpeechParams,
+  TextToSpeechCreateSpeechResponse,
+  TextToSpeechGenerateSpeechParams,
   TextToSpeechListVoicesParams,
   TextToSpeechListVoicesResponse,
 } from './resources/text-to-speech/text-to-speech';
@@ -2791,6 +2799,10 @@ export class Telnyx {
    */
   regulatoryRequirements: API.RegulatoryRequirements = new API.RegulatoryRequirements(this);
   reports: API.Reports = new API.Reports(this);
+  /**
+   * Discover available speech-to-text providers, models, and supported languages.
+   */
+  speechToText: API.SpeechToText = new API.SpeechToText(this);
   /**
    * Requirement Groups
    */
@@ -2984,14 +2996,14 @@ export class Telnyx {
    * UAC connection operations
    */
   uacConnections: API.UacConnections = new API.UacConnections(this);
-  /**
-   * Discover available speech-to-text providers, models, and supported languages.
-   */
-  speechToText: API.SpeechToText = new API.SpeechToText(this);
   /**
    * Retrieve raw Voice SDK call report stats payloads for WebRTC call troubleshooting.
    */
   voiceSDKCallReports: API.VoiceSDKCallReports = new API.VoiceSDKCallReports(this);
+  /**
+   * Look up SIP registration status across credential types
+   */
+  sipRegistrationStatus: API.SipRegistrationStatus = new API.SipRegistrationStatus(this);
 }
 
 Telnyx.Legacy = Legacy;
@@ -3102,6 +3114,7 @@ Telnyx.Recordings = Recordings;
 Telnyx.Regions = Regions;
 Telnyx.RegulatoryRequirements = RegulatoryRequirements;
 Telnyx.Reports = Reports;
+Telnyx.SpeechToText = SpeechToText;
 Telnyx.RequirementGroups = RequirementGroups;
 Telnyx.RequirementTypes = RequirementTypes;
 Telnyx.Requirements = Requirements;
@@ -3158,8 +3171,8 @@ Telnyx.Reputation = Reputation;
 Telnyx.TermsOfService = TermsOfService;
 Telnyx.PronunciationDicts = PronunciationDicts;
 Telnyx.UacConnections = UacConnections;
-Telnyx.SpeechToText = SpeechToText;
 Telnyx.VoiceSDKCallReports = VoiceSDKCallReports;
+Telnyx.SipRegistrationStatus = SipRegistrationStatus;
 
 export declare namespace Telnyx {
   export type RequestOptions = Opts.RequestOptions;
@@ -4397,6 +4410,14 @@ export declare namespace Telnyx {
     type ReportListWdrsParams as ReportListWdrsParams,
   };
 
+  export {
+    SpeechToText as SpeechToText,
+    type SpeechToTextListProvidersResponse as SpeechToTextListProvidersResponse,
+    type TranscribeClientEvent as TranscribeClientEvent,
+    type TranscribeServerEvent as TranscribeServerEvent,
+    type SpeechToTextListProvidersParams as SpeechToTextListProvidersParams,
+  };
+
   export {
     RequirementGroups as RequirementGroups,
     type RequirementGroup as RequirementGroup,
@@ -4615,11 +4636,12 @@ export declare namespace Telnyx {
 
   export {
     TextToSpeech as TextToSpeech,
-    type TextToSpeechGenerateResponse as TextToSpeechGenerateResponse,
+    type TextToSpeechCreateSpeechResponse as TextToSpeechCreateSpeechResponse,
     type TextToSpeechListVoicesResponse as TextToSpeechListVoicesResponse,
     type StreamClientEvent as StreamClientEvent,
     type StreamServerEvent as StreamServerEvent,
-    type TextToSpeechGenerateParams as TextToSpeechGenerateParams,
+    type TextToSpeechCreateSpeechParams as TextToSpeechCreateSpeechParams,
+    type TextToSpeechGenerateSpeechParams as TextToSpeechGenerateSpeechParams,
     type TextToSpeechListVoicesParams as TextToSpeechListVoicesParams,
   };
 
@@ -4942,12 +4964,6 @@ export declare namespace Telnyx {
     type UacConnectionListParams as UacConnectionListParams,
   };
 
-  export {
-    SpeechToText as SpeechToText,
-    type SpeechToTextListProvidersResponse as SpeechToTextListProvidersResponse,
-    type SpeechToTextListProvidersParams as SpeechToTextListProvidersParams,
-  };
-
   export {
     VoiceSDKCallReports as VoiceSDKCallReports,
     type VoiceSDKCallReportLogEntry as VoiceSDKCallReportLogEntry,
@@ -4957,6 +4973,12 @@ export declare namespace Telnyx {
     type VoiceSDKCallReportListParams as VoiceSDKCallReportListParams,
   };
 
+  export {
+    SipRegistrationStatus as SipRegistrationStatus,
+    type SipRegistrationStatusRetrieveResponse as SipRegistrationStatusRetrieveResponse,
+    type SipRegistrationStatusRetrieveParams as SipRegistrationStatusRetrieveParams,
+  };
+
   export type APIError = API.APIError;
   export type AvailablePhoneNumbersMetadata = API.AvailablePhoneNumbersMetadata;
   export type AzureVoiceSettings = API.AzureVoiceSettings;

package/src/resources/ai/ai.ts

@@ -180,8 +180,8 @@ export class AI extends APIResource {
     params: AICreateResponseParams,
     options?: RequestOptions,
   ): APIPromise<AICreateResponseResponse> {
-    const { body } = params;
-    return this._client.post('/ai/responses', { body: body, ...options });
+    const { input } = params;
+    return this._client.post('/ai/responses', { body: input, ...options });
   }
 
   /**
@@ -374,7 +374,7 @@ export namespace AISummarizeResponse {
 }
 
 export interface AICreateResponseParams {
-  body: { [key: string]: unknown };
+  input: { [key: string]: unknown };
 }
 
 export interface AISummarizeParams {

package/src/resources/index.ts

@@ -1163,6 +1163,11 @@ export {
   type SimCardListWirelessConnectivityLogsParams,
   type SimCardListWirelessConnectivityLogsResponsesDefaultFlatPagination,
 } from './sim-cards/sim-cards';
+export {
+  SipRegistrationStatus,
+  type SipRegistrationStatusRetrieveResponse,
+  type SipRegistrationStatusRetrieveParams,
+} from './sip-registration-status';
 export {
   SiprecConnectors,
   type SiprecConnectorCreateResponse,
@@ -1174,6 +1179,8 @@ export {
 export {
   SpeechToText,
   type SpeechToTextListProvidersResponse,
+  type TranscribeClientEvent,
+  type TranscribeServerEvent,
   type SpeechToTextListProvidersParams,
 } from './speech-to-text';
 export { Storage, type StorageListMigrationSourceCoverageResponse } from './storage/storage';
@@ -1234,11 +1241,12 @@ export {
 } from './texml-applications';
 export {
   TextToSpeech,
-  type TextToSpeechGenerateResponse,
+  type TextToSpeechCreateSpeechResponse,
   type TextToSpeechListVoicesResponse,
   type StreamClientEvent,
   type StreamServerEvent,
-  type TextToSpeechGenerateParams,
+  type TextToSpeechCreateSpeechParams,
+  type TextToSpeechGenerateSpeechParams,
   type TextToSpeechListVoicesParams,
   type TextToSpeechStreamParams,
 } from './text-to-speech';

package/src/resources/sip-registration-status.ts

@@ -0,0 +1,123 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * Look up SIP registration status across credential types
+ */
+export class SipRegistrationStatus extends APIResource {
+  /**
+   * Returns the live SIP registration state of a connection or credential. Supports
+   * UAC third-party credentials, telephony credentials, and SIP credential
+   * connections.
+   */
+  retrieve(
+    query: SipRegistrationStatusRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<SipRegistrationStatusRetrieveResponse> {
+    return this._client.get('/sip_registration_status', { query, ...options });
+  }
+}
+
+export interface SipRegistrationStatusRetrieveResponse {
+  /**
+   * Identifier of the resource.
+   */
+  connection_id?: string;
+
+  /**
+   * Human-readable connection name.
+   */
+  connection_name?: string;
+
+  /**
+   * Outward-facing SIP settings used for registration. Password is redacted.
+   */
+  external_uac_settings?: SipRegistrationStatusRetrieveResponse.ExternalUacSettings;
+
+  /**
+   * Internal routing target the connection delivers calls to.
+   */
+  internal_uac_settings?: SipRegistrationStatusRetrieveResponse.InternalUacSettings;
+
+  /**
+   * SIP response from the last registration attempt.
+   */
+  last_registration_response?: string;
+
+  /**
+   * Internal pairing state, e.g. ACTIVE or INACTIVE.
+   */
+  pair_state?: string;
+
+  /**
+   * True if the endpoint is currently registered.
+   */
+  registered?: boolean;
+
+  /**
+   * Owner of the resource.
+   */
+  user_id?: string;
+
+  /**
+   * SIP username used for the registration.
+   */
+  username?: string;
+}
+
+export namespace SipRegistrationStatusRetrieveResponse {
+  /**
+   * Outward-facing SIP settings used for registration. Password is redacted.
+   */
+  export interface ExternalUacSettings {
+    auth_username?: string;
+
+    expiration_sec?: number;
+
+    from_user?: string;
+
+    outbound_proxy?: string;
+
+    password?: string;
+
+    proxy?: string;
+
+    transport?: 'TCP' | 'UDP' | 'TLS';
+
+    username?: string;
+  }
+
+  /**
+   * Internal routing target the connection delivers calls to.
+   */
+  export interface InternalUacSettings {
+    destination_uri?: string;
+  }
+}
+
+export interface SipRegistrationStatusRetrieveParams {
+  /**
+   * Identifier of the connection or credential to look up.
+   */
+  connection_id: string;
+
+  /**
+   * The kind of credential to look up.
+   */
+  credential_type: 'uac_external_credential' | 'telephony_credential' | 'sip_credential_connection';
+
+  /**
+   * Owner of the connection. Used to authorize the lookup.
+   */
+  user_id: string;
+}
+
+export declare namespace SipRegistrationStatus {
+  export {
+    type SipRegistrationStatusRetrieveResponse as SipRegistrationStatusRetrieveResponse,
+    type SipRegistrationStatusRetrieveParams as SipRegistrationStatusRetrieveParams,
+  };
+}

package/src/resources/speech-to-text/index.ts

@@ -2,13 +2,10 @@
 
 export {
   SpeechToText,
-  type SpeechToTextTranscribeParams,
-  type SpeechToTextStreamParams,
-  type SttClientEvent,
-  type SttServerEvent,
-  type TranscriptFrame,
-  type SttErrorFrame,
+  type SpeechToTextListProvidersResponse,
+  type TranscribeClientEvent,
+  type TranscribeServerEvent,
+  type SpeechToTextListProvidersParams,
 } from './speech-to-text';
-
-export { SpeechToTextWS } from './ws';
-export { WebSocketError } from './internal-base';
+export { type SpeechToTextWSClientOptions } from './ws';
+export { type SpeechToTextWSReconnectOptions } from './ws-base';

package/src/resources/speech-to-text/internal-base.ts

@@ -2,18 +2,32 @@
 
 import * as SpeechToTextAPI from './speech-to-text';
 import { Telnyx } from '../../client';
-
 import { EventEmitter } from '../../core/EventEmitter';
 import { TelnyxError } from '../../core/error';
-import { stringifyQuery } from '../../internal/utils';
+
+import type { RawWebSocketData, ReconnectingEvent, UnsentMessage } from '../../internal/ws';
+
+export type SpeechToTextStreamMessage =
+  | { type: 'connecting' | 'open' | 'closing' }
+  | {
+      type: 'close';
+      code: number;
+      reason: string;
+      unsent: UnsentMessage<SpeechToTextAPI.TranscribeClientEvent>[];
+    }
+  | { type: 'reconnecting'; reconnect: ReconnectingEvent }
+  | { type: 'reconnected' }
+  | { type: 'message'; message: SpeechToTextAPI.TranscribeServerEvent }
+  | { type: 'raw'; data: RawWebSocketData }
+  | { type: 'error'; error: WebSocketError };
 
 export class WebSocketError extends TelnyxError {
   /**
    * The error data that the API sent back in an error event.
    */
-  error?: SpeechToTextAPI.SttServerEvent.ErrorFrame | undefined;
+  error?: SpeechToTextAPI.TranscribeServerEvent.SttErrorFrame | undefined;
 
-  constructor(message: string, event: SpeechToTextAPI.SttServerEvent.ErrorFrame | null) {
+  constructor(message: string, event: SpeechToTextAPI.TranscribeServerEvent.SttErrorFrame | null) {
     super(message);
 
     this.error = event ?? undefined;
@@ -22,32 +36,48 @@ export class WebSocketError extends TelnyxError {
 
 type Simplify<T> = { [KeyType in keyof T]: T[KeyType] } & {};
 
-type WebsocketEvents = Simplify<
+type WebSocketEvents = Simplify<
   {
-    event: (event: SpeechToTextAPI.SttServerEvent) => void;
+    event: (event: SpeechToTextAPI.TranscribeServerEvent) => void;
+    raw: (data: RawWebSocketData) => void;
     error: (error: WebSocketError) => void;
+    close: (
+      code: number,
+      reason: string,
+      unsent: UnsentMessage<SpeechToTextAPI.TranscribeClientEvent>[],
+    ) => void;
+    reconnecting: (event: ReconnectingEvent) => void;
+    reconnected: () => void;
   } & {
-    [EventType in Exclude<NonNullable<SpeechToTextAPI.SttServerEvent['type']>, 'error'>]: (
-      event: Extract<SpeechToTextAPI.SttServerEvent, { type?: EventType }>,
+    [EventType in Exclude<NonNullable<SpeechToTextAPI.TranscribeServerEvent['type']>, 'error'>]: (
+      event: Extract<SpeechToTextAPI.TranscribeServerEvent, { type?: EventType }>,
     ) => unknown;
   }
 >;
 
-export abstract class SpeechToTextEmitter extends EventEmitter<WebsocketEvents> {
+export abstract class SpeechToTextEmitter extends EventEmitter<WebSocketEvents> {
+  /**
+   * Send an event to the API.
+   */
+  abstract send(event: SpeechToTextAPI.TranscribeClientEvent): void;
+
   /**
-   * Send binary audio data to the API.
+   * Send raw data over the WebSocket without JSON serialization.
    */
-  abstract send(data: SpeechToTextAPI.SttClientEvent): void;
+  abstract sendRaw(data: RawWebSocketData): void;
 
   /**
-   * Close the websocket connection.
+   * Close the WebSocket connection.
    */
   abstract close(props?: { code: number; reason: string }): void;
 
   protected _onError(event: null, message: string, cause: any): void;
-  protected _onError(event: SpeechToTextAPI.SttServerEvent.ErrorFrame, message?: string | undefined): void;
   protected _onError(
-    event: SpeechToTextAPI.SttServerEvent.ErrorFrame | null,
+    event: SpeechToTextAPI.TranscribeServerEvent.SttErrorFrame,
+    message?: string | undefined,
+  ): void;
+  protected _onError(
+    event: SpeechToTextAPI.TranscribeServerEvent.SttErrorFrame | null,
     message?: string | undefined,
     cause?: any,
   ): void {
@@ -73,14 +103,11 @@ export abstract class SpeechToTextEmitter extends EventEmitter<WebsocketEvents>
   }
 }
 
-export function buildURL(client: Telnyx, query?: SpeechToTextAPI.SpeechToTextStreamParams | null): URL {
-  const path = '/speech-to-text/transcription';
-  const baseURL = client.baseURL;
-  const url = new URL(baseURL + (baseURL.endsWith('/') ? path.slice(1) : path));
-  if (query) {
-    url.search = stringifyQuery(query);
-  }
-  url.protocol = 'wss';
+export function buildURL(client: Telnyx, parameters: Record<string, unknown>): URL {
+  const { ...query } = parameters;
+  const endpoint = '/speech-to-text/transcription';
+  const url = new URL(client.buildURL(endpoint, query, undefined));
+  url.protocol = url.protocol === 'http:' || url.protocol === 'ws:' ? 'ws:' : 'wss:';
   return url;
 }