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
data/docs/AnnuityCalculatorAccumulationHorizonRequest.md DELETED
@@ -1,19 +0,0 @@
1
- # ProtonApi::AnnuityCalculatorAccumulationHorizonRequest
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **annuity_amount** | **Float** | |
7
- **aggregation_account_ids** | **Array<String>** | | [optional]
8
- **tax_rate** | **Float** | | [optional] [default to 0.0]
9
- **account_ids** | **Array<String>** | | [optional]
10
- **initial_balance** | **Float** | | [optional] [default to 0.0]
11
- **create_log** | **BOOLEAN** | | [optional] [default to false]
12
- **inflation_rate** | **Float** | | [optional] [default to 0.0]
13
- **decumulation_horizon** | **Integer** | |
14
- **accumulation_horizon** | **Integer** | | [optional]
15
- **annuity_frequency_interval** | **String** | | [optional] [default to 'year']
16
- **portfolio_return** | **Float** | |
17
- **deposit_schedule** | [**AnnuityDepositSchedule**](AnnuityDepositSchedule.md) | | [optional]
18
-
19
-
data/docs/AnnuityCalculatorAnnuityAmountRequest.md DELETED
@@ -1,19 +0,0 @@
1
- # ProtonApi::AnnuityCalculatorAnnuityAmountRequest
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **annuity_amount** | **Float** | | [optional] [default to 1.0]
7
- **aggregation_account_ids** | **Array<String>** | | [optional]
8
- **tax_rate** | **Float** | | [optional] [default to 0.0]
9
- **account_ids** | **Array<String>** | | [optional]
10
- **initial_balance** | **Float** | | [optional] [default to 0.0]
11
- **create_log** | **BOOLEAN** | | [optional] [default to false]
12
- **inflation_rate** | **Float** | | [optional] [default to 0.0]
13
- **decumulation_horizon** | **Integer** | |
14
- **accumulation_horizon** | **Integer** | |
15
- **annuity_frequency_interval** | **String** | | [optional] [default to 'year']
16
- **portfolio_return** | **Float** | |
17
- **deposit_schedule** | [**AnnuityDepositSchedule**](AnnuityDepositSchedule.md) | | [optional]
18
-
19
-
data/docs/AnnuityCalculatorDecumulationHorizonRequest.md DELETED
@@ -1,19 +0,0 @@
1
- # ProtonApi::AnnuityCalculatorDecumulationHorizonRequest
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **annuity_amount** | **Float** | |
7
- **aggregation_account_ids** | **Array<String>** | | [optional]
8
- **tax_rate** | **Float** | | [optional] [default to 0.0]
9
- **account_ids** | **Array<String>** | | [optional]
10
- **initial_balance** | **Float** | | [optional] [default to 0.0]
11
- **create_log** | **BOOLEAN** | | [optional] [default to false]
12
- **inflation_rate** | **Float** | | [optional] [default to 0.0]
13
- **decumulation_horizon** | **Integer** | | [optional]
14
- **accumulation_horizon** | **Integer** | |
15
- **annuity_frequency_interval** | **String** | | [optional] [default to 'year']
16
- **portfolio_return** | **Float** | |
17
- **deposit_schedule** | [**AnnuityDepositSchedule**](AnnuityDepositSchedule.md) | | [optional]
18
-
19
-
data/docs/AnnuityCalculatorDepositAmountRequest.md DELETED
@@ -1,19 +0,0 @@
1
- # ProtonApi::AnnuityCalculatorDepositAmountRequest
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **annuity_amount** | **Float** | |
7
- **aggregation_account_ids** | **Array<String>** | | [optional]
8
- **tax_rate** | **Float** | | [optional] [default to 0.0]
9
- **account_ids** | **Array<String>** | | [optional]
10
- **initial_balance** | **Float** | | [optional] [default to 0.0]
11
- **create_log** | **BOOLEAN** | | [optional] [default to false]
12
- **inflation_rate** | **Float** | | [optional] [default to 0.0]
13
- **decumulation_horizon** | **Integer** | |
14
- **accumulation_horizon** | **Integer** | |
15
- **annuity_frequency_interval** | **String** | | [optional] [default to 'year']
16
- **portfolio_return** | **Float** | |
17
- **deposit_schedule** | [**AnnuityDepositSchedule**](AnnuityDepositSchedule.md) | | [optional]
18
-
19
-
data/docs/AnnuityCalculatorInitialBalanceRequest.md DELETED
@@ -1,19 +0,0 @@
1
- # ProtonApi::AnnuityCalculatorInitialBalanceRequest
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **annuity_amount** | **Float** | |
7
- **aggregation_account_ids** | **Array<String>** | | [optional]
8
- **tax_rate** | **Float** | | [optional] [default to 0.0]
9
- **account_ids** | **Array<String>** | | [optional]
10
- **initial_balance** | **Float** | | [optional] [default to 0.0]
11
- **create_log** | **BOOLEAN** | | [optional] [default to false]
12
- **inflation_rate** | **Float** | | [optional] [default to 0.0]
13
- **decumulation_horizon** | **Integer** | |
14
- **accumulation_horizon** | **Integer** | |
15
- **annuity_frequency_interval** | **String** | | [optional] [default to 'year']
16
- **portfolio_return** | **Float** | |
17
- **deposit_schedule** | [**AnnuityDepositSchedule**](AnnuityDepositSchedule.md) | | [optional]
18
-
19
-
data/docs/AnnuityDepositSchedule.md DELETED
@@ -1,10 +0,0 @@
1
- # ProtonApi::AnnuityDepositSchedule
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **adjust_deposit_for_inflation** | **BOOLEAN** | | [optional] [default to true]
7
- **deposit_frequency_interval** | **String** | | [optional] [default to 'year']
8
- **deposit_amount** | **Float** | | [optional] [default to 0.0]
9
-
10
-
data/docs/BacktestRequest.md DELETED
@@ -1,17 +0,0 @@
1
- # ProtonApi::BacktestRequest
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **asset_size** | **Float** | | [optional]
7
- **end_date** | **Date** | |
8
- **stats** | **BOOLEAN** | | [optional] [default to true]
9
- **asset_sizes** | **BOOLEAN** | | [optional] [default to true]
10
- **model_id** | **String** | | [optional]
11
- **initial_weights** | **Object** | | [optional]
12
- **trades** | **BOOLEAN** | | [optional] [default to true]
13
- **start_date** | **Date** | |
14
- **settings** | [**Settings**](Settings.md) | | [optional]
15
- **holdings** | **BOOLEAN** | | [optional] [default to true]
16
-
17
-
data/docs/BeneficiaryBequestConfig.md DELETED
@@ -1,10 +0,0 @@
1
- # ProtonApi::BeneficiaryBequestConfig
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **bequest_duration** | **Integer** | | [optional] [default to 10]
7
- **bequest_amount** | **Float** | |
8
- **years_until_bequest** | **Integer** | | [optional] [default to 0]
9
-
10
-
data/docs/BudgetAggregationAccount.md DELETED
@@ -1,8 +0,0 @@
1
- # ProtonApi::BudgetAggregationAccount
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **aggregation_account_id** | **String** | |
7
-
8
-
data/docs/BudgetCalculatorRequest.md DELETED
@@ -1,16 +0,0 @@
1
- # ProtonApi::BudgetCalculatorRequest
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **as_of_date** | **Date** | | [optional]
7
- **show_budget_track** | **BOOLEAN** | | [optional] [default to true]
8
- **budget_id** | **String** | | [optional]
9
- **currency_conversion** | **String** | | [optional]
10
- **lookback_periods** | **Integer** | | [optional] [default to 1]
11
- **show_average_spend** | **BOOLEAN** | | [optional] [default to false]
12
- **budget_details** | [**BudgetDetails**](BudgetDetails.md) | | [optional]
13
- **relative_lookback** | **BOOLEAN** | | [optional] [default to true]
14
- **scope** | **String** | | [optional] [default to 'all']
15
-
16
-
data/docs/BudgetComponent.md DELETED
@@ -1,10 +0,0 @@
1
- # ProtonApi::BudgetComponent
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **subcategory** | **String** | | [optional]
7
- **category** | **String** | |
8
- **value** | **Float** | |
9
-
10
-
data/docs/BudgetDetails.md DELETED
@@ -1,17 +0,0 @@
1
- # ProtonApi::BudgetDetails
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **frequency_unit** | **String** | |
7
- **end_date** | **Date** | | [optional]
8
- **client_id** | **String** | | [optional]
9
- **budget** | [**Array<BudgetComponent>**](BudgetComponent.md) | | [optional]
10
- **total_value** | **Float** | | [optional]
11
- **account_id** | **String** | | [optional]
12
- **aggregation_accounts** | [**Array<BudgetAggregationAccount>**](BudgetAggregationAccount.md) | | [optional]
13
- **currency_code** | **String** | | [optional]
14
- **frequency** | **Integer** | | [optional] [default to 1]
15
- **start_date** | **Date** | | [optional]
16
-
17
-
data/docs/BusinessFinancialHealthCheckRequest.md DELETED
@@ -1,22 +0,0 @@
1
- # ProtonApi::BusinessFinancialHealthCheckRequest
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **period_length** | **String** | | [optional] [default to 'quarterly']
7
- **net_income** | **Float** | | [optional]
8
- **period_month** | **Integer** | | [optional]
9
- **total_revenue** | **Float** | | [optional]
10
- **total_assets** | **Float** | | [optional]
11
- **client_id** | **String** | | [optional]
12
- **accounting_method** | **String** | | [optional]
13
- **period_year** | **Integer** | | [optional]
14
- **currency_conversion** | **String** | | [optional]
15
- **total_liabilities** | **Float** | | [optional]
16
- **period_type** | **String** | | [optional]
17
- **currency_code** | **String** | | [optional]
18
- **ratio_targets** | [**RatioTargets1**](RatioTargets1.md) | | [optional]
19
- **total_equity** | **Float** | | [optional]
20
- **period_quarter** | **Integer** | | [optional]
21
-
22
-
data/docs/BusinessFinancialManagementApi.md DELETED
@@ -1,288 +0,0 @@
1
- # ProtonApi::BusinessFinancialManagementApi
2
-
3
- All URIs are relative to *https://sandbox.hydrogenplatform.com/proton/v1*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**business_financial_health_check**](BusinessFinancialManagementApi.md#business_financial_health_check) | **POST** /business/financial_health_check | Business Financial Health Check
8
- [**cash_analysis**](BusinessFinancialManagementApi.md#cash_analysis) | **POST** /business/cash_analysis | Cash Analysis
9
- [**customer_analysis**](BusinessFinancialManagementApi.md#customer_analysis) | **POST** /business/customer_analysis | Customer Analysis
10
- [**financial_statement_analysis**](BusinessFinancialManagementApi.md#financial_statement_analysis) | **POST** /business/financial_statement_analysis | Financial Statement Analysis
11
- [**invoice_analysis**](BusinessFinancialManagementApi.md#invoice_analysis) | **POST** /business/invoice_analysis | Invoice Analysis
12
-
13
-
14
- # **business_financial_health_check**
15
- > Hash<String, Object> business_financial_health_check(business_financial_health_check_request)
16
-
17
- Business Financial Health Check
18
-
19
- Calculate a series of financial ratios to assess business financial health
20
-
21
- ### Example
22
- ```ruby
23
- # load the gem
24
- require 'proton_api'
25
- # setup authorization
26
- ProtonApi.configure do |config|
27
- # Creating a token for grant_type=client_credentials
28
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
29
- # Creating a token for grant_type=password
30
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
31
- # Creating a token using client token
32
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
33
- end
34
- api_instance = ProtonApi::BusinessFinancialManagementApi.new
35
-
36
- business_financial_health_check_request = ProtonApi::BusinessFinancialHealthCheckRequest.new # BusinessFinancialHealthCheckRequest | Request payload for Business Financial Health Check
37
-
38
-
39
- begin
40
- #Business Financial Health Check
41
- result = api_instance.business_financial_health_check(business_financial_health_check_request)
42
- p result
43
- rescue ProtonApi::ApiError => e
44
- puts "Exception when calling BusinessFinancialManagementApi->business_financial_health_check: #{e}"
45
- end
46
- ```
47
-
48
- ### Parameters
49
-
50
- Name | Type | Description | Notes
51
- ------------- | ------------- | ------------- | -------------
52
- **business_financial_health_check_request** | [**BusinessFinancialHealthCheckRequest**](BusinessFinancialHealthCheckRequest.md)| Request payload for Business Financial Health Check |
53
-
54
- ### Return type
55
-
56
- **Hash<String, Object>**
57
-
58
- ### Authorization
59
-
60
- [oauth2](../README.md#oauth2)
61
-
62
- ### HTTP request headers
63
-
64
- - **Content-Type**: application/json
65
- - **Accept**: application/json
66
-
67
-
68
-
69
- # **cash_analysis**
70
- > Hash<String, Object> cash_analysis(cash_analysis_request)
71
-
72
- Cash Analysis
73
-
74
- Analyze cash activity over time
75
-
76
- ### Example
77
- ```ruby
78
- # load the gem
79
- require 'proton_api'
80
- # setup authorization
81
- ProtonApi.configure do |config|
82
- # Creating a token for grant_type=client_credentials
83
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
84
- # Creating a token for grant_type=password
85
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
86
- # Creating a token using client token
87
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
88
- end
89
- api_instance = ProtonApi::BusinessFinancialManagementApi.new
90
-
91
- cash_analysis_request = ProtonApi::CashAnalysisRequest.new # CashAnalysisRequest | Request payload for Cash Analysis
92
-
93
-
94
- begin
95
- #Cash Analysis
96
- result = api_instance.cash_analysis(cash_analysis_request)
97
- p result
98
- rescue ProtonApi::ApiError => e
99
- puts "Exception when calling BusinessFinancialManagementApi->cash_analysis: #{e}"
100
- end
101
- ```
102
-
103
- ### Parameters
104
-
105
- Name | Type | Description | Notes
106
- ------------- | ------------- | ------------- | -------------
107
- **cash_analysis_request** | [**CashAnalysisRequest**](CashAnalysisRequest.md)| Request payload for Cash Analysis |
108
-
109
- ### Return type
110
-
111
- **Hash<String, Object>**
112
-
113
- ### Authorization
114
-
115
- [oauth2](../README.md#oauth2)
116
-
117
- ### HTTP request headers
118
-
119
- - **Content-Type**: application/json
120
- - **Accept**: application/json
121
-
122
-
123
-
124
- # **customer_analysis**
125
- > Hash<String, Object> customer_analysis(customer_analysis_request)
126
-
127
- Customer Analysis
128
-
129
- Analyze customer revenues over a time period
130
-
131
- ### Example
132
- ```ruby
133
- # load the gem
134
- require 'proton_api'
135
- # setup authorization
136
- ProtonApi.configure do |config|
137
- # Creating a token for grant_type=client_credentials
138
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
139
- # Creating a token for grant_type=password
140
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
141
- # Creating a token using client token
142
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
143
- end
144
- api_instance = ProtonApi::BusinessFinancialManagementApi.new
145
-
146
- customer_analysis_request = ProtonApi::CustomerAnalysisRequest.new # CustomerAnalysisRequest | Request payload for Customer Analysis
147
-
148
-
149
- begin
150
- #Customer Analysis
151
- result = api_instance.customer_analysis(customer_analysis_request)
152
- p result
153
- rescue ProtonApi::ApiError => e
154
- puts "Exception when calling BusinessFinancialManagementApi->customer_analysis: #{e}"
155
- end
156
- ```
157
-
158
- ### Parameters
159
-
160
- Name | Type | Description | Notes
161
- ------------- | ------------- | ------------- | -------------
162
- **customer_analysis_request** | [**CustomerAnalysisRequest**](CustomerAnalysisRequest.md)| Request payload for Customer Analysis |
163
-
164
- ### Return type
165
-
166
- **Hash<String, Object>**
167
-
168
- ### Authorization
169
-
170
- [oauth2](../README.md#oauth2)
171
-
172
- ### HTTP request headers
173
-
174
- - **Content-Type**: application/json
175
- - **Accept**: application/json
176
-
177
-
178
-
179
- # **financial_statement_analysis**
180
- > Hash<String, Object> financial_statement_analysis(financial_statement_analysis_request)
181
-
182
- Financial Statement Analysis
183
-
184
- Analyze financial statement accounting data for a business
185
-
186
- ### Example
187
- ```ruby
188
- # load the gem
189
- require 'proton_api'
190
- # setup authorization
191
- ProtonApi.configure do |config|
192
- # Creating a token for grant_type=client_credentials
193
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
194
- # Creating a token for grant_type=password
195
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
196
- # Creating a token using client token
197
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
198
- end
199
- api_instance = ProtonApi::BusinessFinancialManagementApi.new
200
-
201
- financial_statement_analysis_request = ProtonApi::FinancialStatementAnalysisRequest.new # FinancialStatementAnalysisRequest | Request payload for Financial Statement Analysis
202
-
203
-
204
- begin
205
- #Financial Statement Analysis
206
- result = api_instance.financial_statement_analysis(financial_statement_analysis_request)
207
- p result
208
- rescue ProtonApi::ApiError => e
209
- puts "Exception when calling BusinessFinancialManagementApi->financial_statement_analysis: #{e}"
210
- end
211
- ```
212
-
213
- ### Parameters
214
-
215
- Name | Type | Description | Notes
216
- ------------- | ------------- | ------------- | -------------
217
- **financial_statement_analysis_request** | [**FinancialStatementAnalysisRequest**](FinancialStatementAnalysisRequest.md)| Request payload for Financial Statement Analysis |
218
-
219
- ### Return type
220
-
221
- **Hash<String, Object>**
222
-
223
- ### Authorization
224
-
225
- [oauth2](../README.md#oauth2)
226
-
227
- ### HTTP request headers
228
-
229
- - **Content-Type**: application/json
230
- - **Accept**: application/json
231
-
232
-
233
-
234
- # **invoice_analysis**
235
- > Hash<String, Object> invoice_analysis(invoice_analysis_request)
236
-
237
- Invoice Analysis
238
-
239
- Analyze invoices to understand the context of money owed and paid to a business
240
-
241
- ### Example
242
- ```ruby
243
- # load the gem
244
- require 'proton_api'
245
- # setup authorization
246
- ProtonApi.configure do |config|
247
- # Creating a token for grant_type=client_credentials
248
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
249
- # Creating a token for grant_type=password
250
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
251
- # Creating a token using client token
252
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
253
- end
254
- api_instance = ProtonApi::BusinessFinancialManagementApi.new
255
-
256
- invoice_analysis_request = ProtonApi::BusinessInvoiceAnalysisRequest.new # BusinessInvoiceAnalysisRequest | Request payload for Invoice Analysis
257
-
258
-
259
- begin
260
- #Invoice Analysis
261
- result = api_instance.invoice_analysis(invoice_analysis_request)
262
- p result
263
- rescue ProtonApi::ApiError => e
264
- puts "Exception when calling BusinessFinancialManagementApi->invoice_analysis: #{e}"
265
- end
266
- ```
267
-
268
- ### Parameters
269
-
270
- Name | Type | Description | Notes
271
- ------------- | ------------- | ------------- | -------------
272
- **invoice_analysis_request** | [**BusinessInvoiceAnalysisRequest**](BusinessInvoiceAnalysisRequest.md)| Request payload for Invoice Analysis |
273
-
274
- ### Return type
275
-
276
- **Hash<String, Object>**
277
-
278
- ### Authorization
279
-
280
- [oauth2](../README.md#oauth2)
281
-
282
- ### HTTP request headers
283
-
284
- - **Content-Type**: application/json
285
- - **Accept**: application/json
286
-
287
-
288
-