proton_api 1.8.0 → 1.9.0

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