Class: Sequence::Action::ClientModule

Inherits:
ClientModule show all
Defined in:
lib/sequence/action.rb

Instance Attribute Summary

Attributes inherited from ClientModule

#client

Instance Method Summary collapse

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.

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:



103
104
105
106
107
108
109
110
111
112
 
# File 'lib/sequence/action.rb', line 103

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:



126
127
128
129
130
131
132
133
134
135
 
# File 'lib/sequence/action.rb', line 126

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