atrium-ruby 1.3.2 → 2.0.0

data/docs/AccountsResponseBody.md

@@ -0,0 +1,9 @@
+# Atrium::AccountsResponseBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**accounts** | [**Array<Account>**](Account.md) |  | [optional] 
+**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
+
+

data/docs/Challenge.md

@@ -0,0 +1,13 @@
+# Atrium::Challenge
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**field_name** | **String** |  | [optional] 
+**guid** | **String** |  | [optional] 
+**image_data** | **String** |  | [optional] 
+**label** | **String** |  | [optional] 
+**options** | [**Array<ChallengeOption>**](ChallengeOption.md) |  | [optional] 
+**type** | **String** |  | [optional] 
+
+

data/docs/ChallengeOption.md

@@ -0,0 +1,10 @@
+# Atrium::ChallengeOption
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**image_data** | **String** |  | [optional] 
+**label** | **String** |  | [optional] 
+**value** | **String** |  | [optional] 
+
+

data/docs/ChallengesResponseBody.md

@@ -0,0 +1,8 @@
+# Atrium::ChallengesResponseBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**challenges** | [**Array<Challenge>**](Challenge.md) |  | [optional] 
+
+

data/docs/ConnectWidget.md

@@ -0,0 +1,9 @@
+# Atrium::ConnectWidget
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**connect_widget_url** | **String** |  | [optional] 
+**guid** | **String** |  | [optional] 
+
+

data/docs/ConnectWidgetApi.md

