Class: Telnyx::Resources::AI::Missions

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/ai/missions.rb,
lib/telnyx/resources/ai/missions/runs.rb,
lib/telnyx/resources/ai/missions/tools.rb,
lib/telnyx/resources/ai/missions/runs/plan.rb,
lib/telnyx/resources/ai/missions/mcp_servers.rb,
lib/telnyx/resources/ai/missions/runs/events.rb,
lib/telnyx/resources/ai/missions/knowledge_bases.rb,
lib/telnyx/resources/ai/missions/runs/telnyx_agents.rb,
sig/telnyx/resources/ai/missions.rbs,
sig/telnyx/resources/ai/missions/runs.rbs,
sig/telnyx/resources/ai/missions/tools.rbs,
sig/telnyx/resources/ai/missions/runs/plan.rbs,
sig/telnyx/resources/ai/missions/mcp_servers.rbs,
sig/telnyx/resources/ai/missions/runs/events.rbs,
sig/telnyx/resources/ai/missions/knowledge_bases.rbs,
sig/telnyx/resources/ai/missions/runs/telnyx_agents.rbs

Defined Under Namespace

Classes: KnowledgeBases, McpServers, Runs, Tools

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Missions

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Missions.

Parameters:



204
205
206
207
208
209
210
 
# File 'lib/telnyx/resources/ai/missions.rb', line 204

def initialize(client:)
  @client = client
  @runs = Telnyx::Resources::AI::Missions::Runs.new(client: client)
  @knowledge_bases = Telnyx::Resources::AI::Missions::KnowledgeBases.new(client: client)
  @mcp_servers = Telnyx::Resources::AI::Missions::McpServers.new(client: client)
  @tools = Telnyx::Resources::AI::Missions::Tools.new(client: client)
end

Instance Attribute Details

#knowledge_bases ⇒ Telnyx::Resources::AI::Missions::KnowledgeBases (readonly)

Returns:



11
12
13
 
# File 'lib/telnyx/resources/ai/missions.rb', line 11

def knowledge_bases
  @knowledge_bases
end

#mcp_servers ⇒ Telnyx::Resources::AI::Missions::McpServers (readonly)

Returns:



14
15
16
 
# File 'lib/telnyx/resources/ai/missions.rb', line 14

def mcp_servers
  @mcp_servers
end

#runs ⇒ Telnyx::Resources::AI::Missions::Runs (readonly)

Returns:



8
9
10
 
# File 'lib/telnyx/resources/ai/missions.rb', line 8

def runs
  @runs
end

#tools ⇒ Telnyx::Resources::AI::Missions::Tools (readonly)

Returns:



17
18
19
 
# File 'lib/telnyx/resources/ai/missions.rb', line 17

def tools
  @tools
end

Instance Method Details

#clone_mission(mission_id, request_options: {}) ⇒ Object

Creates a copy of the specified mission as a new mission definition, so you can iterate on its configuration without modifying the original.

Parameters:

  • mission_id (String) —

    Unique identifier of the mission.

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

  • (Object)

See Also:



106
107
108
109
110
111
112
113
 
# File 'lib/telnyx/resources/ai/missions.rb', line 106

def clone_mission(mission_id, params = {})
  @client.request(
    method: :post,
    path: ["ai/missions/%1$s/clone", mission_id],
    model: Telnyx::Internal::Type::Unknown,
    options: params[:request_options]
  )
end

#create(name:, description: nil, execution_mode: nil, instructions: nil, metadata: nil, model: nil, request_options: {}) ⇒ Telnyx::Models::AI::MissionResponse

Creates a new mission definition from the provided configuration and returns the created mission. Execute the mission by starting runs against it.

Parameters:

Returns:

See Also:



35
36
37
38
39
40
41
42
43
44
 
# File 'lib/telnyx/resources/ai/missions.rb', line 35

def create(params)
  parsed, options = Telnyx::AI::MissionCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "ai/missions",
    body: parsed,
    model: Telnyx::AI::MissionResponse,
    options: options
  )
end

#delete_mission(mission_id, request_options: {}) ⇒ nil

Permanently deletes the specified mission definition and returns no content on success.

Parameters:

  • mission_id (String) —

    Unique identifier of the mission.

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

  • (nil)

See Also:



127
128
129
130
131
132
133
134
 
# File 'lib/telnyx/resources/ai/missions.rb', line 127

def delete_mission(mission_id, params = {})
  @client.request(
    method: :delete,
    path: ["ai/missions/%1$s", mission_id],
    model: NilClass,
    options: params[:request_options]
  )
end

#list(page_number: nil, page_size: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::AI::MissionData>

Returns a paginated list of all mission definitions in your organization. Missions describe a goal and the tools, knowledge bases, and MCP servers agents may use to accomplish it.

Parameters:

  • page_number (Integer) —

    Page number (1-based)

  • page_size (Integer) —

    Number of items per page

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/telnyx/resources/ai/missions.rb', line 81

def list(params = {})
  parsed, options = Telnyx::AI::MissionListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "ai/missions",
    query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::AI::MissionData,
    options: options
  )
end

#list_events(page_number: nil, page_size: nil, type: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::AI::Missions::Runs::EventData>

Returns a paginated list of recent events across every mission in your organization, optionally filtered by event type. Useful for building activity feeds or monitoring dashboards.

Parameters:

  • page_number (Integer) —

    Page number (1-based)

  • page_size (Integer) —

    Number of items per page

  • type (String) —

    Filter results by type.

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/telnyx/resources/ai/missions.rb', line 153

def list_events(params = {})
  parsed, options = Telnyx::AI::MissionListEventsParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "ai/missions/events",
    query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::AI::Missions::Runs::EventData,
    options: options
  )
end

#retrieve(mission_id, request_options: {}) ⇒ Telnyx::Models::AI::MissionResponse

Get a mission by ID (includes tools, knowledge_bases, mcp_servers)

Parameters:

  • mission_id (String) —

    Unique identifier of the mission.

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



57
58
59
60
61
62
63
64
 
# File 'lib/telnyx/resources/ai/missions.rb', line 57

def retrieve(mission_id, params = {})
  @client.request(
    method: :get,
    path: ["ai/missions/%1$s", mission_id],
    model: Telnyx::AI::MissionResponse,
    options: params[:request_options]
  )
end

#update_mission(mission_id, description: nil, execution_mode: nil, instructions: nil, metadata: nil, model: nil, name: nil, request_options: {}) ⇒ Telnyx::Models::AI::MissionResponse

Replaces the specified mission's definition with the provided configuration and returns the updated mission.

Parameters:

  • mission_id (String) —

    Unique identifier of the mission.

  • description (String)
  • execution_mode (Symbol, Telnyx::Models::AI::ExecutionMode)
  • instructions (String)
  • metadata (Hash{Symbol=>Object})
  • model (String)
  • name (String)
  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



190
191
192
193
194
195
196
197
198
199
 
# File 'lib/telnyx/resources/ai/missions.rb', line 190

def update_mission(mission_id, params = {})
  parsed, options = Telnyx::AI::MissionUpdateMissionParams.dump_request(params)
  @client.request(
    method: :put,
    path: ["ai/missions/%1$s", mission_id],
    body: parsed,
    model: Telnyx::AI::MissionResponse,
    options: options
  )
end