proton_api 1.8.0

data/docs/PortfolioConstructionApi.md

@@ -0,0 +1,64 @@
+# ProtonApi::PortfolioConstructionApi
+
+All URIs are relative to *https://sandbox.hydrogenplatform.com/proton/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**mvo**](PortfolioConstructionApi.md#mvo) | **POST** /mvo | MVO
+
+
+# **mvo**
+> Hash<String, Object> mvo(mvo_request)
+
+MVO
+
+Run a mean-variance optimization for a group of potential investments
+
+### Example
+```ruby
+# load the gem
+require 'proton_api'
+# setup authorization
+ProtonApi.configure do |config|
+  # Creating a token for grant_type=client_credentials
+   config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
+  # Creating a token for grant_type=password
+   config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
+  # Creating a token using client token
+   config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
+end
+api_instance = ProtonApi::PortfolioConstructionApi.new
+
+mvo_request = ProtonApi::MvoRequest.new # MvoRequest | Request payload for MVO
+
+
+begin
+  #MVO
+  result = api_instance.mvo(mvo_request)
+  p result
+rescue ProtonApi::ApiError => e
+  puts "Exception when calling PortfolioConstructionApi->mvo: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **mvo_request** | [**MvoRequest**](MvoRequest.md)| Request payload for MVO | 
+
+### Return type
+
+**Hash<String, Object>**
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/PortfolioManagementApi.md

@@ -0,0 +1,64 @@
+# ProtonApi::PortfolioManagementApi
+
+All URIs are relative to *https://sandbox.hydrogenplatform.com/proton/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**rebalancing_signal**](PortfolioManagementApi.md#rebalancing_signal) | **POST** /rebalancing_signal | Rebalancing Signal
+
+
+# **rebalancing_signal**
+> Hash<String, Object> rebalancing_signal(rebalancing_signal_request)
+
+Rebalancing Signal
+
+Generate rebalancing signals for a group of investments
+
+### Example
+```ruby
+# load the gem
+require 'proton_api'
+# setup authorization
+ProtonApi.configure do |config|
+  # Creating a token for grant_type=client_credentials
+   config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
+  # Creating a token for grant_type=password
+   config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
+  # Creating a token using client token
+   config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
+end
+api_instance = ProtonApi::PortfolioManagementApi.new
+
+rebalancing_signal_request = ProtonApi::RebalancingSignalRequest.new # RebalancingSignalRequest | Request payload for Rebalancing Signal
+
+
+begin
+  #Rebalancing Signal
+  result = api_instance.rebalancing_signal(rebalancing_signal_request)
+  p result
+rescue ProtonApi::ApiError => e
+  puts "Exception when calling PortfolioManagementApi->rebalancing_signal: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **rebalancing_signal_request** | [**RebalancingSignalRequest**](RebalancingSignalRequest.md)| Request payload for Rebalancing Signal | 
+
+### Return type
+
+**Hash<String, Object>**
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/PortfolioOptimizationScoreRequest.md

@@ -0,0 +1,21 @@
+# ProtonApi::PortfolioOptimizationScoreRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**portfolio_tickers** | **Array<String>** |  | [optional] 
+**end_date** | **Date** |  | [optional] 
+**portfolio_id** | **String** |  | [optional] 
+**market_data_source** | **String** |  | [optional] [default to 'nucleus']
+**model_id** | **String** |  | [optional] 
+**create_log** | **BOOLEAN** |  | [optional] [default to false]
+**opt_config** | [**OptConfig1**](OptConfig1.md) |  | [optional] 
+**allocation_id** | **String** |  | [optional] 
+**tgt_type** | **String** |  | [optional] [default to 'return']
+**use_proxy_data** | **BOOLEAN** |  | [optional] [default to false]
+**start_date** | **Date** |  | [optional] 
+**account_id** | **String** |  | [optional] 
+**aggregation_account_id** | **String** |  | [optional] 
+**portfolio_weights** | **Array<Float>** |  | [optional] 
+
+

