telnyx 6.83.0 → 7.2.0

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

@@ -23,7 +23,7 @@ export class SipRegistrationStatus extends APIResource {
 
 export interface SipRegistrationStatusRetrieveResponse {
   /**
-   * Identifier of the UAC connection.
+   * Identifier of the connection associated with the credential.
    */
   connection_id?: string;
 
@@ -35,7 +35,7 @@ export interface SipRegistrationStatusRetrieveResponse {
   /**
    * The credential type that was looked up.
    */
-  credential_type?: 'uac_external_credential';
+  credential_type?: 'uac_external_credential' | 'telephony_credential';
 
   /**
    * SIP username used for the registration.
@@ -53,7 +53,8 @@ export interface SipRegistrationStatusRetrieveResponse {
   registered?: boolean;
 
   /**
-   * Detailed registration information reported by the registrar.
+   * Detailed registration information reported by the registrar. The populated
+   * fields depend on `credential_type`.
    */
   sip_registration_details?: SipRegistrationStatusRetrieveResponse.SipRegistrationDetails;
 
@@ -72,7 +73,8 @@ export interface SipRegistrationStatusRetrieveResponse {
 
 export namespace SipRegistrationStatusRetrieveResponse {
   /**
-   * Detailed registration information reported by the registrar.
+   * Detailed registration information reported by the registrar. The populated
+   * fields depend on `credential_type`.
    */
   export interface SipRegistrationDetails {
     /**
@@ -90,16 +92,41 @@ export namespace SipRegistrationStatusRetrieveResponse {
      */
     failures?: number;
 
+    /**
+     * Timestamp when the registration row was last modified (telephony_credential).
+     */
+    last_modified?: string;
+
     /**
      * Unix timestamp of the next scheduled registration action.
      */
     next_action_at?: number;
 
+    /**
+     * Registrar node handling the registration (telephony_credential).
+     */
+    node?: string;
+
     /**
      * SIP URI user@host of the registered contact.
      */
     sip_uri_user_host?: string;
 
+    /**
+     * Transport used for the registration, e.g. UDP/TCP/TLS (telephony_credential).
+     */
+    transport?: string;
+
+    /**
+     * IP address of the registered user agent (telephony_credential).
+     */
+    ua_ip?: string;
+
+    /**
+     * Port of the registered user agent (telephony_credential).
+     */
+    ua_port?: number;
+
     /**
      * Registration uptime reported by the registrar.
      */
@@ -109,15 +136,22 @@ export namespace SipRegistrationStatusRetrieveResponse {
 
 export interface SipRegistrationStatusRetrieveParams {
   /**
-   * Identifier of the UAC connection to look up.
+   * The kind of credential to look up. `uac_external_credential` is keyed by
+   * `connection_id`; `telephony_credential` is keyed by `username`.
    */
-  connection_id: string;
+  credential_type: 'uac_external_credential' | 'telephony_credential';
+
+  /**
+   * Identifier of the UAC connection to look up. Required when `credential_type` is
+   * `uac_external_credential`.
+   */
+  connection_id?: string;
 
   /**
-   * The kind of credential to look up. Only `uac_external_credential` is supported
-   * today.
+   * SIP username of the telephony credential to look up. Required when
+   * `credential_type` is `telephony_credential`.
    */
-  credential_type: 'uac_external_credential';
+  username?: string;
 }
 
 export declare namespace SipRegistrationStatus {

package/src/resources/siprec-connectors.ts

@@ -15,7 +15,7 @@ export class SiprecConnectors extends APIResource {
    *
    * @example
    * ```ts
-   * const siprecConnector =
+   * const siprecConnectorResponse =
    *   await client.siprecConnectors.create({
    *     host: 'siprec.telnyx.com',
    *     name: 'my-siprec-connector',
@@ -23,10 +23,7 @@ export class SiprecConnectors extends APIResource {
    *   });
    * ```
    */
-  create(
-    body: SiprecConnectorCreateParams,
-    options?: RequestOptions,
-  ): APIPromise<SiprecConnectorCreateResponse> {
+  create(body: SiprecConnectorCreateParams, options?: RequestOptions): APIPromise<SiprecConnectorResponse> {
     return this._client.post('/siprec_connectors', { body, ...options });
   }
 
@@ -35,11 +32,11 @@ export class SiprecConnectors extends APIResource {
    *
    * @example
    * ```ts
-   * const siprecConnector =
+   * const siprecConnectorResponse =
    *   await client.siprecConnectors.retrieve('connector_name');
    * ```
    */
-  retrieve(connectorName: string, options?: RequestOptions): APIPromise<SiprecConnectorRetrieveResponse> {
+  retrieve(connectorName: string, options?: RequestOptions): APIPromise<SiprecConnectorResponse> {
     return this._client.get(path`/siprec_connectors/${connectorName}`, options);
   }
 
@@ -48,7 +45,7 @@ export class SiprecConnectors extends APIResource {
    *
    * @example
    * ```ts
-   * const siprecConnector =
+   * const siprecConnectorResponse =
    *   await client.siprecConnectors.update('connector_name', {
    *     host: 'siprec.telnyx.com',
    *     name: 'my-siprec-connector',
@@ -60,7 +57,7 @@ export class SiprecConnectors extends APIResource {
     connectorName: string,
     body: SiprecConnectorUpdateParams,
     options?: RequestOptions,
-  ): APIPromise<SiprecConnectorUpdateResponse> {
+  ): APIPromise<SiprecConnectorResponse> {
     return this._client.put(path`/siprec_connectors/${connectorName}`, { body, ...options });
   }
 
@@ -80,91 +77,11 @@ export class SiprecConnectors extends APIResource {
   }
 }
 
-export interface SiprecConnectorCreateResponse {
-  data: SiprecConnectorCreateResponse.Data;
-}
-
-export namespace SiprecConnectorCreateResponse {
-  export interface Data {
-    /**
-     * Subdomain to route calls when using Telnyx SRS (optional).
-     */
-    app_subdomain?: string;
-
-    /**
-     * ISO 8601 formatted date/time of creation.
-     */
-    created_at?: string;
-
-    /**
-     * Hostname/IPv4 address of the SIPREC SRS.
-     */
-    host?: string;
-
-    /**
-     * Name for the SIPREC connector resource.
-     */
-    name?: string;
-
-    /**
-     * Port for the SIPREC SRS.
-     */
-    port?: number;
-
-    record_type?: string;
-
-    /**
-     * ISO 8601 formatted date/time of last update.
-     */
-    updated_at?: string;
-  }
-}
-
-export interface SiprecConnectorRetrieveResponse {
-  data: SiprecConnectorRetrieveResponse.Data;
-}
-
-export namespace SiprecConnectorRetrieveResponse {
-  export interface Data {
-    /**
-     * Subdomain to route calls when using Telnyx SRS (optional).
-     */
-    app_subdomain?: string;
-
-    /**
-     * ISO 8601 formatted date/time of creation.
-     */
-    created_at?: string;
-
-    /**
-     * Hostname/IPv4 address of the SIPREC SRS.
-     */
-    host?: string;
-
-    /**
-     * Name for the SIPREC connector resource.
-     */
-    name?: string;
-
-    /**
-     * Port for the SIPREC SRS.
-     */
-    port?: number;
-
-    record_type?: string;
-
-    /**
-     * ISO 8601 formatted date/time of last update.
-     */
-    updated_at?: string;
-  }
-}
-
-export interface SiprecConnectorUpdateResponse {
-  data: SiprecConnectorUpdateResponse.Data;
+export interface SiprecConnectorResponse {
+  data: SiprecConnectorResponse.Data;
 }
 
-export namespace SiprecConnectorUpdateResponse {
+export namespace SiprecConnectorResponse {
   export interface Data {
     /**
      * Subdomain to route calls when using Telnyx SRS (optional).
@@ -246,9 +163,7 @@ export interface SiprecConnectorUpdateParams {
 
 export declare namespace SiprecConnectors {
   export {
-    type SiprecConnectorCreateResponse as SiprecConnectorCreateResponse,
-    type SiprecConnectorRetrieveResponse as SiprecConnectorRetrieveResponse,
-    type SiprecConnectorUpdateResponse as SiprecConnectorUpdateResponse,
+    type SiprecConnectorResponse as SiprecConnectorResponse,
     type SiprecConnectorCreateParams as SiprecConnectorCreateParams,
     type SiprecConnectorUpdateParams as SiprecConnectorUpdateParams,
   };

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

@@ -2,10 +2,12 @@
 
 export {
   SpeechToText,
+  type SttServiceType,
   type SpeechToTextListProvidersResponse,
   type TranscribeClientEvent,
   type TranscribeServerEvent,
   type SpeechToTextListProvidersParams,
+  type SpeechToTextRetrieveTranscriptionParams,
 } from './speech-to-text';
 export { type SpeechToTextWSClientOptions } from './ws';
 export { type SpeechToTextWSReconnectOptions } from './ws-base';

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

@@ -1,13 +1,12 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
+import * as SpeechToTextAPI from './speech-to-text';
 import { APIPromise } from '../../core/api-promise';
 import { type Uploadable } from '../../core/uploads';
+import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 
-/**
- * Discover available speech-to-text providers, models, and supported languages.
- */
 export class SpeechToText extends APIResource {
   /**
    * Retrieve the canonical list of supported speech-to-text providers, models,
@@ -17,10 +16,11 @@ export class SpeechToText extends APIResource {
    *
    * - `streaming` — standalone WebSocket transcription via
    *   `/speech-to-text/transcription`.
-   * - `file_transcription` — file-based transcription via
-   *   `/ai/audio/transcriptions`.
-   * - `in_call_transcription` — live call transcription via Call Control
-   *   `transcription_start`.
+   * - `file_based` — file-based transcription via `/ai/audio/transcriptions`.
+   * - `in_call` — live call transcription via Call Control `transcription_start`.
+   * - `ai_assistant` — STT configured on a Call Control AI Assistant via
+   *   voice-assistant `TranscriptionConfig` (covers both live-streaming and
+   *   non-streaming/batch models).
    *
    * Use this endpoint to discover which (provider, model) combinations are available
    * for the surface you need, and which language codes each accepts. `auto` in a
@@ -36,8 +36,48 @@ export class SpeechToText extends APIResource {
       ...options,
     });
   }
+
+  /**
+   * Open a WebSocket connection to stream audio and receive transcriptions in
+   * real-time. Authentication is provided via the standard
+   * `Authorization: Bearer <API_KEY>` header.
+   *
+   * Supported engines: `Azure`, `Deepgram`, `Google`, `Telnyx`, `xAI`,
+   * `Speechmatics`, `Soniox`.
+   *
+   * **Connection flow:**
+   *
+   * 1. Open WebSocket with query parameters specifying engine, input format, and
+   *    language.
+   * 2. Send binary audio frames (mp3/wav format).
+   * 3. Receive JSON transcript frames with `transcript`, `is_final`, and
+   *    `confidence` fields.
+   * 4. Close connection when done.
+   */
+  retrieveTranscription(
+    query: SpeechToTextRetrieveTranscriptionParams,
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    return this._client.get('/speech-to-text/transcription', {
+      query,
+      defaultBaseURL: 'wss://api.telnyx.com/v2',
+      ...options,
+      headers: buildHeaders([
+        { 'Content-Type': 'application/octet-stream', Accept: '*/*' },
+        options?.headers,
+      ]),
+    });
+  }
 }
 
+/**
+ * Service surface a model is available on. `ai_assistant` is the STT surface
+ * configured via Call Control voice-assistant transcription; it covers both
+ * live-streaming and non-streaming/batch models (matching the
+ * `TranscriptionConfig.model` enum on `call-control` voice assistants).
+ */
+export type SttServiceType = 'streaming' | 'file_based' | 'in_call' | 'ai_assistant';
+
 /**
  * List of supported STT providers and models.
  */
@@ -49,15 +89,10 @@ export interface SpeechToTextListProvidersResponse {
 
 export namespace SpeechToTextListProvidersResponse {
   /**
-   * A (provider, model) tuple along with its supported service types and languages.
+   * A (provider, model) tuple along with the service surfaces it supports. Each
+   * entry in `service_types` describes one surface and the languages accepted on it.
    */
   export interface Data {
-    /**
-     * Languages this (provider, model) accepts, in the provider's native code format.
-     * `auto` indicates the provider performs language detection.
-     */
-    languages: Array<string>;
-
     /**
      * Provider-scoped model name.
      */
@@ -69,9 +104,35 @@ export namespace SpeechToTextListProvidersResponse {
     provider: string;
 
     /**
-     * Service surfaces this (provider, model) supports.
+     * Service surfaces this (provider, model) supports. When the request filters by
+     * `service_type`, only the matching nested entry is returned for each matching
+     * model.
      */
-    service_types: Array<'streaming' | 'file_transcription' | 'in_call_transcription'>;
+    service_types: Array<Data.ServiceType>;
+  }
+
+  export namespace Data {
+    /**
+     * A supported service surface for a given (provider, model), along with the
+     * language codes accepted on that surface. Language support can differ per surface
+     * — for example, a model may accept a narrower language set for streaming than for
+     * file transcription.
+     */
+    export interface ServiceType {
+      /**
+       * Languages accepted on this service surface, in the provider's native code
+       * format. `auto` indicates the provider performs language detection.
+       */
+      languages: Array<string>;
+
+      /**
+       * Service surface a model is available on. `ai_assistant` is the STT surface
+       * configured via Call Control voice-assistant transcription; it covers both
+       * live-streaming and non-streaming/batch models (matching the
+       * `TranscriptionConfig.model` enum on `call-control` voice assistants).
+       */
+      type: SpeechToTextAPI.SttServiceType;
+    }
   }
 
   export interface Meta {
@@ -158,16 +219,93 @@ export interface SpeechToTextListProvidersParams {
     | 'telnyx';
 
   /**
-   * Filter to entries that support the given service type.
+   * Filter to entries that support the given service type. For backward
+   * compatibility with the values that briefly shipped before the product-aligned
+   * rename, the legacy aliases `file_transcription`, `in_call_transcription`, and
+   * `ai_assistant_transcription` are silently accepted and normalized to
+   * `file_based`, `in_call`, and `ai_assistant` respectively. The response always
+   * emits the canonical (post-rename) values.
+   */
+  service_type?: SttServiceType;
+}
+
+export interface SpeechToTextRetrieveTranscriptionParams {
+  /**
+   * The format of input audio stream.
+   */
+  input_format: 'mp3' | 'wav';
+
+  /**
+   * The transcription engine to use for processing the audio stream.
+   */
+  transcription_engine: 'Azure' | 'Deepgram' | 'Google' | 'Telnyx' | 'xAI' | 'Speechmatics' | 'Soniox';
+
+  /**
+   * Silence duration (in milliseconds) that triggers end-of-speech detection. When
+   * set, the engine uses this value to determine when a speaker has stopped talking.
+   * Supported by `xAI`, `Deepgram`, `Google`, `Speechmatics`, and `Soniox`. `Soniox`
+   * accepts values between 500 and 3000. Other engines may not support this
+   * parameter.
+   */
+  endpointing?: number;
+
+  /**
+   * Whether to receive interim transcription results.
+   */
+  interim_results?: boolean;
+
+  /**
+   * A key term to boost in the transcription. The engine will be more likely to
+   * recognize this term. Can be specified multiple times for multiple terms.
+   */
+  keyterm?: string;
+
+  /**
+   * Comma-separated list of keywords to boost in the transcription. The engine will
+   * prioritize recognition of these words.
+   */
+  keywords?: string;
+
+  /**
+   * The language spoken in the audio stream.
+   */
+  language?: string;
+
+  /**
+   * The specific model to use within the selected transcription engine.
+   */
+  model?:
+    | 'fast'
+    | 'deepgram/nova-2'
+    | 'deepgram/nova-3'
+    | 'latest_long'
+    | 'latest_short'
+    | 'command_and_search'
+    | 'phone_call'
+    | 'video'
+    | 'default'
+    | 'medical_conversation'
+    | 'medical_dictation'
+    | 'openai/whisper-tiny'
+    | 'openai/whisper-large-v3-turbo'
+    | 'xai/grok-stt'
+    | 'speechmatics/standard'
+    | 'soniox/stt-rt-v4';
+
+  /**
+   * Enable redaction of sensitive information (e.g., PCI data, SSN) from
+   * transcription results. Supported values depend on the transcription engine.
    */
-  service_type?: 'streaming' | 'file_transcription' | 'in_call_transcription';
+  redact?: string;
 }
 
 export declare namespace SpeechToText {
   export {
+    type SttServiceType as SttServiceType,
     type SpeechToTextListProvidersResponse as SpeechToTextListProvidersResponse,
     type TranscribeClientEvent as TranscribeClientEvent,
     type TranscribeServerEvent as TranscribeServerEvent,
     type SpeechToTextListProvidersParams as SpeechToTextListProvidersParams,
+    type SpeechToTextRetrieveTranscriptionParams as SpeechToTextRetrieveTranscriptionParams,
   };
 }

package/src/resources/terms-of-service/agreements.ts

@@ -0,0 +1,102 @@
+// 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 { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * Accept and review the Branded Calling and Phone Number Reputation terms of service.
+ */
+export class Agreements extends APIResource {
+  /**
+   * Retrieve a single ToS agreement record. Returns `404` if the agreement does not
+   * exist or does not belong to the authenticated user.
+   */
+  retrieve(agreementID: string, options?: RequestOptions): APIPromise<TosAgreementWrapped> {
+    return this._client.get(path`/terms_of_service/agreements/${agreementID}`, options);
+  }
+
+  /**
+   * Returns the Terms of Service agreements the authenticated user has on file. Each
+   * entry records the version agreed to and when. Most users only have one agreement
+   * per product, but if the ToS is updated and the user re-agrees a new entry is
+   * added.
+   *
+   * Results are paginated with the standard `page[number]` / `page[size]`
+   * parameters; the response uses the standard `{data, meta}` JSON:API envelope.
+   *
+   * By default this returns agreements for **all** products the user has agreed to.
+   * Pass the `product_type` query parameter to scope the result to a single product.
+   */
+  list(
+    query: AgreementListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<TosAgreementsDefaultFlatPagination, TosAgreement> {
+    return this._client.getAPIList('/terms_of_service/agreements', DefaultFlatPagination<TosAgreement>, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export type TosAgreementsDefaultFlatPagination = DefaultFlatPagination<TosAgreement>;
+
+/**
+ * A recorded user agreement to a product's Terms of Service. The `user_id` is
+ * intentionally NOT echoed back on this public surface - the caller already knows
+ * their own identity.
+ */
+export interface TosAgreement {
+  id?: string;
+
+  agreed_at?: string;
+
+  created_at?: string;
+
+  /**
+   * Telnyx product the Terms of Service apply to.
+   */
+  product_type?: TosProductType;
+
+  terms_version?: string;
+
+  /**
+   * Convenience alias of `terms_version`. Both keys are present on every response.
+   */
+  version?: string;
+}
+
+export interface TosAgreementWrapped {
+  /**
+   * A recorded user agreement to a product's Terms of Service. The `user_id` is
+   * intentionally NOT echoed back on this public surface - the caller already knows
+   * their own identity.
+   */
+  data: TosAgreement;
+}
+
+/**
+ * Telnyx product the Terms of Service apply to.
+ */
+export type TosProductType = 'branded_calling' | 'number_reputation';
+
+export interface AgreementListParams extends DefaultFlatPaginationParams {
+  /**
+   * Optional filter. Omit to list the user's agreements for **every** product
+   * (branded_calling and number_reputation); pass a value to return only that
+   * product's agreements.
+   */
+  product_type?: TosProductType;
+}
+
+export declare namespace Agreements {
+  export {
+    type TosAgreement as TosAgreement,
+    type TosAgreementWrapped as TosAgreementWrapped,
+    type TosProductType as TosProductType,
+    type TosAgreementsDefaultFlatPagination as TosAgreementsDefaultFlatPagination,
+    type AgreementListParams as AgreementListParams,
+  };
+}

package/src/resources/terms-of-service/branded-calling.ts

@@ -0,0 +1,24 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as AgreementsAPI from './agreements';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+
+/**
+ * Accept and review the Branded Calling and Phone Number Reputation terms of service.
+ */
+export class BrandedCalling extends APIResource {
+  /**
+   * Records the authenticated user's agreement to the current Branded Calling ToS.
+   * No body required. Idempotent - re-calling after agreement is a no-op and returns
+   * the existing agreement.
+   *
+   * This is a prerequisite for activating Branded Calling on any enterprise
+   * (`POST /enterprises/{id}/branded_calling`); without an agreement, activation
+   * returns `403`.
+   */
+  agree(options?: RequestOptions): APIPromise<AgreementsAPI.TosAgreementWrapped> {
+    return this._client.post('/terms_of_service/branded_calling/agree', options);
+  }
+}

package/src/resources/terms-of-service/index.ts

@@ -1,4 +1,19 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+export {
+  Agreements,
+  type TosAgreement,
+  type TosAgreementWrapped,
+  type TosProductType,
+  type AgreementListParams,
+  type TosAgreementsDefaultFlatPagination,
+} from './agreements';
+export { BrandedCalling } from './branded-calling';
 export { NumberReputation } from './number-reputation';
-export { TermsOfService } from './terms-of-service';
+export {
+  TermsOfService,
+  type TermsOfServiceRetrieveInfoResponse,
+  type TermsOfServiceRetrieveStatusResponse,
+  type TermsOfServiceRetrieveInfoParams,
+  type TermsOfServiceRetrieveStatusParams,
+} from './terms-of-service';

package/src/resources/terms-of-service/number-reputation.ts

@@ -1,25 +1,21 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
+import * as AgreementsAPI from './agreements';
 import { APIPromise } from '../../core/api-promise';
-import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 
 /**
- * Terms of Service agreement endpoints
+ * Accept and review the Branded Calling and Phone Number Reputation terms of service.
  */
 export class NumberReputation extends APIResource {
   /**
-   * Accept the Terms of Service for the Number Reputation product. Must be called
-   * before using Number Reputation endpoints.
+   * Records the authenticated user's agreement to the current Phone Number
+   * Reputation ToS. No body required. Idempotent.
    *
-   * Returns `400` with error code `10015` if the user has already agreed to the
-   * current ToS version.
+   * Prerequisite for using any of the `/v2/.../reputation/*` endpoints.
    */
-  agree(options?: RequestOptions): APIPromise<void> {
-    return this._client.post('/terms_of_service/number_reputation/agree', {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+  agree(options?: RequestOptions): APIPromise<AgreementsAPI.TosAgreementWrapped> {
+    return this._client.post('/terms_of_service/number_reputation/agree', options);
   }
 }