telnyx 6.83.0 → 7.1.0

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

@@ -15,7 +15,7 @@ export class Participants extends APIResource {
    *
    * @example
    * ```ts
-   * const participant =
+   * const participantResource =
    *   await client.texml.accounts.conferences.participants.retrieve(
    *     'call_sid_or_participant_label',
    *     {
@@ -29,7 +29,7 @@ export class Participants extends APIResource {
     callSidOrParticipantLabel: string,
     params: ParticipantRetrieveParams,
     options?: RequestOptions,
-  ): APIPromise<ParticipantRetrieveResponse> {
+  ): APIPromise<ParticipantResource> {
     const { account_sid, conference_sid } = params;
     return this._client.get(
       path`/texml/Accounts/${account_sid}/Conferences/${conference_sid}/Participants/${callSidOrParticipantLabel}`,
@@ -42,7 +42,7 @@ export class Participants extends APIResource {
    *
    * @example
    * ```ts
-   * const participant =
+   * const participantResource =
    *   await client.texml.accounts.conferences.participants.update(
    *     'call_sid_or_participant_label',
    *     {
@@ -56,7 +56,7 @@ export class Participants extends APIResource {
     callSidOrParticipantLabel: string,
     params: ParticipantUpdateParams,
     options?: RequestOptions,
-  ): APIPromise<ParticipantUpdateResponse> {
+  ): APIPromise<ParticipantResource> {
     const { account_sid, conference_sid, ...body } = params;
     return this._client.post(
       path`/texml/Accounts/${account_sid}/Conferences/${conference_sid}/Participants/${callSidOrParticipantLabel}`,
@@ -144,84 +144,7 @@ export class Participants extends APIResource {
   }
 }
 
-export interface ParticipantRetrieveResponse {
-  /**
-   * The id of the account the resource belongs to.
-   */
-  account_sid?: string;
-
-  /**
-   * The version of the API that was used to make the request.
-   */
-  api_version?: string;
-
-  /**
-   * The identifier of this participant's call.
-   */
-  call_sid?: string;
-
-  /**
-   * The identifier of this participant's call.
-   */
-  call_sid_legacy?: string;
-
-  /**
-   * Whether the participant is coaching another call.
-   */
-  coaching?: boolean;
-
-  /**
-   * The identifier of the coached participant's call.
-   */
-  coaching_call_sid?: string;
-
-  /**
-   * The identifier of the coached participant's call.
-   */
-  coaching_call_sid_legacy?: string;
-
-  /**
-   * The unique identifier for the conference.
-   */
-  conference_sid?: string;
-
-  /**
-   * The timestamp of when the resource was created.
-   */
-  date_created?: string;
-
-  /**
-   * The timestamp of when the resource was last updated.
-   */
-  date_updated?: string;
-
-  /**
-   * Whether the conference ends when the participant leaves.
-   */
-  end_conference_on_exit?: boolean;
-
-  /**
-   * Whether the participant is on hold.
-   */
-  hold?: boolean;
-
-  /**
-   * Whether the participant is muted.
-   */
-  muted?: boolean;
-
-  /**
-   * The status of the participant's call in the conference.
-   */
-  status?: 'connecting' | 'connected' | 'completed';
-
-  /**
-   * The relative URI for this participant.
-   */
-  uri?: string;
-}
-
-export interface ParticipantUpdateResponse {
+export interface ParticipantResource {
   /**
    * The id of the account the resource belongs to.
    */
@@ -376,7 +299,7 @@ export interface ParticipantRetrieveParticipantsResponse {
    */
   page_size?: number;
 
-  participants?: Array<ParticipantRetrieveParticipantsResponse.Participant>;
+  participants?: Array<ParticipantResource>;
 
   /**
    * The number of the first element on the page, zero-indexed.
@@ -389,85 +312,6 @@ export interface ParticipantRetrieveParticipantsResponse {
   uri?: string;
 }
 
-export namespace ParticipantRetrieveParticipantsResponse {
-  export interface Participant {
-    /**
-     * The id of the account the resource belongs to.
-     */
-    account_sid?: string;
-
-    /**
-     * The version of the API that was used to make the request.
-     */
-    api_version?: string;
-
-    /**
-     * The identifier of this participant's call.
-     */
-    call_sid?: string;
-
-    /**
-     * The identifier of this participant's call.
-     */
-    call_sid_legacy?: string;
-
-    /**
-     * Whether the participant is coaching another call.
-     */
-    coaching?: boolean;
-
-    /**
-     * The identifier of the coached participant's call.
-     */
-    coaching_call_sid?: string;
-
-    /**
-     * The identifier of the coached participant's call.
-     */
-    coaching_call_sid_legacy?: string;
-
-    /**
-     * The unique identifier for the conference.
-     */
-    conference_sid?: string;
-
-    /**
-     * The timestamp of when the resource was created.
-     */
-    date_created?: string;
-
-    /**
-     * The timestamp of when the resource was last updated.
-     */
-    date_updated?: string;
-
-    /**
-     * Whether the conference ends when the participant leaves.
-     */
-    end_conference_on_exit?: boolean;
-
-    /**
-     * Whether the participant is on hold.
-     */
-    hold?: boolean;
-
-    /**
-     * Whether the participant is muted.
-     */
-    muted?: boolean;
-
-    /**
-     * The status of the participant's call in the conference.
-     */
-    status?: 'connecting' | 'connected' | 'completed';
-
-    /**
-     * The relative URI for this participant.
-     */
-    uri?: string;
-  }
-}
-
 export interface ParticipantRetrieveParams {
   /**
    * The id of the account the resource belongs to.
@@ -892,8 +736,7 @@ export interface ParticipantRetrieveParticipantsParams {
 
 export declare namespace Participants {
   export {
-    type ParticipantRetrieveResponse as ParticipantRetrieveResponse,
-    type ParticipantUpdateResponse as ParticipantUpdateResponse,
+    type ParticipantResource as ParticipantResource,
     type ParticipantParticipantsResponse as ParticipantParticipantsResponse,
     type ParticipantRetrieveParticipantsResponse as ParticipantRetrieveParticipantsResponse,
     type ParticipantRetrieveParams as ParticipantRetrieveParams,

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

@@ -4,16 +4,14 @@ export {
   Accounts,
   type TexmlGetCallRecordingResponseBody,
   type TexmlRecordingSubresourcesUris,
-  type AccountRetrieveRecordingsJsonResponse,
   type AccountRetrieveTranscriptionsJsonResponse,
   type AccountRetrieveRecordingsJsonParams,
   type AccountRetrieveTranscriptionsJsonParams,
 } from './accounts';
 export {
   Calls,
+  type CallResource,
   type UpdateCall,
-  type CallRetrieveResponse,
-  type CallUpdateResponse,
   type CallCallsResponse,
   type CallRetrieveCallsResponse,
   type CallSiprecJsonResponse,
@@ -27,11 +25,9 @@ export {
 } from './calls/index';
 export {
   Conferences,
-  type ConferenceRetrieveResponse,
-  type ConferenceUpdateResponse,
+  type ConferenceResource,
   type ConferenceRetrieveConferencesResponse,
   type ConferenceRetrieveRecordingsResponse,
-  type ConferenceRetrieveRecordingsJsonResponse,
   type ConferenceRetrieveParams,
   type ConferenceUpdateParams,
   type ConferenceRetrieveConferencesParams,
@@ -40,16 +36,13 @@ export {
 } from './conferences/index';
 export {
   Queues,
-  type QueueCreateResponse,
-  type QueueRetrieveResponse,
-  type QueueUpdateResponse,
-  type QueueListResponse,
+  type QueueResource,
   type QueueCreateParams,
   type QueueRetrieveParams,
   type QueueUpdateParams,
   type QueueListParams,
   type QueueDeleteParams,
-  type QueueListResponsesDefaultPaginationForQueues,
+  type QueueResourcesDefaultPaginationForQueues,
 } from './queues';
 export { Recordings } from './recordings/index';
 export { Transcriptions } from './transcriptions/index';

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

@@ -20,16 +20,11 @@ export class Queues extends APIResource {
    *
    * @example
    * ```ts
-   * const queue = await client.texml.accounts.queues.create(
-   *   'account_sid',
-   * );
+   * const queueResource =
+   *   await client.texml.accounts.queues.create('account_sid');
    * ```
    */
-  create(
-    accountSid: string,
-    body: QueueCreateParams,
-    options?: RequestOptions,
-  ): APIPromise<QueueCreateResponse> {
+  create(accountSid: string, body: QueueCreateParams, options?: RequestOptions): APIPromise<QueueResource> {
     return this._client.post(path`/texml/Accounts/${accountSid}/Queues`, {
       body,
       ...options,
@@ -42,17 +37,17 @@ export class Queues extends APIResource {
    *
    * @example
    * ```ts
-   * const queue = await client.texml.accounts.queues.retrieve(
-   *   'queue_sid',
-   *   { account_sid: 'account_sid' },
-   * );
+   * const queueResource =
+   *   await client.texml.accounts.queues.retrieve('queue_sid', {
+   *     account_sid: 'account_sid',
+   *   });
    * ```
    */
   retrieve(
     queueSid: string,
     params: QueueRetrieveParams,
     options?: RequestOptions,
-  ): APIPromise<QueueRetrieveResponse> {
+  ): APIPromise<QueueResource> {
     const { account_sid } = params;
     return this._client.get(path`/texml/Accounts/${account_sid}/Queues/${queueSid}`, options);
   }
@@ -62,17 +57,13 @@ export class Queues extends APIResource {
    *
    * @example
    * ```ts
-   * const queue = await client.texml.accounts.queues.update(
-   *   'queue_sid',
-   *   { account_sid: 'account_sid' },
-   * );
+   * const queueResource =
+   *   await client.texml.accounts.queues.update('queue_sid', {
+   *     account_sid: 'account_sid',
+   *   });
    * ```
    */
-  update(
-    queueSid: string,
-    params: QueueUpdateParams,
-    options?: RequestOptions,
-  ): APIPromise<QueueUpdateResponse> {
+  update(queueSid: string, params: QueueUpdateParams, options?: RequestOptions): APIPromise<QueueResource> {
     const { account_sid, ...body } = params;
     return this._client.post(path`/texml/Accounts/${account_sid}/Queues/${queueSid}`, {
       body,
@@ -87,7 +78,7 @@ export class Queues extends APIResource {
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
-   * for await (const queueListResponse of client.texml.accounts.queues.list(
+   * for await (const queueResource of client.texml.accounts.queues.list(
    *   'account_sid',
    * )) {
    *   // ...
@@ -98,10 +89,10 @@ export class Queues extends APIResource {
     accountSid: string,
     query: QueueListParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<QueueListResponsesDefaultPaginationForQueues, QueueListResponse> {
+  ): PagePromise<QueueResourcesDefaultPaginationForQueues, QueueResource> {
     return this._client.getAPIList(
       path`/texml/Accounts/${accountSid}/Queues`,
-      DefaultPaginationForQueues<QueueListResponse>,
+      DefaultPaginationForQueues<QueueResource>,
       { query, ...options },
     );
   }
@@ -125,150 +116,9 @@ export class Queues extends APIResource {
   }
 }
 
-export type QueueListResponsesDefaultPaginationForQueues = DefaultPaginationForQueues<QueueListResponse>;
-
-export interface QueueCreateResponse {
-  /**
-   * The id of the account the resource belongs to.
-   */
-  account_sid?: string;
-
-  /**
-   * The average wait time in seconds for members in the queue.
-   */
-  average_wait_time?: number;
-
-  /**
-   * The current number of members in the queue.
-   */
-  current_size?: number;
-
-  /**
-   * The timestamp of when the resource was created.
-   */
-  date_created?: string;
-
-  /**
-   * The timestamp of when the resource was last updated.
-   */
-  date_updated?: string;
-
-  /**
-   * The maximum size of the queue.
-   */
-  max_size?: number;
-
-  /**
-   * The unique identifier of the queue.
-   */
-  sid?: string;
-
-  /**
-   * A list of related resources identified by their relative URIs.
-   */
-  subresource_uris?: { [key: string]: unknown };
-
-  /**
-   * The relative URI for this queue.
-   */
-  uri?: string;
-}
-
-export interface QueueRetrieveResponse {
-  /**
-   * The id of the account the resource belongs to.
-   */
-  account_sid?: string;
-
-  /**
-   * The average wait time in seconds for members in the queue.
-   */
-  average_wait_time?: number;
-
-  /**
-   * The current number of members in the queue.
-   */
-  current_size?: number;
-
-  /**
-   * The timestamp of when the resource was created.
-   */
-  date_created?: string;
-
-  /**
-   * The timestamp of when the resource was last updated.
-   */
-  date_updated?: string;
-
-  /**
-   * The maximum size of the queue.
-   */
-  max_size?: number;
-
-  /**
-   * The unique identifier of the queue.
-   */
-  sid?: string;
-
-  /**
-   * A list of related resources identified by their relative URIs.
-   */
-  subresource_uris?: { [key: string]: unknown };
-
-  /**
-   * The relative URI for this queue.
-   */
-  uri?: string;
-}
-
-export interface QueueUpdateResponse {
-  /**
-   * The id of the account the resource belongs to.
-   */
-  account_sid?: string;
-
-  /**
-   * The average wait time in seconds for members in the queue.
-   */
-  average_wait_time?: number;
-
-  /**
-   * The current number of members in the queue.
-   */
-  current_size?: number;
-
-  /**
-   * The timestamp of when the resource was created.
-   */
-  date_created?: string;
-
-  /**
-   * The timestamp of when the resource was last updated.
-   */
-  date_updated?: string;
-
-  /**
-   * The maximum size of the queue.
-   */
-  max_size?: number;
-
-  /**
-   * The unique identifier of the queue.
-   */
-  sid?: string;
-
-  /**
-   * A list of related resources identified by their relative URIs.
-   */
-  subresource_uris?: { [key: string]: unknown };
-
-  /**
-   * The relative URI for this queue.
-   */
-  uri?: string;
-}
+export type QueueResourcesDefaultPaginationForQueues = DefaultPaginationForQueues<QueueResource>;
 
-export interface QueueListResponse {
+export interface QueueResource {
   /**
    * The id of the account the resource belongs to.
    */
@@ -374,11 +224,8 @@ export interface QueueDeleteParams {
 
 export declare namespace Queues {
   export {
-    type QueueCreateResponse as QueueCreateResponse,
-    type QueueRetrieveResponse as QueueRetrieveResponse,
-    type QueueUpdateResponse as QueueUpdateResponse,
-    type QueueListResponse as QueueListResponse,
-    type QueueListResponsesDefaultPaginationForQueues as QueueListResponsesDefaultPaginationForQueues,
+    type QueueResource as QueueResource,
+    type QueueResourcesDefaultPaginationForQueues as QueueResourcesDefaultPaginationForQueues,
     type QueueCreateParams as QueueCreateParams,
     type QueueRetrieveParams as QueueRetrieveParams,
     type QueueUpdateParams as QueueUpdateParams,

package/src/resources/texml/accounts/transcriptions/index.ts

@@ -2,7 +2,7 @@
 
 export {
   Json,
-  type JsonRetrieveRecordingTranscriptionSidJsonResponse,
+  type TexmlRecordingTranscription,
   type JsonDeleteRecordingTranscriptionSidJsonParams,
   type JsonRetrieveRecordingTranscriptionSidJsonParams,
 } from './json';

package/src/resources/texml/accounts/transcriptions/json.ts

@@ -38,7 +38,7 @@ export class Json extends APIResource {
    *
    * @example
    * ```ts
-   * const response =
+   * const texmlRecordingTranscription =
    *   await client.texml.accounts.transcriptions.json.retrieveRecordingTranscriptionSidJson(
    *     '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
    *     { account_sid: 'account_sid' },
@@ -49,7 +49,7 @@ export class Json extends APIResource {
     recordingTranscriptionSid: string,
     params: JsonRetrieveRecordingTranscriptionSidJsonParams,
     options?: RequestOptions,
-  ): APIPromise<JsonRetrieveRecordingTranscriptionSidJsonResponse> {
+  ): APIPromise<TexmlRecordingTranscription> {
     const { account_sid } = params;
     return this._client.get(
       path`/texml/Accounts/${account_sid}/Transcriptions/${recordingTranscriptionSid}.json`,
@@ -58,7 +58,7 @@ export class Json extends APIResource {
   }
 }
 
-export interface JsonRetrieveRecordingTranscriptionSidJsonResponse {
+export interface TexmlRecordingTranscription {
   account_sid?: string;
 
   /**
@@ -120,7 +120,7 @@ export interface JsonRetrieveRecordingTranscriptionSidJsonParams {
 
 export declare namespace Json {
   export {
-    type JsonRetrieveRecordingTranscriptionSidJsonResponse as JsonRetrieveRecordingTranscriptionSidJsonResponse,
+    type TexmlRecordingTranscription as TexmlRecordingTranscription,
     type JsonDeleteRecordingTranscriptionSidJsonParams as JsonDeleteRecordingTranscriptionSidJsonParams,
     type JsonRetrieveRecordingTranscriptionSidJsonParams as JsonRetrieveRecordingTranscriptionSidJsonParams,
   };

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

@@ -6,7 +6,7 @@ import {
   Json,
   JsonDeleteRecordingTranscriptionSidJsonParams,
   JsonRetrieveRecordingTranscriptionSidJsonParams,
-  JsonRetrieveRecordingTranscriptionSidJsonResponse,
+  TexmlRecordingTranscription,
 } from './json';
 
 export class Transcriptions extends APIResource {
@@ -18,7 +18,7 @@ Transcriptions.Json = Json;
 export declare namespace Transcriptions {
   export {
     Json as Json,
-    type JsonRetrieveRecordingTranscriptionSidJsonResponse as JsonRetrieveRecordingTranscriptionSidJsonResponse,
+    type TexmlRecordingTranscription as TexmlRecordingTranscription,
     type JsonDeleteRecordingTranscriptionSidJsonParams as JsonDeleteRecordingTranscriptionSidJsonParams,
     type JsonRetrieveRecordingTranscriptionSidJsonParams as JsonRetrieveRecordingTranscriptionSidJsonParams,
   };

package/src/resources/texml/index.ts

@@ -4,7 +4,6 @@ export {
   Accounts,
   type TexmlGetCallRecordingResponseBody,
   type TexmlRecordingSubresourcesUris,
-  type AccountRetrieveRecordingsJsonResponse,
   type AccountRetrieveTranscriptionsJsonResponse,
   type AccountRetrieveRecordingsJsonParams,
   type AccountRetrieveTranscriptionsJsonParams,

package/src/resources/texml/texml.ts

@@ -4,7 +4,6 @@ import { APIResource } from '../../core/resource';
 import * as AccountsAPI from './accounts/accounts';
 import {
   AccountRetrieveRecordingsJsonParams,
-  AccountRetrieveRecordingsJsonResponse,
   AccountRetrieveTranscriptionsJsonParams,
   AccountRetrieveTranscriptionsJsonResponse,
   Accounts,
@@ -380,7 +379,6 @@ export declare namespace Texml {
     Accounts as Accounts,
     type TexmlGetCallRecordingResponseBody as TexmlGetCallRecordingResponseBody,
     type TexmlRecordingSubresourcesUris as TexmlRecordingSubresourcesUris,
-    type AccountRetrieveRecordingsJsonResponse as AccountRetrieveRecordingsJsonResponse,
     type AccountRetrieveTranscriptionsJsonResponse as AccountRetrieveTranscriptionsJsonResponse,
     type AccountRetrieveRecordingsJsonParams as AccountRetrieveRecordingsJsonParams,
     type AccountRetrieveTranscriptionsJsonParams as AccountRetrieveTranscriptionsJsonParams,

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

@@ -2,14 +2,13 @@
 
 export {
   TextToSpeech,
-  type TextToSpeechCreateSpeechResponse,
+  type TextToSpeechGenerateSpeechResponse,
   type TextToSpeechListVoicesResponse,
   type StreamClientEvent,
   type StreamServerEvent,
-  type TextToSpeechCreateSpeechParams,
   type TextToSpeechGenerateSpeechParams,
   type TextToSpeechListVoicesParams,
-  type TextToSpeechStreamParams,
+  type TextToSpeechRetrieveSpeechParams,
 } from './text-to-speech';
-export { TextToSpeechWS, type TextToSpeechWSClientOptions } from './ws';
+export { type TextToSpeechWSClientOptions } from './ws';
 export { type TextToSpeechWSReconnectOptions } from './ws-base';