telnyx 7.22.0 → 7.24.0

package/src/resources/private-wireless-gateways.ts

@@ -16,7 +16,7 @@ export class PrivateWirelessGateways extends APIResource {
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
-   * for await (const privateWirelessGateway of client.privateWirelessGateways.list()) {
+   * for await (const wirelessPrivateWirelessGateway of client.privateWirelessGateways.list()) {
    *   // ...
    * }
    * ```
@@ -24,10 +24,10 @@ export class PrivateWirelessGateways extends APIResource {
   list(
     query: PrivateWirelessGatewayListParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<PrivateWirelessGatewaysDefaultFlatPagination, PrivateWirelessGateway> {
+  ): PagePromise<WirelessPrivateWirelessGatewaysDefaultFlatPagination, WirelessPrivateWirelessGateway> {
     return this._client.getAPIList(
       '/private_wireless_gateways',
-      DefaultFlatPagination<PrivateWirelessGateway>,
+      DefaultFlatPagination<WirelessPrivateWirelessGateway>,
       { query, ...options },
     );
   }
@@ -84,7 +84,8 @@ export class PrivateWirelessGateways extends APIResource {
   }
 }
 
-export type PrivateWirelessGatewaysDefaultFlatPagination = DefaultFlatPagination<PrivateWirelessGateway>;
+export type WirelessPrivateWirelessGatewaysDefaultFlatPagination =
+  DefaultFlatPagination<WirelessPrivateWirelessGateway>;
 
 export interface PrivateWirelessGateway {
   /**
@@ -180,16 +181,73 @@ export interface PwgAssignedResourcesSummary {
   record_type?: string;
 }
 
+export interface WirelessPrivateWirelessGateway {
+  /**
+   * Identifies the resource.
+   */
+  id?: string;
+
+  /**
+   * The address mode of the private wireless gateway. With static, each SIM card
+   * gets a fixed IP address from the gateway's IP range that is preserved across
+   * sessions. With dynamic, IP addresses are assigned by the network at attach time
+   * and may change between sessions.
+   */
+  address_mode?: 'static' | 'dynamic';
+
+  /**
+   * A list of the resources that have been assigned to the Private Wireless Gateway.
+   */
+  assigned_resources?: Array<PwgAssignedResourcesSummary>;
+
+  /**
+   * ISO 8601 formatted date-time indicating when the resource was created.
+   */
+  created_at?: string;
+
+  /**
+   * IP block used to assign IPs to the SIM cards in the Private Wireless Gateway.
+   */
+  ip_range?: string;
+
+  /**
+   * The private wireless gateway name.
+   */
+  name?: string;
+
+  /**
+   * The identification of the related network resource.
+   */
+  network_id?: string;
+
+  record_type?: string;
+
+  /**
+   * The name of the region where the Private Wireless Gateway is deployed.
+   */
+  region_code?: string;
+
+  /**
+   * The current status or failure details of the Private Wireless Gateway.
+   */
+  status?: PrivateWirelessGatewayStatus;
+
+  /**
+   * ISO 8601 formatted date-time indicating when the resource was updated.
+   */
+  updated_at?: string;
+}
+
 export interface PrivateWirelessGatewayCreateResponse {
-  data?: PrivateWirelessGateway;
+  data?: WirelessPrivateWirelessGateway;
 }
 
 export interface PrivateWirelessGatewayRetrieveResponse {
-  data?: PrivateWirelessGateway;
+  data?: WirelessPrivateWirelessGateway;
 }
 
 export interface PrivateWirelessGatewayDeleteResponse {
-  data?: PrivateWirelessGateway;
+  data?: WirelessPrivateWirelessGateway;
 }
 
 export interface PrivateWirelessGatewayListParams extends DefaultFlatPaginationParams {
@@ -230,6 +288,15 @@ export interface PrivateWirelessGatewayCreateParams {
    */
   network_id: string;
 
+  /**
+   * Determines how IP addresses are assigned to SIM cards using this gateway. With
+   * static, each SIM card gets a fixed IP address from the gateway's IP range that
+   * is preserved across sessions. With dynamic, an IP address is assigned by the
+   * network at attach time and may change between sessions. If omitted, the gateway
+   * is created with the default address mode, dynamic.
+   */
+  address_mode?: 'static' | 'dynamic';
+
   /**
    * The code of the region where the private wireless gateway will be assigned. A
    * list of available regions can be found at the regions endpoint
@@ -242,10 +309,11 @@ export declare namespace PrivateWirelessGateways {
     type PrivateWirelessGateway as PrivateWirelessGateway,
     type PrivateWirelessGatewayStatus as PrivateWirelessGatewayStatus,
     type PwgAssignedResourcesSummary as PwgAssignedResourcesSummary,
+    type WirelessPrivateWirelessGateway as WirelessPrivateWirelessGateway,
     type PrivateWirelessGatewayCreateResponse as PrivateWirelessGatewayCreateResponse,
     type PrivateWirelessGatewayRetrieveResponse as PrivateWirelessGatewayRetrieveResponse,
     type PrivateWirelessGatewayDeleteResponse as PrivateWirelessGatewayDeleteResponse,
-    type PrivateWirelessGatewaysDefaultFlatPagination as PrivateWirelessGatewaysDefaultFlatPagination,
+    type WirelessPrivateWirelessGatewaysDefaultFlatPagination as WirelessPrivateWirelessGatewaysDefaultFlatPagination,
     type PrivateWirelessGatewayListParams as PrivateWirelessGatewayListParams,
     type PrivateWirelessGatewayCreateParams as PrivateWirelessGatewayCreateParams,
   };

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

@@ -314,6 +314,7 @@ export interface SpeechToTextRetrieveTranscriptionParams {
     | 'speechmatics/standard'
     | 'soniox/stt-rt-v4'
     | 'nvidia/parakeet-v3'
+    | 'omi-health/omi-med-stt-v1'
     | 'humain/realtime'
     | 'reson8/turns'
     | 'cohere/ar-stt';

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

@@ -45,10 +45,20 @@ export class Calls extends APIResource {
    */
   retrieveCalls(
     accountSid: string,
-    query: CallRetrieveCallsParams | null | undefined = {},
+    params: CallRetrieveCallsParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<CallRetrieveCallsResponse> {
-    return this._client.get(path`/texml/Accounts/${accountSid}/Calls`, { query, ...options });
+    const { EndTime_lt, EndTime_gt, StartTime_lt, StartTime_gt, ...query } = params ?? {};
+    return this._client.get(path`/texml/Accounts/${accountSid}/Calls`, {
+      query: {
+        'EndTime<': EndTime_lt,
+        'EndTime>': EndTime_gt,
+        'StartTime<': StartTime_lt,
+        'StartTime>': StartTime_gt,
+        ...query,
+      },
+      ...options,
+    });
   }
 
   /**
@@ -434,14 +444,14 @@ export interface CallRetrieveCallsParams {
   EndTime?: string;
 
   /**
-   * Filters calls by their end date (after). Expected format is YYYY-MM-DD
+   * Filters calls by their end date (before). Expected format is YYYY-MM-DD
    */
-  EndTime_gt?: string;
+  EndTime_lt?: string;
 
   /**
-   * Filters calls by their end date (before). Expected format is YYYY-MM-DD
+   * Filters calls by their end date (after). Expected format is YYYY-MM-DD
    */
-  EndTime_lt?: string;
+  EndTime_gt?: string;
 
   /**
    * Filters calls by the from number.
@@ -470,14 +480,14 @@ export interface CallRetrieveCallsParams {
   StartTime?: string;
 
   /**
-   * Filters calls by their start date (after). Expected format is YYYY-MM-DD
+   * Filters calls by their start date (before). Expected format is YYYY-MM-DD
    */
-  StartTime_gt?: string;
+  StartTime_lt?: string;
 
   /**
-   * Filters calls by their start date (before). Expected format is YYYY-MM-DD
+   * Filters calls by their start date (after). Expected format is YYYY-MM-DD
    */
-  StartTime_lt?: string;
+  StartTime_gt?: string;
 
   /**
    * Filters calls by status.
@@ -590,6 +600,27 @@ export namespace CallCallsParams {
      */
     MachineDetection?: 'Enable' | 'Disable' | 'DetectMessageEnd';
 
+    /**
+     * Highest frequency, in Hz, that a tone can reach and still be treated as a beep.
+     * Only used when MachineDetection is enabled.
+     */
+    MachineDetectionBeepMaxFrequency?: number;
+
+    /**
+     * Lowest frequency, in Hz, that a tone must reach to be treated as a beep. Raising
+     * it above 480 excludes North American ringback (440 + 480 Hz), which can
+     * otherwise be reported as a beep when the `freq_only` profile is in use. Only
+     * used when MachineDetection is enabled.
+     */
+    MachineDetectionBeepMinFrequency?: number;
+
+    /**
+     * Shortest tone, in milliseconds, that can be treated as a beep. Raising it
+     * rejects brief tones such as call-progress blips. Only used when MachineDetection
+     * is enabled.
+     */
+    MachineDetectionBeepMinToneDuration?: number;
+
     /**
      * Selects which detectors must validate a beep. `both` requires the amplitude and
      * frequency detectors to agree. `freq_only` uses the frequency detector alone, for
@@ -598,6 +629,31 @@ export namespace CallCallsParams {
      */
     MachineDetectionBeepProfile?: 'both' | 'freq_only';
 
+    /**
+     * When enabled, a candidate beep must pass an additional spectral check before it
+     * is reported. Only used when MachineDetection is enabled.
+     */
+    MachineDetectionBeepSpectralConfirmation?: boolean;
+
+    /**
+     * Minimum spectral purity, from 0 to 1, for a tone to be treated as a beep.
+     * Raising it rejects mixed tones such as ringback, which combines two frequencies.
+     * Only used when MachineDetection is enabled.
+     */
+    MachineDetectionBeepSpectralMinPurity?: number;
+
+    /**
+     * When enabled, the fax CNG tone is rejected rather than reported as a beep. Only
+     * used when MachineDetection is enabled.
+     */
+    MachineDetectionBeepSpectralRejectFaxCng?: boolean;
+
+    /**
+     * Length of the spectral confirmation window, in milliseconds. Only used when
+     * MachineDetection is enabled.
+     */
+    MachineDetectionBeepSpectralWindow?: number;
+
     /**
      * Silence duration threshold after a call screening prompt before ending prompt
      * detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.
@@ -874,6 +930,27 @@ export namespace CallCallsParams {
      */
     MachineDetection?: 'Enable' | 'Disable' | 'DetectMessageEnd';
 
+    /**
+     * Highest frequency, in Hz, that a tone can reach and still be treated as a beep.
+     * Only used when MachineDetection is enabled.
+     */
+    MachineDetectionBeepMaxFrequency?: number;
+
+    /**
+     * Lowest frequency, in Hz, that a tone must reach to be treated as a beep. Raising
+     * it above 480 excludes North American ringback (440 + 480 Hz), which can
+     * otherwise be reported as a beep when the `freq_only` profile is in use. Only
+     * used when MachineDetection is enabled.
+     */
+    MachineDetectionBeepMinFrequency?: number;
+
+    /**
+     * Shortest tone, in milliseconds, that can be treated as a beep. Raising it
+     * rejects brief tones such as call-progress blips. Only used when MachineDetection
+     * is enabled.
+     */
+    MachineDetectionBeepMinToneDuration?: number;
+
     /**
      * Selects which detectors must validate a beep. `both` requires the amplitude and
      * frequency detectors to agree. `freq_only` uses the frequency detector alone, for
@@ -882,6 +959,31 @@ export namespace CallCallsParams {
      */
     MachineDetectionBeepProfile?: 'both' | 'freq_only';
 
+    /**
+     * When enabled, a candidate beep must pass an additional spectral check before it
+     * is reported. Only used when MachineDetection is enabled.
+     */
+    MachineDetectionBeepSpectralConfirmation?: boolean;
+
+    /**
+     * Minimum spectral purity, from 0 to 1, for a tone to be treated as a beep.
+     * Raising it rejects mixed tones such as ringback, which combines two frequencies.
+     * Only used when MachineDetection is enabled.
+     */
+    MachineDetectionBeepSpectralMinPurity?: number;
+
+    /**
+     * When enabled, the fax CNG tone is rejected rather than reported as a beep. Only
+     * used when MachineDetection is enabled.
+     */
+    MachineDetectionBeepSpectralRejectFaxCng?: boolean;
+
+    /**
+     * Length of the spectral confirmation window, in milliseconds. Only used when
+     * MachineDetection is enabled.
+     */
+    MachineDetectionBeepSpectralWindow?: number;
+
     /**
      * Silence duration threshold after a call screening prompt before ending prompt
      * detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.
@@ -1152,6 +1254,27 @@ export namespace CallCallsParams {
      */
     MachineDetection?: 'Enable' | 'Disable' | 'DetectMessageEnd';
 
+    /**
+     * Highest frequency, in Hz, that a tone can reach and still be treated as a beep.
+     * Only used when MachineDetection is enabled.
+     */
+    MachineDetectionBeepMaxFrequency?: number;
+
+    /**
+     * Lowest frequency, in Hz, that a tone must reach to be treated as a beep. Raising
+     * it above 480 excludes North American ringback (440 + 480 Hz), which can
+     * otherwise be reported as a beep when the `freq_only` profile is in use. Only
+     * used when MachineDetection is enabled.
+     */
+    MachineDetectionBeepMinFrequency?: number;
+
+    /**
+     * Shortest tone, in milliseconds, that can be treated as a beep. Raising it
+     * rejects brief tones such as call-progress blips. Only used when MachineDetection
+     * is enabled.
+     */
+    MachineDetectionBeepMinToneDuration?: number;
+
     /**
      * Selects which detectors must validate a beep. `both` requires the amplitude and
      * frequency detectors to agree. `freq_only` uses the frequency detector alone, for
@@ -1160,6 +1283,31 @@ export namespace CallCallsParams {
      */
     MachineDetectionBeepProfile?: 'both' | 'freq_only';
 
+    /**
+     * When enabled, a candidate beep must pass an additional spectral check before it
+     * is reported. Only used when MachineDetection is enabled.
+     */
+    MachineDetectionBeepSpectralConfirmation?: boolean;
+
+    /**
+     * Minimum spectral purity, from 0 to 1, for a tone to be treated as a beep.
+     * Raising it rejects mixed tones such as ringback, which combines two frequencies.
+     * Only used when MachineDetection is enabled.
+     */
+    MachineDetectionBeepSpectralMinPurity?: number;
+
+    /**
+     * When enabled, the fax CNG tone is rejected rather than reported as a beep. Only
+     * used when MachineDetection is enabled.
+     */
+    MachineDetectionBeepSpectralRejectFaxCng?: boolean;
+
+    /**
+     * Length of the spectral confirmation window, in milliseconds. Only used when
+     * MachineDetection is enabled.
+     */
+    MachineDetectionBeepSpectralWindow?: number;
+
     /**
      * Silence duration threshold after a call screening prompt before ending prompt
      * detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.

package/src/resources/texml/accounts/conferences/participants.ts

@@ -484,6 +484,27 @@ export interface ParticipantParticipantsParams {
    */
   MachineDetection?: 'Enable' | 'DetectMessageEnd';
 
+  /**
+   * Body param: Highest frequency, in Hz, that a tone can reach and still be treated
+   * as a beep. Only used when MachineDetection is enabled.
+   */
+  MachineDetectionBeepMaxFrequency?: number;
+
+  /**
+   * Body param: Lowest frequency, in Hz, that a tone must reach to be treated as a
+   * beep. Raising it above 480 excludes North American ringback (440 + 480 Hz),
+   * which can otherwise be reported as a beep when the `freq_only` profile is in
+   * use. Only used when MachineDetection is enabled.
+   */
+  MachineDetectionBeepMinFrequency?: number;
+
+  /**
+   * Body param: Shortest tone, in milliseconds, that can be treated as a beep.
+   * Raising it rejects brief tones such as call-progress blips. Only used when
+   * MachineDetection is enabled.
+   */
+  MachineDetectionBeepMinToneDuration?: number;
+
   /**
    * Body param: Selects which detectors must validate a beep. `both` requires the
    * amplitude and frequency detectors to agree. `freq_only` uses the frequency
@@ -492,6 +513,31 @@ export interface ParticipantParticipantsParams {
    */
   MachineDetectionBeepProfile?: 'both' | 'freq_only';
 
+  /**
+   * Body param: When enabled, a candidate beep must pass an additional spectral
+   * check before it is reported. Only used when MachineDetection is enabled.
+   */
+  MachineDetectionBeepSpectralConfirmation?: boolean;
+
+  /**
+   * Body param: Minimum spectral purity, from 0 to 1, for a tone to be treated as a
+   * beep. Raising it rejects mixed tones such as ringback, which combines two
+   * frequencies. Only used when MachineDetection is enabled.
+   */
+  MachineDetectionBeepSpectralMinPurity?: number;
+
+  /**
+   * Body param: When enabled, the fax CNG tone is rejected rather than reported as a
+   * beep. Only used when MachineDetection is enabled.
+   */
+  MachineDetectionBeepSpectralRejectFaxCng?: boolean;
+
+  /**
+   * Body param: Length of the spectral confirmation window, in milliseconds. Only
+   * used when MachineDetection is enabled.
+   */
+  MachineDetectionBeepSpectralWindow?: number;
+
   /**
    * Body param: If initial silence duration is greater than this value, consider it
    * a machine. Ignored when `premium` detection is used.

package/src/resources/texml/calls.ts

@@ -0,0 +1,90 @@
+// 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';
+import { path } from '../../internal/utils/path';
+
+/**
+ * TeXML REST Commands
+ */
+export class Calls extends APIResource {
+  /**
+   * Initiate an outbound TeXML call using a TeXML application connection ID, not an
+   * account SID. Request parameter names are case-sensitive. From and To are
+   * required; Texml supplies inline instructions and Url overrides the application
+   * XML request URL. When neither is supplied, the application configuration
+   * supplies the instructions. The response is a flat call object without a data
+   * wrapper.
+   *
+   * @example
+   * ```ts
+   * const call = await client.texml.calls.create('1234567890', {
+   *   From: '+13120001234',
+   *   To: '+13121230000',
+   *   Texml: '<Response><Say>Hello</Say></Response>',
+   * });
+   * ```
+   */
+  create(
+    connectionID: string,
+    body: CallCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<CallCreateResponse> {
+    return this._client.post(path`/texml/calls/${connectionID}`, { body, ...options });
+  }
+}
+
+export interface CallCreateResponse {
+  /**
+   * The call control ID of the created call.
+   */
+  call_sid: string;
+
+  /**
+   * The caller address.
+   */
+  from: string;
+
+  /**
+   * The initial status of the outbound call.
+   */
+  status: 'queued';
+
+  /**
+   * The called address.
+   */
+  to: string;
+}
+
+export interface CallCreateParams {
+  /**
+   * The E.164-formatted phone number or SIP URI to present as the caller.
+   */
+  From: string;
+
+  /**
+   * The E.164-formatted phone number or SIP URI to call.
+   */
+  To: string;
+
+  /**
+   * HTTP method used to retrieve TeXML instructions from Url.
+   */
+  Method?: 'GET' | 'POST';
+
+  /**
+   * Inline TeXML instructions to execute when the call is answered.
+   */
+  Texml?: string;
+
+  /**
+   * The URL from which to retrieve TeXML instructions. Overrides the TeXML
+   * application XML request URL.
+   */
+  Url?: string;
+}
+
+export declare namespace Calls {
+  export { type CallCreateResponse as CallCreateResponse, type CallCreateParams as CallCreateParams };
+}

package/src/resources/texml/index.ts

@@ -8,6 +8,7 @@ export {
   type AccountRetrieveRecordingsJsonParams,
   type AccountRetrieveTranscriptionsJsonParams,
 } from './accounts/index';
+export { Calls, type CallCreateResponse, type CallCreateParams } from './calls';
 export {
   Texml,
   type TexmlInitiateAICallResponse,

package/src/resources/texml/texml.ts

@@ -1,6 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
+import * as CallsAPI from './calls';
+import { CallCreateParams, CallCreateResponse, Calls } from './calls';
 import * as AccountsAPI from './accounts/accounts';
 import {
   AccountRetrieveRecordingsJsonParams,
@@ -18,6 +20,7 @@ import { path } from '../../internal/utils/path';
  * TeXML REST Commands
  */
 export class Texml extends APIResource {
+  calls: CallsAPI.Calls = new CallsAPI.Calls(this._client);
   accounts: AccountsAPI.Accounts = new AccountsAPI.Accounts(this._client);
 
   /**
@@ -203,6 +206,27 @@ export interface TexmlInitiateAICallParams {
    */
   MachineDetection?: 'Enable' | 'Disable' | 'DetectMessageEnd';
 
+  /**
+   * Highest frequency, in Hz, that a tone can reach and still be treated as a beep.
+   * Only used when MachineDetection is enabled.
+   */
+  MachineDetectionBeepMaxFrequency?: number;
+
+  /**
+   * Lowest frequency, in Hz, that a tone must reach to be treated as a beep. Raising
+   * it above 480 excludes North American ringback (440 + 480 Hz), which can
+   * otherwise be reported as a beep when the `freq_only` profile is in use. Only
+   * used when MachineDetection is enabled.
+   */
+  MachineDetectionBeepMinFrequency?: number;
+
+  /**
+   * Shortest tone, in milliseconds, that can be treated as a beep. Raising it
+   * rejects brief tones such as call-progress blips. Only used when MachineDetection
+   * is enabled.
+   */
+  MachineDetectionBeepMinToneDuration?: number;
+
   /**
    * Selects which detectors must validate a beep. `both` requires the amplitude and
    * frequency detectors to agree. `freq_only` uses the frequency detector alone, for
@@ -211,6 +235,31 @@ export interface TexmlInitiateAICallParams {
    */
   MachineDetectionBeepProfile?: 'both' | 'freq_only';
 
+  /**
+   * When enabled, a candidate beep must pass an additional spectral check before it
+   * is reported. Only used when MachineDetection is enabled.
+   */
+  MachineDetectionBeepSpectralConfirmation?: boolean;
+
+  /**
+   * Minimum spectral purity, from 0 to 1, for a tone to be treated as a beep.
+   * Raising it rejects mixed tones such as ringback, which combines two frequencies.
+   * Only used when MachineDetection is enabled.
+   */
+  MachineDetectionBeepSpectralMinPurity?: number;
+
+  /**
+   * When enabled, the fax CNG tone is rejected rather than reported as a beep. Only
+   * used when MachineDetection is enabled.
+   */
+  MachineDetectionBeepSpectralRejectFaxCng?: boolean;
+
+  /**
+   * Length of the spectral confirmation window, in milliseconds. Only used when
+   * MachineDetection is enabled.
+   */
+  MachineDetectionBeepSpectralWindow?: number;
+
   /**
    * Silence duration threshold after a call screening prompt before ending prompt
    * detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.
@@ -373,6 +422,7 @@ export namespace TexmlInitiateAICallParams {
   }
 }
 
+Texml.Calls = Calls;
 Texml.Accounts = Accounts;
 
 export declare namespace Texml {
@@ -383,6 +433,12 @@ export declare namespace Texml {
     type TexmlInitiateAICallParams as TexmlInitiateAICallParams,
   };
 
+  export {
+    Calls as Calls,
+    type CallCreateResponse as CallCreateResponse,
+    type CallCreateParams as CallCreateParams,
+  };
+
   export {
     Accounts as Accounts,
     type TexmlGetCallRecordingResponseBody as TexmlGetCallRecordingResponseBody,