telnyx 6.41.0 → 6.42.0

package/src/resources/ai/conversations/conversations.ts

@@ -12,7 +12,12 @@ import {
   Insights,
 } from './insights';
 import * as MessagesAPI from './messages';
-import { MessageListResponse, Messages } from './messages';
+import {
+  MessageListParams,
+  MessageListResponse,
+  MessageListResponsesDefaultFlatPagination,
+  Messages,
+} from './messages';
 import * as InsightGroupsAPI from './insight-groups/insight-groups';
 import {
   InsightGroupInsightGroupsParams,
@@ -383,5 +388,10 @@ export declare namespace Conversations {
     type InsightListParams as InsightListParams,
   };
 
-  export { Messages as Messages, type MessageListResponse as MessageListResponse };
+  export {
+    Messages as Messages,
+    type MessageListResponse as MessageListResponse,
+    type MessageListResponsesDefaultFlatPagination as MessageListResponsesDefaultFlatPagination,
+    type MessageListParams as MessageListParams,
+  };
 }

package/src/resources/ai/conversations/index.ts

@@ -30,4 +30,9 @@ export {
   type InsightListParams,
   type InsightTemplatesDefaultFlatPagination,
 } from './insights';
-export { Messages, type MessageListResponse } from './messages';
+export {
+  Messages,
+  type MessageListResponse,
+  type MessageListParams,
+  type MessageListResponsesDefaultFlatPagination,
+} from './messages';

package/src/resources/ai/conversations/messages.ts

@@ -1,8 +1,11 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../../core/resource';
-import * as RunsAPI from '../assistants/tests/test-suites/runs';
-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';
 
