proton_api 1.8.0 → 1.9.0

Sign up to get free protection for your applications and to get access to all the features.
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
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 23aac3a093f2f1a0f7fdaea70abb5446cea861442d1a5d703004b266157d4e3d
4
- data.tar.gz: a1bb1786c3da7ca71c2333e8c3d5cd6bb19beccde23e4497ec578ea0aa4a29b3
3
+ metadata.gz: 385c5a86b3ffc8f2d40b3987bc4f966d5d73d636153b2112fdc478d63c4febc4
4
+ data.tar.gz: aa8d24dc00006188d59df04eacd40ae5826d200d0cbbe57d2c03cf8e39ae499f
5
5
  SHA512:
6
- metadata.gz: a65881f9bb3d3a0cf54128d29e3e584feb83bb285c3c8dccb62b91b543c5314fa3895177b521a5cae2103e5a75ed0b673be5ccf9ce33148bac26b072641f0ce9
7
- data.tar.gz: f3d96695f93ef04d9be1b09a799bbfd4c321f086a666a8646b4d124d3766ad5e69a68689f2f59defe8d26dcc31e6f766e4972f748de57a411745dfa04e7a899f
6
+ metadata.gz: 829b13d900f352363c9ee271e53214a272b04c1e5d31684d9fbc4f7c9a22dd972d32e9f9e6d76717d71744686a62a2f86cfbfd2da64609ae9408de602d4c5bd7
7
+ data.tar.gz: 1246766bf4525e7afff50e6ac9619d80d2c6701735f0161fe6438e71cd62f7a30b2d64705e04f2291b25e5f157f199e73229238f19ac910add34d48639e0c74c
data/README.md CHANGED
@@ -1,84 +1,64 @@
1
- # proton_api
1
+ # Hydrogen Proton API
2
2
 
3
- ProtonApi - the Ruby gem for the Hydrogen Proton API
3
+ Hydrogen Proton API
4
+ - API version: 1.9.0
5
+ - Build date: 29-06-2021
4
6
 
