Class: Telnyx::Resources::AI::Missions::Runs::Events

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/ai/missions/runs/events.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Events

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 Events.

Parameters:



122
123
124
 
# File 'lib/telnyx/resources/ai/missions/runs/events.rb', line 122

def initialize(client:)
  @client = client
end

Instance Method Details

#get_event_details(event_id, mission_id:, run_id:, request_options: {}) ⇒ Telnyx::Models::AI::Missions::Runs::EventGetEventDetailsResponse

Get details of a specific event

Parameters:

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

Returns:

See Also:



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/telnyx/resources/ai/missions/runs/events.rb', line 61

def get_event_details(event_id, params)
  parsed, options = Telnyx::AI::Missions::Runs::EventGetEventDetailsParams.dump_request(params)
  mission_id =
    parsed.delete(:mission_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  run_id =
    parsed.delete(:run_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["ai/missions/%1$s/runs/%2$s/events/%3$s", mission_id, run_id, event_id],
    model: Telnyx::Models::AI::Missions::Runs::EventGetEventDetailsResponse,
    options: options
  )
end

#list(run_id, mission_id:, agent_id: nil, page_number: nil, page_size: nil, step_id: nil, type: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::AI::Missions::Runs::EventData>

List events for a run (paginated)

Parameters:

  • run_id (String) —

    Path param

  • mission_id (String) —

    Path param

  • agent_id (String) —

    Query param

  • page_number (Integer) —

    Query param: Page number (1-based)

  • page_size (Integer) —

    Query param: Number of items per page

  • step_id (String) —

    Query param

  • type (String) —

    Query param

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

Returns:

See Also:



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/telnyx/resources/ai/missions/runs/events.rb', line 32

def list(run_id, params)
  parsed, options = Telnyx::AI::Missions::Runs::EventListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  mission_id =
    parsed.delete(:mission_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["ai/missions/%1$s/runs/%2$s/events", mission_id, run_id],
    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

#log(run_id, mission_id:, summary:, type:, agent_id: nil, idempotency_key: nil, payload: nil, step_id: nil, request_options: {}) ⇒ Telnyx::Models::AI::Missions::Runs::EventLogResponse

Log an event for a run

Parameters:

  • run_id (String) —

    Path param

  • mission_id (String) —

    Path param

  • summary (String) —

    Body param

  • type (Symbol, Telnyx::Models::AI::Missions::Runs::EventLogParams::Type) —

    Body param

  • agent_id (String) —

    Body param

  • idempotency_key (String) —

    Body param: Prevents duplicate events on retry

  • payload (Hash{Symbol=>Object}) —

    Body param

  • step_id (String) —

    Body param

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

Returns:

See Also:



104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/telnyx/resources/ai/missions/runs/events.rb', line 104

def log(run_id, params)
  parsed, options = Telnyx::AI::Missions::Runs::EventLogParams.dump_request(params)
  mission_id =
    parsed.delete(:mission_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :post,
    path: ["ai/missions/%1$s/runs/%2$s/events", mission_id, run_id],
    body: parsed,
    model: Telnyx::Models::AI::Missions::Runs::EventLogResponse,
    options: options
  )
end