telnyx 7.16.0 → 7.18.0

package/src/resources/recordings/recordings.ts

@@ -15,7 +15,8 @@ export class Recordings extends APIResource {
   actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
 
   /**
-   * Returns a list of your call recordings.
+   * Returns a paginated list of your call recordings, with support for filtering to
+   * locate specific recordings.
    *
    * @example
    * ```ts
@@ -36,7 +37,8 @@ export class Recordings extends APIResource {
   }
 
   /**
-   * Permanently deletes a call recording.
+   * Permanently deletes the specified call recording and returns the deleted
+   * recording resource. The media is removed and can no longer be downloaded.
    *
    * @example
    * ```ts

package/src/resources/reports/mdr-usage-reports.ts

@@ -79,7 +79,7 @@ export class MdrUsageReports extends APIResource {
   }
 
   /**
-   * Delete messaging usage report by id
+   * Permanently deletes the specified messaging usage report by its identifier.
    *
    * @example
    * ```ts

package/src/resources/reports/reports.ts

@@ -31,7 +31,8 @@ export class Reports extends APIResource {
   mdrUsageReports: MdrUsageReportsAPI.MdrUsageReports = new MdrUsageReportsAPI.MdrUsageReports(this._client);
 
   /**
-   * Fetch all Mdr records
+   * Returns message detail records (MDRs) matching the provided criteria, such as
+   * date range, direction, status, and message type.
    *
    * @example
    * ```ts
@@ -46,7 +47,8 @@ export class Reports extends APIResource {
   }
 
   /**
-   * Fetch all Wdr records
+   * Returns wireless detail records (WDRs) matching the provided criteria, such as
+   * date range, SIM card, IMSI, or phone number, with pagination and sorting.
    *
    * @example
    * ```ts

package/src/resources/requirement-types.ts

@@ -28,7 +28,8 @@ export class RequirementTypes extends APIResource {
   }
 
   /**
-   * Retrieve a requirement type by id
+   * Returns the details of a single requirement type by its identifier, describing a
+   * kind of documentation needed for regulatory purposes.
    *
    * @example
    * ```ts

package/src/resources/requirements.ts

@@ -33,7 +33,9 @@ export class Requirements extends APIResource {
   }
 
   /**
-   * Retrieve a document requirement record
+   * Returns a single document requirement record by its identifier, describing the
+   * documentation needed for number-related actions. A specific requirement version
+   * can be requested.
    *
    * @example
    * ```ts

package/src/resources/room-recordings.ts

@@ -42,7 +42,8 @@ export class RoomRecordings extends APIResource {
   }
 
   /**
-   * Synchronously delete a Room Recording.
+   * Synchronously deletes the specified video room recording. The recording's media
+   * is removed permanently.
    */
   delete(roomRecordingID: string, options?: RequestOptions): APIPromise<void> {
     return this._client.delete(path`/room_recordings/${roomRecordingID}`, {

package/src/resources/rooms/rooms.ts

@@ -52,7 +52,8 @@ export class Rooms extends APIResource {
   }
 
   /**
-   * Synchronously create a Room.
+   * Synchronously creates a new video room with the provided configuration and
+   * returns the created room.
    *
    * @example
    * ```ts
@@ -103,7 +104,8 @@ export class Rooms extends APIResource {
   }
 
   /**
-   * Synchronously update a Room.
+   * Synchronously updates the specified video room's configuration and returns the
+   * updated room.
    *
    * @example
    * ```ts

package/src/resources/shared.ts

@@ -1096,18 +1096,6 @@ export interface ResembleVoiceSettings {
   sample_rate?: '8000' | '16000' | '22050' | '32000' | '44100' | '48000';
 }
 
-export interface RimeVoiceSettings {
-  /**
-   * Voice settings provider type
-   */
-  type: 'rime';
-
-  /**
-   * Speech speed multiplier. Default is 1.0.
-   */
-  voice_speed?: number;
-}
-
 export interface RoomParticipant {
   /**
    * A unique identifier for the room participant.

package/src/resources/sim-card-groups/actions.ts

@@ -67,8 +67,9 @@ export class Actions extends APIResource {
   }
 
   /**
-   * This action will asynchronously remove an existing Wireless Blocklist to all the
-   * SIMs in the SIM card group.
+   * This action asynchronously removes the Wireless Blocklist assigned to a SIM Card
+   * Group. The request returns `404` when the SIM Card Group does not exist and
+   * `422` when no Wireless Blocklist is assigned.
    *
    * @example
    * ```ts
@@ -118,8 +119,9 @@ export class Actions extends APIResource {
   }
 
   /**
-   * This action will asynchronously assign a Wireless Blocklist to all the SIMs in
-   * the SIM card group.
+   * This action asynchronously assigns a Wireless Blocklist to all SIMs in the SIM
+   * Card Group. The request returns `404` when the SIM Card Group does not exist and
+   * `422` when the Wireless Blocklist does not exist.
    *
    * @example
    * ```ts
@@ -201,6 +203,11 @@ export namespace SimCardGroupAction {
      * The identification of the related Private Wireless Gateway resource.
      */
     private_wireless_gateway_id?: string;
+
+    /**
+     * The identification of the related Wireless Blocklist resource.
+     */
+    wireless_blocklist_id?: string;
   }
 }
 

package/src/resources/sim-card-groups/sim-card-groups.ts

@@ -48,7 +48,8 @@ export class SimCardGroups extends APIResource {
   }
 
   /**
-   * Creates a new SIM card group object
+   * Creates a new SIM card group and returns it. Groups let you apply shared
+   * settings to a set of SIM cards.
    *
    * @example
    * ```ts
@@ -62,7 +63,7 @@ export class SimCardGroups extends APIResource {
   }
 
   /**
-   * Permanently deletes a SIM card group
+   * Permanently deletes the specified SIM card group from your account.
    *
    * @example
    * ```ts
@@ -94,7 +95,7 @@ export class SimCardGroups extends APIResource {
   }
 
   /**
-   * Updates a SIM card group
+   * Updates the specified SIM card group's attributes and returns the updated group.
    *
    * @example
    * ```ts

package/src/resources/sim-card-order-preview.ts

@@ -9,7 +9,8 @@ import { RequestOptions } from '../internal/request-options';
  */
 export class SimCardOrderPreview extends APIResource {
   /**
-   * Preview SIM card order purchases.
+   * Previews a SIM card order purchase, returning estimated costs and details before
+   * you place the order. The preview is processed asynchronously.
    *
    * @example
    * ```ts

package/src/resources/sim-card-orders.ts

@@ -32,7 +32,8 @@ export class SimCardOrders extends APIResource {
   }
 
   /**
-   * Creates a new order for SIM cards.
+   * Creates a new order for physical SIM cards, including quantity and shipping
+   * details, and returns the created order.
    *
    * @example
    * ```ts
@@ -47,7 +48,7 @@ export class SimCardOrders extends APIResource {
   }
 
   /**
-   * Get a single SIM card order by its ID.
+   * Returns the details of a single SIM card order by its ID, including its status.
    *
    * @example
    * ```ts

package/src/resources/sim-cards/sim-cards.ts

@@ -106,7 +106,7 @@ export class SimCards extends APIResource {
   }
 
   /**
-   * Updates SIM card data
+   * Updates the specified SIM card's attributes and returns the updated SIM card.
    *
    * @example
    * ```ts

package/src/resources/siprec-connectors.ts

@@ -28,7 +28,7 @@ export class SiprecConnectors extends APIResource {
   }
 
   /**
-   * Deletes a stored SIPREC connector.
+   * Deletes the stored SIPREC connector with the specified connector name.
    *
    * @example
    * ```ts

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

@@ -3,9 +3,9 @@
 export {
   SpeechToText,
   type SttServiceType,
-  type SpeechToTextListProvidersResponse,
   type TranscribeClientEvent,
   type TranscribeServerEvent,
+  type SpeechToTextListProvidersResponse,
   type SpeechToTextListProvidersParams,
   type SpeechToTextRetrieveTranscriptionParams,
 } from './speech-to-text';

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

@@ -43,13 +43,14 @@ export class SpeechToText extends APIResource {
    * `Authorization: Bearer <API_KEY>` header.
    *
    * Supported engines: `Azure`, `Deepgram`, `Google`, `Telnyx`, `xAI`,
-   * `Speechmatics`, `Soniox`, `Parakeet`, `Humain`, `Reson8`.
+   * `Speechmatics`, `Soniox`, `Parakeet`, `Humain`, `Reson8`, `Cohere`.
    *
    * **Connection flow:**
    *
    * 1. Open WebSocket with query parameters specifying engine, input format, and
    *    language.
-   * 2. Send binary audio frames (mp3/wav format).
+   * 2. Send binary audio frames (mp3, wav, linear16, or linear32 format, per
+   *    `input_format`).
    * 3. Receive JSON transcript frames with `transcript`, `is_final`, and
    *    `confidence` fields.
    * 4. Close connection when done.
@@ -62,10 +63,7 @@ export class SpeechToText extends APIResource {
       query,
       defaultBaseURL: 'wss://api.telnyx.com/v2',
       ...options,
-      headers: buildHeaders([
-        { 'Content-Type': 'application/octet-stream', Accept: '*/*' },
-        options?.headers,
-      ]),
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 }
@@ -78,6 +76,63 @@ export class SpeechToText extends APIResource {
  */
 export type SttServiceType = 'streaming' | 'file_based' | 'in_call' | 'ai_assistant';
 
+/**
+ * Binary audio data in mp3, wav, linear16, or linear32 format, per `input_format`.
+ */
+export type TranscribeClientEvent = Uploadable;
+
+/**
+ * Union of all server-to-client WebSocket events for STT streaming.
+ */
+export type TranscribeServerEvent =
+  | TranscribeServerEvent.TranscriptFrame
+  | TranscribeServerEvent.SttErrorFrame;
+
+export namespace TranscribeServerEvent {
+  /**
+   * Server-to-client frame containing a transcription result.
+   */
+  export interface TranscriptFrame {
+    /**
+     * The transcribed text from the audio.
+     */
+    transcript: string;
+
+    /**
+     * Frame type identifier.
+     */
+    type: 'transcript';
+
+    /**
+     * Confidence score of the transcription, ranging from 0 to 1. `cohere/ar-stt`
+     * frames return `null` here rather than omitting the field.
+     */
+    confidence?: number | null;
+
+    /**
+     * Whether this is a final transcription result. When `false`, this is an interim
+     * result that may be refined.
+     */
+    is_final?: boolean;
+  }
+
+  /**
+   * Server-to-client frame indicating an error during transcription. The connection
+   * may be closed shortly after.
+   */
+  export interface SttErrorFrame {
+    /**
+     * Error message describing what went wrong.
+     */
+    error: string;
+
+    /**
+     * Frame type identifier.
+     */
+    type: 'error';
+  }
+}
+
 /**
  * List of supported STT providers and models.
  */
@@ -149,62 +204,6 @@ export namespace SpeechToTextListProvidersResponse {
   }
 }
 
