proton_api 1.8.0 → 1.9.0

data/docs/SavingsCalculatorRequest.md

@@ -1,17 +0,0 @@
-# ProtonApi::SavingsCalculatorRequest
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**aggregation_account_ids** | **Array<String>** |  | [optional] 
-**tax_rate** | **Float** |  | [optional] [default to 0.0]
-**account_ids** | **Array<String>** |  | [optional] 
-**initial_balance** | **Float** |  | [optional] 
-**create_log** | **BOOLEAN** |  | [optional] [default to false]
-**inflation_rate** | **Float** |  | [optional] [default to 0.0]
-**horizon** | **Integer** |  | 
-**horizon_frequency_interval** | **String** |  | [optional] [default to 'year']
-**deposit_schedule** | [**Array<SavingsDepositSchedule>**](SavingsDepositSchedule.md) |  | [optional] 
-**return_schedule** | **Array<Float>** |  | 
-
-

data/docs/SavingsDepositSchedule.md

@@ -1,11 +0,0 @@
-# ProtonApi::SavingsDepositSchedule
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**adjust_deposit_for_inflation** | **BOOLEAN** |  | [optional] [default to true]
-**deposit_frequency_interval** | **String** |  | [optional] [default to 'year']
-**deposit_amount** | **Float** |  | [optional] 
-**deposit_duration** | **Integer** |  | [optional] 
-
-

data/docs/ScenarioAnalysisRequest.md

@@ -1,22 +0,0 @@
-# ProtonApi::ScenarioAnalysisRequest
-
-## 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]
-**allocation_id** | **String** |  | [optional] 
-**scenario** | [**Array<SensitivityFactor>**](SensitivityFactor.md) |  | 
-**use_proxy_data** | **BOOLEAN** |  | [optional] [default to false]
-**start_date** | **Date** |  | [optional] 
-**account_id** | **String** |  | [optional] 
-**frequency_interval** | **String** |  | 
-**aggregation_account_id** | **String** |  | [optional] 
-**trading_days_per_year** | **Integer** |  | [optional] [default to 252]
-**portfolio_weights** | **Array<Float>** |  | [optional] 
-
-

data/docs/SensitivityAnalysisRequest.md

@@ -1,22 +0,0 @@
-# ProtonApi::SensitivityAnalysisRequest
-
-## 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]
-**allocation_id** | **String** |  | [optional] 
-**use_proxy_data** | **BOOLEAN** |  | [optional] [default to false]
-**start_date** | **Date** |  | [optional] 
-**account_id** | **String** |  | [optional] 
-**frequency_interval** | **String** |  | 
-**aggregation_account_id** | **String** |  | [optional] 
-**trading_days_per_year** | **Integer** |  | [optional] [default to 252]
-**portfolio_weights** | **Array<Float>** |  | [optional] 
-**sensitivity_factor** | [**SensitivityFactor**](SensitivityFactor.md) |  | 
-
-

data/docs/SensitivityFactor.md

@@ -1,11 +0,0 @@
-# ProtonApi::SensitivityFactor
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**change_duration** | **Integer** |  | 
-**lag** | **Integer** |  | [optional] [default to 0]
-**change_amount** | **Float** |  | 
-**ticker** | **String** |  | 
-
-

data/docs/Settings.md

@@ -1,13 +0,0 @@
-# ProtonApi::Settings
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**drift_rebal** | **BOOLEAN** |  | [optional] 
-**downside** | **BOOLEAN** |  | [optional] 
-**default_drift_factor** | **Float** |  | [optional] 
-**period_rebal** | **BOOLEAN** |  | [optional] 
-**rebalance_period** | **Integer** |  | [optional] 
-**tax_efficiency_id** | **Integer** |  | [optional] 
-
-

data/docs/SimulationsApi.md