5
- Financial engineering module of Hydrogen Atom
7
+ For more information, please visit [https://www.hydrogenplatform.com/apis](https://www.hydrogenplatform.com/apis)
6
8
 
7
- This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
9
+ ## Documentation
8
10
 
9
- - API version: 1.8.0
10
- - Package version: 1.0.0
11
- - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
- For more information, please visit [https://www.hydrogenplatform.com/contact](https://www.hydrogenplatform.com/contact)
11
+ https://www.hydrogenplatform.com/docs/proton/v1
13
12
 
14
- ## Installation
15
- ### Update Base Path
16
- Follow steps to verify the base URL path:
17
- 1. Go to configuration file located under lib folder.
18
- 2. Search for @host and change/verify the URL according to the environment.
19
- **Sandbox Base URL**
20
- https://sandbox.hydrogenplatform.com/proton/v1
21
- **Production Base URL**
22
- https://api.hydrogenplatform.com/proton/v1
23
-
24
- ### Build a gem
13
+ ## Requirements
14
+ 1. Ruby 2.7+
25
15
 
26
- To build the Ruby code into a gem:
16
+ ## Installation
27
17
 
28
- ```shell
29
- gem build proton_api.gemspec
30
- ```
18
+ ### Install via Ruby Gems
31
19
 
32
- Then either install the gem locally:
20
+ Install the gem:
33
21
 
34
22
  ```shell
35
- gem install ./proton_api-1.8.0.gem
23
+ gem install proton_api
36
24
  ```
37
- (for development, run `gem install --dev ./proton_api-1.8.0.gem` to install the development dependencies)
38
25
 
39
- or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
26
+ The add this to the Gemfile:
40
27
 
41
- Finally add this to the Gemfile:
28
+ gem 'proton_api', '~> 1.9'
42
29
 
43
- gem 'proton_api', '~> 1.8.0'
44
-
45
- ### Install from Git
46
-
47
- If the Ruby gem is hosted at a git repository: https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO, then add the following in the Gemfile:
30
+ ## Getting Started
48
31
 
49
- gem 'proton_api', :git => 'https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO.git'
32
+ Please first follow the [installation](#installation) instructions. Then make sure you use the proper base URL:
50
33
 
51
- ### Include the Ruby code directly
34
+ ### Base URL
52
35
 
53
- Include the Ruby code directly using `-I` as follows:
36
+ 1. Go to configuration file located under lib folder.
37
+ 2. Search for @host and change/verify the URL according to the environment.
54
38
 
55
- ```shell
56
- ruby -Ilib script.rb
57
- ```
39
+ **Sandbox Base URL**
40
+ sandbox.hydrogenplatform.com
58
41
 
59
- ## Getting Started
42
+ **Production Base URL**
43
+ api.hydrogenplatform.com
60
44
 
61
- Please follow the [installation](#installation) procedure and then run the following code:
62
45
  ```ruby
63
46
  # Load the gem
64
47
  require 'proton_api'
65
48
 
66
49
  # Setup authorization
67
50
  ProtonApi.configure do |config|
68
- # Creating a token for grant_type=client_credentials
69
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
70
- # Creating a token for grant_type=password
71
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
72
- # Creating a token using client token
73
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
51
+ # Use one of the below method to generate oauth token
52
+ # Creating a token for grant_type=client_credentials
53
+ config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
54
+ # Creating a token for grant_type=password
55
+ config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
56
+ # Creating a token using client token
57
+ config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
74
58
  end
75
-
76
-
77
59
  api_instance = ProtonApi::AnnuitiesApi.new
78
60
 
79
61
  annuity_calculator_accumulation_horizon_request = ProtonApi::AnnuityCalculatorAccumulationHorizonRequest.new # AnnuityCalculatorAccumulationHorizonRequest | Request payload for Annuity Calculator - Accumulation Horizon
80
-
81
-
82
62
  begin
83
63
  #Annuity Calculator - Accumulation Horizon
84
64
  result = api_instance.annuity_calculator_accumulation_horizon(annuity_calculator_accumulation_horizon_request)
@@ -88,159 +68,9 @@ rescue ProtonApi::ApiError => e
88
68
  end
89
69
 
90
70
  ```
71
+ ## Author
72
+ The Hydrogen Technology Corporation
91
73
 
92
- ## Documentation for API Endpoints
93
-
94
- All URIs are relative to *https://sandbox.hydrogenplatform.com/proton/v1*
95
-
96
- Class | Method | HTTP request | Description
97
- ------------ | ------------- | ------------- | -------------
98
- *ProtonApi::AnnuitiesApi* | [**annuity_calculator_accumulation_horizon**](docs/AnnuitiesApi.md#annuity_calculator_accumulation_horizon) | **POST** /annuity_calculator/accumulation_horizon | Annuity Calculator - Accumulation Horizon
99
- *ProtonApi::AnnuitiesApi* | [**annuity_calculator_annuity_amount**](docs/AnnuitiesApi.md#annuity_calculator_annuity_amount) | **POST** /annuity_calculator/annuity_amount | Annuity Calculator - Annuity Amount
100
- *ProtonApi::AnnuitiesApi* | [**annuity_calculator_decumulation_horizon**](docs/AnnuitiesApi.md#annuity_calculator_decumulation_horizon) | **POST** /annuity_calculator/decumulation_horizon | Annuity Calculator - Decumulation Horizon
101
- *ProtonApi::AnnuitiesApi* | [**annuity_calculator_deposit_amount**](docs/AnnuitiesApi.md#annuity_calculator_deposit_amount) | **POST** /annuity_calculator/deposit_amount | Annuity Calculator - Deposit Amount
102
- *ProtonApi::AnnuitiesApi* | [**annuity_calculator_initial_balance**](docs/AnnuitiesApi.md#annuity_calculator_initial_balance) | **POST** /annuity_calculator/initial_balance | Annuity Calculator - Initial Balance
103
- *ProtonApi::AnnuitiesApi* | [**variable_annuity**](docs/AnnuitiesApi.md#variable_annuity) | **POST** /variable_annuity | Variable Annuity
104
- *ProtonApi::BusinessFinancialManagementApi* | [**business_financial_health_check**](docs/BusinessFinancialManagementApi.md#business_financial_health_check) | **POST** /business/financial_health_check | Business Financial Health Check
105
- *ProtonApi::BusinessFinancialManagementApi* | [**cash_analysis**](docs/BusinessFinancialManagementApi.md#cash_analysis) | **POST** /business/cash_analysis | Cash Analysis
106
- *ProtonApi::BusinessFinancialManagementApi* | [**customer_analysis**](docs/BusinessFinancialManagementApi.md#customer_analysis) | **POST** /business/customer_analysis | Customer Analysis
107
- *ProtonApi::BusinessFinancialManagementApi* | [**financial_statement_analysis**](docs/BusinessFinancialManagementApi.md#financial_statement_analysis) | **POST** /business/financial_statement_analysis | Financial Statement Analysis
108
- *ProtonApi::BusinessFinancialManagementApi* | [**invoice_analysis**](docs/BusinessFinancialManagementApi.md#invoice_analysis) | **POST** /business/invoice_analysis | Invoice Analysis
109
- *ProtonApi::CardsApi* | [**card_limit_check**](docs/CardsApi.md#card_limit_check) | **POST** /card_limit_check | Card Limit Check
110
- *ProtonApi::CardsApi* | [**card_transaction_authorization**](docs/CardsApi.md#card_transaction_authorization) | **POST** /card_authorization | Card Transaction Authorization
111
- *ProtonApi::FinancialHealthApi* | [**diversification_score**](docs/FinancialHealthApi.md#diversification_score) | **POST** /diversification_score | Diversification Score
112
- *ProtonApi::FinancialHealthApi* | [**emergency_fund_calculator**](docs/FinancialHealthApi.md#emergency_fund_calculator) | **POST** /emergency_fund_calculator | Emergency Fund Calculator
113
- *ProtonApi::FinancialHealthApi* | [**financial_health_check**](docs/FinancialHealthApi.md#financial_health_check) | **POST** /financial_health_check | Financial Health Check
114
- *ProtonApi::FinancialHealthApi* | [**portfolio_optimization_score**](docs/FinancialHealthApi.md#portfolio_optimization_score) | **POST** /portfolio_optimization_score | Portfolio Optimization Score
115
- *ProtonApi::FinancialPlanningApi* | [**education_calculator_annual_cost**](docs/FinancialPlanningApi.md#education_calculator_annual_cost) | **POST** /education_calculator/annual_cost | Education Calculator - Annual Cost
116
- *ProtonApi::FinancialPlanningApi* | [**education_calculator_deposit_amount**](docs/FinancialPlanningApi.md#education_calculator_deposit_amount) | **POST** /education_calculator/deposit_amount | Education Calculator - Deposit Amount
117
- *ProtonApi::FinancialPlanningApi* | [**education_calculator_percent_covered**](docs/FinancialPlanningApi.md#education_calculator_percent_covered) | **POST** /education_calculator/percent_covered | Education Calculator - Percent Covered
118
- *ProtonApi::FinancialPlanningApi* | [**mortgage_calculator_down_payment**](docs/FinancialPlanningApi.md#mortgage_calculator_down_payment) | **POST** /mortgage_calculator/down_payment | Mortgage Calculator - Down Payment
119
- *ProtonApi::FinancialPlanningApi* | [**mortgage_calculator_home_price**](docs/FinancialPlanningApi.md#mortgage_calculator_home_price) | **POST** /mortgage_calculator/home_price | Mortgage Calculator - Home Price
120
- *ProtonApi::FinancialPlanningApi* | [**mortgage_calculator_periodic_payment**](docs/FinancialPlanningApi.md#mortgage_calculator_periodic_payment) | **POST** /mortgage_calculator/periodic_payment | Mortgage Calculator - Periodic Payment
121
- *ProtonApi::FinancialPlanningApi* | [**purchase_calculator_amount**](docs/FinancialPlanningApi.md#purchase_calculator_amount) | **POST** /purchase_calculator/amount | Purchase Calculator - Amount
122
- *ProtonApi::FinancialPlanningApi* | [**purchase_calculator_deposit_amount**](docs/FinancialPlanningApi.md#purchase_calculator_deposit_amount) | **POST** /purchase_calculator/deposit_amount | Purchase Calculator - Deposit Amount
123
- *ProtonApi::FinancialPlanningApi* | [**purchase_calculator_horizon**](docs/FinancialPlanningApi.md#purchase_calculator_horizon) | **POST** /purchase_calculator/horizon | Purchase Calculator - Horizon
124
- *ProtonApi::FinancialPlanningApi* | [**retirement_calculator_deposit_amount**](docs/FinancialPlanningApi.md#retirement_calculator_deposit_amount) | **POST** /retirement_calculator/deposit_amount | Retirement Calculator - Deposit Amount
125
- *ProtonApi::FinancialPlanningApi* | [**retirement_calculator_expenses**](docs/FinancialPlanningApi.md#retirement_calculator_expenses) | **POST** /retirement_calculator/expenses | Retirement Calculator - Expenses
126
- *ProtonApi::FinancialPlanningApi* | [**retirement_calculator_percent_covered**](docs/FinancialPlanningApi.md#retirement_calculator_percent_covered) | **POST** /retirement_calculator/percent_covered | Retirement Calculator - Percent Covered
127
- *ProtonApi::GoalsApi* | [**goal_accumulation_allocation**](docs/GoalsApi.md#goal_accumulation_allocation) | **POST** /goal_accumulation/allocation | Goal Accumulation Allocation
128
- *ProtonApi::GoalsApi* | [**goal_accumulation_recommendation**](docs/GoalsApi.md#goal_accumulation_recommendation) | **POST** /goal_accumulation/recommendation | Goal Accumulation Recommendation
129
- *ProtonApi::GoalsApi* | [**goal_accumulation_status**](docs/GoalsApi.md#goal_accumulation_status) | **POST** /goal_accumulation/status | Goal Accumulation Status
130
- *ProtonApi::GoalsApi* | [**goal_decumulation_allocation**](docs/GoalsApi.md#goal_decumulation_allocation) | **POST** /goal_decumulation/allocation | Goal Decumulation Allocation
131
- *ProtonApi::GoalsApi* | [**goal_decumulation_recommendation**](docs/GoalsApi.md#goal_decumulation_recommendation) | **POST** /goal_decumulation/recommendation | Goal Decumulation Recommendation
132
- *ProtonApi::GoalsApi* | [**goal_decumulation_status**](docs/GoalsApi.md#goal_decumulation_status) | **POST** /goal_decumulation/status | Goal Decumulation Status
133
- *ProtonApi::LifeInsuranceApi* | [**life_insurance_needs_calculator**](docs/LifeInsuranceApi.md#life_insurance_needs_calculator) | **POST** /life_insurance/needs_calculator | Life Insurance Needs Calculator
134
- *ProtonApi::PersonalFinancialManagementApi* | [**budget_calculator**](docs/PersonalFinancialManagementApi.md#budget_calculator) | **POST** /budget_calculator | Budget Calculator
135
- *ProtonApi::PersonalFinancialManagementApi* | [**cash_flow_analysis**](docs/PersonalFinancialManagementApi.md#cash_flow_analysis) | **POST** /cash_flow_analysis | Cash Flow Analysis
136
- *ProtonApi::PersonalFinancialManagementApi* | [**fee_analysis**](docs/PersonalFinancialManagementApi.md#fee_analysis) | **POST** /fee_analysis | RFee Analysis
137
- *ProtonApi::PersonalFinancialManagementApi* | [**financial_picture**](docs/PersonalFinancialManagementApi.md#financial_picture) | **POST** /financial_picture | Financial Picture
138
- *ProtonApi::PersonalFinancialManagementApi* | [**recurring_transaction_analysis**](docs/PersonalFinancialManagementApi.md#recurring_transaction_analysis) | **POST** /recurring_transaction_analysis | Recurring Transaction Analysis
139
- *ProtonApi::PortfolioConstructionApi* | [**mvo**](docs/PortfolioConstructionApi.md#mvo) | **POST** /mvo | MVO
140
- *ProtonApi::PortfolioManagementApi* | [**rebalancing_signal**](docs/PortfolioManagementApi.md#rebalancing_signal) | **POST** /rebalancing_signal | Rebalancing Signal
141
- *ProtonApi::RiskScoringApi* | [**dimensional_risk_score**](docs/RiskScoringApi.md#dimensional_risk_score) | **POST** /dimensional_risk_score | Dimensional Risk Score
142
- *ProtonApi::RiskScoringApi* | [**risk_allocation**](docs/RiskScoringApi.md#risk_allocation) | **POST** /risk_allocation | Risk Allocation
143
- *ProtonApi::RiskScoringApi* | [**risk_score**](docs/RiskScoringApi.md#risk_score) | **POST** /risk_score | Risk Score
144
- *ProtonApi::SimulationsApi* | [**backtest**](docs/SimulationsApi.md#backtest) | **POST** /backtest | Backtest
145
- *ProtonApi::SimulationsApi* | [**event_study**](docs/SimulationsApi.md#event_study) | **POST** /event_study | Event Study
146
- *ProtonApi::SimulationsApi* | [**monte_carlo**](docs/SimulationsApi.md#monte_carlo) | **POST** /monte_carlo | Monte Carlo
147
- *ProtonApi::SimulationsApi* | [**portfolio_what_if**](docs/SimulationsApi.md#portfolio_what_if) | **POST** /portfolio_what_if | Porfolio What-If
148
- *ProtonApi::SimulationsApi* | [**savings_calculator**](docs/SimulationsApi.md#savings_calculator) | **POST** /savings_calculator | Savings Calculator
149
- *ProtonApi::SimulationsApi* | [**scenario_analysis**](docs/SimulationsApi.md#scenario_analysis) | **POST** /scenario_analysis | Scenario Analysis
150
- *ProtonApi::SimulationsApi* | [**sensitivity_analysis**](docs/SimulationsApi.md#sensitivity_analysis) | **POST** /sensitivity_analysis | Sensitivity Analysis
151
-
152
-
153
- ## Documentation for Models
154
-
155
- - [ProtonApi::AccumulationGoalDepositConfig](docs/AccumulationGoalDepositConfig.md)
156
- - [ProtonApi::AnnuityCalculatorAccumulationHorizonRequest](docs/AnnuityCalculatorAccumulationHorizonRequest.md)
157
- - [ProtonApi::AnnuityCalculatorAnnuityAmountRequest](docs/AnnuityCalculatorAnnuityAmountRequest.md)
158
- - [ProtonApi::AnnuityCalculatorDecumulationHorizonRequest](docs/AnnuityCalculatorDecumulationHorizonRequest.md)
159
- - [ProtonApi::AnnuityCalculatorDepositAmountRequest](docs/AnnuityCalculatorDepositAmountRequest.md)
160
- - [ProtonApi::AnnuityCalculatorInitialBalanceRequest](docs/AnnuityCalculatorInitialBalanceRequest.md)
161
- - [ProtonApi::AnnuityDepositSchedule](docs/AnnuityDepositSchedule.md)
162
- - [ProtonApi::BacktestRequest](docs/BacktestRequest.md)
163
- - [ProtonApi::BeneficiaryBequestConfig](docs/BeneficiaryBequestConfig.md)
164
- - [ProtonApi::BudgetAggregationAccount](docs/BudgetAggregationAccount.md)
165
- - [ProtonApi::BudgetCalculatorRequest](docs/BudgetCalculatorRequest.md)
166
- - [ProtonApi::BudgetComponent](docs/BudgetComponent.md)
167
- - [ProtonApi::BudgetDetails](docs/BudgetDetails.md)
168
- - [ProtonApi::BusinessFinancialHealthCheckRequest](docs/BusinessFinancialHealthCheckRequest.md)
169
- - [ProtonApi::BusinessInvoiceAnalysisRequest](docs/BusinessInvoiceAnalysisRequest.md)
170
- - [ProtonApi::CalculatorDepositSchedule](docs/CalculatorDepositSchedule.md)
171
- - [ProtonApi::CalculatorDepositSchedule1](docs/CalculatorDepositSchedule1.md)
172
- - [ProtonApi::CardLimitCheckRequest](docs/CardLimitCheckRequest.md)
173
- - [ProtonApi::CardTransactionAuthorizationRequest](docs/CardTransactionAuthorizationRequest.md)
174
- - [ProtonApi::CashAnalysisRequest](docs/CashAnalysisRequest.md)
175
- - [ProtonApi::CashFlowAnalysisRequest](docs/CashFlowAnalysisRequest.md)
176
- - [ProtonApi::ChildrenEducationConfig](docs/ChildrenEducationConfig.md)
177
- - [ProtonApi::CustomerAnalysisRequest](docs/CustomerAnalysisRequest.md)
178
- - [ProtonApi::DecumulationGoalDepositConfig](docs/DecumulationGoalDepositConfig.md)
179
- - [ProtonApi::DimensionalRiskScoreRequest](docs/DimensionalRiskScoreRequest.md)
180
- - [ProtonApi::DiversificationScoreRequest](docs/DiversificationScoreRequest.md)
181
- - [ProtonApi::EducationCalculatorAnnualCostRequest](docs/EducationCalculatorAnnualCostRequest.md)
182
- - [ProtonApi::EducationCalculatorDepositAmountRequest](docs/EducationCalculatorDepositAmountRequest.md)
183
- - [ProtonApi::EducationCalculatorPercentCoveredRequest](docs/EducationCalculatorPercentCoveredRequest.md)
184
- - [ProtonApi::EducationConfig](docs/EducationConfig.md)
185
- - [ProtonApi::EmergencyFundCalculatorRequest](docs/EmergencyFundCalculatorRequest.md)
186
- - [ProtonApi::EventStudyRequest](docs/EventStudyRequest.md)
187
- - [ProtonApi::FeeAnalysisRequest](docs/FeeAnalysisRequest.md)
188
- - [ProtonApi::FinancialHealthCheckRequest](docs/FinancialHealthCheckRequest.md)
189
- - [ProtonApi::FinancialPictureRequest](docs/FinancialPictureRequest.md)
190
- - [ProtonApi::FinancialStatementAnalysisRequest](docs/FinancialStatementAnalysisRequest.md)
191
- - [ProtonApi::GoalAccumulationAllocationRequest](docs/GoalAccumulationAllocationRequest.md)
192
- - [ProtonApi::GoalAccumulationRecommendationRequest](docs/GoalAccumulationRecommendationRequest.md)
193
- - [ProtonApi::GoalAccumulationStatusRequest](docs/GoalAccumulationStatusRequest.md)
194
- - [ProtonApi::GoalConfig](docs/GoalConfig.md)
195
- - [ProtonApi::GoalDecumulationAllocationRequest](docs/GoalDecumulationAllocationRequest.md)
196
- - [ProtonApi::GoalDecumulationRecommendationRequest](docs/GoalDecumulationRecommendationRequest.md)
197
- - [ProtonApi::GoalDecumulationStatusRequest](docs/GoalDecumulationStatusRequest.md)
198
- - [ProtonApi::GoalWithdrawalConfig](docs/GoalWithdrawalConfig.md)
199
- - [ProtonApi::GuaranteedRateBenefit](docs/GuaranteedRateBenefit.md)
200
- - [ProtonApi::IncomeConfig](docs/IncomeConfig.md)
201
- - [ProtonApi::LifeInsuranceNeedsCalculatorRequest](docs/LifeInsuranceNeedsCalculatorRequest.md)
202
- - [ProtonApi::MonteCarloRequest](docs/MonteCarloRequest.md)
203
- - [ProtonApi::MortgageCalculatorDownPaymentRequest](docs/MortgageCalculatorDownPaymentRequest.md)
204
- - [ProtonApi::MortgageCalculatorHomePriceRequest](docs/MortgageCalculatorHomePriceRequest.md)
205
- - [ProtonApi::MortgageCalculatorPeriodicPaymentRequest](docs/MortgageCalculatorPeriodicPaymentRequest.md)
206
- - [ProtonApi::MvoRequest](docs/MvoRequest.md)
207
- - [ProtonApi::OptConfig](docs/OptConfig.md)
208
- - [ProtonApi::OptConfig1](docs/OptConfig1.md)
209
- - [ProtonApi::Periods](docs/Periods.md)
210
- - [ProtonApi::PortfolioOptimizationScoreRequest](docs/PortfolioOptimizationScoreRequest.md)
211
- - [ProtonApi::PortfolioWhatIfRequest](docs/PortfolioWhatIfRequest.md)
212
- - [ProtonApi::PurchaseCalculatorAmountRequest](docs/PurchaseCalculatorAmountRequest.md)
213
- - [ProtonApi::PurchaseCalculatorDepositAmountRequest](docs/PurchaseCalculatorDepositAmountRequest.md)
214
- - [ProtonApi::PurchaseCalculatorHorizonRequest](docs/PurchaseCalculatorHorizonRequest.md)
215
- - [ProtonApi::RatioTargets](docs/RatioTargets.md)
216
- - [ProtonApi::RatioTargets1](docs/RatioTargets1.md)
217
- - [ProtonApi::RebalancingSignalRequest](docs/RebalancingSignalRequest.md)
218
- - [ProtonApi::RecommendationConfig](docs/RecommendationConfig.md)
219
- - [ProtonApi::RecommendationConfig1](docs/RecommendationConfig1.md)
220
- - [ProtonApi::RecurringTransactionAnalysisRequest](docs/RecurringTransactionAnalysisRequest.md)
221
- - [ProtonApi::RetirementCalculatorDepositAmountRequest](docs/RetirementCalculatorDepositAmountRequest.md)
222
- - [ProtonApi::RetirementCalculatorExpensesRequest](docs/RetirementCalculatorExpensesRequest.md)
223
- - [ProtonApi::RetirementCalculatorPercentCoveredRequest](docs/RetirementCalculatorPercentCoveredRequest.md)
224
- - [ProtonApi::RiskAllocationRequest](docs/RiskAllocationRequest.md)
225
- - [ProtonApi::RiskScoreRequest](docs/RiskScoreRequest.md)
226
- - [ProtonApi::SavingsCalculatorRequest](docs/SavingsCalculatorRequest.md)
227
- - [ProtonApi::SavingsDepositSchedule](docs/SavingsDepositSchedule.md)
228
- - [ProtonApi::ScenarioAnalysisRequest](docs/ScenarioAnalysisRequest.md)
229
- - [ProtonApi::SensitivityAnalysisRequest](docs/SensitivityAnalysisRequest.md)
230
- - [ProtonApi::SensitivityFactor](docs/SensitivityFactor.md)
231
- - [ProtonApi::Settings](docs/Settings.md)
232
- - [ProtonApi::VariableAnnuityRequest](docs/VariableAnnuityRequest.md)
233
- - [ProtonApi::WConfig](docs/WConfig.md)
234
- - [ProtonApi::WConfig1](docs/WConfig1.md)
235
-
236
-
237
- ## Documentation for Authorization
238
-
239
-
240
- ### oauth2
241
-
242
- - **Type**: OAuth
243
- - **Flow**: application
244
- - **Authorization URL**:
245
- - **Scopes**: N/A
74
+ https://www.hydrogenplatform.com
246
75
 
76
+ *Generated using [Swagger Codegen](https://github.com/swagger-api/swagger-codegen)*
data/lib/proton_api.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
 
@@ -25,6 +25,7 @@ require 'proton_api/models/annuity_calculator_decumulation_horizon_request'
25
25
  require 'proton_api/models/annuity_calculator_deposit_amount_request'
26
26
  require 'proton_api/models/annuity_calculator_initial_balance_request'
27
27
  require 'proton_api/models/annuity_deposit_schedule'
28
+ require 'proton_api/models/answer'
28
29
  require 'proton_api/models/backtest_request'
29
30
  require 'proton_api/models/beneficiary_bequest_config'
30
31
  require 'proton_api/models/budget_aggregation_account'
@@ -35,12 +36,14 @@ require 'proton_api/models/business_financial_health_check_request'
35
36
  require 'proton_api/models/business_invoice_analysis_request'
36
37
  require 'proton_api/models/calculator_deposit_schedule'
37
38
  require 'proton_api/models/calculator_deposit_schedule1'
39
+ require 'proton_api/models/card_analysis_request'
38
40
  require 'proton_api/models/card_limit_check_request'
39
41
  require 'proton_api/models/card_transaction_authorization_request'
40
42
  require 'proton_api/models/cash_analysis_request'
41
43
  require 'proton_api/models/cash_flow_analysis_request'
42
44
  require 'proton_api/models/children_education_config'
43
45
  require 'proton_api/models/customer_analysis_request'
46
+ require 'proton_api/models/decision_tree_result_request'
44
47
  require 'proton_api/models/decumulation_goal_deposit_config'
45
48
  require 'proton_api/models/dimensional_risk_score_request'
46
49
  require 'proton_api/models/diversification_score_request'
@@ -65,6 +68,7 @@ require 'proton_api/models/goal_withdrawal_config'
65
68
  require 'proton_api/models/guaranteed_rate_benefit'
66
69
  require 'proton_api/models/income_config'
67
70
  require 'proton_api/models/life_insurance_needs_calculator_request'
71
+ require 'proton_api/models/location'
68
72
  require 'proton_api/models/monte_carlo_request'
69
73
  require 'proton_api/models/mortgage_calculator_down_payment_request'
70
74
  require 'proton_api/models/mortgage_calculator_home_price_request'
@@ -72,6 +76,8 @@ require 'proton_api/models/mortgage_calculator_periodic_payment_request'
72
76
  require 'proton_api/models/mvo_request'
73
77
  require 'proton_api/models/opt_config'
74
78
  require 'proton_api/models/opt_config1'
79
+ require 'proton_api/models/order_rebalance_request'
80
+ require 'proton_api/models/performance_calculator_request'
75
81
  require 'proton_api/models/periods'
76
82
  require 'proton_api/models/portfolio_optimization_score_request'
77
83
  require 'proton_api/models/portfolio_what_if_request'
@@ -95,6 +101,7 @@ require 'proton_api/models/scenario_analysis_request'
95
101
  require 'proton_api/models/sensitivity_analysis_request'
96
102
  require 'proton_api/models/sensitivity_factor'
97
103
  require 'proton_api/models/settings'
104
+ require 'proton_api/models/spending_analysis_request'
98
105
  require 'proton_api/models/variable_annuity_request'
99
106
  require 'proton_api/models/w_config'
100
107
  require 'proton_api/models/w_config1'
@@ -112,6 +119,7 @@ require 'proton_api/api/portfolio_construction_api'
112
119
  require 'proton_api/api/portfolio_management_api'
113
120
  require 'proton_api/api/risk_scoring_api'
114
121
  require 'proton_api/api/simulations_api'
122
+ require 'proton_api/api/util_api'
115
123
 
116
124
  module ProtonApi
117
125
  class << self
data/lib/proton_api/api/annuities_api.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
 
data/lib/proton_api/api/business_financial_management_api.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
 
data/lib/proton_api/api/cards_api.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
 
@@ -19,6 +19,60 @@ module ProtonApi
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+ # Card Analysis
23
+ # Analyze cardholder activity over time
24
+ # @param card_analysis_request Request payload for Card Analysis
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [Hash<String, Object>]
27
+ def card_analysis(card_analysis_request, opts = {})
28
+ data, _status_code, _headers = card_analysis_with_http_info(card_analysis_request, opts)
29
+ data
30
+ end
31
+
32
+ # Card Analysis
33
+ # Analyze cardholder activity over time
34
+ # @param card_analysis_request Request payload for Card Analysis
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(Hash<String, Object>, Fixnum, Hash)>] Hash<String, Object> data, response status code and response headers
37
+ def card_analysis_with_http_info(card_analysis_request, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: CardsApi.card_analysis ...'
40
+ end
41
+ # verify the required parameter 'card_analysis_request' is set
42
+ if @api_client.config.client_side_validation && card_analysis_request.nil?
43
+ fail ArgumentError, "Missing the required parameter 'card_analysis_request' when calling CardsApi.card_analysis"
44
+ end
45
+ # resource path
46
+ local_var_path = '/card_analysis'
47
+
48
+ # query parameters
49
+ query_params = {}
50
+
51
+ # header parameters
52
+ header_params = {}
53
+ # HTTP header 'Accept' (if needed)
54
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
55
+ # HTTP header 'Content-Type'
56
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
57
+
58
+ # form parameters
59
+ form_params = {}
60
+
61
+ # http body (model)
62
+ post_body = @api_client.object_to_http_body(card_analysis_request)
63
+ auth_names = ['oauth2']
64
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
65
+ :header_params => header_params,
66
+ :query_params => query_params,
67
+ :form_params => form_params,
68
+ :body => post_body,
69
+ :auth_names => auth_names,
70
+ :return_type => 'Hash<String, Object>')
71
+ if @api_client.config.debugging
72
+ @api_client.config.logger.debug "API called: CardsApi#card_analysis\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
73
+ end
74
+ return data, status_code, headers
75
+ end
22
76
  # Card Limit Check
23
77
  # Evaluate card transaction history against spending controls
24
78
  # @param card_limit_check_request Request payload for Card Limit Check