atrium-ruby 1.3.2 → 2.0.0

data/docs/MembersResponseBody.md

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

data/docs/Pagination.md

@@ -0,0 +1,11 @@
+# Atrium::Pagination
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** |  | [optional] 
+**per_page** | **Integer** |  | [optional] 
+**total_entries** | **Integer** |  | [optional] 
+**total_pages** | **Integer** |  | [optional] 
+
+

data/docs/Transaction.md

@@ -0,0 +1,38 @@
+# Atrium::Transaction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_guid** | **String** |  | [optional] 
+**amount** | **Float** |  | [optional] 
+**category** | **String** |  | [optional] 
+**check_number** | **Integer** |  | [optional] 
+**check_number_string** | **String** |  | [optional] 
+**created_at** | **String** |  | [optional] 
+**currency_code** | **String** |  | [optional] 
+**date** | **String** |  | [optional] 
+**description** | **String** |  | [optional] 
+**guid** | **String** |  | [optional] 
+**is_bill_pay** | **BOOLEAN** |  | [optional] 
+**is_direct_deposit** | **BOOLEAN** |  | [optional] 
+**is_expense** | **BOOLEAN** |  | [optional] 
+**is_fee** | **BOOLEAN** |  | [optional] 
+**is_income** | **BOOLEAN** |  | [optional] 
+**is_international** | **BOOLEAN** |  | [optional] 
+**is_overdraft_fee** | **BOOLEAN** |  | [optional] 
+**is_payroll_advance** | **BOOLEAN** |  | [optional] 
+**latitude** | **Float** |  | [optional] 
+**longitude** | **Float** |  | [optional] 
+**member_guid** | **String** |  | [optional] 
+**memo** | **String** |  | [optional] 
+**merchant_category_code** | **Integer** |  | [optional] 
+**original_description** | **String** |  | [optional] 
+**posted_at** | **String** |  | [optional] 
+**status** | **String** |  | [optional] 
+**top_level_category** | **String** |  | [optional] 
+**transacted_at** | **String** |  | [optional] 
+**type** | **String** |  | [optional] 
+**updated_at** | **String** |  | [optional] 
+**user_guid** | **String** |  | [optional] 
+
+

data/docs/TransactionCleanseAndCategorizeRequest.md

@@ -0,0 +1,11 @@
+# Atrium::TransactionCleanseAndCategorizeRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Float** |  | [optional] 
+**description** | **String** |  | [optional] 
+**identifier** | **String** |  | [optional] 
+**type** | **String** |  | [optional] 
+
+

data/docs/TransactionCleanseAndCategorizeResponse.md

@@ -0,0 +1,20 @@
+# Atrium::TransactionCleanseAndCategorizeResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Float** |  | [optional] 
+**category** | **String** |  | [optional] 
+**description** | **String** |  | [optional] 
+**identifier** | **String** |  | [optional] 
+**type** | **String** |  | [optional] 
+**is_bill_pay** | **BOOLEAN** |  | [optional] 
+**is_direct_deposit** | **BOOLEAN** |  | [optional] 
+**is_expense** | **BOOLEAN** |  | [optional] 
+**is_fee** | **BOOLEAN** |  | [optional] 
+**is_income** | **BOOLEAN** |  | [optional] 
+**is_international** | **BOOLEAN** |  | [optional] 
+**is_overdraft_fee** | **BOOLEAN** |  | [optional] 
+**is_payroll_advance** | **BOOLEAN** |  | [optional] 
+
+

data/docs/TransactionResponseBody.md

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

data/docs/TransactionsApi.md

