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
 
@@ -38,25 +38,25 @@ describe 'WConfig1' do
38
38
  end
39
39
  end
40
40
 
41
- describe 'test attribute "cash_amount"' do
41
+ describe 'test attribute "w_min_major"' do
42
42
  it 'should work' do
43
43
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
44
44
  end
45
45
  end
46
46
 
47
- describe 'test attribute "w_min_major"' do
47
+ describe 'test attribute "cash_amount"' do
48
48
  it 'should work' do
49
49
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
50
50
  end
51
51
  end
52
52
 
53
- describe 'test attribute "w_max_minor"' do
53
+ describe 'test attribute "w_max_major"' do
54
54
  it 'should work' do
55
55
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
56
56
  end
57
57
  end
58
58
 
59
- describe 'test attribute "w_max_major"' do
59
+ describe 'test attribute "w_max_minor"' do
60
60
  it 'should work' do
61
61
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
62
62
  end
@@ -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
 
@@ -32,31 +32,31 @@ describe 'WConfig' do
32
32
  expect(@instance).to be_instance_of(ProtonApi::WConfig)
33
33
  end
34
34
  end
35
- describe 'test attribute "w_min_major"' do
35
+ describe 'test attribute "w_min_minor"' do
36
36
  it 'should work' do
37
37
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
38
38
  end
39
39
  end
40
40
 
41
- describe 'test attribute "cash_amount"' do
41
+ describe 'test attribute "w_min_major"' do
42
42
  it 'should work' do
43
43
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
44
44
  end
45
45
  end
46
46
 
47
- describe 'test attribute "w_min_minor"' do
47
+ describe 'test attribute "cash_amount"' do
48
48
  it 'should work' do
49
49
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
50
50
  end
51
51
  end
52
52
 
53
- describe 'test attribute "w_max_minor"' do
53
+ describe 'test attribute "w_max_major"' do
54
54
  it 'should work' do
55
55
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
56
56
  end
57
57
  end
58
58
 
59
- describe 'test attribute "w_max_major"' do
59
+ describe 'test attribute "w_max_minor"' do
60
60
  it 'should work' do
61
61
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
62
62
  end
data/spec/spec_helper.rb CHANGED
@@ -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
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: proton_api
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.8.0
4
+ version: 1.9.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Swagger-Codegen
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-02-03 00:00:00.000000000 Z
11
+ date: 2021-06-29 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -220,98 +220,6 @@ files:
220
220
  - Gemfile
221
221
  - README.md
222
222
  - Rakefile
