proton_api 1.8.0 → 1.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +35 -205
- data/lib/proton_api.rb +10 -2
- data/lib/proton_api/api/annuities_api.rb +2 -2
- data/lib/proton_api/api/business_financial_management_api.rb +2 -2
- data/lib/proton_api/api/cards_api.rb +56 -2
- data/lib/proton_api/api/financial_health_api.rb +2 -2
- data/lib/proton_api/api/financial_planning_api.rb +2 -2
- data/lib/proton_api/api/goals_api.rb +2 -2
- data/lib/proton_api/api/life_insurance_api.rb +2 -2
- data/lib/proton_api/api/personal_financial_management_api.rb +56 -2
- data/lib/proton_api/api/portfolio_construction_api.rb +2 -2
- data/lib/proton_api/api/portfolio_management_api.rb +2 -2
- data/lib/proton_api/api/risk_scoring_api.rb +2 -2
- data/lib/proton_api/api/simulations_api.rb +2 -2
- data/lib/proton_api/api/util_api.rb +185 -0
- data/lib/proton_api/api_client.rb +6 -6
- data/lib/proton_api/api_error.rb +2 -2
- data/lib/proton_api/configuration.rb +3 -3
- data/lib/proton_api/models/accumulation_goal_deposit_config.rb +25 -25
- data/lib/proton_api/models/annuity_calculator_accumulation_horizon_request.rb +138 -141
- data/lib/proton_api/models/annuity_calculator_annuity_amount_request.rb +129 -132
- data/lib/proton_api/models/annuity_calculator_decumulation_horizon_request.rb +138 -141
- data/lib/proton_api/models/annuity_calculator_deposit_amount_request.rb +138 -141
- data/lib/proton_api/models/annuity_calculator_initial_balance_request.rb +138 -141
- data/lib/proton_api/models/annuity_deposit_schedule.rb +33 -36
- data/lib/proton_api/models/answer.rb +186 -0
- data/lib/proton_api/models/backtest_request.rb +56 -59
- data/lib/proton_api/models/beneficiary_bequest_config.rb +32 -35
- data/lib/proton_api/models/budget_aggregation_account.rb +7 -10
- data/lib/proton_api/models/budget_calculator_request.rb +85 -66
- data/lib/proton_api/models/budget_component.rb +25 -28
- data/lib/proton_api/models/budget_details.rb +75 -78
- data/lib/proton_api/models/business_financial_health_check_request.rb +172 -166
- data/lib/proton_api/models/business_invoice_analysis_request.rb +79 -73
- data/lib/proton_api/models/calculator_deposit_schedule.rb +22 -25
- data/lib/proton_api/models/calculator_deposit_schedule1.rb +33 -36
- data/lib/proton_api/models/card_analysis_request.rb +372 -0
- data/lib/proton_api/models/card_limit_check_request.rb +42 -14
- data/lib/proton_api/models/card_transaction_authorization_request.rb +143 -80
- data/lib/proton_api/models/cash_analysis_request.rb +82 -63
- data/lib/proton_api/models/cash_flow_analysis_request.rb +104 -76
- data/lib/proton_api/models/children_education_config.rb +7 -10
- data/lib/proton_api/models/customer_analysis_request.rb +60 -54
- data/lib/proton_api/models/decision_tree_result_request.rb +236 -0
- data/lib/proton_api/models/decumulation_goal_deposit_config.rb +28 -31
- data/lib/proton_api/models/dimensional_risk_score_request.rb +52 -55
- data/lib/proton_api/models/diversification_score_request.rb +59 -62
- data/lib/proton_api/models/education_calculator_annual_cost_request.rb +143 -146
- data/lib/proton_api/models/education_calculator_deposit_amount_request.rb +170 -173
- data/lib/proton_api/models/education_calculator_percent_covered_request.rb +136 -139
- data/lib/proton_api/models/education_config.rb +44 -47
- data/lib/proton_api/models/emergency_fund_calculator_request.rb +182 -185
- data/lib/proton_api/models/event_study_request.rb +64 -67
- data/lib/proton_api/models/fee_analysis_request.rb +42 -34
- data/lib/proton_api/models/financial_health_check_request.rb +109 -112
- data/lib/proton_api/models/financial_picture_request.rb +53 -52
- data/lib/proton_api/models/financial_statement_analysis_request.rb +140 -134
- data/lib/proton_api/models/goal_accumulation_allocation_request.rb +271 -274
- data/lib/proton_api/models/goal_accumulation_recommendation_request.rb +218 -221
- data/lib/proton_api/models/goal_accumulation_status_request.rb +218 -221
- data/lib/proton_api/models/goal_config.rb +35 -38
- data/lib/proton_api/models/goal_decumulation_allocation_request.rb +293 -296
- data/lib/proton_api/models/goal_decumulation_recommendation_request.rb +242 -245
- data/lib/proton_api/models/goal_decumulation_status_request.rb +242 -245
- data/lib/proton_api/models/goal_withdrawal_config.rb +82 -85
- data/lib/proton_api/models/guaranteed_rate_benefit.rb +51 -54
- data/lib/proton_api/models/income_config.rb +37 -40
- data/lib/proton_api/models/life_insurance_needs_calculator_request.rb +152 -155
- data/lib/proton_api/models/location.rb +183 -0
- data/lib/proton_api/models/monte_carlo_request.rb +157 -160
- data/lib/proton_api/models/mortgage_calculator_down_payment_request.rb +46 -49
- data/lib/proton_api/models/mortgage_calculator_home_price_request.rb +46 -49
- data/lib/proton_api/models/mortgage_calculator_periodic_payment_request.rb +71 -74
- data/lib/proton_api/models/mvo_request.rb +88 -91
- data/lib/proton_api/models/opt_config.rb +54 -57
- data/lib/proton_api/models/opt_config1.rb +29 -32
- data/lib/proton_api/models/order_rebalance_request.rb +398 -0
- data/lib/proton_api/models/performance_calculator_request.rb +687 -0
- data/lib/proton_api/models/periods.rb +7 -10
- data/lib/proton_api/models/portfolio_optimization_score_request.rb +68 -71
- data/lib/proton_api/models/portfolio_what_if_request.rb +71 -74
- data/lib/proton_api/models/purchase_calculator_amount_request.rb +112 -115
- data/lib/proton_api/models/purchase_calculator_deposit_amount_request.rb +136 -139
- data/lib/proton_api/models/purchase_calculator_horizon_request.rb +100 -103
- data/lib/proton_api/models/ratio_targets.rb +79 -82
- data/lib/proton_api/models/ratio_targets1.rb +38 -41
- data/lib/proton_api/models/rebalancing_signal_request.rb +26 -29
- data/lib/proton_api/models/recommendation_config.rb +104 -107
- data/lib/proton_api/models/recommendation_config1.rb +100 -103
- data/lib/proton_api/models/recurring_transaction_analysis_request.rb +106 -76
- data/lib/proton_api/models/retirement_calculator_deposit_amount_request.rb +148 -151
- data/lib/proton_api/models/retirement_calculator_expenses_request.rb +119 -122
- data/lib/proton_api/models/retirement_calculator_percent_covered_request.rb +132 -135
- data/lib/proton_api/models/risk_allocation_request.rb +53 -56
- data/lib/proton_api/models/risk_score_request.rb +37 -40
- data/lib/proton_api/models/savings_calculator_request.rb +100 -103
- data/lib/proton_api/models/savings_deposit_schedule.rb +22 -25
- data/lib/proton_api/models/scenario_analysis_request.rb +81 -84
- data/lib/proton_api/models/sensitivity_analysis_request.rb +77 -80
- data/lib/proton_api/models/sensitivity_factor.rb +58 -61
- data/lib/proton_api/models/settings.rb +38 -41
- data/lib/proton_api/models/spending_analysis_request.rb +505 -0
- data/lib/proton_api/models/variable_annuity_request.rb +284 -287
- data/lib/proton_api/models/w_config.rb +77 -80
- data/lib/proton_api/models/w_config1.rb +66 -69
- data/lib/proton_api/version.rb +3 -3
- data/proton_api.gemspec +2 -2
- data/spec/api/annuities_api_spec.rb +2 -2
- data/spec/api/business_financial_management_api_spec.rb +2 -2
- data/spec/api/cards_api_spec.rb +14 -2
- data/spec/api/financial_health_api_spec.rb +2 -2
- data/spec/api/financial_planning_api_spec.rb +2 -2
- data/spec/api/goals_api_spec.rb +2 -2
- data/spec/api/life_insurance_api_spec.rb +2 -2
- data/spec/api/personal_financial_management_api_spec.rb +14 -2
- data/spec/api/portfolio_construction_api_spec.rb +2 -2
- data/spec/api/portfolio_management_api_spec.rb +2 -2
- data/spec/api/risk_scoring_api_spec.rb +2 -2
- data/spec/api/simulations_api_spec.rb +2 -2
- data/spec/api/util_api_spec.rb +71 -0
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +5 -5
- data/spec/models/accumulation_goal_deposit_config_spec.rb +10 -10
- data/spec/models/annuity_calculator_accumulation_horizon_request_spec.rb +17 -17
- data/spec/models/annuity_calculator_annuity_amount_request_spec.rb +17 -17
- data/spec/models/annuity_calculator_decumulation_horizon_request_spec.rb +17 -17
- data/spec/models/annuity_calculator_deposit_amount_request_spec.rb +17 -17
- data/spec/models/annuity_calculator_initial_balance_request_spec.rb +17 -17
- data/spec/models/annuity_deposit_schedule_spec.rb +4 -4
- data/spec/models/answer_spec.rb +41 -0
- data/spec/models/backtest_request_spec.rb +10 -10
- data/spec/models/beneficiary_bequest_config_spec.rb +4 -4
- data/spec/models/budget_aggregation_account_spec.rb +2 -2
- data/spec/models/budget_calculator_request_spec.rb +25 -13
- data/spec/models/budget_component_spec.rb +4 -4
- data/spec/models/budget_details_spec.rb +15 -15
- data/spec/models/business_financial_health_check_request_spec.rb +34 -28
- data/spec/models/business_invoice_analysis_request_spec.rb +18 -12
- data/spec/models/calculator_deposit_schedule1_spec.rb +4 -4
- data/spec/models/calculator_deposit_schedule_spec.rb +8 -8
- data/spec/models/card_analysis_request_spec.rb +129 -0
- data/spec/models/card_limit_check_request_spec.rb +20 -2
- data/spec/models/card_transaction_authorization_request_spec.rb +57 -15
- data/spec/models/cash_analysis_request_spec.rb +25 -13
- data/spec/models/cash_flow_analysis_request_spec.rb +34 -16
- data/spec/models/children_education_config_spec.rb +2 -2
- data/spec/models/customer_analysis_request_spec.rb +15 -9
- data/spec/models/decision_tree_result_request_spec.rb +51 -0
- data/spec/models/decumulation_goal_deposit_config_spec.rb +10 -10
- data/spec/models/dimensional_risk_score_request_spec.rb +8 -8
- data/spec/models/diversification_score_request_spec.rb +14 -14
- data/spec/models/education_calculator_annual_cost_request_spec.rb +13 -13
- data/spec/models/education_calculator_deposit_amount_request_spec.rb +13 -13
- data/spec/models/education_calculator_percent_covered_request_spec.rb +12 -12
- data/spec/models/education_config_spec.rb +5 -5
- data/spec/models/emergency_fund_calculator_request_spec.rb +23 -23
- data/spec/models/event_study_request_spec.rb +17 -17
- data/spec/models/fee_analysis_request_spec.rb +12 -6
- data/spec/models/financial_health_check_request_spec.rb +12 -12
- data/spec/models/financial_picture_request_spec.rb +15 -9
- data/spec/models/financial_statement_analysis_request_spec.rb +39 -33
- data/spec/models/goal_accumulation_allocation_request_spec.rb +48 -48
- data/spec/models/goal_accumulation_recommendation_request_spec.rb +34 -34
- data/spec/models/goal_accumulation_status_request_spec.rb +34 -34
- data/spec/models/goal_config_spec.rb +4 -4
- data/spec/models/goal_decumulation_allocation_request_spec.rb +51 -51
- data/spec/models/goal_decumulation_recommendation_request_spec.rb +35 -35
- data/spec/models/goal_decumulation_status_request_spec.rb +35 -35
- data/spec/models/goal_withdrawal_config_spec.rb +20 -20
- data/spec/models/guaranteed_rate_benefit_spec.rb +5 -5
- data/spec/models/income_config_spec.rb +4 -4
- data/spec/models/life_insurance_needs_calculator_request_spec.rb +16 -16
- data/spec/models/location_spec.rb +41 -0
- data/spec/models/monte_carlo_request_spec.rb +31 -31
- data/spec/models/mortgage_calculator_down_payment_request_spec.rb +6 -6
- data/spec/models/mortgage_calculator_home_price_request_spec.rb +6 -6
- data/spec/models/mortgage_calculator_periodic_payment_request_spec.rb +6 -6
- data/spec/models/mvo_request_spec.rb +23 -23
- data/spec/models/opt_config1_spec.rb +10 -10
- data/spec/models/opt_config_spec.rb +13 -13
- data/spec/models/order_rebalance_request_spec.rb +123 -0
- data/spec/models/performance_calculator_request_spec.rb +233 -0
- data/spec/models/periods_spec.rb +2 -2
- data/spec/models/portfolio_optimization_score_request_spec.rb +16 -16
- data/spec/models/portfolio_what_if_request_spec.rb +16 -16
- data/spec/models/purchase_calculator_amount_request_spec.rb +14 -14
- data/spec/models/purchase_calculator_deposit_amount_request_spec.rb +16 -16
- data/spec/models/purchase_calculator_horizon_request_spec.rb +10 -10
- data/spec/models/ratio_targets1_spec.rb +4 -4
- data/spec/models/ratio_targets_spec.rb +8 -8
- data/spec/models/rebalancing_signal_request_spec.rb +6 -6
- data/spec/models/recommendation_config1_spec.rb +9 -9
- data/spec/models/recommendation_config_spec.rb +9 -9
- data/spec/models/recurring_transaction_analysis_request_spec.rb +33 -15
- data/spec/models/retirement_calculator_deposit_amount_request_spec.rb +13 -13
- data/spec/models/retirement_calculator_expenses_request_spec.rb +12 -12
- data/spec/models/retirement_calculator_percent_covered_request_spec.rb +12 -12
- data/spec/models/risk_allocation_request_spec.rb +15 -15
- data/spec/models/risk_score_request_spec.rb +8 -8
- data/spec/models/savings_calculator_request_spec.rb +16 -16
- data/spec/models/savings_deposit_schedule_spec.rb +8 -8
- data/spec/models/scenario_analysis_request_spec.rb +19 -19
- data/spec/models/sensitivity_analysis_request_spec.rb +23 -23
- data/spec/models/sensitivity_factor_spec.rb +6 -6
- data/spec/models/settings_spec.rb +13 -13
- data/spec/models/spending_analysis_request_spec.rb +187 -0
- data/spec/models/variable_annuity_request_spec.rb +40 -40
- data/spec/models/w_config1_spec.rb +6 -6
- data/spec/models/w_config_spec.rb +7 -7
- data/spec/spec_helper.rb +2 -2
- metadata +26 -94
- data/docs/AccumulationGoalDepositConfig.md +0 -14
- data/docs/AnnuitiesApi.md +0 -344
- data/docs/AnnuityCalculatorAccumulationHorizonRequest.md +0 -19
- data/docs/AnnuityCalculatorAnnuityAmountRequest.md +0 -19
- data/docs/AnnuityCalculatorDecumulationHorizonRequest.md +0 -19
- data/docs/AnnuityCalculatorDepositAmountRequest.md +0 -19
- data/docs/AnnuityCalculatorInitialBalanceRequest.md +0 -19
- data/docs/AnnuityDepositSchedule.md +0 -10
- data/docs/BacktestRequest.md +0 -17
- data/docs/BeneficiaryBequestConfig.md +0 -10
- data/docs/BudgetAggregationAccount.md +0 -8
- data/docs/BudgetCalculatorRequest.md +0 -16
- data/docs/BudgetComponent.md +0 -10
- data/docs/BudgetDetails.md +0 -17
- data/docs/BusinessFinancialHealthCheckRequest.md +0 -22
- data/docs/BusinessFinancialManagementApi.md +0 -288
- data/docs/BusinessInvoiceAnalysisRequest.md +0 -20
- data/docs/CalculatorDepositSchedule.md +0 -9
- data/docs/CalculatorDepositSchedule1.md +0 -10
- data/docs/CardLimitCheckRequest.md +0 -9
- data/docs/CardTransactionAuthorizationRequest.md +0 -19
- data/docs/CardsApi.md +0 -120
- data/docs/CashAnalysisRequest.md +0 -17
- data/docs/CashFlowAnalysisRequest.md +0 -20
- data/docs/ChildrenEducationConfig.md +0 -9
- data/docs/CustomerAnalysisRequest.md +0 -17
- data/docs/DecumulationGoalDepositConfig.md +0 -14
- data/docs/DimensionalRiskScoreRequest.md +0 -16
- data/docs/DiversificationScoreRequest.md +0 -19
- data/docs/EducationCalculatorAnnualCostRequest.md +0 -18
- data/docs/EducationCalculatorDepositAmountRequest.md +0 -19
- data/docs/EducationCalculatorPercentCoveredRequest.md +0 -18
- data/docs/EducationConfig.md +0 -10
- data/docs/EmergencyFundCalculatorRequest.md +0 -24
- data/docs/EventStudyRequest.md +0 -18
- data/docs/FeeAnalysisRequest.md +0 -13
- data/docs/FinancialHealthApi.md +0 -232
- data/docs/FinancialHealthCheckRequest.md +0 -17
- data/docs/FinancialPictureRequest.md +0 -16
- data/docs/FinancialPlanningApi.md +0 -680
- data/docs/FinancialStatementAnalysisRequest.md +0 -22
- data/docs/GoalAccumulationAllocationRequest.md +0 -33
- data/docs/GoalAccumulationRecommendationRequest.md +0 -28
- data/docs/GoalAccumulationStatusRequest.md +0 -28
- data/docs/GoalConfig.md +0 -9
- data/docs/GoalDecumulationAllocationRequest.md +0 -34
- data/docs/GoalDecumulationRecommendationRequest.md +0 -29
- data/docs/GoalDecumulationStatusRequest.md +0 -29
- data/docs/GoalWithdrawalConfig.md +0 -14
- data/docs/GoalsApi.md +0 -344
- data/docs/GuaranteedRateBenefit.md +0 -11
- data/docs/IncomeConfig.md +0 -10
- data/docs/LifeInsuranceApi.md +0 -64
- data/docs/LifeInsuranceNeedsCalculatorRequest.md +0 -22
- data/docs/MonteCarloRequest.md +0 -29
- data/docs/MortgageCalculatorDownPaymentRequest.md +0 -11
- data/docs/MortgageCalculatorHomePriceRequest.md +0 -11
- data/docs/MortgageCalculatorPeriodicPaymentRequest.md +0 -11
- data/docs/MvoRequest.md +0 -18
- data/docs/OptConfig.md +0 -14
- data/docs/OptConfig1.md +0 -12
- data/docs/Periods.md +0 -9
- data/docs/PersonalFinancialManagementApi.md +0 -288
- data/docs/PortfolioConstructionApi.md +0 -64
- data/docs/PortfolioManagementApi.md +0 -64
- data/docs/PortfolioOptimizationScoreRequest.md +0 -21
- data/docs/PortfolioWhatIfRequest.md +0 -21
- data/docs/PurchaseCalculatorAmountRequest.md +0 -16
- data/docs/PurchaseCalculatorDepositAmountRequest.md +0 -17
- data/docs/PurchaseCalculatorHorizonRequest.md +0 -15
- data/docs/RatioTargets.md +0 -13
- data/docs/RatioTargets1.md +0 -13
- data/docs/RebalancingSignalRequest.md +0 -13
- data/docs/RecommendationConfig.md +0 -15
- data/docs/RecommendationConfig1.md +0 -14
- data/docs/RecurringTransactionAnalysisRequest.md +0 -19
- data/docs/RetirementCalculatorDepositAmountRequest.md +0 -20
- data/docs/RetirementCalculatorExpensesRequest.md +0 -19
- data/docs/RetirementCalculatorPercentCoveredRequest.md +0 -19
- data/docs/RiskAllocationRequest.md +0 -14
- data/docs/RiskScoreRequest.md +0 -13
- data/docs/RiskScoringApi.md +0 -176
- data/docs/SavingsCalculatorRequest.md +0 -17
- data/docs/SavingsDepositSchedule.md +0 -11
- data/docs/ScenarioAnalysisRequest.md +0 -22
- data/docs/SensitivityAnalysisRequest.md +0 -22
- data/docs/SensitivityFactor.md +0 -11
- data/docs/Settings.md +0 -13
- data/docs/SimulationsApi.md +0 -400
- data/docs/VariableAnnuityRequest.md +0 -34
- data/docs/WConfig.md +0 -12
- data/docs/WConfig1.md +0 -12
|
@@ -3,10 +3,10 @@
|
|
|
3
3
|
|
|
4
4
|
#Financial engineering module of Hydrogen Atom
|
|
5
5
|
|
|
6
|
-
OpenAPI spec version: 1.
|
|
6
|
+
OpenAPI spec version: 1.9.0
|
|
7
7
|
Contact: info@hydrogenplatform.com
|
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
|
-
Swagger Codegen version: 2.4.
|
|
9
|
+
Swagger Codegen version: 2.4.19
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -16,46 +16,46 @@ module ProtonApi
|
|
|
16
16
|
class RetirementCalculatorDepositAmountRequest
|
|
17
17
|
attr_accessor :retirement_savings
|
|
18
18
|
|
|
19
|
-
attr_accessor :aggregation_account_ids
|
|
20
|
-
|
|
21
|
-
attr_accessor :retirement_age
|
|
22
|
-
|
|
23
|
-
attr_accessor :retirement_income
|
|
24
|
-
|
|
25
|
-
attr_accessor :retirement_expenses
|
|
26
|
-
|
|
27
19
|
attr_accessor :current_age
|
|
28
20
|
|
|
29
21
|
attr_accessor :account_ids
|
|
30
22
|
|
|
31
|
-
attr_accessor :
|
|
23
|
+
attr_accessor :retirement_income
|
|
32
24
|
|
|
33
|
-
attr_accessor :
|
|
25
|
+
attr_accessor :retirement_tax
|
|
34
26
|
|
|
35
27
|
attr_accessor :death_age
|
|
36
28
|
|
|
29
|
+
attr_accessor :retirement_age
|
|
30
|
+
|
|
31
|
+
attr_accessor :percent_of_expenses_covered
|
|
32
|
+
|
|
37
33
|
attr_accessor :portfolio_return
|
|
38
34
|
|
|
35
|
+
attr_accessor :retirement_expenses
|
|
36
|
+
|
|
39
37
|
attr_accessor :deposit_schedule
|
|
40
38
|
|
|
41
|
-
attr_accessor :
|
|
39
|
+
attr_accessor :inflation_rate
|
|
40
|
+
|
|
41
|
+
attr_accessor :aggregation_account_ids
|
|
42
42
|
|
|
43
43
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
44
44
|
def self.attribute_map
|
|
45
45
|
{
|
|
46
46
|
:'retirement_savings' => :'retirement_savings',
|
|
47
|
-
:'aggregation_account_ids' => :'aggregation_account_ids',
|
|
48
|
-
:'retirement_age' => :'retirement_age',
|
|
49
|
-
:'retirement_income' => :'retirement_income',
|
|
50
|
-
:'retirement_expenses' => :'retirement_expenses',
|
|
51
47
|
:'current_age' => :'current_age',
|
|
52
48
|
:'account_ids' => :'account_ids',
|
|
49
|
+
:'retirement_income' => :'retirement_income',
|
|
53
50
|
:'retirement_tax' => :'retirement_tax',
|
|
54
|
-
:'inflation_rate' => :'inflation_rate',
|
|
55
51
|
:'death_age' => :'death_age',
|
|
52
|
+
:'retirement_age' => :'retirement_age',
|
|
53
|
+
:'percent_of_expenses_covered' => :'percent_of_expenses_covered',
|
|
56
54
|
:'portfolio_return' => :'portfolio_return',
|
|
55
|
+
:'retirement_expenses' => :'retirement_expenses',
|
|
57
56
|
:'deposit_schedule' => :'deposit_schedule',
|
|
58
|
-
:'
|
|
57
|
+
:'inflation_rate' => :'inflation_rate',
|
|
58
|
+
:'aggregation_account_ids' => :'aggregation_account_ids'
|
|
59
59
|
}
|
|
60
60
|
end
|
|
61
61
|
|
|
@@ -63,18 +63,18 @@ module ProtonApi
|
|
|
63
63
|
def self.swagger_types
|
|
64
64
|
{
|
|
65
65
|
:'retirement_savings' => :'Float',
|
|
66
|
-
:'aggregation_account_ids' => :'Array<String>',
|
|
67
|
-
:'retirement_age' => :'Integer',
|
|
68
|
-
:'retirement_income' => :'Float',
|
|
69
|
-
:'retirement_expenses' => :'Float',
|
|
70
66
|
:'current_age' => :'Integer',
|
|
71
67
|
:'account_ids' => :'Array<String>',
|
|
68
|
+
:'retirement_income' => :'Float',
|
|
72
69
|
:'retirement_tax' => :'Float',
|
|
73
|
-
:'inflation_rate' => :'Float',
|
|
74
70
|
:'death_age' => :'Integer',
|
|
71
|
+
:'retirement_age' => :'Integer',
|
|
72
|
+
:'percent_of_expenses_covered' => :'Float',
|
|
75
73
|
:'portfolio_return' => :'Float',
|
|
74
|
+
:'retirement_expenses' => :'Float',
|
|
76
75
|
:'deposit_schedule' => :'CalculatorDepositSchedule',
|
|
77
|
-
:'
|
|
76
|
+
:'inflation_rate' => :'Float',
|
|
77
|
+
:'aggregation_account_ids' => :'Array<String>'
|
|
78
78
|
}
|
|
79
79
|
end
|
|
80
80
|
|
|
@@ -92,28 +92,6 @@ module ProtonApi
|
|
|
92
92
|
self.retirement_savings = 0.0
|
|
93
93
|
end
|
|
94
94
|
|
|
95
|
-
if attributes.has_key?(:'aggregation_account_ids')
|
|
96
|
-
if (value = attributes[:'aggregation_account_ids']).is_a?(Array)
|
|
97
|
-
self.aggregation_account_ids = value
|
|
98
|
-
end
|
|
99
|
-
end
|
|
100
|
-
|
|
101
|
-
if attributes.has_key?(:'retirement_age')
|
|
102
|
-
self.retirement_age = attributes[:'retirement_age']
|
|
103
|
-
else
|
|
104
|
-
self.retirement_age = 65
|
|
105
|
-
end
|
|
106
|
-
|
|
107
|
-
if attributes.has_key?(:'retirement_income')
|
|
108
|
-
self.retirement_income = attributes[:'retirement_income']
|
|
109
|
-
else
|
|
110
|
-
self.retirement_income = 0.0
|
|
111
|
-
end
|
|
112
|
-
|
|
113
|
-
if attributes.has_key?(:'retirement_expenses')
|
|
114
|
-
self.retirement_expenses = attributes[:'retirement_expenses']
|
|
115
|
-
end
|
|
116
|
-
|
|
117
95
|
if attributes.has_key?(:'current_age')
|
|
118
96
|
self.current_age = attributes[:'current_age']
|
|
119
97
|
end
|
|
@@ -124,34 +102,56 @@ module ProtonApi
|
|
|
124
102
|
end
|
|
125
103
|
end
|
|
126
104
|
|
|
105
|
+
if attributes.has_key?(:'retirement_income')
|
|
106
|
+
self.retirement_income = attributes[:'retirement_income']
|
|
107
|
+
else
|
|
108
|
+
self.retirement_income = 0.0
|
|
109
|
+
end
|
|
110
|
+
|
|
127
111
|
if attributes.has_key?(:'retirement_tax')
|
|
128
112
|
self.retirement_tax = attributes[:'retirement_tax']
|
|
129
113
|
else
|
|
130
114
|
self.retirement_tax = 0.0
|
|
131
115
|
end
|
|
132
116
|
|
|
133
|
-
if attributes.has_key?(:'
|
|
134
|
-
self.
|
|
117
|
+
if attributes.has_key?(:'death_age')
|
|
118
|
+
self.death_age = attributes[:'death_age']
|
|
119
|
+
end
|
|
120
|
+
|
|
121
|
+
if attributes.has_key?(:'retirement_age')
|
|
122
|
+
self.retirement_age = attributes[:'retirement_age']
|
|
135
123
|
else
|
|
136
|
-
self.
|
|
124
|
+
self.retirement_age = 65
|
|
137
125
|
end
|
|
138
126
|
|
|
139
|
-
if attributes.has_key?(:'
|
|
140
|
-
self.
|
|
127
|
+
if attributes.has_key?(:'percent_of_expenses_covered')
|
|
128
|
+
self.percent_of_expenses_covered = attributes[:'percent_of_expenses_covered']
|
|
129
|
+
else
|
|
130
|
+
self.percent_of_expenses_covered = 1.0
|
|
141
131
|
end
|
|
142
132
|
|
|
143
133
|
if attributes.has_key?(:'portfolio_return')
|
|
144
134
|
self.portfolio_return = attributes[:'portfolio_return']
|
|
145
135
|
end
|
|
146
136
|
|
|
137
|
+
if attributes.has_key?(:'retirement_expenses')
|
|
138
|
+
self.retirement_expenses = attributes[:'retirement_expenses']
|
|
139
|
+
end
|
|
140
|
+
|
|
147
141
|
if attributes.has_key?(:'deposit_schedule')
|
|
148
142
|
self.deposit_schedule = attributes[:'deposit_schedule']
|
|
149
143
|
end
|
|
150
144
|
|
|
151
|
-
if attributes.has_key?(:'
|
|
152
|
-
self.
|
|
145
|
+
if attributes.has_key?(:'inflation_rate')
|
|
146
|
+
self.inflation_rate = attributes[:'inflation_rate']
|
|
153
147
|
else
|
|
154
|
-
self.
|
|
148
|
+
self.inflation_rate = 0.0
|
|
149
|
+
end
|
|
150
|
+
|
|
151
|
+
if attributes.has_key?(:'aggregation_account_ids')
|
|
152
|
+
if (value = attributes[:'aggregation_account_ids']).is_a?(Array)
|
|
153
|
+
self.aggregation_account_ids = value
|
|
154
|
+
end
|
|
155
155
|
end
|
|
156
156
|
end
|
|
157
157
|
|
|
@@ -163,22 +163,6 @@ module ProtonApi
|
|
|
163
163
|
invalid_properties.push('invalid value for "retirement_savings", must be greater than or equal to 0.')
|
|
164
164
|
end
|
|
165
165
|
|
|
166
|
-
if !@retirement_age.nil? && @retirement_age < 0
|
|
167
|
-
invalid_properties.push('invalid value for "retirement_age", must be greater than or equal to 0.')
|
|
168
|
-
end
|
|
169
|
-
|
|
170
|
-
if !@retirement_income.nil? && @retirement_income < 0
|
|
171
|
-
invalid_properties.push('invalid value for "retirement_income", must be greater than or equal to 0.')
|
|
172
|
-
end
|
|
173
|
-
|
|
174
|
-
if @retirement_expenses.nil?
|
|
175
|
-
invalid_properties.push('invalid value for "retirement_expenses", retirement_expenses cannot be nil.')
|
|
176
|
-
end
|
|
177
|
-
|
|
178
|
-
if @retirement_expenses < 0
|
|
179
|
-
invalid_properties.push('invalid value for "retirement_expenses", must be greater than or equal to 0.')
|
|
180
|
-
end
|
|
181
|
-
|
|
182
166
|
if @current_age.nil?
|
|
183
167
|
invalid_properties.push('invalid value for "current_age", current_age cannot be nil.')
|
|
184
168
|
end
|
|
@@ -187,6 +171,10 @@ module ProtonApi
|
|
|
187
171
|
invalid_properties.push('invalid value for "current_age", must be greater than or equal to 0.')
|
|
188
172
|
end
|
|
189
173
|
|
|
174
|
+
if !@retirement_income.nil? && @retirement_income < 0
|
|
175
|
+
invalid_properties.push('invalid value for "retirement_income", must be greater than or equal to 0.')
|
|
176
|
+
end
|
|
177
|
+
|
|
190
178
|
if !@retirement_tax.nil? && @retirement_tax > 1
|
|
191
179
|
invalid_properties.push('invalid value for "retirement_tax", must be smaller than or equal to 1.')
|
|
192
180
|
end
|
|
@@ -195,10 +183,6 @@ module ProtonApi
|
|
|
195
183
|
invalid_properties.push('invalid value for "retirement_tax", must be greater than or equal to 0.')
|
|
196
184
|
end
|
|
197
185
|
|
|
198
|
-
if !@inflation_rate.nil? && @inflation_rate < -1
|
|
199
|
-
invalid_properties.push('invalid value for "inflation_rate", must be greater than or equal to -1.')
|
|
200
|
-
end
|
|
201
|
-
|
|
202
186
|
if @death_age.nil?
|
|
203
187
|
invalid_properties.push('invalid value for "death_age", death_age cannot be nil.')
|
|
204
188
|
end
|
|
@@ -207,6 +191,18 @@ module ProtonApi
|
|
|
207
191
|
invalid_properties.push('invalid value for "death_age", must be greater than or equal to 0.')
|
|
208
192
|
end
|
|
209
193
|
|
|
194
|
+
if !@retirement_age.nil? && @retirement_age < 0
|
|
195
|
+
invalid_properties.push('invalid value for "retirement_age", must be greater than or equal to 0.')
|
|
196
|
+
end
|
|
197
|
+
|
|
198
|
+
if !@percent_of_expenses_covered.nil? && @percent_of_expenses_covered > 1
|
|
199
|
+
invalid_properties.push('invalid value for "percent_of_expenses_covered", must be smaller than or equal to 1.')
|
|
200
|
+
end
|
|
201
|
+
|
|
202
|
+
if !@percent_of_expenses_covered.nil? && @percent_of_expenses_covered < 0
|
|
203
|
+
invalid_properties.push('invalid value for "percent_of_expenses_covered", must be greater than or equal to 0.')
|
|
204
|
+
end
|
|
205
|
+
|
|
210
206
|
if @portfolio_return.nil?
|
|
211
207
|
invalid_properties.push('invalid value for "portfolio_return", portfolio_return cannot be nil.')
|
|
212
208
|
end
|
|
@@ -215,12 +211,16 @@ module ProtonApi
|
|
|
215
211
|
invalid_properties.push('invalid value for "portfolio_return", must be greater than or equal to -1.')
|
|
216
212
|
end
|
|
217
213
|
|
|
218
|
-
if
|
|
219
|
-
invalid_properties.push('invalid value for "
|
|
214
|
+
if @retirement_expenses.nil?
|
|
215
|
+
invalid_properties.push('invalid value for "retirement_expenses", retirement_expenses cannot be nil.')
|
|
220
216
|
end
|
|
221
217
|
|
|
222
|
-
if
|
|
223
|
-
invalid_properties.push('invalid value for "
|
|
218
|
+
if @retirement_expenses < 0
|
|
219
|
+
invalid_properties.push('invalid value for "retirement_expenses", must be greater than or equal to 0.')
|
|
220
|
+
end
|
|
221
|
+
|
|
222
|
+
if !@inflation_rate.nil? && @inflation_rate < -1
|
|
223
|
+
invalid_properties.push('invalid value for "inflation_rate", must be greater than or equal to -1.')
|
|
224
224
|
end
|
|
225
225
|
|
|
226
226
|
invalid_properties
|
|
@@ -230,21 +230,21 @@ module ProtonApi
|
|
|
230
230
|
# @return true if the model is valid
|
|
231
231
|
def valid?
|
|
232
232
|
return false if !@retirement_savings.nil? && @retirement_savings < 0
|
|
233
|
-
return false if !@retirement_age.nil? && @retirement_age < 0
|
|
234
|
-
return false if !@retirement_income.nil? && @retirement_income < 0
|
|
235
|
-
return false if @retirement_expenses.nil?
|
|
236
|
-
return false if @retirement_expenses < 0
|
|
237
233
|
return false if @current_age.nil?
|
|
238
234
|
return false if @current_age < 0
|
|
235
|
+
return false if !@retirement_income.nil? && @retirement_income < 0
|
|
239
236
|
return false if !@retirement_tax.nil? && @retirement_tax > 1
|
|
240
237
|
return false if !@retirement_tax.nil? && @retirement_tax < 0
|
|
241
|
-
return false if !@inflation_rate.nil? && @inflation_rate < -1
|
|
242
238
|
return false if @death_age.nil?
|
|
243
239
|
return false if @death_age < 0
|
|
244
|
-
return false if
|
|
245
|
-
return false if @portfolio_return < -1
|
|
240
|
+
return false if !@retirement_age.nil? && @retirement_age < 0
|
|
246
241
|
return false if !@percent_of_expenses_covered.nil? && @percent_of_expenses_covered > 1
|
|
247
242
|
return false if !@percent_of_expenses_covered.nil? && @percent_of_expenses_covered < 0
|
|
243
|
+
return false if @portfolio_return.nil?
|
|
244
|
+
return false if @portfolio_return < -1
|
|
245
|
+
return false if @retirement_expenses.nil?
|
|
246
|
+
return false if @retirement_expenses < 0
|
|
247
|
+
return false if !@inflation_rate.nil? && @inflation_rate < -1
|
|
248
248
|
true
|
|
249
249
|
end
|
|
250
250
|
|
|
@@ -259,13 +259,17 @@ module ProtonApi
|
|
|
259
259
|
end
|
|
260
260
|
|
|
261
261
|
# Custom attribute writer method with validation
|
|
262
|
-
# @param [Object]
|
|
263
|
-
def
|
|
264
|
-
if
|
|
265
|
-
fail ArgumentError, '
|
|
262
|
+
# @param [Object] current_age Value to be assigned
|
|
263
|
+
def current_age=(current_age)
|
|
264
|
+
if current_age.nil?
|
|
265
|
+
fail ArgumentError, 'current_age cannot be nil'
|
|
266
266
|
end
|
|
267
267
|
|
|
268
|
-
|
|
268
|
+
if current_age < 0
|
|
269
|
+
fail ArgumentError, 'invalid value for "current_age", must be greater than or equal to 0.'
|
|
270
|
+
end
|
|
271
|
+
|
|
272
|
+
@current_age = current_age
|
|
269
273
|
end
|
|
270
274
|
|
|
271
275
|
# Custom attribute writer method with validation
|
|
@@ -278,34 +282,6 @@ module ProtonApi
|
|
|
278
282
|
@retirement_income = retirement_income
|
|
279
283
|
end
|
|
280
284
|
|
|
281
|
-
# Custom attribute writer method with validation
|
|
282
|
-
# @param [Object] retirement_expenses Value to be assigned
|
|
283
|
-
def retirement_expenses=(retirement_expenses)
|
|
284
|
-
if retirement_expenses.nil?
|
|
285
|
-
fail ArgumentError, 'retirement_expenses cannot be nil'
|
|
286
|
-
end
|
|
287
|
-
|
|
288
|
-
if retirement_expenses < 0
|
|
289
|
-
fail ArgumentError, 'invalid value for "retirement_expenses", must be greater than or equal to 0.'
|
|
290
|
-
end
|
|
291
|
-
|
|
292
|
-
@retirement_expenses = retirement_expenses
|
|
293
|
-
end
|
|
294
|
-
|
|
295
|
-
# Custom attribute writer method with validation
|
|
296
|
-
# @param [Object] current_age Value to be assigned
|
|
297
|
-
def current_age=(current_age)
|
|
298
|
-
if current_age.nil?
|
|
299
|
-
fail ArgumentError, 'current_age cannot be nil'
|
|
300
|
-
end
|
|
301
|
-
|
|
302
|
-
if current_age < 0
|
|
303
|
-
fail ArgumentError, 'invalid value for "current_age", must be greater than or equal to 0.'
|
|
304
|
-
end
|
|
305
|
-
|
|
306
|
-
@current_age = current_age
|
|
307
|
-
end
|
|
308
|
-
|
|
309
285
|
# Custom attribute writer method with validation
|
|
310
286
|
# @param [Object] retirement_tax Value to be assigned
|
|
311
287
|
def retirement_tax=(retirement_tax)
|
|
@@ -320,16 +296,6 @@ module ProtonApi
|
|
|
320
296
|
@retirement_tax = retirement_tax
|
|
321
297
|
end
|
|
322
298
|
|
|
323
|
-
# Custom attribute writer method with validation
|
|
324
|
-
# @param [Object] inflation_rate Value to be assigned
|
|
325
|
-
def inflation_rate=(inflation_rate)
|
|
326
|
-
if !inflation_rate.nil? && inflation_rate < -1
|
|
327
|
-
fail ArgumentError, 'invalid value for "inflation_rate", must be greater than or equal to -1.'
|
|
328
|
-
end
|
|
329
|
-
|
|
330
|
-
@inflation_rate = inflation_rate
|
|
331
|
-
end
|
|
332
|
-
|
|
333
299
|
# Custom attribute writer method with validation
|
|
334
300
|
# @param [Object] death_age Value to be assigned
|
|
335
301
|
def death_age=(death_age)
|
|
@@ -344,6 +310,30 @@ module ProtonApi
|
|
|
344
310
|
@death_age = death_age
|
|
345
311
|
end
|
|
346
312
|
|
|
313
|
+
# Custom attribute writer method with validation
|
|
314
|
+
# @param [Object] retirement_age Value to be assigned
|
|
315
|
+
def retirement_age=(retirement_age)
|
|
316
|
+
if !retirement_age.nil? && retirement_age < 0
|
|
317
|
+
fail ArgumentError, 'invalid value for "retirement_age", must be greater than or equal to 0.'
|
|
318
|
+
end
|
|
319
|
+
|
|
320
|
+
@retirement_age = retirement_age
|
|
321
|
+
end
|
|
322
|
+
|
|
323
|
+
# Custom attribute writer method with validation
|
|
324
|
+
# @param [Object] percent_of_expenses_covered Value to be assigned
|
|
325
|
+
def percent_of_expenses_covered=(percent_of_expenses_covered)
|
|
326
|
+
if !percent_of_expenses_covered.nil? && percent_of_expenses_covered > 1
|
|
327
|
+
fail ArgumentError, 'invalid value for "percent_of_expenses_covered", must be smaller than or equal to 1.'
|
|
328
|
+
end
|
|
329
|
+
|
|
330
|
+
if !percent_of_expenses_covered.nil? && percent_of_expenses_covered < 0
|
|
331
|
+
fail ArgumentError, 'invalid value for "percent_of_expenses_covered", must be greater than or equal to 0.'
|
|
332
|
+
end
|
|
333
|
+
|
|
334
|
+
@percent_of_expenses_covered = percent_of_expenses_covered
|
|
335
|
+
end
|
|
336
|
+
|
|
347
337
|
# Custom attribute writer method with validation
|
|
348
338
|
# @param [Object] portfolio_return Value to be assigned
|
|
349
339
|
def portfolio_return=(portfolio_return)
|
|
@@ -359,17 +349,27 @@ module ProtonApi
|
|
|
359
349
|
end
|
|
360
350
|
|
|
361
351
|
# Custom attribute writer method with validation
|
|
362
|
-
# @param [Object]
|
|
363
|
-
def
|
|
364
|
-
if
|
|
365
|
-
fail ArgumentError, '
|
|
352
|
+
# @param [Object] retirement_expenses Value to be assigned
|
|
353
|
+
def retirement_expenses=(retirement_expenses)
|
|
354
|
+
if retirement_expenses.nil?
|
|
355
|
+
fail ArgumentError, 'retirement_expenses cannot be nil'
|
|
366
356
|
end
|
|
367
357
|
|
|
368
|
-
if
|
|
369
|
-
fail ArgumentError, 'invalid value for "
|
|
358
|
+
if retirement_expenses < 0
|
|
359
|
+
fail ArgumentError, 'invalid value for "retirement_expenses", must be greater than or equal to 0.'
|
|
370
360
|
end
|
|
371
361
|
|
|
372
|
-
@
|
|
362
|
+
@retirement_expenses = retirement_expenses
|
|
363
|
+
end
|
|
364
|
+
|
|
365
|
+
# Custom attribute writer method with validation
|
|
366
|
+
# @param [Object] inflation_rate Value to be assigned
|
|
367
|
+
def inflation_rate=(inflation_rate)
|
|
368
|
+
if !inflation_rate.nil? && inflation_rate < -1
|
|
369
|
+
fail ArgumentError, 'invalid value for "inflation_rate", must be greater than or equal to -1.'
|
|
370
|
+
end
|
|
371
|
+
|
|
372
|
+
@inflation_rate = inflation_rate
|
|
373
373
|
end
|
|
374
374
|
|
|
375
375
|
# Checks equality by comparing each attribute.
|
|
@@ -378,18 +378,18 @@ module ProtonApi
|
|
|
378
378
|
return true if self.equal?(o)
|
|
379
379
|
self.class == o.class &&
|
|
380
380
|
retirement_savings == o.retirement_savings &&
|
|
381
|
-
aggregation_account_ids == o.aggregation_account_ids &&
|
|
382
|
-
retirement_age == o.retirement_age &&
|
|
383
|
-
retirement_income == o.retirement_income &&
|
|
384
|
-
retirement_expenses == o.retirement_expenses &&
|
|
385
381
|
current_age == o.current_age &&
|
|
386
382
|
account_ids == o.account_ids &&
|
|
383
|
+
retirement_income == o.retirement_income &&
|
|
387
384
|
retirement_tax == o.retirement_tax &&
|
|
388
|
-
inflation_rate == o.inflation_rate &&
|
|
389
385
|
death_age == o.death_age &&
|
|
386
|
+
retirement_age == o.retirement_age &&
|
|
387
|
+
percent_of_expenses_covered == o.percent_of_expenses_covered &&
|
|
390
388
|
portfolio_return == o.portfolio_return &&
|
|
389
|
+
retirement_expenses == o.retirement_expenses &&
|
|
391
390
|
deposit_schedule == o.deposit_schedule &&
|
|
392
|
-
|
|
391
|
+
inflation_rate == o.inflation_rate &&
|
|
392
|
+
aggregation_account_ids == o.aggregation_account_ids
|
|
393
393
|
end
|
|
394
394
|
|
|
395
395
|
# @see the `==` method
|
|
@@ -401,7 +401,7 @@ module ProtonApi
|
|
|
401
401
|
# Calculates hash code according to all attributes.
|
|
402
402
|
# @return [Fixnum] Hash code
|
|
403
403
|
def hash
|
|
404
|
-
[retirement_savings,
|
|
404
|
+
[retirement_savings, current_age, account_ids, retirement_income, retirement_tax, death_age, retirement_age, percent_of_expenses_covered, portfolio_return, retirement_expenses, deposit_schedule, inflation_rate, aggregation_account_ids].hash
|
|
405
405
|
end
|
|
406
406
|
|
|
407
407
|
# Builds the object from hash
|
|
@@ -423,17 +423,16 @@ module ProtonApi
|
|
|
423
423
|
|
|
424
424
|
self
|
|
425
425
|
end
|
|
426
|
-
|
|
427
|
-
# Deserializes the data based on type
|
|
426
|
+
# Deserializes the data based on type
|
|
428
427
|
# @param string type Data type
|
|
429
428
|
# @param string value Value to be deserialized
|
|
430
429
|
# @return [Object] Deserialized data
|
|
431
430
|
def _deserialize(type, value)
|
|
432
431
|
case type.to_sym
|
|
433
432
|
when :DateTime
|
|
434
|
-
|
|
433
|
+
value
|
|
435
434
|
when :Date
|
|
436
|
-
|
|
435
|
+
value
|
|
437
436
|
when :String
|
|
438
437
|
value.to_s
|
|
439
438
|
when :Integer
|
|
@@ -465,8 +464,7 @@ module ProtonApi
|
|
|
465
464
|
temp_model.build_from_hash(value)
|
|
466
465
|
end
|
|
467
466
|
end
|
|
468
|
-
|
|
469
|
-
# Returns the string representation of the object
|
|
467
|
+
# Returns the string representation of the object
|
|
470
468
|
# @return [String] String presentation of the object
|
|
471
469
|
def to_s
|
|
472
470
|
to_hash.to_s
|
|
@@ -489,8 +487,7 @@ module ProtonApi
|
|
|
489
487
|
end
|
|
490
488
|
hash
|
|
491
489
|
end
|
|
492
|
-
|
|
493
|
-
# Outputs non-array value in the form of hash
|
|
490
|
+
# Outputs non-array value in the form of hash
|
|
494
491
|
# For object, use to_hash. Otherwise, just return the value
|
|
495
492
|
# @param [Object] value Any valid value
|
|
496
493
|
# @return [Hash] Returns the value in the form of hash
|