proton_api 1.8.0 → 1.9.0

data/docs/GuaranteedRateBenefit.md

@@ -1,11 +0,0 @@
-# ProtonApi::GuaranteedRateBenefit
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**start_period** | **Integer** |  | [optional] [default to 1]
-**end_period** | **Integer** |  | [optional] 
-**max_rate** | **Float** |  | [optional] 
-**min_rate** | **Float** |  | [optional] [default to 0.0]
-
-

data/docs/IncomeConfig.md

@@ -1,10 +0,0 @@
-# ProtonApi::IncomeConfig
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**annual_net_take_home_pay** | **Float** |  | 
-**percentage_of_income_covered** | **Float** |  | [optional] [default to 1.0]
-**income_benefit_duration** | **Integer** |  | [optional] [default to 10]
-
-

data/docs/LifeInsuranceApi.md

@@ -1,64 +0,0 @@
-# ProtonApi::LifeInsuranceApi
-
-All URIs are relative to *https://sandbox.hydrogenplatform.com/proton/v1*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**life_insurance_needs_calculator**](LifeInsuranceApi.md#life_insurance_needs_calculator) | **POST** /life_insurance/needs_calculator | Life Insurance Needs Calculator
-
-
-# **life_insurance_needs_calculator**
-> Hash<String, Object> life_insurance_needs_calculator(life_insurance_needs_calculator_request)
-
-Life Insurance Needs Calculator
-
-Calculate life insurance needs based on existing asset and liability data
-
-### 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::LifeInsuranceApi.new
-
-life_insurance_needs_calculator_request = ProtonApi::LifeInsuranceNeedsCalculatorRequest.new # LifeInsuranceNeedsCalculatorRequest | Request payload for Life Insurance Needs Calculator
-
-
-begin
-  #Life Insurance Needs Calculator
-  result = api_instance.life_insurance_needs_calculator(life_insurance_needs_calculator_request)
-  p result
-rescue ProtonApi::ApiError => e
-  puts "Exception when calling LifeInsuranceApi->life_insurance_needs_calculator: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **life_insurance_needs_calculator_request** | [**LifeInsuranceNeedsCalculatorRequest**](LifeInsuranceNeedsCalculatorRequest.md)| Request payload for Life Insurance Needs Calculator | 
-
-### Return type
-
-**Hash<String, Object>**
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-

data/docs/LifeInsuranceNeedsCalculatorRequest.md

@@ -1,22 +0,0 @@
-# ProtonApi::LifeInsuranceNeedsCalculatorRequest
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**children_education_config** | [**Array<ChildrenEducationConfig>**](ChildrenEducationConfig.md) |  | [optional] 
-**liquid_assets** | **Float** |  | [optional] 
-**other_debt** | **Float** |  | [optional] 
-**client_id** | **String** |  | [optional] 
-**tax_rate** | **Float** |  | [optional] [default to 0.0]
-**end_of_life_expenses** | **Float** |  | [optional] 
-**mortgage_balance** | **Float** |  | [optional] 
-**income_config** | [**Array<IncomeConfig>**](IncomeConfig.md) |  | [optional] 
-**beneficiary_bequest_config** | [**Array<BeneficiaryBequestConfig>**](BeneficiaryBequestConfig.md) |  | [optional] 
-**margin_of_error** | **Float** |  | [optional] [default to 0.0]
-**education_inflation_rate** | **Float** |  | [optional] [default to 0.0]
-**interest_rate** | **Float** |  | 
-**existing_life_insurance** | **Float** |  | [optional] 
-**benefit_amount_rounding** | **Integer** |  | [optional] [default to 0]
-**general_inflation_rate** | **Float** |  | [optional] [default to 0.0]
-
-

data/docs/MonteCarloRequest.md

@@ -1,29 +0,0 @@
-# ProtonApi::MonteCarloRequest
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**portfolio_id** | **String** |  | [optional] 
-**max_sample** | **Array<Float>** |  | [optional] 
-**result_type** | **String** |  | [optional] [default to 'raw']
-**ret_mod** | **Array<Float>** |  | [optional] 
-**remove_outliers** | **BOOLEAN** |  | [optional] [default to false]
-**max_bal** | **Array<Float>** |  | [optional] 
-**market_data_source** | **String** |  | [optional] [default to 'nucleus']
-**p** | **Array<Float>** |  | [optional] 
-**allocation_id** | **String** |  | [optional] 
-**use_proxy_data** | **BOOLEAN** |  | [optional] [default to false]
-**aggregation_account_id** | **String** |  | [optional] 
-**init_bal** | **Float** |  | [optional] 
-**min_sample** | **Array<Float>** |  | [optional] 
-**create_log** | **BOOLEAN** |  | [optional] [default to false]
-**mu** | **Array<Float>** |  | [optional] 
-**account_id** | **String** |  | [optional] 
-**sigma** | **Array<Float>** |  | [optional] 
-**model_id** | **String** |  | [optional] 
-**n** | **Integer** |  | [optional] [default to 1000]
-**min_bal** | **Array<Float>** |  | [optional] 
-**frequency_interval** | **String** |  | [optional] [default to 'year']
-**cf** | **Array<Array<Float>>** |  | 
-
-