-/**
- * Binary audio data in mp3 or wav format.
- */
-export type TranscribeClientEvent = Uploadable;
-
-/**
- * Union of all server-to-client WebSocket events for STT streaming.
- */
-export type TranscribeServerEvent =
-  | TranscribeServerEvent.TranscriptFrame
-  | TranscribeServerEvent.SttErrorFrame;
-
-export namespace TranscribeServerEvent {
-  /**
-   * Server-to-client frame containing a transcription result.
-   */
-  export interface TranscriptFrame {
-    /**
-     * The transcribed text from the audio.
-     */
-    transcript: string;
-
-    /**
-     * Frame type identifier.
-     */
-    type: 'transcript';
-
-    /**
-     * Confidence score of the transcription, ranging from 0 to 1.
-     */
-    confidence?: number;
-
-    /**
-     * Whether this is a final transcription result. When `false`, this is an interim
-     * result that may be refined.
-     */
-    is_final?: boolean;
-  }
-
-  /**
-   * Server-to-client frame indicating an error during transcription. The connection
-   * may be closed shortly after.
-   */
-  export interface SttErrorFrame {
-    /**
-     * Error message describing what went wrong.
-     */
-    error: string;
-
-    /**
-     * Frame type identifier.
-     */
-    type: 'error';
-  }
-}
-
 export interface SpeechToTextListProvidersParams {
   /**
    * Filter to entries for a specific STT provider. The enum mirrors the providers
@@ -222,6 +221,7 @@ export interface SpeechToTextListProvidersParams {
     | 'parakeet'
     | 'humain'
     | 'reson8'
+    | 'cohere'
     | 'azure'
     | 'openai'
     | 'google'
@@ -242,7 +242,7 @@ export interface SpeechToTextRetrieveTranscriptionParams {
   /**
    * The format of input audio stream.
    */
-  input_format: 'mp3' | 'wav';
+  input_format: 'mp3' | 'wav' | 'linear16' | 'linear32';
 
   /**
    * The transcription engine to use for processing the audio stream.
@@ -257,7 +257,8 @@ export interface SpeechToTextRetrieveTranscriptionParams {
     | 'Soniox'
     | 'Parakeet'
     | 'Humain'
-    | 'Reson8';
+    | 'Reson8'
+    | 'Cohere';
 
   /**
    * Silence duration (in milliseconds) that triggers end-of-speech detection. When
@@ -286,7 +287,9 @@ export interface SpeechToTextRetrieveTranscriptionParams {
   keywords?: string;
 
   /**
-   * The language spoken in the audio stream.
+   * The language spoken in the audio stream. For `cohere/ar-stt`, this must be `ar`
+   * or `en` — unlike other engines, Cohere does not auto-detect the language, and
+   * rejects unsupported values including `auto`; omitting it defaults to `ar`.
    */
   language?: string;
 
@@ -312,21 +315,29 @@ export interface SpeechToTextRetrieveTranscriptionParams {
     | 'soniox/stt-rt-v4'
     | 'nvidia/parakeet-v3'
     | 'humain/realtime'
-    | 'reson8/turns';
+    | 'reson8/turns'
+    | 'cohere/ar-stt';
 
   /**
    * Enable redaction of sensitive information (e.g., PCI data, SSN) from
    * transcription results. Supported values depend on the transcription engine.
    */
   redact?: string;
+
+  /**
+   * Audio sample rate in Hz. Required when `input_format` is a raw encoding
+   * (`linear16`, `linear32`) — those formats carry no header metadata. Ignored for
+   * container formats (`mp3`, `wav`), which self-describe their rate.
+   */
+  sample_rate?: number;
 }
 
 export declare namespace SpeechToText {
   export {
     type SttServiceType as SttServiceType,
-    type SpeechToTextListProvidersResponse as SpeechToTextListProvidersResponse,
     type TranscribeClientEvent as TranscribeClientEvent,
     type TranscribeServerEvent as TranscribeServerEvent,
+    type SpeechToTextListProvidersResponse as SpeechToTextListProvidersResponse,
     type SpeechToTextListProvidersParams as SpeechToTextListProvidersParams,
     type SpeechToTextRetrieveTranscriptionParams as SpeechToTextRetrieveTranscriptionParams,
   };

package/src/resources/storage/buckets/buckets.ts

@@ -52,9 +52,9 @@ export class Buckets extends APIResource {
     params: BucketCreatePresignedURLParams,
     options?: RequestOptions,
   ): APIPromise<BucketCreatePresignedURLResponse> {
-    const { bucketName, ...body } = params;
+    const { bucketName, body } = params;
     return this._client.post(path`/storage/buckets/${bucketName}/${objectName}/presigned_url`, {
-      body,
+      body: body,
       ...options,
     });
   }
@@ -90,9 +90,18 @@ export interface BucketCreatePresignedURLParams {
   bucketName: string;
 
   /**
-   * Body param: The time to live of the token in seconds
+   * Body param
    */
-  ttl?: number;
+  body?: BucketCreatePresignedURLParams.Body;
+}
+
+export namespace BucketCreatePresignedURLParams {
+  export interface Body {
+    /**
+     * The time to live of the token in seconds
+     */
+    ttl?: number;
+  }
 }
 
 Buckets.SslCertificateResource = SslCertificateResource;