telnyx 6.74.2 → 7.1.0

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

@@ -2,9 +2,8 @@
 
 export {
   Calls,
+  type CallResource,
   type UpdateCall,
-  type CallRetrieveResponse,
-  type CallUpdateResponse,
   type CallCallsResponse,
   type CallRetrieveCallsResponse,
   type CallSiprecJsonResponse,
@@ -16,15 +15,13 @@ export {
   type CallSiprecJsonParams,
   type CallStreamsJsonParams,
 } from './calls';
-export {
-  Recordings,
-  type RecordingRecordingSidJsonResponse,
-  type RecordingRecordingSidJsonParams,
-} from './recordings';
+export { Recordings, type RecordingRecordingSidJsonParams } from './recordings';
 export {
   RecordingsJson,
-  type RecordingsJsonRecordingsJsonResponse,
-  type RecordingsJsonRetrieveRecordingsJsonResponse,
+  type RecordingSource,
+  type TexmlCreateCallRecordingResponseBody,
+  type TexmlGetCallRecordingsResponseBody,
+  type TwimlRecordingChannels,
   type RecordingsJsonRecordingsJsonParams,
   type RecordingsJsonRetrieveRecordingsJsonParams,
 } from './recordings-json';

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

@@ -16,7 +16,7 @@ export class RecordingsJson extends APIResource {
    *
    * @example
    * ```ts
-   * const response =
+   * const texmlCreateCallRecordingResponseBody =
    *   await client.texml.accounts.calls.recordingsJson.recordingsJson(
    *     'call_sid',
    *     { account_sid: 'account_sid' },
@@ -27,7 +27,7 @@ export class RecordingsJson extends APIResource {
     callSid: string,
     params: RecordingsJsonRecordingsJsonParams,
     options?: RequestOptions,
-  ): APIPromise<RecordingsJsonRecordingsJsonResponse> {
+  ): APIPromise<TexmlCreateCallRecordingResponseBody> {
     const { account_sid, ...body } = params;
     return this._client.post(path`/texml/Accounts/${account_sid}/Calls/${callSid}/Recordings.json`, {
       body,
@@ -41,7 +41,7 @@ export class RecordingsJson extends APIResource {
    *
    * @example
    * ```ts
-   * const response =
+   * const texmlGetCallRecordingsResponseBody =
    *   await client.texml.accounts.calls.recordingsJson.retrieveRecordingsJson(
    *     'call_sid',
    *     { account_sid: 'account_sid' },
@@ -52,18 +52,30 @@ export class RecordingsJson extends APIResource {
     callSid: string,
     params: RecordingsJsonRetrieveRecordingsJsonParams,
     options?: RequestOptions,
-  ): APIPromise<RecordingsJsonRetrieveRecordingsJsonResponse> {
+  ): APIPromise<TexmlGetCallRecordingsResponseBody> {
     const { account_sid } = params;
     return this._client.get(path`/texml/Accounts/${account_sid}/Calls/${callSid}/Recordings.json`, options);
   }
 }
 
-export interface RecordingsJsonRecordingsJsonResponse {
+/**
+ * Defines how the recording was created.
+ */
+export type RecordingSource =
+  | 'StartCallRecordingAPI'
+  | 'StartConferenceRecordingAPI'
+  | 'OutboundAPI'
+  | 'DialVerb'
+  | 'Conference'
+  | 'RecordVerb'
+  | 'Trunking';
+
+export interface TexmlCreateCallRecordingResponseBody {
   account_sid?: string;
 
   call_sid?: string;
 
-  channels?: 1 | 2;
+  channels?: TwimlRecordingChannels;
 
   conference_sid?: string | null;
 
@@ -96,14 +108,7 @@ export interface RecordingsJsonRecordingsJsonResponse {
   /**
    * Defines how the recording was created.
    */
-  source?:
-    | 'StartCallRecordingAPI'
-    | 'StartConferenceRecordingAPI'
-    | 'OutboundAPI'
-    | 'DialVerb'
-    | 'Conference'
-    | 'RecordVerb'
-    | 'Trunking';
+  source?: RecordingSource;
 
   start_time?: string;
 
@@ -118,7 +123,7 @@ export interface RecordingsJsonRecordingsJsonResponse {
   uri?: string;
 }
 
-export interface RecordingsJsonRetrieveRecordingsJsonResponse {
+export interface TexmlGetCallRecordingsResponseBody {
   /**
    * The number of the last element on the page, zero-indexed.
    */
@@ -162,6 +167,8 @@ export interface RecordingsJsonRetrieveRecordingsJsonResponse {
   uri?: string;
 }
 
+export type TwimlRecordingChannels = 1 | 2;
+
 export interface RecordingsJsonRecordingsJsonParams {
   /**
    * Path param: The id of the account the resource belongs to.
@@ -216,8 +223,10 @@ export interface RecordingsJsonRetrieveRecordingsJsonParams {
 
 export declare namespace RecordingsJson {
   export {
-    type RecordingsJsonRecordingsJsonResponse as RecordingsJsonRecordingsJsonResponse,
-    type RecordingsJsonRetrieveRecordingsJsonResponse as RecordingsJsonRetrieveRecordingsJsonResponse,
+    type RecordingSource as RecordingSource,
+    type TexmlCreateCallRecordingResponseBody as TexmlCreateCallRecordingResponseBody,
+    type TexmlGetCallRecordingsResponseBody as TexmlGetCallRecordingsResponseBody,
+    type TwimlRecordingChannels as TwimlRecordingChannels,
     type RecordingsJsonRecordingsJsonParams as RecordingsJsonRecordingsJsonParams,
     type RecordingsJsonRetrieveRecordingsJsonParams as RecordingsJsonRetrieveRecordingsJsonParams,
   };

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

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../../../core/resource';
+import * as RecordingsJsonAPI from './recordings-json';
 import { APIPromise } from '../../../../core/api-promise';
 import { buildHeaders } from '../../../../internal/headers';
 import { RequestOptions } from '../../../../internal/request-options';
@@ -15,7 +16,7 @@ export class Recordings extends APIResource {
    *
    * @example
    * ```ts
-   * const response =
+   * const texmlCreateCallRecordingResponseBody =
    *   await client.texml.accounts.calls.recordings.recordingSidJson(
    *     '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
    *     { account_sid: 'account_sid', call_sid: 'call_sid' },
@@ -26,7 +27,7 @@ export class Recordings extends APIResource {
     recordingSid: string,
     params: RecordingRecordingSidJsonParams,
     options?: RequestOptions,
-  ): APIPromise<RecordingRecordingSidJsonResponse> {
+  ): APIPromise<RecordingsJsonAPI.TexmlCreateCallRecordingResponseBody> {
     const { account_sid, call_sid, ...body } = params;
     return this._client.post(
       path`/texml/Accounts/${account_sid}/Calls/${call_sid}/Recordings/${recordingSid}.json`,
@@ -39,66 +40,6 @@ export class Recordings extends APIResource {
   }
 }
 
-export interface RecordingRecordingSidJsonResponse {
-  account_sid?: string;
-
-  call_sid?: string;
-
-  channels?: 1 | 2;
-
-  conference_sid?: string | null;
-
-  date_created?: string;
-
-  date_updated?: string;
-
-  /**
-   * The duration of this recording, given in seconds.
-   */
-  duration?: string | null;
-
-  error_code?: string | null;
-
-  /**
-   * The price of this recording, the currency is specified in the price_unit field.
-   */
-  price?: string | null;
-
-  /**
-   * The unit in which the price is given.
-   */
-  price_unit?: string | null;
-
-  /**
-   * Identifier of a resource.
-   */
-  sid?: string;
-
-  /**
-   * Defines how the recording was created.
-   */
-  source?:
-    | 'StartCallRecordingAPI'
-    | 'StartConferenceRecordingAPI'
-    | 'OutboundAPI'
-    | 'DialVerb'
-    | 'Conference'
-    | 'RecordVerb'
-    | 'Trunking';
-
-  start_time?: string;
-
-  /**
-   * The audio track to record for the call. The default is `both`.
-   */
-  track?: 'inbound' | 'outbound' | 'both';
-
-  /**
-   * The relative URI for this recording resource.
-   */
-  uri?: string;
-}
-
 export interface RecordingRecordingSidJsonParams {
   /**
    * Path param: The id of the account the resource belongs to.
@@ -117,8 +58,5 @@ export interface RecordingRecordingSidJsonParams {
 }
 
 export declare namespace Recordings {
-  export {
-    type RecordingRecordingSidJsonResponse as RecordingRecordingSidJsonResponse,
-    type RecordingRecordingSidJsonParams as RecordingRecordingSidJsonParams,
-  };
+  export { type RecordingRecordingSidJsonParams as RecordingRecordingSidJsonParams };
 }

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

@@ -1,18 +1,17 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../../../core/resource';
-import * as AccountsAPI from '../accounts';
+import * as RecordingsJsonAPI from '../calls/recordings-json';
 import * as ParticipantsAPI from './participants';
 import {
   ParticipantDeleteParams,
   ParticipantParticipantsParams,
   ParticipantParticipantsResponse,
+  ParticipantResource,
   ParticipantRetrieveParams,
   ParticipantRetrieveParticipantsParams,
   ParticipantRetrieveParticipantsResponse,
-  ParticipantRetrieveResponse,
   ParticipantUpdateParams,
-  ParticipantUpdateResponse,
   Participants,
 } from './participants';
 import { APIPromise } from '../../../../core/api-promise';
@@ -31,7 +30,7 @@ export class Conferences extends APIResource {
    *
    * @example
    * ```ts
-   * const conference =
+   * const conferenceResource =
    *   await client.texml.accounts.conferences.retrieve(
    *     'conference_sid',
    *     { account_sid: 'account_sid' },
@@ -42,7 +41,7 @@ export class Conferences extends APIResource {
     conferenceSid: string,
     params: ConferenceRetrieveParams,
     options?: RequestOptions,
-  ): APIPromise<ConferenceRetrieveResponse> {
+  ): APIPromise<ConferenceResource> {
     const { account_sid } = params;
     return this._client.get(path`/texml/Accounts/${account_sid}/Conferences/${conferenceSid}`, options);
   }
@@ -52,7 +51,7 @@ export class Conferences extends APIResource {
    *
    * @example
    * ```ts
-   * const conference =
+   * const conferenceResource =
    *   await client.texml.accounts.conferences.update(
    *     'conference_sid',
    *     { account_sid: 'account_sid' },
@@ -63,7 +62,7 @@ export class Conferences extends APIResource {
     conferenceSid: string,
     params: ConferenceUpdateParams,
     options?: RequestOptions,
-  ): APIPromise<ConferenceUpdateResponse> {
+  ): APIPromise<ConferenceResource> {
     const { account_sid, ...body } = params;
     return this._client.post(path`/texml/Accounts/${account_sid}/Conferences/${conferenceSid}`, {
       body,
@@ -120,7 +119,7 @@ export class Conferences extends APIResource {
    *
    * @example
    * ```ts
-   * const response =
+   * const texmlGetCallRecordingsResponseBody =
    *   await client.texml.accounts.conferences.retrieveRecordingsJson(
    *     'conference_sid',
    *     { account_sid: 'account_sid' },
@@ -131,7 +130,7 @@ export class Conferences extends APIResource {
     conferenceSid: string,
     params: ConferenceRetrieveRecordingsJsonParams,
     options?: RequestOptions,
-  ): APIPromise<ConferenceRetrieveRecordingsJsonResponse> {
+  ): APIPromise<RecordingsJsonAPI.TexmlGetCallRecordingsResponseBody> {
     const { account_sid } = params;
     return this._client.get(
       path`/texml/Accounts/${account_sid}/Conferences/${conferenceSid}/Recordings.json`,
@@ -140,74 +139,7 @@ export class Conferences extends APIResource {
   }
 }
 
-export interface ConferenceRetrieveResponse {
-  /**
-   * 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;
-
-  /**
-   * Caller ID, if present.
-   */
-  call_sid_ending_conference?: string;
-
-  /**
-   * The timestamp of when the resource was created.
-   */
-  date_created?: string;
-
-  /**
-   * The timestamp of when the resource was last updated.
-   */
-  date_updated?: string;
-
-  /**
-   * A string that you assigned to describe this conference room.
-   */
-  friendly_name?: string;
-
-  /**
-   * The reason why a conference ended. When a conference is in progress, will be
-   * null.
-   */
-  reason_conference_ended?:
-    | 'participant-with-end-conference-on-exit-left'
-    | 'last-participant-left'
-    | 'conference-ended-via-api'
-    | 'time-exceeded';
-
-  /**
-   * A string representing the region where the conference is hosted.
-   */
-  region?: string;
-
-  /**
-   * The unique identifier of the conference.
-   */
-  sid?: string;
-
-  /**
-   * The status of this conference.
-   */
-  status?: 'init' | 'in-progress' | 'completed';
-
-  /**
-   * A list of related resources identified by their relative URIs.
-   */
-  subresource_uris?: { [key: string]: unknown };
-
-  /**
-   * The relative URI for this conference.
-   */
-  uri?: string;
-}
-
-export interface ConferenceUpdateResponse {
+export interface ConferenceResource {
   /**
    * The id of the account the resource belongs to.
    */
@@ -275,7 +207,7 @@ export interface ConferenceUpdateResponse {
 }
 
 export interface ConferenceRetrieveConferencesResponse {
-  conferences?: Array<ConferenceRetrieveConferencesResponse.Conference>;
+  conferences?: Array<ConferenceResource>;
 
   /**
    * The number of the last element on the page, zero-indexed.
@@ -313,75 +245,6 @@ export interface ConferenceRetrieveConferencesResponse {
   uri?: string;
 }
 
-export namespace ConferenceRetrieveConferencesResponse {
-  export interface Conference {
-    /**
-     * 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;
-
-    /**
-     * Caller ID, if present.
-     */
-    call_sid_ending_conference?: string;
-
-    /**
-     * The timestamp of when the resource was created.
-     */
-    date_created?: string;
-
-    /**
-     * The timestamp of when the resource was last updated.
-     */
-    date_updated?: string;
-
-    /**
-     * A string that you assigned to describe this conference room.
-     */
-    friendly_name?: string;
-
-    /**
-     * The reason why a conference ended. When a conference is in progress, will be
-     * null.
-     */
-    reason_conference_ended?:
-      | 'participant-with-end-conference-on-exit-left'
-      | 'last-participant-left'
-      | 'conference-ended-via-api'
-      | 'time-exceeded';
-
-    /**
-     * A string representing the region where the conference is hosted.
-     */
-    region?: string;
-
-    /**
-     * The unique identifier of the conference.
-     */
-    sid?: string;
-
-    /**
-     * The status of this conference.
-     */
-    status?: 'init' | 'in-progress' | 'completed';
-
-    /**
-     * A list of related resources identified by their relative URIs.
-     */
-    subresource_uris?: { [key: string]: unknown };
-
-    /**
-     * The relative URI for this conference.
-     */
-    uri?: string;
-  }
-}
-
 export interface ConferenceRetrieveRecordingsResponse {
   /**
    * The number of the last element on the page, zero-indexed.
@@ -512,50 +375,6 @@ export namespace ConferenceRetrieveRecordingsResponse {
   }
 }
 
-export interface ConferenceRetrieveRecordingsJsonResponse {
-  /**
-   * The number of the last element on the page, zero-indexed.
-   */
-  end?: number;
-
-  /**
-   * Relative uri to the first page of the query results
-   */
-  first_page_uri?: string;
-
-  /**
-   * Relative uri to the next page of the query results
-   */
-  next_page_uri?: string;
-
-  /**
-   * Current page number, zero-indexed.
-   */
-  page?: number;
-
-  /**
-   * The number of items on the page
-   */
-  page_size?: number;
-
-  /**
-   * Relative uri to the previous page of the query results
-   */
-  previous_page_uri?: string;
-
-  recordings?: Array<AccountsAPI.TexmlGetCallRecordingResponseBody>;
-
-  /**
-   * The number of the first element on the page, zero-indexed.
-   */
-  start?: number;
-
-  /**
-   * The URI of the current page.
-   */
-  uri?: string;
-}
-
 export interface ConferenceRetrieveParams {
   /**
    * The id of the account the resource belongs to.
@@ -646,11 +465,9 @@ Conferences.Participants = Participants;
 
 export declare namespace Conferences {
   export {
-    type ConferenceRetrieveResponse as ConferenceRetrieveResponse,
-    type ConferenceUpdateResponse as ConferenceUpdateResponse,
+    type ConferenceResource as ConferenceResource,
     type ConferenceRetrieveConferencesResponse as ConferenceRetrieveConferencesResponse,
     type ConferenceRetrieveRecordingsResponse as ConferenceRetrieveRecordingsResponse,
-    type ConferenceRetrieveRecordingsJsonResponse as ConferenceRetrieveRecordingsJsonResponse,
     type ConferenceRetrieveParams as ConferenceRetrieveParams,
     type ConferenceUpdateParams as ConferenceUpdateParams,
     type ConferenceRetrieveConferencesParams as ConferenceRetrieveConferencesParams,
@@ -660,8 +477,7 @@ export declare namespace Conferences {
 
   export {
     Participants as Participants,
-    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/conferences/index.ts

@@ -2,11 +2,9 @@
 
 export {
   Conferences,
-  type ConferenceRetrieveResponse,
-  type ConferenceUpdateResponse,
+  type ConferenceResource,
   type ConferenceRetrieveConferencesResponse,
   type ConferenceRetrieveRecordingsResponse,
-  type ConferenceRetrieveRecordingsJsonResponse,
   type ConferenceRetrieveParams,
   type ConferenceUpdateParams,
   type ConferenceRetrieveConferencesParams,
@@ -15,8 +13,7 @@ export {
 } from './conferences';
 export {
   Participants,
-  type ParticipantRetrieveResponse,
-  type ParticipantUpdateResponse,
+  type ParticipantResource,
   type ParticipantParticipantsResponse,
   type ParticipantRetrieveParticipantsResponse,
   type ParticipantRetrieveParams,