Class: Zavudev::Resources::Senders::Agent::Executions

Inherits:

Object

• Object
• Zavudev::Resources::Senders::Agent::Executions

Defined in:

lib/zavudev/resources/senders/agent/executions.rb

Instance Method Summary

• #initialize(client:) ⇒ Executions constructor private

  A new instance of Executions.

• #list(sender_id, cursor: nil, limit: nil, status: nil, request_options: {}) ⇒ Zavudev::Internal::Cursor<Zavudev::Models::Senders::AgentExecution>

  List recent agent executions with pagination.

Constructor Details

#initialize(client:) ⇒ Executions

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

Parameters:

• client (Zavudev::Client)

# File 'lib/zavudev/resources/senders/agent/executions.rb', line 41

def initialize(client:)
  @client = client
end

Instance Method Details

#list(sender_id, cursor: nil, limit: nil, status: nil, request_options: {}) ⇒ Zavudev::Internal::Cursor<Zavudev::Models::Senders::AgentExecution>

List recent agent executions with pagination.

Parameters:

• sender_id (String)
• cursor (String)
• limit (Integer)
• status (Symbol, Zavudev::Models::Senders::AgentExecutionStatus) —

  Status of an agent execution.

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

Returns:

• (Zavudev::Internal::Cursor<Zavudev::Models::Senders::AgentExecution>)

See Also:

• Models::Senders::Agent::ExecutionListParams

# File 'lib/zavudev/resources/senders/agent/executions.rb', line 25

def list(sender_id, params = {})
  parsed, options = Zavudev::Senders::Agent::ExecutionListParams.dump_request(params)
  query = Zavudev::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["v1/senders/%1$s/agent/executions", sender_id],
    query: query,
    page: Zavudev::Internal::Cursor,
    model: Zavudev::Senders::AgentExecution,
    options: options
  )
end