@@ -1,400 +0,0 @@
-# ProtonApi::SimulationsApi
-
-All URIs are relative to *https://sandbox.hydrogenplatform.com/proton/v1*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**backtest**](SimulationsApi.md#backtest) | **POST** /backtest | Backtest
-[**event_study**](SimulationsApi.md#event_study) | **POST** /event_study | Event Study
-[**monte_carlo**](SimulationsApi.md#monte_carlo) | **POST** /monte_carlo | Monte Carlo
-[**portfolio_what_if**](SimulationsApi.md#portfolio_what_if) | **POST** /portfolio_what_if | Porfolio What-If
-[**savings_calculator**](SimulationsApi.md#savings_calculator) | **POST** /savings_calculator | Savings Calculator
-[**scenario_analysis**](SimulationsApi.md#scenario_analysis) | **POST** /scenario_analysis | Scenario Analysis
-[**sensitivity_analysis**](SimulationsApi.md#sensitivity_analysis) | **POST** /sensitivity_analysis | Sensitivity Analysis
-
-
-# **backtest**
-> Hash<String, Object> backtest(backtest_request)
-
-Backtest
-
-Run a historical analysis 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::SimulationsApi.new
-
-backtest_request = ProtonApi::BacktestRequest.new # BacktestRequest | Request payload for Backtest
-
-
-begin
-  #Backtest
-  result = api_instance.backtest(backtest_request)
-  p result
-rescue ProtonApi::ApiError => e
-  puts "Exception when calling SimulationsApi->backtest: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **backtest_request** | [**BacktestRequest**](BacktestRequest.md)| Request payload for Backtest | 
-
-### Return type
-
-**Hash<String, Object>**
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **event_study**
-> Hash<String, Object> event_study(event_study_request)
-
-Event Study
-
-Analyze a group of investments against key historical events
-
-### 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::SimulationsApi.new
-
-event_study_request = ProtonApi::EventStudyRequest.new # EventStudyRequest | Request payload for Event Study
-
-
-begin
-  #Event Study
-  result = api_instance.event_study(event_study_request)
-  p result
-rescue ProtonApi::ApiError => e
-  puts "Exception when calling SimulationsApi->event_study: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **event_study_request** | [**EventStudyRequest**](EventStudyRequest.md)| Request payload for Event Study | 
-
-### Return type
-
-**Hash<String, Object>**
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **monte_carlo**
-> Hash<String, Object> monte_carlo(monte_carlo_request)
-
-Monte Carlo
-
-Simulate the future growth of 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::SimulationsApi.new
-
-monte_carlo_request = ProtonApi::MonteCarloRequest.new # MonteCarloRequest | Request payload for Monte Carlo
-
-
-begin
-  #Monte Carlo
-  result = api_instance.monte_carlo(monte_carlo_request)
-  p result
-rescue ProtonApi::ApiError => e
-  puts "Exception when calling SimulationsApi->monte_carlo: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **monte_carlo_request** | [**MonteCarloRequest**](MonteCarloRequest.md)| Request payload for Monte Carlo | 
-
-### Return type
-
-**Hash<String, Object>**
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **portfolio_what_if**
-> Hash<String, Object> portfolio_what_if(portfolio_what_if_request)
-
-Porfolio What-If
-
-Simulate the impact of adding, removing, reducing, or increasing various positions in 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::SimulationsApi.new
-
-portfolio_what_if_request = ProtonApi::PortfolioWhatIfRequest.new # PortfolioWhatIfRequest | Request payload for Portfolio What-If
-
-
-begin
-  #Porfolio What-If
-  result = api_instance.portfolio_what_if(portfolio_what_if_request)
-  p result
-rescue ProtonApi::ApiError => e
-  puts "Exception when calling SimulationsApi->portfolio_what_if: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **portfolio_what_if_request** | [**PortfolioWhatIfRequest**](PortfolioWhatIfRequest.md)| Request payload for Portfolio What-If | 
-
-### Return type
-
-**Hash<String, Object>**
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **savings_calculator**
-> Hash<String, Object> savings_calculator(savings_calculator_request)
-
-Savings Calculator
-
-Simulate the future growth of a simple savings account
-
-### 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::SimulationsApi.new
-
-savings_calculator_request = ProtonApi::SavingsCalculatorRequest.new # SavingsCalculatorRequest | Request payload for Savings Calculator
-
-
-begin
-  #Savings Calculator
-  result = api_instance.savings_calculator(savings_calculator_request)
-  p result
-rescue ProtonApi::ApiError => e
-  puts "Exception when calling SimulationsApi->savings_calculator: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **savings_calculator_request** | [**SavingsCalculatorRequest**](SavingsCalculatorRequest.md)| Request payload for Savings Calculator | 
-
-### Return type
-
-**Hash<String, Object>**
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **scenario_analysis**
-> Hash<String, Object> scenario_analysis(scneario_analysis_request)
-
-Scenario Analysis
-
-Analyze a group of investments against a series of external economic factors
-
-### 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::SimulationsApi.new
-
-scneario_analysis_request = ProtonApi::ScenarioAnalysisRequest.new # ScenarioAnalysisRequest | Request payload for Scenario Analysis
-
-
-begin
-  #Scenario Analysis
-  result = api_instance.scenario_analysis(scneario_analysis_request)
-  p result
-rescue ProtonApi::ApiError => e
-  puts "Exception when calling SimulationsApi->scenario_analysis: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **scneario_analysis_request** | [**ScenarioAnalysisRequest**](ScenarioAnalysisRequest.md)| Request payload for Scenario Analysis | 
-
-### Return type
-
-**Hash<String, Object>**
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **sensitivity_analysis**
-> Hash<String, Object> sensitivity_analysis(sensitivity_analysis_request)
-
-Sensitivity Analysis
-
-Analyze a group of investments against an external economic factor
-
-### 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::SimulationsApi.new
-
-sensitivity_analysis_request = ProtonApi::SensitivityAnalysisRequest.new # SensitivityAnalysisRequest | Request payload for Sensitivity Analysis
-
-
-begin
-  #Sensitivity Analysis
-  result = api_instance.sensitivity_analysis(sensitivity_analysis_request)
-  p result
-rescue ProtonApi::ApiError => e
-  puts "Exception when calling SimulationsApi->sensitivity_analysis: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **sensitivity_analysis_request** | [**SensitivityAnalysisRequest**](SensitivityAnalysisRequest.md)| Request payload for Sensitivity Analysis | 
-
-### Return type
-
-**Hash<String, Object>**
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-