Class: Atrium::MembersApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MembersApi

Returns a new instance of MembersApi.



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

def api_client
  @api_client
end

Instance Method Details

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

Aggregate member Calling this endpoint initiates an aggregation event for the member. This brings in the latest account and transaction data from the connected institution. If this data has recently been updated, MX may not initiate an aggregation event.

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:



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

def aggregate_member(member_guid, user_guid, opts = {})
  data, _status_code, _headers = aggregate_member_with_http_info(member_guid, user_guid, opts)
  data
end

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

Aggregate member account balances This endpoint operates much like the _aggregate member_ endpoint except that it gathers only account balance information; it does not gather any transaction data at all.

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:



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

def aggregate_member_balances(member_guid, user_guid, opts = {})
  data, _status_code, _headers = aggregate_member_balances_with_http_info(member_guid, user_guid, opts)
  data
end

#create_member(user_guid, body, opts = {}) ⇒ MemberResponseBody

Create member This endpoint allows you to create a new member. Members are created with the required parameters credentials and institution_code, and the optional parameters identifier and metadata.
When creating a member, you’ll need to include the correct type of credential required by the financial institution and provided by the user. You can find out which credential type is required with the /institutions/institution_code/credentials endpoint.
If successful, Atrium will respond with the newly-created member object.
Once you successfully create a member, MX will immediately validate the provided credentials and attempt to aggregate data for accounts and transactions.

Parameters:

  • user_guid —

    The unique identifier for a `user`.

  • body —

    Member object to be created with optional parameters (identifier and metadata) and required parameters (credentials and institution_code)

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

    the optional parameters

Returns:



46
47
48
49
 
# File 'lib/atrium-ruby/api/members_api.rb', line 46

def create_member(user_guid, body, opts = {})
  data, _status_code, _headers = create_member_with_http_info(user_guid, body, opts)
  data
end

#delete_member(member_guid, user_guid, opts = {}) ⇒ nil

Delete member Accessing this endpoint will permanently delete 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:

  • (nil) 


57
58
59
60
 
# File 'lib/atrium-ruby/api/members_api.rb', line 57

def delete_member(member_guid, user_guid, opts = {})
  delete_member_with_http_info(member_guid, user_guid, opts)
  nil
end

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

Extend history The extend_history endpoint begins the process of fetching up to 24 months of data associated with a particular ‘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:



68
69
70
71
 
# File 'lib/atrium-ruby/api/members_api.rb', line 68

def extend_history(member_guid, user_guid, opts = {})
  data, _status_code, _headers = extend_history_with_http_info(member_guid, user_guid, opts)
  data
end

#list_member_accounts(member_guid, user_guid, opts = {}) ⇒ AccountsResponseBody

List member accounts This endpoint returns an array with information about every account associated with a particular 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:



81
82
83
84
 
# File 'lib/atrium-ruby/api/members_api.rb', line 81

def list_member_accounts(member_guid, user_guid, opts = {})
  data, _status_code, _headers = list_member_accounts_with_http_info(member_guid, user_guid, opts)
  data
end

#list_member_credentials(member_guid, user_guid, opts = {}) ⇒ CredentialsResponseBody

List member credentials This endpoint returns an array which contains information on every non-MFA credential associated with a specific 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:



92
93
94
95
 
# File 'lib/atrium-ruby/api/members_api.rb', line 92

def list_member_credentials(member_guid, user_guid, opts = {})
  data, _status_code, _headers = list_member_credentials_with_http_info(member_guid, user_guid, opts)
  data
end

#list_member_mfa_challenges(member_guid, user_guid, opts = {}) ⇒ ChallengesResponseBody

List member MFA challenges Use this endpoint for information on what multi-factor authentication challenges need to be answered in order to aggregate a member.
If the aggregation is not challenged, i.e., the member does not have a connection status of CHALLENGED, then code 204 No Content will be returned.
If the aggregation has been challenged, i.e., the member does have a connection status of CHALLENGED, then code 200 OK will be returned — along with the corresponding credentials.

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:



103
104
105
106
 
# File 'lib/atrium-ruby/api/members_api.rb', line 103