@@ -0,0 +1,126 @@
+# Atrium::TransactionsApi
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**cleanse_and_categorize_transactions**](TransactionsApi.md#cleanse_and_categorize_transactions) | **POST** /cleanse_and_categorize | Categorize transactions
+[**list_user_transactions**](TransactionsApi.md#list_user_transactions) | **GET** /users/{user_guid}/transactions | List transactions for a user
+[**read_transaction**](TransactionsApi.md#read_transaction) | **GET** /users/{user_guid}/transactions/{transaction_guid} | Read a transaction
+
+
+# **cleanse_and_categorize_transactions**
+> TransactionsCleanseAndCategorizeResponseBody cleanse_and_categorize_transactions(body)
+
+Categorize transactions
+
+Use this endpoint to categorize, cleanse, and classify transactions. These transactions are not persisted or stored on the MX platform.
+
+### Example
+```ruby
+# load the gem
+require 'atrium-ruby'
+
+client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
+
+body = Atrium::TransactionsCleanseAndCategorizeRequestBody.new # TransactionsCleanseAndCategorizeRequestBody | User object to be created with optional parameters (amount, type) amd required parameters (description, identifier)
+
+begin
+  #Categorize transactions
+  response = client.transactions.cleanse_and_categorize_transactions(body)
+  p response
+rescue Atrium::ApiError => e
+  puts "Exception when calling TransactionsApi->cleanse_and_categorize_transactions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**TransactionsCleanseAndCategorizeRequestBody**](TransactionsCleanseAndCategorizeRequestBody.md)| User object to be created with optional parameters (amount, type) amd required parameters (description, identifier) | 
+
+### Return type
+
+[**TransactionsCleanseAndCategorizeResponseBody**](TransactionsCleanseAndCategorizeResponseBody.md)
+
+# **list_user_transactions**
+> TransactionsResponseBody list_user_transactions(user_guid, opts)
+
+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.<br> 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. 
+
+### 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`.
+opts = { 
+  page: 1, # Integer | Specify current page.
+  from_date: "2016-09-20", # String | Filter transactions from this date.
+  records_per_page: 12, # Integer | Specify records per page.
+  to_date: "2016-10-20" # String | Filter transactions to this date.
+}
+
+begin
+  #List transactions for a user
+  response = client.transactions.list_user_transactions(user_guid, opts)
+  p response
+rescue Atrium::ApiError => e
+  puts "Exception when calling TransactionsApi->list_user_transactions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_guid** | **String**| The unique identifier for a &#x60;user&#x60;. | 
+ **page** | **Integer**| Specify current page. | [optional] 
+ **from_date** | **String**| Filter transactions from this date. | [optional] 
+ **records_per_page** | **Integer**| Specify records per page. | [optional] 
+ **to_date** | **String**| Filter transactions to this date. | [optional] 
+
+### Return type
+
+[**TransactionsResponseBody**](TransactionsResponseBody.md)
+
+# **read_transaction**
+> TransactionResponseBody read_transaction(transaction_guid, user_guid)
+
+Read a transaction
+
+This endpoint allows you to view information about a specific transaction that belongs to a user.<br>
+
+### Example
+```ruby
+# load the gem
+require 'atrium-ruby'
+
+client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
+
+transaction_guid = "TRN-123" # String | The unique identifier for a `transaction`.
+user_guid = "USR-123" # String | The unique identifier for a `user`.
+
+begin
+  #Read a transaction
+  response = client.transactions.read_transaction(transaction_guid, user_guid)
+  p response
+rescue Atrium::ApiError => e
+  puts "Exception when calling TransactionsApi->read_transaction: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **transaction_guid** | **String**| The unique identifier for a &#x60;transaction&#x60;. | 
+ **user_guid** | **String**| The unique identifier for a &#x60;user&#x60;. | 
+
+### Return type
+
+[**TransactionResponseBody**](TransactionResponseBody.md)
+

data/docs/TransactionsCleanseAndCategorizeRequestBody.md

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

data/docs/TransactionsCleanseAndCategorizeResponseBody.md

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

data/docs/TransactionsResponseBody.md

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

data/docs/User.md

@@ -0,0 +1,11 @@
+# Atrium::User
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**guid** | **String** |  | [optional] 
+**identifier** | **String** |  | [optional] 
+**is_disabled** | **BOOLEAN** |  | [optional] 
+**metadata** | **String** |  | [optional] 
+
+

data/docs/UserCreateRequestBody.md

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

data/docs/UserResponseBody.md

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

data/docs/UserUpdateRequestBody.md

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

data/docs/UsersApi.md

@@ -0,0 +1,193 @@
+# Atrium::UsersApi
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_user**](UsersApi.md#create_user) | **POST** /users | Create user
+[**delete_user**](UsersApi.md#delete_user) | **DELETE** /users/{user_guid} | Delete user
+[**list_users**](UsersApi.md#list_users) | **GET** /users | List users
+[**read_user**](UsersApi.md#read_user) | **GET** /users/{user_guid} | Read user
+[**update_user**](UsersApi.md#update_user) | **PUT** /users/{user_guid} | Update user
+
+
+# **create_user**
+> UserResponseBody create_user(body)
+
+Create user
+
+Call this endpoint to create a new user. Atrium will respond with the newly-created user object if successful. This endpoint accepts several parameters: identifier, metadata, and is_disabled.<br> Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that user's data until they are no longer disabled. Users who are disabled for the entirety of an Atrium billing period will not be factored into that month's bill. 
+
+### Example
+```ruby
+# load the gem
+require 'atrium-ruby'
+
+client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
+
+body = Atrium::UserCreateRequestBody.new # UserCreateRequestBody | User object to be created with optional parameters (identifier, is_disabled, metadata)
+
+begin
+  #Create user
+  response = client.users.create_user(body)
+  p response
+rescue Atrium::ApiError => e
+  puts "Exception when calling UsersApi->create_user: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**UserCreateRequestBody**](UserCreateRequestBody.md)| User object to be created with optional parameters (identifier, is_disabled, metadata) | 
+
+### Return type
+
+[**UserResponseBody**](UserResponseBody.md)
+
+# **delete_user**
+> delete_user(user_guid)
+
+Delete user
+
+Calling this endpoint will permanently delete a user from Atrium. If successful, the API will respond with Status: 204 No Content. 
+
+### 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`.
+
+begin
+  #Delete user
+  client.users.delete_user(user_guid)
+rescue Atrium::ApiError => e
+  puts "Exception when calling UsersApi->delete_user: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_guid** | **String**| The unique identifier for a &#x60;user&#x60;. | 
+
+### Return type
+
+nil (empty response body)
+
+# **list_users**
+> UsersResponseBody list_users(opts)
+
+List users
+
+Use this endpoint to list every user you've created in Atrium.
+
+### Example
+```ruby
+# load the gem
+require 'atrium-ruby'
+
+client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
+
+opts = { 
+  page: 1, # Integer | Specify current page.
+  records_per_page: 12, # Integer | Specify records per page.
+}
+
+begin
+  #List users
+  response = client.users.list_users(opts)
+  p response
+rescue Atrium::ApiError => e
+  puts "Exception when calling UsersApi->list_users: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **Integer**| Specify current page. | [optional] 
+ **records_per_page** | **Integer**| Specify records per page. | [optional] 
+
+### Return type
+
+[**UsersResponseBody**](UsersResponseBody.md)
+
+# **read_user**
+> UserResponseBody read_user(user_guid)
+
+Read user
+
+Use this endpoint to read the attributes of a specific user.
+
+### 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`.
+
+begin
+  #Read user
+  response = client.users.read_user(user_guid)
+  p response
+rescue Atrium::ApiError => e
+  puts "Exception when calling UsersApi->read_user: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_guid** | **String**| The unique identifier for a &#x60;user&#x60;. | 
+
+### Return type
+
+[**UserResponseBody**](UserResponseBody.md)
+
+# **update_user**
+> UserResponseBody update_user(user_guid, opts)
+
+Update user
+
+Use this endpoint to update the attributes of a specific user. Atrium will respond with the updated user object.<br> Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that user's data until they are no longer disabled. Users who are disabled for the entirety of an Atrium billing period will not be factored into that month's bill.<br> To disable a user, update it and set the is_disabled parameter to true. Set it to false to re-enable the user. 
+
+### 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`.
+opts = { 
+  body: Atrium::UserUpdateRequestBody.new # UserUpdateRequestBody | User object to be updated with optional parameters (identifier, is_disabled, metadata)
+}
+
+begin
+  #Update user
+  response = client.users.update_user(user_guid, opts)
+  p response
+rescue Atrium::ApiError => e
+  puts "Exception when calling UsersApi->update_user: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_guid** | **String**| The unique identifier for a &#x60;user&#x60;. | 
+ **body** | [**UserUpdateRequestBody**](UserUpdateRequestBody.md)| User object to be updated with optional parameters (identifier, is_disabled, metadata) | [optional] 
+
+### Return type
+
+[**UserResponseBody**](UserResponseBody.md)
+