Class: Sequence::Action::ClientModule

Inherits:

ClientModule

• Object
• ClientModule
• Sequence::Action::ClientModule

Defined in:

lib/sequence/action.rb

Instance Attribute Summary

Attributes inherited from ClientModule

#client

Instance Method Summary

• #list(opts = {}) ⇒ Query

  Executes a query, returning an enumerable over individual actions.

• #sum(opts = {}) ⇒ Query

  Executes a query, returning an enumerable over individual actionsums.

Methods inherited from ClientModule

#initialize

Constructor Details

This class inherits a constructor from Sequence::ClientModule

Instance Method Details

#list(opts = {}) ⇒ Query

Executes a query, returning an enumerable over individual actions.

Examples:

List all actions after a certain time

ledger.actions.list(
  filter: 'timestamp > $1',
  filter_params: ['1985-10-26T01:21:00Z']
).each do |action|
  puts 'timestamp: ' + action.timestamp
  puts 'amount: ' + action.amount
end

Parameters:

• opts (Hash) (defaults to: {}) —

  Options hash

Options Hash (opts):

• filter (String) —

  A filter expression.

• filter_params (Array<String|Integer>) —

  A list of values that will be interpolated into the filter expression.

• ] (Integer) —

  page_size The number of items to return in the result set.

Returns:

• (Query)

# File 'lib/sequence/action.rb', line 138

def list(opts = {})
  validate_inclusion_of!(
    opts,
    :filter,
    :filter_params,
    :page_size,
    :after,
  )
  ListQuery.new(client, opts)
end

#sum(opts = {}) ⇒ Query

Executes a query, returning an enumerable over individual actionsums.

Parameters:

• opts (Hash) (defaults to: {}) —

  Options hash

Options Hash (opts):

• filter (String) —

  A filter expression.

• filter_params (Array<String|Integer>) —

  A list of values that will be interpolated into the filter expression.

• group_by (Array<String>) —

  A list of fields along which action values will be summed.

• ] (Integer) —

  page_size The number of items to return in the result set.

Returns:

• (Query)

# File 'lib/sequence/action.rb', line 161

def sum(opts = {})
  validate_inclusion_of!(
    opts,
    :filter,
    :filter_params,
    :group_by,
    :page_size,
  )
  SumQuery.new(client, opts)
end