telnyx 7.13.0 → 7.15.0

package/src/resources/ai/ai.ts

@@ -37,6 +37,7 @@ import {
   ToolListParams,
   ToolUpdateParams,
   Tools,
+  UpdateDynamicVariablesToolParams,
 } from './tools';
 import * as AnthropicAPI from './anthropic/anthropic';
 import { Anthropic } from './anthropic/anthropic';
@@ -98,6 +99,18 @@ import {
   WebhookTool,
   WidgetSettings,
 } from './assistants/assistants';
+import * as CollectionsAPI from './collections/collections';
+import {
+  Collection,
+  CollectionCreateParams,
+  CollectionEnvelope,
+  CollectionListParams,
+  CollectionRetrieveDocumentsParams,
+  CollectionRetrieveDocumentsResponse,
+  CollectionUpdateParams,
+  Collections,
+  CollectionsDefaultFlatPagination,
+} from './collections/collections';
 import * as ConversationsAPI from './conversations/conversations';
 import {
   Conversation,
@@ -152,6 +165,7 @@ export class AI extends APIResource {
   audio: AudioAPI.Audio = new AudioAPI.Audio(this._client);
   chat: ChatAPI.Chat = new ChatAPI.Chat(this._client);
   clusters: ClustersAPI.Clusters = new ClustersAPI.Clusters(this._client);
+  collections: CollectionsAPI.Collections = new CollectionsAPI.Collections(this._client);
   conversations: ConversationsAPI.Conversations = new ConversationsAPI.Conversations(this._client);
   embeddings: EmbeddingsAPI.Embeddings = new EmbeddingsAPI.Embeddings(this._client);
   fineTuning: FineTuningAPI.FineTuning = new FineTuningAPI.FineTuning(this._client);
@@ -178,8 +192,9 @@ export class AI extends APIResource {
    * @example
    * ```ts
    * const response = await client.ai.summarize({
-   *   bucket: 'bucket',
-   *   filename: 'filename',
+   *   bucket: 'string',
+   *   filename: 'string',
+   *   system_prompt: 'string',
    * });
    * ```
    */
@@ -232,13 +247,11 @@ export class AI extends APIResource {
    *
    * **Examples:**
    *
-   * ```
-   * GET /v2/ai/conversation_histories?q=billing+issue&page[size]=10
-   * GET /v2/ai/conversation_histories?q=setup+guide&region=USA&min_score=0.5
-   * GET /v2/ai/conversation_histories?q=refund&filter[record_created_at][gte]=2026-01-01T00:00:00Z
-   * GET /v2/ai/conversation_histories?q=outage&filter[region][in]=USA,DEU
-   * GET /v2/ai/conversation_histories?q=hold+time&filter[language]=en
-   * ```
+   * - `GET /v2/ai/conversation_histories?q=billing+issue&page[size]=10`
+   * - `GET /v2/ai/conversation_histories?q=setup+guide&region=USA&min_score=0.5`
+   * - `GET /v2/ai/conversation_histories?q=refund&filter[record_created_at][gte]=2026-01-01T00:00:00Z`
+   * - `GET /v2/ai/conversation_histories?q=outage&filter[region][in]=USA,DEU`
+   * - `GET /v2/ai/conversation_histories?q=hold+time&filter[language]=en`
    *
    * @example
    * ```ts
@@ -618,6 +631,7 @@ AI.Assistants = Assistants;
 AI.Audio = Audio;
 AI.Chat = Chat;
 AI.Clusters = Clusters;
+AI.Collections = Collections;
 AI.Conversations = Conversations;
 AI.Embeddings = Embeddings;
 AI.FineTuning = FineTuning;
@@ -717,6 +731,18 @@ export declare namespace AI {
     type ClusterFetchGraphParams as ClusterFetchGraphParams,
   };
 
+  export {
+    Collections as Collections,
+    type Collection as Collection,
+    type CollectionEnvelope as CollectionEnvelope,
+    type CollectionRetrieveDocumentsResponse as CollectionRetrieveDocumentsResponse,
+    type CollectionsDefaultFlatPagination as CollectionsDefaultFlatPagination,
+    type CollectionListParams as CollectionListParams,
+    type CollectionCreateParams as CollectionCreateParams,
+    type CollectionRetrieveDocumentsParams as CollectionRetrieveDocumentsParams,
+    type CollectionUpdateParams as CollectionUpdateParams,
+  };
+
   export {
     Conversations as Conversations,
     type Conversation as Conversation,
@@ -784,6 +810,7 @@ export declare namespace AI {
     Tools as Tools,
     type PayToolParams as PayToolParams,
     type SharedToolResponse as SharedToolResponse,
+    type UpdateDynamicVariablesToolParams as UpdateDynamicVariablesToolParams,
     type ToolDeleteResponse as ToolDeleteResponse,
     type SharedToolResponsesDefaultFlatPagination as SharedToolResponsesDefaultFlatPagination,
     type ToolListParams as ToolListParams,

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

@@ -119,8 +119,9 @@ export class Assistants extends APIResource {
    * @example
    * ```ts
    * const assistantsList = await client.ai.assistants.imports({
-   *   api_key_ref: 'api_key_ref',
+   *   api_key_ref: 'string',
    *   provider: 'elevenlabs',
+   *   import_ids: ['string'],
    * });
    * ```
    */
@@ -250,7 +251,11 @@ export class Assistants extends APIResource {
    * ```ts
    * const response = await client.ai.assistants.sendSMS(
    *   'assistant_id',
-   *   { from: 'from', to: 'to' },
+   *   {
+   *     from: 'From',
+   *     to: 'To',
+   *     text: 'Text',
+   *   },
    * );
    * ```
    */
@@ -386,7 +391,8 @@ export type AssistantTool =
   | AssistantTool.SendDtmf
   | AssistantTool.SendMessage
   | AssistantTool.SkipTurn
-  | AssistantTool.Pay;
+  | AssistantTool.Pay
+  | AssistantTool.UpdateDynamicVariables;
 
 export namespace AssistantTool {
   export interface ClientSideTool {
@@ -913,6 +919,22 @@ export namespace AssistantTool {
 
     type: 'pay';
   }
+
+  /**
+   * The update_dynamic_variables tool lets the assistant write values into the
+   * conversation's dynamic-variables context during the call. Updated variables are
+   * available to later `{{variable}}` interpolation (prompts, speak nodes, message
+   * templates) and to flow edge conditions. Declare each variable the assistant is
+   * allowed to set under `updatable_variables`.
+   */
+  export interface UpdateDynamicVariables {
+    type: 'update_dynamic_variables';
+
+    /**
+     * Configuration for an update_dynamic_variables tool.
+     */
+    update_dynamic_variables: ToolsAPI.UpdateDynamicVariablesToolParams;
+  }
 }
 
 export interface AssistantsList {
@@ -2311,6 +2333,13 @@ export interface TelephonySettings {
    */
   default_texml_app_id?: string;
 
+  /**
+   * Disable inbound DTMF for the entire call. Must be set to true if a 'pay' tool is
+   * configured anywhere on the assistant — on the main tool array or on any workflow
+   * node — enforced at write time.
+   */
+  disable_dtmf?: boolean;
+
   /**
    * The noise suppression engine to use. Use 'disabled' to turn off noise
    * suppression.

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

@@ -58,6 +58,25 @@ export class CanaryDeploys extends APIResource {
    * const canaryDeployResponse =
    *   await client.ai.assistants.canaryDeploys.create(
    *     'assistant_id',
+   *     {
+   *       rules: [
+   *         {
+   *           match: [
+   *             {
+   *               attribute: 'Attribute',
+   *               operator: 'in',
+   *               values: ['string'],
+   *             },
+   *           ],
+   *           serve: {
+   *             version_id: 'Version Id',
+   *             rollout: [
+   *               { version_id: 'Version Id', weight: 0 },
+   *             ],
+   *           },
+   *         },
+   *       ],
+   *     },
    *   );
    * ```
    */
@@ -81,6 +100,25 @@ export class CanaryDeploys extends APIResource {
    * const canaryDeployResponse =
    *   await client.ai.assistants.canaryDeploys.update(
    *     'assistant_id',
+   *     {
+   *       rules: [
+   *         {
+   *           match: [
+   *             {
+   *               attribute: 'Attribute',
+   *               operator: 'in',
+   *               values: ['string'],
+   *             },
+   *           ],
+   *           serve: {
+   *             version_id: 'Version Id',
+   *             rollout: [
+   *               { version_id: 'Version Id', weight: 0 },
+   *             ],
+   *           },
+   *         },
+   *       ],
+   *     },
    *   );
    * ```
    */

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

@@ -33,6 +33,10 @@ export class Instructions extends APIResource {
    * const response =
    *   await client.ai.assistants.instructions.enhance(
    *     'assistant_id',
+   *     {
+   *       enhancement_prompt: 'string',
+   *       instructions: 'string',
+   *     },
    *   );
    * ```
    */

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

@@ -10,7 +10,7 @@ import { path } from '../../../internal/utils/path';
  */
 export class Tags extends APIResource {
   /**
-   * Get All Tags
+   * Retrieve all tags that have been applied to your AI assistants.
    *
    * @example
    * ```ts
@@ -22,13 +22,13 @@ export class Tags extends APIResource {
   }
 
   /**
-   * Add Assistant Tag
+   * Add a tag to an AI assistant. Tags help you organize and filter your assistants.
    *
    * @example
    * ```ts
    * const tagsResponse = await client.ai.assistants.tags.add(
    *   'assistant_id',
-   *   { tag: 'tag' },
+   *   { tag: 'Tag' },
    * );
    * ```
    */
@@ -37,7 +37,7 @@ export class Tags extends APIResource {
   }
 
   /**
-   * Remove Assistant Tag
+   * Remove a tag from an AI assistant.
    *
    * @example
    * ```ts

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

@@ -116,7 +116,16 @@ export class Tests extends APIResource {
    * @example
    * ```ts
    * const assistantTest =
-   *   await client.ai.assistants.tests.update('test_id');
+   *   await client.ai.assistants.tests.update('test_id', {
+   *     description: 'Description',
+   *     destination: 'Destination',
+   *     instructions: 'Instructions',
+   *     max_duration_seconds: 30,
+   *     name: 'Name',
+   *     rubric: [{ name: 'string', criteria: 'string' }],
+   *     telnyx_conversation_channel: 'phone_call',
+   *     test_suite: 'Test Suite',
+   *   });
    * ```
    */
   update(testID: string, body: TestUpdateParams, options?: RequestOptions): APIPromise<AssistantTest> {

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

@@ -16,7 +16,11 @@ export class Tools extends APIResource {
    * ```ts
    * const response = await client.ai.assistants.tools.test(
    *   'tool_id',
-   *   { assistant_id: 'assistant_id' },
+   *   {
+   *     assistant_id: 'assistant_id',
+   *     arguments: { order_id: 'order_12345' },
+   *     dynamic_variables: { customer_name: 'Ada' },
+   *   },
    * );
    * ```
    */
@@ -26,7 +30,7 @@ export class Tools extends APIResource {
   }
 
   /**
-   * Remove Assistant Tool
+   * Detach a tool from an AI assistant.
    *
    * @example
    * ```ts
@@ -42,7 +46,7 @@ export class Tools extends APIResource {
   }
 
   /**
-   * Add Assistant Tool
+   * Attach an existing tool to an AI assistant.
    *
    * @example
    * ```ts

package/src/resources/ai/clusters.ts

@@ -14,7 +14,7 @@ import { path } from '../../internal/utils/path';
  */
 export class Clusters extends APIResource {
   /**
-   * List all clusters
+   * Retrieve a paginated list of clustering tasks and their statuses.
    *
    * @example
    * ```ts
@@ -42,7 +42,11 @@ export class Clusters extends APIResource {
    * @example
    * ```ts
    * const response = await client.ai.clusters.compute({
-   *   bucket: 'bucket',
+   *   bucket: 'string',
+   *   files: ['string'],
+   *   min_cluster_size: 25,
+   *   min_subcluster_size: 5,
+   *   prefix: 'string',
    * });
    * ```
    */
@@ -51,7 +55,7 @@ export class Clusters extends APIResource {
   }
 
   /**
-   * Delete a cluster
+   * Delete a clustering task and its computed results.
    *
    * @example
    * ```ts
@@ -66,7 +70,7 @@ export class Clusters extends APIResource {
   }
 
   /**
-   * Fetch a cluster
+   * Fetch the results of a clustering task, including the discovered clusters.
    *
    * @example
    * ```ts
@@ -84,7 +88,7 @@ export class Clusters extends APIResource {
   }
 
   /**
-   * Fetch a cluster visualization
+   * Fetch a visualization image of the clusters computed by a clustering task.
    *
    * @example
    * ```ts