223
- - docs/AccumulationGoalDepositConfig.md
224
- - docs/AnnuitiesApi.md
225
- - docs/AnnuityCalculatorAccumulationHorizonRequest.md
226
- - docs/AnnuityCalculatorAnnuityAmountRequest.md
227
- - docs/AnnuityCalculatorDecumulationHorizonRequest.md
228
- - docs/AnnuityCalculatorDepositAmountRequest.md
229
- - docs/AnnuityCalculatorInitialBalanceRequest.md
230
- - docs/AnnuityDepositSchedule.md
231
- - docs/BacktestRequest.md
232
- - docs/BeneficiaryBequestConfig.md
233
- - docs/BudgetAggregationAccount.md
234
- - docs/BudgetCalculatorRequest.md
235
- - docs/BudgetComponent.md
236
- - docs/BudgetDetails.md
237
- - docs/BusinessFinancialHealthCheckRequest.md
238
- - docs/BusinessFinancialManagementApi.md
239
- - docs/BusinessInvoiceAnalysisRequest.md
240
- - docs/CalculatorDepositSchedule.md
241
- - docs/CalculatorDepositSchedule1.md
242
- - docs/CardLimitCheckRequest.md
243
- - docs/CardTransactionAuthorizationRequest.md
244
- - docs/CardsApi.md
245
- - docs/CashAnalysisRequest.md
246
- - docs/CashFlowAnalysisRequest.md
247
- - docs/ChildrenEducationConfig.md
248
- - docs/CustomerAnalysisRequest.md
249
- - docs/DecumulationGoalDepositConfig.md
250
- - docs/DimensionalRiskScoreRequest.md
251
- - docs/DiversificationScoreRequest.md
252
- - docs/EducationCalculatorAnnualCostRequest.md
253
- - docs/EducationCalculatorDepositAmountRequest.md
254
- - docs/EducationCalculatorPercentCoveredRequest.md
255
- - docs/EducationConfig.md
256
- - docs/EmergencyFundCalculatorRequest.md
257
- - docs/EventStudyRequest.md
258
- - docs/FeeAnalysisRequest.md
259
- - docs/FinancialHealthApi.md
260
- - docs/FinancialHealthCheckRequest.md
261
- - docs/FinancialPictureRequest.md
262
- - docs/FinancialPlanningApi.md
263
- - docs/FinancialStatementAnalysisRequest.md
264
- - docs/GoalAccumulationAllocationRequest.md
265
- - docs/GoalAccumulationRecommendationRequest.md
266
- - docs/GoalAccumulationStatusRequest.md
267
- - docs/GoalConfig.md
268
- - docs/GoalDecumulationAllocationRequest.md
269
- - docs/GoalDecumulationRecommendationRequest.md
270
- - docs/GoalDecumulationStatusRequest.md
271
- - docs/GoalWithdrawalConfig.md
272
- - docs/GoalsApi.md
273
- - docs/GuaranteedRateBenefit.md
274
- - docs/IncomeConfig.md
275
- - docs/LifeInsuranceApi.md
276
- - docs/LifeInsuranceNeedsCalculatorRequest.md
277
- - docs/MonteCarloRequest.md
278
- - docs/MortgageCalculatorDownPaymentRequest.md
279
- - docs/MortgageCalculatorHomePriceRequest.md
280
- - docs/MortgageCalculatorPeriodicPaymentRequest.md
281
- - docs/MvoRequest.md
282
- - docs/OptConfig.md
283
- - docs/OptConfig1.md
284
- - docs/Periods.md
285
- - docs/PersonalFinancialManagementApi.md
286
- - docs/PortfolioConstructionApi.md
287
- - docs/PortfolioManagementApi.md
288
- - docs/PortfolioOptimizationScoreRequest.md
289
- - docs/PortfolioWhatIfRequest.md
290
- - docs/PurchaseCalculatorAmountRequest.md
291
- - docs/PurchaseCalculatorDepositAmountRequest.md
292
- - docs/PurchaseCalculatorHorizonRequest.md
293
- - docs/RatioTargets.md
294
- - docs/RatioTargets1.md
295
- - docs/RebalancingSignalRequest.md
296
- - docs/RecommendationConfig.md
297
- - docs/RecommendationConfig1.md
298
- - docs/RecurringTransactionAnalysisRequest.md
299
- - docs/RetirementCalculatorDepositAmountRequest.md
300
- - docs/RetirementCalculatorExpensesRequest.md
301
- - docs/RetirementCalculatorPercentCoveredRequest.md
302
- - docs/RiskAllocationRequest.md
303
- - docs/RiskScoreRequest.md
304
- - docs/RiskScoringApi.md
305
- - docs/SavingsCalculatorRequest.md
306
- - docs/SavingsDepositSchedule.md
307
- - docs/ScenarioAnalysisRequest.md
308
- - docs/SensitivityAnalysisRequest.md
309
- - docs/SensitivityFactor.md
310
- - docs/Settings.md
311
- - docs/SimulationsApi.md
312
- - docs/VariableAnnuityRequest.md
313
- - docs/WConfig.md
314
- - docs/WConfig1.md
315
223
  - git_push.sh
316
224
  - lib/proton_api.rb
317
225
  - lib/proton_api/api/annuities_api.rb
@@ -326,6 +234,7 @@ files:
326
234
  - lib/proton_api/api/portfolio_management_api.rb
327
235
  - lib/proton_api/api/risk_scoring_api.rb
328
236
  - lib/proton_api/api/simulations_api.rb
237
+ - lib/proton_api/api/util_api.rb
329
238
  - lib/proton_api/api_client.rb
330
239
  - lib/proton_api/api_error.rb
