telnyx 7.28.0 → 7.29.0

package/src/resources/browser-sessions/browser-sessions.ts

@@ -0,0 +1,278 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as ActionsAPI from './actions';
+import {
+  ActionCreateParams,
+  ActionCreateResponse,
+  ActionResponse,
+  ActionRetrieveParams,
+  ActionRetrieveResponse,
+  Actions,
+  ClickAction,
+  FillAction,
+  NavigateAction,
+  ObserveAction,
+  PressAction,
+  ScreenshotAction,
+  ScrollAction,
+  SelectAction,
+  WaitForAction,
+} from './actions';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class BrowserSessions extends APIResource {
+  actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
+
+  /**
+   * Returns the current status of a browser session.
+   *
+   * @example
+   * ```ts
+   * const browserSession =
+   *   await client.browserSessions.retrieve('id');
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<BrowserSessionRetrieveResponse> {
+    return this._client.get(path`/browser_sessions/${id}`, options);
+  }
+
+  /**
+   * Returns artifact metadata and a signed download URL. The download URL requires
+   * Bearer auth.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.browserSessions.retrieveArtifact(
+   *     'artifactId',
+   *     { id: 'id' },
+   *   );
+   * ```
+   */
+  retrieveArtifact(
+    artifactID: string,
+    params: BrowserSessionRetrieveArtifactParams,
+    options?: RequestOptions,
+  ): APIPromise<BrowserSessionRetrieveArtifactResponse> {
+    const { id } = params;
+    return this._client.get(path`/browser_sessions/${id}/artifacts/${artifactID}`, options);
+  }
+
+  /**
+   * Lists sessions for the authenticated org. Optional status filter.
+   *
+   * @example
+   * ```ts
+   * const browserSessions = await client.browserSessions.list();
+   * ```
+   */
+  list(
+    query: BrowserSessionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<BrowserSessionListResponse> {
+    return this._client.get('/browser_sessions', { query, ...options });
+  }
+
+  /**
+   * Creates an isolated browser session with network access restricted to the
+   * domains you allow.
+   *
+   * @example
+   * ```ts
+   * const browserSession = await client.browserSessions.create({
+   *   policy: { allowed_domains: ['example.com'] },
+   * });
+   * ```
+   */
+  create(
+    body: BrowserSessionCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<BrowserSessionCreateResponse> {
+    return this._client.post('/browser_sessions', { body, ...options });
+  }
+
+  /**
+   * Closes a ready session and releases its resources. An already closed, failed, or
+   * expired session is returned unchanged; a provisioning session returns 409
+   * session_not_ready.
+   *
+   * @example
+   * ```ts
+   * const browserSession = await client.browserSessions.delete(
+   *   'id',
+   * );
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<BrowserSessionDeleteResponse> {
+    return this._client.delete(path`/browser_sessions/${id}`, options);
+  }
+}
+
+export interface Session {
+  id: string;
+
+  closed_at: string | null;
+
+  created_at: string;
+
+  expires_at: string | null;
+
+  failure_reason: string | null;
+
+  last_activity_at: string | null;
+
+  limits: Session.Limits;
+
+  metadata: unknown;
+
+  policy: Session.Policy;
+
+  ready_at: string | null;
+
+  status: 'provisioning' | 'ready' | 'closing' | 'closed' | 'failed' | 'expired';
+}
+
+export namespace Session {
+  export interface Limits {
+    idle_timeout_s: number;
+
+    lifetime_s: number;
+  }
+
+  export interface Policy {
+    allowed_domains: Array<string>;
+  }
+}
+
+export interface BrowserSessionCreateResponse {
+  data?: Session;
+}
+
+export interface BrowserSessionRetrieveResponse {
+  data?: Session;
+}
+
+export interface BrowserSessionListResponse {
+  data?: Array<Session>;
+}
+
+export interface BrowserSessionDeleteResponse {
+  data?: Session;
+}
+
+export interface BrowserSessionRetrieveArtifactResponse {
+  data?: BrowserSessionRetrieveArtifactResponse.Data;
+}
+
+export namespace BrowserSessionRetrieveArtifactResponse {
+  export interface Data {
+    id: string;
+
+    action_id: string;
+
+    checksum: string;
+
+    content_type: string;
+
+    created_at: string;
+
+    /**
+     * Signed relative path (starts with /v2/artifact_downloads/). Prepend your API
+     * host, e.g. https://api.telnyx.com, before calling it.
+     */
+    download_url: string;
+
+    expires_at: string;
+
+    session_id: string;
+
+    size_bytes: number;
+
+    type: string;
+  }
+}
+
+export interface BrowserSessionRetrieveArtifactParams {
+  id: string;
+}
+
+export interface BrowserSessionListParams {
+  status?: 'provisioning' | 'ready' | 'closing' | 'closed' | 'failed' | 'expired';
+}
+
+export interface BrowserSessionCreateParams {
+  policy: BrowserSessionCreateParams.Policy;
+
+  /**
+   * Scoped to the organization. The same key and identical normalized policy,
+   * limits, and metadata replay the existing session (HTTP 201); a different request
+   * returns 409 idempotency_conflict. Replays do not restart terminal sessions.
+   */
+  idempotency_key?: string;
+
+  limits?: BrowserSessionCreateParams.Limits;
+
+  /**
+   * Arbitrary key-value metadata.
+   */
+  metadata?: unknown;
+}
+
+export namespace BrowserSessionCreateParams {
+  export interface Policy {
+    /**
+     * Domain patterns the browser can navigate to. Exact match (example.com) or
+     * wildcard (\*.example.com). IP literals not allowed.
+     */
+    allowed_domains: Array<string>;
+  }
+
+  export interface Limits {
+    /**
+     * Idle timeout in seconds. Must not exceed lifetime_s.
+     */
+    idle_timeout_s?: number;
+
+    /**
+     * Max session duration in seconds (60-1800).
+     */
+    lifetime_s?: number;
+  }
+}
+
+BrowserSessions.Actions = Actions;
+
+export declare namespace BrowserSessions {
+  export {
+    type Session as Session,
+    type BrowserSessionCreateResponse as BrowserSessionCreateResponse,
+    type BrowserSessionRetrieveResponse as BrowserSessionRetrieveResponse,
+    type BrowserSessionListResponse as BrowserSessionListResponse,
+    type BrowserSessionDeleteResponse as BrowserSessionDeleteResponse,
+    type BrowserSessionRetrieveArtifactResponse as BrowserSessionRetrieveArtifactResponse,
+    type BrowserSessionRetrieveArtifactParams as BrowserSessionRetrieveArtifactParams,
+    type BrowserSessionListParams as BrowserSessionListParams,
+    type BrowserSessionCreateParams as BrowserSessionCreateParams,
+  };
+
+  export {
+    Actions as Actions,
+    type ActionResponse as ActionResponse,
+    type ClickAction as ClickAction,
+    type FillAction as FillAction,
+    type NavigateAction as NavigateAction,
+    type ObserveAction as ObserveAction,
+    type PressAction as PressAction,
+    type ScreenshotAction as ScreenshotAction,
+    type ScrollAction as ScrollAction,
+    type SelectAction as SelectAction,
+    type WaitForAction as WaitForAction,
+    type ActionCreateResponse as ActionCreateResponse,
+    type ActionRetrieveResponse as ActionRetrieveResponse,
+    type ActionCreateParams as ActionCreateParams,
+    type ActionRetrieveParams as ActionRetrieveParams,
+  };
+}

package/src/resources/browser-sessions/index.ts

@@ -0,0 +1,31 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Actions,
+  type ActionResponse,
+  type ClickAction,
+  type FillAction,
+  type NavigateAction,
+  type ObserveAction,
+  type PressAction,
+  type ScreenshotAction,
+  type ScrollAction,
+  type SelectAction,
+  type WaitForAction,
+  type ActionCreateResponse,
+  type ActionRetrieveResponse,
+  type ActionCreateParams,
+  type ActionRetrieveParams,
+} from './actions';
+export {
+  BrowserSessions,
+  type Session,
+  type BrowserSessionCreateResponse,
+  type BrowserSessionRetrieveResponse,
+  type BrowserSessionListResponse,
+  type BrowserSessionDeleteResponse,
+  type BrowserSessionRetrieveArtifactResponse,
+  type BrowserSessionRetrieveArtifactParams,
+  type BrowserSessionListParams,
+  type BrowserSessionCreateParams,
+} from './browser-sessions';

