proton_api 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23aac3a093f2f1a0f7fdaea70abb5446cea861442d1a5d703004b266157d4e3d
-  data.tar.gz: a1bb1786c3da7ca71c2333e8c3d5cd6bb19beccde23e4497ec578ea0aa4a29b3
+  metadata.gz: 385c5a86b3ffc8f2d40b3987bc4f966d5d73d636153b2112fdc478d63c4febc4
+  data.tar.gz: aa8d24dc00006188d59df04eacd40ae5826d200d0cbbe57d2c03cf8e39ae499f
 SHA512:
-  metadata.gz: a65881f9bb3d3a0cf54128d29e3e584feb83bb285c3c8dccb62b91b543c5314fa3895177b521a5cae2103e5a75ed0b673be5ccf9ce33148bac26b072641f0ce9
-  data.tar.gz: f3d96695f93ef04d9be1b09a799bbfd4c321f086a666a8646b4d124d3766ad5e69a68689f2f59defe8d26dcc31e6f766e4972f748de57a411745dfa04e7a899f
+  metadata.gz: 829b13d900f352363c9ee271e53214a272b04c1e5d31684d9fbc4f7c9a22dd972d32e9f9e6d76717d71744686a62a2f86cfbfd2da64609ae9408de602d4c5bd7
+  data.tar.gz: 1246766bf4525e7afff50e6ac9619d80d2c6701735f0161fe6438e71cd62f7a30b2d64705e04f2291b25e5f157f199e73229238f19ac910add34d48639e0c74c

data/README.md

@@ -1,84 +1,64 @@
-# proton_api
+# Hydrogen Proton API
 
-ProtonApi - the Ruby gem for the Hydrogen Proton API
+Hydrogen Proton API
+- API version: 1.9.0
+  - Build date: 29-06-2021
 