331
240
  - lib/proton_api/auth_configuration.rb
@@ -337,6 +246,7 @@ files:
337
246
  - lib/proton_api/models/annuity_calculator_deposit_amount_request.rb
338
247
  - lib/proton_api/models/annuity_calculator_initial_balance_request.rb
339
248
  - lib/proton_api/models/annuity_deposit_schedule.rb
249
+ - lib/proton_api/models/answer.rb
340
250
  - lib/proton_api/models/backtest_request.rb
341
251
  - lib/proton_api/models/beneficiary_bequest_config.rb
342
252
  - lib/proton_api/models/budget_aggregation_account.rb
@@ -347,12 +257,14 @@ files:
347
257
  - lib/proton_api/models/business_invoice_analysis_request.rb
348
258
  - lib/proton_api/models/calculator_deposit_schedule.rb
349
259
  - lib/proton_api/models/calculator_deposit_schedule1.rb
260
+ - lib/proton_api/models/card_analysis_request.rb
350
261
  - lib/proton_api/models/card_limit_check_request.rb
351
262
  - lib/proton_api/models/card_transaction_authorization_request.rb
352
263
  - lib/proton_api/models/cash_analysis_request.rb
353
264
  - lib/proton_api/models/cash_flow_analysis_request.rb
354
265
  - lib/proton_api/models/children_education_config.rb
355
266
  - lib/proton_api/models/customer_analysis_request.rb
267
+ - lib/proton_api/models/decision_tree_result_request.rb
356
268
  - lib/proton_api/models/decumulation_goal_deposit_config.rb
357
269
  - lib/proton_api/models/dimensional_risk_score_request.rb
358
270
  - lib/proton_api/models/diversification_score_request.rb
@@ -377,6 +289,7 @@ files:
377
289
  - lib/proton_api/models/guaranteed_rate_benefit.rb
378
290
  - lib/proton_api/models/income_config.rb
379
291
  - lib/proton_api/models/life_insurance_needs_calculator_request.rb
292
+ - lib/proton_api/models/location.rb
380
293
  - lib/proton_api/models/monte_carlo_request.rb
381
294
  - lib/proton_api/models/mortgage_calculator_down_payment_request.rb
382
295
  - lib/proton_api/models/mortgage_calculator_home_price_request.rb
@@ -384,6 +297,8 @@ files:
384
297
  - lib/proton_api/models/mvo_request.rb
385
298
  - lib/proton_api/models/opt_config.rb
386
299
  - lib/proton_api/models/opt_config1.rb
300
+ - lib/proton_api/models/order_rebalance_request.rb
301
+ - lib/proton_api/models/performance_calculator_request.rb
387
302
  - lib/proton_api/models/periods.rb
388
303
  - lib/proton_api/models/portfolio_optimization_score_request.rb
389
304
  - lib/proton_api/models/portfolio_what_if_request.rb
@@ -407,6 +322,7 @@ files:
407
322
  - lib/proton_api/models/sensitivity_analysis_request.rb
408
323
  - lib/proton_api/models/sensitivity_factor.rb
409
324
  - lib/proton_api/models/settings.rb
325
+ - lib/proton_api/models/spending_analysis_request.rb
410
326
  - lib/proton_api/models/variable_annuity_request.rb
411
327
  - lib/proton_api/models/w_config.rb
412
328
  - lib/proton_api/models/w_config1.rb
@@ -424,6 +340,7 @@ files:
424
340
  - spec/api/portfolio_management_api_spec.rb
425
341
  - spec/api/risk_scoring_api_spec.rb
426
342
  - spec/api/simulations_api_spec.rb
343
+ - spec/api/util_api_spec.rb
427
344
  - spec/api_client_spec.rb
428
345
  - spec/configuration_spec.rb
429
346
  - spec/models/accumulation_goal_deposit_config_spec.rb
@@ -433,6 +350,7 @@ files:
433
350
  - spec/models/annuity_calculator_deposit_amount_request_spec.rb
434
351
  - spec/models/annuity_calculator_initial_balance_request_spec.rb
435
352
  - spec/models/annuity_deposit_schedule_spec.rb
