Class: Atrium::TransactionsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/atrium-ruby/api/transactions_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TransactionsApi

Returns a new instance of TransactionsApi.



15
16
17
 
# File 'lib/atrium-ruby/api/transactions_api.rb', line 15

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



13
14
15
 
# File 'lib/atrium-ruby/api/transactions_api.rb', line 13

def api_client
  @api_client
end

Instance Method Details

#cleanse_and_categorize_transactions(body, opts = {}) ⇒ TransactionsCleanseAndCategorizeResponseBody

Categorize transactions Use this endpoint to categorize, cleanse, and classify transactions. These transactions are not persisted or stored on the MX platform.

Parameters:

  • body —

    User object to be created with optional parameters (amount, type) amd required parameters (description, identifier)

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

    the optional parameters

Returns:



23
24
25
26
 
# File 'lib/atrium-ruby/api/transactions_api.rb', line 23

def cleanse_and_categorize_transactions(body, opts = {})
  data, _status_code, _headers = cleanse_and_categorize_transactions_with_http_info(body, opts)
  data
end

#list_user_transactions(user_guid, opts = {}) ⇒ TransactionsResponseBody

List transactions for a user Use this endpoint to get all transactions that belong to a specific user, across all the user’s members and accounts.
This endpoint accepts optional query parameters, from_date and to_date, which filter transactions according to the date they were posted. If no values are given, from_date will default to 90 days prior to the request, and to_date will default to 5 days from the time of the request.

Parameters:

  • user_guid —

    The unique identifier for a `user`.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :from_date (String) —

    Filter transactions from this date.

  • :records_per_page (Integer) —

    Specify records per page.

  • :to_date (String) —

    Filter transactions to this date.

Returns:



37
38
39
40
 
# File 'lib/atrium-ruby/api/transactions_api.rb', line 37

def list_user_transactions(user_guid, opts = {})
  data, _status_code, _headers = list_user_transactions_with_http_info(user_guid, opts)
  data
end

#read_transaction(transaction_guid, user_guid, opts = {}) ⇒ TransactionResponseBody

Read a transaction This endpoint allows you to view information about a specific transaction that belongs to a user.

Parameters:

  • transaction_guid —

    The unique identifier for a `transaction`.

  • user_guid —

    The unique identifier for a `user`.

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

    the optional parameters

Returns:



48
49
50
51
 
# File 'lib/atrium-ruby/api/transactions_api.rb', line 48

def read_transaction(transaction_guid, user_guid, opts = {})
  data, _status_code, _headers = read_transaction_with_http_info(transaction_guid, user_guid, opts)
  data
end