package/src/resources/browser-sessions.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './browser-sessions/index';

package/src/resources/call-control-applications.ts

@@ -227,8 +227,8 @@ export interface CallControlApplicationInbound {
    * in the same way a phone number is used, from a SIP endpoint. Example: the
    * subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using
    * the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any
-   * alphanumeric value. Please note TLS encrypted calls are not allowed for
-   * subdomain calls.
+   * alphanumeric value. TLS signaling is supported. SRTP media encryption requires
+   * TLS transport.
    */
   sip_subdomain?: string;
 

package/src/resources/calls/actions.ts

@@ -1768,23 +1768,25 @@ export interface TranscriptionConfig {
    * hints `en`, `es`, `fr`, `de`, `hi`, `ru`, `pt`, `ja`, `it`, and `nl`. For
    * `soniox/stt-rt-v4`, `auto` omits the language hint and lets Soniox auto-detect;
    * ISO 639-1 codes (e.g. `en`, `es`) bias detection toward that language. For
-   * `assemblyai/universal-3-5-pro` (and its legacy alias
-   * `assemblyai/universal-streaming`), `auto` (or unset) enables native multilingual
-   * code-switching; ISO 639-1 codes (`en`, `es`, `de`, `fr`, `pt`, `it`, `tr`, `nl`,
-   * `sv`, `no`, `da`, `fi`, `hi`, `vi`, `ar`, `he`, `ja`, `zh`) bias the session to
-   * that language. For `humain/realtime`, supported values are `ar`, `en`,
-   * `codeswitch` (Arabic/English code-switching), and `auto` (resolves server-side
-   * to code-switching). Unlike other models, `humain/realtime` does not fall back to
-   * `auto` when `language` is omitted — omitting it applies `en` instead. For
-   * `reson8/turns`, supported values are `auto` (or unset) for automatic language
-   * detection, and the language codes `nl`, `en`, `fr`, `fy`, `de`, `it`, `pl`,
-   * `pt`, `es`, and `sv` to fix the transcription language. For `cohere/ar-stt`,
-   * supported values are `ar` and `en`; unlike other models, this model does not
-   * auto-detect and defaults to `ar` when `language` is omitted. For
-   * `speechmatics/linden-1`, there is no auto-detect; set a code from Speechmatics'
-   * Realtime language list (see `SpeechmaticsTranscriptionLanguage`); unset defaults
-   * to `en`, while an explicit `auto`, `auto_beta`, or `multi` is rejected (unlike
-   * `speechmatics/standard`, which defaults to `en`).
+   * `assemblyai/universal-3-6-pro` (and its legacy aliases
+   * `assemblyai/universal-3-5-pro` and `assemblyai/universal-streaming`), `auto` (or
+   * unset) enables native multilingual code-switching; language codes (`en`, `es`,
+   * `de`, `fr`, `pt`, `it`, `tr`, `nl`, `sv`, `no`, `da`, `fi`, `hi`, `vi`, `ar`,
+   * `he`, `ja`, `zh`, `ur`, `ru`, `ko`, `ca`, `gl`, `ro`, `et`, `fa`, `yue`, `af`,
+   * `mr`, `zu`, `xh`, `nn`) bias the session to that language. For
+   * `humain/realtime`, supported values are `ar`, `en`, `codeswitch` (Arabic/English
+   * code-switching), and `auto` (resolves server-side to code-switching). Unlike
+   * other models, `humain/realtime` does not fall back to `auto` when `language` is
+   * omitted — omitting it applies `en` instead. For `reson8/turns`, supported values
+   * are `auto` (or unset) for automatic language detection, and the language codes
+   * `nl`, `en`, `fr`, `fy`, `de`, `it`, `pl`, `pt`, `es`, and `sv` to fix the
+   * transcription language. For `cohere/ar-stt`, supported values are `ar` and `en`;
+   * unlike other models, this model does not auto-detect and defaults to `ar` when
+   * `language` is omitted. For `speechmatics/linden-1`, there is no auto-detect; set
+   * a code from Speechmatics' Realtime language list (see
+   * `SpeechmaticsTranscriptionLanguage`); unset defaults to `en`, while an explicit
+   * `auto`, `auto_beta`, or `multi` is rejected (unlike `speechmatics/standard`,
+   * which defaults to `en`).
    */
   language?: string;
 
@@ -1799,9 +1801,10 @@ export interface TranscriptionConfig {
    * - `speechmatics/linden-1` (preview, vendor-hosted) for live streaming
    *   transcription; no auto-detect, so set `language` from Speechmatics' Realtime
    *   language list (defaults to `en`).
-   * - `assemblyai/universal-3-5-pro` for live streaming transcription. The legacy
-   *   alias `assemblyai/universal-streaming` is still accepted and resolves to the
-   *   same model.
+   * - `assemblyai/universal-3-6-pro` (AssemblyAI Universal-3.6 Pro) for live
+   *   streaming transcription. The legacy aliases `assemblyai/universal-3-5-pro` and
+   *   `assemblyai/universal-streaming` are still accepted and run the same
+   *   Universal-3.6 Pro model.
    * - `xai/grok-stt` for live streaming transcription.
    * - `soniox/stt-rt-v4` for live streaming multilingual transcription with
    *   automatic language detection.
@@ -1830,6 +1833,7 @@ export interface TranscriptionConfig {
     | 'speechmatics/standard'
     | 'speechmatics/enhanced'
     | 'speechmatics/linden-1'
+    | 'assemblyai/universal-3-6-pro'
     | 'assemblyai/universal-3-5-pro'
     | 'assemblyai/universal-streaming'
     | 'xai/grok-stt'
@@ -1936,10 +1940,15 @@ export interface TranscriptionEngineAssemblyaiConfig {
   transcription_engine?: 'AssemblyAI';
 
   /**
-   * The model to use for transcription. `assemblyai/universal-streaming` is a legacy
-   * alias of `assemblyai/universal-3-5-pro` and resolves to the same model.
+   * The model to use for transcription. `assemblyai/universal-3-6-pro` is the
+   * AssemblyAI Universal-3.6 Pro model. `assemblyai/universal-3-5-pro` (the default)
+   * and `assemblyai/universal-streaming` are legacy aliases that run the same
+   * Universal-3.6 Pro model.
    */
-  transcription_model?: 'assemblyai/universal-3-5-pro' | 'assemblyai/universal-streaming';
+  transcription_model?:
+    | 'assemblyai/universal-3-6-pro'
+    | 'assemblyai/universal-3-5-pro'
+    | 'assemblyai/universal-streaming';
 }
 
 export interface TranscriptionEngineAzureConfig {
@@ -3787,8 +3796,9 @@ export interface ActionGatherUsingSpeakParams {
    *   `Minimax.speech-02-hd.Wise_Woman`). Supported models: `speech-02-turbo`,
    *   `speech-02-hd`, `speech-2.6-turbo`, `speech-2.8-turbo`. Use `voice_settings`
    *   to configure speed, volume, pitch, and language_boost.
-   * - **Resemble:** Use `Resemble.Turbo.<voice_id>` (e.g.,
-   *   `Resemble.Turbo.my_voice`). Only `Turbo` model is supported. Use
+   * - **Resemble:** Use `Resemble.<ModelId>.<VoiceId>` (e.g.,
+   *   `Resemble.Turbo.Aaron_en-US`). Supported models: `Pro`, `Turbo`, `Urdu`.
+   *   `<VoiceId>` is a stock voice name or the ID of a Resemble voice clone. Use
    *   `voice_settings` to configure precision, sample_rate, and format.
    * - **Inworld:** Use `Inworld.<ModelId>.<VoiceId>` (e.g., `Inworld.Mini.Loretta`,
    *   `Inworld.Max.Oliver`, `Inworld.TTS2.Loretta`). Supported models: `Mini`,
@@ -4699,8 +4709,9 @@ export interface ActionSpeakParams {
    *   `Minimax.speech-02-hd.Wise_Woman`). Supported models: `speech-02-turbo`,
    *   `speech-02-hd`, `speech-2.6-turbo`, `speech-2.8-turbo`. Use `voice_settings`
    *   to configure speed, volume, pitch, and language_boost.
-   * - **Resemble:** Use `Resemble.Turbo.<voice_id>` (e.g.,
-   *   `Resemble.Turbo.my_voice`). Only `Turbo` model is supported. Use
+   * - **Resemble:** Use `Resemble.<ModelId>.<VoiceId>` (e.g.,
+   *   `Resemble.Turbo.Aaron_en-US`). Supported models: `Pro`, `Turbo`, `Urdu`.
+   *   `<VoiceId>` is a stock voice name or the ID of a Resemble voice clone. Use
    *   `voice_settings` to configure precision, sample_rate, and format.
    * - **Inworld:** Use `Inworld.<ModelId>.<VoiceId>` (e.g., `Inworld.Mini.Loretta`,
    *   `Inworld.Max.Oliver`, `Inworld.TTS2.Loretta`). Supported models: `Mini`,

package/src/resources/conferences/actions.ts

@@ -787,8 +787,9 @@ export interface ActionSpeakParams {
    *   `Minimax.speech-02-hd.Wise_Woman`). Supported models: `speech-02-turbo`,
    *   `speech-02-hd`, `speech-2.6-turbo`, `speech-2.8-turbo`. Use `voice_settings`
    *   to configure speed, volume, pitch, and language_boost.
-   * - **Resemble:** Use `Resemble.Turbo.<voice_id>` (e.g.,
-   *   `Resemble.Turbo.my_voice`). Only `Turbo` model is supported. Use
+   * - **Resemble:** Use `Resemble.<ModelId>.<VoiceId>` (e.g.,
+   *   `Resemble.Turbo.Aaron_en-US`). Supported models: `Pro`, `Turbo`, `Urdu`.
+   *   `<VoiceId>` is a stock voice name or the ID of a Resemble voice clone. Use
    *   `voice_settings` to configure precision, sample_rate, and format.
    * - **Inworld:** Use `Inworld.<ModelId>.<VoiceId>` (e.g., `Inworld.Mini.Loretta`,
    *   `Inworld.Max.Oliver`, `Inworld.TTS2.Loretta`). Supported models: `Mini`,

package/src/resources/email/dedicated-ips/actions.ts

@@ -0,0 +1,87 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as DedicatedIPsAPI from './dedicated-ips';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * Purchase and manage dedicated sending IP addresses for your Telnyx email traffic.
+ */
+export class Actions extends APIResource {
+  /**
+   * Manually complete the warm-up ramp (`warming_up` to `active`), bypassing the
+   * schedule. Use only for an IP already warmed elsewhere. Completion sets
+   * `warmup.progress` to `100`, clears `warmup.daily_cap`, and applies the
+   * ramp-complete allowance to the current UTC day: `warmup.today.cap` becomes
+   * `100000000`, `warmup.today.granted` keeps the sends already released today, and
+   * `warmup.today.remaining` becomes `cap` minus `granted`. Once completion applies
+   * this allowance, an exhausted stage allowance does not block the next eligible
+   * first-attempt send. The response reports these values. On an `active` IP,
+   * `warmup.progress` and `warmup.daily_cap` are informational: they can keep
+   * earlier values after a suspension is lifted and do not limit sending.
+   *
+   * @example
+   * ```ts
+   * const dedicatedIPShowResponse =
+   *   await client.email.dedicatedIPs.actions.completeWarmup(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   );
+   * ```
+   */
+  completeWarmup(id: string, options?: RequestOptions): APIPromise<DedicatedIPsAPI.DedicatedIPShowResponse> {
+    return this._client.post(path`/email/dedicated_ips/${id}/actions/complete_warmup`, options);
+  }
+
+  /**
+   * Pause the warm-up ramp at its current stage. While paused, the IP releases no
+   * first-attempt sends from hold and the ramp does not advance. Only a `warming_up`
+   * IP can be paused; pausing an already paused IP refreshes `paused_at`.
+   *
+   * @example
+   * ```ts
+   * const dedicatedIPShowResponse =
+   *   await client.email.dedicatedIPs.actions.pauseWarmup(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   );
+   * ```
+   */
+  pauseWarmup(id: string, options?: RequestOptions): APIPromise<DedicatedIPsAPI.DedicatedIPShowResponse> {
+    return this._client.post(path`/email/dedicated_ips/${id}/actions/pause_warmup`, options);
+  }
+
+  /**
+   * Resume a paused warm-up ramp from its held stage. Only a `warming_up` IP can be
+   * resumed; resuming a ramp that is not paused returns the IP unchanged.
+   *
+   * @example
+   * ```ts
+   * const dedicatedIPShowResponse =
+   *   await client.email.dedicatedIPs.actions.resumeWarmup(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   );
+   * ```
+   */
+  resumeWarmup(id: string, options?: RequestOptions): APIPromise<DedicatedIPsAPI.DedicatedIPShowResponse> {
+    return this._client.post(path`/email/dedicated_ips/${id}/actions/resume_warmup`, options);
+  }
+
+  /**
+   * Start the warm-up ramp (`provisioning` to `warming_up`). The ramp never starts
+   * automatically. Only a `provisioning` IP can be started; a `suspended` IP returns
+   * `409`. Starting does not check DNS: the IP carries mail only while
+   * `dns_confirmed_at` is set and the IP is in a pool that routes mail.
+   *
+   * @example
+   * ```ts
+   * const dedicatedIPShowResponse =
+   *   await client.email.dedicatedIPs.actions.startWarmup(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   );
+   * ```
+   */
+  startWarmup(id: string, options?: RequestOptions): APIPromise<DedicatedIPsAPI.DedicatedIPShowResponse> {
+    return this._client.post(path`/email/dedicated_ips/${id}/actions/start_warmup`, options);
+  }
+}