Class: Atrium::StatementsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ StatementsApi

Returns a new instance of StatementsApi.



15
16
17
 
# File 'lib/atrium-ruby/api/statements_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/statements_api.rb', line 13

def api_client
  @api_client
end

Instance Method Details

#download_statement_pdf(member_guid, user_guid, statement_guid, opts = {}) ⇒ File

Download statement PDF Use this endpoint to download a specified statement. The endpoint URL is the same as the URI given in each ‘statement` object.

Parameters:

  • member_guid —

    The unique identifier for a `member`.

  • user_guid —

    The unique identifier for a `user`.

  • statement_guid —

    The unique identifier for an `statement`.

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

    the optional parameters

Returns:

  • (File) 


25
26
27
28
 
# File 'lib/atrium-ruby/api/statements_api.rb', line 25

def download_statement_pdf(member_guid, user_guid, statement_guid, opts = {})
  data, _status_code, _headers = download_statement_pdf_with_http_info(member_guid, user_guid, statement_guid, opts)
  data
end

#fetch_statements(member_guid, user_guid, opts = {}) ⇒ MemberResponseBody

Fetch statements The fetch statements endpoint begins fetching statements for a member.

Parameters:

  • member_guid —

    The unique identifier for a `member`.

  • user_guid —

    The unique identifier for a `user`.

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

    the optional parameters

Returns:



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

def fetch_statements(member_guid, user_guid, opts = {})
  data, _status_code, _headers = fetch_statements_with_http_info(member_guid, user_guid, opts)
  data
end

#list_member_statements(member_guid, user_guid, opts = {}) ⇒ StatementsResponseBody

List member statements Certain institutions in Atrium allow developers to access account statements associated with a particular ‘member`. Use this endpoint to get an array of available statements. Before this endpoint can be used, `fetch_statements` should be performed on the relevant `member`.

Parameters:

  • member_guid —

    The unique identifier for a `member`.

  • user_guid —

    The unique identifier for a `user`.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:



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

def list_member_statements(member_guid, user_guid, opts = {})
  data, _status_code, _headers = list_member_statements_with_http_info(member_guid, user_guid, opts)
  data
end

#read_member_statement(member_guid, user_guid, statement_guid, opts = {}) ⇒ StatementResponseBody

Read statement JSON Use this endpoint to download a specified statement. The endpoint URL is the same as the URI given in each ‘statement` object.

Parameters:

  • member_guid —

    The unique identifier for a `member`.

  • user_guid —

    The unique identifier for a `user`.

  • statement_guid —

    The unique identifier for an `statement`.

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

    the optional parameters

Returns:



61
62
63
64
 
# File 'lib/atrium-ruby/api/statements_api.rb', line 61

def read_member_statement(member_guid, user_guid, statement_guid, opts = {})
  data, _status_code, _headers = read_member_statement_with_http_info(member_guid, user_guid, statement_guid, opts)
  data
end