-Financial engineering module of Hydrogen Atom
+For more information, please visit [https://www.hydrogenplatform.com/apis](https://www.hydrogenplatform.com/apis)
 
-This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+## Documentation
 
-- API version: 1.8.0
-- Package version: 1.0.0
-- Build package: io.swagger.codegen.languages.RubyClientCodegen
-For more information, please visit [https://www.hydrogenplatform.com/contact](https://www.hydrogenplatform.com/contact)
+https://www.hydrogenplatform.com/docs/proton/v1
 
-## Installation
-### Update Base Path
-Follow steps to verify the base URL path:
-1. Go to configuration file located under lib folder.
-2. Search for @host and change/verify the URL according to the environment.
-**Sandbox Base URL**
-https://sandbox.hydrogenplatform.com/proton/v1
-**Production Base URL**
-https://api.hydrogenplatform.com/proton/v1
-
-### Build a gem
+## Requirements
+1. Ruby 2.7+
 
-To build the Ruby code into a gem:
+## Installation
 
-```shell
-gem build proton_api.gemspec
-```
+### Install via Ruby Gems
 
-Then either install the gem locally:
+Install the gem:
 
 ```shell
-gem install ./proton_api-1.8.0.gem
+gem install proton_api
 ```
-(for development, run `gem install --dev ./proton_api-1.8.0.gem` to install the development dependencies)
 
-or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+The add this to the Gemfile:
 
-Finally add this to the Gemfile:
+    gem 'proton_api', '~> 1.9'
 
-    gem 'proton_api', '~> 1.8.0'
-
-### Install from Git
-
-If the Ruby gem is hosted at a git repository: https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO, then add the following in the Gemfile:
+## Getting Started
 
-    gem 'proton_api', :git => 'https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO.git'
+Please first follow the [installation](#installation) instructions. Then make sure you use the proper base URL:
 
-### Include the Ruby code directly
+### Base URL
 
-Include the Ruby code directly using `-I` as follows:
+1. Go to configuration file located under lib folder.
+2. Search for @host and change/verify the URL according to the environment.
 
-```shell
-ruby -Ilib script.rb
-```
+**Sandbox Base URL**
+sandbox.hydrogenplatform.com
 
-## Getting Started
+**Production Base URL**
+api.hydrogenplatform.com
 
-Please follow the [installation](#installation) procedure and then run the following code:
 ```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");
+# Use one of the below method to generate oauth token        
+# 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::AnnuitiesApi.new
 
 annuity_calculator_accumulation_horizon_request = ProtonApi::AnnuityCalculatorAccumulationHorizonRequest.new # AnnuityCalculatorAccumulationHorizonRequest | Request payload for Annuity Calculator - Accumulation Horizon
-
-
 begin
   #Annuity Calculator - Accumulation Horizon
   result = api_instance.annuity_calculator_accumulation_horizon(annuity_calculator_accumulation_horizon_request)
@@ -88,159 +68,9 @@ rescue ProtonApi::ApiError => e
 end
 
 ```
+## Author
+The Hydrogen Technology Corporation
 
-## Documentation for API Endpoints
-
-All URIs are relative to *https://sandbox.hydrogenplatform.com/proton/v1*
-
-Class | Method | HTTP request | Description
------------- | ------------- | ------------- | -------------
-*ProtonApi::AnnuitiesApi* | [**annuity_calculator_accumulation_horizon**](docs/AnnuitiesApi.md#annuity_calculator_accumulation_horizon) | **POST** /annuity_calculator/accumulation_horizon | Annuity Calculator - Accumulation Horizon
-*ProtonApi::AnnuitiesApi* | [**annuity_calculator_annuity_amount**](docs/AnnuitiesApi.md#annuity_calculator_annuity_amount) | **POST** /annuity_calculator/annuity_amount | Annuity Calculator - Annuity Amount
-*ProtonApi::AnnuitiesApi* | [**annuity_calculator_decumulation_horizon**](docs/AnnuitiesApi.md#annuity_calculator_decumulation_horizon) | **POST** /annuity_calculator/decumulation_horizon | Annuity Calculator - Decumulation Horizon
-*ProtonApi::AnnuitiesApi* | [**annuity_calculator_deposit_amount**](docs/AnnuitiesApi.md#annuity_calculator_deposit_amount) | **POST** /annuity_calculator/deposit_amount | Annuity Calculator - Deposit Amount
-*ProtonApi::AnnuitiesApi* | [**annuity_calculator_initial_balance**](docs/AnnuitiesApi.md#annuity_calculator_initial_balance) | **POST** /annuity_calculator/initial_balance | Annuity Calculator - Initial Balance
-*ProtonApi::AnnuitiesApi* | [**variable_annuity**](docs/AnnuitiesApi.md#variable_annuity) | **POST** /variable_annuity | Variable Annuity
-*ProtonApi::BusinessFinancialManagementApi* | [**business_financial_health_check**](docs/BusinessFinancialManagementApi.md#business_financial_health_check) | **POST** /business/financial_health_check | Business Financial Health Check
-*ProtonApi::BusinessFinancialManagementApi* | [**cash_analysis**](docs/BusinessFinancialManagementApi.md#cash_analysis) | **POST** /business/cash_analysis | Cash Analysis
-*ProtonApi::BusinessFinancialManagementApi* | [**customer_analysis**](docs/BusinessFinancialManagementApi.md#customer_analysis) | **POST** /business/customer_analysis | Customer Analysis
-*ProtonApi::BusinessFinancialManagementApi* | [**financial_statement_analysis**](docs/BusinessFinancialManagementApi.md#financial_statement_analysis) | **POST** /business/financial_statement_analysis | Financial Statement Analysis
-*ProtonApi::BusinessFinancialManagementApi* | [**invoice_analysis**](docs/BusinessFinancialManagementApi.md#invoice_analysis) | **POST** /business/invoice_analysis | Invoice Analysis
-*ProtonApi::CardsApi* | [**card_limit_check**](docs/CardsApi.md#card_limit_check) | **POST** /card_limit_check | Card Limit Check
-*ProtonApi::CardsApi* | [**card_transaction_authorization**](docs/CardsApi.md#card_transaction_authorization) | **POST** /card_authorization | Card Transaction Authorization
-*ProtonApi::FinancialHealthApi* | [**diversification_score**](docs/FinancialHealthApi.md#diversification_score) | **POST** /diversification_score | Diversification Score
-*ProtonApi::FinancialHealthApi* | [**emergency_fund_calculator**](docs/FinancialHealthApi.md#emergency_fund_calculator) | **POST** /emergency_fund_calculator | Emergency Fund Calculator
-*ProtonApi::FinancialHealthApi* | [**financial_health_check**](docs/FinancialHealthApi.md#financial_health_check) | **POST** /financial_health_check | Financial Health Check
-*ProtonApi::FinancialHealthApi* | [**portfolio_optimization_score**](docs/FinancialHealthApi.md#portfolio_optimization_score) | **POST** /portfolio_optimization_score | Portfolio Optimization Score
-*ProtonApi::FinancialPlanningApi* | [**education_calculator_annual_cost**](docs/FinancialPlanningApi.md#education_calculator_annual_cost) | **POST** /education_calculator/annual_cost | Education Calculator - Annual Cost
-*ProtonApi::FinancialPlanningApi* | [**education_calculator_deposit_amount**](docs/FinancialPlanningApi.md#education_calculator_deposit_amount) | **POST** /education_calculator/deposit_amount | Education Calculator - Deposit Amount
-*ProtonApi::FinancialPlanningApi* | [**education_calculator_percent_covered**](docs/FinancialPlanningApi.md#education_calculator_percent_covered) | **POST** /education_calculator/percent_covered | Education Calculator - Percent Covered
-*ProtonApi::FinancialPlanningApi* | [**mortgage_calculator_down_payment**](docs/FinancialPlanningApi.md#mortgage_calculator_down_payment) | **POST** /mortgage_calculator/down_payment | Mortgage Calculator - Down Payment
-*ProtonApi::FinancialPlanningApi* | [**mortgage_calculator_home_price**](docs/FinancialPlanningApi.md#mortgage_calculator_home_price) | **POST** /mortgage_calculator/home_price | Mortgage Calculator - Home Price
-*ProtonApi::FinancialPlanningApi* | [**mortgage_calculator_periodic_payment**](docs/FinancialPlanningApi.md#mortgage_calculator_periodic_payment) | **POST** /mortgage_calculator/periodic_payment | Mortgage Calculator - Periodic Payment
-*ProtonApi::FinancialPlanningApi* | [**purchase_calculator_amount**](docs/FinancialPlanningApi.md#purchase_calculator_amount) | **POST** /purchase_calculator/amount | Purchase Calculator - Amount
-*ProtonApi::FinancialPlanningApi* | [**purchase_calculator_deposit_amount**](docs/FinancialPlanningApi.md#purchase_calculator_deposit_amount) | **POST** /purchase_calculator/deposit_amount | Purchase Calculator - Deposit Amount
-*ProtonApi::FinancialPlanningApi* | [**purchase_calculator_horizon**](docs/FinancialPlanningApi.md#purchase_calculator_horizon) | **POST** /purchase_calculator/horizon | Purchase Calculator - Horizon
-*ProtonApi::FinancialPlanningApi* | [**retirement_calculator_deposit_amount**](docs/FinancialPlanningApi.md#retirement_calculator_deposit_amount) | **POST** /retirement_calculator/deposit_amount | Retirement Calculator - Deposit Amount
-*ProtonApi::FinancialPlanningApi* | [**retirement_calculator_expenses**](docs/FinancialPlanningApi.md#retirement_calculator_expenses) | **POST** /retirement_calculator/expenses | Retirement Calculator - Expenses
-*ProtonApi::FinancialPlanningApi* | [**retirement_calculator_percent_covered**](docs/FinancialPlanningApi.md#retirement_calculator_percent_covered) | **POST** /retirement_calculator/percent_covered | Retirement Calculator - Percent Covered
-*ProtonApi::GoalsApi* | [**goal_accumulation_allocation**](docs/GoalsApi.md#goal_accumulation_allocation) | **POST** /goal_accumulation/allocation | Goal Accumulation Allocation
-*ProtonApi::GoalsApi* | [**goal_accumulation_recommendation**](docs/GoalsApi.md#goal_accumulation_recommendation) | **POST** /goal_accumulation/recommendation | Goal Accumulation Recommendation
-*ProtonApi::GoalsApi* | [**goal_accumulation_status**](docs/GoalsApi.md#goal_accumulation_status) | **POST** /goal_accumulation/status | Goal Accumulation Status
-*ProtonApi::GoalsApi* | [**goal_decumulation_allocation**](docs/GoalsApi.md#goal_decumulation_allocation) | **POST** /goal_decumulation/allocation | Goal Decumulation Allocation
-*ProtonApi::GoalsApi* | [**goal_decumulation_recommendation**](docs/GoalsApi.md#goal_decumulation_recommendation) | **POST** /goal_decumulation/recommendation | Goal Decumulation Recommendation
-*ProtonApi::GoalsApi* | [**goal_decumulation_status**](docs/GoalsApi.md#goal_decumulation_status) | **POST** /goal_decumulation/status | Goal Decumulation Status
-*ProtonApi::LifeInsuranceApi* | [**life_insurance_needs_calculator**](docs/LifeInsuranceApi.md#life_insurance_needs_calculator) | **POST** /life_insurance/needs_calculator | Life Insurance Needs Calculator
-*ProtonApi::PersonalFinancialManagementApi* | [**budget_calculator**](docs/PersonalFinancialManagementApi.md#budget_calculator) | **POST** /budget_calculator | Budget Calculator
-*ProtonApi::PersonalFinancialManagementApi* | [**cash_flow_analysis**](docs/PersonalFinancialManagementApi.md#cash_flow_analysis) | **POST** /cash_flow_analysis | Cash Flow Analysis
-*ProtonApi::PersonalFinancialManagementApi* | [**fee_analysis**](docs/PersonalFinancialManagementApi.md#fee_analysis) | **POST** /fee_analysis | RFee Analysis
-*ProtonApi::PersonalFinancialManagementApi* | [**financial_picture**](docs/PersonalFinancialManagementApi.md#financial_picture) | **POST** /financial_picture | Financial Picture
-*ProtonApi::PersonalFinancialManagementApi* | [**recurring_transaction_analysis**](docs/PersonalFinancialManagementApi.md#recurring_transaction_analysis) | **POST** /recurring_transaction_analysis | Recurring Transaction Analysis
-*ProtonApi::PortfolioConstructionApi* | [**mvo**](docs/PortfolioConstructionApi.md#mvo) | **POST** /mvo | MVO
-*ProtonApi::PortfolioManagementApi* | [**rebalancing_signal**](docs/PortfolioManagementApi.md#rebalancing_signal) | **POST** /rebalancing_signal | Rebalancing Signal
-*ProtonApi::RiskScoringApi* | [**dimensional_risk_score**](docs/RiskScoringApi.md#dimensional_risk_score) | **POST** /dimensional_risk_score | Dimensional Risk Score
-*ProtonApi::RiskScoringApi* | [**risk_allocation**](docs/RiskScoringApi.md#risk_allocation) | **POST** /risk_allocation | Risk Allocation
-*ProtonApi::RiskScoringApi* | [**risk_score**](docs/RiskScoringApi.md#risk_score) | **POST** /risk_score | Risk Score
-*ProtonApi::SimulationsApi* | [**backtest**](docs/SimulationsApi.md#backtest) | **POST** /backtest | Backtest
-*ProtonApi::SimulationsApi* | [**event_study**](docs/SimulationsApi.md#event_study) | **POST** /event_study | Event Study
-*ProtonApi::SimulationsApi* | [**monte_carlo**](docs/SimulationsApi.md#monte_carlo) | **POST** /monte_carlo | Monte Carlo
-*ProtonApi::SimulationsApi* | [**portfolio_what_if**](docs/SimulationsApi.md#portfolio_what_if) | **POST** /portfolio_what_if | Porfolio What-If
-*ProtonApi::SimulationsApi* | [**savings_calculator**](docs/SimulationsApi.md#savings_calculator) | **POST** /savings_calculator | Savings Calculator
-*ProtonApi::SimulationsApi* | [**scenario_analysis**](docs/SimulationsApi.md#scenario_analysis) | **POST** /scenario_analysis | Scenario Analysis
-*ProtonApi::SimulationsApi* | [**sensitivity_analysis**](docs/SimulationsApi.md#sensitivity_analysis) | **POST** /sensitivity_analysis | Sensitivity Analysis
-
-
-## Documentation for Models
-
- - [ProtonApi::AccumulationGoalDepositConfig](docs/AccumulationGoalDepositConfig.md)
- - [ProtonApi::AnnuityCalculatorAccumulationHorizonRequest](docs/AnnuityCalculatorAccumulationHorizonRequest.md)
- - [ProtonApi::AnnuityCalculatorAnnuityAmountRequest](docs/AnnuityCalculatorAnnuityAmountRequest.md)
- - [ProtonApi::AnnuityCalculatorDecumulationHorizonRequest](docs/AnnuityCalculatorDecumulationHorizonRequest.md)
- - [ProtonApi::AnnuityCalculatorDepositAmountRequest](docs/AnnuityCalculatorDepositAmountRequest.md)
- - [ProtonApi::AnnuityCalculatorInitialBalanceRequest](docs/AnnuityCalculatorInitialBalanceRequest.md)
- - [ProtonApi::AnnuityDepositSchedule](docs/AnnuityDepositSchedule.md)
- - [ProtonApi::BacktestRequest](docs/BacktestRequest.md)
- - [ProtonApi::BeneficiaryBequestConfig](docs/BeneficiaryBequestConfig.md)
- - [ProtonApi::BudgetAggregationAccount](docs/BudgetAggregationAccount.md)
- - [ProtonApi::BudgetCalculatorRequest](docs/BudgetCalculatorRequest.md)
- - [ProtonApi::BudgetComponent](docs/BudgetComponent.md)
- - [ProtonApi::BudgetDetails](docs/BudgetDetails.md)
- - [ProtonApi::BusinessFinancialHealthCheckRequest](docs/BusinessFinancialHealthCheckRequest.md)
- - [ProtonApi::BusinessInvoiceAnalysisRequest](docs/BusinessInvoiceAnalysisRequest.md)
- - [ProtonApi::CalculatorDepositSchedule](docs/CalculatorDepositSchedule.md)
- - [ProtonApi::CalculatorDepositSchedule1](docs/CalculatorDepositSchedule1.md)
- - [ProtonApi::CardLimitCheckRequest](docs/CardLimitCheckRequest.md)
- - [ProtonApi::CardTransactionAuthorizationRequest](docs/CardTransactionAuthorizationRequest.md)
- - [ProtonApi::CashAnalysisRequest](docs/CashAnalysisRequest.md)
- - [ProtonApi::CashFlowAnalysisRequest](docs/CashFlowAnalysisRequest.md)
- - [ProtonApi::ChildrenEducationConfig](docs/ChildrenEducationConfig.md)
- - [ProtonApi::CustomerAnalysisRequest](docs/CustomerAnalysisRequest.md)
- - [ProtonApi::DecumulationGoalDepositConfig](docs/DecumulationGoalDepositConfig.md)
- - [ProtonApi::DimensionalRiskScoreRequest](docs/DimensionalRiskScoreRequest.md)
- - [ProtonApi::DiversificationScoreRequest](docs/DiversificationScoreRequest.md)
- - [ProtonApi::EducationCalculatorAnnualCostRequest](docs/EducationCalculatorAnnualCostRequest.md)
- - [ProtonApi::EducationCalculatorDepositAmountRequest](docs/EducationCalculatorDepositAmountRequest.md)
- - [ProtonApi::EducationCalculatorPercentCoveredRequest](docs/EducationCalculatorPercentCoveredRequest.md)
- - [ProtonApi::EducationConfig](docs/EducationConfig.md)
- - [ProtonApi::EmergencyFundCalculatorRequest](docs/EmergencyFundCalculatorRequest.md)
- - [ProtonApi::EventStudyRequest](docs/EventStudyRequest.md)
- - [ProtonApi::FeeAnalysisRequest](docs/FeeAnalysisRequest.md)
- - [ProtonApi::FinancialHealthCheckRequest](docs/FinancialHealthCheckRequest.md)
- - [ProtonApi::FinancialPictureRequest](docs/FinancialPictureRequest.md)
- - [ProtonApi::FinancialStatementAnalysisRequest](docs/FinancialStatementAnalysisRequest.md)
- - [ProtonApi::GoalAccumulationAllocationRequest](docs/GoalAccumulationAllocationRequest.md)
- - [ProtonApi::GoalAccumulationRecommendationRequest](docs/GoalAccumulationRecommendationRequest.md)
- - [ProtonApi::GoalAccumulationStatusRequest](docs/GoalAccumulationStatusRequest.md)
- - [ProtonApi::GoalConfig](docs/GoalConfig.md)
- - [ProtonApi::GoalDecumulationAllocationRequest](docs/GoalDecumulationAllocationRequest.md)
- - [ProtonApi::GoalDecumulationRecommendationRequest](docs/GoalDecumulationRecommendationRequest.md)
- - [ProtonApi::GoalDecumulationStatusRequest](docs/GoalDecumulationStatusRequest.md)
- - [ProtonApi::GoalWithdrawalConfig](docs/GoalWithdrawalConfig.md)
- - [ProtonApi::GuaranteedRateBenefit](docs/GuaranteedRateBenefit.md)
- - [ProtonApi::IncomeConfig](docs/IncomeConfig.md)
- - [ProtonApi::LifeInsuranceNeedsCalculatorRequest](docs/LifeInsuranceNeedsCalculatorRequest.md)
- - [ProtonApi::MonteCarloRequest](docs/MonteCarloRequest.md)
- - [ProtonApi::MortgageCalculatorDownPaymentRequest](docs/MortgageCalculatorDownPaymentRequest.md)
- - [ProtonApi::MortgageCalculatorHomePriceRequest](docs/MortgageCalculatorHomePriceRequest.md)
- - [ProtonApi::MortgageCalculatorPeriodicPaymentRequest](docs/MortgageCalculatorPeriodicPaymentRequest.md)
- - [ProtonApi::MvoRequest](docs/MvoRequest.md)
- - [ProtonApi::OptConfig](docs/OptConfig.md)
- - [ProtonApi::OptConfig1](docs/OptConfig1.md)
- - [ProtonApi::Periods](docs/Periods.md)
- - [ProtonApi::PortfolioOptimizationScoreRequest](docs/PortfolioOptimizationScoreRequest.md)
- - [ProtonApi::PortfolioWhatIfRequest](docs/PortfolioWhatIfRequest.md)
- - [ProtonApi::PurchaseCalculatorAmountRequest](docs/PurchaseCalculatorAmountRequest.md)
- - [ProtonApi::PurchaseCalculatorDepositAmountRequest](docs/PurchaseCalculatorDepositAmountRequest.md)
- - [ProtonApi::PurchaseCalculatorHorizonRequest](docs/PurchaseCalculatorHorizonRequest.md)
- - [ProtonApi::RatioTargets](docs/RatioTargets.md)
- - [ProtonApi::RatioTargets1](docs/RatioTargets1.md)
- - [ProtonApi::RebalancingSignalRequest](docs/RebalancingSignalRequest.md)
- - [ProtonApi::RecommendationConfig](docs/RecommendationConfig.md)
- - [ProtonApi::RecommendationConfig1](docs/RecommendationConfig1.md)
- - [ProtonApi::RecurringTransactionAnalysisRequest](docs/RecurringTransactionAnalysisRequest.md)
- - [ProtonApi::RetirementCalculatorDepositAmountRequest](docs/RetirementCalculatorDepositAmountRequest.md)
- - [ProtonApi::RetirementCalculatorExpensesRequest](docs/RetirementCalculatorExpensesRequest.md)
- - [ProtonApi::RetirementCalculatorPercentCoveredRequest](docs/RetirementCalculatorPercentCoveredRequest.md)
- - [ProtonApi::RiskAllocationRequest](docs/RiskAllocationRequest.md)
- - [ProtonApi::RiskScoreRequest](docs/RiskScoreRequest.md)
- - [ProtonApi::SavingsCalculatorRequest](docs/SavingsCalculatorRequest.md)
- - [ProtonApi::SavingsDepositSchedule](docs/SavingsDepositSchedule.md)
- - [ProtonApi::ScenarioAnalysisRequest](docs/ScenarioAnalysisRequest.md)
- - [ProtonApi::SensitivityAnalysisRequest](docs/SensitivityAnalysisRequest.md)
- - [ProtonApi::SensitivityFactor](docs/SensitivityFactor.md)
- - [ProtonApi::Settings](docs/Settings.md)
- - [ProtonApi::VariableAnnuityRequest](docs/VariableAnnuityRequest.md)
- - [ProtonApi::WConfig](docs/WConfig.md)
- - [ProtonApi::WConfig1](docs/WConfig1.md)
-
-
-## Documentation for Authorization
-
-
-### oauth2
-
-- **Type**: OAuth
-- **Flow**: application
-- **Authorization URL**: 
-- **Scopes**: N/A
+https://www.hydrogenplatform.com
 
+*Generated using [Swagger Codegen](https://github.com/swagger-api/swagger-codegen)*

data/lib/proton_api.rb

@@ -3,10 +3,10 @@
 
 #Financial engineering module of Hydrogen Atom
 
-OpenAPI spec version: 1.8.0
+OpenAPI spec version: 1.9.0
 Contact: info@hydrogenplatform.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.17
+Swagger Codegen version: 2.4.19
 
 =end
 
@@ -25,6 +25,7 @@ require 'proton_api/models/annuity_calculator_decumulation_horizon_request'
 require 'proton_api/models/annuity_calculator_deposit_amount_request'
 require 'proton_api/models/annuity_calculator_initial_balance_request'
 require 'proton_api/models/annuity_deposit_schedule'
+require 'proton_api/models/answer'
 require 'proton_api/models/backtest_request'
 require 'proton_api/models/beneficiary_bequest_config'
 require 'proton_api/models/budget_aggregation_account'
@@ -35,12 +36,14 @@ require 'proton_api/models/business_financial_health_check_request'
 require 'proton_api/models/business_invoice_analysis_request'
 require 'proton_api/models/calculator_deposit_schedule'
 require 'proton_api/models/calculator_deposit_schedule1'
+require 'proton_api/models/card_analysis_request'
 require 'proton_api/models/card_limit_check_request'
 require 'proton_api/models/card_transaction_authorization_request'
 require 'proton_api/models/cash_analysis_request'
 require 'proton_api/models/cash_flow_analysis_request'
 require 'proton_api/models/children_education_config'
 require 'proton_api/models/customer_analysis_request'
+require 'proton_api/models/decision_tree_result_request'
 require 'proton_api/models/decumulation_goal_deposit_config'
 require 'proton_api/models/dimensional_risk_score_request'
 require 'proton_api/models/diversification_score_request'
@@ -65,6 +68,7 @@ require 'proton_api/models/goal_withdrawal_config'
 require 'proton_api/models/guaranteed_rate_benefit'
 require 'proton_api/models/income_config'
 require 'proton_api/models/life_insurance_needs_calculator_request'
+require 'proton_api/models/location'
 require 'proton_api/models/monte_carlo_request'
 require 'proton_api/models/mortgage_calculator_down_payment_request'
 require 'proton_api/models/mortgage_calculator_home_price_request'
@@ -72,6 +76,8 @@ require 'proton_api/models/mortgage_calculator_periodic_payment_request'
 require 'proton_api/models/mvo_request'
 require 'proton_api/models/opt_config'
 require 'proton_api/models/opt_config1'
+require 'proton_api/models/order_rebalance_request'
+require 'proton_api/models/performance_calculator_request'
 require 'proton_api/models/periods'
 require 'proton_api/models/portfolio_optimization_score_request'
 require 'proton_api/models/portfolio_what_if_request'
@@ -95,6 +101,7 @@ require 'proton_api/models/scenario_analysis_request'
 require 'proton_api/models/sensitivity_analysis_request'
 require 'proton_api/models/sensitivity_factor'
 require 'proton_api/models/settings'
+require 'proton_api/models/spending_analysis_request'
 require 'proton_api/models/variable_annuity_request'
 require 'proton_api/models/w_config'
 require 'proton_api/models/w_config1'
@@ -112,6 +119,7 @@ require 'proton_api/api/portfolio_construction_api'
 require 'proton_api/api/portfolio_management_api'
 require 'proton_api/api/risk_scoring_api'
 require 'proton_api/api/simulations_api'
+require 'proton_api/api/util_api'
 
 module ProtonApi
   class << self

data/lib/proton_api/api/annuities_api.rb

@@ -3,10 +3,10 @@
 
 #Financial engineering module of Hydrogen Atom
 
-OpenAPI spec version: 1.8.0
+OpenAPI spec version: 1.9.0
 Contact: info@hydrogenplatform.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.17
+Swagger Codegen version: 2.4.19
 
 =end
 

data/lib/proton_api/api/business_financial_management_api.rb

@@ -3,10 +3,10 @@
 
 #Financial engineering module of Hydrogen Atom
 
-OpenAPI spec version: 1.8.0
+OpenAPI spec version: 1.9.0
 Contact: info@hydrogenplatform.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.17
+Swagger Codegen version: 2.4.19
 
 =end
 

data/lib/proton_api/api/cards_api.rb

@@ -3,10 +3,10 @@
 
 #Financial engineering module of Hydrogen Atom
 
-OpenAPI spec version: 1.8.0
+OpenAPI spec version: 1.9.0
 Contact: info@hydrogenplatform.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.17
+Swagger Codegen version: 2.4.19
 
 =end
 
@@ -19,6 +19,60 @@ module ProtonApi
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Card Analysis
+    # Analyze cardholder activity over time
+    # @param card_analysis_request Request payload for Card Analysis
+    # @param [Hash] opts the optional parameters
+    # @return [Hash<String, Object>]
+    def card_analysis(card_analysis_request, opts = {})
+      data, _status_code, _headers = card_analysis_with_http_info(card_analysis_request, opts)
+      data
+    end
+
+    # Card Analysis
+    # Analyze cardholder activity over time
+    # @param card_analysis_request Request payload for Card Analysis
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Hash<String, Object>, Fixnum, Hash)>] Hash<String, Object> data, response status code and response headers
+    def card_analysis_with_http_info(card_analysis_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CardsApi.card_analysis ...'
+      end
+      # verify the required parameter 'card_analysis_request' is set
+      if @api_client.config.client_side_validation && card_analysis_request.nil?
+        fail ArgumentError, "Missing the required parameter 'card_analysis_request' when calling CardsApi.card_analysis"
+      end
+      # resource path
+      local_var_path = '/card_analysis'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(card_analysis_request)
+      auth_names = ['oauth2']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Hash<String, Object>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CardsApi#card_analysis\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Card Limit Check
     # Evaluate card transaction history against spending controls
     # @param card_limit_check_request Request payload for Card Limit Check