data/docs/MortgageCalculatorDownPaymentRequest.md

@@ -1,11 +0,0 @@
-# ProtonApi::MortgageCalculatorDownPaymentRequest
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**mortgage_term** | **Integer** |  | [optional] [default to 360]
-**periodic_payment** | **Float** |  | 
-**home_price** | **Float** |  | 
-**interest_rate** | **Float** |  | [optional] [default to 0.04]
-
-

data/docs/MortgageCalculatorHomePriceRequest.md

@@ -1,11 +0,0 @@
-# ProtonApi::MortgageCalculatorHomePriceRequest
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**mortgage_term** | **Integer** |  | [optional] [default to 360]
-**periodic_payment** | **Float** |  | 
-**down_payment** | **Float** |  | 
-**interest_rate** | **Float** |  | [optional] [default to 0.04]
-
-

data/docs/MortgageCalculatorPeriodicPaymentRequest.md

@@ -1,11 +0,0 @@
-# ProtonApi::MortgageCalculatorPeriodicPaymentRequest
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**mortgage_term** | **Integer** |  | [optional] [default to 360]
-**home_price** | **Float** |  | 
-**down_payment** | **Float** |  | 
-**interest_rate** | **Float** |  | [optional] [default to 0.04]
-
-

data/docs/MvoRequest.md

@@ -1,18 +0,0 @@
-# ProtonApi::MvoRequest
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**sec_types** | **Array<String>** |  | 
-**end_date** | **Date** |  | [optional] 
-**market_data_source** | **String** |  | [optional] [default to 'nucleus']
-**tgt_val** | **Float** |  | [optional] [default to 0.0]
-**tgt_type** | **String** |  | [optional] 
-**use_proxy_data** | **BOOLEAN** |  | [optional] [default to false]
-**w_config** | [**WConfig**](WConfig.md) |  | 
-**start_date** | **Date** |  | [optional] 
-**tickers** | **Array<String>** |  | 
-**min_assets** | **Integer** |  | 
-**w_asset_config** | **Object** |  | [optional] 
-
-

data/docs/OptConfig.md

@@ -1,14 +0,0 @@
-# ProtonApi::OptConfig
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**sec_types** | **Array<String>** |  | 
-**end_date** | **Date** |  | [optional] 
-**w_config** | [**WConfig**](WConfig.md) |  | 
-**start_date** | **Date** |  | [optional] 
-**tickers** | **Array<String>** |  | 
-**min_assets** | **Integer** |  | 
-**w_asset_config** | **Object** |  | [optional] 
-
-

data/docs/OptConfig1.md

@@ -1,12 +0,0 @@
-# ProtonApi::OptConfig1
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**sec_types** | **Array<String>** |  | [optional] 
-**w_config** | [**WConfig1**](WConfig1.md) |  | [optional] 
-**tickers** | **Array<String>** |  | [optional] 
-**min_assets** | **Integer** |  | [optional] [default to 1]
-**w_asset_config** | **Object** |  | [optional] 
-
-

data/docs/Periods.md

@@ -1,9 +0,0 @@
-# ProtonApi::Periods
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**_end** | **Integer** |  | [optional] 
-**start** | **Integer** |  | [optional] 
-
-

data/docs/PersonalFinancialManagementApi.md

