telnyx 6.83.0 → 7.1.0

package/src/resources/ai/missions/runs/runs.ts

@@ -6,26 +6,26 @@ import {
   EventData,
   EventDataDefaultFlatPagination,
   EventGetEventDetailsParams,
-  EventGetEventDetailsResponse,
   EventListParams,
   EventLogParams,
-  EventLogResponse,
+  EventResponse,
+  EventType,
   Events,
 } from './events';
 import * as PlanAPI from './plan';
 import {
+  CreatePlanStepRequest,
   Plan,
   PlanAddStepsToPlanParams,
-  PlanAddStepsToPlanResponse,
   PlanCreateParams,
-  PlanCreateResponse,
   PlanGetStepDetailsParams,
-  PlanGetStepDetailsResponse,
   PlanRetrieveParams,
   PlanRetrieveResponse,
   PlanStepData,
+  PlanStepResponse,
+  PlanStepsCreatedResponse,
   PlanUpdateStepParams,
-  PlanUpdateStepResponse,
+  StepStatus,
 } from './plan';
 import * as TelnyxAgentsAPI from './telnyx-agents';
 import {
@@ -37,6 +37,7 @@ import {
   TelnyxAgentUnlinkParams,
   TelnyxAgents,
 } from './telnyx-agents';
+import * as TestSuitesRunsAPI from '../../assistants/tests/test-suites/runs';
 import { APIPromise } from '../../../../core/api-promise';
 import {
   DefaultFlatPagination,
@@ -56,16 +57,17 @@ export class Runs extends APIResource {
    *
    * @example
    * ```ts
-   * const run = await client.ai.missions.runs.create(
-   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   * );
+   * const missionRunResponse =
+   *   await client.ai.missions.runs.create(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   );
    * ```
    */
   create(
     missionID: string,
     body: RunCreateParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<RunCreateResponse> {
+  ): APIPromise<MissionRunResponse> {
     return this._client.post(path`/ai/missions/${missionID}/runs`, { body, ...options });
   }
 
@@ -74,17 +76,18 @@ export class Runs extends APIResource {
    *
    * @example
    * ```ts
-   * const run = await client.ai.missions.runs.retrieve(
-   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   *   { mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
-   * );
+   * const missionRunResponse =
+   *   await client.ai.missions.runs.retrieve(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     { mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
+   *   );
    * ```
    */
   retrieve(
     runID: string,
     params: RunRetrieveParams,
     options?: RequestOptions,
-  ): APIPromise<RunRetrieveResponse> {
+  ): APIPromise<MissionRunResponse> {
     const { mission_id } = params;
     return this._client.get(path`/ai/missions/${mission_id}/runs/${runID}`, options);
   }
@@ -94,13 +97,14 @@ export class Runs extends APIResource {
    *
    * @example
    * ```ts
-   * const run = await client.ai.missions.runs.update(
-   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   *   { mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
-   * );
+   * const missionRunResponse =
+   *   await client.ai.missions.runs.update(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     { mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
+   *   );
    * ```
    */
-  update(runID: string, params: RunUpdateParams, options?: RequestOptions): APIPromise<RunUpdateResponse> {
+  update(runID: string, params: RunUpdateParams, options?: RequestOptions): APIPromise<MissionRunResponse> {
     const { mission_id, ...body } = params;
     return this._client.patch(path`/ai/missions/${mission_id}/runs/${runID}`, { body, ...options });
   }
@@ -135,17 +139,18 @@ export class Runs extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.ai.missions.runs.cancelRun(
-   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   *   { mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
-   * );
+   * const missionRunResponse =
+   *   await client.ai.missions.runs.cancelRun(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     { mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
+   *   );
    * ```
    */
   cancelRun(
     runID: string,
     params: RunCancelRunParams,
     options?: RequestOptions,
-  ): APIPromise<RunCancelRunResponse> {
+  ): APIPromise<MissionRunResponse> {
     const { mission_id } = params;
     return this._client.post(path`/ai/missions/${mission_id}/runs/${runID}/cancel`, options);
   }
@@ -176,17 +181,18 @@ export class Runs extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.ai.missions.runs.pauseRun(
-   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   *   { mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
-   * );
+   * const missionRunResponse =
+   *   await client.ai.missions.runs.pauseRun(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     { mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
+   *   );
    * ```
    */
   pauseRun(
     runID: string,
     params: RunPauseRunParams,
     options?: RequestOptions,
-  ): APIPromise<RunPauseRunResponse> {
+  ): APIPromise<MissionRunResponse> {
     const { mission_id } = params;
     return this._client.post(path`/ai/missions/${mission_id}/runs/${runID}/pause`, options);
   }
@@ -196,17 +202,18 @@ export class Runs extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.ai.missions.runs.resumeRun(
-   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   *   { mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
-   * );
+   * const missionRunResponse =
+   *   await client.ai.missions.runs.resumeRun(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     { mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
+   *   );
    * ```
    */
   resumeRun(
     runID: string,
     params: RunResumeRunParams,
     options?: RequestOptions,
-  ): APIPromise<RunResumeRunResponse> {
+  ): APIPromise<MissionRunResponse> {
     const { mission_id } = params;
     return this._client.post(path`/ai/missions/${mission_id}/runs/${runID}/resume`, options);
   }
@@ -221,7 +228,7 @@ export interface MissionRunData {
 
   started_at: string;
 
-  status: 'pending' | 'running' | 'paused' | 'succeeded' | 'failed' | 'cancelled';
+  status: RunStatus;
 
   updated_at: string;
 
@@ -238,29 +245,17 @@ export interface MissionRunData {
   result_summary?: string;
 }
 
-export interface RunCreateResponse {
+export interface MissionRunResponse {
   data: MissionRunData;
 }
 
-export interface RunRetrieveResponse {
-  data: MissionRunData;
-}
+export interface MissionRunsListResponse {
+  data: Array<MissionRunData>;
 
-export interface RunUpdateResponse {
-  data: MissionRunData;
+  meta: TestSuitesRunsAPI.Meta;
 }
 
-export interface RunCancelRunResponse {
-  data: MissionRunData;
-}
-
-export interface RunPauseRunResponse {
-  data: MissionRunData;
-}
-
-export interface RunResumeRunResponse {
-  data: MissionRunData;
-}
+export type RunStatus = 'pending' | 'running' | 'paused' | 'succeeded' | 'failed' | 'cancelled';
 
 export interface RunCreateParams {
   input?: { [key: string]: unknown };
@@ -269,12 +264,15 @@ export interface RunCreateParams {
 }
 
 export interface RunRetrieveParams {
+  /**
+   * Unique identifier of the mission.
+   */
   mission_id: string;
 }
 
 export interface RunUpdateParams {
   /**
-   * Path param
+   * Path param: Unique identifier of the mission.
    */
   mission_id: string;
 
@@ -301,26 +299,41 @@ export interface RunUpdateParams {
   /**
    * Body param
    */
-  status?: 'pending' | 'running' | 'paused' | 'succeeded' | 'failed' | 'cancelled';
+  status?: RunStatus;
 }
 
 export interface RunListParams extends DefaultFlatPaginationParams {
+  /**
+   * Filter results by status.
+   */
   status?: string;
 }
 
 export interface RunCancelRunParams {
+  /**
+   * Unique identifier of the mission.
+   */
   mission_id: string;
 }
 
 export interface RunListRunsParams extends DefaultFlatPaginationParams {
+  /**
+   * Filter results by status.
+   */
   status?: string;
 }
 
 export interface RunPauseRunParams {
+  /**
+   * Unique identifier of the mission.
+   */
   mission_id: string;
 }
 
 export interface RunResumeRunParams {
+  /**
+   * Unique identifier of the mission.
+   */
   mission_id: string;
 }
 
@@ -331,12 +344,9 @@ Runs.TelnyxAgents = TelnyxAgents;
 export declare namespace Runs {
   export {
     type MissionRunData as MissionRunData,
-    type RunCreateResponse as RunCreateResponse,
-    type RunRetrieveResponse as RunRetrieveResponse,
-    type RunUpdateResponse as RunUpdateResponse,
-    type RunCancelRunResponse as RunCancelRunResponse,
-    type RunPauseRunResponse as RunPauseRunResponse,
-    type RunResumeRunResponse as RunResumeRunResponse,
+    type MissionRunResponse as MissionRunResponse,
+    type MissionRunsListResponse as MissionRunsListResponse,
+    type RunStatus as RunStatus,
     type MissionRunDataDefaultFlatPagination as MissionRunDataDefaultFlatPagination,
     type RunCreateParams as RunCreateParams,
     type RunRetrieveParams as RunRetrieveParams,
@@ -351,8 +361,8 @@ export declare namespace Runs {
   export {
     Events as Events,
     type EventData as EventData,
-    type EventGetEventDetailsResponse as EventGetEventDetailsResponse,
-    type EventLogResponse as EventLogResponse,
+    type EventResponse as EventResponse,
+    type EventType as EventType,
     type EventDataDefaultFlatPagination as EventDataDefaultFlatPagination,
     type EventListParams as EventListParams,
     type EventGetEventDetailsParams as EventGetEventDetailsParams,
@@ -361,12 +371,12 @@ export declare namespace Runs {
 
   export {
     Plan as Plan,
+    type CreatePlanStepRequest as CreatePlanStepRequest,
     type PlanStepData as PlanStepData,
-    type PlanCreateResponse as PlanCreateResponse,
+    type PlanStepResponse as PlanStepResponse,
+    type PlanStepsCreatedResponse as PlanStepsCreatedResponse,
+    type StepStatus as StepStatus,
     type PlanRetrieveResponse as PlanRetrieveResponse,
-    type PlanAddStepsToPlanResponse as PlanAddStepsToPlanResponse,
-    type PlanGetStepDetailsResponse as PlanGetStepDetailsResponse,
-    type PlanUpdateStepResponse as PlanUpdateStepResponse,
     type PlanCreateParams as PlanCreateParams,
     type PlanRetrieveParams as PlanRetrieveParams,
     type PlanAddStepsToPlanParams as PlanAddStepsToPlanParams,

package/src/resources/ai/missions/runs/telnyx-agents.ts

@@ -95,12 +95,15 @@ export interface TelnyxAgentLinkResponse {
 }
 
 export interface TelnyxAgentListParams {
+  /**
+   * Unique identifier of the mission.
+   */
   mission_id: string;
 }
 
 export interface TelnyxAgentLinkParams {
   /**
-   * Path param
+   * Path param: Unique identifier of the mission.
    */
   mission_id: string;
 
@@ -111,8 +114,14 @@ export interface TelnyxAgentLinkParams {
 }
 
 export interface TelnyxAgentUnlinkParams {
+  /**
+   * Unique identifier of the mission.
+   */
   mission_id: string;
 
+  /**
+   * Unique identifier of the run.
+   */
   run_id: string;
 }
 

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

@@ -95,14 +95,23 @@ export type ToolListToolsResponse = unknown;
 export type ToolUpdateToolResponse = unknown;
 
 export interface ToolDeleteToolParams {
+  /**
+   * Unique identifier of the mission.
+   */
   mission_id: string;
 }
 
 export interface ToolGetToolParams {
+  /**
+   * Unique identifier of the mission.
+   */
   mission_id: string;
 }
 
 export interface ToolUpdateToolParams {
+  /**
+   * Unique identifier of the mission.
+   */
   mission_id: string;
 }
 

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

@@ -7,9 +7,4 @@ export {
   type EmbeddingListEmbeddingModelsResponse,
   type EmbeddingCreateEmbeddingsParams,
 } from './embeddings';
-export {
-  OpenAI,
-  type OpenAICreateResponseResponse,
-  type OpenAIListModelsResponse,
-  type OpenAICreateResponseParams,
-} from './openai';
+export { OpenAI, type OpenAICreateResponseResponse, type OpenAICreateResponseParams } from './openai';

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

@@ -51,14 +51,14 @@ export class OpenAI extends APIResource {
    * ```ts
    * const response = await client.ai.openai.createResponse({
    *   conversation: '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
-   *   input: [
-   *     {
+   *   input: {
+   *     '0': {
    *       role: 'user',
    *       content: [
    *         { type: 'input_text', text: 'Hello, world!' },
    *       ],
    *     },
-   *   ],
+   *   },
    *   instructions: 'You are a friendly chatbot.',
    *   model: 'zai-org/GLM-5.1-FP8',
    *   stream: true,
@@ -91,22 +91,16 @@ export class OpenAI extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.ai.openai.listModels();
+   * const modelsResponse = await client.ai.openai.listModels();
    * ```
    */
-  listModels(options?: RequestOptions): APIPromise<OpenAIListModelsResponse> {
+  listModels(options?: RequestOptions): APIPromise<AIAPI.ModelsResponse> {
     return this._client.get('/ai/openai/models', options);
   }
 }
 
 export type OpenAICreateResponseResponse = { [key: string]: unknown };
 
-export interface OpenAIListModelsResponse {
-  data: Array<AIAPI.ModelMetadata>;
-
-  object?: string;
-}
-
 export interface OpenAICreateResponseParams {
   /**
    * Optional Telnyx Conversation ID from `POST /ai/conversations`. When provided,
@@ -119,7 +113,7 @@ export interface OpenAICreateResponseParams {
   /**
    * The input items for this turn, using the OpenAI Responses API input format.
    */
-  input?: unknown;
+  input?: { [key: string]: unknown };
 
   /**
    * Optional system/developer instructions for the model. When used with a persisted
@@ -149,7 +143,6 @@ OpenAI.Chat = Chat;
 export declare namespace OpenAI {
   export {
     type OpenAICreateResponseResponse as OpenAICreateResponseResponse,
-    type OpenAIListModelsResponse as OpenAIListModelsResponse,
     type OpenAICreateResponseParams as OpenAICreateResponseParams,
   };
 

package/src/resources/ai/tools.ts

@@ -15,13 +15,13 @@ export class Tools extends APIResource {
    *
    * @example
    * ```ts
-   * const tool = await client.ai.tools.create({
+   * const sharedToolResponse = await client.ai.tools.create({
    *   display_name: 'display_name',
    *   type: 'type',
    * });
    * ```
    */
-  create(body: ToolCreateParams, options?: RequestOptions): APIPromise<ToolCreateResponse> {
+  create(body: ToolCreateParams, options?: RequestOptions): APIPromise<SharedToolResponse> {
     return this._client.post('/ai/tools', { body, ...options });
   }
 
@@ -30,10 +30,12 @@ export class Tools extends APIResource {
    *
    * @example
    * ```ts
-   * const tool = await client.ai.tools.retrieve('tool_id');
+   * const sharedToolResponse = await client.ai.tools.retrieve(
+   *   'tool_id',
+   * );
    * ```
    */
-  retrieve(toolID: string, options?: RequestOptions): APIPromise<ToolRetrieveResponse> {
+  retrieve(toolID: string, options?: RequestOptions): APIPromise<SharedToolResponse> {
     return this._client.get(path`/ai/tools/${toolID}`, options);
   }
 
@@ -42,10 +44,12 @@ export class Tools extends APIResource {
    *
    * @example
    * ```ts
-   * const tool = await client.ai.tools.update('tool_id');
+   * const sharedToolResponse = await client.ai.tools.update(
+   *   'tool_id',
+   * );
    * ```
    */
-  update(toolID: string, body: ToolUpdateParams, options?: RequestOptions): APIPromise<ToolUpdateResponse> {
+  update(toolID: string, body: ToolUpdateParams, options?: RequestOptions): APIPromise<SharedToolResponse> {
     return this._client.patch(path`/ai/tools/${toolID}`, { body, ...options });
   }
 
@@ -55,7 +59,7 @@ export class Tools extends APIResource {
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
-   * for await (const toolListResponse of client.ai.tools.list()) {
+   * for await (const sharedToolResponse of client.ai.tools.list()) {
    *   // ...
    * }
    * ```
@@ -63,8 +67,8 @@ export class Tools extends APIResource {
   list(
     query: ToolListParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<ToolListResponsesDefaultFlatPagination, ToolListResponse> {
-    return this._client.getAPIList('/ai/tools', DefaultFlatPagination<ToolListResponse>, {
+  ): PagePromise<SharedToolResponsesDefaultFlatPagination, SharedToolResponse> {
+    return this._client.getAPIList('/ai/tools', DefaultFlatPagination<SharedToolResponse>, {
       query,
       ...options,
     });
@@ -83,51 +87,9 @@ export class Tools extends APIResource {
   }
 }
 
-export type ToolListResponsesDefaultFlatPagination = DefaultFlatPagination<ToolListResponse>;
+export type SharedToolResponsesDefaultFlatPagination = DefaultFlatPagination<SharedToolResponse>;
 
-export interface ToolCreateResponse {
-  id: string;
-
-  tool_definition: { [key: string]: unknown };
-
-  type: string;
-
-  created_at?: string;
-
-  display_name?: string;
-
-  timeout_ms?: number;
-}
-
-export interface ToolRetrieveResponse {
-  id: string;
-
-  tool_definition: { [key: string]: unknown };
-
-  type: string;
-
-  created_at?: string;
-
-  display_name?: string;
-
-  timeout_ms?: number;
-}
-
-export interface ToolUpdateResponse {
-  id: string;
-
-  tool_definition: { [key: string]: unknown };
-
-  type: string;
-
-  created_at?: string;
-
-  display_name?: string;
-
-  timeout_ms?: number;
-}
-
-export interface ToolListResponse {
+export interface SharedToolResponse {
   id: string;
 
   tool_definition: { [key: string]: unknown };
@@ -184,19 +146,22 @@ export interface ToolUpdateParams {
 }
 
 export interface ToolListParams extends DefaultFlatPaginationParams {
+  /**
+   * Filter results by filter name.
+   */
   'filter[name]'?: string;
 
+  /**
+   * Filter results by filter type.
+   */
   'filter[type]'?: string;
 }
 
 export declare namespace Tools {
   export {
-    type ToolCreateResponse as ToolCreateResponse,
-    type ToolRetrieveResponse as ToolRetrieveResponse,
-    type ToolUpdateResponse as ToolUpdateResponse,
-    type ToolListResponse as ToolListResponse,
+    type SharedToolResponse as SharedToolResponse,
     type ToolDeleteResponse as ToolDeleteResponse,
-    type ToolListResponsesDefaultFlatPagination as ToolListResponsesDefaultFlatPagination,
+    type SharedToolResponsesDefaultFlatPagination as SharedToolResponsesDefaultFlatPagination,
     type ToolCreateParams as ToolCreateParams,
     type ToolUpdateParams as ToolUpdateParams,
     type ToolListParams as ToolListParams,