telnyx 5.51.0 → 6.2.0

package/src/resources/portouts/comments.ts

@@ -6,6 +6,9 @@ import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Number portout operations
+ */
 export class Comments extends APIResource {
   /**
    * Creates a comment on a portout request.

package/src/resources/portouts/events.ts

@@ -7,6 +7,9 @@ import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Number portout operations
+ */
 export class Events extends APIResource {
   /**
    * Show a specific port-out event.

package/src/resources/portouts/portouts.ts

@@ -44,6 +44,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Number portout operations
+ */
 export class Portouts extends APIResource {
   events: EventsAPI.Events = new EventsAPI.Events(this._client);
   reports: ReportsAPI.Reports = new ReportsAPI.Reports(this._client);

package/src/resources/portouts/reports.ts

@@ -6,6 +6,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Number portout operations
+ */
 export class Reports extends APIResource {
   /**
    * Generate reports about port-out operations.

package/src/resources/portouts/supporting-documents.ts

@@ -5,6 +5,9 @@ import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Number portout operations
+ */
 export class SupportingDocuments extends APIResource {
   /**
    * Creates a list of supporting documents on a portout request.

package/src/resources/private-wireless-gateways.ts

@@ -6,6 +6,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Private Wireless Gateways operations
+ */
 export class PrivateWirelessGateways extends APIResource {
   /**
    * Asynchronously create a Private Wireless Gateway for SIM cards for a previously

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

@@ -9,6 +9,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Public Internet Gateway operations
+ */
 export class PublicInternetGateways extends APIResource {
   /**
    * Create a new Public Internet Gateway.

package/src/resources/queues/calls.ts

@@ -7,6 +7,9 @@ import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Queue commands operations
+ */
 export class Calls extends APIResource {
   /**
    * Retrieve an existing call from an existing queue

package/src/resources/queues/queues.ts

@@ -18,6 +18,9 @@ import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Queue commands operations
+ */
 export class Queues extends APIResource {
   calls: CallsAPI.Calls = new CallsAPI.Calls(this._client);
 

package/src/resources/recording-transcriptions.ts

@@ -6,6 +6,9 @@ import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Call Recordings operations.
+ */
 export class RecordingTranscriptions extends APIResource {
   /**
    * Retrieves the details of an existing recording transcription.

package/src/resources/recordings/actions.ts

@@ -5,6 +5,9 @@ import { APIPromise } from '../../core/api-promise';
 import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 
+/**
+ * Call Recordings operations.
+ */
 export class Actions extends APIResource {
   /**
    * Permanently deletes a list of call recordings.

package/src/resources/recordings/recordings.ts

@@ -8,6 +8,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Call Recordings operations.
+ */
 export class Recordings extends APIResource {
   actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
 

package/src/resources/regions.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Regions
+ */
 export class Regions extends APIResource {
   /**
    * List all regions and the interfaces that region supports

package/src/resources/regulatory-requirements.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Regulatory Requirements
+ */
 export class RegulatoryRequirements extends APIResource {
   /**
    * Retrieve regulatory requirements

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

@@ -4,6 +4,9 @@ import { APIResource } from '../../core/resource';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 
+/**
+ * Voice usage reports
+ */
 export class CdrUsageReports extends APIResource {
   /**
    * Generate and fetch voice usage report synchronously. This endpoint will both

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

@@ -7,6 +7,9 @@ import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Messaging usage reports
+ */
 export class MdrUsageReports extends APIResource {
   /**
    * Submit request for new new messaging usage report. This endpoint will pull and

package/src/resources/requirement-groups.ts

@@ -5,6 +5,9 @@ import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Requirement Groups
+ */
 export class RequirementGroups extends APIResource {
   /**
    * Create a new requirement group

package/src/resources/requirement-types.ts

@@ -7,6 +7,9 @@ import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Types of requirements for international numbers and porting orders
+ */
 export class RequirementTypes extends APIResource {
   /**
    * Retrieve a requirement type by id

package/src/resources/requirements.ts

@@ -7,6 +7,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Requirements for international numbers and porting orders
+ */
 export class Requirements extends APIResource {
   /**
    * Retrieve a document requirement record

package/src/resources/room-compositions.ts

@@ -7,6 +7,9 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Rooms Compositions operations.
+ */
 export class RoomCompositions extends APIResource {
   /**
    * Asynchronously create a room composition.

package/src/resources/room-participants.ts

@@ -8,6 +8,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Rooms Participants operations.
+ */
 export class RoomParticipants extends APIResource {
   /**
    * View a room participant.

package/src/resources/room-recordings.ts

@@ -7,6 +7,9 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Rooms Recordings operations.
+ */
 export class RoomRecordings extends APIResource {
   /**
    * View a room recording.

package/src/resources/rooms/actions.ts

@@ -5,6 +5,9 @@ import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Rooms Client Tokens operations.
+ */
 export class Actions extends APIResource {
   /**
    * Synchronously create an Client Token to join a Room. Client Token is necessary

package/src/resources/rooms/rooms.ts

@@ -25,6 +25,9 @@ import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Rooms operations.
+ */
 export class Rooms extends APIResource {
   actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
   sessions: SessionsAPI.Sessions = new SessionsAPI.Sessions(this._client);

package/src/resources/rooms/sessions/actions.ts

@@ -5,6 +5,9 @@ import { APIPromise } from '../../../core/api-promise';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * Rooms Sessions operations.
+ */
 export class Actions extends APIResource {
   /**
    * Note: this will also kick all participants currently present in the room

package/src/resources/session-analysis/index.ts

@@ -0,0 +1,16 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Metadata,
+  type ChildRelationshipInfo,
+  type MetadataFieldMapping,
+  type ParentRelationshipInfo,
+  type MetadataRetrieveResponse,
+  type MetadataRetrieveRecordTypeResponse,
+} from './metadata';
+export {
+  SessionAnalysis,
+  type EventNode,
+  type SessionAnalysisRetrieveResponse,
+  type SessionAnalysisRetrieveParams,
+} from './session-analysis';

package/src/resources/session-analysis/metadata.ts

@@ -0,0 +1,165 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as MetadataAPI from './metadata';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * Analyze voice AI sessions, costs, and event hierarchies across Telnyx products.
+ */
+export class Metadata extends APIResource {
+  /**
+   * Returns all available record types and supported query parameters for session
+   * analysis.
+   */
+  retrieve(options?: RequestOptions): APIPromise<MetadataRetrieveResponse> {
+    return this._client.get('/session_analysis/metadata', options);
+  }
+
+  /**
+   * Returns detailed metadata for a specific record type, including relationships
+   * and examples.
+   */
+  retrieveRecordType(
+    recordType: string,
+    options?: RequestOptions,
+  ): APIPromise<MetadataRetrieveRecordTypeResponse> {
+    return this._client.get(path`/session_analysis/metadata/${recordType}`, options);
+  }
+}
+
+export interface ChildRelationshipInfo {
+  child_event: string;
+
+  child_product: string;
+
+  child_record_type: string;
+
+  cost_rollup: boolean;
+
+  description: string;
+
+  relationship_type: string;
+
+  traversal_enabled: boolean;
+
+  via: MetadataFieldMapping;
+}
+
+export interface MetadataFieldMapping {
+  local_field: string;
+
+  parent_field: string;
+}
+
+export interface ParentRelationshipInfo {
+  cost_rollup: boolean;
+
+  description: string;
+
+  parent_event: string;
+
+  parent_product: string;
+
+  parent_record_type: string;
+
+  relationship_type: string;
+
+  traversal_enabled: boolean;
+
+  via: MetadataFieldMapping;
+}
+
+export interface MetadataRetrieveResponse {
+  meta: MetadataRetrieveResponse.Meta;
+
+  /**
+   * Map of supported query parameter names to their definitions.
+   */
+  query_parameters: { [key: string]: MetadataRetrieveResponse.QueryParameters };
+
+  record_types: Array<MetadataRetrieveResponse.RecordType>;
+}
+
+export namespace MetadataRetrieveResponse {
+  export interface Meta {
+    last_updated: string;
+
+    total_record_types: number;
+  }
+
+  export interface QueryParameters {
+    default: string;
+
+    description: string;
+
+    type: string;
+
+    enum_values?: Array<string> | null;
+
+    max?: number | null;
+
+    min?: number | null;
+  }
+
+  export interface RecordType {
+    aliases: Array<string>;
+
+    child_relationships: Array<MetadataAPI.ChildRelationshipInfo>;
+
+    description: string;
+
+    event: string;
+
+    parent_relationships: Array<MetadataAPI.ParentRelationshipInfo>;
+
+    product: string;
+
+    record_type: string;
+  }
+}
+
+export interface MetadataRetrieveRecordTypeResponse {
+  aliases: Array<string>;
+
+  child_relationships: Array<ChildRelationshipInfo>;
+
+  event: string;
+
+  /**
+   * Example queries and responses for this record type.
+   */
+  examples: { [key: string]: unknown };
+
+  meta: MetadataRetrieveRecordTypeResponse.Meta;
+
+  parent_relationships: Array<ParentRelationshipInfo>;
+
+  product: string;
+
+  record_type: string;
+}
+
+export namespace MetadataRetrieveRecordTypeResponse {
+  export interface Meta {
+    max_recommended_depth: number;
+
+    total_children: number;
+
+    total_parents: number;
+
+    total_siblings: number;
+  }
+}
+
+export declare namespace Metadata {
+  export {
+    type ChildRelationshipInfo as ChildRelationshipInfo,
+    type MetadataFieldMapping as MetadataFieldMapping,
+    type ParentRelationshipInfo as ParentRelationshipInfo,
+    type MetadataRetrieveResponse as MetadataRetrieveResponse,
+    type MetadataRetrieveRecordTypeResponse as MetadataRetrieveRecordTypeResponse,
+  };
+}