telnyx 6.83.0 → 7.1.0

package/src/resources/conferences/actions.ts

@@ -327,6 +327,12 @@ export interface ConferenceCommandResult {
   result: string;
 }
 
+/**
+ * Region where the conference data is located. Defaults to the region defined in
+ * user's data locality settings (Europe or US).
+ */
+export type ConferenceRegion = 'Australia' | 'Europe' | 'Middle East' | 'US';
+
 export interface UpdateConference {
   /**
    * Unique identifier and token for controlling the call
@@ -353,7 +359,7 @@ export interface UpdateConference {
    * Region where the conference data is located. Defaults to the region defined in
    * user's data locality settings (Europe or US).
    */
-  region?: 'Australia' | 'Europe' | 'Middle East' | 'US';
+  region?: ConferenceRegion;
 
   /**
    * Array of unique call_control_ids the supervisor can whisper to. If none
@@ -457,7 +463,7 @@ export interface ActionUpdateParams {
    * Region where the conference data is located. Defaults to the region defined in
    * user's data locality settings (Europe or US).
    */
-  region?: 'Australia' | 'Europe' | 'Middle East' | 'US';
+  region?: ConferenceRegion;
 
   /**
    * Array of unique call_control_ids the supervisor can whisper to. If none
@@ -587,7 +593,7 @@ export interface ActionHoldParams {
    * Region where the conference data is located. Defaults to the region defined in
    * user's data locality settings (Europe or US).
    */
-  region?: 'Australia' | 'Europe' | 'Middle East' | 'US';
+  region?: ConferenceRegion;
 }
 
 export interface ActionJoinParams {
@@ -657,7 +663,7 @@ export interface ActionJoinParams {
    * Region where the conference data is located. Defaults to the region defined in
    * user's data locality settings (Europe or US).
    */
-  region?: 'Australia' | 'Europe' | 'Middle East' | 'US';
+  region?: ConferenceRegion;
 
   /**
    * Whether the conference should end after the participant leaves the conference.
@@ -712,7 +718,7 @@ export interface ActionLeaveParams {
    * Region where the conference data is located. Defaults to the region defined in
    * user's data locality settings (Europe or US).
    */
-  region?: 'Australia' | 'Europe' | 'Middle East' | 'US';
+  region?: ConferenceRegion;
 }
 
 export interface ActionMuteParams {
@@ -726,7 +732,7 @@ export interface ActionMuteParams {
    * Region where the conference data is located. Defaults to the region defined in
    * user's data locality settings (Europe or US).
    */
-  region?: 'Australia' | 'Europe' | 'Middle East' | 'US';
+  region?: ConferenceRegion;
 }
 
 export interface ActionPlayParams {
@@ -760,7 +766,7 @@ export interface ActionPlayParams {
    * Region where the conference data is located. Defaults to the region defined in
    * user's data locality settings (Europe or US).
    */
-  region?: 'Australia' | 'Europe' | 'Middle East' | 'US';
+  region?: ConferenceRegion;
 }
 
 export interface ActionRecordPauseParams {
@@ -779,7 +785,7 @@ export interface ActionRecordPauseParams {
    * Region where the conference data is located. Defaults to the region defined in
    * user's data locality settings (Europe or US).
    */
-  region?: 'Australia' | 'Europe' | 'Middle East' | 'US';
+  region?: ConferenceRegion;
 }
 
 export interface ActionRecordResumeParams {
@@ -798,7 +804,7 @@ export interface ActionRecordResumeParams {
    * Region where the conference data is located. Defaults to the region defined in
    * user's data locality settings (Europe or US).
    */
-  region?: 'Australia' | 'Europe' | 'Middle East' | 'US';
+  region?: ConferenceRegion;
 }
 
 export interface ActionRecordStartParams {
@@ -835,7 +841,7 @@ export interface ActionRecordStartParams {
    * Region where the conference data is located. Defaults to the region defined in
    * user's data locality settings (Europe or US).
    */
-  region?: 'Australia' | 'Europe' | 'Middle East' | 'US';
+  region?: ConferenceRegion;
 
   /**
    * When set to `trim-silence`, silence will be removed from the beginning and end
@@ -866,7 +872,7 @@ export interface ActionRecordStopParams {
    * Region where the conference data is located. Defaults to the region defined in
    * user's data locality settings (Europe or US).
    */
-  region?: 'Australia' | 'Europe' | 'Middle East' | 'US';
+  region?: ConferenceRegion;
 }
 
 export interface ActionSendDtmfParams {
@@ -939,7 +945,9 @@ export interface ActionSpeakParams {
    *   `Resemble.Turbo.my_voice`). Only `Turbo` model is supported. Use
    *   `voice_settings` to configure precision, sample_rate, and format.
    * - **Inworld:** Use `Inworld.<ModelId>.<VoiceId>` (e.g., `Inworld.Mini.Loretta`,
-   *   `Inworld.Max.Oliver`). Supported models: `Mini`, `Max`.
+   *   `Inworld.Max.Oliver`, `Inworld.TTS2.Loretta`). Supported models: `Mini`,
+   *   `Max`, `TTS2`. Use `voice_settings` to configure `delivery_mode` (`STABLE`,
+   *   `BALANCED`, `CREATIVE`), supported by `TTS2` only.
    * - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
    *   `ara`, `rex`, `sal`, `leo`.
    *
@@ -1006,7 +1014,7 @@ export interface ActionSpeakParams {
    * Region where the conference data is located. Defaults to the region defined in
    * user's data locality settings (Europe or US).
    */
-  region?: 'Australia' | 'Europe' | 'Middle East' | 'US';
+  region?: ConferenceRegion;
 
   /**
    * The settings associated with the voice selected
@@ -1034,7 +1042,7 @@ export interface ActionStopParams {
    * Region where the conference data is located. Defaults to the region defined in
    * user's data locality settings (Europe or US).
    */
-  region?: 'Australia' | 'Europe' | 'Middle East' | 'US';
+  region?: ConferenceRegion;
 }
 
 export interface ActionUnholdParams {
@@ -1048,7 +1056,7 @@ export interface ActionUnholdParams {
    * Region where the conference data is located. Defaults to the region defined in
    * user's data locality settings (Europe or US).
    */
-  region?: 'Australia' | 'Europe' | 'Middle East' | 'US';
+  region?: ConferenceRegion;
 }
 
 export interface ActionUnmuteParams {
@@ -1062,12 +1070,13 @@ export interface ActionUnmuteParams {
    * Region where the conference data is located. Defaults to the region defined in
    * user's data locality settings (Europe or US).
    */
-  region?: 'Australia' | 'Europe' | 'Middle East' | 'US';
+  region?: ConferenceRegion;
 }
 
 export declare namespace Actions {
   export {
     type ConferenceCommandResult as ConferenceCommandResult,
+    type ConferenceRegion as ConferenceRegion,
     type UpdateConference as UpdateConference,
     type ActionUpdateResponse as ActionUpdateResponse,
     type ActionEndConferenceResponse as ActionEndConferenceResponse,

package/src/resources/conferences/conferences.ts

@@ -39,6 +39,7 @@ import {
   ActionUpdateResponse,
   Actions,
   ConferenceCommandResult,
+  ConferenceRegion,
   UpdateConference,
 } from './actions';
 import { APIPromise } from '../../core/api-promise';
@@ -151,7 +152,7 @@ export class Conferences extends APIResource {
    *
    * @example
    * ```ts
-   * const response =
+   * const conferenceParticipantResource =
    *   await client.conferences.retrieveParticipant(
    *     'participant_id',
    *     { id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
@@ -162,7 +163,7 @@ export class Conferences extends APIResource {
     participantID: string,
     params: ConferenceRetrieveParticipantParams,
     options?: RequestOptions,
-  ): APIPromise<ConferenceRetrieveParticipantResponse> {
+  ): APIPromise<ConferenceParticipantResource> {
     const { id } = params;
     return this._client.get(path`/conferences/${id}/participants/${participantID}`, options);
   }
@@ -172,17 +173,18 @@ export class Conferences extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.conferences.updateParticipant(
-   *   'participant_id',
-   *   { id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
-   * );
+   * const conferenceParticipantResource =
+   *   await client.conferences.updateParticipant(
+   *     'participant_id',
+   *     { id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
+   *   );
    * ```
    */
   updateParticipant(
     participantID: string,
     params: ConferenceUpdateParticipantParams,
     options?: RequestOptions,
-  ): APIPromise<ConferenceUpdateParticipantResponse> {
+  ): APIPromise<ConferenceParticipantResource> {
     const { id, ...body } = params;
     return this._client.patch(path`/conferences/${id}/participants/${participantID}`, { body, ...options });
   }
@@ -333,6 +335,10 @@ export interface ConferenceParticipant {
   whisper_call_control_ids?: Array<string>;
 }
 
+export interface ConferenceParticipantResource {
+  data?: ConferenceParticipant;
+}
+
 export interface ConferenceCreateResponse {
   data?: Conference;
 }
@@ -424,14 +430,6 @@ export namespace ConferenceListParticipantsResponse {
   }
 }
 
-export interface ConferenceRetrieveParticipantResponse {
-  data?: ConferenceParticipant;
-}
-
-export interface ConferenceUpdateParticipantResponse {
-  data?: ConferenceParticipant;
-}
-
 export interface ConferenceCreateParams {
   /**
    * Unique identifier and token for controlling the call
@@ -728,11 +726,10 @@ export declare namespace Conferences {
   export {
     type Conference as Conference,
     type ConferenceParticipant as ConferenceParticipant,
+    type ConferenceParticipantResource as ConferenceParticipantResource,
     type ConferenceCreateResponse as ConferenceCreateResponse,
     type ConferenceRetrieveResponse as ConferenceRetrieveResponse,
     type ConferenceListParticipantsResponse as ConferenceListParticipantsResponse,
-    type ConferenceRetrieveParticipantResponse as ConferenceRetrieveParticipantResponse,
-    type ConferenceUpdateParticipantResponse as ConferenceUpdateParticipantResponse,
     type ConferencesDefaultFlatPagination as ConferencesDefaultFlatPagination,
     type ConferenceListParticipantsResponsesDefaultFlatPagination as ConferenceListParticipantsResponsesDefaultFlatPagination,
     type ConferenceCreateParams as ConferenceCreateParams,
@@ -746,6 +743,7 @@ export declare namespace Conferences {
   export {
     Actions as Actions,
     type ConferenceCommandResult as ConferenceCommandResult,
+    type ConferenceRegion as ConferenceRegion,
     type UpdateConference as UpdateConference,
     type ActionUpdateResponse as ActionUpdateResponse,
     type ActionEndConferenceResponse as ActionEndConferenceResponse,

package/src/resources/conferences/index.ts

@@ -3,6 +3,7 @@
 export {
   Actions,
   type ConferenceCommandResult,
+  type ConferenceRegion,
   type UpdateConference,
   type ActionUpdateResponse,
   type ActionEndConferenceResponse,
@@ -43,11 +44,10 @@ export {
   Conferences,
   type Conference,
   type ConferenceParticipant,
+  type ConferenceParticipantResource,
   type ConferenceCreateResponse,
   type ConferenceRetrieveResponse,
   type ConferenceListParticipantsResponse,
-  type ConferenceRetrieveParticipantResponse,
-  type ConferenceUpdateParticipantResponse,
   type ConferenceCreateParams,
   type ConferenceRetrieveParams,
   type ConferenceListParams,

package/src/resources/connections.ts

@@ -22,11 +22,8 @@ export class Connections extends APIResource {
   list(
     query: ConnectionListParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<ConnectionListResponsesDefaultFlatPagination, ConnectionListResponse> {
-    return this._client.getAPIList('/connections', DefaultFlatPagination<ConnectionListResponse>, {
-      query,
-      ...options,
-    });
+  ): PagePromise<ConnectionsDefaultFlatPagination, Connection> {
+    return this._client.getAPIList('/connections', DefaultFlatPagination<Connection>, { query, ...options });
   }
 
   /**
@@ -47,80 +44,12 @@ export class Connections extends APIResource {
   }
 }
 
-export type ConnectionListResponsesDefaultFlatPagination = DefaultFlatPagination<ConnectionListResponse>;
+export type ConnectionsDefaultFlatPagination = DefaultFlatPagination<Connection>;
 
 export type ConnectionListActiveCallsResponsesDefaultFlatPagination =
   DefaultFlatPagination<ConnectionListActiveCallsResponse>;
 
-export interface ConnectionRetrieveResponse {
-  data?: ConnectionRetrieveResponse.Data;
-}
-
-export namespace ConnectionRetrieveResponse {
-  export interface Data {
-    /**
-     * Identifies the specific resource.
-     */
-    id?: string;
-
-    /**
-     * Defaults to true
-     */
-    active?: boolean;
-
-    /**
-     * `Latency` directs Telnyx to route media through the site with the lowest
-     * round-trip time to the user's connection. Telnyx calculates this time using ICMP
-     * ping messages. This can be disabled by specifying a site to handle all media.
-     */
-    anchorsite_override?: CredentialConnectionsAPI.AnchorsiteOverride;
-
-    connection_name?: string;
-
-    /**
-     * ISO 8601 formatted date indicating when the resource was created.
-     */
-    created_at?: string;
-
-    /**
-     * Identifies the associated outbound voice profile.
-     */
-    outbound_voice_profile_id?: string;
-
-    /**
-     * Identifies the type of the resource.
-     */
-    record_type?: string;
-
-    /**
-     * Tags associated with the connection.
-     */
-    tags?: Array<string>;
-
-    /**
-     * ISO 8601 formatted date indicating when the resource was updated.
-     */
-    updated_at?: string;
-
-    /**
-     * Determines which webhook format will be used, Telnyx API v1 or v2.
-     */
-    webhook_api_version?: '1' | '2';
-
-    /**
-     * The failover URL where webhooks related to this connection will be sent if
-     * sending to the primary URL fails.
-     */
-    webhook_event_failover_url?: string | null;
-
-    /**
-     * The URL where webhooks related to this connection will be sent.
-     */
-    webhook_event_url?: string | null;
-  }
-}
-
-export interface ConnectionListResponse {
+export interface Connection {
   /**
    * Identifies the specific resource.
    */
@@ -182,6 +111,10 @@ export interface ConnectionListResponse {
   webhook_event_url?: string | null;
 }
 
+export interface ConnectionRetrieveResponse {
+  data?: Connection;
+}
+
 export interface ConnectionListActiveCallsResponse {
   /**
    * Unique identifier and token for controlling the call.
@@ -283,10 +216,10 @@ export interface ConnectionListActiveCallsParams extends DefaultFlatPaginationPa
 
 export declare namespace Connections {
   export {
+    type Connection as Connection,
     type ConnectionRetrieveResponse as ConnectionRetrieveResponse,
-    type ConnectionListResponse as ConnectionListResponse,
     type ConnectionListActiveCallsResponse as ConnectionListActiveCallsResponse,
-    type ConnectionListResponsesDefaultFlatPagination as ConnectionListResponsesDefaultFlatPagination,
+    type ConnectionsDefaultFlatPagination as ConnectionsDefaultFlatPagination,
     type ConnectionListActiveCallsResponsesDefaultFlatPagination as ConnectionListActiveCallsResponsesDefaultFlatPagination,
     type ConnectionListParams as ConnectionListParams,
     type ConnectionListActiveCallsParams as ConnectionListActiveCallsParams,

package/src/resources/credential-connections/credential-connections.ts

@@ -119,6 +119,14 @@ export type AnchorsiteOverride =
   | 'Vancouver, Canada'
   | 'Frankfurt, Germany';
 
+/**
+ * Controls when noise suppression is applied to calls. When set to 'inbound',
+ * noise suppression is applied to incoming audio. When set to 'outbound', it's
+ * applied to outgoing audio. When set to 'both', it's applied in both directions.
+ * When set to 'disabled', noise suppression is turned off.
+ */
+export type ConnectionNoiseSuppression = 'inbound' | 'outbound' | 'both' | 'disabled';
+
 export interface ConnectionRtcpSettings {
   /**
    * BETA - Enable the capture and storage of RTCP messages to create QoS reports on
@@ -220,7 +228,7 @@ export interface CredentialConnection {
    * applied to outgoing audio. When set to 'both', it's applied in both directions.
    * When set to 'disabled', noise suppression is turned off.
    */
-  noise_suppression?: 'inbound' | 'outbound' | 'both' | 'disabled';
+  noise_suppression?: ConnectionNoiseSuppression;
 
   /**
    * Configuration options for noise suppression. These settings are stored
@@ -556,7 +564,7 @@ export interface CredentialConnectionCreateParams {
    * applied to outgoing audio. When set to 'both', it's applied in both directions.
    * When set to 'disabled', noise suppression is turned off.
    */
-  noise_suppression?: 'inbound' | 'outbound' | 'both' | 'disabled';
+  noise_suppression?: ConnectionNoiseSuppression;
 
   /**
    * Configuration options for noise suppression. These settings are stored
@@ -691,7 +699,7 @@ export interface CredentialConnectionUpdateParams {
    * applied to outgoing audio. When set to 'both', it's applied in both directions.
    * When set to 'disabled', noise suppression is turned off.
    */
-  noise_suppression?: 'inbound' | 'outbound' | 'both' | 'disabled';
+  noise_suppression?: ConnectionNoiseSuppression;
 
   /**
    * Configuration options for noise suppression. These settings are stored
@@ -832,6 +840,7 @@ CredentialConnections.Actions = Actions;
 export declare namespace CredentialConnections {
   export {
     type AnchorsiteOverride as AnchorsiteOverride,
+    type ConnectionNoiseSuppression as ConnectionNoiseSuppression,
     type ConnectionRtcpSettings as ConnectionRtcpSettings,
     type CredentialConnection as CredentialConnection,
     type CredentialInbound as CredentialInbound,

package/src/resources/credential-connections/index.ts

@@ -4,6 +4,7 @@ export { Actions, type ActionCheckRegistrationStatusResponse } from './actions';
 export {
   CredentialConnections,
   type AnchorsiteOverride,
+  type ConnectionNoiseSuppression,
   type ConnectionRtcpSettings,
   type CredentialConnection,
   type CredentialInbound,

package/src/resources/custom-storage-credentials.ts

@@ -15,7 +15,7 @@ export class CustomStorageCredentials extends APIResource {
    *
    * @example
    * ```ts
-   * const customStorageCredential =
+   * const credentialsResponse =
    *   await client.customStorageCredentials.create(
    *     'connection_id',
    *     {
@@ -29,7 +29,7 @@ export class CustomStorageCredentials extends APIResource {
     connectionID: string,
     body: CustomStorageCredentialCreateParams,
     options?: RequestOptions,
-  ): APIPromise<CustomStorageCredentialCreateResponse> {
+  ): APIPromise<CredentialsResponse> {
     return this._client.post(path`/custom_storage_credentials/${connectionID}`, { body, ...options });
   }
 
@@ -38,16 +38,13 @@ export class CustomStorageCredentials extends APIResource {
    *
    * @example
    * ```ts
-   * const customStorageCredential =
+   * const credentialsResponse =
    *   await client.customStorageCredentials.retrieve(
    *     'connection_id',
    *   );
    * ```
    */
-  retrieve(
-    connectionID: string,
-    options?: RequestOptions,
-  ): APIPromise<CustomStorageCredentialRetrieveResponse> {
+  retrieve(connectionID: string, options?: RequestOptions): APIPromise<CredentialsResponse> {
     return this._client.get(path`/custom_storage_credentials/${connectionID}`, options);
   }
 
@@ -56,7 +53,7 @@ export class CustomStorageCredentials extends APIResource {
    *
    * @example
    * ```ts
-   * const customStorageCredential =
+   * const credentialsResponse =
    *   await client.customStorageCredentials.update(
    *     'connection_id',
    *     {
@@ -70,7 +67,7 @@ export class CustomStorageCredentials extends APIResource {
     connectionID: string,
     body: CustomStorageCredentialUpdateParams,
     options?: RequestOptions,
-  ): APIPromise<CustomStorageCredentialUpdateResponse> {
+  ): APIPromise<CredentialsResponse> {
     return this._client.put(path`/custom_storage_credentials/${connectionID}`, { body, ...options });
   }
 
@@ -114,6 +111,21 @@ export interface AzureConfigurationData {
   bucket?: string;
 }
 
+export interface CredentialsResponse {
+  /**
+   * Uniquely identifies a Telnyx application (Call Control, TeXML) or Sip connection
+   * resource.
+   */
+  connection_id: string;
+
+  data: CustomStorageConfiguration;
+
+  /**
+   * Identifies record type.
+   */
+  record_type: 'custom_storage_credentials';
+}
+
 export interface CustomStorageConfiguration {
   backend: 'gcs' | 's3' | 'azure';
 
@@ -165,51 +177,6 @@ export interface S3ConfigurationData {
   region?: string;
 }
 
-export interface CustomStorageCredentialCreateResponse {
-  /**
-   * Uniquely identifies a Telnyx application (Call Control, TeXML) or Sip connection
-   * resource.
-   */
-  connection_id: string;
-
-  data: CustomStorageConfiguration;
-
-  /**
-   * Identifies record type.
-   */
-  record_type: 'custom_storage_credentials';
-}
-
-export interface CustomStorageCredentialRetrieveResponse {
-  /**
-   * Uniquely identifies a Telnyx application (Call Control, TeXML) or Sip connection
-   * resource.
-   */
-  connection_id: string;
-
-  data: CustomStorageConfiguration;
-
-  /**
-   * Identifies record type.
-   */
-  record_type: 'custom_storage_credentials';
-}
-
-export interface CustomStorageCredentialUpdateResponse {
-  /**
-   * Uniquely identifies a Telnyx application (Call Control, TeXML) or Sip connection
-   * resource.
-   */
-  connection_id: string;
-
-  data: CustomStorageConfiguration;
-
-  /**
-   * Identifies record type.
-   */
-  record_type: 'custom_storage_credentials';
-}
-
 export interface CustomStorageCredentialCreateParams {
   backend: 'gcs' | 's3' | 'azure';
 
@@ -225,12 +192,10 @@ export interface CustomStorageCredentialUpdateParams {
 export declare namespace CustomStorageCredentials {
   export {
     type AzureConfigurationData as AzureConfigurationData,
+    type CredentialsResponse as CredentialsResponse,
     type CustomStorageConfiguration as CustomStorageConfiguration,
     type GcsConfigurationData as GcsConfigurationData,
     type S3ConfigurationData as S3ConfigurationData,
-    type CustomStorageCredentialCreateResponse as CustomStorageCredentialCreateResponse,
-    type CustomStorageCredentialRetrieveResponse as CustomStorageCredentialRetrieveResponse,
-    type CustomStorageCredentialUpdateResponse as CustomStorageCredentialUpdateResponse,
     type CustomStorageCredentialCreateParams as CustomStorageCredentialCreateParams,
     type CustomStorageCredentialUpdateParams as CustomStorageCredentialUpdateParams,
   };