proton_api 1.8.0 → 1.9.0

data/docs/FinancialHealthApi.md

@@ -1,232 +0,0 @@
-# ProtonApi::FinancialHealthApi
-
-All URIs are relative to *https://sandbox.hydrogenplatform.com/proton/v1*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**diversification_score**](FinancialHealthApi.md#diversification_score) | **POST** /diversification_score | Diversification Score
-[**emergency_fund_calculator**](FinancialHealthApi.md#emergency_fund_calculator) | **POST** /emergency_fund_calculator | Emergency Fund Calculator
-[**financial_health_check**](FinancialHealthApi.md#financial_health_check) | **POST** /financial_health_check | Financial Health Check
-[**portfolio_optimization_score**](FinancialHealthApi.md#portfolio_optimization_score) | **POST** /portfolio_optimization_score | Portfolio Optimization Score
-
-
-# **diversification_score**
-> Hash<String, Object> diversification_score(diversification_score_request)
-
-Diversification Score
-
-Assess how well a group of investments is diversified
-
-### 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::FinancialHealthApi.new
-
-diversification_score_request = ProtonApi::DiversificationScoreRequest.new # DiversificationScoreRequest | Request payload for Diversification Score
-
-
-begin
-  #Diversification Score
-  result = api_instance.diversification_score(diversification_score_request)
-  p result
-rescue ProtonApi::ApiError => e
-  puts "Exception when calling FinancialHealthApi->diversification_score: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **diversification_score_request** | [**DiversificationScoreRequest**](DiversificationScoreRequest.md)| Request payload for Diversification Score | 
-
-### Return type
-
-**Hash<String, Object>**
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **emergency_fund_calculator**
-> Hash<String, Object> emergency_fund_calculator(emergency_fund_calculator_request)
-
-Emergency Fund Calculator
-
-Calculate a target emergency fund amount and savings plan
-
-### 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::FinancialHealthApi.new
-
-emergency_fund_calculator_request = ProtonApi::EmergencyFundCalculatorRequest.new # EmergencyFundCalculatorRequest | Request payload for Emergency Fund Calculator
-
-
-begin
-  #Emergency Fund Calculator
-  result = api_instance.emergency_fund_calculator(emergency_fund_calculator_request)
-  p result
-rescue ProtonApi::ApiError => e
-  puts "Exception when calling FinancialHealthApi->emergency_fund_calculator: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **emergency_fund_calculator_request** | [**EmergencyFundCalculatorRequest**](EmergencyFundCalculatorRequest.md)| Request payload for Emergency Fund Calculator | 
-
-### Return type
-
-**Hash<String, Object>**
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **financial_health_check**
-> Hash<String, Object> financial_health_check(financial_health_check_request)
-
-Financial Health Check
-
-Calculate a series of financial ratios to assess financial health
-
-### 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::FinancialHealthApi.new
-
-financial_health_check_request = ProtonApi::FinancialHealthCheckRequest.new # FinancialHealthCheckRequest | Request payload for Financial Health Check
-
-
-begin
-  #Financial Health Check
-  result = api_instance.financial_health_check(financial_health_check_request)
-  p result
-rescue ProtonApi::ApiError => e
-  puts "Exception when calling FinancialHealthApi->financial_health_check: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **financial_health_check_request** | [**FinancialHealthCheckRequest**](FinancialHealthCheckRequest.md)| Request payload for Financial Health Check | 
-
-### Return type
-
-**Hash<String, Object>**
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **portfolio_optimization_score**
-> Hash<String, Object> portfolio_optimization_score(portfolio_optimization_score_request)
-
-Portfolio Optimization Score
-
-Analyze a group of investments against the optimized result
-
-### 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::FinancialHealthApi.new
-
-portfolio_optimization_score_request = ProtonApi::PortfolioOptimizationScoreRequest.new # PortfolioOptimizationScoreRequest | Request payload for Portfolio Optimization Score
-
-
-begin
-  #Portfolio Optimization Score
-  result = api_instance.portfolio_optimization_score(portfolio_optimization_score_request)
-  p result
-rescue ProtonApi::ApiError => e
-  puts "Exception when calling FinancialHealthApi->portfolio_optimization_score: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **portfolio_optimization_score_request** | [**PortfolioOptimizationScoreRequest**](PortfolioOptimizationScoreRequest.md)| Request payload for Portfolio Optimization Score | 
-
-### Return type
-
-**Hash<String, Object>**
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-

data/docs/FinancialHealthCheckRequest.md

@@ -1,17 +0,0 @@
-# ProtonApi::FinancialHealthCheckRequest
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**gross_annual_income** | **Float** |  | [optional] 
-**liquid_assets** | **Float** |  | [optional] 
-**net_monthly_income** | **Float** |  | [optional] 
-**client_id** | **String** |  | [optional] 
-**short_term_liabilities** | **Float** |  | [optional] 
-**monthly_expenses** | **Float** |  | [optional] 
-**total_liabilities** | **Float** |  | [optional] 
-**lookback_periods** | **Integer** |  | [optional] [default to 3]
-**ratio_targets** | [**RatioTargets**](RatioTargets.md) |  | [optional] 
-**non_liquid_assets** | **Float** |  | [optional] 
-
-

data/docs/FinancialPictureRequest.md

@@ -1,16 +0,0 @@
-# ProtonApi::FinancialPictureRequest
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**end_date** | **Date** |  | [optional] 
-**client_id** | **String** |  | 
-**create_log** | **BOOLEAN** |  | [optional] [default to false]
-**currency_conversion** | **String** |  | [optional] 
-**show_history** | **BOOLEAN** |  | [optional] [default to false]
-**start_date** | **Date** |  | [optional] 
-**currency_code** | **String** |  | [optional] 
-**show_category_breakdown** | **BOOLEAN** |  | [optional] [default to true]
-**show_change** | **BOOLEAN** |  | [optional] [default to false]
-
-

data/docs/FinancialPlanningApi.md

@@ -1,680 +0,0 @@
-# ProtonApi::FinancialPlanningApi
-
-All URIs are relative to *https://sandbox.hydrogenplatform.com/proton/v1*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**education_calculator_annual_cost**](FinancialPlanningApi.md#education_calculator_annual_cost) | **POST** /education_calculator/annual_cost | Education Calculator - Annual Cost
-[**education_calculator_deposit_amount**](FinancialPlanningApi.md#education_calculator_deposit_amount) | **POST** /education_calculator/deposit_amount | Education Calculator - Deposit Amount
-[**education_calculator_percent_covered**](FinancialPlanningApi.md#education_calculator_percent_covered) | **POST** /education_calculator/percent_covered | Education Calculator - Percent Covered
-[**mortgage_calculator_down_payment**](FinancialPlanningApi.md#mortgage_calculator_down_payment) | **POST** /mortgage_calculator/down_payment | Mortgage Calculator - Down Payment
-[**mortgage_calculator_home_price**](FinancialPlanningApi.md#mortgage_calculator_home_price) | **POST** /mortgage_calculator/home_price | Mortgage Calculator - Home Price
-[**mortgage_calculator_periodic_payment**](FinancialPlanningApi.md#mortgage_calculator_periodic_payment) | **POST** /mortgage_calculator/periodic_payment | Mortgage Calculator - Periodic Payment
-[**purchase_calculator_amount**](FinancialPlanningApi.md#purchase_calculator_amount) | **POST** /purchase_calculator/amount | Purchase Calculator - Amount
-[**purchase_calculator_deposit_amount**](FinancialPlanningApi.md#purchase_calculator_deposit_amount) | **POST** /purchase_calculator/deposit_amount | Purchase Calculator - Deposit Amount
-[**purchase_calculator_horizon**](FinancialPlanningApi.md#purchase_calculator_horizon) | **POST** /purchase_calculator/horizon | Purchase Calculator - Horizon
-[**retirement_calculator_deposit_amount**](FinancialPlanningApi.md#retirement_calculator_deposit_amount) | **POST** /retirement_calculator/deposit_amount | Retirement Calculator - Deposit Amount
-[**retirement_calculator_expenses**](FinancialPlanningApi.md#retirement_calculator_expenses) | **POST** /retirement_calculator/expenses | Retirement Calculator - Expenses
-[**retirement_calculator_percent_covered**](FinancialPlanningApi.md#retirement_calculator_percent_covered) | **POST** /retirement_calculator/percent_covered | Retirement Calculator - Percent Covered
-
-
-# **education_calculator_annual_cost**
-> Hash<String, Object> education_calculator_annual_cost(education_calculator_annual_cost_request)
-
-Education Calculator - Annual Cost
-
-Calculate the achievable education costs
-
-### 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::FinancialPlanningApi.new
-
-education_calculator_annual_cost_request = ProtonApi::EducationCalculatorAnnualCostRequest.new # EducationCalculatorAnnualCostRequest | Request payload for Education Calculator - Annual Cost
-
-
-begin
-  #Education Calculator - Annual Cost
-  result = api_instance.education_calculator_annual_cost(education_calculator_annual_cost_request)
-  p result
-rescue ProtonApi::ApiError => e
-  puts "Exception when calling FinancialPlanningApi->education_calculator_annual_cost: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **education_calculator_annual_cost_request** | [**EducationCalculatorAnnualCostRequest**](EducationCalculatorAnnualCostRequest.md)| Request payload for Education Calculator - Annual Cost | 
-
-### Return type
-
-**Hash<String, Object>**
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **education_calculator_deposit_amount**
-> Hash<String, Object> education_calculator_deposit_amount(education_calculator_deposit_amount_request)
-
-Education Calculator - Deposit Amount
-
-Calculate the necessary periodic deposit amount to achieve education costs
-
-### 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::FinancialPlanningApi.new
-
-education_calculator_deposit_amount_request = ProtonApi::EducationCalculatorDepositAmountRequest.new # EducationCalculatorDepositAmountRequest | Request payload for Education Calculator - Deposit Amount
-
-
-begin
-  #Education Calculator - Deposit Amount
-  result = api_instance.education_calculator_deposit_amount(education_calculator_deposit_amount_request)
-  p result
-rescue ProtonApi::ApiError => e
-  puts "Exception when calling FinancialPlanningApi->education_calculator_deposit_amount: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **education_calculator_deposit_amount_request** | [**EducationCalculatorDepositAmountRequest**](EducationCalculatorDepositAmountRequest.md)| Request payload for Education Calculator - Deposit Amount | 
-
-### Return type
-
-**Hash<String, Object>**
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **education_calculator_percent_covered**
-> Hash<String, Object> education_calculator_percent_covered(education_calculator_percent_covered_request)
-
-Education Calculator - Percent Covered
-
-Calculate the achievable percentage of education costs that can be covered
-
-### 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::FinancialPlanningApi.new
-
-education_calculator_percent_covered_request = ProtonApi::EducationCalculatorPercentCoveredRequest.new # EducationCalculatorPercentCoveredRequest | Request payload for Education Calculator - Percent Covered
-
-
-begin
-  #Education Calculator - Percent Covered
-  result = api_instance.education_calculator_percent_covered(education_calculator_percent_covered_request)
-  p result
-rescue ProtonApi::ApiError => e
-  puts "Exception when calling FinancialPlanningApi->education_calculator_percent_covered: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **education_calculator_percent_covered_request** | [**EducationCalculatorPercentCoveredRequest**](EducationCalculatorPercentCoveredRequest.md)| Request payload for Education Calculator - Percent Covered | 
-
-### Return type
-
-**Hash<String, Object>**
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **mortgage_calculator_down_payment**
-> Hash<String, Object> mortgage_calculator_down_payment(mortgage_calculator_down_payment_request)
-
-Mortgage Calculator - Down Payment
-
-Calculate the necessary down payment for the mortgage
-
-### 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::FinancialPlanningApi.new
-
-mortgage_calculator_down_payment_request = ProtonApi::MortgageCalculatorDownPaymentRequest.new # MortgageCalculatorDownPaymentRequest | Request payload for Mortgage Calculator - Down Payment
-
-
-begin
-  #Mortgage Calculator - Down Payment
-  result = api_instance.mortgage_calculator_down_payment(mortgage_calculator_down_payment_request)
-  p result
-rescue ProtonApi::ApiError => e
-  puts "Exception when calling FinancialPlanningApi->mortgage_calculator_down_payment: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **mortgage_calculator_down_payment_request** | [**MortgageCalculatorDownPaymentRequest**](MortgageCalculatorDownPaymentRequest.md)| Request payload for Mortgage Calculator - Down Payment | 
-
-### Return type
-
-**Hash<String, Object>**
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **mortgage_calculator_home_price**
-> Hash<String, Object> mortgage_calculator_home_price(mortgage_calculator_home_price_request)
-
-Mortgage Calculator - Home Price
-
-Calculate the achievable home price for the mortgage
-
-### 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::FinancialPlanningApi.new
-
-mortgage_calculator_home_price_request = ProtonApi::MortgageCalculatorHomePriceRequest.new # MortgageCalculatorHomePriceRequest | Request payload for Mortgage Calculator - Home Price
-
-
-begin
-  #Mortgage Calculator - Home Price
-  result = api_instance.mortgage_calculator_home_price(mortgage_calculator_home_price_request)
-  p result
-rescue ProtonApi::ApiError => e
-  puts "Exception when calling FinancialPlanningApi->mortgage_calculator_home_price: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **mortgage_calculator_home_price_request** | [**MortgageCalculatorHomePriceRequest**](MortgageCalculatorHomePriceRequest.md)| Request payload for Mortgage Calculator - Home Price | 
-
-### Return type
-
-**Hash<String, Object>**
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **mortgage_calculator_periodic_payment**
-> Hash<String, Object> mortgage_calculator_periodic_payment(mortgage_calculator_periodic_payment_request)
-
-Mortgage Calculator - Periodic Payment
-
-Calculate the periodic payment for the mortgage
-
-### 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::FinancialPlanningApi.new
-
-mortgage_calculator_periodic_payment_request = ProtonApi::MortgageCalculatorPeriodicPaymentRequest.new # MortgageCalculatorPeriodicPaymentRequest | Request payload for Mortgage Calculator - Periodic Payment
-
-
-begin
-  #Mortgage Calculator - Periodic Payment
-  result = api_instance.mortgage_calculator_periodic_payment(mortgage_calculator_periodic_payment_request)
-  p result
-rescue ProtonApi::ApiError => e
-  puts "Exception when calling FinancialPlanningApi->mortgage_calculator_periodic_payment: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **mortgage_calculator_periodic_payment_request** | [**MortgageCalculatorPeriodicPaymentRequest**](MortgageCalculatorPeriodicPaymentRequest.md)| Request payload for Mortgage Calculator - Periodic Payment | 
-
-### Return type
-
-**Hash<String, Object>**
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **purchase_calculator_amount**
-> Hash<String, Object> purchase_calculator_amount(purchase_calculator_amount_request)
-
-Purchase Calculator - Amount
-
-Calculate the achievable purchase amount
-
-### 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::FinancialPlanningApi.new
-
-purchase_calculator_amount_request = ProtonApi::PurchaseCalculatorAmountRequest.new # PurchaseCalculatorAmountRequest | Request payload for Purchase Calculator - Amount
-
-
-begin
-  #Purchase Calculator - Amount
-  result = api_instance.purchase_calculator_amount(purchase_calculator_amount_request)
-  p result
-rescue ProtonApi::ApiError => e
-  puts "Exception when calling FinancialPlanningApi->purchase_calculator_amount: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **purchase_calculator_amount_request** | [**PurchaseCalculatorAmountRequest**](PurchaseCalculatorAmountRequest.md)| Request payload for Purchase Calculator - Amount | 
-
-### Return type
-
-**Hash<String, Object>**
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **purchase_calculator_deposit_amount**
-> Hash<String, Object> purchase_calculator_deposit_amount(purchase_calculator_deposit_amount_request)
-
-Purchase Calculator - Deposit Amount
-
-Calculate the necessary periodic deposit amount to achieve the purchase amount
-
-### 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::FinancialPlanningApi.new
-
-purchase_calculator_deposit_amount_request = ProtonApi::PurchaseCalculatorDepositAmountRequest.new # PurchaseCalculatorDepositAmountRequest | Request payload for Purchase Calculator - Deposit Amount
-
-
-begin
-  #Purchase Calculator - Deposit Amount
-  result = api_instance.purchase_calculator_deposit_amount(purchase_calculator_deposit_amount_request)
-  p result
-rescue ProtonApi::ApiError => e
-  puts "Exception when calling FinancialPlanningApi->purchase_calculator_deposit_amount: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **purchase_calculator_deposit_amount_request** | [**PurchaseCalculatorDepositAmountRequest**](PurchaseCalculatorDepositAmountRequest.md)| Request payload for Purchase Calculator - Deposit Amount | 
-
-### Return type
-
-**Hash<String, Object>**
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **purchase_calculator_horizon**
-> Hash<String, Object> purchase_calculator_horizon(purchase_calculator_horizon_request)
-
-Purchase Calculator - Horizon
-
-Calculate the necessary time horizon to achieve the purchase amount
-
-### 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::FinancialPlanningApi.new
-
-purchase_calculator_horizon_request = ProtonApi::PurchaseCalculatorHorizonRequest.new # PurchaseCalculatorHorizonRequest | Request payload for Purchase Calculator - Horizon
-
-
-begin
-  #Purchase Calculator - Horizon
-  result = api_instance.purchase_calculator_horizon(purchase_calculator_horizon_request)
-  p result
-rescue ProtonApi::ApiError => e
-  puts "Exception when calling FinancialPlanningApi->purchase_calculator_horizon: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **purchase_calculator_horizon_request** | [**PurchaseCalculatorHorizonRequest**](PurchaseCalculatorHorizonRequest.md)| Request payload for Purchase Calculator - Horizon | 
-
-### Return type
-
-**Hash<String, Object>**
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **retirement_calculator_deposit_amount**
-> Hash<String, Object> retirement_calculator_deposit_amount(retirement_calculator_deposit_amount_request)
-
-Retirement Calculator - Deposit Amount
-
-Calculate the necessary period deposit amount to achieve the retirement expenses
-
-### 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::FinancialPlanningApi.new
-
-retirement_calculator_deposit_amount_request = ProtonApi::RetirementCalculatorDepositAmountRequest.new # RetirementCalculatorDepositAmountRequest | Request payload for Retirement Calculator - Deposit AMount
-
-
-begin
-  #Retirement Calculator - Deposit Amount
-  result = api_instance.retirement_calculator_deposit_amount(retirement_calculator_deposit_amount_request)
-  p result
-rescue ProtonApi::ApiError => e
-  puts "Exception when calling FinancialPlanningApi->retirement_calculator_deposit_amount: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **retirement_calculator_deposit_amount_request** | [**RetirementCalculatorDepositAmountRequest**](RetirementCalculatorDepositAmountRequest.md)| Request payload for Retirement Calculator - Deposit AMount | 
-
-### Return type
-
-**Hash<String, Object>**
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **retirement_calculator_expenses**
-> Hash<String, Object> retirement_calculator_expenses(retirement_calculator_expenses_request)
-
-Retirement Calculator - Expenses
-
-Calculate the achievable retirement expenses
-
-### 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::FinancialPlanningApi.new
-
-retirement_calculator_expenses_request = ProtonApi::RetirementCalculatorExpensesRequest.new # RetirementCalculatorExpensesRequest | Request payload for Retirement Calculator - Expenses
-
-
-begin
-  #Retirement Calculator - Expenses
-  result = api_instance.retirement_calculator_expenses(retirement_calculator_expenses_request)
-  p result
-rescue ProtonApi::ApiError => e
-  puts "Exception when calling FinancialPlanningApi->retirement_calculator_expenses: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **retirement_calculator_expenses_request** | [**RetirementCalculatorExpensesRequest**](RetirementCalculatorExpensesRequest.md)| Request payload for Retirement Calculator - Expenses | 
-
-### Return type
-
-**Hash<String, Object>**
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **retirement_calculator_percent_covered**
-> Hash<String, Object> retirement_calculator_percent_covered(retirement_calculator_percent_covered_request)
-
-Retirement Calculator - Percent Covered
-
-Calculate the achievable percentage of retirement expenses that can be covered
-
-### 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::FinancialPlanningApi.new
-
-retirement_calculator_percent_covered_request = ProtonApi::RetirementCalculatorPercentCoveredRequest.new # RetirementCalculatorPercentCoveredRequest | Request payload for Retirement Calculator - Percent Covered
-
-
-begin
-  #Retirement Calculator - Percent Covered
-  result = api_instance.retirement_calculator_percent_covered(retirement_calculator_percent_covered_request)
-  p result
-rescue ProtonApi::ApiError => e
-  puts "Exception when calling FinancialPlanningApi->retirement_calculator_percent_covered: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **retirement_calculator_percent_covered_request** | [**RetirementCalculatorPercentCoveredRequest**](RetirementCalculatorPercentCoveredRequest.md)| Request payload for Retirement Calculator - Percent Covered | 
-
-### Return type
-
-**Hash<String, Object>**
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-