data/docs/PortfolioWhatIfRequest.md

@@ -0,0 +1,21 @@
+# ProtonApi::PortfolioWhatIfRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_portfolio_weights** | **Array<Float>** |  | [optional] 
+**portfolio_id** | **String** |  | [optional] 
+**end_date** | **String** |  | [optional] 
+**market_data_source** | **String** |  | [optional] [default to 'nucleus']
+**model_id** | **String** |  | [optional] 
+**create_log** | **BOOLEAN** |  | [optional] [default to false]
+**allocation_id** | **String** |  | [optional] 
+**use_proxy_data** | **BOOLEAN** |  | [optional] [default to false]
+**start_date** | **String** |  | [optional] 
+**account_id** | **String** |  | [optional] 
+**aggregation_account_id** | **String** |  | [optional] 
+**current_portfolio_tickers** | **Array<String>** |  | [optional] 
+**altered_portfolio_weights** | **Array<Float>** |  | 
+**altered_portfolio_tickers** | **Array<String>** |  | [optional] 
+
+

data/docs/PurchaseCalculatorAmountRequest.md

@@ -0,0 +1,16 @@
+# ProtonApi::PurchaseCalculatorAmountRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**aggregation_account_ids** | **Array<String>** |  | [optional] 
+**current_savings** | **Float** |  | [optional] [default to 0.0]
+**account_ids** | **Array<String>** |  | [optional] 
+**investment_tax** | **Float** |  | [optional] [default to 0.0]
+**purchase_horizon** | **Integer** |  | 
+**inflation_rate** | **Float** |  | [optional] [default to 0.0]
+**horizon_frequency_interval** | **String** |  | [optional] [default to 'year']
+**portfolio_return** | **Float** |  | 
+**deposit_schedule** | [**CalculatorDepositSchedule1**](CalculatorDepositSchedule1.md) |  | [optional] 
+
+

data/docs/PurchaseCalculatorDepositAmountRequest.md

@@ -0,0 +1,17 @@
+# ProtonApi::PurchaseCalculatorDepositAmountRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**purchase_amount** | **Float** |  | 
+**aggregation_account_ids** | **Array<String>** |  | [optional] 
+**current_savings** | **Float** |  | [optional] [default to 0.0]
+**account_ids** | **Array<String>** |  | [optional] 
+**investment_tax** | **Float** |  | [optional] [default to 0.0]
+**purchase_horizon** | **Integer** |  | 
+**inflation_rate** | **Float** |  | [optional] [default to 0.0]
+**horizon_frequency_interval** | **String** |  | [optional] [default to 'year']
+**portfolio_return** | **Float** |  | 
+**deposit_schedule** | [**CalculatorDepositSchedule**](CalculatorDepositSchedule.md) |  | [optional] 
+
+

data/docs/PurchaseCalculatorHorizonRequest.md

@@ -0,0 +1,15 @@
+# ProtonApi::PurchaseCalculatorHorizonRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**purchase_amount** | **Float** |  | 
+**aggregation_account_ids** | **Array<String>** |  | [optional] 
+**current_savings** | **Float** |  | [optional] [default to 0.0]
+**account_ids** | **Array<String>** |  | [optional] 
+**investment_tax** | **Float** |  | [optional] [default to 0.0]
+**inflation_rate** | **Float** |  | [optional] [default to 0.0]
+**portfolio_return** | **Float** |  | 
+**deposit_schedule** | [**CalculatorDepositSchedule1**](CalculatorDepositSchedule1.md) |  | [optional] 
+
+

data/docs/RatioTargets.md

