Class: Increase::Resources::Transactions

Inherits:

Object

• Object
• Increase::Resources::Transactions

Defined in:

lib/increase/resources/transactions.rb

Instance Method Summary

• #initialize(client:) ⇒ Transactions constructor private

  A new instance of Transactions.

• #list(account_id: nil, category: nil, created_at: nil, cursor: nil, limit: nil, route_id: nil, request_options: {}) ⇒ Increase::Internal::Page<Increase::Models::Transaction>

  Some parameter documentations has been truncated, see Models::TransactionListParams for more details.

• #retrieve(transaction_id, request_options: {}) ⇒ Increase::Models::Transaction

  Retrieve a Transaction.

Constructor Details

#initialize(client:) ⇒ Transactions

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

Parameters:

• client (Increase::Client)

# File 'lib/increase/resources/transactions.rb', line 65

def initialize(client:)
  @client = client
end

Instance Method Details

#list(account_id: nil, category: nil, created_at: nil, cursor: nil, limit: nil, route_id: nil, request_options: {}) ⇒ Increase::Internal::Page<Increase::Models::Transaction>

Some parameter documentations has been truncated, see Models::TransactionListParams for more details.

List Transactions

Parameters:

• account_id (String) —

  Filter Transactions for those belonging to the specified Account.

• category (Increase::Models::TransactionListParams::Category)
• created_at (Increase::Models::TransactionListParams::CreatedAt)
• cursor (String) —

  Return the page of entries after this one.

• limit (Integer) —

  Limit the size of the list that is returned. The default (and maximum) is 100 ob

• route_id (String) —

  Filter Transactions for those belonging to the specified route. This could be a

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

Returns:

• (Increase::Internal::Page<Increase::Models::Transaction>)

See Also:

• Models::TransactionListParams

# File 'lib/increase/resources/transactions.rb', line 50

def list(params = {})
  parsed, options = Increase::TransactionListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "transactions",
    query: parsed,
    page: Increase::Internal::Page,
    model: Increase::Transaction,
    options: options
  )
end

#retrieve(transaction_id, request_options: {}) ⇒ Increase::Models::Transaction

Retrieve a Transaction

Parameters:

• transaction_id (String) —

  The identifier of the Transaction to retrieve.

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

Returns:

• (Increase::Models::Transaction)

See Also:

• Models::TransactionRetrieveParams

# File 'lib/increase/resources/transactions.rb', line 17

def retrieve(transaction_id, params = {})
  @client.request(
    method: :get,
    path: ["transactions/%1$s", transaction_id],
    model: Increase::Transaction,
    options: params[:request_options]
  )
end