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