def list_member_mfa_challenges(member_guid, user_guid, opts = {})
  data, _status_code, _headers = list_member_mfa_challenges_with_http_info(member_guid, user_guid, opts)
  data
end

#list_member_transactions(member_guid, user_guid, opts = {}) ⇒ TransactionsResponseBody

List member transactions Use this endpoint to get all transactions from all accounts associated with a specific member.
This endpoint accepts optional URL query parameters — from_date and to_date — which are used to filter transactions according to the date they were posted. If no values are given for the query parameters, 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:

  • 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):

  • :from_date (String) —

    Filter transactions from this date.

  • :to_date (String) —

    Filter transactions to this date.

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:



118
119
120
121
 
# File 'lib/atrium-ruby/api/members_api.rb', line 118

def list_member_transactions(member_guid, user_guid, opts = {})
  data, _status_code, _headers = list_member_transactions_with_http_info(member_guid, user_guid, opts)
  data
end

#list_members(user_guid, opts = {}) ⇒ MembersResponseBody

List members This endpoint returns an array which contains information on every member associated with a specific user.

Parameters:

  • 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:



130
131
132
133
 
# File 'lib/atrium-ruby/api/members_api.rb', line 130

def list_members(user_guid, opts = {})
  data, _status_code, _headers = list_members_with_http_info(user_guid, opts)
  data
end

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

Read member Use this endpoint to read the attributes of a specific 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:



141
142
143
144
 
# File 'lib/atrium-ruby/api/members_api.rb', line 141

def read_member(member_guid, user_guid, opts = {})
  data, _status_code, _headers = read_member_with_http_info(member_guid, user_guid, opts)
  data
end

#read_member_status(member_guid, user_guid, opts = {}) ⇒ MemberConnectionStatusResponseBody

Read member connection status This endpoint provides the status of the member’s most recent aggregation event. This is an important step in the aggregation process, and the results returned by this endpoint should determine what you do next in order to successfully aggregate a member.
MX has introduced new, more detailed information on the current status of a member’s connection to a financial institution and the state of its aggregation: the connection_status field. These are intended to replace and expand upon the information provided in the status field, which will soon be deprecated; support for the status field remains for the time being.

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:



152
153
154
155
 
# File 'lib/atrium-ruby/api/members_api.rb', line 152

def read_member_status(member_guid, user_guid, opts = {})
  data, _status_code, _headers = read_member_status_with_http_info(member_guid, user_guid, opts)
  data
end

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

Read OAuth Window URI This endpoint will generate an ‘oauth_window_uri` for the specified `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):

  • :referral_source (String) —

    Should be either BROWSER or APP depending on the implementation.

  • :ui_message_webview_url_scheme (String) —

    A scheme for routing the user back to the application state they were previously in.

Returns:



165
166
167
168
 
# File 'lib/atrium-ruby/api/members_api.rb', line 165

def read_o_auth_window_uri(member_guid, user_guid, opts = {})
  data, _status_code, _headers = read_o_auth_window_uri_with_http_info(member_guid, user_guid, opts)
  data
end

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

Resume aggregation from MFA This endpoint answers the challenges needed when a member has been challenged by multi-factor authentication.

Parameters:

  • member_guid —

    The unique identifier for a `member`.

  • user_guid —

    The unique identifier for a `user`.

  • body —

    Member object with MFA challenge answers

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

    the optional parameters

Returns:



177
178
179
180
 
# File 'lib/atrium-ruby/api/members_api.rb', line 177

def resume_member(member_guid, user_guid, body, opts = {})
  data, _status_code, _headers = resume_member_with_http_info(member_guid, user_guid, body, opts)
  data
end

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

Update member Use this endpoint to update a member’s attributes. Only the credentials, identifier, and metadata parameters can be updated. To get a list of the required credentials for the member, use the list member credentials endpoint.

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):

  • :body (MemberUpdateRequestBody) —

    Member object to be updated with optional parameters (credentials, identifier, metadata)

Returns:



189
190
191
192
 
# File 'lib/atrium-ruby/api/members_api.rb', line 189

def update_member(member_guid, user_guid, opts = {})
  data, _status_code, _headers = update_member_with_http_info(member_guid, user_guid, opts)
  data
end