353
+ - spec/models/answer_spec.rb
436
354
  - spec/models/backtest_request_spec.rb
437
355
  - spec/models/beneficiary_bequest_config_spec.rb
438
356
  - spec/models/budget_aggregation_account_spec.rb
@@ -443,12 +361,14 @@ files:
443
361
  - spec/models/business_invoice_analysis_request_spec.rb
444
362
  - spec/models/calculator_deposit_schedule1_spec.rb
445
363
  - spec/models/calculator_deposit_schedule_spec.rb
364
+ - spec/models/card_analysis_request_spec.rb
446
365
  - spec/models/card_limit_check_request_spec.rb
447
366
  - spec/models/card_transaction_authorization_request_spec.rb
448
367
  - spec/models/cash_analysis_request_spec.rb
449
368
  - spec/models/cash_flow_analysis_request_spec.rb
450
369
  - spec/models/children_education_config_spec.rb
451
370
  - spec/models/customer_analysis_request_spec.rb
371
+ - spec/models/decision_tree_result_request_spec.rb
452
372
  - spec/models/decumulation_goal_deposit_config_spec.rb
453
373
  - spec/models/dimensional_risk_score_request_spec.rb
454
374
  - spec/models/diversification_score_request_spec.rb
@@ -473,6 +393,7 @@ files:
473
393
  - spec/models/guaranteed_rate_benefit_spec.rb
474
394
  - spec/models/income_config_spec.rb
475
395
  - spec/models/life_insurance_needs_calculator_request_spec.rb
396
+ - spec/models/location_spec.rb
476
397
  - spec/models/monte_carlo_request_spec.rb
477
398
  - spec/models/mortgage_calculator_down_payment_request_spec.rb
478
399
  - spec/models/mortgage_calculator_home_price_request_spec.rb
@@ -480,6 +401,8 @@ files:
480
401
  - spec/models/mvo_request_spec.rb
481
402
  - spec/models/opt_config1_spec.rb
482
403
  - spec/models/opt_config_spec.rb
404
+ - spec/models/order_rebalance_request_spec.rb
405
+ - spec/models/performance_calculator_request_spec.rb
483
406
  - spec/models/periods_spec.rb
484
407
  - spec/models/portfolio_optimization_score_request_spec.rb
485
408
  - spec/models/portfolio_what_if_request_spec.rb
@@ -503,6 +426,7 @@ files:
503
426
  - spec/models/sensitivity_analysis_request_spec.rb
504
427
  - spec/models/sensitivity_factor_spec.rb
505
428
  - spec/models/settings_spec.rb
429
+ - spec/models/spending_analysis_request_spec.rb
506
430
  - spec/models/variable_annuity_request_spec.rb
507
431
  - spec/models/w_config1_spec.rb
508
432
  - spec/models/w_config_spec.rb
@@ -542,16 +466,19 @@ test_files:
542
466
  - spec/api/cards_api_spec.rb
543
467
  - spec/api/financial_planning_api_spec.rb
544
468
  - spec/api/simulations_api_spec.rb
469
+ - spec/api/util_api_spec.rb
545
470
  - spec/api/life_insurance_api_spec.rb
546
471
  - spec/api_client_spec.rb
547
472
  - spec/configuration_spec.rb
548
473
  - spec/models/ratio_targets_spec.rb
549
474
  - spec/models/purchase_calculator_deposit_amount_request_spec.rb
550
475
  - spec/models/purchase_calculator_amount_request_spec.rb
476
+ - spec/models/decision_tree_result_request_spec.rb
551
477
  - spec/models/emergency_fund_calculator_request_spec.rb
552
478
  - spec/models/mvo_request_spec.rb
553
479
  - spec/models/settings_spec.rb
554
480
  - spec/models/financial_statement_analysis_request_spec.rb
481
+ - spec/models/order_rebalance_request_spec.rb
555
482
  - spec/models/monte_carlo_request_spec.rb
556
483
  - spec/models/w_config_spec.rb
557
484
  - spec/models/opt_config_spec.rb
@@ -559,6 +486,7 @@ test_files:
559
486
  - spec/models/savings_calculator_request_spec.rb