@@ -0,0 +1,44 @@
+# Atrium::ConnectWidgetApi
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_connect_widget**](ConnectWidgetApi.md#get_connect_widget) | **POST** /users/{user_guid}/connect_widget_url | Embedding in a website
+
+
+# **get_connect_widget**
+> ConnectWidgetResponseBody get_connect_widget(user_guidbody)
+
+Embedding in a website
+
+This endpoint will return a URL for an embeddable version of MX Connect.
+
+### Example
+```ruby
+# load the gem
+require 'atrium-ruby'
+
+client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
+
+user_guid = "USR-123" # String | The unique identifier for a `user`.
+body = Atrium::ConnectWidgetRequestBody.new # ConnectWidgetRequestBody | Optional config options for WebView (is_mobile_webview, current_institution_code, current_member_guid, update_credentials)
+
+begin
+  #Embedding in a website
+  response = client.connectWidget.get_connect_widget(user_guidbody)
+  p response
+rescue Atrium::ApiError => e
+  puts "Exception when calling ConnectWidgetApi->get_connect_widget: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_guid** | **String**| The unique identifier for a `user`. | 
+ **body** | [**ConnectWidgetRequestBody**](ConnectWidgetRequestBody.md)| Optional config options for WebView (is_mobile_webview, current_institution_code, current_member_guid, update_credentials) | 
+
+### Return type
+
+[**ConnectWidgetResponseBody**](ConnectWidgetResponseBody.md)
+

data/docs/ConnectWidgetRequestBody.md

@@ -0,0 +1,11 @@
+# Atrium::ConnectWidgetRequestBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**is_mobile_webview** | **BOOLEAN** |  | [optional] 
+**current_institution_code** | **String** |  | [optional] 
+**current_member_guid** | **String** |  | [optional] 
+**update_credentials** | **BOOLEAN** |  | [optional] 
+
+

data/docs/ConnectWidgetResponseBody.md

@@ -0,0 +1,8 @@
+# Atrium::ConnectWidgetResponseBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user** | [**ConnectWidget**](ConnectWidget.md) |  | [optional] 
+
+

data/docs/CredentialOption.md

@@ -0,0 +1,9 @@
+# Atrium::CredentialOption
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**label** | **String** |  | [optional] 
+**value** | **String** |  | [optional] 
+
+

data/docs/CredentialRequest.md

@@ -0,0 +1,9 @@
+# Atrium::CredentialRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**guid** | **String** |  | [optional] 
+**value** | **String** |  | [optional] 
+
+

data/docs/CredentialResponse.md

@@ -0,0 +1,12 @@
+# Atrium::CredentialResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**field_name** | **String** |  | [optional] 
+**guid** | **String** |  | [optional] 
+**label** | **String** |  | [optional] 
+**options** | [**Array<CredentialOption>**](CredentialOption.md) |  | [optional] 
+**type** | **String** |  | [optional] 
+
+

data/docs/CredentialsResponseBody.md

@@ -0,0 +1,8 @@
+# Atrium::CredentialsResponseBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**credentials** | [**Array<CredentialResponse>**](CredentialResponse.md) |  | [optional] 
+
+

data/docs/IdentityApi.md

@@ -0,0 +1,82 @@
+# Atrium::IdentityApi
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**identify_member**](IdentityApi.md#identify_member) | **POST** /users/{user_guid}/members/{member_guid}/identify | Identify
+[**list_account_owners**](IdentityApi.md#list_account_owners) | **GET** /users/{user_guid}/members/{member_guid}/account_owners | List member account owners
+
+
+# **identify_member**
+> MemberResponseBody identify_member(member_guid, user_guid)
+
+Identify
+
+The identify endpoint begins an identification process for an already-existing member.
+
+### Example
+```ruby
+# load the gem
+require 'atrium-ruby'
+
+client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
+
+member_guid = "MBR-123" # String | The unique identifier for a `member`.
+user_guid = "USR-123" # String | The unique identifier for a `user`.
+
+begin
+  #Identify
+  response = client.identity.identify_member(member_guid, user_guid)
+  p response
+rescue Atrium::ApiError => e
+  puts "Exception when calling IdentityApi->identify_member: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **member_guid** | **String**| The unique identifier for a `member`. | 
+ **user_guid** | **String**| The unique identifier for a `user`. | 
+
+### Return type
+
+[**MemberResponseBody**](MemberResponseBody.md)
+
+# **list_account_owners**
+> AccountOwnersResponseBody list_account_owners(member_guid, user_guid)
+
+List member account owners
+
+This endpoint returns an array with information about every account associated with a particular member.
+
+### Example
+```ruby
+# load the gem
+require 'atrium-ruby'
+
+client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
+
+member_guid = "MBR-123" # String | The unique identifier for a `member`.
+user_guid = "USR-123" # String | The unique identifier for a `user`.
+
+begin
+  #List member account owners
+  response = client.identity.list_account_owners(member_guid, user_guid)
+  p response
+rescue Atrium::ApiError => e
+  puts "Exception when calling IdentityApi->list_account_owners: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **member_guid** | **String**| The unique identifier for a `member`. | 
+ **user_guid** | **String**| The unique identifier for a `user`. | 
+
+### Return type
+
+[**AccountOwnersResponseBody**](AccountOwnersResponseBody.md)
+

data/docs/Institution.md

@@ -0,0 +1,14 @@
+# Atrium::Institution
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** |  | [optional] 
+**medium_logo_url** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**small_logo_url** | **String** |  | [optional] 
+**supports_account_identification** | **BOOLEAN** |  | [optional] 
+**supports_account_verification** | **BOOLEAN** |  | [optional] 
+**url** | **String** |  | [optional] 
+
+

data/docs/InstitutionResponseBody.md

@@ -0,0 +1,8 @@
+# Atrium::InstitutionResponseBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**institution** | [**Institution**](Institution.md) |  | [optional] 
+
+

data/docs/InstitutionsApi.md

@@ -0,0 +1,120 @@
+# Atrium::InstitutionsApi
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list_institutions**](InstitutionsApi.md#list_institutions) | **GET** /institutions | List institutions
+[**read_institution**](InstitutionsApi.md#read_institution) | **GET** /institutions/{institution_code} | Read institution
+[**read_institution_credentials**](InstitutionsApi.md#read_institution_credentials) | **GET** /institutions/{institution_code}/credentials | Read institution credentials
+
+
+# **list_institutions**
+> InstitutionsResponseBody list_institutions(opts)
+
+List institutions
+
+This endpoint allows you to see what institutions are available for connection. Information returned will include the institution_code assigned to a particular institution, URLs for the financial institution's logo, and the URL for its website.<br> This endpoint takes an optional query string, name={string}. This will list only institutions in which the appended string appears. 
+
+### Example
+```ruby
+# load the gem
+require 'atrium-ruby'
+
+client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
+
+opts = { 
+  name: name_example, # String | This will list only institutions in which the appended string appears.
+  page: 1, # Integer | Specify current page.
+  records_per_page: 12, # Integer | Specify records per page.
+}
+
+begin
+  #List institutions
+  response = client.institutions.list_institutions(opts)
+  p response
+rescue Atrium::ApiError => e
+  puts "Exception when calling InstitutionsApi->list_institutions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| This will list only institutions in which the appended string appears. | [optional] 
+ **page** | **Integer**| Specify current page. | [optional] 
+ **records_per_page** | **Integer**| Specify records per page. | [optional] 
+
+### Return type
+
+[**InstitutionsResponseBody**](InstitutionsResponseBody.md)
+
+# **read_institution**
+> InstitutionResponseBody read_institution(institution_code)
+
+Read institution
+
+This endpoint allows you to see information for a specific institution.
+
+### Example
+```ruby
+# load the gem
+require 'atrium-ruby'
+
+client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
+
+institution_code = "example_institution_code" # String | The institution_code of the institution.
+
+begin
+  #Read institution
+  response = client.institutions.read_institution(institution_code)
+  p response
+rescue Atrium::ApiError => e
+  puts "Exception when calling InstitutionsApi->read_institution: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **institution_code** | **String**| The institution_code of the institution. | 
+
+### Return type
+
+[**InstitutionResponseBody**](InstitutionResponseBody.md)
+
+# **read_institution_credentials**
+> CredentialsResponseBody read_institution_credentials(institution_code)
+
+Read institution credentials
+
+Use this endpoint to see which credentials will be needed to create a member for a specific institution.
+
+### Example
+```ruby
+# load the gem
+require 'atrium-ruby'
+
+client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
+
+institution_code = "example_institution_code" # String | The institution_code of the institution.
+
+begin
+  #Read institution credentials
+  response = client.institutions.read_institution_credentials(institution_code)
+  p response
+rescue Atrium::ApiError => e
+  puts "Exception when calling InstitutionsApi->read_institution_credentials: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **institution_code** | **String**| The institution_code of the institution. | 
+
+### Return type
+
+[**CredentialsResponseBody**](CredentialsResponseBody.md)
+

data/docs/InstitutionsResponseBody.md

@@ -0,0 +1,9 @@
+# Atrium::InstitutionsResponseBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**institutions** | [**Array<Institution>**](Institution.md) |  | [optional] 
+**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
+
+

data/docs/Member.md

@@ -0,0 +1,18 @@
+# Atrium::Member
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**aggregated_at** | **String** |  | [optional] 
+**connection_status** | **String** |  | [optional] 
+**guid** | **BOOLEAN** |  | [optional] 
+**identifier** | **String** |  | [optional] 
+**institution_code** | **String** |  | [optional] 
+**is_being_aggregated** | **BOOLEAN** |  | [optional] 
+**metadata** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**status** | **String** |  | [optional] 
+**successfully_aggregated_at** | **String** |  | [optional] 
+**user_guid** | **String** |  | [optional] 
+
+

data/docs/MemberConnectionStatus.md

@@ -0,0 +1,16 @@
+# Atrium::MemberConnectionStatus
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**aggregated_at** | **String** |  | [optional] 
+**challenges** | [**Array<Challenge>**](Challenge.md) |  | [optional] 
+**connection_status** | **String** |  | [optional] 
+**guid** | **BOOLEAN** |  | [optional] 
+**has_processed_accounts** | **BOOLEAN** |  | [optional] 
+**has_processed_transactions** | **BOOLEAN** |  | [optional] 
+**is_being_aggregated** | **BOOLEAN** |  | [optional] 
+**status** | **String** |  | [optional] 
+**successfully_aggregated_at** | **String** |  | [optional] 
+
+