telnyx 7.2.0 → 7.5.0

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

@@ -32,41 +32,23 @@ export class Calls extends APIResource {
   streams: StreamsAPI.Streams = new StreamsAPI.Streams(this._client);
 
   /**
-   * Returns an individual call identified by its CallSid. This endpoint is
-   * eventually consistent.
-   *
-   * @example
-   * ```ts
-   * const callResource =
-   *   await client.texml.accounts.calls.retrieve('call_sid', {
-   *     account_sid: 'account_sid',
-   *   });
-   * ```
-   */
-  retrieve(callSid: string, params: CallRetrieveParams, options?: RequestOptions): APIPromise<CallResource> {
-    const { account_sid } = params;
-    return this._client.get(path`/texml/Accounts/${account_sid}/Calls/${callSid}`, options);
-  }
-
-  /**
-   * Update TeXML call. Please note that the keys present in the payload MUST BE
-   * formatted in CamelCase as specified in the example.
+   * Returns multiple call resouces for an account. This endpoint is eventually
+   * consistent.
    *
    * @example
    * ```ts
-   * const callResource =
-   *   await client.texml.accounts.calls.update('call_sid', {
-   *     account_sid: 'account_sid',
-   *   });
+   * const response =
+   *   await client.texml.accounts.calls.retrieveCalls(
+   *     'account_sid',
+   *   );
    * ```
    */
-  update(callSid: string, params: CallUpdateParams, options?: RequestOptions): APIPromise<CallResource> {
-    const { account_sid, ...body } = params;
-    return this._client.post(path`/texml/Accounts/${account_sid}/Calls/${callSid}`, {
-      body,
-      ...options,
-      headers: buildHeaders([{ 'Content-Type': 'application/x-www-form-urlencoded' }, options?.headers]),
-    });
+  retrieveCalls(
+    accountSid: string,
+    query: CallRetrieveCallsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CallRetrieveCallsResponse> {
+    return this._client.get(path`/texml/Accounts/${accountSid}/Calls`, { query, ...options });
   }
 
   /**
@@ -94,23 +76,41 @@ export class Calls extends APIResource {
   }
 
   /**
-   * Returns multiple call resouces for an account. This endpoint is eventually
-   * consistent.
+   * Returns an individual call identified by its CallSid. This endpoint is
+   * eventually consistent.
    *
    * @example
    * ```ts
-   * const response =
-   *   await client.texml.accounts.calls.retrieveCalls(
-   *     'account_sid',
-   *   );
+   * const callResource =
+   *   await client.texml.accounts.calls.retrieve('call_sid', {
+   *     account_sid: 'account_sid',
+   *   });
    * ```
    */
-  retrieveCalls(
-    accountSid: string,
-    query: CallRetrieveCallsParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<CallRetrieveCallsResponse> {
-    return this._client.get(path`/texml/Accounts/${accountSid}/Calls`, { query, ...options });
+  retrieve(callSid: string, params: CallRetrieveParams, options?: RequestOptions): APIPromise<CallResource> {
+    const { account_sid } = params;
+    return this._client.get(path`/texml/Accounts/${account_sid}/Calls/${callSid}`, options);
+  }
+
+  /**
+   * Update TeXML call. Please note that the keys present in the payload MUST BE
+   * formatted in CamelCase as specified in the example.
+   *
+   * @example
+   * ```ts
+   * const callResource =
+   *   await client.texml.accounts.calls.update('call_sid', {
+   *     account_sid: 'account_sid',
+   *   });
+   * ```
+   */
+  update(callSid: string, params: CallUpdateParams, options?: RequestOptions): APIPromise<CallResource> {
+    const { account_sid, ...body } = params;
+    return this._client.post(path`/texml/Accounts/${account_sid}/Calls/${callSid}`, {
+      body,
+      ...options,
+      headers: buildHeaders([{ 'Content-Type': 'application/x-www-form-urlencoded' }, options?.headers]),
+    });
   }
 
   /**
@@ -430,62 +430,67 @@ export interface CallStreamsJsonResponse {
   uri?: string;
 }
 
-export interface CallRetrieveParams {
+export interface CallRetrieveCallsParams {
   /**
-   * The id of the account the resource belongs to.
+   * Filters calls by their end date. Expected format is YYYY-MM-DD
    */
-  account_sid: string;
-}
+  EndTime?: string;
 
-export interface CallUpdateParams {
   /**
-   * Path param: The id of the account the resource belongs to.
+   * Filters calls by their end date (after). Expected format is YYYY-MM-DD
    */
-  account_sid: string;
+  EndTime_gt?: string;
 
   /**
-   * Body param: HTTP request type used for `FallbackUrl`.
+   * Filters calls by their end date (before). Expected format is YYYY-MM-DD
    */
-  FallbackMethod?: 'GET' | 'POST';
+  EndTime_lt?: string;
 
   /**
-   * Body param: A failover URL for which Telnyx will retrieve the TeXML call
-   * instructions if the Url is not responding.
+   * Filters calls by the from number.
    */
-  FallbackUrl?: string;
+  From?: string;
 
   /**
-   * Body param: HTTP request type used for `Url`.
+   * The number of the page to be displayed, zero-indexed, should be used in
+   * conjuction with PageToken.
    */
-  Method?: 'GET' | 'POST';
+  Page?: number;
 
   /**
-   * Body param: The value to set the call status to. Setting the status to completed
-   * ends the call.
+   * The number of records to be displayed on a page
    */
-  Status?: string;
+  PageSize?: number;
 
   /**
-   * Body param: URL destination for Telnyx to send status callback events to for the
-   * call.
+   * Used to request the next page of results.
    */
-  StatusCallback?: string;
+  PageToken?: string;
 
   /**
-   * Body param: HTTP request type used for `StatusCallback`.
+   * Filters calls by their start date. Expected format is YYYY-MM-DD.
    */
-  StatusCallbackMethod?: 'GET' | 'POST';
+  StartTime?: string;
 
   /**
-   * Body param: TeXML to replace the current one with.
+   * Filters calls by their start date (after). Expected format is YYYY-MM-DD
    */
-  Texml?: string;
+  StartTime_gt?: string;
 
   /**
-   * Body param: The URL where TeXML will make a request to retrieve a new set of
-   * TeXML instructions to continue the call flow.
+   * Filters calls by their start date (before). Expected format is YYYY-MM-DD
    */
-  Url?: string;
+  StartTime_lt?: string;
+
+  /**
+   * Filters calls by status.
+   */
+  Status?: 'canceled' | 'completed' | 'failed' | 'busy' | 'no-answer';
+
+  /**
+   * Filters calls by the to number.
+   */
+  To?: string;
 }
 
 export type CallCallsParams =
@@ -700,7 +705,7 @@ export declare namespace CallCallsParams {
      * The call events for which Telnyx should send a webhook. Multiple events can be
      * defined when separated by a space.
      */
-    StatusCallbackEvent?: 'initiated' | 'ringing' | 'answered' | 'completed';
+    StatusCallbackEvent?: string;
 
     /**
      * HTTP request type used for `StatusCallback`.
@@ -976,7 +981,7 @@ export declare namespace CallCallsParams {
      * The call events for which Telnyx should send a webhook. Multiple events can be
      * defined when separated by a space.
      */
-    StatusCallbackEvent?: 'initiated' | 'ringing' | 'answered' | 'completed';
+    StatusCallbackEvent?: string;
 
     /**
      * HTTP request type used for `StatusCallback`.
@@ -1246,7 +1251,7 @@ export declare namespace CallCallsParams {
      * The call events for which Telnyx should send a webhook. Multiple events can be
      * defined when separated by a space.
      */
-    StatusCallbackEvent?: 'initiated' | 'ringing' | 'answered' | 'completed';
+    StatusCallbackEvent?: string;
 
     /**
      * HTTP request type used for `StatusCallback`.
@@ -1318,67 +1323,62 @@ export declare namespace CallCallsParams {
   }
 }
 
-export interface CallRetrieveCallsParams {
-  /**
-   * Filters calls by their end date. Expected format is YYYY-MM-DD
-   */
-  EndTime?: string;
-
-  /**
-   * Filters calls by their end date (after). Expected format is YYYY-MM-DD
-   */
-  EndTime_gt?: string;
-
+export interface CallRetrieveParams {
   /**
-   * Filters calls by their end date (before). Expected format is YYYY-MM-DD
+   * The id of the account the resource belongs to.
    */
-  EndTime_lt?: string;
+  account_sid: string;
+}
 
+export interface CallUpdateParams {
   /**
-   * Filters calls by the from number.
+   * Path param: The id of the account the resource belongs to.
    */
-  From?: string;
+  account_sid: string;
 
   /**
-   * The number of the page to be displayed, zero-indexed, should be used in
-   * conjuction with PageToken.
+   * Body param: HTTP request type used for `FallbackUrl`.
    */
-  Page?: number;
+  FallbackMethod?: 'GET' | 'POST';
 
   /**
-   * The number of records to be displayed on a page
+   * Body param: A failover URL for which Telnyx will retrieve the TeXML call
+   * instructions if the Url is not responding.
    */
-  PageSize?: number;
+  FallbackUrl?: string;
 
   /**
-   * Used to request the next page of results.
+   * Body param: HTTP request type used for `Url`.
    */
-  PageToken?: string;
+  Method?: 'GET' | 'POST';
 
   /**
-   * Filters calls by their start date. Expected format is YYYY-MM-DD.
+   * Body param: The value to set the call status to. Setting the status to completed
+   * ends the call.
    */
-  StartTime?: string;
+  Status?: string;
 
   /**
-   * Filters calls by their start date (after). Expected format is YYYY-MM-DD
+   * Body param: URL destination for Telnyx to send status callback events to for the
+   * call.
    */
-  StartTime_gt?: string;
+  StatusCallback?: string;
 
   /**
-   * Filters calls by their start date (before). Expected format is YYYY-MM-DD
+   * Body param: HTTP request type used for `StatusCallback`.
    */
-  StartTime_lt?: string;
+  StatusCallbackMethod?: 'GET' | 'POST';
 
   /**
-   * Filters calls by status.
+   * Body param: TeXML to replace the current one with.
    */
-  Status?: 'canceled' | 'completed' | 'failed' | 'busy' | 'no-answer';
+  Texml?: string;
 
   /**
-   * Filters calls by the to number.
+   * Body param: The URL where TeXML will make a request to retrieve a new set of
+   * TeXML instructions to continue the call flow.
    */
-  To?: string;
+  Url?: string;
 }
 
 export interface CallSiprecJsonParams {
@@ -1498,10 +1498,10 @@ export declare namespace Calls {
     type CallRetrieveCallsResponse as CallRetrieveCallsResponse,
     type CallSiprecJsonResponse as CallSiprecJsonResponse,
     type CallStreamsJsonResponse as CallStreamsJsonResponse,
+    type CallRetrieveCallsParams as CallRetrieveCallsParams,
+    type CallCallsParams as CallCallsParams,
     type CallRetrieveParams as CallRetrieveParams,
     type CallUpdateParams as CallUpdateParams,
-    type CallCallsParams as CallCallsParams,
-    type CallRetrieveCallsParams as CallRetrieveCallsParams,
     type CallSiprecJsonParams as CallSiprecJsonParams,
     type CallStreamsJsonParams as CallStreamsJsonParams,
   };
@@ -1512,8 +1512,8 @@ export declare namespace Calls {
     type TexmlCreateCallRecordingResponseBody as TexmlCreateCallRecordingResponseBody,
     type TexmlGetCallRecordingsResponseBody as TexmlGetCallRecordingsResponseBody,
     type TwimlRecordingChannels as TwimlRecordingChannels,
-    type RecordingsJsonRecordingsJsonParams as RecordingsJsonRecordingsJsonParams,
     type RecordingsJsonRetrieveRecordingsJsonParams as RecordingsJsonRetrieveRecordingsJsonParams,
+    type RecordingsJsonRecordingsJsonParams as RecordingsJsonRecordingsJsonParams,
   };
 
   export {

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

@@ -8,10 +8,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';
@@ -22,8 +22,8 @@ export {
   type TexmlCreateCallRecordingResponseBody,
   type TexmlGetCallRecordingsResponseBody,
   type TwimlRecordingChannels,
-  type RecordingsJsonRecordingsJsonParams,
   type RecordingsJsonRetrieveRecordingsJsonParams,
+  type RecordingsJsonRecordingsJsonParams,
 } from './recordings-json';
 export { Siprec, type SiprecSiprecSidJsonResponse, type SiprecSiprecSidJsonParams } from './siprec';
 export { Streams, type StreamStreamingSidJsonResponse, type StreamStreamingSidJsonParams } from './streams';

package/src/resources/texml/accounts/calls/recordings-json.ts

@@ -12,49 +12,49 @@ import { path } from '../../../../internal/utils/path';
  */
 export class RecordingsJson extends APIResource {
   /**
-   * Starts recording with specified parameters for call idientified by call_sid.
+   * Returns recordings for a call identified by call_sid.
    *
    * @example
    * ```ts
-   * const texmlCreateCallRecordingResponseBody =
-   *   await client.texml.accounts.calls.recordingsJson.recordingsJson(
+   * const texmlGetCallRecordingsResponseBody =
+   *   await client.texml.accounts.calls.recordingsJson.retrieveRecordingsJson(
    *     'call_sid',
    *     { account_sid: 'account_sid' },
    *   );
    * ```
    */
-  recordingsJson(
+  retrieveRecordingsJson(
     callSid: string,
-    params: RecordingsJsonRecordingsJsonParams,
+    params: RecordingsJsonRetrieveRecordingsJsonParams,
     options?: RequestOptions,
-  ): APIPromise<TexmlCreateCallRecordingResponseBody> {
-    const { account_sid, ...body } = params;
-    return this._client.post(path`/texml/Accounts/${account_sid}/Calls/${callSid}/Recordings.json`, {
-      body,
-      ...options,
-      headers: buildHeaders([{ 'Content-Type': 'application/x-www-form-urlencoded' }, options?.headers]),
-    });
+  ): APIPromise<TexmlGetCallRecordingsResponseBody> {
+    const { account_sid } = params;
+    return this._client.get(path`/texml/Accounts/${account_sid}/Calls/${callSid}/Recordings.json`, options);
   }
 
   /**
-   * Returns recordings for a call identified by call_sid.
+   * Starts recording with specified parameters for call idientified by call_sid.
    *
    * @example
    * ```ts
-   * const texmlGetCallRecordingsResponseBody =
-   *   await client.texml.accounts.calls.recordingsJson.retrieveRecordingsJson(
+   * const texmlCreateCallRecordingResponseBody =
+   *   await client.texml.accounts.calls.recordingsJson.recordingsJson(
    *     'call_sid',
    *     { account_sid: 'account_sid' },
    *   );
    * ```
    */
-  retrieveRecordingsJson(
+  recordingsJson(
     callSid: string,
-    params: RecordingsJsonRetrieveRecordingsJsonParams,
+    params: RecordingsJsonRecordingsJsonParams,
     options?: RequestOptions,
-  ): APIPromise<TexmlGetCallRecordingsResponseBody> {
-    const { account_sid } = params;
-    return this._client.get(path`/texml/Accounts/${account_sid}/Calls/${callSid}/Recordings.json`, options);
+  ): APIPromise<TexmlCreateCallRecordingResponseBody> {
+    const { account_sid, ...body } = params;
+    return this._client.post(path`/texml/Accounts/${account_sid}/Calls/${callSid}/Recordings.json`, {
+      body,
+      ...options,
+      headers: buildHeaders([{ 'Content-Type': 'application/x-www-form-urlencoded' }, options?.headers]),
+    });
   }
 }
 
@@ -169,6 +169,13 @@ export interface TexmlGetCallRecordingsResponseBody {
 
 export type TwimlRecordingChannels = 1 | 2;
 
+export interface RecordingsJsonRetrieveRecordingsJsonParams {
+  /**
+   * The id of the account the resource belongs to.
+   */
+  account_sid: string;
+}
+
 export interface RecordingsJsonRecordingsJsonParams {
   /**
    * Path param: The id of the account the resource belongs to.
@@ -214,20 +221,13 @@ export interface RecordingsJsonRecordingsJsonParams {
   SendRecordingUrl?: boolean;
 }
 
-export interface RecordingsJsonRetrieveRecordingsJsonParams {
-  /**
-   * The id of the account the resource belongs to.
-   */
-  account_sid: string;
-}
-
 export declare namespace RecordingsJson {
   export {
     type RecordingSource as RecordingSource,
     type TexmlCreateCallRecordingResponseBody as TexmlCreateCallRecordingResponseBody,
     type TexmlGetCallRecordingsResponseBody as TexmlGetCallRecordingsResponseBody,
     type TwimlRecordingChannels as TwimlRecordingChannels,
-    type RecordingsJsonRecordingsJsonParams as RecordingsJsonRecordingsJsonParams,
     type RecordingsJsonRetrieveRecordingsJsonParams as RecordingsJsonRetrieveRecordingsJsonParams,
+    type RecordingsJsonRecordingsJsonParams as RecordingsJsonRecordingsJsonParams,
   };
 }

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

@@ -25,6 +25,25 @@ import { path } from '../../../../internal/utils/path';
 export class Conferences extends APIResource {
   participants: ParticipantsAPI.Participants = new ParticipantsAPI.Participants(this._client);
 
+  /**
+   * Lists conference resources.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.texml.accounts.conferences.retrieveConferences(
+   *     'account_sid',
+   *   );
+   * ```
+   */
+  retrieveConferences(
+    accountSid: string,
+    query: ConferenceRetrieveConferencesParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ConferenceRetrieveConferencesResponse> {
+    return this._client.get(path`/texml/Accounts/${accountSid}/Conferences`, { query, ...options });
+  }
+
   /**
    * Returns a conference resource.
    *
@@ -71,25 +90,6 @@ export class Conferences extends APIResource {
     });
   }
 
-  /**
-   * Lists conference resources.
-   *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.texml.accounts.conferences.retrieveConferences(
-   *     'account_sid',
-   *   );
-   * ```
-   */
-  retrieveConferences(
-    accountSid: string,
-    query: ConferenceRetrieveConferencesParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<ConferenceRetrieveConferencesResponse> {
-    return this._client.get(path`/texml/Accounts/${accountSid}/Conferences`, { query, ...options });
-  }
-
   /**
    * Lists conference recordings
    *
@@ -375,38 +375,6 @@ export namespace ConferenceRetrieveRecordingsResponse {
   }
 }
 
-export interface ConferenceRetrieveParams {
-  /**
-   * The id of the account the resource belongs to.
-   */
-  account_sid: string;
-}
-
-export interface ConferenceUpdateParams {
-  /**
-   * Path param: The id of the account the resource belongs to.
-   */
-  account_sid: string;
-
-  /**
-   * Body param: The HTTP method used to call the `AnnounceUrl`. Defaults to `POST`.
-   */
-  AnnounceMethod?: 'GET' | 'POST';
-
-  /**
-   * Body param: The URL we should call to announce something into the conference.
-   * The URL may return an MP3 file, a WAV file, or a TwiML document that contains
-   * `<Play>`, `<Say>`, `<Pause>`, or `<Redirect>` verbs.
-   */
-  AnnounceUrl?: string;
-
-  /**
-   * Body param: The new status of the resource. Specifying `completed` will end the
-   * conference and hang up all participants.
-   */
-  Status?: string;
-}
-
 export interface ConferenceRetrieveConferencesParams {
   /**
    * Filters conferences by the creation date. Expected format is YYYY-MM-DD. Also
@@ -447,6 +415,38 @@ export interface ConferenceRetrieveConferencesParams {
   Status?: 'init' | 'in-progress' | 'completed';
 }
 
+export interface ConferenceRetrieveParams {
+  /**
+   * The id of the account the resource belongs to.
+   */
+  account_sid: string;
+}
+
+export interface ConferenceUpdateParams {
+  /**
+   * Path param: The id of the account the resource belongs to.
+   */
+  account_sid: string;
+
+  /**
+   * Body param: The HTTP method used to call the `AnnounceUrl`. Defaults to `POST`.
+   */
+  AnnounceMethod?: 'GET' | 'POST';
+
+  /**
+   * Body param: The URL we should call to announce something into the conference.
+   * The URL may return an MP3 file, a WAV file, or a TwiML document that contains
+   * `<Play>`, `<Say>`, `<Pause>`, or `<Redirect>` verbs.
+   */
+  AnnounceUrl?: string;
+
+  /**
+   * Body param: The new status of the resource. Specifying `completed` will end the
+   * conference and hang up all participants.
+   */
+  Status?: string;
+}
+
 export interface ConferenceRetrieveRecordingsParams {
   /**
    * The id of the account the resource belongs to.
@@ -468,9 +468,9 @@ export declare namespace Conferences {
     type ConferenceResource as ConferenceResource,
     type ConferenceRetrieveConferencesResponse as ConferenceRetrieveConferencesResponse,
     type ConferenceRetrieveRecordingsResponse as ConferenceRetrieveRecordingsResponse,
+    type ConferenceRetrieveConferencesParams as ConferenceRetrieveConferencesParams,
     type ConferenceRetrieveParams as ConferenceRetrieveParams,
     type ConferenceUpdateParams as ConferenceUpdateParams,
-    type ConferenceRetrieveConferencesParams as ConferenceRetrieveConferencesParams,
     type ConferenceRetrieveRecordingsParams as ConferenceRetrieveRecordingsParams,
     type ConferenceRetrieveRecordingsJsonParams as ConferenceRetrieveRecordingsJsonParams,
   };
@@ -480,10 +480,10 @@ export declare namespace Conferences {
     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/conferences/index.ts

@@ -5,9 +5,9 @@ export {
   type ConferenceResource,
   type ConferenceRetrieveConferencesResponse,
   type ConferenceRetrieveRecordingsResponse,
+  type ConferenceRetrieveConferencesParams,
   type ConferenceRetrieveParams,
   type ConferenceUpdateParams,
-  type ConferenceRetrieveConferencesParams,
   type ConferenceRetrieveRecordingsParams,
   type ConferenceRetrieveRecordingsJsonParams,
 } from './conferences';
@@ -16,9 +16,9 @@ export {
   type ParticipantResource,
   type ParticipantParticipantsResponse,
   type ParticipantRetrieveParticipantsResponse,
+  type ParticipantRetrieveParticipantsParams,
+  type ParticipantParticipantsParams,
+  type ParticipantDeleteParams,
   type ParticipantRetrieveParams,
   type ParticipantUpdateParams,
-  type ParticipantDeleteParams,
-  type ParticipantParticipantsParams,
-  type ParticipantRetrieveParticipantsParams,
 } from './participants';