@@ -1,288 +0,0 @@
-# ProtonApi::PersonalFinancialManagementApi
-
-All URIs are relative to *https://sandbox.hydrogenplatform.com/proton/v1*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**budget_calculator**](PersonalFinancialManagementApi.md#budget_calculator) | **POST** /budget_calculator | Budget Calculator
-[**cash_flow_analysis**](PersonalFinancialManagementApi.md#cash_flow_analysis) | **POST** /cash_flow_analysis | Cash Flow Analysis
-[**fee_analysis**](PersonalFinancialManagementApi.md#fee_analysis) | **POST** /fee_analysis | RFee Analysis
-[**financial_picture**](PersonalFinancialManagementApi.md#financial_picture) | **POST** /financial_picture | Financial Picture
-[**recurring_transaction_analysis**](PersonalFinancialManagementApi.md#recurring_transaction_analysis) | **POST** /recurring_transaction_analysis | Recurring Transaction Analysis
-
-
-# **budget_calculator**
-> Hash<String, Object> budget_calculator(budget_calculator_request)
-
-Budget Calculator
-
-Analyze spending against a defined budget
-
-### 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::PersonalFinancialManagementApi.new
-
-budget_calculator_request = ProtonApi::BudgetCalculatorRequest.new # BudgetCalculatorRequest | Request payload for Budget Calculator
-
-
-begin
-  #Budget Calculator
-  result = api_instance.budget_calculator(budget_calculator_request)
-  p result
-rescue ProtonApi::ApiError => e
-  puts "Exception when calling PersonalFinancialManagementApi->budget_calculator: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **budget_calculator_request** | [**BudgetCalculatorRequest**](BudgetCalculatorRequest.md)| Request payload for Budget Calculator | 
-
-### Return type
-
-**Hash<String, Object>**
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **cash_flow_analysis**
-> Hash<String, Object> cash_flow_analysis(cash_flow_analysis_request)
-
-Cash Flow Analysis
-
-Analyze income, expenses, and net income
-
-### 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::PersonalFinancialManagementApi.new
-
-cash_flow_analysis_request = ProtonApi::CashFlowAnalysisRequest.new # CashFlowAnalysisRequest | Request payload for Cash Flow Analysis
-
-
-begin
-  #Cash Flow Analysis
-  result = api_instance.cash_flow_analysis(cash_flow_analysis_request)
-  p result
-rescue ProtonApi::ApiError => e
-  puts "Exception when calling PersonalFinancialManagementApi->cash_flow_analysis: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **cash_flow_analysis_request** | [**CashFlowAnalysisRequest**](CashFlowAnalysisRequest.md)| Request payload for Cash Flow Analysis | 
-
-### Return type
-
-**Hash<String, Object>**
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **fee_analysis**
-> Hash<String, Object> fee_analysis(fee_analysis_request)
-
-RFee Analysis
-
-Analyze fee data
-
-### 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::PersonalFinancialManagementApi.new
-
-fee_analysis_request = ProtonApi::FeeAnalysisRequest.new # FeeAnalysisRequest | Request payload for Fee Analysis
-
-
-begin
-  #RFee Analysis
-  result = api_instance.fee_analysis(fee_analysis_request)
-  p result
-rescue ProtonApi::ApiError => e
-  puts "Exception when calling PersonalFinancialManagementApi->fee_analysis: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **fee_analysis_request** | [**FeeAnalysisRequest**](FeeAnalysisRequest.md)| Request payload for Fee Analysis | 
-
-### Return type
-
-**Hash<String, Object>**
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **financial_picture**
-> Hash<String, Object> financial_picture(financial_picture_request)
-
-Financial Picture
-
-Assess assets, liabilities, and net worth
-
-### 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::PersonalFinancialManagementApi.new
-
-financial_picture_request = ProtonApi::FinancialPictureRequest.new # FinancialPictureRequest | Request payload for Financial Picture
-
-
-begin
-  #Financial Picture
-  result = api_instance.financial_picture(financial_picture_request)
-  p result
-rescue ProtonApi::ApiError => e
-  puts "Exception when calling PersonalFinancialManagementApi->financial_picture: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **financial_picture_request** | [**FinancialPictureRequest**](FinancialPictureRequest.md)| Request payload for Financial Picture | 
-
-### Return type
-
-**Hash<String, Object>**
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **recurring_transaction_analysis**
-> Hash<String, Object> recurring_transaction_analysis(recurring_transaction_analysis_request)
-
-Recurring Transaction Analysis
-
-Analyze recurring transactions
-
-### 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::PersonalFinancialManagementApi.new
-
-recurring_transaction_analysis_request = ProtonApi::RecurringTransactionAnalysisRequest.new # RecurringTransactionAnalysisRequest | Request payload for Recurring Transaction Analysis
-
-
-begin
-  #Recurring Transaction Analysis
-  result = api_instance.recurring_transaction_analysis(recurring_transaction_analysis_request)
-  p result
-rescue ProtonApi::ApiError => e
-  puts "Exception when calling PersonalFinancialManagementApi->recurring_transaction_analysis: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **recurring_transaction_analysis_request** | [**RecurringTransactionAnalysisRequest**](RecurringTransactionAnalysisRequest.md)| Request payload for Recurring Transaction Analysis | 
-
-### Return type
-
-**Hash<String, Object>**
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-