@@ -0,0 +1,13 @@
+# ProtonApi::RatioTargets
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_ratio** | **Float** |  | [optional] [default to 0.5]
+**liquidity_ratio_expenses** | **Float** |  | [optional] [default to 2.5]
+**liquidity_ratio_liabilities** | **Float** |  | [optional] [default to 0.1]
+**savings_ratio_gross** | **Float** |  | [optional] [default to 0.1]
+**savings_ratio_net** | **Float** |  | [optional] [default to 0.1]
+**asset_allocation_ratio** | **Float** |  | [optional] [default to 1.5]
+
+

data/docs/RatioTargets1.md

@@ -0,0 +1,13 @@
+# ProtonApi::RatioTargets1
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**profit_margin** | **Float** |  | [optional] [default to 0.1]
+**return_on_assets** | **Float** |  | [optional] [default to 0.05]
+**debt_to_equity** | **Float** |  | [optional] [default to 1.5]
+**return_on_equity** | **Float** |  | [optional] [default to 0.15]
+**debt_ratio** | **Float** |  | [optional] [default to 0.5]
+**asset_turnover** | **Float** |  | [optional] [default to 1.0]
+
+

data/docs/RebalancingSignalRequest.md

@@ -0,0 +1,13 @@
+# ProtonApi::RebalancingSignalRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**end_date** | **Date** |  | 
+**model_id** | **String** |  | [optional] 
+**initial_weights** | **Object** |  | [optional] 
+**update_model** | **BOOLEAN** |  | [optional] [default to false]
+**start_date** | **Date** |  | 
+**settings** | [**Settings**](Settings.md) |  | [optional] 
+
+

data/docs/RecommendationConfig.md

@@ -0,0 +1,15 @@
+# ProtonApi::RecommendationConfig
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**recommended_inflation** | **Float** |  | [optional] [default to 0.0]
+**recommend** | **BOOLEAN** |  | [optional] [default to true]
+**inv_max** | **Float** |  | [optional] 
+**horizon_min** | **Integer** |  | [optional] [default to 1]
+**horizon_max** | **Integer** |  | [optional] [default to 64]
+**dep_max** | **Float** |  | [optional] 
+**inv_min** | **Float** |  | [optional] 
+**dep_min** | **Float** |  | [optional] 
+
+

data/docs/RecommendationConfig1.md

@@ -0,0 +1,14 @@
+# ProtonApi::RecommendationConfig1
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**recommended_inflation** | **Float** |  | [optional] [default to 0.0]
+**inv_max** | **Float** |  | [optional] 
+**horizon_min** | **Integer** |  | [optional] [default to 1]
+**horizon_max** | **Integer** |  | [optional] [default to 64]
+**dep_max** | **Float** |  | [optional] 
+**inv_min** | **Float** |  | [optional] 
+**dep_min** | **Float** |  | [optional] 
+
+

data/docs/RecurringTransactionAnalysisRequest.md

@@ -0,0 +1,19 @@
+# ProtonApi::RecurringTransactionAnalysisRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**aggregation_account_ids** | **Array<String>** |  | [optional] 
+**end_date** | **Date** |  | [optional] 
+**client_id** | **String** |  | [optional] 
+**account_ids** | **Array<String>** |  | [optional] 
+**interval_deviation_threshold** | **Integer** |  | [optional] [default to 3]
+**analyze_transactions** | **BOOLEAN** |  | [optional] [default to true]
+**currency_conversion** | **String** |  | [optional] 
+**start_date** | **Date** |  | [optional] 
+**currency_code** | **String** |  | [optional] 
+**show_recurring_details** | **BOOLEAN** |  | [optional] [default to false]
+**scope** | **String** |  | [optional] [default to 'all']
+**amount_deviation_threshold** | **Float** |  | [optional] [default to 0.05]
+
+

data/docs/RetirementCalculatorDepositAmountRequest.md

