telnyx 6.74.2 → 7.1.0

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

@@ -43,7 +43,7 @@ export class Events extends APIResource {
    *
    * @example
    * ```ts
-   * const response =
+   * const eventResponse =
    *   await client.ai.missions.runs.events.getEventDetails(
    *     'event_id',
    *     {
@@ -57,7 +57,7 @@ export class Events extends APIResource {
     eventID: string,
     params: EventGetEventDetailsParams,
     options?: RequestOptions,
-  ): APIPromise<EventGetEventDetailsResponse> {
+  ): APIPromise<EventResponse> {
     const { mission_id, run_id } = params;
     return this._client.get(path`/ai/missions/${mission_id}/runs/${run_id}/events/${eventID}`, options);
   }
@@ -67,17 +67,18 @@ export class Events extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.ai.missions.runs.events.log(
-   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   *   {
-   *     mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   *     summary: 'summary',
-   *     type: 'status_change',
-   *   },
-   * );
+   * const eventResponse =
+   *   await client.ai.missions.runs.events.log(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     {
+   *       mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *       summary: 'summary',
+   *       type: 'status_change',
+   *     },
+   *   );
    * ```
    */
-  log(runID: string, params: EventLogParams, options?: RequestOptions): APIPromise<EventLogResponse> {
+  log(runID: string, params: EventLogParams, options?: RequestOptions): APIPromise<EventResponse> {
     const { mission_id, ...body } = params;
     return this._client.post(path`/ai/missions/${mission_id}/runs/${runID}/events`, { body, ...options });
   }
@@ -94,16 +95,7 @@ export interface EventData {
 
   timestamp: string;
 
-  type:
-    | 'status_change'
-    | 'step_started'
-    | 'step_completed'
-    | 'step_failed'
-    | 'tool_call'
-    | 'tool_result'
-    | 'message'
-    | 'error'
-    | 'custom';
+  type: EventType;
 
   agent_id?: string;
 
@@ -114,45 +106,58 @@ export interface EventData {
   step_id?: string;
 }
 
-export interface EventGetEventDetailsResponse {
+export interface EventResponse {
   data: EventData;
 }
 
-export interface EventLogResponse {
-  data: EventData;
-}
+export type EventType =
+  | 'status_change'
+  | 'step_started'
+  | 'step_completed'
+  | 'step_failed'
+  | 'tool_call'
+  | 'tool_result'
+  | 'message'
+  | 'error'
+  | 'custom';
 
 export interface EventListParams extends DefaultFlatPaginationParams {
   /**
-   * Path param
+   * Path param: Unique identifier of the mission.
    */
   mission_id: string;
 
   /**
-   * Query param
+   * Query param: Filter results by agent id.
    */
   agent_id?: string;
 
   /**
-   * Query param
+   * Query param: Filter results by step id.
    */
   step_id?: string;
 
   /**
-   * Query param
+   * Query param: Filter results by type.
    */
   type?: string;
 }
 
 export interface EventGetEventDetailsParams {
+  /**
+   * Unique identifier of the mission.
+   */
   mission_id: string;
 
+  /**
+   * Unique identifier of the run.
+   */
   run_id: string;
 }
 
 export interface EventLogParams {
   /**
-   * Path param
+   * Path param: Unique identifier of the mission.
    */
   mission_id: string;
 
@@ -164,16 +169,7 @@ export interface EventLogParams {
   /**
    * Body param
    */
-  type:
-    | 'status_change'
-    | 'step_started'
-    | 'step_completed'
-    | 'step_failed'
-    | 'tool_call'
-    | 'tool_result'
-    | 'message'
-    | 'error'
-    | 'custom';
+  type: EventType;
 
   /**
    * Body param
@@ -199,8 +195,8 @@ export interface EventLogParams {
 export declare namespace Events {
   export {
     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,

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

@@ -3,8 +3,8 @@
 export {
   Events,
   type EventData,
-  type EventGetEventDetailsResponse,
-  type EventLogResponse,
+  type EventResponse,
+  type EventType,
   type EventListParams,
   type EventGetEventDetailsParams,
   type EventLogParams,
@@ -12,12 +12,12 @@ export {
 } from './events';
 export {
   Plan,
+  type CreatePlanStepRequest,
   type PlanStepData,
-  type PlanCreateResponse,
+  type PlanStepResponse,
+  type PlanStepsCreatedResponse,
+  type StepStatus,
   type PlanRetrieveResponse,
-  type PlanAddStepsToPlanResponse,
-  type PlanGetStepDetailsResponse,
-  type PlanUpdateStepResponse,
   type PlanCreateParams,
   type PlanRetrieveParams,
   type PlanAddStepsToPlanParams,
@@ -27,12 +27,9 @@ export {
 export {
   Runs,
   type MissionRunData,
-  type RunCreateResponse,
-  type RunRetrieveResponse,
-  type RunUpdateResponse,
-  type RunCancelRunResponse,
-  type RunPauseRunResponse,
-  type RunResumeRunResponse,
+  type MissionRunResponse,
+  type MissionRunsListResponse,
+  type RunStatus,
   type RunCreateParams,
   type RunRetrieveParams,
   type RunUpdateParams,

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

@@ -11,22 +11,27 @@ export class Plan extends APIResource {
    *
    * @example
    * ```ts
-   * const plan = await client.ai.missions.runs.plan.create(
-   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   *   {
-   *     mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   *     steps: [
-   *       {
-   *         description: 'description',
-   *         sequence: 0,
-   *         step_id: 'step_id',
-   *       },
-   *     ],
-   *   },
-   * );
+   * const planStepsCreatedResponse =
+   *   await client.ai.missions.runs.plan.create(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     {
+   *       mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *       steps: [
+   *         {
+   *           description: 'description',
+   *           sequence: 0,
+   *           step_id: 'step_id',
+   *         },
+   *       ],
+   *     },
+   *   );
    * ```
    */
-  create(runID: string, params: PlanCreateParams, options?: RequestOptions): APIPromise<PlanCreateResponse> {
+  create(
+    runID: string,
+    params: PlanCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<PlanStepsCreatedResponse> {
     const { mission_id, ...body } = params;
     return this._client.post(path`/ai/missions/${mission_id}/runs/${runID}/plan`, { body, ...options });
   }
@@ -56,7 +61,7 @@ export class Plan extends APIResource {
    *
    * @example
    * ```ts
-   * const response =
+   * const planStepsCreatedResponse =
    *   await client.ai.missions.runs.plan.addStepsToPlan(
    *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
    *     {
@@ -76,7 +81,7 @@ export class Plan extends APIResource {
     runID: string,
     params: PlanAddStepsToPlanParams,
     options?: RequestOptions,
-  ): APIPromise<PlanAddStepsToPlanResponse> {
+  ): APIPromise<PlanStepsCreatedResponse> {
     const { mission_id, ...body } = params;
     return this._client.post(path`/ai/missions/${mission_id}/runs/${runID}/plan/steps`, { body, ...options });
   }
@@ -86,7 +91,7 @@ export class Plan extends APIResource {
    *
    * @example
    * ```ts
-   * const response =
+   * const planStepResponse =
    *   await client.ai.missions.runs.plan.getStepDetails(
    *     'step_id',
    *     {
@@ -100,7 +105,7 @@ export class Plan extends APIResource {
     stepID: string,
     params: PlanGetStepDetailsParams,
     options?: RequestOptions,
-  ): APIPromise<PlanGetStepDetailsResponse> {
+  ): APIPromise<PlanStepResponse> {
     const { mission_id, run_id } = params;
     return this._client.get(path`/ai/missions/${mission_id}/runs/${run_id}/plan/steps/${stepID}`, options);
   }
@@ -110,7 +115,7 @@ export class Plan extends APIResource {
    *
    * @example
    * ```ts
-   * const response =
+   * const planStepResponse =
    *   await client.ai.missions.runs.plan.updateStep('step_id', {
    *     mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
    *     run_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
@@ -121,7 +126,7 @@ export class Plan extends APIResource {
     stepID: string,
     params: PlanUpdateStepParams,
     options?: RequestOptions,
-  ): APIPromise<PlanUpdateStepResponse> {
+  ): APIPromise<PlanStepResponse> {
     const { mission_id, run_id, ...body } = params;
     return this._client.patch(path`/ai/missions/${mission_id}/runs/${run_id}/plan/steps/${stepID}`, {
       body,
@@ -130,6 +135,18 @@ export class Plan extends APIResource {
   }
 }
 
+export interface CreatePlanStepRequest {
+  description: string;
+
+  sequence: number;
+
+  step_id: string;
+
+  metadata?: { [key: string]: unknown };
+
+  parent_step_id?: string;
+}
+
 export interface PlanStepData {
   description: string;
 
@@ -137,7 +154,7 @@ export interface PlanStepData {
 
   sequence: number;
 
-  status: 'pending' | 'in_progress' | 'completed' | 'skipped' | 'failed';
+  status: StepStatus;
 
   step_id: string;
 
@@ -150,96 +167,71 @@ export interface PlanStepData {
   started_at?: string;
 }
 
-export interface PlanCreateResponse {
-  data: Array<PlanStepData>;
-}
-
-export interface PlanRetrieveResponse {
-  data: Array<PlanStepData>;
+export interface PlanStepResponse {
+  data: PlanStepData;
 }
 
-export interface PlanAddStepsToPlanResponse {
+export interface PlanStepsCreatedResponse {
   data: Array<PlanStepData>;
 }
 
-export interface PlanGetStepDetailsResponse {
-  data: PlanStepData;
-}
+export type StepStatus = 'pending' | 'in_progress' | 'completed' | 'skipped' | 'failed';
 
-export interface PlanUpdateStepResponse {
-  data: PlanStepData;
+export interface PlanRetrieveResponse {
+  data: Array<PlanStepData>;
 }
 
 export interface PlanCreateParams {
   /**
-   * Path param
+   * Path param: Unique identifier of the mission.
    */
   mission_id: string;
 
   /**
    * Body param
    */
-  steps: Array<PlanCreateParams.Step>;
-}
-
-export namespace PlanCreateParams {
-  export interface Step {
-    description: string;
-
-    sequence: number;
-
-    step_id: string;
-
-    metadata?: { [key: string]: unknown };
-
-    parent_step_id?: string;
-  }
+  steps: Array<CreatePlanStepRequest>;
 }
 
 export interface PlanRetrieveParams {
+  /**
+   * Unique identifier of the mission.
+   */
   mission_id: string;
 }
 
 export interface PlanAddStepsToPlanParams {
   /**
-   * Path param
+   * Path param: Unique identifier of the mission.
    */
   mission_id: string;
 
   /**
    * Body param
    */
-  steps: Array<PlanAddStepsToPlanParams.Step>;
-}
-
-export namespace PlanAddStepsToPlanParams {
-  export interface Step {
-    description: string;
-
-    sequence: number;
-
-    step_id: string;
-
-    metadata?: { [key: string]: unknown };
-
-    parent_step_id?: string;
-  }
+  steps: Array<CreatePlanStepRequest>;
 }
 
 export interface PlanGetStepDetailsParams {
+  /**
+   * Unique identifier of the mission.
+   */
   mission_id: string;
 
+  /**
+   * Unique identifier of the run.
+   */
   run_id: string;
 }
 
 export interface PlanUpdateStepParams {
   /**
-   * Path param
+   * Path param: Unique identifier of the mission.
    */
   mission_id: string;
 
   /**
-   * Path param
+   * Path param: Unique identifier of the run.
    */
   run_id: string;
 
@@ -251,17 +243,17 @@ export interface PlanUpdateStepParams {
   /**
    * Body param
    */
-  status?: 'pending' | 'in_progress' | 'completed' | 'skipped' | 'failed';
+  status?: StepStatus;
 }
 
 export declare namespace Plan {
   export {
+    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,