fuse_client 0.3.1 → 0.3.4

data/{fuse-ruby-openapi/docs → docs}/FuseApi.md

@@ -1,14 +1,16 @@
 # FuseClient::FuseApi
 
-All URIs are relative to *https://yz9sph5c42.execute-api.us-east-1.amazonaws.com*
+All URIs are relative to *https://sandbox-api.letsfuse.com*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
 | [**create_asset_report**](FuseApi.md#create_asset_report) | **POST** /v1/asset_report/create |  |
+| [**create_entity**](FuseApi.md#create_entity) | **POST** /v1/entities | Create entity |
 | [**create_link_token**](FuseApi.md#create_link_token) | **POST** /v1/link/token |  |
 | [**create_session**](FuseApi.md#create_session) | **POST** /v1/session |  |
 | [**exchange_public_token**](FuseApi.md#exchange_public_token) | **POST** /v1/financial_connections/public_token/exchange |  |
 | [**get_asset_report**](FuseApi.md#get_asset_report) | **POST** /v1/asset_report |  |
+| [**get_entity**](FuseApi.md#get_entity) | **GET** /v1/entities/{entity_id} | Get entity |
 | [**get_financial_connections_account_details**](FuseApi.md#get_financial_connections_account_details) | **POST** /v1/financial_connections/accounts/details | Get account details |
 | [**get_financial_connections_accounts**](FuseApi.md#get_financial_connections_accounts) | **POST** /v1/financial_connections/accounts | Get accounts |
 | [**get_financial_connections_balances**](FuseApi.md#get_financial_connections_balances) | **POST** /v1/financial_connections/balances | Get balances |
@@ -16,8 +18,10 @@ All URIs are relative to *https://yz9sph5c42.execute-api.us-east-1.amazonaws.com
 | [**get_financial_connections_transactions**](FuseApi.md#get_financial_connections_transactions) | **POST** /v1/financial_connections/transactions | Get transactions |
 | [**get_investment_holdings**](FuseApi.md#get_investment_holdings) | **POST** /v1/financial_connections/investments/holdings | Get investment holdings |
 | [**get_investment_transactions**](FuseApi.md#get_investment_transactions) | **POST** /v1/financial_connections/investments/transactions | Get investment holdings |
+| [**refresh_asset_report**](FuseApi.md#refresh_asset_report) | **POST** /v1/asset_report/refresh |  |
 | [**sync_financial_connections_data**](FuseApi.md#sync_financial_connections_data) | **POST** /v1/financial_connections/sync | Sync financial connections data |
 | [**sync_financial_connections_transactions**](FuseApi.md#sync_financial_connections_transactions) | **POST** /v1/financial_connections/transactions/sync | Sync transactions |
+| [**update_entity**](FuseApi.md#update_entity) | **PUT** /v1/entities/{entity_id_to_update} | Update entity |
 | [**v1_financial_connections_liabilities_post**](FuseApi.md#v1_financial_connections_liabilities_post) | **POST** /v1/financial_connections/liabilities | Get liabilities |
 
 
@@ -99,6 +103,80 @@ end
 - **Accept**: application/json
 
 
+## create_entity
+
+> <CreateEntityResponse> create_entity(create_entity_request)
+
+Create entity
+
+### Examples
+
+```ruby
+require 'time'
+require 'fuse_client'
+# setup authorization
+FuseClient.configure do |config|
+  # Configure API key authorization: fuseApiKey
+  config.api_key['fuseApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['fuseApiKey'] = 'Bearer'
+
+  # Configure API key authorization: fuseClientId
+  config.api_key['fuseClientId'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['fuseClientId'] = 'Bearer'
+end
+
+api_instance = FuseClient::FuseApi.new
+create_entity_request = FuseClient::CreateEntityRequest.new # CreateEntityRequest | 
+
+begin
+  # Create entity
+  result = api_instance.create_entity(create_entity_request)
+  p result
+rescue FuseClient::ApiError => e
+  puts "Error when calling FuseApi->create_entity: #{e}"
+end
+```
+
+#### Using the create_entity_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateEntityResponse>, Integer, Hash)> create_entity_with_http_info(create_entity_request)
+
+```ruby
+begin
+  # Create entity
+  data, status_code, headers = api_instance.create_entity_with_http_info(create_entity_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateEntityResponse>
+rescue FuseClient::ApiError => e
+  puts "Error when calling FuseApi->create_entity_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_entity_request** | [**CreateEntityRequest**](CreateEntityRequest.md) |  |  |
+
+### Return type
+
+[**CreateEntityResponse**](CreateEntityResponse.md)
+
+### Authorization
+
+[fuseApiKey](../README.md#fuseApiKey), [fuseClientId](../README.md#fuseClientId)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## create_link_token
 
 > <CreateLinkTokenResponse> create_link_token(opts)
@@ -411,6 +489,80 @@ end
 - **Accept**: application/json
 
 
+## get_entity
+
+> <GetEntityResponse> get_entity(entity_id)
+
+Get entity
+
+### Examples
+
+```ruby
+require 'time'
+require 'fuse_client'
+# setup authorization
+FuseClient.configure do |config|
+  # Configure API key authorization: fuseApiKey
+  config.api_key['fuseApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['fuseApiKey'] = 'Bearer'
+
+  # Configure API key authorization: fuseClientId
+  config.api_key['fuseClientId'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['fuseClientId'] = 'Bearer'
+end
+
+api_instance = FuseClient::FuseApi.new
+entity_id = 'entity_id_example' # String | 
+
+begin
+  # Get entity
+  result = api_instance.get_entity(entity_id)
+  p result
+rescue FuseClient::ApiError => e
+  puts "Error when calling FuseApi->get_entity: #{e}"
+end
+```
+
+#### Using the get_entity_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetEntityResponse>, Integer, Hash)> get_entity_with_http_info(entity_id)
+
+```ruby
+begin
+  # Get entity
+  data, status_code, headers = api_instance.get_entity_with_http_info(entity_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetEntityResponse>
+rescue FuseClient::ApiError => e
+  puts "Error when calling FuseApi->get_entity_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **entity_id** | **String** |  |  |
+
+### Return type
+
+[**GetEntityResponse**](GetEntityResponse.md)
+
+### Authorization
+
+[fuseApiKey](../README.md#fuseApiKey), [fuseClientId](../README.md#fuseClientId)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_financial_connections_account_details
 
 > <GetFinancialConnectionsAccountDetailsResponse> get_financial_connections_account_details(get_financial_connections_account_details_request)
@@ -929,6 +1081,84 @@ end
 - **Accept**: application/json
 
 
+## refresh_asset_report
+
+> <CreateAssetReportResponse> refresh_asset_report(opts)
+
+
+
+Refreshes the Asset Report in JSON format.
+
+### Examples
+
+```ruby
+require 'time'
+require 'fuse_client'
+# setup authorization
+FuseClient.configure do |config|
+  # Configure API key authorization: fuseApiKey
+  config.api_key['fuseApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['fuseApiKey'] = 'Bearer'
+
+  # Configure API key authorization: fuseClientId
+  config.api_key['fuseClientId'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['fuseClientId'] = 'Bearer'
+end
+
+api_instance = FuseClient::FuseApi.new
+opts = {
+  refresh_asset_report_request: FuseClient::RefreshAssetReportRequest.new({days_requested: 3.56}) # RefreshAssetReportRequest | 
+}
+
+begin
+  
+  result = api_instance.refresh_asset_report(opts)
+  p result
+rescue FuseClient::ApiError => e
+  puts "Error when calling FuseApi->refresh_asset_report: #{e}"
+end
+```
+
+#### Using the refresh_asset_report_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateAssetReportResponse>, Integer, Hash)> refresh_asset_report_with_http_info(opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.refresh_asset_report_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateAssetReportResponse>
+rescue FuseClient::ApiError => e
+  puts "Error when calling FuseApi->refresh_asset_report_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **refresh_asset_report_request** | [**RefreshAssetReportRequest**](RefreshAssetReportRequest.md) |  | [optional] |
+
+### Return type
+
+[**CreateAssetReportResponse**](CreateAssetReportResponse.md)
+
+### Authorization
+
+[fuseApiKey](../README.md#fuseApiKey), [fuseClientId](../README.md#fuseClientId)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## sync_financial_connections_data
 
 > <SyncFinancialConnectionsDataResponse> sync_financial_connections_data(body)
@@ -1079,6 +1309,82 @@ end
 - **Accept**: application/json
 
 
+## update_entity
+
+> <UpdateEntityResponse> update_entity(entity_id_to_update, update_entity_request)
+
+Update entity
+
+### Examples
+
+```ruby
+require 'time'
+require 'fuse_client'
+# setup authorization
+FuseClient.configure do |config|
+  # Configure API key authorization: fuseApiKey
+  config.api_key['fuseApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['fuseApiKey'] = 'Bearer'
+
+  # Configure API key authorization: fuseClientId
+  config.api_key['fuseClientId'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['fuseClientId'] = 'Bearer'
+end
+
+api_instance = FuseClient::FuseApi.new
+entity_id_to_update = 'entity_id_to_update_example' # String | 
+update_entity_request = FuseClient::UpdateEntityRequest.new # UpdateEntityRequest | 
+
+begin
+  # Update entity
+  result = api_instance.update_entity(entity_id_to_update, update_entity_request)
+  p result
+rescue FuseClient::ApiError => e
+  puts "Error when calling FuseApi->update_entity: #{e}"
+end
+```
+
+#### Using the update_entity_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UpdateEntityResponse>, Integer, Hash)> update_entity_with_http_info(entity_id_to_update, update_entity_request)
+
+```ruby
+begin
+  # Update entity
+  data, status_code, headers = api_instance.update_entity_with_http_info(entity_id_to_update, update_entity_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UpdateEntityResponse>
+rescue FuseClient::ApiError => e
+  puts "Error when calling FuseApi->update_entity_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **entity_id_to_update** | **String** |  |  |
+| **update_entity_request** | [**UpdateEntityRequest**](UpdateEntityRequest.md) |  |  |
+
+### Return type
+
+[**UpdateEntityResponse**](UpdateEntityResponse.md)
+
+### Authorization
+
+[fuseApiKey](../README.md#fuseApiKey), [fuseClientId](../README.md#fuseClientId)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## v1_financial_connections_liabilities_post
 
 > <GetLiabilitiesResponse> v1_financial_connections_liabilities_post(get_liabilities_request)

data/docs/GetEntityResponse.md

@@ -0,0 +1,24 @@
+# FuseClient::GetEntityResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Id of the entity | [optional] |
+| **email** | **String** | Email of the entity | [optional] |
+| **aggregators** | [**Array<Aggregator>**](Aggregator.md) | These will force the user to connect through all of these aggregators | [optional] |
+| **institution_ids** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::GetEntityResponse.new(
+  id: null,
+  email: null,
+  aggregators: null,
+  institution_ids: null
+)
+```
+

data/{fuse-ruby-openapi/docs → docs}/GetInvestmentHoldingsRequest.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **access_token** | **String** | Access token for authentication |  |
+| **iso_currency_code** | **String** | The ISO-4217 currency code to convert the holding to. | [optional] |
 
 ## Example
 
@@ -12,7 +13,8 @@
 require 'fuse_client'
 
 instance = FuseClient::GetInvestmentHoldingsRequest.new(
-  access_token: null
+  access_token: null,
+  iso_currency_code: null
 )
 ```
 

data/{fuse-ruby-openapi/docs → docs}/GetInvestmentHoldingsResponse.md

@@ -7,7 +7,6 @@
 | **accounts** | [**Array<FinancialConnectionsInvestmentAccount>**](FinancialConnectionsInvestmentAccount.md) |  | [optional] |
 | **holdings** | [**Array<FinancialConnectionsHolding>**](FinancialConnectionsHolding.md) |  | [optional] |
 | **securities** | [**Array<FinancialConnectionsInvestmentSecurity>**](FinancialConnectionsInvestmentSecurity.md) |  | [optional] |
-| **remote_data** | **Object** | The exact data from the aggregator (ie plaid) that we retrieved the information from. | [optional] |
 
 ## Example
 
@@ -17,8 +16,7 @@ require 'fuse_client'
 instance = FuseClient::GetInvestmentHoldingsResponse.new(
   accounts: null,
   holdings: null,
-  securities: null,
-  remote_data: null
+  securities: null
 )
 ```
 

data/{fuse-ruby-openapi/docs → docs}/GetInvestmentTransactionsResponse.md

@@ -7,7 +7,6 @@
 | **accounts** | [**Array<FinancialConnectionsInvestmentAccount>**](FinancialConnectionsInvestmentAccount.md) |  | [optional] |
 | **investment_transactions** | [**Array<FinancialConnectionsInvestmentTransaction>**](FinancialConnectionsInvestmentTransaction.md) |  | [optional] |
 | **securities** | [**Array<FinancialConnectionsInvestmentSecurity>**](FinancialConnectionsInvestmentSecurity.md) |  | [optional] |
-| **remote_data** | **Object** | The exact data from the aggregator (ie plaid) that we retrieved the information from. | [optional] |
 
 ## Example
 
@@ -17,8 +16,7 @@ require 'fuse_client'
 instance = FuseClient::GetInvestmentTransactionsResponse.new(
   accounts: null,
   investment_transactions: null,
-  securities: null,
-  remote_data: null
+  securities: null
 )
 ```
 

data/{fuse-ruby-openapi/docs → docs}/GetLiabilitiesResponse.md

@@ -5,7 +5,6 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **liabilities** | [**Array<FinancialConnectionsAccountLiability>**](FinancialConnectionsAccountLiability.md) |  | [optional] |
-| **remote_data** | **Object** | The exact data from the aggregator (ie plaid) that we retrieved the information from. | [optional] |
 
 ## Example
 
@@ -13,8 +12,7 @@
 require 'fuse_client'
 
 instance = FuseClient::GetLiabilitiesResponse.new(
-  liabilities: null,
-  remote_data: null
+  liabilities: null
 )
 ```
 

data/{fuse-ruby-openapi/docs → docs}/GetTransactionsResponseDataInner.md

@@ -14,7 +14,6 @@
 | **merchant** | [**GetTransactionsResponseDataInnerMerchant**](GetTransactionsResponseDataInnerMerchant.md) |  | [optional] |
 | **status** | **String** | The status of the transaction. This will be either POSTED or PENDING. | [optional] |
 | **type** | **String** | Type of the transaction, ie adjustment | [optional] |
-| **remote_data** | **Object** | The exact data from the aggregator (ie plaid) that we retrieved the information from | [optional] |
 
 ## Example
 
@@ -31,8 +30,7 @@ instance = FuseClient::GetTransactionsResponseDataInner.new(
   category: null,
   merchant: null,
   status: null,
-  type: null,
-  remote_data: null
+  type: null
 )
 ```
 

data/docs/Product.md

@@ -0,0 +1,15 @@
+# FuseClient::Product
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::Product.new()
+```
+

data/docs/RefreshAssetReportRequest.md

@@ -0,0 +1,22 @@
+# FuseClient::RefreshAssetReportRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_token** | **String** | The asset_report_token returned by the original call to /asset_report/create | [optional] |
+| **days_requested** | **Float** | The maximum integer number of days of history to include in the Asset Report |  |
+| **include_identity** | **Boolean** | Indicates whether to include identity data in the Asset Report | [optional][default to true] |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::RefreshAssetReportRequest.new(
+  access_token: null,
+  days_requested: null,
+  include_identity: null
+)
+```
+

data/docs/UpdateEntityRequest.md

@@ -0,0 +1,22 @@
+# FuseClient::UpdateEntityRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | Email of the entity | [optional] |
+| **aggregators** | [**Array<Aggregator>**](Aggregator.md) | These will force the user to connect through all of these aggregators | [optional] |
+| **institution_ids** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::UpdateEntityRequest.new(
+  email: null,
+  aggregators: null,
+  institution_ids: null
+)
+```
+

data/docs/UpdateEntityResponse.md

@@ -0,0 +1,24 @@
+# FuseClient::UpdateEntityResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Id of the entity | [optional] |
+| **email** | **String** | Email of the entity | [optional] |
+| **aggregators** | [**Array<Aggregator>**](Aggregator.md) | These will force the user to connect through all of these aggregators | [optional] |
+| **institution_ids** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::UpdateEntityResponse.new(
+  id: null,
+  email: null,
+  aggregators: null,
+  institution_ids: null
+)
+```
+