560
487
  - spec/models/goal_decumulation_recommendation_request_spec.rb
561
488
  - spec/models/savings_deposit_schedule_spec.rb
489
+ - spec/models/spending_analysis_request_spec.rb
562
490
  - spec/models/cash_analysis_request_spec.rb
563
491
  - spec/models/goal_decumulation_allocation_request_spec.rb
564
492
  - spec/models/portfolio_what_if_request_spec.rb
@@ -572,6 +500,8 @@ test_files:
572
500
  - spec/models/risk_allocation_request_spec.rb
573
501
  - spec/models/variable_annuity_request_spec.rb
574
502
  - spec/models/rebalancing_signal_request_spec.rb
503
+ - spec/models/location_spec.rb
504
+ - spec/models/answer_spec.rb
575
505
  - spec/models/portfolio_optimization_score_request_spec.rb
576
506
  - spec/models/diversification_score_request_spec.rb
577
507
  - spec/models/dimensional_risk_score_request_spec.rb
@@ -604,6 +534,7 @@ test_files:
604
534
  - spec/models/education_calculator_percent_covered_request_spec.rb
605
535
  - spec/models/accumulation_goal_deposit_config_spec.rb
606
536
  - spec/models/guaranteed_rate_benefit_spec.rb
537
+ - spec/models/card_analysis_request_spec.rb
607
538
  - spec/models/annuity_calculator_decumulation_horizon_request_spec.rb
608
539
  - spec/models/budget_details_spec.rb
609
540
  - spec/models/education_calculator_annual_cost_request_spec.rb
@@ -620,6 +551,7 @@ test_files:
620
551
  - spec/models/education_config_spec.rb
621
552
  - spec/models/goal_accumulation_allocation_request_spec.rb
622
553
  - spec/models/scenario_analysis_request_spec.rb
554
+ - spec/models/performance_calculator_request_spec.rb
623
555
  - spec/models/goal_decumulation_status_request_spec.rb
624
556
  - spec/models/goal_withdrawal_config_spec.rb
625
557
  - spec/models/annuity_calculator_deposit_amount_request_spec.rb