@@ -16,84 +19,94 @@ export class Messages extends APIResource {
    *
    * @example
    * ```ts
-   * const messages =
-   *   await client.ai.conversations.messages.list(
-   *     'conversation_id',
-   *   );
+   * // Automatically fetches more pages as needed.
+   * for await (const messageListResponse of client.ai.conversations.messages.list(
+   *   'conversation_id',
+   * )) {
+   *   // ...
+   * }
    * ```
    */
-  list(conversationID: string, options?: RequestOptions): APIPromise<MessageListResponse> {
-    return this._client.get(path`/ai/conversations/${conversationID}/messages`, options);
+  list(
+    conversationID: string,
+    query: MessageListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<MessageListResponsesDefaultFlatPagination, MessageListResponse> {
+    return this._client.getAPIList(
+      path`/ai/conversations/${conversationID}/messages`,
+      DefaultFlatPagination<MessageListResponse>,
+      { query, ...options },
+    );
   }
 }
 
+export type MessageListResponsesDefaultFlatPagination = DefaultFlatPagination<MessageListResponse>;
+
 export interface MessageListResponse {
-  data: Array<MessageListResponse.Data>;
+  /**
+   * The role of the message sender.
+   */
+  role: 'user' | 'assistant' | 'tool';
 
-  meta: RunsAPI.Meta;
-}
+  /**
+   * The message content. Can be null for tool calls.
+   */
+  text: string;
 
-export namespace MessageListResponse {
-  export interface Data {
-    /**
-     * The role of the message sender.
-     */
-    role: 'user' | 'assistant' | 'tool';
+  /**
+   * The datetime the message was created on the conversation. This does not
+   * necesarily correspond to the time the message was sent. The best field to use to
+   * determine the time the end user experienced the message is `sent_at`.
+   */
+  created_at?: string;
 
-    /**
-     * The message content. Can be null for tool calls.
-     */
-    text: string;
+  /**
+   * The datetime the message was sent to the end user.
+   */
+  sent_at?: string;
 
-    /**
-     * The datetime the message was created on the conversation. This does not
-     * necesarily correspond to the time the message was sent. The best field to use to
-     * determine the time the end user experienced the message is `sent_at`.
-     */
-    created_at?: string;
+  /**
+   * Optional tool calls made by the assistant.
+   */
+  tool_calls?: Array<MessageListResponse.ToolCall>;
+}
 
+export namespace MessageListResponse {
+  export interface ToolCall {
     /**
-     * The datetime the message was sent to the end user.
+     * Unique identifier for the tool call.
      */
-    sent_at?: string;
+    id: string;
+
+    function: ToolCall.Function;
 
     /**
-     * Optional tool calls made by the assistant.
+     * Type of the tool call.
      */
-    tool_calls?: Array<Data.ToolCall>;
+    type: 'function';
   }
 
-  export namespace Data {
-    export interface ToolCall {
+  export namespace ToolCall {
+    export interface Function {
       /**
-       * Unique identifier for the tool call.
+       * JSON-formatted arguments to pass to the function.
        */
-      id: string;
-
-      function: ToolCall.Function;
+      arguments: string;
 
       /**
-       * Type of the tool call.
+       * Name of the function to call.
        */
-      type: 'function';
-    }
-
-    export namespace ToolCall {
-      export interface Function {
-        /**
-         * JSON-formatted arguments to pass to the function.
-         */
-        arguments: string;
-
-        /**
-         * Name of the function to call.
-         */
-        name: string;
-      }
+      name: string;
     }
   }
 }
 
+export interface MessageListParams extends DefaultFlatPaginationParams {}
+
 export declare namespace Messages {
-  export { type MessageListResponse as MessageListResponse };
+  export {
+    type MessageListResponse as MessageListResponse,
+    type MessageListResponsesDefaultFlatPagination as MessageListResponsesDefaultFlatPagination,
+    type MessageListParams as MessageListParams,
+  };
 }

package/src/resources/calls/actions.ts

@@ -41,6 +41,10 @@ export class Actions extends APIResource {
    * **Expected Webhooks:**
    *
    * - `call.answered`
+   * - `call.hold` and `call.unhold` if the call is held/unheld
+   * - `call.deepfake_detection.result` if `deepfake_detection` was enabled
+   * - `call.deepfake_detection.error` if `deepfake_detection` was enabled and an
+   *   error occurred
    * - `streaming.started`, `streaming.stopped` or `streaming.failed` if `stream_url`
    *   was set
    *
@@ -1655,12 +1659,14 @@ export interface TranscriptionStartRequest {
    * Engine to use for speech recognition. Legacy values `A` - `Google`, `B` -
    * `Telnyx` are supported for backward compatibility.
    */
-  transcription_engine?: 'Google' | 'Telnyx' | 'Deepgram' | 'Azure' | 'A' | 'B';
+  transcription_engine?: 'Google' | 'Telnyx' | 'Deepgram' | 'Azure' | 'xAI' | 'AssemblyAI' | 'A' | 'B';
 
   transcription_engine_config?:
     | TranscriptionEngineGoogleConfig
     | TranscriptionEngineTelnyxConfig
     | TranscriptionEngineAzureConfig
+    | TranscriptionStartRequest.TranscriptionEngineXaiConfig
+    | TranscriptionStartRequest.TranscriptionEngineAssemblyaiConfig
     | TranscriptionEngineAConfig
     | TranscriptionEngineBConfig
     | DeepgramNova2Config
@@ -1674,6 +1680,74 @@ export interface TranscriptionStartRequest {
   transcription_tracks?: string;
 }
 
+export namespace TranscriptionStartRequest {
+  export interface TranscriptionEngineXaiConfig {
+    /**
+     * Whether to send also interim results. If set to false, only final results will
+     * be sent.
+     */
+    interim_results?: boolean;
+
+    /**
+     * Language to use for speech recognition
+     */
+    language?:
+      | 'ar'
+      | 'cs'
+      | 'da'
+      | 'de'
+      | 'en'
+      | 'es'
+      | 'fa'
+      | 'fil'
+      | 'fr'
+      | 'hi'
+      | 'id'
+      | 'it'
+      | 'ja'
+      | 'ko'
+      | 'mk'
+      | 'ms'
+      | 'nl'
+      | 'pl'
+      | 'pt'
+      | 'ro'
+      | 'ru'
+      | 'sv'
+      | 'th'
+      | 'tr'
+      | 'vi';
+
+    /**
+     * Engine identifier for xAI transcription service
+     */
+    transcription_engine?: 'xAI';
+
+    /**
+     * The model to use for transcription.
+     */
+    transcription_model?: 'xai/grok-stt';
+  }
+
+  export interface TranscriptionEngineAssemblyaiConfig {
+    /**
+     * Whether to send also interim results. If set to false, only final results will
+     * be sent.
+     */
+    interim_results?: boolean;
+
+    /**
+     * Engine identifier for AssemblyAI transcription service
+     */
+    transcription_engine?: 'AssemblyAI';
+
+    /**
+     * The model to use for transcription.
+     */
+    transcription_model?: 'assemblyai/universal-streaming';
+  }
+}
+
 export interface ActionAddAIAssistantMessagesResponse {
   data?: CallControlCommandResult;
 }
@@ -2039,6 +2113,14 @@ export interface ActionAnswerParams {
    */
   custom_headers?: Array<CallsAPI.CustomSipHeader>;
 
+  /**
+   * Enables deepfake detection on the call. When enabled, audio from the remote
+   * party is streamed to a detection service that analyzes whether the voice is
+   * AI-generated. Results are delivered via the `call.deepfake_detection.result`
+   * webhook.
+   */
+  deepfake_detection?: ActionAnswerParams.DeepfakeDetection;
+
   /**
    * The list of comma-separated codecs in a preferred order for the forked media to
    * be received.
@@ -2183,6 +2265,30 @@ export interface ActionAnswerParams {
 }
 
 export namespace ActionAnswerParams {
+  /**
+   * Enables deepfake detection on the call. When enabled, audio from the remote
+   * party is streamed to a detection service that analyzes whether the voice is
+   * AI-generated. Results are delivered via the `call.deepfake_detection.result`
+   * webhook.
+   */
+  export interface DeepfakeDetection {
+    /**
+     * Whether deepfake detection is enabled.
+     */
+    enabled: boolean;
+
+    /**
+     * Maximum time in seconds to wait for RTP audio before timing out. If no audio is
+     * received within this window, detection stops with an error.
+     */
+    rtp_timeout?: number;
+
+    /**
+     * Maximum time in seconds to wait for a detection result before timing out.
+     */
+    timeout?: number;
+  }
+
   export interface WebhookRetriesPolicies {
     /**
      * Array of delays in milliseconds between retry attempts. Total sum cannot exceed
@@ -4198,12 +4304,14 @@ export interface ActionStartTranscriptionParams {
    * Engine to use for speech recognition. Legacy values `A` - `Google`, `B` -
    * `Telnyx` are supported for backward compatibility.
    */
-  transcription_engine?: 'Google' | 'Telnyx' | 'Deepgram' | 'Azure' | 'A' | 'B';
+  transcription_engine?: 'Google' | 'Telnyx' | 'Deepgram' | 'Azure' | 'xAI' | 'AssemblyAI' | 'A' | 'B';
 
   transcription_engine_config?:
     | TranscriptionEngineGoogleConfig
     | TranscriptionEngineTelnyxConfig
     | TranscriptionEngineAzureConfig
+    | ActionStartTranscriptionParams.TranscriptionEngineXaiConfig
+    | ActionStartTranscriptionParams.TranscriptionEngineAssemblyaiConfig
     | TranscriptionEngineAConfig
     | TranscriptionEngineBConfig
     | DeepgramNova2Config
@@ -4217,6 +4325,74 @@ export interface ActionStartTranscriptionParams {
   transcription_tracks?: string;
 }
 
+export namespace ActionStartTranscriptionParams {
+  export interface TranscriptionEngineXaiConfig {
+    /**
+     * Whether to send also interim results. If set to false, only final results will
+     * be sent.
+     */
+    interim_results?: boolean;
+
+    /**
+     * Language to use for speech recognition
+     */
+    language?:
+      | 'ar'
+      | 'cs'
+      | 'da'
+      | 'de'
+      | 'en'
+      | 'es'
+      | 'fa'
+      | 'fil'
+      | 'fr'
+      | 'hi'
+      | 'id'
+      | 'it'
+      | 'ja'
+      | 'ko'
+      | 'mk'
+      | 'ms'
+      | 'nl'
+      | 'pl'
+      | 'pt'
+      | 'ro'
+      | 'ru'
+      | 'sv'
+      | 'th'
+      | 'tr'
+      | 'vi';
+
+    /**
+     * Engine identifier for xAI transcription service
+     */
+    transcription_engine?: 'xAI';
+
+    /**
+     * The model to use for transcription.
+     */
+    transcription_model?: 'xai/grok-stt';
+  }
+
+  export interface TranscriptionEngineAssemblyaiConfig {
+    /**
+     * Whether to send also interim results. If set to false, only final results will
+     * be sent.
+     */
+    interim_results?: boolean;
+
+    /**
+     * Engine identifier for AssemblyAI transcription service
+     */
+    transcription_engine?: 'AssemblyAI';
+
+    /**
+     * The model to use for transcription.
+     */
+    transcription_model?: 'assemblyai/universal-streaming';
+  }
+}
+
 export interface ActionStopAIAssistantParams {
   /**
    * Use this field to add state to every subsequent webhook. It must be a valid
@@ -4404,7 +4580,9 @@ export interface ActionTransferParams {
 
   /**
    * Optional configuration parameters to modify 'answering_machine_detection'
-   * performance.
+   * performance. Only `total_analysis_time_millis` and `greeting_duration_millis`
+   * parameters are applicable when `premium` is selected as
+   * answering_machine_detection.
    */
   answering_machine_detection_config?: ActionTransferParams.AnsweringMachineDetectionConfig;
 
@@ -4634,7 +4812,9 @@ export interface ActionTransferParams {
 export namespace ActionTransferParams {
   /**
    * Optional configuration parameters to modify 'answering_machine_detection'
-   * performance.
+   * performance. Only `total_analysis_time_millis` and `greeting_duration_millis`
+   * parameters are applicable when `premium` is selected as
+   * answering_machine_detection.
    */
   export interface AnsweringMachineDetectionConfig {
     /**