telnyx 6.71.0 → 6.72.0

package/src/resources/texml/accounts/calls/calls.ts

@@ -83,7 +83,13 @@ export class Calls extends APIResource {
    * ```ts
    * const response = await client.texml.accounts.calls.calls(
    *   'account_sid',
-   *   { params: { Url: 'https://www.example.com/texml.xml' } },
+   *   {
+   *     params: {
+   *       ApplicationSid: 'example-app-sid',
+   *       From: '+13120001234',
+   *       To: '+13121230000',
+   *     },
+   *   },
    * );
    * ```
    */
@@ -678,566 +684,37 @@ export interface CallUpdateParams {
 }
 
 export interface CallCallsParams {
-  params: CallCallsParams.WithURL | CallCallsParams.WithTeXml | CallCallsParams.ApplicationDefault;
-}
-
-export namespace CallCallsParams {
-  export interface WithURL {
-    /**
-     * The URL from which Telnyx will retrieve the TeXML call instructions.
-     */
-    Url: string;
-
-    /**
-     * The ID of the TeXML Application.
-     */
-    ApplicationSid?: string;
-
-    /**
-     * Select whether to perform answering machine detection in the background. By
-     * default execution is blocked until Answering Machine Detection is completed.
-     */
-    AsyncAmd?: boolean;
-
-    /**
-     * URL destination for Telnyx to send AMD callback events to for the call.
-     */
-    AsyncAmdStatusCallback?: string;
-
-    /**
-     * HTTP request type used for `AsyncAmdStatusCallback`. The default value is
-     * inherited from TeXML Application setting.
-     */
-    AsyncAmdStatusCallbackMethod?: 'GET' | 'POST';
-
-    /**
-     * To be used as the caller id name (SIP From Display Name) presented to the
-     * destination (`To` number). The string should have a maximum of 128 characters,
-     * containing only letters, numbers, spaces, and `-_~!.+` special characters. If
-     * ommited, the display name will be the same as the number in the `From` field.
-     */
-    CallerId?: string;
-
-    /**
-     * Whether to cancel ongoing playback on `greeting ended` detection. Defaults to
-     * `true`.
-     */
-    CancelPlaybackOnDetectMessageEnd?: boolean;
-
-    /**
-     * Whether to cancel ongoing playback on `machine` detection. Defaults to `true`.
-     */
-    CancelPlaybackOnMachineDetection?: boolean;
-
-    /**
-     * Custom HTTP headers to be sent with the call. Each header should be an object
-     * with 'name' and 'value' properties.
-     */
-    CustomHeaders?: Array<WithURL.CustomHeader>;
-
-    /**
-     * Enables Deepfake Detection on the dialed call. When enabled, audio from the
-     * remote party is analyzed to determine whether the voice is AI-generated. Results
-     * are delivered asynchronously via a callback.
-     */
-    DeepfakeDetection?: 'Enable';
-
-    /**
-     * HTTP request type used for `DeepfakeDetectionCallbackUrl`.
-     */
-    DeepfakeDetectionCallbackMethod?: 'GET' | 'POST';
-
-    /**
-     * URL destination for Telnyx to send deepfake detection callback events to for the
-     * call.
-     */
-    DeepfakeDetectionCallbackUrl?: string;
-
-    /**
-     * Allows you to choose between Regular, Premium, and PremiumCallScreening
-     * detections. See
-     * https://developers.telnyx.com/docs/voice/programmable-voice/answering-machine-detection
-     */
-    DetectionMode?: 'Premium' | 'Regular' | 'PremiumCallScreening';
-
-    /**
-     * A failover URL for which Telnyx will retrieve the TeXML call instructions if the
-     * `Url` is not responding.
-     */
-    FallbackUrl?: string;
-
-    /**
-     * The phone number of the party that initiated the call. Phone numbers are
-     * formatted with a `+` and country code.
-     */
-    From?: string;
-
-    /**
-     * Enables Answering Machine Detection.
-     */
-    MachineDetection?: 'Enable' | 'Disable' | 'DetectMessageEnd';
-
-    /**
-     * Silence duration threshold after a call screening prompt before ending prompt
-     * detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.
-     */
-    MachineDetectionPromptEndTimeout?: number;
-
-    /**
-     * If initial silence duration is greater than this value, consider it a machine.
-     * Ignored when `premium` detection is used.
-     */
-    MachineDetectionSilenceTimeout?: number;
-
-    /**
-     * Silence duration threshold after a greeting message or voice for it be
-     * considered human. Ignored when `premium` detection is used.
-     */
-    MachineDetectionSpeechEndThreshold?: number;
-
-    /**
-     * Maximum threshold of a human greeting. If greeting longer than this value,
-     * considered machine. Ignored when `premium` detection is used.
-     */
-    MachineDetectionSpeechThreshold?: number;
-
-    /**
-     * Maximum timeout threshold in milliseconds for overall detection.
-     */
-    MachineDetectionTimeout?: number;
-
-    /**
-     * Defines whether media should be encrypted on the call. When set to `SRTP`, the
-     * call will use Secure Real-time Transport Protocol for media encryption. When set
-     * to `DTLS`, the call will use DTLS for media encryption. Only supported for SIP
-     * destinations.
-     */
-    MediaEncryption?: 'disabled' | 'SRTP' | 'DTLS';
-
-    /**
-     * The list of comma-separated codecs to be offered on a call.
-     */
-    PreferredCodecs?: string;
-
-    /**
-     * Whether to record the entire participant's call leg. Defaults to `false`.
-     */
-    Record?: boolean;
-
-    /**
-     * The number of channels in the final recording. Defaults to `mono`.
-     */
-    RecordingChannels?: 'mono' | 'dual';
-
-    /**
-     * The URL the recording callbacks will be sent to.
-     */
-    RecordingStatusCallback?: string;
-
-    /**
-     * The changes to the recording's state that should generate a call to
-     * `RecoridngStatusCallback`. Can be: `in-progress`, `completed` and `absent`.
-     * Separate multiple values with a space. Defaults to `completed`.
-     */
-    RecordingStatusCallbackEvent?: string;
-
-    /**
-     * HTTP request type used for `RecordingStatusCallback`. Defaults to `POST`.
-     */
-    RecordingStatusCallbackMethod?: 'GET' | 'POST';
-
-    /**
-     * The number of seconds that Telnyx will wait for the recording to be stopped if
-     * silence is detected. The timer only starts when the speech is detected. Please
-     * note that the transcription is used to detect silence and the related charge
-     * will be applied. The minimum value is 0. The default value is 0 (infinite)
-     */
-    RecordingTimeout?: number;
-
-    /**
-     * The audio track to record for the call. The default is `both`.
-     */
-    RecordingTrack?: 'inbound' | 'outbound' | 'both';
-
-    /**
-     * Whether to send RecordingUrl in webhooks.
-     */
-    SendRecordingUrl?: boolean;
-
-    /**
-     * The password to use for SIP authentication.
-     */
-    SipAuthPassword?: string;
-
-    /**
-     * The username to use for SIP authentication.
-     */
-    SipAuthUsername?: string;
-
-    /**
-     * Defines the SIP region to be used for the call.
-     */
-    SipRegion?: 'US' | 'Europe' | 'Canada' | 'Australia' | 'Middle East';
-
-    /**
-     * URL destination for Telnyx to send status callback events to for the call.
-     */
-    StatusCallback?: string;
-
-    /**
-     * The call events for which Telnyx should send a webhook. Multiple events can be
-     * defined when separated by a space.
-     */
-    StatusCallbackEvent?: 'initiated' | 'ringing' | 'answered' | 'completed';
-
-    /**
-     * HTTP request type used for `StatusCallback`.
-     */
-    StatusCallbackMethod?: 'GET' | 'POST';
-
-    /**
-     * The call control ID of the existing call to supervise. When provided, the
-     * created leg will be added to the specified call in supervising mode. Status
-     * callbacks and action callbacks will NOT be sent for the supervising leg.
-     */
-    SuperviseCallSid?: string;
-
-    /**
-     * The supervising role for the new leg. Determines the audio behavior: barge (hear
-     * both sides), whisper (only hear supervisor), monitor (hear both sides but
-     * supervisor muted). Default: barge
-     */
-    SupervisingRole?: 'barge' | 'whisper' | 'monitor';
-
-    Texml?: string | null;
-
-    /**
-     * The maximum duration of the call in seconds. The minimum value is 30 and the
-     * maximum value is 14400 (4 hours). Default is 14400 seconds.
-     */
-    TimeLimit?: number;
-
-    /**
-     * The number of seconds to wait for the called party to answer the call before the
-     * call is canceled. The minimum value is 5 and the maximum value is 120. Default
-     * is 30 seconds.
-     */
-    Timeout?: number;
-
-    /**
-     * The phone number of the called party. Phone numbers are formatted with a `+` and
-     * country code.
-     */
-    To?: string;
-
-    /**
-     * Whether to trim any leading and trailing silence from the recording. Defaults to
-     * `trim-silence`.
-     */
-    Trim?: 'trim-silence' | 'do-not-trim';
-
-    /**
-     * HTTP request type used for `Url`. The default value is inherited from TeXML
-     * Application setting.
-     */
-    UrlMethod?: 'GET' | 'POST';
-  }
-
-  export namespace WithURL {
-    export interface CustomHeader {
-      /**
-       * The name of the custom header
-       */
-      name: string;
-
-      /**
-       * The value of the custom header
-       */
-      value: string;
-    }
-  }
-
-  export interface WithTeXml {
-    /**
-     * TeXML to be used as instructions for the call. If provided, the call will
-     * execute these instructions instead of fetching from the Url.
-     */
-    Texml: string;
-
-    /**
-     * The ID of the TeXML Application.
-     */
-    ApplicationSid?: string;
-
-    /**
-     * Select whether to perform answering machine detection in the background. By
-     * default execution is blocked until Answering Machine Detection is completed.
-     */
-    AsyncAmd?: boolean;
-
-    /**
-     * URL destination for Telnyx to send AMD callback events to for the call.
-     */
-    AsyncAmdStatusCallback?: string;
-
-    /**
-     * HTTP request type used for `AsyncAmdStatusCallback`. The default value is
-     * inherited from TeXML Application setting.
-     */
-    AsyncAmdStatusCallbackMethod?: 'GET' | 'POST';
-
-    /**
-     * To be used as the caller id name (SIP From Display Name) presented to the
-     * destination (`To` number). The string should have a maximum of 128 characters,
-     * containing only letters, numbers, spaces, and `-_~!.+` special characters. If
-     * ommited, the display name will be the same as the number in the `From` field.
-     */
-    CallerId?: string;
-
-    /**
-     * Whether to cancel ongoing playback on `greeting ended` detection. Defaults to
-     * `true`.
-     */
-    CancelPlaybackOnDetectMessageEnd?: boolean;
-
-    /**
-     * Whether to cancel ongoing playback on `machine` detection. Defaults to `true`.
-     */
-    CancelPlaybackOnMachineDetection?: boolean;
-
-    /**
-     * Custom HTTP headers to be sent with the call. Each header should be an object
-     * with 'name' and 'value' properties.
-     */
-    CustomHeaders?: Array<WithTeXml.CustomHeader>;
-
-    /**
-     * Enables Deepfake Detection on the dialed call. When enabled, audio from the
-     * remote party is analyzed to determine whether the voice is AI-generated. Results
-     * are delivered asynchronously via a callback.
-     */
-    DeepfakeDetection?: 'Enable';
-
-    /**
-     * HTTP request type used for `DeepfakeDetectionCallbackUrl`.
-     */
-    DeepfakeDetectionCallbackMethod?: 'GET' | 'POST';
-
-    /**
-     * URL destination for Telnyx to send deepfake detection callback events to for the
-     * call.
-     */
-    DeepfakeDetectionCallbackUrl?: string;
-
-    /**
-     * Allows you to choose between Regular, Premium, and PremiumCallScreening
-     * detections. See
-     * https://developers.telnyx.com/docs/voice/programmable-voice/answering-machine-detection
-     */
-    DetectionMode?: 'Premium' | 'Regular' | 'PremiumCallScreening';
+  /**
+   * Initiate a TeXML call. Provide either `Url` (fetches TeXML from URL) or `Texml`
+   * (inline TeXML), or neither (uses the application default). `Url` and `Texml` are
+   * mutually exclusive.
+   */
+  params: CallCallsParams.Params;
+}
 
+export namespace CallCallsParams {
+  /**
+   * Initiate a TeXML call. Provide either `Url` (fetches TeXML from URL) or `Texml`
+   * (inline TeXML), or neither (uses the application default). `Url` and `Texml` are
+   * mutually exclusive.
+   */
+  export interface Params {
     /**
-     * A failover URL for which Telnyx will retrieve the TeXML call instructions if the
-     * `Url` is not responding.
+     * The ID of the TeXML Application.
      */
-    FallbackUrl?: string;
+    ApplicationSid: string;
 
     /**
      * The phone number of the party that initiated the call. Phone numbers are
      * formatted with a `+` and country code.
      */
-    From?: string;
-
-    /**
-     * Enables Answering Machine Detection.
-     */
-    MachineDetection?: 'Enable' | 'Disable' | 'DetectMessageEnd';
-
-    /**
-     * Silence duration threshold after a call screening prompt before ending prompt
-     * detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.
-     */
-    MachineDetectionPromptEndTimeout?: number;
-
-    /**
-     * If initial silence duration is greater than this value, consider it a machine.
-     * Ignored when `premium` detection is used.
-     */
-    MachineDetectionSilenceTimeout?: number;
-
-    /**
-     * Silence duration threshold after a greeting message or voice for it be
-     * considered human. Ignored when `premium` detection is used.
-     */
-    MachineDetectionSpeechEndThreshold?: number;
-
-    /**
-     * Maximum threshold of a human greeting. If greeting longer than this value,
-     * considered machine. Ignored when `premium` detection is used.
-     */
-    MachineDetectionSpeechThreshold?: number;
-
-    /**
-     * Maximum timeout threshold in milliseconds for overall detection.
-     */
-    MachineDetectionTimeout?: number;
-
-    /**
-     * Defines whether media should be encrypted on the call. When set to `SRTP`, the
-     * call will use Secure Real-time Transport Protocol for media encryption. When set
-     * to `DTLS`, the call will use DTLS for media encryption. Only supported for SIP
-     * destinations.
-     */
-    MediaEncryption?: 'disabled' | 'SRTP' | 'DTLS';
-
-    /**
-     * The list of comma-separated codecs to be offered on a call.
-     */
-    PreferredCodecs?: string;
-
-    /**
-     * Whether to record the entire participant's call leg. Defaults to `false`.
-     */
-    Record?: boolean;
-
-    /**
-     * The number of channels in the final recording. Defaults to `mono`.
-     */
-    RecordingChannels?: 'mono' | 'dual';
-
-    /**
-     * The URL the recording callbacks will be sent to.
-     */
-    RecordingStatusCallback?: string;
-
-    /**
-     * The changes to the recording's state that should generate a call to
-     * `RecoridngStatusCallback`. Can be: `in-progress`, `completed` and `absent`.
-     * Separate multiple values with a space. Defaults to `completed`.
-     */
-    RecordingStatusCallbackEvent?: string;
-
-    /**
-     * HTTP request type used for `RecordingStatusCallback`. Defaults to `POST`.
-     */
-    RecordingStatusCallbackMethod?: 'GET' | 'POST';
-
-    /**
-     * The number of seconds that Telnyx will wait for the recording to be stopped if
-     * silence is detected. The timer only starts when the speech is detected. Please
-     * note that the transcription is used to detect silence and the related charge
-     * will be applied. The minimum value is 0. The default value is 0 (infinite)
-     */
-    RecordingTimeout?: number;
-
-    /**
-     * The audio track to record for the call. The default is `both`.
-     */
-    RecordingTrack?: 'inbound' | 'outbound' | 'both';
-
-    /**
-     * Whether to send RecordingUrl in webhooks.
-     */
-    SendRecordingUrl?: boolean;
-
-    /**
-     * The password to use for SIP authentication.
-     */
-    SipAuthPassword?: string;
-
-    /**
-     * The username to use for SIP authentication.
-     */
-    SipAuthUsername?: string;
-
-    /**
-     * Defines the SIP region to be used for the call.
-     */
-    SipRegion?: 'US' | 'Europe' | 'Canada' | 'Australia' | 'Middle East';
-
-    /**
-     * URL destination for Telnyx to send status callback events to for the call.
-     */
-    StatusCallback?: string;
-
-    /**
-     * The call events for which Telnyx should send a webhook. Multiple events can be
-     * defined when separated by a space.
-     */
-    StatusCallbackEvent?: 'initiated' | 'ringing' | 'answered' | 'completed';
-
-    /**
-     * HTTP request type used for `StatusCallback`.
-     */
-    StatusCallbackMethod?: 'GET' | 'POST';
-
-    /**
-     * The call control ID of the existing call to supervise. When provided, the
-     * created leg will be added to the specified call in supervising mode. Status
-     * callbacks and action callbacks will NOT be sent for the supervising leg.
-     */
-    SuperviseCallSid?: string;
-
-    /**
-     * The supervising role for the new leg. Determines the audio behavior: barge (hear
-     * both sides), whisper (only hear supervisor), monitor (hear both sides but
-     * supervisor muted). Default: barge
-     */
-    SupervisingRole?: 'barge' | 'whisper' | 'monitor';
-
-    /**
-     * The maximum duration of the call in seconds. The minimum value is 30 and the
-     * maximum value is 14400 (4 hours). Default is 14400 seconds.
-     */
-    TimeLimit?: number;
-
-    /**
-     * The number of seconds to wait for the called party to answer the call before the
-     * call is canceled. The minimum value is 5 and the maximum value is 120. Default
-     * is 30 seconds.
-     */
-    Timeout?: number;
+    From: string;
 
     /**
      * The phone number of the called party. Phone numbers are formatted with a `+` and
      * country code.
      */
-    To?: string;
-
-    /**
-     * Whether to trim any leading and trailing silence from the recording. Defaults to
-     * `trim-silence`.
-     */
-    Trim?: 'trim-silence' | 'do-not-trim';
-
-    Url?: string | null;
-
-    /**
-     * HTTP request type used for `Url`. The default value is inherited from TeXML
-     * Application setting.
-     */
-    UrlMethod?: 'GET' | 'POST';
-  }
-
-  export namespace WithTeXml {
-    export interface CustomHeader {
-      /**
-       * The name of the custom header
-       */
-      name: string;
-
-      /**
-       * The value of the custom header
-       */
-      value: string;
-    }
-  }
-
-  export interface ApplicationDefault {
-    /**
-     * The ID of the TeXML Application.
-     */
-    ApplicationSid?: string;
+    To: string;
 
     /**
      * Select whether to perform answering machine detection in the background. By
@@ -1279,7 +756,7 @@ export namespace CallCallsParams {
      * Custom HTTP headers to be sent with the call. Each header should be an object
      * with 'name' and 'value' properties.
      */
-    CustomHeaders?: Array<ApplicationDefault.CustomHeader>;
+    CustomHeaders?: Array<Params.CustomHeader>;
 
     /**
      * Enables Deepfake Detection on the dialed call. When enabled, audio from the
@@ -1312,12 +789,6 @@ export namespace CallCallsParams {
      */
     FallbackUrl?: string;
 
-    /**
-     * The phone number of the party that initiated the call. Phone numbers are
-     * formatted with a `+` and country code.
-     */
-    From?: string;
-
     /**
      * Enables Answering Machine Detection.
      */
@@ -1455,7 +926,11 @@ export namespace CallCallsParams {
      */
     SupervisingRole?: 'barge' | 'whisper' | 'monitor';
 
-    Texml?: string | null;
+    /**
+     * TeXML to be used as instructions for the call. If provided, the call will
+     * execute these instructions instead of fetching from the Url.
+     */
+    Texml?: string;
 
     /**
      * The maximum duration of the call in seconds. The minimum value is 30 and the
@@ -1470,19 +945,16 @@ export namespace CallCallsParams {
      */
     Timeout?: number;
 
-    /**
-     * The phone number of the called party. Phone numbers are formatted with a `+` and
-     * country code.
-     */
-    To?: string;
-
     /**
      * Whether to trim any leading and trailing silence from the recording. Defaults to
      * `trim-silence`.
      */
     Trim?: 'trim-silence' | 'do-not-trim';
 
-    Url?: string | null;
+    /**
+     * The URL from which Telnyx will retrieve the TeXML call instructions.
+     */
+    Url?: string;
 
     /**
      * HTTP request type used for `Url`. The default value is inherited from TeXML
@@ -1491,7 +963,7 @@ export namespace CallCallsParams {
     UrlMethod?: 'GET' | 'POST';
   }
 
-  export namespace ApplicationDefault {
+  export namespace Params {
     export interface CustomHeader {
       /**
        * The name of the custom header

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

@@ -2,11 +2,12 @@
 
 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';