@@ -1,14 +0,0 @@
1
- # ProtonApi::AccumulationGoalDepositConfig
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **dep_amount** | **Float** | | [optional]
7
- **dep_end_period** | **Integer** | | [optional] [default to 0]
8
- **dep_end_reference** | **String** | | [optional] [default to 'a_end']
9
- **dep_frequency** | **String** | | [optional] [default to 'year']
10
- **dep_start_period** | **Integer** | | [optional] [default to 0]
11
- **dep_inflation** | **Float** | | [optional] [default to 0.0]
12
- **dep_start_reference** | **String** | | [optional] [default to 'a_start']
13
-
14
-
data/docs/AnnuitiesApi.md DELETED
@@ -1,344 +0,0 @@
1
- # ProtonApi::AnnuitiesApi
2
-
3
- All URIs are relative to *https://sandbox.hydrogenplatform.com/proton/v1*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**annuity_calculator_accumulation_horizon**](AnnuitiesApi.md#annuity_calculator_accumulation_horizon) | **POST** /annuity_calculator/accumulation_horizon | Annuity Calculator - Accumulation Horizon
8
- [**annuity_calculator_annuity_amount**](AnnuitiesApi.md#annuity_calculator_annuity_amount) | **POST** /annuity_calculator/annuity_amount | Annuity Calculator - Annuity Amount
9
- [**annuity_calculator_decumulation_horizon**](AnnuitiesApi.md#annuity_calculator_decumulation_horizon) | **POST** /annuity_calculator/decumulation_horizon | Annuity Calculator - Decumulation Horizon
10
- [**annuity_calculator_deposit_amount**](AnnuitiesApi.md#annuity_calculator_deposit_amount) | **POST** /annuity_calculator/deposit_amount | Annuity Calculator - Deposit Amount
11
- [**annuity_calculator_initial_balance**](AnnuitiesApi.md#annuity_calculator_initial_balance) | **POST** /annuity_calculator/initial_balance | Annuity Calculator - Initial Balance
12
- [**variable_annuity**](AnnuitiesApi.md#variable_annuity) | **POST** /variable_annuity | Variable Annuity
13
-
14
-
15
- # **annuity_calculator_accumulation_horizon**
16
- > Hash<String, Object> annuity_calculator_accumulation_horizon(annuity_calculator_accumulation_horizon_request)
17
-
18
- Annuity Calculator - Accumulation Horizon
19
-
20
- Calculate the necessary fixed annuity contribution period
21
-
22
- ### Example
23
- ```ruby
24
- # load the gem
25
- require 'proton_api'
26
- # setup authorization
27
- ProtonApi.configure do |config|
28
- # Creating a token for grant_type=client_credentials
29
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
30
- # Creating a token for grant_type=password
31
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
32
- # Creating a token using client token
33
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
34
- end
35
- api_instance = ProtonApi::AnnuitiesApi.new
36
-
37
- annuity_calculator_accumulation_horizon_request = ProtonApi::AnnuityCalculatorAccumulationHorizonRequest.new # AnnuityCalculatorAccumulationHorizonRequest | Request payload for Annuity Calculator - Accumulation Horizon
38
-
39
-
40
- begin
41
- #Annuity Calculator - Accumulation Horizon
42
- result = api_instance.annuity_calculator_accumulation_horizon(annuity_calculator_accumulation_horizon_request)
43
- p result
44
- rescue ProtonApi::ApiError => e
45
- puts "Exception when calling AnnuitiesApi->annuity_calculator_accumulation_horizon: #{e}"
46
- end
47
- ```
48
-
49
- ### Parameters
50
-
51
- Name | Type | Description | Notes
52
- ------------- | ------------- | ------------- | -------------
53
- **annuity_calculator_accumulation_horizon_request** | [**AnnuityCalculatorAccumulationHorizonRequest**](AnnuityCalculatorAccumulationHorizonRequest.md)| Request payload for Annuity Calculator - Accumulation Horizon |
54
-
55
- ### Return type
56
-
57
- **Hash<String, Object>**
58
-
59
- ### Authorization
60
-
61
- [oauth2](../README.md#oauth2)
62
-
63
- ### HTTP request headers
64
-
65
- - **Content-Type**: application/json
66
- - **Accept**: application/json
67
-
68
-
69
-
70
- # **annuity_calculator_annuity_amount**
71
- > Hash<String, Object> annuity_calculator_annuity_amount(annuity_calculator_annuity_amount_request)
72
-
73
- Annuity Calculator - Annuity Amount
74
-
75
- Calculate the achievable fixed annuity amount
76
-
77
- ### Example
78
- ```ruby
79
- # load the gem
80
- require 'proton_api'
81
- # setup authorization
82
- ProtonApi.configure do |config|
83
- # Creating a token for grant_type=client_credentials
84
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
85
- # Creating a token for grant_type=password
86
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
87
- # Creating a token using client token
88
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
89
- end
90
- api_instance = ProtonApi::AnnuitiesApi.new
91
-
92
- annuity_calculator_annuity_amount_request = ProtonApi::AnnuityCalculatorAnnuityAmountRequest.new # AnnuityCalculatorAnnuityAmountRequest | Request payload for Annuity Calculator - Annuity Amount
93
-
94
-
95
- begin
96
- #Annuity Calculator - Annuity Amount
97
- result = api_instance.annuity_calculator_annuity_amount(annuity_calculator_annuity_amount_request)
98
- p result
99
- rescue ProtonApi::ApiError => e
100
- puts "Exception when calling AnnuitiesApi->annuity_calculator_annuity_amount: #{e}"
101
- end
102
- ```
103
-
104
- ### Parameters
105
-
106
- Name | Type | Description | Notes
107
- ------------- | ------------- | ------------- | -------------
108
- **annuity_calculator_annuity_amount_request** | [**AnnuityCalculatorAnnuityAmountRequest**](AnnuityCalculatorAnnuityAmountRequest.md)| Request payload for Annuity Calculator - Annuity Amount |
109
-
110
- ### Return type
111
-
112
- **Hash<String, Object>**
113
-
114
- ### Authorization
115
-
116
- [oauth2](../README.md#oauth2)
117
-
118
- ### HTTP request headers
119
-
120
- - **Content-Type**: application/json
121
- - **Accept**: application/json
122
-
123
-
124
-
125
- # **annuity_calculator_decumulation_horizon**
126
- > Hash<String, Object> annuity_calculator_decumulation_horizon(annuity_calculator_decumulation_horizon_request)
127
-
128
- Annuity Calculator - Decumulation Horizon
129
-
130
- Calculate the achievable fixed annuity payout period
131
-
132
- ### Example
133
- ```ruby
134
- # load the gem
135
- require 'proton_api'
136
- # setup authorization
137
- ProtonApi.configure do |config|
138
- # Creating a token for grant_type=client_credentials
139
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
140
- # Creating a token for grant_type=password
141
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
142
- # Creating a token using client token
143
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
144
- end
145
- api_instance = ProtonApi::AnnuitiesApi.new
146
-
147
- annuity_calculator_decumulation_horizon_request = ProtonApi::AnnuityCalculatorDecumulationHorizonRequest.new # AnnuityCalculatorDecumulationHorizonRequest | Request payload for Annuity Calculator - Decumulation Horizon
148
-
149
-
150
- begin
151
- #Annuity Calculator - Decumulation Horizon
152
- result = api_instance.annuity_calculator_decumulation_horizon(annuity_calculator_decumulation_horizon_request)
153
- p result
154
- rescue ProtonApi::ApiError => e
155
- puts "Exception when calling AnnuitiesApi->annuity_calculator_decumulation_horizon: #{e}"
156
- end
157
- ```
158
-
159
- ### Parameters
160
-
161
- Name | Type | Description | Notes
162
- ------------- | ------------- | ------------- | -------------
163
- **annuity_calculator_decumulation_horizon_request** | [**AnnuityCalculatorDecumulationHorizonRequest**](AnnuityCalculatorDecumulationHorizonRequest.md)| Request payload for Annuity Calculator - Decumulation Horizon |
164
-
165
- ### Return type
166
-
167
- **Hash<String, Object>**
168
-
169
- ### Authorization
170
-
171
- [oauth2](../README.md#oauth2)
172
-
173
- ### HTTP request headers
174
-
175
- - **Content-Type**: application/json
176
- - **Accept**: application/json
177
-
178
-
179
-
180
- # **annuity_calculator_deposit_amount**
181
- > Hash<String, Object> annuity_calculator_deposit_amount(annuity_calculator_deposit_amount_request)
182
-
183
- Annuity Calculator - Deposit Amount
184
-
185
- Calculate the necessary periodic deposit amount for a fixed annuity
186
-
187
- ### Example
188
- ```ruby
189
- # load the gem
190
- require 'proton_api'
191
- # setup authorization
192
- ProtonApi.configure do |config|
193
- # Creating a token for grant_type=client_credentials
194
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
195
- # Creating a token for grant_type=password
196
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
197
- # Creating a token using client token
198
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
199
- end
200
- api_instance = ProtonApi::AnnuitiesApi.new
201
-
202
- annuity_calculator_deposit_amount_request = ProtonApi::AnnuityCalculatorDepositAmountRequest.new # AnnuityCalculatorDepositAmountRequest | Request payload for Annuity Calculator - Deposit Amount
203
-
204
-
205
- begin
206
- #Annuity Calculator - Deposit Amount
207
- result = api_instance.annuity_calculator_deposit_amount(annuity_calculator_deposit_amount_request)
208
- p result
209
- rescue ProtonApi::ApiError => e
210
- puts "Exception when calling AnnuitiesApi->annuity_calculator_deposit_amount: #{e}"
211
- end
212
- ```
213
-
214
- ### Parameters
215
-
216
- Name | Type | Description | Notes
217
- ------------- | ------------- | ------------- | -------------
218
- **annuity_calculator_deposit_amount_request** | [**AnnuityCalculatorDepositAmountRequest**](AnnuityCalculatorDepositAmountRequest.md)| Request payload for Annuity Calculator - Deposit Amount |
219
-
220
- ### Return type
221
-
222
- **Hash<String, Object>**
223
-
224
- ### Authorization
225
-
226
- [oauth2](../README.md#oauth2)
227
-
228
- ### HTTP request headers
229
-
230
- - **Content-Type**: application/json
231
- - **Accept**: application/json
232
-
233
-
234
-
235
- # **annuity_calculator_initial_balance**
236
- > Hash<String, Object> annuity_calculator_initial_balance(annuity_calculator_initial_balance_request)
237
-
238
- Annuity Calculator - Initial Balance
239
-
240
- Calculate the necessary initial balance for a fixed annuity
241
-
242
- ### Example
243
- ```ruby
244
- # load the gem
245
- require 'proton_api'
246
- # setup authorization
247
- ProtonApi.configure do |config|
248
- # Creating a token for grant_type=client_credentials
249
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
250
- # Creating a token for grant_type=password
251
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
252
- # Creating a token using client token
253
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
254
- end
255
- api_instance = ProtonApi::AnnuitiesApi.new
256
-
257
- annuity_calculator_initial_balance_request = ProtonApi::AnnuityCalculatorInitialBalanceRequest.new # AnnuityCalculatorInitialBalanceRequest | Request payload for Annuity Calculator - Initial Balance
258
-
259
-
260
- begin
261
- #Annuity Calculator - Initial Balance
262
- result = api_instance.annuity_calculator_initial_balance(annuity_calculator_initial_balance_request)
263
- p result
264
- rescue ProtonApi::ApiError => e
265
- puts "Exception when calling AnnuitiesApi->annuity_calculator_initial_balance: #{e}"
266
- end
267
- ```
268
-
269
- ### Parameters
270
-
271
- Name | Type | Description | Notes
272
- ------------- | ------------- | ------------- | -------------
273
- **annuity_calculator_initial_balance_request** | [**AnnuityCalculatorInitialBalanceRequest**](AnnuityCalculatorInitialBalanceRequest.md)| Request payload for Annuity Calculator - Initial Balance |
274
-
275
- ### Return type
276
-
277
- **Hash<String, Object>**
278
-
279
- ### Authorization
280
-
281
- [oauth2](../README.md#oauth2)
282
-
283
- ### HTTP request headers
284
-
285
- - **Content-Type**: application/json
286
- - **Accept**: application/json
287
-
288
-
289
-
290
- # **variable_annuity**
291
- > Hash<String, Object> variable_annuity(variable_annuity_request)
292
-
293
- Variable Annuity
294
-
295
- Project the behavior of a variable annuity over time
296
-
297
- ### Example
298
- ```ruby
299
- # load the gem
300
- require 'proton_api'
301
- # setup authorization
302
- ProtonApi.configure do |config|
303
- # Creating a token for grant_type=client_credentials
304
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
305
- # Creating a token for grant_type=password
306
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
307
- # Creating a token using client token
308
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
309
- end
310
- api_instance = ProtonApi::AnnuitiesApi.new
311
-
312
- variable_annuity_request = ProtonApi::VariableAnnuityRequest.new # VariableAnnuityRequest | Request payload for Variable Annuity
313
-
314
-
315
- begin
316
- #Variable Annuity
317
- result = api_instance.variable_annuity(variable_annuity_request)
318
- p result
319
- rescue ProtonApi::ApiError => e
320
- puts "Exception when calling AnnuitiesApi->variable_annuity: #{e}"
321
- end
322
- ```
323
-
324
- ### Parameters
325
-
326
- Name | Type | Description | Notes
327
- ------------- | ------------- | ------------- | -------------
328
- **variable_annuity_request** | [**VariableAnnuityRequest**](VariableAnnuityRequest.md)| Request payload for Variable Annuity |
329
-
330
- ### Return type
331
-
332
- **Hash<String, Object>**
333
-
334
- ### Authorization
335
-
336
- [oauth2](../README.md#oauth2)
337
-
338
- ### HTTP request headers
339
-
340
- - **Content-Type**: application/json
341
- - **Accept**: application/json
342
-
343
-
344
-