@@ -0,0 +1,20 @@
+# ProtonApi::RetirementCalculatorDepositAmountRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**retirement_savings** | **Float** |  | [optional] [default to 0.0]
+**aggregation_account_ids** | **Array<String>** |  | [optional] 
+**retirement_age** | **Integer** |  | [optional] [default to 65]
+**retirement_income** | **Float** |  | [optional] [default to 0.0]
+**retirement_expenses** | **Float** |  | 
+**current_age** | **Integer** |  | 
+**account_ids** | **Array<String>** |  | [optional] 
+**retirement_tax** | **Float** |  | [optional] [default to 0.0]
+**inflation_rate** | **Float** |  | [optional] [default to 0.0]
+**death_age** | **Integer** |  | 
+**portfolio_return** | **Float** |  | 
+**deposit_schedule** | [**CalculatorDepositSchedule**](CalculatorDepositSchedule.md) |  | [optional] 
+**percent_of_expenses_covered** | **Float** |  | [optional] [default to 1.0]
+
+

data/docs/RetirementCalculatorExpensesRequest.md

@@ -0,0 +1,19 @@
+# ProtonApi::RetirementCalculatorExpensesRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**retirement_savings** | **Float** |  | [optional] [default to 0.0]
+**aggregation_account_ids** | **Array<String>** |  | [optional] 
+**retirement_age** | **Integer** |  | [optional] [default to 65]
+**retirement_income** | **Float** |  | [optional] [default to 0.0]
+**current_age** | **Integer** |  | 
+**account_ids** | **Array<String>** |  | [optional] 
+**retirement_tax** | **Float** |  | [optional] [default to 0.0]
+**inflation_rate** | **Float** |  | [optional] [default to 0.0]
+**death_age** | **Integer** |  | 
+**portfolio_return** | **Float** |  | 
+**deposit_schedule** | [**CalculatorDepositSchedule1**](CalculatorDepositSchedule1.md) |  | [optional] 
+**percent_of_expenses_covered** | **Float** |  | [optional] [default to 1.0]
+
+

data/docs/RetirementCalculatorPercentCoveredRequest.md

@@ -0,0 +1,19 @@
+# ProtonApi::RetirementCalculatorPercentCoveredRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**retirement_savings** | **Float** |  | [optional] [default to 0.0]
+**aggregation_account_ids** | **Array<String>** |  | [optional] 
+**retirement_age** | **Integer** |  | [optional] [default to 65]
+**retirement_income** | **Float** |  | [optional] [default to 0.0]
+**retirement_expenses** | **Float** |  | 
+**current_age** | **Integer** |  | 
+**account_ids** | **Array<String>** |  | [optional] 
+**retirement_tax** | **Float** |  | [optional] [default to 0.0]
+**inflation_rate** | **Float** |  | [optional] [default to 0.0]
+**death_age** | **Integer** |  | 
+**portfolio_return** | **Float** |  | 
+**deposit_schedule** | [**CalculatorDepositSchedule1**](CalculatorDepositSchedule1.md) |  | [optional] 
+
+

data/docs/RiskAllocationRequest.md

@@ -0,0 +1,14 @@
+# ProtonApi::RiskAllocationRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**market_data_source** | **String** |  | [optional] [default to 'nucleus']
+**allocations** | **Array<String>** |  | [optional] 
+**client_id** | **String** |  | [optional] 
+**opt_config** | [**OptConfig**](OptConfig.md) |  | [optional] 
+**risk_score** | **Float** |  | [optional] 
+**use_proxy_data** | **BOOLEAN** |  | [optional] [default to false]
+**allocation_method** | **String** |  | 
+
+

data/docs/RiskScoreRequest.md

@@ -0,0 +1,13 @@
+# ProtonApi::RiskScoreRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**post_score** | **BOOLEAN** |  | [optional] [default to false]
+**weights** | **Array<Float>** |  | [optional] 
+**max_answers** | **Array<Float>** |  | 
+**client_id** | **String** |  | [optional] 
+**answers** | **Array<Float>** |  | [optional] 
+**questionnaire_id** | **String** |  | [optional] 
+
+

data/docs/RiskScoringApi.md

