telnyx 7.3.0 → 7.5.0

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

@@ -11,61 +11,52 @@ import { path } from '../../../../internal/utils/path';
  */
 export class Participants extends APIResource {
   /**
-   * Gets conference participant resource
+   * Lists conference participants
    *
    * @example
    * ```ts
-   * const participantResource =
-   *   await client.texml.accounts.conferences.participants.retrieve(
-   *     'call_sid_or_participant_label',
-   *     {
-   *       account_sid: 'account_sid',
-   *       conference_sid: 'conference_sid',
-   *     },
+   * const response =
+   *   await client.texml.accounts.conferences.participants.retrieveParticipants(
+   *     'conference_sid',
+   *     { account_sid: 'account_sid' },
    *   );
    * ```
    */
-  retrieve(
-    callSidOrParticipantLabel: string,
-    params: ParticipantRetrieveParams,
+  retrieveParticipants(
+    conferenceSid: string,
+    params: ParticipantRetrieveParticipantsParams,
     options?: RequestOptions,
-  ): APIPromise<ParticipantResource> {
-    const { account_sid, conference_sid } = params;
+  ): APIPromise<ParticipantRetrieveParticipantsResponse> {
+    const { account_sid } = params;
     return this._client.get(
-      path`/texml/Accounts/${account_sid}/Conferences/${conference_sid}/Participants/${callSidOrParticipantLabel}`,
+      path`/texml/Accounts/${account_sid}/Conferences/${conferenceSid}/Participants`,
       options,
     );
   }
 
   /**
-   * Updates a conference participant
+   * Dials a new conference participant
    *
    * @example
    * ```ts
-   * const participantResource =
-   *   await client.texml.accounts.conferences.participants.update(
-   *     'call_sid_or_participant_label',
-   *     {
-   *       account_sid: 'account_sid',
-   *       conference_sid: 'conference_sid',
-   *     },
+   * const response =
+   *   await client.texml.accounts.conferences.participants.participants(
+   *     'conference_sid',
+   *     { account_sid: 'account_sid' },
    *   );
    * ```
    */
-  update(
-    callSidOrParticipantLabel: string,
-    params: ParticipantUpdateParams,
+  participants(
+    conferenceSid: string,
+    params: ParticipantParticipantsParams,
     options?: RequestOptions,
-  ): APIPromise<ParticipantResource> {
-    const { account_sid, conference_sid, ...body } = params;
-    return this._client.post(
-      path`/texml/Accounts/${account_sid}/Conferences/${conference_sid}/Participants/${callSidOrParticipantLabel}`,
-      {
-        body,
-        ...options,
-        headers: buildHeaders([{ 'Content-Type': 'application/x-www-form-urlencoded' }, options?.headers]),
-      },
-    );
+  ): APIPromise<ParticipantParticipantsResponse> {
+    const { account_sid, timeout_seconds, ...body } = params;
+    return this._client.post(path`/texml/Accounts/${account_sid}/Conferences/${conferenceSid}/Participants`, {
+      body: { Timeout: timeout_seconds, ...body },
+      ...options,
+      headers: buildHeaders([{ 'Content-Type': 'application/x-www-form-urlencoded' }, options?.headers]),
+    });
   }
 
   /**
@@ -95,51 +86,60 @@ export class Participants extends APIResource {
   }
 
   /**
-   * Dials a new conference participant
+   * Gets conference participant resource
    *
    * @example
    * ```ts
-   * const response =
-   *   await client.texml.accounts.conferences.participants.participants(
-   *     'conference_sid',
-   *     { account_sid: 'account_sid' },
+   * const participantResource =
+   *   await client.texml.accounts.conferences.participants.retrieve(
+   *     'call_sid_or_participant_label',
+   *     {
+   *       account_sid: 'account_sid',
+   *       conference_sid: 'conference_sid',
+   *     },
    *   );
    * ```
    */
-  participants(
-    conferenceSid: string,
-    params: ParticipantParticipantsParams,
+  retrieve(
+    callSidOrParticipantLabel: string,
+    params: ParticipantRetrieveParams,
     options?: RequestOptions,
-  ): APIPromise<ParticipantParticipantsResponse> {
-    const { account_sid, timeout_seconds, ...body } = params;
-    return this._client.post(path`/texml/Accounts/${account_sid}/Conferences/${conferenceSid}/Participants`, {
-      body: { Timeout: timeout_seconds, ...body },
-      ...options,
-      headers: buildHeaders([{ 'Content-Type': 'application/x-www-form-urlencoded' }, options?.headers]),
-    });
+  ): APIPromise<ParticipantResource> {
+    const { account_sid, conference_sid } = params;
+    return this._client.get(
+      path`/texml/Accounts/${account_sid}/Conferences/${conference_sid}/Participants/${callSidOrParticipantLabel}`,
+      options,
+    );
   }
 
   /**
-   * Lists conference participants
+   * Updates a conference participant
    *
    * @example
    * ```ts
-   * const response =
-   *   await client.texml.accounts.conferences.participants.retrieveParticipants(
-   *     'conference_sid',
-   *     { account_sid: 'account_sid' },
+   * const participantResource =
+   *   await client.texml.accounts.conferences.participants.update(
+   *     'call_sid_or_participant_label',
+   *     {
+   *       account_sid: 'account_sid',
+   *       conference_sid: 'conference_sid',
+   *     },
    *   );
    * ```
    */
-  retrieveParticipants(
-    conferenceSid: string,
-    params: ParticipantRetrieveParticipantsParams,
+  update(
+    callSidOrParticipantLabel: string,
+    params: ParticipantUpdateParams,
     options?: RequestOptions,
-  ): APIPromise<ParticipantRetrieveParticipantsResponse> {
-    const { account_sid } = params;
-    return this._client.get(
-      path`/texml/Accounts/${account_sid}/Conferences/${conferenceSid}/Participants`,
-      options,
+  ): APIPromise<ParticipantResource> {
+    const { account_sid, conference_sid, ...body } = params;
+    return this._client.post(
+      path`/texml/Accounts/${account_sid}/Conferences/${conference_sid}/Participants/${callSidOrParticipantLabel}`,
+      {
+        body,
+        ...options,
+        headers: buildHeaders([{ 'Content-Type': 'application/x-www-form-urlencoded' }, options?.headers]),
+      },
     );
   }
 }
@@ -312,105 +312,11 @@ export interface ParticipantRetrieveParticipantsResponse {
   uri?: string;
 }
 
-export interface ParticipantRetrieveParams {
-  /**
-   * The id of the account the resource belongs to.
-   */
-  account_sid: string;
-
-  /**
-   * The ConferenceSid that uniquely identifies a conference.
-   */
-  conference_sid: string;
-}
-
-export interface ParticipantUpdateParams {
-  /**
-   * Path param: The id of the account the resource belongs to.
-   */
-  account_sid: string;
-
-  /**
-   * Path param: The ConferenceSid that uniquely identifies a conference.
-   */
-  conference_sid: string;
-
-  /**
-   * Body param: The HTTP method used to call the `AnnounceUrl`. Defaults to `POST`.
-   */
-  AnnounceMethod?: 'GET' | 'POST';
-
-  /**
-   * Body param: The URL to call to announce something to the participant. The URL
-   * may return an MP3 fileo a WAV file, or a TwiML document that contains `<Play>`,
-   * `<Say>`, `<Pause>`, or `<Redirect>` verbs.
-   */
-  AnnounceUrl?: string;
-
-  /**
-   * Body param: Whether to play a notification beep to the conference when the
-   * participant exits.
-   */
-  BeepOnExit?: boolean;
-
-  /**
-   * Body param: The SID of the participant who is being coached. The participant
-   * being coached is the only participant who can hear the participant who is
-   * coaching.
-   */
-  CallSidToCoach?: string;
-
-  /**
-   * Body param: Whether the participant is coaching another call. When `true`,
-   * `CallSidToCoach` has to be given.
-   */
-  Coaching?: boolean;
-
-  /**
-   * Body param: Whether to end the conference when the participant leaves.
-   */
-  EndConferenceOnExit?: boolean;
-
-  /**
-   * Body param: Whether the participant should be on hold.
-   */
-  Hold?: boolean;
-
-  /**
-   * Body param: The HTTP method to use when calling the `HoldUrl`.
-   */
-  HoldMethod?: 'GET' | 'POST';
-
-  /**
-   * Body param: The URL to be called using the `HoldMethod` for music that plays
-   * when the participant is on hold. The URL may return an MP3 file, a WAV file, or
-   * a TwiML document that contains `<Play>`, `<Say>`, `<Pause>`, or `<Redirect>`
-   * verbs.
-   */
-  HoldUrl?: string;
-
-  /**
-   * Body param: Whether the participant should be muted.
-   */
-  Muted?: boolean;
-
-  /**
-   * Body param: The URL to call for an audio file to play while the participant is
-   * waiting for the conference to start.
-   */
-  WaitUrl?: string;
-}
-
-export interface ParticipantDeleteParams {
+export interface ParticipantRetrieveParticipantsParams {
   /**
    * The id of the account the resource belongs to.
    */
   account_sid: string;
-
-  /**
-   * The ConferenceSid that uniquely identifies a conference.
-   */
-  conference_sid: string;
 }
 
 export interface ParticipantParticipantsParams {
@@ -727,11 +633,105 @@ export namespace ParticipantParticipantsParams {
   }
 }
 
-export interface ParticipantRetrieveParticipantsParams {
+export interface ParticipantDeleteParams {
+  /**
+   * The id of the account the resource belongs to.
+   */
+  account_sid: string;
+
+  /**
+   * The ConferenceSid that uniquely identifies a conference.
+   */
+  conference_sid: string;
+}
+
+export interface ParticipantRetrieveParams {
   /**
    * The id of the account the resource belongs to.
    */
   account_sid: string;
+
+  /**
+   * The ConferenceSid that uniquely identifies a conference.
+   */
+  conference_sid: string;
+}
+
+export interface ParticipantUpdateParams {
+  /**
+   * Path param: The id of the account the resource belongs to.
+   */
+  account_sid: string;
+
+  /**
+   * Path param: The ConferenceSid that uniquely identifies a conference.
+   */
+  conference_sid: string;
+
+  /**
+   * Body param: The HTTP method used to call the `AnnounceUrl`. Defaults to `POST`.
+   */
+  AnnounceMethod?: 'GET' | 'POST';
+
+  /**
+   * Body param: The URL to call to announce something to the participant. The URL
+   * may return an MP3 fileo a WAV file, or a TwiML document that contains `<Play>`,
+   * `<Say>`, `<Pause>`, or `<Redirect>` verbs.
+   */
+  AnnounceUrl?: string;
+
+  /**
+   * Body param: Whether to play a notification beep to the conference when the
+   * participant exits.
+   */
+  BeepOnExit?: boolean;
+
+  /**
+   * Body param: The SID of the participant who is being coached. The participant
+   * being coached is the only participant who can hear the participant who is
+   * coaching.
+   */
+  CallSidToCoach?: string;
+
+  /**
+   * Body param: Whether the participant is coaching another call. When `true`,
+   * `CallSidToCoach` has to be given.
+   */
+  Coaching?: boolean;
+
+  /**
+   * Body param: Whether to end the conference when the participant leaves.
+   */
+  EndConferenceOnExit?: boolean;
+
+  /**
+   * Body param: Whether the participant should be on hold.
+   */
+  Hold?: boolean;
+
+  /**
+   * Body param: The HTTP method to use when calling the `HoldUrl`.
+   */
+  HoldMethod?: 'GET' | 'POST';
+
+  /**
+   * Body param: The URL to be called using the `HoldMethod` for music that plays
+   * when the participant is on hold. The URL may return an MP3 file, a WAV file, or
+   * a TwiML document that contains `<Play>`, `<Say>`, `<Pause>`, or `<Redirect>`
+   * verbs.
+   */
+  HoldUrl?: string;
+
+  /**
+   * Body param: Whether the participant should be muted.
+   */
+  Muted?: boolean;
+
+  /**
+   * Body param: The URL to call for an audio file to play while the participant is
+   * waiting for the conference to start.
+   */
+  WaitUrl?: string;
 }
 
 export declare namespace Participants {
@@ -739,10 +739,10 @@ export declare namespace Participants {
     type ParticipantResource as ParticipantResource,
     type ParticipantParticipantsResponse as ParticipantParticipantsResponse,
     type ParticipantRetrieveParticipantsResponse as ParticipantRetrieveParticipantsResponse,
+    type ParticipantRetrieveParticipantsParams as ParticipantRetrieveParticipantsParams,
+    type ParticipantParticipantsParams as ParticipantParticipantsParams,
+    type ParticipantDeleteParams as ParticipantDeleteParams,
     type ParticipantRetrieveParams as ParticipantRetrieveParams,
     type ParticipantUpdateParams as ParticipantUpdateParams,
-    type ParticipantDeleteParams as ParticipantDeleteParams,
-    type ParticipantParticipantsParams as ParticipantParticipantsParams,
-    type ParticipantRetrieveParticipantsParams as ParticipantRetrieveParticipantsParams,
   };
 }

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

@@ -16,10 +16,10 @@ export {
   type CallRetrieveCallsResponse,
   type CallSiprecJsonResponse,
   type CallStreamsJsonResponse,
+  type CallRetrieveCallsParams,
+  type CallCallsParams,
   type CallRetrieveParams,
   type CallUpdateParams,
-  type CallCallsParams,
-  type CallRetrieveCallsParams,
   type CallSiprecJsonParams,
   type CallStreamsJsonParams,
 } from './calls/index';
@@ -28,9 +28,9 @@ export {
   type ConferenceResource,
   type ConferenceRetrieveConferencesResponse,
   type ConferenceRetrieveRecordingsResponse,
+  type ConferenceRetrieveConferencesParams,
   type ConferenceRetrieveParams,
   type ConferenceUpdateParams,
-  type ConferenceRetrieveConferencesParams,
   type ConferenceRetrieveRecordingsParams,
   type ConferenceRetrieveRecordingsJsonParams,
 } from './conferences/index';
@@ -38,10 +38,10 @@ export {
   Queues,
   type QueueResource,
   type QueueCreateParams,
+  type QueueDeleteParams,
   type QueueRetrieveParams,
   type QueueUpdateParams,
   type QueueListParams,
-  type QueueDeleteParams,
   type QueueResourcesDefaultPaginationForQueues,
 } from './queues';
 export { Recordings } from './recordings/index';

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

@@ -32,6 +32,24 @@ export class Queues extends APIResource {
     });
   }
 
+  /**
+   * Delete a queue resource.
+   *
+   * @example
+   * ```ts
+   * await client.texml.accounts.queues.delete('queue_sid', {
+   *   account_sid: 'account_sid',
+   * });
+   * ```
+   */
+  delete(queueSid: string, params: QueueDeleteParams, options?: RequestOptions): APIPromise<void> {
+    const { account_sid } = params;
+    return this._client.delete(path`/texml/Accounts/${account_sid}/Queues/${queueSid}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
   /**
    * Returns a queue resource.
    *
@@ -96,24 +114,6 @@ export class Queues extends APIResource {
       { query, ...options },
     );
   }
-
-  /**
-   * Delete a queue resource.
-   *
-   * @example
-   * ```ts
-   * await client.texml.accounts.queues.delete('queue_sid', {
-   *   account_sid: 'account_sid',
-   * });
-   * ```
-   */
-  delete(queueSid: string, params: QueueDeleteParams, options?: RequestOptions): APIPromise<void> {
-    const { account_sid } = params;
-    return this._client.delete(path`/texml/Accounts/${account_sid}/Queues/${queueSid}`, {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
-  }
 }
 
 export type QueueResourcesDefaultPaginationForQueues = DefaultPaginationForQueues<QueueResource>;
@@ -177,6 +177,13 @@ export interface QueueCreateParams {
   MaxSize?: number;
 }
 
+export interface QueueDeleteParams {
+  /**
+   * The id of the account the resource belongs to.
+   */
+  account_sid: string;
+}
+
 export interface QueueRetrieveParams {
   /**
    * The id of the account the resource belongs to.
@@ -215,21 +222,14 @@ export interface QueueListParams extends DefaultPaginationForQueuesParams {
   PageToken?: string;
 }
 
-export interface QueueDeleteParams {
-  /**
-   * The id of the account the resource belongs to.
-   */
-  account_sid: string;
-}
-
 export declare namespace Queues {
   export {
     type QueueResource as QueueResource,
     type QueueResourcesDefaultPaginationForQueues as QueueResourcesDefaultPaginationForQueues,
     type QueueCreateParams as QueueCreateParams,
+    type QueueDeleteParams as QueueDeleteParams,
     type QueueRetrieveParams as QueueRetrieveParams,
     type QueueUpdateParams as QueueUpdateParams,
     type QueueListParams as QueueListParams,
-    type QueueDeleteParams as QueueDeleteParams,
   };
 }

package/src/resources/texml/index.ts

@@ -12,6 +12,6 @@ export {
   Texml,
   type TexmlInitiateAICallResponse,
   type TexmlSecretsResponse,
-  type TexmlInitiateAICallParams,
   type TexmlSecretsParams,
+  type TexmlInitiateAICallParams,
 } from './texml';

package/src/resources/texml/texml.ts

@@ -20,6 +20,25 @@ import { path } from '../../internal/utils/path';
 export class Texml extends APIResource {
   accounts: AccountsAPI.Accounts = new AccountsAPI.Accounts(this._client);
 
+  /**
+   * Create a TeXML secret which can be later used as a Dynamic Parameter for TeXML
+   * when using Mustache Templates in your TeXML. In your TeXML you will be able to
+   * use your secret name, and this name will be replaced by the actual secret value
+   * when processing the TeXML on Telnyx side. The secrets are not visible in any
+   * logs.
+   *
+   * @example
+   * ```ts
+   * const response = await client.texml.secrets({
+   *   name: 'My Secret Name',
+   *   value: 'My Secret Value',
+   * });
+   * ```
+   */
+  secrets(body: TexmlSecretsParams, options?: RequestOptions): APIPromise<TexmlSecretsResponse> {
+    return this._client.post('/texml/secrets', { body, ...options });
+  }
+
   /**
    * Initiate an outbound AI call with warm-up support. Validates parameters, builds
    * an internal TeXML with an AI Assistant configuration, encodes instructions into
@@ -60,25 +79,6 @@ export class Texml extends APIResource {
       ...options,
     });
   }
-
-  /**
-   * Create a TeXML secret which can be later used as a Dynamic Parameter for TeXML
-   * when using Mustache Templates in your TeXML. In your TeXML you will be able to
-   * use your secret name, and this name will be replaced by the actual secret value
-   * when processing the TeXML on Telnyx side. The secrets are not visible in any
-   * logs.
-   *
-   * @example
-   * ```ts
-   * const response = await client.texml.secrets({
-   *   name: 'My Secret Name',
-   *   value: 'My Secret Value',
-   * });
-   * ```
-   */
-  secrets(body: TexmlSecretsParams, options?: RequestOptions): APIPromise<TexmlSecretsResponse> {
-    return this._client.post('/texml/secrets', { body, ...options });
-  }
 }
 
 export interface TexmlInitiateAICallResponse {
@@ -103,6 +103,19 @@ export namespace TexmlSecretsResponse {
   }
 }
 
+export interface TexmlSecretsParams {
+  /**
+   * Name used as a reference for the secret, if the name already exists within the
+   * account its value will be replaced
+   */
+  name: string;
+
+  /**
+   * Secret value which will be used when rendering the TeXML template
+   */
+  value: string;
+}
+
 export interface TexmlInitiateAICallParams {
   /**
    * The ID of the AI assistant to use for the call.
@@ -352,27 +365,14 @@ export namespace TexmlInitiateAICallParams {
   }
 }
 
-export interface TexmlSecretsParams {
-  /**
-   * Name used as a reference for the secret, if the name already exists within the
-   * account its value will be replaced
-   */
-  name: string;
-
-  /**
-   * Secret value which will be used when rendering the TeXML template
-   */
-  value: string;
-}
-
 Texml.Accounts = Accounts;
 
 export declare namespace Texml {
   export {
     type TexmlInitiateAICallResponse as TexmlInitiateAICallResponse,
     type TexmlSecretsResponse as TexmlSecretsResponse,
-    type TexmlInitiateAICallParams as TexmlInitiateAICallParams,
     type TexmlSecretsParams as TexmlSecretsParams,
+    type TexmlInitiateAICallParams as TexmlInitiateAICallParams,
   };
 
   export {