telnyx 5.50.0 → 6.2.0

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

@@ -0,0 +1,233 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as MetadataAPI from './metadata';
+import {
+  ChildRelationshipInfo,
+  Metadata,
+  MetadataFieldMapping,
+  MetadataRetrieveRecordTypeResponse,
+  MetadataRetrieveResponse,
+  ParentRelationshipInfo,
+} 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 SessionAnalysis extends APIResource {
+  metadata: MetadataAPI.Metadata = new MetadataAPI.Metadata(this._client);
+
+  /**
+   * Retrieves a full session analysis tree for a given event, including costs, child
+   * events, and product linkages.
+   */
+  retrieve(
+    eventID: string,
+    params: SessionAnalysisRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<SessionAnalysisRetrieveResponse> {
+    const { record_type, ...query } = params;
+    return this._client.get(path`/session_analysis/${record_type}/${eventID}`, { query, ...options });
+  }
+}
+
+export interface EventNode {
+  /**
+   * Event identifier.
+   */
+  id: string;
+
+  /**
+   * Child events in the session tree.
+   */
+  children: Array<EventNode>;
+
+  cost: EventNode.Cost;
+
+  /**
+   * Name of the event type.
+   */
+  event_name: string;
+
+  links: EventNode.Links;
+
+  /**
+   * Product that generated this event.
+   */
+  product: string;
+
+  /**
+   * The underlying detail record data. Contents vary by record type.
+   */
+  record: { [key: string]: unknown };
+
+  /**
+   * Relationship to the parent node, null for root.
+   */
+  relationship?: EventNode.Relationship | null;
+}
+
+export namespace EventNode {
+  export interface Cost {
+    /**
+     * Cumulative cost including all descendants.
+     */
+    cumulative_cost: string;
+
+    /**
+     * ISO 4217 currency code.
+     */
+    currency: string;
+
+    /**
+     * Cost of this individual event.
+     */
+    event_cost: string;
+  }
+
+  export interface Links {
+    /**
+     * Link to the underlying detail records.
+     */
+    records: string;
+
+    /**
+     * Link to this session analysis node.
+     */
+    self: string;
+  }
+
+  /**
+   * Relationship to the parent node, null for root.
+   */
+  export interface Relationship {
+    /**
+     * Identifier of the parent event.
+     */
+    parent_id: string;
+
+    /**
+     * Relationship type identifier.
+     */
+    type: string;
+
+    via: Relationship.Via;
+  }
+
+  export namespace Relationship {
+    export interface Via {
+      /**
+       * Field name on the child record.
+       */
+      local_field: string;
+
+      /**
+       * Field name on the parent record.
+       */
+      parent_field: string;
+    }
+  }
+}
+
+export interface SessionAnalysisRetrieveResponse {
+  cost: SessionAnalysisRetrieveResponse.Cost;
+
+  /**
+   * When the session started.
+   */
+  created_at: string;
+
+  meta: SessionAnalysisRetrieveResponse.Meta;
+
+  root: EventNode;
+
+  /**
+   * Identifier for the analyzed session.
+   */
+  session_id: string;
+
+  /**
+   * Analysis status (e.g. "completed").
+   */
+  status: string;
+
+  /**
+   * When the session completed.
+   */
+  completed_at?: string | null;
+}
+
+export namespace SessionAnalysisRetrieveResponse {
+  export interface Cost {
+    /**
+     * ISO 4217 currency code.
+     */
+    currency: string;
+
+    /**
+     * Total session cost as a decimal string.
+     */
+    total: string;
+  }
+
+  export interface Meta {
+    /**
+     * Total number of events in the session tree.
+     */
+    event_count: number;
+
+    /**
+     * List of distinct products involved in the session.
+     */
+    products: Array<string>;
+  }
+}
+
+export interface SessionAnalysisRetrieveParams {
+  /**
+   * Path param: The record type identifier.
+   */
+  record_type: string;
+
+  /**
+   * Query param: ISO 8601 timestamp to narrow index selection for faster lookups.
+   */
+  date_time?: string;
+
+  /**
+   * Query param: Controls what data to expand on each event node.
+   */
+  expand?: 'record' | 'none';
+
+  /**
+   * Query param: Whether to include child events in the response.
+   */
+  include_children?: boolean;
+
+  /**
+   * Query param: Maximum traversal depth for the event tree.
+   */
+  max_depth?: number;
+}
+
+SessionAnalysis.Metadata = Metadata;
+
+export declare namespace SessionAnalysis {
+  export {
+    type EventNode as EventNode,
+    type SessionAnalysisRetrieveResponse as SessionAnalysisRetrieveResponse,
+    type SessionAnalysisRetrieveParams as SessionAnalysisRetrieveParams,
+  };
+
+  export {
+    Metadata as Metadata,
+    type ChildRelationshipInfo as ChildRelationshipInfo,
+    type MetadataFieldMapping as MetadataFieldMapping,
+    type ParentRelationshipInfo as ParentRelationshipInfo,
+    type MetadataRetrieveResponse as MetadataRetrieveResponse,
+    type MetadataRetrieveRecordTypeResponse as MetadataRetrieveRecordTypeResponse,
+  };
+}

package/src/resources/session-analysis.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './session-analysis/index';

package/src/resources/seti.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Observability into Telnyx platform stability and performance.
+ */
 export class Seti extends APIResource {
   /**
    * Returns the results of the various black box tests

package/src/resources/short-codes.ts

@@ -8,6 +8,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Short codes
+ */
 export class ShortCodes extends APIResource {
   /**
    * Retrieve a short code

package/src/resources/sim-card-data-usage-notifications.ts

@@ -6,6 +6,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * SIM Cards operations
+ */
 export class SimCardDataUsageNotifications extends APIResource {
   /**
    * Creates a new SIM card data usage notification.

package/src/resources/sim-card-groups/sim-card-groups.ts

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

package/src/resources/sim-card-order-preview.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * SIM Card Orders operations
+ */
 export class SimCardOrderPreview extends APIResource {
   /**
    * Preview SIM card order purchases.

package/src/resources/sim-card-orders.ts

@@ -6,6 +6,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * SIM Card Orders operations
+ */
 export class SimCardOrders extends APIResource {
   /**
    * Creates a new order for SIM cards.

package/src/resources/sim-cards/sim-cards.ts

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

package/src/resources/siprec-connectors.ts

@@ -6,6 +6,9 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * SIPREC connectors configuration.
+ */
 export class SiprecConnectors extends APIResource {
   /**
    * Creates a new SIPREC connector configuration.

package/src/resources/speech-to-text.ts

@@ -5,6 +5,9 @@ import { APIPromise } from '../core/api-promise';
 import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Speech to text command operations
+ */
 export class SpeechToText extends APIResource {
   /**
    * Transcribe audio streams to text over WebSocket.

package/src/resources/storage/buckets/buckets.ts

@@ -22,6 +22,9 @@ import { APIPromise } from '../../../core/api-promise';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * Presigned object URL operations
+ */
 export class Buckets extends APIResource {
   sslCertificate: SslCertificateAPI.SslCertificateResource = new SslCertificateAPI.SslCertificateResource(
     this._client,

package/src/resources/storage/buckets/ssl-certificate.ts

@@ -7,6 +7,9 @@ import { RequestOptions } from '../../../internal/request-options';
 import { multipartFormRequestOptions } from '../../../internal/uploads';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * SSL certificate operations
+ */
 export class SslCertificateResource extends APIResource {
   /**
    * Uploads an SSL certificate and its matching secret so that you can use Telnyx's

package/src/resources/storage/buckets/usage.ts

@@ -5,6 +5,9 @@ import { APIPromise } from '../../../core/api-promise';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * Bucket Usage operations
+ */
 export class Usage extends APIResource {
   /**
    * Returns the detail on API usage on a bucket of a particular time period, group

package/src/resources/storage/migration-sources.ts

@@ -6,6 +6,9 @@ import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Migrate data from an external provider into Telnyx Cloud Storage
+ */
 export class MigrationSources extends APIResource {
   /**
    * Create a source from which data can be migrated from.

package/src/resources/storage/migrations/actions.ts

@@ -6,6 +6,9 @@ import { APIPromise } from '../../../core/api-promise';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * Migrate data from an external provider into Telnyx Cloud Storage
+ */
 export class Actions extends APIResource {
   /**
    * Stop a Migration

package/src/resources/storage/migrations/migrations.ts

@@ -8,6 +8,9 @@ import { APIPromise } from '../../../core/api-promise';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * Migrate data from an external provider into Telnyx Cloud Storage
+ */
 export class Migrations extends APIResource {
   actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
 

package/src/resources/storage/storage.ts

@@ -26,6 +26,9 @@ import {
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 
+/**
+ * Migrate data from an external provider into Telnyx Cloud Storage
+ */
 export class Storage extends APIResource {
   buckets: BucketsAPI.Buckets = new BucketsAPI.Buckets(this._client);
   migrationSources: MigrationSourcesAPI.MigrationSources = new MigrationSourcesAPI.MigrationSources(

package/src/resources/sub-number-orders-report.ts

@@ -7,6 +7,9 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Number orders
+ */
 export class SubNumberOrdersReportResource extends APIResource {
   /**
    * Create a CSV report for sub number orders. The report will be generated

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

@@ -54,6 +54,9 @@ import { APIPromise } from '../../../core/api-promise';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * TeXML REST Commands
+ */
 export class Accounts extends APIResource {
   calls: CallsAPI.Calls = new CallsAPI.Calls(this._client);
   conferences: ConferencesAPI.Conferences = new ConferencesAPI.Conferences(this._client);

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

@@ -20,6 +20,9 @@ import { buildHeaders } from '../../../../internal/headers';
 import { RequestOptions } from '../../../../internal/request-options';
 import { path } from '../../../../internal/utils/path';
 
+/**
+ * TeXML REST Commands
+ */
 export class Calls extends APIResource {
   recordingsJson: RecordingsJsonAPI.RecordingsJson = new RecordingsJsonAPI.RecordingsJson(this._client);
   recordings: RecordingsAPI.Recordings = new RecordingsAPI.Recordings(this._client);

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

@@ -7,6 +7,9 @@ import { buildHeaders } from '../../../../internal/headers';
 import { RequestOptions } from '../../../../internal/request-options';
 import { path } from '../../../../internal/utils/path';
 
+/**
+ * TeXML REST Commands
+ */
 export class RecordingsJson extends APIResource {
   /**
    * Starts recording with specified parameters for call idientified by call_sid.

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

@@ -6,6 +6,9 @@ import { buildHeaders } from '../../../../internal/headers';
 import { RequestOptions } from '../../../../internal/request-options';
 import { path } from '../../../../internal/utils/path';
 
+/**
+ * TeXML REST Commands
+ */
 export class Recordings extends APIResource {
   /**
    * Updates recording resource for particular call.

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

@@ -6,6 +6,9 @@ import { buildHeaders } from '../../../../internal/headers';
 import { RequestOptions } from '../../../../internal/request-options';
 import { path } from '../../../../internal/utils/path';
 
+/**
+ * TeXML REST Commands
+ */
 export class Siprec extends APIResource {
   /**
    * Updates siprec session identified by siprec_sid.

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

@@ -6,6 +6,9 @@ import { buildHeaders } from '../../../../internal/headers';
 import { RequestOptions } from '../../../../internal/request-options';
 import { path } from '../../../../internal/utils/path';
 
+/**
+ * TeXML REST Commands
+ */
 export class Streams extends APIResource {
   /**
    * Updates streaming resource for particular call.

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

@@ -20,6 +20,9 @@ import { buildHeaders } from '../../../../internal/headers';
 import { RequestOptions } from '../../../../internal/request-options';
 import { path } from '../../../../internal/utils/path';
 
+/**
+ * TeXML REST Commands
+ */
 export class Conferences extends APIResource {
   participants: ParticipantsAPI.Participants = new ParticipantsAPI.Participants(this._client);
 

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

@@ -6,6 +6,9 @@ import { buildHeaders } from '../../../../internal/headers';
 import { RequestOptions } from '../../../../internal/request-options';
 import { path } from '../../../../internal/utils/path';
 
+/**
+ * TeXML REST Commands
+ */
 export class Participants extends APIResource {
   /**
    * Gets conference participant resource

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

@@ -11,6 +11,9 @@ import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * TeXML REST Commands
+ */
 export class Queues extends APIResource {
   /**
    * Creates a new queue resource.

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

@@ -7,6 +7,9 @@ import { buildHeaders } from '../../../../internal/headers';
 import { RequestOptions } from '../../../../internal/request-options';
 import { path } from '../../../../internal/utils/path';
 
+/**
+ * TeXML REST Commands
+ */
 export class Json extends APIResource {
   /**
    * Deletes recording resource identified by recording id.

package/src/resources/texml/accounts/transcriptions/json.ts

@@ -6,6 +6,9 @@ import { buildHeaders } from '../../../../internal/headers';
 import { RequestOptions } from '../../../../internal/request-options';
 import { path } from '../../../../internal/utils/path';
 
+/**
+ * TeXML REST Commands
+ */
 export class Json extends APIResource {
   /**
    * Permanently deletes a recording transcription.

package/src/resources/texml/texml.ts

@@ -14,6 +14,9 @@ import {
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 
+/**
+ * TeXML REST Commands
+ */
 export class Texml extends APIResource {
   accounts: AccountsAPI.Accounts = new AccountsAPI.Accounts(this._client);
 

package/src/resources/texml-applications.ts

@@ -7,6 +7,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * TeXML Applications operations
+ */
 export class TexmlApplications extends APIResource {
   /**
    * Creates a TeXML Application.