@@ -0,0 +1,176 @@
+# ProtonApi::RiskScoringApi
+
+All URIs are relative to *https://sandbox.hydrogenplatform.com/proton/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**dimensional_risk_score**](RiskScoringApi.md#dimensional_risk_score) | **POST** /dimensional_risk_score | Dimensional Risk Score
+[**risk_allocation**](RiskScoringApi.md#risk_allocation) | **POST** /risk_allocation | Risk Allocation
+[**risk_score**](RiskScoringApi.md#risk_score) | **POST** /risk_score | Risk Score
+
+
+# **dimensional_risk_score**
+> Hash<String, Object> dimensional_risk_score(dimensional_risk_score_request)
+
+Dimensional Risk Score
+
+Calculate a dimensional risk score based on questionnaire responses
+
+### Example
+```ruby
+# load the gem
+require 'proton_api'
+# setup authorization
+ProtonApi.configure do |config|
+  # Creating a token for grant_type=client_credentials
+   config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
+  # Creating a token for grant_type=password
+   config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
+  # Creating a token using client token
+   config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
+end
+api_instance = ProtonApi::RiskScoringApi.new
+
+dimensional_risk_score_request = ProtonApi::DimensionalRiskScoreRequest.new # DimensionalRiskScoreRequest | Request payload for Dimensional Risk Score
+
+
+begin
+  #Dimensional Risk Score
+  result = api_instance.dimensional_risk_score(dimensional_risk_score_request)
+  p result
+rescue ProtonApi::ApiError => e
+  puts "Exception when calling RiskScoringApi->dimensional_risk_score: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **dimensional_risk_score_request** | [**DimensionalRiskScoreRequest**](DimensionalRiskScoreRequest.md)| Request payload for Dimensional Risk Score | 
+
+### Return type
+
+**Hash<String, Object>**
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **risk_allocation**
+> Hash<String, Object> risk_allocation(risk_allocation_request)
+
+Risk Allocation
+
+Allocate based on a risk score
+
+### Example
+```ruby
+# load the gem
+require 'proton_api'
+# setup authorization
+ProtonApi.configure do |config|
+  # Creating a token for grant_type=client_credentials
+   config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
+  # Creating a token for grant_type=password
+   config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
+  # Creating a token using client token
+   config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
+end
+api_instance = ProtonApi::RiskScoringApi.new
+
+risk_allocation_request = ProtonApi::RiskAllocationRequest.new # RiskAllocationRequest | Request payload for Risk Allocation
+
+
+begin
+  #Risk Allocation
+  result = api_instance.risk_allocation(risk_allocation_request)
+  p result
+rescue ProtonApi::ApiError => e
+  puts "Exception when calling RiskScoringApi->risk_allocation: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **risk_allocation_request** | [**RiskAllocationRequest**](RiskAllocationRequest.md)| Request payload for Risk Allocation | 
+
+### Return type
+
+**Hash<String, Object>**
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **risk_score**
+> Hash<String, Object> risk_score(risk_score_request)
+
+Risk Score
+
+Calculate a risk score based on questionnaire responses
+
+### Example
+```ruby
+# load the gem
+require 'proton_api'
+# setup authorization
+ProtonApi.configure do |config|
+  # Creating a token for grant_type=client_credentials
+   config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
+  # Creating a token for grant_type=password
+   config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
+  # Creating a token using client token
+   config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
+end
+api_instance = ProtonApi::RiskScoringApi.new
+
+risk_score_request = ProtonApi::RiskScoreRequest.new # RiskScoreRequest | Request payload for Risk Score
+
+
+begin
+  #Risk Score
+  result = api_instance.risk_score(risk_score_request)
+  p result
+rescue ProtonApi::ApiError => e
+  puts "Exception when calling RiskScoringApi->risk_score: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **risk_score_request** | [**RiskScoreRequest**](RiskScoreRequest.md)| Request payload for Risk Score | 
+
+### Return type
+
+**Hash<String, Object>**
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+