telnyx 6.83.0 → 7.1.0

package/src/resources/portouts/portouts.ts

@@ -12,10 +12,10 @@ import {
 import * as EventsAPI from './events';
 import {
   EventListParams,
-  EventListResponse,
-  EventListResponsesDefaultFlatPagination,
   EventRetrieveResponse,
   Events,
+  PortoutEvent,
+  PortoutEventsDefaultFlatPagination,
   WebhookPortoutFocDateChanged,
   WebhookPortoutNewComment,
   WebhookPortoutStatusChanged,
@@ -461,12 +461,12 @@ export declare namespace Portouts {
 
   export {
     Events as Events,
+    type PortoutEvent as PortoutEvent,
     type WebhookPortoutFocDateChanged as WebhookPortoutFocDateChanged,
     type WebhookPortoutNewComment as WebhookPortoutNewComment,
     type WebhookPortoutStatusChanged as WebhookPortoutStatusChanged,
     type EventRetrieveResponse as EventRetrieveResponse,
-    type EventListResponse as EventListResponse,
-    type EventListResponsesDefaultFlatPagination as EventListResponsesDefaultFlatPagination,
+    type PortoutEventsDefaultFlatPagination as PortoutEventsDefaultFlatPagination,
     type EventListParams as EventListParams,
   };
 

package/src/resources/pronunciation-dicts.ts

@@ -34,7 +34,7 @@ export class PronunciationDicts extends APIResource {
    *
    * @example
    * ```ts
-   * const pronunciationDict =
+   * const pronunciationDictResponse =
    *   await client.pronunciationDicts.create({
    *     items: [
    *       {
@@ -50,7 +50,7 @@ export class PronunciationDicts extends APIResource {
   create(
     body: PronunciationDictCreateParams,
     options?: RequestOptions,
-  ): APIPromise<PronunciationDictCreateResponse> {
+  ): APIPromise<PronunciationDictResponse> {
     return this._client.post(
       '/pronunciation_dicts',
       maybeMultipartFormRequestOptions({ body, ...options }, this._client),
@@ -62,13 +62,13 @@ export class PronunciationDicts extends APIResource {
    *
    * @example
    * ```ts
-   * const pronunciationDict =
+   * const pronunciationDictResponse =
    *   await client.pronunciationDicts.retrieve(
    *     'c215a3e1-be41-4701-97e8-1d3c22f9a5b7',
    *   );
    * ```
    */
-  retrieve(id: string, options?: RequestOptions): APIPromise<PronunciationDictRetrieveResponse> {
+  retrieve(id: string, options?: RequestOptions): APIPromise<PronunciationDictResponse> {
     return this._client.get(path`/pronunciation_dicts/${id}`, options);
   }
 
@@ -79,7 +79,7 @@ export class PronunciationDicts extends APIResource {
    *
    * @example
    * ```ts
-   * const pronunciationDict =
+   * const pronunciationDictResponse =
    *   await client.pronunciationDicts.update(
    *     'c215a3e1-be41-4701-97e8-1d3c22f9a5b7',
    *   );
@@ -89,7 +89,7 @@ export class PronunciationDicts extends APIResource {
     id: string,
     body: PronunciationDictUpdateParams,
     options?: RequestOptions,
-  ): APIPromise<PronunciationDictUpdateResponse> {
+  ): APIPromise<PronunciationDictResponse> {
     return this._client.patch(path`/pronunciation_dicts/${id}`, { body, ...options });
   }
 
@@ -174,7 +174,7 @@ export interface PronunciationDictData {
   /**
    * List of pronunciation items (alias or phoneme type).
    */
-  items?: Array<PronunciationDictAliasItem | PronunciationDictPhonemeItem>;
+  items?: Array<PronunciationDictItem>;
 
   /**
    * Human-readable name for the dictionary. Must be unique within the organization.
@@ -198,6 +198,13 @@ export interface PronunciationDictData {
   version?: number;
 }
 
+/**
+ * A single pronunciation dictionary item. Use type 'alias' to replace matched text
+ * with a spoken alias, or type 'phoneme' to specify exact pronunciation using IPA
+ * notation.
+ */
+export type PronunciationDictItem = PronunciationDictAliasItem | PronunciationDictPhonemeItem;
+
 /**
  * A phoneme pronunciation item. When the `text` value is found in input, it is
  * pronounced using the specified IPA phoneme notation.
@@ -228,27 +235,7 @@ export interface PronunciationDictPhonemeItem {
 /**
  * Response containing a single pronunciation dictionary.
  */
-export interface PronunciationDictCreateResponse {
-  /**
-   * A pronunciation dictionary record.
-   */
-  data?: PronunciationDictData;
-}
-
-/**
- * Response containing a single pronunciation dictionary.
- */
-export interface PronunciationDictRetrieveResponse {
-  /**
-   * A pronunciation dictionary record.
-   */
-  data?: PronunciationDictData;
-}
-
-/**
- * Response containing a single pronunciation dictionary.
- */
-export interface PronunciationDictUpdateResponse {
+export interface PronunciationDictResponse {
   /**
    * A pronunciation dictionary record.
    */
@@ -260,7 +247,7 @@ export interface PronunciationDictCreateParams {
    * List of pronunciation items (alias or phoneme type). At least one item is
    * required.
    */
-  items: Array<PronunciationDictAliasItem | PronunciationDictPhonemeItem>;
+  items: Array<PronunciationDictItem>;
 
   /**
    * Human-readable name. Must be unique within the organization.
@@ -272,7 +259,7 @@ export interface PronunciationDictUpdateParams {
   /**
    * Updated list of pronunciation items (alias or phoneme type).
    */
-  items?: Array<PronunciationDictAliasItem | PronunciationDictPhonemeItem>;
+  items?: Array<PronunciationDictItem>;
 
   /**
    * Updated dictionary name.
@@ -286,10 +273,9 @@ export declare namespace PronunciationDicts {
   export {
     type PronunciationDictAliasItem as PronunciationDictAliasItem,
     type PronunciationDictData as PronunciationDictData,
+    type PronunciationDictItem as PronunciationDictItem,
     type PronunciationDictPhonemeItem as PronunciationDictPhonemeItem,
-    type PronunciationDictCreateResponse as PronunciationDictCreateResponse,
-    type PronunciationDictRetrieveResponse as PronunciationDictRetrieveResponse,
-    type PronunciationDictUpdateResponse as PronunciationDictUpdateResponse,
+    type PronunciationDictResponse as PronunciationDictResponse,
     type PronunciationDictDataDefaultFlatPagination as PronunciationDictDataDefaultFlatPagination,
     type PronunciationDictCreateParams as PronunciationDictCreateParams,
     type PronunciationDictUpdateParams as PronunciationDictUpdateParams,

package/src/resources/public-internet-gateways.ts

@@ -1,6 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
+import * as PublicInternetGatewaysAPI from './public-internet-gateways';
+import * as GlobalIPAssignmentsAPI from './global-ip-assignments';
 import * as NetworksAPI from './networks/networks';
 import { APIPromise } from '../core/api-promise';
 import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from '../core/pagination';
@@ -13,30 +15,17 @@ import { path } from '../internal/utils/path';
 export class PublicInternetGateways extends APIResource {
   /**
    * Create a new Public Internet Gateway.
-   *
-   * @example
-   * ```ts
-   * const publicInternetGateway =
-   *   await client.publicInternetGateways.create();
-   * ```
    */
   create(
-    body: PublicInternetGatewayCreateParams,
+    params: PublicInternetGatewayCreateParams,
     options?: RequestOptions,
   ): APIPromise<PublicInternetGatewayCreateResponse> {
-    return this._client.post('/public_internet_gateways', { body, ...options });
+    const { body } = params;
+    return this._client.post('/public_internet_gateways', { body: body, ...options });
   }
 
   /**
    * Retrieve a Public Internet Gateway.
-   *
-   * @example
-   * ```ts
-   * const publicInternetGateway =
-   *   await client.publicInternetGateways.retrieve(
-   *     '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
-   *   );
-   * ```
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<PublicInternetGatewayRetrieveResponse> {
     return this._client.get(path`/public_internet_gateways/${id}`, options);
@@ -44,14 +33,6 @@ export class PublicInternetGateways extends APIResource {
 
   /**
    * List all Public Internet Gateways.
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const publicInternetGatewayRead of client.publicInternetGateways.list()) {
-   *   // ...
-   * }
-   * ```
    */
   list(
     query: PublicInternetGatewayListParams | null | undefined = {},
@@ -66,14 +47,6 @@ export class PublicInternetGateways extends APIResource {
 
   /**
    * Delete a Public Internet Gateway.
-   *
-   * @example
-   * ```ts
-   * const publicInternetGateway =
-   *   await client.publicInternetGateways.delete(
-   *     '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
-   *   );
-   * ```
    */
   delete(id: string, options?: RequestOptions): APIPromise<PublicInternetGatewayDeleteResponse> {
     return this._client.delete(path`/public_internet_gateways/${id}`, options);
@@ -107,6 +80,18 @@ export interface NetworkInterfaceRegion {
   region_code?: string;
 }
 
+export interface PublicInternetGateway extends GlobalIPAssignmentsAPI.Record, NetworkInterface {
+  /**
+   * The publically accessible ip for this interface.
+   */
+  public_ip?: string;
+
+  /**
+   * The region interface is deployed to.
+   */
+  region_code?: string;
+}
+
 export interface PublicInternetGatewayRead {
   /**
    * Identifies the resource.
@@ -167,20 +152,11 @@ export interface PublicInternetGatewayDeleteResponse {
 }
 
 export interface PublicInternetGatewayCreateParams {
-  /**
-   * A user specified name for the interface.
-   */
-  name?: string;
-
-  /**
-   * The id of the network associated with the interface.
-   */
-  network_id?: string;
+  body: PublicInternetGatewayCreateParams.Body;
+}
 
-  /**
-   * The region interface is deployed to.
-   */
-  region_code?: string;
+export namespace PublicInternetGatewayCreateParams {
+  export interface Body extends PublicInternetGatewaysAPI.PublicInternetGateway {}
 }
 
 export interface PublicInternetGatewayListParams extends DefaultFlatPaginationParams {
@@ -206,6 +182,7 @@ export declare namespace PublicInternetGateways {
   export {
     type NetworkInterface as NetworkInterface,
     type NetworkInterfaceRegion as NetworkInterfaceRegion,
+    type PublicInternetGateway as PublicInternetGateway,
     type PublicInternetGatewayRead as PublicInternetGatewayRead,
     type PublicInternetGatewayCreateResponse as PublicInternetGatewayCreateResponse,
     type PublicInternetGatewayRetrieveResponse as PublicInternetGatewayRetrieveResponse,

package/src/resources/queues/calls.ts

@@ -56,7 +56,7 @@ export class Calls extends APIResource {
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
-   * for await (const callListResponse of client.queues.calls.list(
+   * for await (const queueCall of client.queues.calls.list(
    *   'queue_name',
    * )) {
    *   // ...
@@ -67,12 +67,11 @@ export class Calls extends APIResource {
     queueName: string,
     query: CallListParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<CallListResponsesDefaultFlatPagination, CallListResponse> {
-    return this._client.getAPIList(
-      path`/queues/${queueName}/calls`,
-      DefaultFlatPagination<CallListResponse>,
-      { query, ...options },
-    );
+  ): PagePromise<QueueCallsDefaultFlatPagination, QueueCall> {
+    return this._client.getAPIList(path`/queues/${queueName}/calls`, DefaultFlatPagination<QueueCall>, {
+      query,
+      ...options,
+    });
   }
 
   /**
@@ -95,76 +94,9 @@ export class Calls extends APIResource {
   }
 }
 
-export type CallListResponsesDefaultFlatPagination = DefaultFlatPagination<CallListResponse>;
-
-export interface CallRetrieveResponse {
-  data?: CallRetrieveResponse.Data;
-}
-
-export namespace CallRetrieveResponse {
-  export interface Data {
-    /**
-     * Unique identifier and token for controlling the call.
-     */
-    call_control_id: string;
-
-    /**
-     * ID that is unique to the call and can be used to correlate webhook events
-     */
-    call_leg_id: string;
-
-    /**
-     * ID that is unique to the call session and can be used to correlate webhook
-     * events. Call session is a group of related call legs that logically belong to
-     * the same phone call, e.g. an inbound and outbound leg of a transferred call
-     */
-    call_session_id: string;
-
-    /**
-     * Call Control App ID (formerly Telnyx connection ID) used in the call.
-     */
-    connection_id: string;
-
-    /**
-     * ISO 8601 formatted date of when the call was put in the queue
-     */
-    enqueued_at: string;
-
-    /**
-     * Number or SIP URI placing the call.
-     */
-    from: string;
+export type QueueCallsDefaultFlatPagination = DefaultFlatPagination<QueueCall>;
 
-    /**
-     * Unique identifier of the queue the call is in.
-     */
-    queue_id: string;
-
-    /**
-     * Current position of the call in the queue
-     */
-    queue_position: number;
-
-    record_type: 'queue_call';
-
-    /**
-     * Destination number or SIP URI of the call.
-     */
-    to: string;
-
-    /**
-     * The time the call has been waiting in the queue, given in seconds
-     */
-    wait_time_secs: number;
-
-    /**
-     * Indicates whether the call is still active in the queue.
-     */
-    is_alive?: boolean;
-  }
-}
-
-export interface CallListResponse {
+export interface QueueCall {
   /**
    * Unique identifier and token for controlling the call.
    */
@@ -225,6 +157,10 @@ export interface CallListResponse {
   is_alive?: boolean;
 }
 
+export interface CallRetrieveResponse {
+  data?: QueueCall;
+}
+
 export interface CallRetrieveParams {
   /**
    * Uniquely identifies the queue by name
@@ -255,9 +191,9 @@ export interface CallRemoveParams {
 
 export declare namespace Calls {
   export {
+    type QueueCall as QueueCall,
     type CallRetrieveResponse as CallRetrieveResponse,
-    type CallListResponse as CallListResponse,
-    type CallListResponsesDefaultFlatPagination as CallListResponsesDefaultFlatPagination,
+    type QueueCallsDefaultFlatPagination as QueueCallsDefaultFlatPagination,
     type CallRetrieveParams as CallRetrieveParams,
     type CallUpdateParams as CallUpdateParams,
     type CallListParams as CallListParams,

package/src/resources/queues/index.ts

@@ -2,13 +2,13 @@
 
 export {
   Calls,
+  type QueueCall,
   type CallRetrieveResponse,
-  type CallListResponse,
   type CallRetrieveParams,
   type CallUpdateParams,
   type CallListParams,
   type CallRemoveParams,
-  type CallListResponsesDefaultFlatPagination,
+  type QueueCallsDefaultFlatPagination,
 } from './calls';
 export {
   Queues,

package/src/resources/queues/queues.ts

@@ -4,13 +4,13 @@ import { APIResource } from '../../core/resource';
 import * as CallsAPI from './calls';
 import {
   CallListParams,
-  CallListResponse,
-  CallListResponsesDefaultFlatPagination,
   CallRemoveParams,
   CallRetrieveParams,
   CallRetrieveResponse,
   CallUpdateParams,
   Calls,
+  QueueCall,
+  QueueCallsDefaultFlatPagination,
 } from './calls';
 import { APIPromise } from '../../core/api-promise';
 import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from '../../core/pagination';
@@ -193,9 +193,9 @@ export declare namespace Queues {
 
   export {
     Calls as Calls,
+    type QueueCall as QueueCall,
     type CallRetrieveResponse as CallRetrieveResponse,
-    type CallListResponse as CallListResponse,
-    type CallListResponsesDefaultFlatPagination as CallListResponsesDefaultFlatPagination,
+    type QueueCallsDefaultFlatPagination as QueueCallsDefaultFlatPagination,
     type CallRetrieveParams as CallRetrieveParams,
     type CallUpdateParams as CallUpdateParams,
     type CallListParams as CallListParams,

package/src/resources/recordings/index.ts

@@ -3,9 +3,8 @@
 export { Actions, type ActionDeleteResponse, type ActionDeleteParams } from './actions';
 export {
   Recordings,
+  type RecordingResponse,
   type RecordingResponseData,
-  type RecordingRetrieveResponse,
-  type RecordingDeleteResponse,
   type RecordingListParams,
   type RecordingResponseDataDefaultFlatPagination,
 } from './recordings';

package/src/resources/recordings/recordings.ts

@@ -19,12 +19,12 @@ export class Recordings extends APIResource {
    *
    * @example
    * ```ts
-   * const recording = await client.recordings.retrieve(
+   * const recordingResponse = await client.recordings.retrieve(
    *   'recording_id',
    * );
    * ```
    */
-  retrieve(recordingID: string, options?: RequestOptions): APIPromise<RecordingRetrieveResponse> {
+  retrieve(recordingID: string, options?: RequestOptions): APIPromise<RecordingResponse> {
     return this._client.get(path`/recordings/${recordingID}`, options);
   }
 
@@ -54,18 +54,22 @@ export class Recordings extends APIResource {
    *
    * @example
    * ```ts
-   * const recording = await client.recordings.delete(
+   * const recordingResponse = await client.recordings.delete(
    *   'recording_id',
    * );
    * ```
    */
-  delete(recordingID: string, options?: RequestOptions): APIPromise<RecordingDeleteResponse> {
+  delete(recordingID: string, options?: RequestOptions): APIPromise<RecordingResponse> {
     return this._client.delete(path`/recordings/${recordingID}`, options);
   }
 }
 
 export type RecordingResponseDataDefaultFlatPagination = DefaultFlatPagination<RecordingResponseData>;
 
+export interface RecordingResponse {
+  data?: RecordingResponseData;
+}
+
 export interface RecordingResponseData {
   /**
    * Uniquely identifies the recording.
@@ -184,14 +188,6 @@ export namespace RecordingResponseData {
   }
 }
 
-export interface RecordingRetrieveResponse {
-  data?: RecordingResponseData;
-}
-
-export interface RecordingDeleteResponse {
-  data?: RecordingResponseData;
-}
-
 export interface RecordingListParams extends DefaultFlatPaginationParams {
   /**
    * Filter recordings by various attributes.
@@ -310,9 +306,8 @@ Recordings.Actions = Actions;
 
 export declare namespace Recordings {
   export {
+    type RecordingResponse as RecordingResponse,
     type RecordingResponseData as RecordingResponseData,
-    type RecordingRetrieveResponse as RecordingRetrieveResponse,
-    type RecordingDeleteResponse as RecordingDeleteResponse,
     type RecordingResponseDataDefaultFlatPagination as RecordingResponseDataDefaultFlatPagination,
     type RecordingListParams as RecordingListParams,
   };

package/src/resources/reports/cdr-usage-reports.ts

@@ -66,14 +66,29 @@ export namespace CdrUsageReportFetchSyncResponse {
 }
 
 export interface CdrUsageReportFetchSyncParams {
+  /**
+   * Type of aggregation to apply to the results.
+   */
   aggregation_type: 'NO_AGGREGATION' | 'CONNECTION' | 'TAG' | 'BILLING_GROUP';
 
+  /**
+   * Filter results by product breakdown.
+   */
   product_breakdown: 'NO_BREAKDOWN' | 'DID_VS_TOLL_FREE' | 'COUNTRY' | 'DID_VS_TOLL_FREE_PER_COUNTRY';
 
+  /**
+   * Filter results by connection.
+   */
   connections?: Array<number>;
 
+  /**
+   * End of the date range filter (inclusive, ISO 8601).
+   */
   end_date?: string;
 
+  /**
+   * Start of the date range filter (inclusive, ISO 8601).
+   */
   start_date?: string;
 }
 

package/src/resources/reports/mdr-usage-reports.ts

@@ -211,12 +211,24 @@ export interface MdrUsageReportCreateParams {
 export interface MdrUsageReportListParams extends DefaultFlatPaginationParams {}
 
 export interface MdrUsageReportFetchSyncParams {
+  /**
+   * Type of aggregation to apply to the results.
+   */
   aggregation_type: 'NO_AGGREGATION' | 'PROFILE' | 'TAGS';
 
+  /**
+   * End of the date range filter (inclusive, ISO 8601).
+   */
   end_date?: string;
 
+  /**
+   * Filter results by profile.
+   */
   profiles?: Array<string>;
 
+  /**
+   * Start of the date range filter (inclusive, ISO 8601).
+   */
   start_date?: string;
 }