telnyx 5.51.0 → 6.2.0

package/src/resources/ai/assistants/assistants.ts

@@ -51,6 +51,9 @@ import { APIPromise } from '../../../core/api-promise';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * Configure AI assistant specifications
+ */
 export class Assistants extends APIResource {
   tests: TestsAPI.Tests = new TestsAPI.Tests(this._client);
   canaryDeploys: CanaryDeploysAPI.CanaryDeploys = new CanaryDeploysAPI.CanaryDeploys(this._client);
@@ -367,6 +370,7 @@ export type AssistantTool =
   | AssistantTool.Handoff
   | HangupTool
   | AssistantTool.Transfer
+  | AssistantTool.Invite
   | AssistantTool.Refer
   | AssistantTool.SendDtmf
   | AssistantTool.SendMessage
@@ -605,6 +609,75 @@ export namespace AssistantTool {
     }
   }
 
+  export interface Invite {
+    invite: Invite.Invite;
+
+    type: 'invite';
+  }
+
+  export namespace Invite {
+    export interface Invite {
+      /**
+       * Custom headers to be added to the SIP INVITE for the invite command.
+       */
+      custom_headers?: Array<Invite.CustomHeader>;
+
+      /**
+       * Number or SIP URI placing the call.
+       */
+      from?: string;
+
+      /**
+       * Configuration for voicemail detection (AMD - Answering Machine Detection) on the
+       * invited call.
+       */
+      voicemail_detection?: Invite.VoicemailDetection;
+    }
+
+    export namespace Invite {
+      export interface CustomHeader {
+        name?: string;
+
+        /**
+         * The value of the header. Note that we support mustache templating for the value.
+         * For example you can use
+         * `{{#integration_secret}}test-secret{{/integration_secret}}` to pass the value of
+         * the integration secret.
+         */
+        value?: string;
+      }
+
+      /**
+       * Configuration for voicemail detection (AMD - Answering Machine Detection) on the
+       * invited call.
+       */
+      export interface VoicemailDetection {
+        /**
+         * The AMD detection mode to use. 'premium' enables premium answering machine
+         * detection. 'disabled' turns off AMD detection.
+         */
+        detection_mode?: 'disabled' | 'premium';
+
+        /**
+         * Action to take when voicemail is detected on the invited call.
+         */
+        on_voicemail_detected?: VoicemailDetection.OnVoicemailDetected;
+      }
+
+      export namespace VoicemailDetection {
+        /**
+         * Action to take when voicemail is detected on the invited call.
+         */
+        export interface OnVoicemailDetected {
+          /**
+           * The action to take when voicemail is detected.
+           */
+          action?: 'stop_invite';
+        }
+      }
+    }
+  }
+
   export interface Refer {
     refer: Refer.Refer;
 

package/src/resources/ai/assistants/canary-deploys.ts

@@ -6,6 +6,9 @@ import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * Configure AI assistant specifications
+ */
 export class CanaryDeploys extends APIResource {
   /**
    * Endpoint to create a canary deploy configuration for an assistant.

package/src/resources/ai/assistants/scheduled-events.ts

@@ -11,6 +11,9 @@ import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * Configure AI assistant specifications
+ */
 export class ScheduledEvents extends APIResource {
   /**
    * Create a scheduled event for an assistant

package/src/resources/ai/assistants/tests/runs.ts

@@ -10,6 +10,9 @@ import {
 import { RequestOptions } from '../../../../internal/request-options';
 import { path } from '../../../../internal/utils/path';
 
+/**
+ * Configure AI assistant specifications
+ */
 export class Runs extends APIResource {
   /**
    * Retrieves detailed information about a specific test run execution

package/src/resources/ai/assistants/tests/test-suites/runs.ts

@@ -12,6 +12,9 @@ import {
 import { RequestOptions } from '../../../../../internal/request-options';
 import { path } from '../../../../../internal/utils/path';
 
+/**
+ * Configure AI assistant specifications
+ */
 export class Runs extends APIResource {
   /**
    * Retrieves paginated history of test runs for a specific test suite with

package/src/resources/ai/assistants/tests/test-suites/test-suites.ts

@@ -13,6 +13,9 @@ import {
 import { APIPromise } from '../../../../../core/api-promise';
 import { RequestOptions } from '../../../../../internal/request-options';
 
+/**
+ * Configure AI assistant specifications
+ */
 export class TestSuites extends APIResource {
   runs: RunsAPI.Runs = new RunsAPI.Runs(this._client);
 

package/src/resources/ai/assistants/tests/tests.ts

@@ -24,6 +24,9 @@ import { buildHeaders } from '../../../../internal/headers';
 import { RequestOptions } from '../../../../internal/request-options';
 import { path } from '../../../../internal/utils/path';
 
+/**
+ * Configure AI assistant specifications
+ */
 export class Tests extends APIResource {
   testSuites: TestSuitesAPI.TestSuites = new TestSuitesAPI.TestSuites(this._client);
   runs: RunsAPI.Runs = new RunsAPI.Runs(this._client);

package/src/resources/ai/assistants/tools.ts

@@ -5,6 +5,9 @@ import { APIPromise } from '../../../core/api-promise';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * Configure AI assistant specifications
+ */
 export class Tools extends APIResource {
   /**
    * Test a webhook tool for an assistant

package/src/resources/ai/assistants/versions.ts

@@ -7,6 +7,9 @@ import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * Configure AI assistant specifications
+ */
 export class Versions extends APIResource {
   /**
    * Retrieves a specific version of an assistant by assistant_id and version_id

package/src/resources/ai/audio.ts

@@ -6,6 +6,9 @@ import { type Uploadable } from '../../core/uploads';
 import { RequestOptions } from '../../internal/request-options';
 import { multipartFormRequestOptions } from '../../internal/uploads';
 
+/**
+ * Turn audio into text or text into audio.
+ */
 export class Audio extends APIResource {
   /**
    * Transcribe speech to text. This endpoint is consistent with the

package/src/resources/ai/chat.ts

@@ -5,6 +5,9 @@ import * as ChatAPI from './chat';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 
+/**
+ * Generate text with LLMs
+ */
 export class Chat extends APIResource {
   /**
    * Chat with a language model. This endpoint is consistent with the

package/src/resources/ai/clusters.ts

@@ -9,6 +9,9 @@ import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Identify common themes and patterns in your embedded documents
+ */
 export class Clusters extends APIResource {
   /**
    * Fetch a cluster

package/src/resources/ai/conversations/conversations.ts

@@ -29,6 +29,9 @@ import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * Manage historical AI assistant conversations
+ */
 export class Conversations extends APIResource {
   insightGroups: InsightGroupsAPI.InsightGroups = new InsightGroupsAPI.InsightGroups(this._client);
   insights: InsightsAPI.Insights = new InsightsAPI.Insights(this._client);

package/src/resources/ai/conversations/insight-groups/insight-groups.ts

@@ -14,6 +14,9 @@ import { buildHeaders } from '../../../../internal/headers';
 import { RequestOptions } from '../../../../internal/request-options';
 import { path } from '../../../../internal/utils/path';
 
+/**
+ * Manage historical AI assistant conversations
+ */
 export class InsightGroups extends APIResource {
   insights: InsightGroupsInsightsAPI.Insights = new InsightGroupsInsightsAPI.Insights(this._client);
 

package/src/resources/ai/conversations/insight-groups/insights.ts

@@ -6,6 +6,9 @@ import { buildHeaders } from '../../../../internal/headers';
 import { RequestOptions } from '../../../../internal/request-options';
 import { path } from '../../../../internal/utils/path';
 
+/**
+ * Manage historical AI assistant conversations
+ */
 export class Insights extends APIResource {
   /**
    * Assign an insight to a group

package/src/resources/ai/conversations/insights.ts

@@ -11,6 +11,9 @@ import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * Manage historical AI assistant conversations
+ */
 export class Insights extends APIResource {
   /**
    * Create a new insight

package/src/resources/ai/conversations/messages.ts

@@ -6,6 +6,9 @@ import { APIPromise } from '../../../core/api-promise';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * Manage historical AI assistant conversations
+ */
 export class Messages extends APIResource {
   /**
    * Retrieve messages for a specific conversation, including tool calls made by the

package/src/resources/ai/embeddings/buckets.ts

@@ -6,6 +6,9 @@ import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * Embed documents and perform text searches
+ */
 export class Buckets extends APIResource {
   /**
    * Get all embedded files for a given user bucket, including their processing

package/src/resources/ai/embeddings/embeddings.ts

@@ -8,6 +8,9 @@ import { APIPromise } from '../../../core/api-promise';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * Embed documents and perform text searches
+ */
 export class Embeddings extends APIResource {
   buckets: BucketsAPI.Buckets = new BucketsAPI.Buckets(this._client);
 

package/src/resources/ai/fine-tuning/jobs.ts

@@ -5,6 +5,9 @@ import { APIPromise } from '../../../core/api-promise';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * Customize LLMs for your unique needs
+ */
 export class Jobs extends APIResource {
   /**
    * Create a new fine tuning job.

package/src/resources/ai/openai/embeddings.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../../../core/resource';
 import { APIPromise } from '../../../core/api-promise';
 import { RequestOptions } from '../../../internal/request-options';
 
+/**
+ * OpenAI-compatible embeddings endpoints for generating vector representations of text
+ */
 export class Embeddings extends APIResource {
   /**
    * Creates an embedding vector representing the input text. This endpoint is

package/src/resources/audit-events.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../core/resource';
 import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Audit log operations.
+ */
 export class AuditEvents extends APIResource {
   /**
    * Retrieve a list of audit log entries. Audit logs are a best-effort, eventually

package/src/resources/available-phone-number-blocks.ts

@@ -5,6 +5,9 @@ import * as Shared from './shared';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Number search
+ */
 export class AvailablePhoneNumberBlocks extends APIResource {
   /**
    * List available phone number blocks

package/src/resources/available-phone-numbers.ts

@@ -5,6 +5,9 @@ import * as Shared from './shared';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Number search
+ */
 export class AvailablePhoneNumbers extends APIResource {
   /**
    * List available phone numbers

package/src/resources/balance.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Billing operations
+ */
 export class Balance extends APIResource {
   /**
    * Get user balance details

package/src/resources/billing-groups.ts

@@ -6,6 +6,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Billing groups operations
+ */
 export class BillingGroups extends APIResource {
   /**
    * Create a billing group

package/src/resources/bulk-sim-card-actions.ts

@@ -7,6 +7,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * View SIM card actions, their progress and timestamps using the SIM Card Actions API
+ */
 export class BulkSimCardActions extends APIResource {
   /**
    * This API fetches information about a bulk SIM card action. A bulk SIM card

package/src/resources/call-control-applications.ts

@@ -6,6 +6,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Call Control applications operations
+ */
 export class CallControlApplications extends APIResource {
   /**
    * Create a call control application.

package/src/resources/call-events.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../core/resource';
 import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Call Control debugging
+ */
 export class CallEvents extends APIResource {
   /**
    * Filters call events by given filter parameters. Events are ordered by

package/src/resources/calls/actions.ts

@@ -8,6 +8,9 @@ import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Call Control command operations
+ */
 export class Actions extends APIResource {
   /**
    * Add messages to the conversation started by an AI assistant on the call.
@@ -935,7 +938,7 @@ export interface CallControlCommandResultWithConversationID {
 }
 
 export interface DeepgramNova2Config {
-  transcription_engine: 'Deepgram';
+  transcription_engine: 'deepgram/nova-2';
 
   transcription_model: 'deepgram/nova-2';
 
@@ -1009,7 +1012,7 @@ export interface DeepgramNova2Config {
 }
 
 export interface DeepgramNova3Config {
-  transcription_engine: 'Deepgram';
+  transcription_engine: 'deepgram/nova-3';
 
   transcription_model: 'deepgram/nova-3';
 
@@ -1634,11 +1637,11 @@ export interface TranscriptionStartRequest {
   transcription_engine_config?:
     | TranscriptionEngineGoogleConfig
     | TranscriptionEngineTelnyxConfig
-    | DeepgramNova2Config
-    | DeepgramNova3Config
     | TranscriptionEngineAzureConfig
     | TranscriptionEngineAConfig
-    | TranscriptionEngineBConfig;
+    | TranscriptionEngineBConfig
+    | DeepgramNova2Config
+    | DeepgramNova3Config;
 
   /**
    * Indicates which leg of the call will be transcribed. Use `inbound` for the leg
@@ -3881,11 +3884,11 @@ export interface ActionStartTranscriptionParams {
   transcription_engine_config?:
     | TranscriptionEngineGoogleConfig
     | TranscriptionEngineTelnyxConfig
-    | DeepgramNova2Config
-    | DeepgramNova3Config
     | TranscriptionEngineAzureConfig
     | TranscriptionEngineAConfig
-    | TranscriptionEngineBConfig;
+    | TranscriptionEngineBConfig
+    | DeepgramNova2Config
+    | DeepgramNova3Config;
 
   /**
    * Indicates which leg of the call will be transcribed. Use `inbound` for the leg

package/src/resources/channel-zones.ts

@@ -6,6 +6,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Voice Channels
+ */
 export class ChannelZones extends APIResource {
   /**
    * Update the number of Voice Channels for the Non-US Zones. This allows your

package/src/resources/comments.ts

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

package/src/resources/conferences/actions.ts

@@ -7,6 +7,9 @@ import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Conference command operations
+ */
 export class Actions extends APIResource {
   /**
    * Update conference participant supervisor_role

package/src/resources/conferences/conferences.ts

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

package/src/resources/country-coverage.ts

@@ -5,6 +5,9 @@ import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Country Coverage
+ */
 export class CountryCoverageResource extends APIResource {
   /**
    * Get country coverage

package/src/resources/credential-connections/actions.ts

@@ -5,6 +5,9 @@ import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Credential connection operations
+ */
 export class Actions extends APIResource {
   /**
    * Checks the registration_status for a credential connection,

package/src/resources/credential-connections/credential-connections.ts

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

package/src/resources/custom-storage-credentials.ts

@@ -6,6 +6,9 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Call Recordings operations.
+ */
 export class CustomStorageCredentials extends APIResource {
   /**
    * Creates a custom storage credentials configuration.

package/src/resources/customer-service-records.ts

@@ -6,6 +6,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Customer Service Record operations
+ */
 export class CustomerServiceRecords extends APIResource {
   /**
    * Create a new customer service record for the provided phone number.

package/src/resources/detail-records.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../core/resource';
 import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Detail Records operations
+ */
 export class DetailRecords extends APIResource {
   /**
    * Search for any detail record across the Telnyx Platform

package/src/resources/dialogflow-connections.ts

@@ -6,6 +6,9 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Dialogflow Connection Operations.
+ */
 export class DialogflowConnections extends APIResource {
   /**
    * Save Dialogflow Credentiails to Telnyx, so it can be used with other Telnyx

package/src/resources/document-links.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../core/resource';
 import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Documents
+ */
 export class DocumentLinks extends APIResource {
   /**
    * List all documents links ordered by created_at descending.

package/src/resources/documents.ts

@@ -7,6 +7,9 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Documents
+ */
 export class Documents extends APIResource {
   /**
    * Retrieve a document.

package/src/resources/dynamic-emergency-addresses.ts

@@ -6,6 +6,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Dynamic emergency address operations
+ */
 export class DynamicEmergencyAddresses extends APIResource {
   /**
    * Creates a dynamic emergency address.

package/src/resources/dynamic-emergency-endpoints.ts

@@ -6,6 +6,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Dynamic Emergency Endpoints
+ */
 export class DynamicEmergencyEndpoints extends APIResource {
   /**
    * Creates a dynamic emergency endpoints.

package/src/resources/external-connections/civic-addresses.ts

@@ -5,6 +5,9 @@ import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * External Connections operations
+ */
 export class CivicAddresses extends APIResource {
   /**
    * Return the details of an existing Civic Address with its Locations inside the