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/FinancialStatementAnalysisRequest.md DELETED
@@ -1,22 +0,0 @@
1
- # ProtonApi::FinancialStatementAnalysisRequest
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **period_length** | **String** | | [optional] [default to 'quarterly']
7
- **period_month** | **Integer** | | [optional]
8
- **end_date** | **Date** | | [optional]
9
- **client_id** | **String** | | [optional]
10
- **accounting_method** | **String** | |
11
- **period_year** | **Integer** | | [optional]
12
- **currency_conversion** | **String** | | [optional]
13
- **history_frequency_interval** | **String** | | [optional] [default to 'month']
14
- **start_date** | **Date** | | [optional]
15
- **period_type** | **String** | | [optional]
16
- **currency_code** | **String** | | [optional]
17
- **show_history** | **BOOLEAN** | | [optional] [default to false]
18
- **stat_names** | **Array<String>** | | [optional]
19
- **period_quarter** | **Integer** | | [optional]
20
- **statement_type** | **String** | | [optional] [default to 'all']
21
-
22
-
data/docs/GoalAccumulationAllocationRequest.md DELETED
@@ -1,33 +0,0 @@
1
- # ProtonApi::GoalAccumulationAllocationRequest
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **thresh_type** | **String** | | [optional] [default to 'perc']
7
- **goal_id** | **String** | | [optional]
8
- **client_id** | **String** | | [optional]
9
- **conf_tgt** | **Float** | | [optional] [default to 0.9]
10
- **risk_score** | **Float** | | [optional]
11
- **remove_outliers** | **BOOLEAN** | | [optional] [default to true]
12
- **allocation_priority** | **String** | |
13
- **market_data_source** | **String** | | [optional] [default to 'nucleus']
14
- **compounding_rate** | **Float** | | [optional] [default to 0.0]
15
- **adjust_for_compounding** | **BOOLEAN** | | [optional] [default to false]
16
- **opt_config** | [**OptConfig**](OptConfig.md) | | [optional]
17
- **deposit_config** | [**Array<AccumulationGoalDepositConfig>**](AccumulationGoalDepositConfig.md) | | [optional]
18
- **use_proxy_data** | **BOOLEAN** | | [optional] [default to false]
19
- **thresh** | **Float** | | [optional]
20
- **horizon_frequency** | **String** | | [optional] [default to 'year']
21
- **recommendation_config** | [**RecommendationConfig**](RecommendationConfig.md) | | [optional]
22
- **create_log** | **BOOLEAN** | | [optional] [default to false]
23
- **withdrawal_tax** | **Float** | | [optional] [default to 0.0]
24
- **goal_config** | [**GoalConfig**](GoalConfig.md) | | [optional]
25
- **trading_days_per_year** | **Integer** | | [optional] [default to 252]
26
- **allocations** | **Array<String>** | | [optional]
27
- **n** | **Integer** | | [optional] [default to 1000]
28
- **horizon** | **Integer** | | [optional]
29
- **recommend_type** | **String** | | [optional] [default to 'horizon']
30
- **curr_inv** | **Float** | | [optional]
31
- **allocation_method** | **String** | |
32
-
33
-
data/docs/GoalAccumulationRecommendationRequest.md DELETED
@@ -1,28 +0,0 @@
1
- # ProtonApi::GoalAccumulationRecommendationRequest
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **thresh_type** | **String** | | [optional] [default to 'perc']
7
- **goal_id** | **String** | | [optional]
8
- **client_id** | **String** | | [optional]
9
- **conf_tgt** | **Float** | | [optional] [default to 0.9]
10
- **remove_outliers** | **BOOLEAN** | | [optional] [default to true]
11
- **p_ret** | **Array<Float>** | |
12
- **compounding_rate** | **Float** | | [optional] [default to 0.0]
13
- **adjust_for_compounding** | **BOOLEAN** | | [optional] [default to false]
14
- **deposit_config** | [**Array<AccumulationGoalDepositConfig>**](AccumulationGoalDepositConfig.md) | | [optional]
15
- **thresh** | **Float** | | [optional]
16
- **horizon_frequency** | **String** | | [optional] [default to 'year']
17
- **recommendation_config** | [**RecommendationConfig1**](RecommendationConfig1.md) | | [optional]
18
- **create_log** | **BOOLEAN** | | [optional] [default to false]
19
- **withdrawal_tax** | **Float** | | [optional] [default to 0.0]
20
- **goal_config** | [**GoalConfig**](GoalConfig.md) | | [optional]
21
- **trading_days_per_year** | **Integer** | | [optional] [default to 252]
22
- **n** | **Integer** | | [optional] [default to 1000]
23
- **p_risk** | **Array<Float>** | |
24
- **horizon** | **Integer** | | [optional]
25
- **recommend_type** | **String** | | [optional] [default to 'horizon']
26
- **curr_inv** | **Float** | | [optional]
27
-
28
-
data/docs/GoalAccumulationStatusRequest.md DELETED
@@ -1,28 +0,0 @@
1
- # ProtonApi::GoalAccumulationStatusRequest
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **thresh_type** | **String** | | [optional] [default to 'perc']
7
- **goal_id** | **String** | | [optional]
8
- **client_id** | **String** | | [optional]
9
- **conf_tgt** | **Float** | | [optional] [default to 0.9]
10
- **remove_outliers** | **BOOLEAN** | | [optional] [default to true]
11
- **p_ret** | **Array<Float>** | |
12
- **compounding_rate** | **Float** | | [optional] [default to 0.0]
13
- **adjust_for_compounding** | **BOOLEAN** | | [optional] [default to false]
14
- **deposit_config** | [**Array<AccumulationGoalDepositConfig>**](AccumulationGoalDepositConfig.md) | | [optional]
15
- **thresh** | **Float** | | [optional]
16
- **horizon_frequency** | **String** | | [optional] [default to 'year']
17
- **recommendation_config** | [**RecommendationConfig**](RecommendationConfig.md) | | [optional]
18
- **create_log** | **BOOLEAN** | | [optional] [default to false]
19
- **withdrawal_tax** | **Float** | | [optional] [default to 0.0]
20
- **goal_config** | [**GoalConfig**](GoalConfig.md) | | [optional]
21
- **trading_days_per_year** | **Integer** | | [optional] [default to 252]
22
- **n** | **Integer** | | [optional] [default to 1000]
23
- **p_risk** | **Array<Float>** | |
24
- **horizon** | **Integer** | | [optional]
25
- **recommend_type** | **String** | | [optional] [default to 'horizon']
26
- **curr_inv** | **Float** | | [optional]
27
-
28
-
data/docs/GoalConfig.md DELETED
@@ -1,9 +0,0 @@
1
- # ProtonApi::GoalConfig
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **goal_inflation** | **Float** | | [optional] [default to 0.0]
7
- **goal_amount** | **Float** | | [optional]
8
-
9
-
data/docs/GoalDecumulationAllocationRequest.md DELETED
@@ -1,34 +0,0 @@
1
- # ProtonApi::GoalDecumulationAllocationRequest
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **thresh_type** | **String** | | [optional] [default to 'perc']
7
- **goal_id** | **String** | | [optional]
8
- **client_id** | **String** | | [optional]
9
- **conf_tgt** | **Float** | | [optional] [default to 0.9]
10
- **risk_score** | **Float** | | [optional]
11
- **remove_outliers** | **BOOLEAN** | | [optional] [default to true]
12
- **allocation_priority** | **String** | |
13
- **a_horizon** | **Integer** | | [optional]
14
- **withdrawal_config** | [**Array<GoalWithdrawalConfig>**](GoalWithdrawalConfig.md) | | [optional]
15
- **market_data_source** | **String** | | [optional] [default to 'nucleus']
16
- **compounding_rate** | **Float** | | [optional] [default to 0.0]
17
- **adjust_for_compounding** | **BOOLEAN** | | [optional] [default to false]
18
- **opt_config** | [**OptConfig**](OptConfig.md) | | [optional]
19
- **deposit_config** | [**Array<DecumulationGoalDepositConfig>**](DecumulationGoalDepositConfig.md) | | [optional]
20
- **use_proxy_data** | **BOOLEAN** | | [optional] [default to false]
21
- **thresh** | **Float** | | [optional]
22
- **horizon_frequency** | **String** | | [optional] [default to 'year']
23
- **recommendation_config** | [**RecommendationConfig**](RecommendationConfig.md) | | [optional]
24
- **create_log** | **BOOLEAN** | | [optional] [default to false]
25
- **withdrawal_tax** | **Float** | | [optional] [default to 0.0]
26
- **trading_days_per_year** | **Integer** | | [optional] [default to 252]
27
- **allocations** | **Array<String>** | | [optional]
28
- **n** | **Integer** | | [optional] [default to 1000]
29
- **d_horizon** | **Integer** | | [optional]
30
- **curr_inv** | **Float** | | [optional]
31
- **recommend_type** | **String** | | [optional] [default to 'horizon']
32
- **allocation_method** | **String** | |
33
-
34
-
data/docs/GoalDecumulationRecommendationRequest.md DELETED
@@ -1,29 +0,0 @@
1
- # ProtonApi::GoalDecumulationRecommendationRequest
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **thresh_type** | **String** | | [optional] [default to 'perc']
7
- **goal_id** | **String** | | [optional]
8
- **client_id** | **String** | | [optional]
9
- **conf_tgt** | **Float** | | [optional] [default to 0.9]
10
- **remove_outliers** | **BOOLEAN** | | [optional] [default to true]
11
- **a_horizon** | **Integer** | | [optional]
12
- **withdrawal_config** | [**Array<GoalWithdrawalConfig>**](GoalWithdrawalConfig.md) | | [optional]
13
- **p_ret** | **Array<Float>** | |
14
- **compounding_rate** | **Float** | | [optional] [default to 0.0]
15
- **adjust_for_compounding** | **BOOLEAN** | | [optional] [default to false]
16
- **deposit_config** | [**Array<DecumulationGoalDepositConfig>**](DecumulationGoalDepositConfig.md) | | [optional]
17
- **thresh** | **Float** | | [optional]
18
- **horizon_frequency** | **String** | | [optional] [default to 'year']
19
- **recommendation_config** | [**RecommendationConfig1**](RecommendationConfig1.md) | | [optional]
20
- **create_log** | **BOOLEAN** | | [optional] [default to false]
21
- **withdrawal_tax** | **Float** | | [optional] [default to 0.0]
22
- **trading_days_per_year** | **Integer** | | [optional] [default to 252]
23
- **n** | **Integer** | | [optional] [default to 1000]
24
- **d_horizon** | **Integer** | | [optional]
25
- **p_risk** | **Array<Float>** | |
26
- **curr_inv** | **Float** | | [optional]
27
- **recommend_type** | **String** | | [optional] [default to 'horizon']
28
-
29
-
data/docs/GoalDecumulationStatusRequest.md DELETED
@@ -1,29 +0,0 @@
1
- # ProtonApi::GoalDecumulationStatusRequest
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **thresh_type** | **String** | | [optional] [default to 'perc']
7
- **goal_id** | **String** | | [optional]
8
- **client_id** | **String** | | [optional]
9
- **conf_tgt** | **Float** | | [optional] [default to 0.9]
10
- **remove_outliers** | **BOOLEAN** | | [optional] [default to true]
11
- **a_horizon** | **Integer** | | [optional]
12
- **withdrawal_config** | [**Array<GoalWithdrawalConfig>**](GoalWithdrawalConfig.md) | | [optional]
13
- **p_ret** | **Array<Float>** | |
14
- **compounding_rate** | **Float** | | [optional] [default to 0.0]
15
- **adjust_for_compounding** | **BOOLEAN** | | [optional] [default to false]
16
- **deposit_config** | [**Array<DecumulationGoalDepositConfig>**](DecumulationGoalDepositConfig.md) | | [optional]
17
- **thresh** | **Float** | | [optional]
18
- **horizon_frequency** | **String** | | [optional] [default to 'year']
19
- **recommendation_config** | [**RecommendationConfig**](RecommendationConfig.md) | | [optional]
20
- **create_log** | **BOOLEAN** | | [optional] [default to false]
21
- **withdrawal_tax** | **Float** | | [optional] [default to 0.0]
22
- **trading_days_per_year** | **Integer** | | [optional] [default to 252]
23
- **n** | **Integer** | | [optional] [default to 1000]
24
- **d_horizon** | **Integer** | | [optional]
25
- **p_risk** | **Array<Float>** | |
26
- **curr_inv** | **Float** | | [optional]
27
- **recommend_type** | **String** | | [optional] [default to 'horizon']
28
-
29
-
data/docs/GoalWithdrawalConfig.md DELETED
@@ -1,14 +0,0 @@
1
- # ProtonApi::GoalWithdrawalConfig
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **with_start_reference** | **String** | | [optional] [default to 'a_end']
7
- **with_amount** | **Float** | | [optional]
8
- **with_inflation** | **Float** | | [optional] [default to 0.0]
9
- **with_start_period** | **Integer** | | [optional] [default to 0]
10
- **with_end_period** | **Integer** | | [optional] [default to 0]
11
- **with_end_reference** | **String** | | [optional] [default to 'd_end']
12
- **with_frequency** | **String** | | [optional] [default to 'year']
13
-
14
-
data/docs/GoalsApi.md DELETED
@@ -1,344 +0,0 @@
1
- # ProtonApi::GoalsApi
2
-
3
- All URIs are relative to *https://sandbox.hydrogenplatform.com/proton/v1*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**goal_accumulation_allocation**](GoalsApi.md#goal_accumulation_allocation) | **POST** /goal_accumulation/allocation | Goal Accumulation Allocation
8
- [**goal_accumulation_recommendation**](GoalsApi.md#goal_accumulation_recommendation) | **POST** /goal_accumulation/recommendation | Goal Accumulation Recommendation
9
- [**goal_accumulation_status**](GoalsApi.md#goal_accumulation_status) | **POST** /goal_accumulation/status | Goal Accumulation Status
10
- [**goal_decumulation_allocation**](GoalsApi.md#goal_decumulation_allocation) | **POST** /goal_decumulation/allocation | Goal Decumulation Allocation
11
- [**goal_decumulation_recommendation**](GoalsApi.md#goal_decumulation_recommendation) | **POST** /goal_decumulation/recommendation | Goal Decumulation Recommendation
12
- [**goal_decumulation_status**](GoalsApi.md#goal_decumulation_status) | **POST** /goal_decumulation/status | Goal Decumulation Status
13
-
14
-
15
- # **goal_accumulation_allocation**
16
- > Hash<String, Object> goal_accumulation_allocation(goal_accumulation_allocation_request)
17
-
18
- Goal Accumulation Allocation
19
-
20
- Allocate based on an accumulation goal
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::GoalsApi.new
36
-
37
- goal_accumulation_allocation_request = ProtonApi::GoalAccumulationAllocationRequest.new # GoalAccumulationAllocationRequest | Request payload for Goal Accumulation Allocation
38
-
39
-
40
- begin
41
- #Goal Accumulation Allocation
42
- result = api_instance.goal_accumulation_allocation(goal_accumulation_allocation_request)
43
- p result
44
- rescue ProtonApi::ApiError => e
45
- puts "Exception when calling GoalsApi->goal_accumulation_allocation: #{e}"
46
- end
47
- ```
48
-
49
- ### Parameters
50
-
51
- Name | Type | Description | Notes
52
- ------------- | ------------- | ------------- | -------------
53
- **goal_accumulation_allocation_request** | [**GoalAccumulationAllocationRequest**](GoalAccumulationAllocationRequest.md)| Request payload for Goal Accumulation Allocation |
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
- # **goal_accumulation_recommendation**
71
- > Hash<String, Object> goal_accumulation_recommendation(goal_accumulation_recommendation_request)
72
-
73
- Goal Accumulation Recommendation
74
-
75
- Generate recommendations to achieve an accumulation goal
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::GoalsApi.new
91
-
92
- goal_accumulation_recommendation_request = ProtonApi::GoalAccumulationRecommendationRequest.new # GoalAccumulationRecommendationRequest | Request payload for Goal Accumulation Recommendation
93
-
94
-
95
- begin
96
- #Goal Accumulation Recommendation
97
- result = api_instance.goal_accumulation_recommendation(goal_accumulation_recommendation_request)
98
- p result
99
- rescue ProtonApi::ApiError => e
100
- puts "Exception when calling GoalsApi->goal_accumulation_recommendation: #{e}"
101
- end
102
- ```
103
-
104
- ### Parameters
105
-
106
- Name | Type | Description | Notes
107
- ------------- | ------------- | ------------- | -------------
108
- **goal_accumulation_recommendation_request** | [**GoalAccumulationRecommendationRequest**](GoalAccumulationRecommendationRequest.md)| Request payload for Goal Accumulation Recommendation |
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
- # **goal_accumulation_status**
126
- > Hash<String, Object> goal_accumulation_status(goal_accumulation_status_request)
127
-
128
- Goal Accumulation Status
129
-
130
- Track the status of an accumulation goal
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::GoalsApi.new
146
-
147
- goal_accumulation_status_request = ProtonApi::GoalAccumulationStatusRequest.new # GoalAccumulationStatusRequest | Request payload for Goal Accumulation Status
148
-
149
-
150
- begin
151
- #Goal Accumulation Status
152
- result = api_instance.goal_accumulation_status(goal_accumulation_status_request)
153
- p result
154
- rescue ProtonApi::ApiError => e
155
- puts "Exception when calling GoalsApi->goal_accumulation_status: #{e}"
156
- end
157
- ```
158
-
159
- ### Parameters
160
-
161
- Name | Type | Description | Notes
162
- ------------- | ------------- | ------------- | -------------
163
- **goal_accumulation_status_request** | [**GoalAccumulationStatusRequest**](GoalAccumulationStatusRequest.md)| Request payload for Goal Accumulation Status |
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
- # **goal_decumulation_allocation**
181
- > Hash<String, Object> goal_decumulation_allocation(goal_decumulation_allocation_request)
182
-
183
- Goal Decumulation Allocation
184
-
185
- Allocate based on a decumulation goal
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::GoalsApi.new
201
-
202
- goal_decumulation_allocation_request = ProtonApi::GoalDecumulationAllocationRequest.new # GoalDecumulationAllocationRequest | Request payload for Goal Decumulation Allocation
203
-
204
-
205
- begin
206
- #Goal Decumulation Allocation
207
- result = api_instance.goal_decumulation_allocation(goal_decumulation_allocation_request)
208
- p result
209
- rescue ProtonApi::ApiError => e
210
- puts "Exception when calling GoalsApi->goal_decumulation_allocation: #{e}"
211
- end
212
- ```
213
-
214
- ### Parameters
215
-
216
- Name | Type | Description | Notes
217
- ------------- | ------------- | ------------- | -------------
218
- **goal_decumulation_allocation_request** | [**GoalDecumulationAllocationRequest**](GoalDecumulationAllocationRequest.md)| Request payload for Goal Decumulation Allocation |
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
- # **goal_decumulation_recommendation**
236
- > Hash<String, Object> goal_decumulation_recommendation(goal_decumulation_recommendation_request)
237
-
238
- Goal Decumulation Recommendation
239
-
240
- Generate recommendations to achieve a decumulation goal
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::GoalsApi.new
256
-
257
- goal_decumulation_recommendation_request = ProtonApi::GoalDecumulationRecommendationRequest.new # GoalDecumulationRecommendationRequest | Request payload for Goal Decumulation Recommendation
258
-
259
-
260
- begin
261
- #Goal Decumulation Recommendation
262
- result = api_instance.goal_decumulation_recommendation(goal_decumulation_recommendation_request)
263
- p result
264
- rescue ProtonApi::ApiError => e
265
- puts "Exception when calling GoalsApi->goal_decumulation_recommendation: #{e}"
266
- end
267
- ```
268
-
269
- ### Parameters
270
-
271
- Name | Type | Description | Notes
272
- ------------- | ------------- | ------------- | -------------
273
- **goal_decumulation_recommendation_request** | [**GoalDecumulationRecommendationRequest**](GoalDecumulationRecommendationRequest.md)| Request payload for Goal Decumulation Recommendation |
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
- # **goal_decumulation_status**
291
- > Hash<String, Object> goal_decumulation_status(goal_decumulation_status_request)
292
-
293
- Goal Decumulation Status
294
-
295
- Track the status of a decumulation goal
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::GoalsApi.new
311
-
312
- goal_decumulation_status_request = ProtonApi::GoalDecumulationStatusRequest.new # GoalDecumulationStatusRequest | Request payload for Goal Decumulation Status
313
-
314
-
315
- begin
316
- #Goal Decumulation Status
317
- result = api_instance.goal_decumulation_status(goal_decumulation_status_request)
318
- p result
319
- rescue ProtonApi::ApiError => e
320
- puts "Exception when calling GoalsApi->goal_decumulation_status: #{e}"
321
- end
322
- ```
323
-
324
- ### Parameters
325
-
326
- Name | Type | Description | Notes
327
- ------------- | ------------- | ------------- | -------------
328
- **goal_decumulation_status_request** | [**GoalDecumulationStatusRequest**](GoalDecumulationStatusRequest.md)| Request payload for Goal Decumulation Status |
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
-