telnyx 5.26.0 → 5.27.0

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

@@ -36,14 +36,16 @@ import {
 } from './tools';
 import * as RunsAPI from './runs/runs';
 import {
-  MissionRunData,
-  MissionRunDataDefaultFlatPagination,
   RunCancelRunParams,
   RunCancelRunResponse,
   RunCreateParams,
   RunCreateResponse,
   RunListParams,
+  RunListResponse,
+  RunListResponsesDefaultFlatPagination,
   RunListRunsParams,
+  RunListRunsResponse,
+  RunListRunsResponsesDefaultFlatPagination,
   RunPauseRunParams,
   RunPauseRunResponse,
   RunResumeRunParams,
@@ -104,7 +106,7 @@ export class Missions extends APIResource {
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
-   * for await (const missionData of client.ai.missions.list()) {
+   * for await (const missionListResponse of client.ai.missions.list()) {
    *   // ...
    * }
    * ```
@@ -112,8 +114,11 @@ export class Missions extends APIResource {
   list(
     query: MissionListParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<MissionDataDefaultFlatPagination, MissionData> {
-    return this._client.getAPIList('/ai/missions', DefaultFlatPagination<MissionData>, { query, ...options });
+  ): PagePromise<MissionListResponsesDefaultFlatPagination, MissionListResponse> {
+    return this._client.getAPIList('/ai/missions', DefaultFlatPagination<MissionListResponse>, {
+      query,
+      ...options,
+    });
   }
 
   /**
@@ -187,12 +192,64 @@ export class Missions extends APIResource {
   }
 }
 
-export type MissionDataDefaultFlatPagination = DefaultFlatPagination<MissionData>;
+export type MissionListResponsesDefaultFlatPagination = DefaultFlatPagination<MissionListResponse>;
 
 export type MissionListEventsResponsesDefaultFlatPagination =
   DefaultFlatPagination<MissionListEventsResponse>;
 
-export interface MissionData {
+export interface MissionCreateResponse {
+  data: MissionCreateResponse.Data;
+}
+
+export namespace MissionCreateResponse {
+  export interface Data {
+    created_at: string;
+
+    execution_mode: 'external' | 'managed';
+
+    mission_id: string;
+
+    name: string;
+
+    updated_at: string;
+
+    description?: string;
+
+    instructions?: string;
+
+    metadata?: { [key: string]: unknown };
+
+    model?: string;
+  }
+}
+
+export interface MissionRetrieveResponse {
+  data: MissionRetrieveResponse.Data;
+}
+
+export namespace MissionRetrieveResponse {
+  export interface Data {
+    created_at: string;
+
+    execution_mode: 'external' | 'managed';
+
+    mission_id: string;
+
+    name: string;
+
+    updated_at: string;
+
+    description?: string;
+
+    instructions?: string;
+
+    metadata?: { [key: string]: unknown };
+
+    model?: string;
+  }
+}
+
+export interface MissionListResponse {
   created_at: string;
 
   execution_mode: 'external' | 'managed';
@@ -212,14 +269,6 @@ export interface MissionData {
   model?: string;
 }
 
-export interface MissionCreateResponse {
-  data: MissionData;
-}
-
-export interface MissionRetrieveResponse {
-  data: MissionData;
-}
-
 export type MissionCloneMissionResponse = unknown;
 
 export interface MissionListEventsResponse {
@@ -252,7 +301,29 @@ export interface MissionListEventsResponse {
 }
 
 export interface MissionUpdateMissionResponse {
-  data: MissionData;
+  data: MissionUpdateMissionResponse.Data;
+}
+
+export namespace MissionUpdateMissionResponse {
+  export interface Data {
+    created_at: string;
+
+    execution_mode: 'external' | 'managed';
+
+    mission_id: string;
+
+    name: string;
+
+    updated_at: string;
+
+    description?: string;
+
+    instructions?: string;
+
+    metadata?: { [key: string]: unknown };
+
+    model?: string;
+  }
 }
 
 export interface MissionCreateParams {
@@ -296,13 +367,13 @@ Missions.Tools = Tools;
 
 export declare namespace Missions {
   export {
-    type MissionData as MissionData,
     type MissionCreateResponse as MissionCreateResponse,
     type MissionRetrieveResponse as MissionRetrieveResponse,
+    type MissionListResponse as MissionListResponse,
     type MissionCloneMissionResponse as MissionCloneMissionResponse,
     type MissionListEventsResponse as MissionListEventsResponse,
     type MissionUpdateMissionResponse as MissionUpdateMissionResponse,
-    type MissionDataDefaultFlatPagination as MissionDataDefaultFlatPagination,
+    type MissionListResponsesDefaultFlatPagination as MissionListResponsesDefaultFlatPagination,
     type MissionListEventsResponsesDefaultFlatPagination as MissionListEventsResponsesDefaultFlatPagination,
     type MissionCreateParams as MissionCreateParams,
     type MissionListParams as MissionListParams,
@@ -312,14 +383,16 @@ export declare namespace Missions {
 
   export {
     Runs as Runs,
-    type MissionRunData as MissionRunData,
     type RunCreateResponse as RunCreateResponse,
     type RunRetrieveResponse as RunRetrieveResponse,
     type RunUpdateResponse as RunUpdateResponse,
+    type RunListResponse as RunListResponse,
     type RunCancelRunResponse as RunCancelRunResponse,
+    type RunListRunsResponse as RunListRunsResponse,
     type RunPauseRunResponse as RunPauseRunResponse,
     type RunResumeRunResponse as RunResumeRunResponse,
-    type MissionRunDataDefaultFlatPagination as MissionRunDataDefaultFlatPagination,
+    type RunListResponsesDefaultFlatPagination as RunListResponsesDefaultFlatPagination,
+    type RunListRunsResponsesDefaultFlatPagination as RunListRunsResponsesDefaultFlatPagination,
     type RunCreateParams as RunCreateParams,
     type RunRetrieveParams as RunRetrieveParams,
     type RunUpdateParams as RunUpdateParams,

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

@@ -12,7 +12,6 @@ export {
 } from './events';
 export {
   Plan,
-  type PlanStepData,
   type PlanCreateResponse,
   type PlanRetrieveResponse,
   type PlanAddStepsToPlanResponse,
@@ -26,11 +25,12 @@ export {
 } from './plan';
 export {
   Runs,
-  type MissionRunData,
   type RunCreateResponse,
   type RunRetrieveResponse,
   type RunUpdateResponse,
+  type RunListResponse,
   type RunCancelRunResponse,
+  type RunListRunsResponse,
   type RunPauseRunResponse,
   type RunResumeRunResponse,
   type RunCreateParams,
@@ -41,7 +41,8 @@ export {
   type RunListRunsParams,
   type RunPauseRunParams,
   type RunResumeRunParams,
-  type MissionRunDataDefaultFlatPagination,
+  type RunListResponsesDefaultFlatPagination,
+  type RunListRunsResponsesDefaultFlatPagination,
 } from './runs';
 export {
   TelnyxAgents,

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

@@ -130,44 +130,134 @@ export class Plan extends APIResource {
   }
 }
 
-export interface PlanStepData {
-  description: string;
+export interface PlanCreateResponse {
+  data: Array<PlanCreateResponse.Data>;
+}
 
-  run_id: string;
+export namespace PlanCreateResponse {
+  export interface Data {
+    description: string;
 
-  sequence: number;
+    run_id: string;
 
-  status: 'pending' | 'in_progress' | 'completed' | 'skipped' | 'failed';
+    sequence: number;
 
-  step_id: string;
+    status: 'pending' | 'in_progress' | 'completed' | 'skipped' | 'failed';
 
-  completed_at?: string;
+    step_id: string;
 
-  metadata?: { [key: string]: unknown };
+    completed_at?: string;
 
-  parent_step_id?: string;
+    metadata?: { [key: string]: unknown };
 
-  started_at?: string;
-}
+    parent_step_id?: string;
 
-export interface PlanCreateResponse {
-  data: Array<PlanStepData>;
+    started_at?: string;
+  }
 }
 
 export interface PlanRetrieveResponse {
-  data: Array<PlanStepData>;
+  data: Array<PlanRetrieveResponse.Data>;
+}
+
+export namespace PlanRetrieveResponse {
+  export interface Data {
+    description: string;
+
+    run_id: string;
+
+    sequence: number;
+
+    status: 'pending' | 'in_progress' | 'completed' | 'skipped' | 'failed';
+
+    step_id: string;
+
+    completed_at?: string;
+
+    metadata?: { [key: string]: unknown };
+
+    parent_step_id?: string;
+
+    started_at?: string;
+  }
 }
 
 export interface PlanAddStepsToPlanResponse {
-  data: Array<PlanStepData>;
+  data: Array<PlanAddStepsToPlanResponse.Data>;
+}
+
+export namespace PlanAddStepsToPlanResponse {
+  export interface Data {
+    description: string;
+
+    run_id: string;
+
+    sequence: number;
+
+    status: 'pending' | 'in_progress' | 'completed' | 'skipped' | 'failed';
+
+    step_id: string;
+
+    completed_at?: string;
+
+    metadata?: { [key: string]: unknown };
+
+    parent_step_id?: string;
+
+    started_at?: string;
+  }
 }
 
 export interface PlanGetStepDetailsResponse {
-  data: PlanStepData;
+  data: PlanGetStepDetailsResponse.Data;
+}
+
+export namespace PlanGetStepDetailsResponse {
+  export interface Data {
+    description: string;
+
+    run_id: string;
+
+    sequence: number;
+
+    status: 'pending' | 'in_progress' | 'completed' | 'skipped' | 'failed';
+
+    step_id: string;
+
+    completed_at?: string;
+
+    metadata?: { [key: string]: unknown };
+
+    parent_step_id?: string;
+
+    started_at?: string;
+  }
 }
 
 export interface PlanUpdateStepResponse {
-  data: PlanStepData;
+  data: PlanUpdateStepResponse.Data;
+}
+
+export namespace PlanUpdateStepResponse {
+  export interface Data {
+    description: string;
+
+    run_id: string;
+
+    sequence: number;
+
+    status: 'pending' | 'in_progress' | 'completed' | 'skipped' | 'failed';
+
+    step_id: string;
+
+    completed_at?: string;
+
+    metadata?: { [key: string]: unknown };
+
+    parent_step_id?: string;
+
+    started_at?: string;
+  }
 }
 
 export interface PlanCreateParams {
@@ -256,7 +346,6 @@ export interface PlanUpdateStepParams {
 
 export declare namespace Plan {
   export {
-    type PlanStepData as PlanStepData,
     type PlanCreateResponse as PlanCreateResponse,
     type PlanRetrieveResponse as PlanRetrieveResponse,
     type PlanAddStepsToPlanResponse as PlanAddStepsToPlanResponse,

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

@@ -23,7 +23,6 @@ import {
   PlanGetStepDetailsResponse,
   PlanRetrieveParams,
   PlanRetrieveResponse,
-  PlanStepData,
   PlanUpdateStepParams,
   PlanUpdateStepResponse,
 } from './plan';
@@ -110,7 +109,7 @@ export class Runs extends APIResource {
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
-   * for await (const missionRunData of client.ai.missions.runs.list(
+   * for await (const runListResponse of client.ai.missions.runs.list(
    *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
    * )) {
    *   // ...
@@ -121,10 +120,10 @@ export class Runs extends APIResource {
     missionID: string,
     query: RunListParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<MissionRunDataDefaultFlatPagination, MissionRunData> {
+  ): PagePromise<RunListResponsesDefaultFlatPagination, RunListResponse> {
     return this._client.getAPIList(
       path`/ai/missions/${missionID}/runs`,
-      DefaultFlatPagination<MissionRunData>,
+      DefaultFlatPagination<RunListResponse>,
       { query, ...options },
     );
   }
@@ -155,7 +154,7 @@ export class Runs extends APIResource {
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
-   * for await (const missionRunData of client.ai.missions.runs.listRuns()) {
+   * for await (const runListRunsResponse of client.ai.missions.runs.listRuns()) {
    *   // ...
    * }
    * ```
@@ -163,8 +162,8 @@ export class Runs extends APIResource {
   listRuns(
     query: RunListRunsParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<MissionRunDataDefaultFlatPagination, MissionRunData> {
-    return this._client.getAPIList('/ai/missions/runs', DefaultFlatPagination<MissionRunData>, {
+  ): PagePromise<RunListRunsResponsesDefaultFlatPagination, RunListRunsResponse> {
+    return this._client.getAPIList('/ai/missions/runs', DefaultFlatPagination<RunListRunsResponse>, {
       query,
       ...options,
     });
@@ -211,9 +210,101 @@ export class Runs extends APIResource {
   }
 }
 
-export type MissionRunDataDefaultFlatPagination = DefaultFlatPagination<MissionRunData>;
+export type RunListResponsesDefaultFlatPagination = DefaultFlatPagination<RunListResponse>;
 
-export interface MissionRunData {
+export type RunListRunsResponsesDefaultFlatPagination = DefaultFlatPagination<RunListRunsResponse>;
+
+export interface RunCreateResponse {
+  data: RunCreateResponse.Data;
+}
+
+export namespace RunCreateResponse {
+  export interface Data {
+    mission_id: string;
+
+    run_id: string;
+
+    started_at: string;
+
+    status: 'pending' | 'running' | 'paused' | 'succeeded' | 'failed' | 'cancelled';
+
+    updated_at: string;
+
+    error?: string;
+
+    finished_at?: string;
+
+    input?: { [key: string]: unknown };
+
+    metadata?: { [key: string]: unknown };
+
+    result_payload?: { [key: string]: unknown };
+
+    result_summary?: string;
+  }
+}
+
+export interface RunRetrieveResponse {
+  data: RunRetrieveResponse.Data;
+}
+
+export namespace RunRetrieveResponse {
+  export interface Data {
+    mission_id: string;
+
+    run_id: string;
+
+    started_at: string;
+
+    status: 'pending' | 'running' | 'paused' | 'succeeded' | 'failed' | 'cancelled';
+
+    updated_at: string;
+
+    error?: string;
+
+    finished_at?: string;
+
+    input?: { [key: string]: unknown };
+
+    metadata?: { [key: string]: unknown };
+
+    result_payload?: { [key: string]: unknown };
+
+    result_summary?: string;
+  }
+}
+
+export interface RunUpdateResponse {
+  data: RunUpdateResponse.Data;
+}
+
+export namespace RunUpdateResponse {
+  export interface Data {
+    mission_id: string;
+
+    run_id: string;
+
+    started_at: string;
+
+    status: 'pending' | 'running' | 'paused' | 'succeeded' | 'failed' | 'cancelled';
+
+    updated_at: string;
+
+    error?: string;
+
+    finished_at?: string;
+
+    input?: { [key: string]: unknown };
+
+    metadata?: { [key: string]: unknown };
+
+    result_payload?: { [key: string]: unknown };
+
+    result_summary?: string;
+  }
+}
+
+export interface RunListResponse {
   mission_id: string;
 
   run_id: string;
@@ -237,28 +328,118 @@ export interface MissionRunData {
   result_summary?: string;
 }
 
-export interface RunCreateResponse {
-  data: MissionRunData;
+export interface RunCancelRunResponse {
+  data: RunCancelRunResponse.Data;
 }
 
-export interface RunRetrieveResponse {
-  data: MissionRunData;
-}
+export namespace RunCancelRunResponse {
+  export interface Data {
+    mission_id: string;
 
-export interface RunUpdateResponse {
-  data: MissionRunData;
+    run_id: string;
+
+    started_at: string;
+
+    status: 'pending' | 'running' | 'paused' | 'succeeded' | 'failed' | 'cancelled';
+
+    updated_at: string;
+
+    error?: string;
+
+    finished_at?: string;
+
+    input?: { [key: string]: unknown };
+
+    metadata?: { [key: string]: unknown };
+
+    result_payload?: { [key: string]: unknown };
+
+    result_summary?: string;
+  }
 }
 
-export interface RunCancelRunResponse {
-  data: MissionRunData;
+export interface RunListRunsResponse {
+  mission_id: string;
+
+  run_id: string;
+
+  started_at: string;
+
+  status: 'pending' | 'running' | 'paused' | 'succeeded' | 'failed' | 'cancelled';
+
+  updated_at: string;
+
+  error?: string;
+
+  finished_at?: string;
+
+  input?: { [key: string]: unknown };
+
+  metadata?: { [key: string]: unknown };
+
+  result_payload?: { [key: string]: unknown };
+
+  result_summary?: string;
 }
 
 export interface RunPauseRunResponse {
-  data: MissionRunData;
+  data: RunPauseRunResponse.Data;
+}
+
+export namespace RunPauseRunResponse {
+  export interface Data {
+    mission_id: string;
+
+    run_id: string;
+
+    started_at: string;
+
+    status: 'pending' | 'running' | 'paused' | 'succeeded' | 'failed' | 'cancelled';
+
+    updated_at: string;
+
+    error?: string;
+
+    finished_at?: string;
+
+    input?: { [key: string]: unknown };
+
+    metadata?: { [key: string]: unknown };
+
+    result_payload?: { [key: string]: unknown };
+
+    result_summary?: string;
+  }
 }
 
 export interface RunResumeRunResponse {
-  data: MissionRunData;
+  data: RunResumeRunResponse.Data;
+}
+
+export namespace RunResumeRunResponse {
+  export interface Data {
+    mission_id: string;
+
+    run_id: string;
+
+    started_at: string;
+
+    status: 'pending' | 'running' | 'paused' | 'succeeded' | 'failed' | 'cancelled';
+
+    updated_at: string;
+
+    error?: string;
+
+    finished_at?: string;
+
+    input?: { [key: string]: unknown };
+
+    metadata?: { [key: string]: unknown };
+
+    result_payload?: { [key: string]: unknown };
+
+    result_summary?: string;
+  }
 }
 
 export interface RunCreateParams {
@@ -329,14 +510,16 @@ 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 RunListResponse as RunListResponse,
     type RunCancelRunResponse as RunCancelRunResponse,
+    type RunListRunsResponse as RunListRunsResponse,
     type RunPauseRunResponse as RunPauseRunResponse,
     type RunResumeRunResponse as RunResumeRunResponse,
-    type MissionRunDataDefaultFlatPagination as MissionRunDataDefaultFlatPagination,
+    type RunListResponsesDefaultFlatPagination as RunListResponsesDefaultFlatPagination,
+    type RunListRunsResponsesDefaultFlatPagination as RunListRunsResponsesDefaultFlatPagination,
     type RunCreateParams as RunCreateParams,
     type RunRetrieveParams as RunRetrieveParams,
     type RunUpdateParams as RunUpdateParams,
@@ -360,7 +543,6 @@ export declare namespace Runs {
 
   export {
     Plan as Plan,
-    type PlanStepData as PlanStepData,
     type PlanCreateResponse as PlanCreateResponse,
     type PlanRetrieveResponse as PlanRetrieveResponse,
     type PlanAddStepsToPlanResponse as PlanAddStepsToPlanResponse,

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

@@ -705,6 +705,13 @@ export interface ParticipantParticipantsParams {
    */
   From?: string;
 
+  /**
+   * Body param: A unique label for the participant that will be added to the
+   * conference. The label can be used to reference the participant for updates via
+   * the TeXML REST API.
+   */
+  Label?: string;
+
   /**
    * Body param: Whether to detect if a human or an answering machine picked up the
    * call. Use `Enable` if you would like to ne notified as soon as the called party

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '5.26.0'; // x-release-please-version
+export const VERSION = '5.27.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "5.26.0";
+export declare const VERSION = "5.27.0";
 //# sourceMappingURL=version.d.mts.map