telnyx 7.16.0 → 7.17.0

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/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

@@ -62,10 +62,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 +75,62 @@ export class SpeechToText extends APIResource {
  */
 export type SttServiceType = 'streaming' | 'file_based' | 'in_call' | 'ai_assistant';
 
+/**
+ * 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';
+  }
+}
+
 /**
  * List of supported STT providers and models.
  */
@@ -149,62 +202,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
@@ -324,9 +321,9 @@ export interface SpeechToTextRetrieveTranscriptionParams {
 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;