Method: StarkBank::Transaction.query

Defined in:

lib/transaction/transaction.rb

.query(limit: nil, after: nil, before: nil, external_ids: nil, user: nil) ⇒ Object

# Retrieve Transactions

Receive a generator of Transaction objects previously created in the Stark Bank API

## Parameters (optional):

• limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35

• after [Date, DateTime, Time or string, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)

• before [Date, DateTime, Time or string, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)

• external_ids [list of strings, default nil]: list of external ids to filter retrieved objects. ex: [‘5656565656565656’, ‘4545454545454545’]

• user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call

## Return:

• generator of Transaction objects with updated attributes

# File 'lib/transaction/transaction.rb', line 95

def self.query(limit: nil, after: nil, before: nil, external_ids: nil, user: nil)
  after = StarkBank::Utils::Checks.check_date(after)
  before = StarkBank::Utils::Checks.check_date(before)
  StarkBank::Utils::Rest.get_list(user: user, limit: limit, after: after, before: before, external_ids: external_ids, **resource)
end