hydrogen-proton-api 1.9.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (217) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +7 -0
  3. data/README.md +82 -0
  4. data/Rakefile +8 -0
  5. data/git_push.sh +55 -0
  6. data/lib/proton_api.rb +141 -0
  7. data/lib/proton_api/api/annuities_api.rb +347 -0
  8. data/lib/proton_api/api/business_financial_management_api.rb +293 -0
  9. data/lib/proton_api/api/cards_api.rb +185 -0
  10. data/lib/proton_api/api/financial_health_api.rb +239 -0
  11. data/lib/proton_api/api/financial_planning_api.rb +671 -0
  12. data/lib/proton_api/api/goals_api.rb +347 -0
  13. data/lib/proton_api/api/life_insurance_api.rb +77 -0
  14. data/lib/proton_api/api/personal_financial_management_api.rb +347 -0
  15. data/lib/proton_api/api/portfolio_construction_api.rb +77 -0
  16. data/lib/proton_api/api/portfolio_management_api.rb +77 -0
  17. data/lib/proton_api/api/risk_scoring_api.rb +185 -0
  18. data/lib/proton_api/api/simulations_api.rb +401 -0
  19. data/lib/proton_api/api/util_api.rb +185 -0
  20. data/lib/proton_api/api_client.rb +391 -0
  21. data/lib/proton_api/api_error.rb +38 -0
  22. data/lib/proton_api/auth_configuration.rb +181 -0
  23. data/lib/proton_api/configuration.rb +209 -0
  24. data/lib/proton_api/environment.rb +36 -0
  25. data/lib/proton_api/models/accumulation_goal_deposit_config.rb +338 -0
  26. data/lib/proton_api/models/annuity_calculator_accumulation_horizon_request.rb +459 -0
  27. data/lib/proton_api/models/annuity_calculator_annuity_amount_request.rb +461 -0
  28. data/lib/proton_api/models/annuity_calculator_decumulation_horizon_request.rb +459 -0
  29. data/lib/proton_api/models/annuity_calculator_deposit_amount_request.rb +468 -0
  30. data/lib/proton_api/models/annuity_calculator_initial_balance_request.rb +468 -0
  31. data/lib/proton_api/models/annuity_deposit_schedule.rb +254 -0
  32. data/lib/proton_api/models/answer.rb +186 -0
  33. data/lib/proton_api/models/backtest_request.rb +295 -0
  34. data/lib/proton_api/models/beneficiary_bequest_config.rb +257 -0
  35. data/lib/proton_api/models/budget_aggregation_account.rb +186 -0
  36. data/lib/proton_api/models/budget_calculator_request.rb +334 -0
  37. data/lib/proton_api/models/budget_component.rb +228 -0
  38. data/lib/proton_api/models/budget_details.rb +337 -0
  39. data/lib/proton_api/models/business_financial_health_check_request.rb +484 -0
  40. data/lib/proton_api/models/business_invoice_analysis_request.rb +361 -0
  41. data/lib/proton_api/models/calculator_deposit_schedule.rb +228 -0
  42. data/lib/proton_api/models/calculator_deposit_schedule1.rb +254 -0
  43. data/lib/proton_api/models/card_analysis_request.rb +372 -0
  44. data/lib/proton_api/models/card_limit_check_request.rb +231 -0
  45. data/lib/proton_api/models/card_transaction_authorization_request.rb +422 -0
  46. data/lib/proton_api/models/cash_analysis_request.rb +340 -0
  47. data/lib/proton_api/models/cash_flow_analysis_request.rb +366 -0
  48. data/lib/proton_api/models/children_education_config.rb +221 -0
  49. data/lib/proton_api/models/customer_analysis_request.rb +292 -0
  50. data/lib/proton_api/models/decision_tree_result_request.rb +236 -0
  51. data/lib/proton_api/models/decumulation_goal_deposit_config.rb +335 -0
  52. data/lib/proton_api/models/dimensional_risk_score_request.rb +282 -0
  53. data/lib/proton_api/models/diversification_score_request.rb +324 -0
  54. data/lib/proton_api/models/education_calculator_annual_cost_request.rb +450 -0
  55. data/lib/proton_api/models/education_calculator_deposit_amount_request.rb +483 -0
  56. data/lib/proton_api/models/education_calculator_percent_covered_request.rb +448 -0
  57. data/lib/proton_api/models/education_config.rb +271 -0
  58. data/lib/proton_api/models/emergency_fund_calculator_request.rb +561 -0
  59. data/lib/proton_api/models/event_study_request.rb +317 -0
  60. data/lib/proton_api/models/fee_analysis_request.rb +239 -0
  61. data/lib/proton_api/models/financial_health_check_request.rb +384 -0
  62. data/lib/proton_api/models/financial_picture_request.rb +270 -0
  63. data/lib/proton_api/models/financial_statement_analysis_request.rb +461 -0
  64. data/lib/proton_api/models/goal_accumulation_allocation_request.rb +729 -0
  65. data/lib/proton_api/models/goal_accumulation_recommendation_request.rb +622 -0
  66. data/lib/proton_api/models/goal_accumulation_status_request.rb +622 -0
  67. data/lib/proton_api/models/goal_config.rb +222 -0
  68. data/lib/proton_api/models/goal_decumulation_allocation_request.rb +764 -0
  69. data/lib/proton_api/models/goal_decumulation_recommendation_request.rb +657 -0
  70. data/lib/proton_api/models/goal_decumulation_status_request.rb +657 -0
  71. data/lib/proton_api/models/goal_withdrawal_config.rb +335 -0
  72. data/lib/proton_api/models/guaranteed_rate_benefit.rb +272 -0
  73. data/lib/proton_api/models/income_config.rb +266 -0
  74. data/lib/proton_api/models/life_insurance_needs_calculator_request.rb +515 -0
  75. data/lib/proton_api/models/location.rb +183 -0
  76. data/lib/proton_api/models/monte_carlo_request.rb +504 -0
  77. data/lib/proton_api/models/mortgage_calculator_down_payment_request.rb +299 -0
  78. data/lib/proton_api/models/mortgage_calculator_home_price_request.rb +299 -0
  79. data/lib/proton_api/models/mortgage_calculator_periodic_payment_request.rb +299 -0
  80. data/lib/proton_api/models/mvo_request.rb +366 -0
  81. data/lib/proton_api/models/opt_config.rb +300 -0
  82. data/lib/proton_api/models/opt_config1.rb +260 -0
  83. data/lib/proton_api/models/order_rebalance_request.rb +398 -0
  84. data/lib/proton_api/models/performance_calculator_request.rb +687 -0
  85. data/lib/proton_api/models/periods.rb +220 -0
  86. data/lib/proton_api/models/portfolio_optimization_score_request.rb +356 -0
  87. data/lib/proton_api/models/portfolio_what_if_request.rb +351 -0
  88. data/lib/proton_api/models/purchase_calculator_amount_request.rb +401 -0
  89. data/lib/proton_api/models/purchase_calculator_deposit_amount_request.rb +434 -0
  90. data/lib/proton_api/models/purchase_calculator_horizon_request.rb +356 -0
  91. data/lib/proton_api/models/ratio_targets.rb +328 -0
  92. data/lib/proton_api/models/ratio_targets1.rb +328 -0
  93. data/lib/proton_api/models/rebalancing_signal_request.rb +238 -0
  94. data/lib/proton_api/models/recommendation_config.rb +357 -0
  95. data/lib/proton_api/models/recommendation_config1.rb +346 -0
  96. data/lib/proton_api/models/recurring_transaction_analysis_request.rb +400 -0
  97. data/lib/proton_api/models/retirement_calculator_deposit_amount_request.rb +509 -0
  98. data/lib/proton_api/models/retirement_calculator_expenses_request.rb +476 -0
  99. data/lib/proton_api/models/retirement_calculator_percent_covered_request.rb +474 -0
  100. data/lib/proton_api/models/risk_allocation_request.rb +316 -0
  101. data/lib/proton_api/models/risk_score_request.rb +239 -0
  102. data/lib/proton_api/models/savings_calculator_request.rb +395 -0
  103. data/lib/proton_api/models/savings_deposit_schedule.rb +276 -0
  104. data/lib/proton_api/models/scenario_analysis_request.rb +401 -0
  105. data/lib/proton_api/models/sensitivity_analysis_request.rb +399 -0
  106. data/lib/proton_api/models/sensitivity_factor.rb +278 -0
  107. data/lib/proton_api/models/settings.rb +287 -0
  108. data/lib/proton_api/models/spending_analysis_request.rb +505 -0
  109. data/lib/proton_api/models/variable_annuity_request.rb +700 -0
  110. data/lib/proton_api/models/w_config.rb +382 -0
  111. data/lib/proton_api/models/w_config1.rb +347 -0
  112. data/lib/proton_api/version.rb +15 -0
  113. data/proton_api.gemspec +46 -0
  114. data/spec/api/annuities_api_spec.rb +107 -0
  115. data/spec/api/business_financial_management_api_spec.rb +95 -0
  116. data/spec/api/cards_api_spec.rb +71 -0
  117. data/spec/api/financial_health_api_spec.rb +83 -0
  118. data/spec/api/financial_planning_api_spec.rb +179 -0
  119. data/spec/api/goals_api_spec.rb +107 -0
  120. data/spec/api/life_insurance_api_spec.rb +47 -0
  121. data/spec/api/personal_financial_management_api_spec.rb +107 -0
  122. data/spec/api/portfolio_construction_api_spec.rb +47 -0
  123. data/spec/api/portfolio_management_api_spec.rb +47 -0
  124. data/spec/api/risk_scoring_api_spec.rb +71 -0
  125. data/spec/api/simulations_api_spec.rb +119 -0
  126. data/spec/api/util_api_spec.rb +71 -0
  127. data/spec/api_client_spec.rb +243 -0
  128. data/spec/configuration_spec.rb +42 -0
  129. data/spec/models/accumulation_goal_deposit_config_spec.rb +89 -0
  130. data/spec/models/annuity_calculator_accumulation_horizon_request_spec.rb +111 -0
  131. data/spec/models/annuity_calculator_annuity_amount_request_spec.rb +111 -0
  132. data/spec/models/annuity_calculator_decumulation_horizon_request_spec.rb +111 -0
  133. data/spec/models/annuity_calculator_deposit_amount_request_spec.rb +111 -0
  134. data/spec/models/annuity_calculator_initial_balance_request_spec.rb +111 -0
  135. data/spec/models/annuity_deposit_schedule_spec.rb +57 -0
  136. data/spec/models/answer_spec.rb +41 -0
  137. data/spec/models/backtest_request_spec.rb +95 -0
  138. data/spec/models/beneficiary_bequest_config_spec.rb +53 -0
  139. data/spec/models/budget_aggregation_account_spec.rb +41 -0
  140. data/spec/models/budget_calculator_request_spec.rb +105 -0
  141. data/spec/models/budget_component_spec.rb +53 -0
  142. data/spec/models/budget_details_spec.rb +99 -0
  143. data/spec/models/business_financial_health_check_request_spec.rb +143 -0
  144. data/spec/models/business_invoice_analysis_request_spec.rb +123 -0
  145. data/spec/models/calculator_deposit_schedule1_spec.rb +57 -0
  146. data/spec/models/calculator_deposit_schedule_spec.rb +51 -0
  147. data/spec/models/card_analysis_request_spec.rb +129 -0
  148. data/spec/models/card_limit_check_request_spec.rb +65 -0
  149. data/spec/models/card_transaction_authorization_request_spec.rb +157 -0
  150. data/spec/models/cash_analysis_request_spec.rb +115 -0
  151. data/spec/models/cash_flow_analysis_request_spec.rb +135 -0
  152. data/spec/models/children_education_config_spec.rb +47 -0
  153. data/spec/models/customer_analysis_request_spec.rb +101 -0
  154. data/spec/models/decision_tree_result_request_spec.rb +51 -0
  155. data/spec/models/decumulation_goal_deposit_config_spec.rb +89 -0
  156. data/spec/models/dimensional_risk_score_request_spec.rb +89 -0
  157. data/spec/models/diversification_score_request_spec.rb +111 -0
  158. data/spec/models/education_calculator_annual_cost_request_spec.rb +101 -0
  159. data/spec/models/education_calculator_deposit_amount_request_spec.rb +107 -0
  160. data/spec/models/education_calculator_percent_covered_request_spec.rb +101 -0
  161. data/spec/models/education_config_spec.rb +53 -0
  162. data/spec/models/emergency_fund_calculator_request_spec.rb +141 -0
  163. data/spec/models/event_study_request_spec.rb +109 -0
  164. data/spec/models/fee_analysis_request_spec.rb +77 -0
  165. data/spec/models/financial_health_check_request_spec.rb +95 -0
  166. data/spec/models/financial_picture_request_spec.rb +95 -0
  167. data/spec/models/financial_statement_analysis_request_spec.rb +155 -0
  168. data/spec/models/goal_accumulation_allocation_request_spec.rb +215 -0
  169. data/spec/models/goal_accumulation_recommendation_request_spec.rb +173 -0
  170. data/spec/models/goal_accumulation_status_request_spec.rb +173 -0
  171. data/spec/models/goal_config_spec.rb +47 -0
  172. data/spec/models/goal_decumulation_allocation_request_spec.rb +221 -0
  173. data/spec/models/goal_decumulation_recommendation_request_spec.rb +179 -0
  174. data/spec/models/goal_decumulation_status_request_spec.rb +179 -0
  175. data/spec/models/goal_withdrawal_config_spec.rb +89 -0
  176. data/spec/models/guaranteed_rate_benefit_spec.rb +59 -0
  177. data/spec/models/income_config_spec.rb +53 -0
  178. data/spec/models/life_insurance_needs_calculator_request_spec.rb +125 -0
  179. data/spec/models/location_spec.rb +41 -0
  180. data/spec/models/monte_carlo_request_spec.rb +179 -0
  181. data/spec/models/mortgage_calculator_down_payment_request_spec.rb +59 -0
  182. data/spec/models/mortgage_calculator_home_price_request_spec.rb +59 -0
  183. data/spec/models/mortgage_calculator_periodic_payment_request_spec.rb +59 -0
  184. data/spec/models/mvo_request_spec.rb +113 -0
  185. data/spec/models/opt_config1_spec.rb +69 -0
  186. data/spec/models/opt_config_spec.rb +81 -0
  187. data/spec/models/order_rebalance_request_spec.rb +123 -0
  188. data/spec/models/performance_calculator_request_spec.rb +233 -0
  189. data/spec/models/periods_spec.rb +47 -0
  190. data/spec/models/portfolio_optimization_score_request_spec.rb +127 -0
  191. data/spec/models/portfolio_what_if_request_spec.rb +123 -0
  192. data/spec/models/purchase_calculator_amount_request_spec.rb +93 -0
  193. data/spec/models/purchase_calculator_deposit_amount_request_spec.rb +99 -0
  194. data/spec/models/purchase_calculator_horizon_request_spec.rb +83 -0
  195. data/spec/models/ratio_targets1_spec.rb +71 -0
  196. data/spec/models/ratio_targets_spec.rb +71 -0
  197. data/spec/models/rebalancing_signal_request_spec.rb +71 -0
  198. data/spec/models/recommendation_config1_spec.rb +77 -0
  199. data/spec/models/recommendation_config_spec.rb +83 -0
  200. data/spec/models/recurring_transaction_analysis_request_spec.rb +129 -0
  201. data/spec/models/retirement_calculator_deposit_amount_request_spec.rb +113 -0
  202. data/spec/models/retirement_calculator_expenses_request_spec.rb +107 -0
  203. data/spec/models/retirement_calculator_percent_covered_request_spec.rb +107 -0
  204. data/spec/models/risk_allocation_request_spec.rb +85 -0
  205. data/spec/models/risk_score_request_spec.rb +71 -0
  206. data/spec/models/savings_calculator_request_spec.rb +99 -0
  207. data/spec/models/savings_deposit_schedule_spec.rb +63 -0
  208. data/spec/models/scenario_analysis_request_spec.rb +133 -0
  209. data/spec/models/sensitivity_analysis_request_spec.rb +133 -0
  210. data/spec/models/sensitivity_factor_spec.rb +59 -0
  211. data/spec/models/settings_spec.rb +79 -0
  212. data/spec/models/spending_analysis_request_spec.rb +187 -0
  213. data/spec/models/variable_annuity_request_spec.rb +209 -0
  214. data/spec/models/w_config1_spec.rb +65 -0
  215. data/spec/models/w_config_spec.rb +65 -0
  216. data/spec/spec_helper.rb +111 -0
  217. metadata +561 -0
@@ -0,0 +1,434 @@
1
+ =begin
2
+ #Hydrogen Proton API
3
+
4
+ #Financial engineering module of Hydrogen Atom
5
+
6
+ OpenAPI spec version: 1.9.1
7
+ Contact: info@hydrogenplatform.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.19
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module ProtonApi
16
+ class PurchaseCalculatorDepositAmountRequest
17
+ attr_accessor :account_ids
18
+
19
+ attr_accessor :horizon_frequency_interval
20
+
21
+ attr_accessor :purchase_horizon
22
+
23
+ attr_accessor :investment_tax
24
+
25
+ attr_accessor :portfolio_return
26
+
27
+ attr_accessor :deposit_schedule
28
+
29
+ attr_accessor :current_savings
30
+
31
+ attr_accessor :purchase_amount
32
+
33
+ attr_accessor :inflation_rate
34
+
35
+ attr_accessor :aggregation_account_ids
36
+
37
+ class EnumAttributeValidator
38
+ attr_reader :datatype
39
+ attr_reader :allowable_values
40
+
41
+ def initialize(datatype, allowable_values)
42
+ @allowable_values = allowable_values.map do |value|
43
+ case datatype.to_s
44
+ when /Integer/i
45
+ value.to_i
46
+ when /Float/i
47
+ value.to_f
48
+ else
49
+ value
50
+ end
51
+ end
52
+ end
53
+
54
+ def valid?(value)
55
+ !value || allowable_values.include?(value)
56
+ end
57
+ end
58
+
59
+ # Attribute mapping from ruby-style variable name to JSON key.
60
+ def self.attribute_map
61
+ {
62
+ :'account_ids' => :'account_ids',
63
+ :'horizon_frequency_interval' => :'horizon_frequency_interval',
64
+ :'purchase_horizon' => :'purchase_horizon',
65
+ :'investment_tax' => :'investment_tax',
66
+ :'portfolio_return' => :'portfolio_return',
67
+ :'deposit_schedule' => :'deposit_schedule',
68
+ :'current_savings' => :'current_savings',
69
+ :'purchase_amount' => :'purchase_amount',
70
+ :'inflation_rate' => :'inflation_rate',
71
+ :'aggregation_account_ids' => :'aggregation_account_ids'
72
+ }
73
+ end
74
+
75
+ # Attribute type mapping.
76
+ def self.swagger_types
77
+ {
78
+ :'account_ids' => :'Array<String>',
79
+ :'horizon_frequency_interval' => :'String',
80
+ :'purchase_horizon' => :'Integer',
81
+ :'investment_tax' => :'Float',
82
+ :'portfolio_return' => :'Float',
83
+ :'deposit_schedule' => :'CalculatorDepositSchedule',
84
+ :'current_savings' => :'Float',
85
+ :'purchase_amount' => :'Float',
86
+ :'inflation_rate' => :'Float',
87
+ :'aggregation_account_ids' => :'Array<String>'
88
+ }
89
+ end
90
+
91
+ # Initializes the object
92
+ # @param [Hash] attributes Model attributes in the form of hash
93
+ def initialize(attributes = {})
94
+ return unless attributes.is_a?(Hash)
95
+
96
+ # convert string to symbol for hash key
97
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
98
+
99
+ if attributes.has_key?(:'account_ids')
100
+ if (value = attributes[:'account_ids']).is_a?(Array)
101
+ self.account_ids = value
102
+ end
103
+ end
104
+
105
+ if attributes.has_key?(:'horizon_frequency_interval')
106
+ self.horizon_frequency_interval = attributes[:'horizon_frequency_interval']
107
+ else
108
+ self.horizon_frequency_interval = 'year'
109
+ end
110
+
111
+ if attributes.has_key?(:'purchase_horizon')
112
+ self.purchase_horizon = attributes[:'purchase_horizon']
113
+ end
114
+
115
+ if attributes.has_key?(:'investment_tax')
116
+ self.investment_tax = attributes[:'investment_tax']
117
+ else
118
+ self.investment_tax = 0.0
119
+ end
120
+
121
+ if attributes.has_key?(:'portfolio_return')
122
+ self.portfolio_return = attributes[:'portfolio_return']
123
+ end
124
+
125
+ if attributes.has_key?(:'deposit_schedule')
126
+ self.deposit_schedule = attributes[:'deposit_schedule']
127
+ end
128
+
129
+ if attributes.has_key?(:'current_savings')
130
+ self.current_savings = attributes[:'current_savings']
131
+ else
132
+ self.current_savings = 0.0
133
+ end
134
+
135
+ if attributes.has_key?(:'purchase_amount')
136
+ self.purchase_amount = attributes[:'purchase_amount']
137
+ end
138
+
139
+ if attributes.has_key?(:'inflation_rate')
140
+ self.inflation_rate = attributes[:'inflation_rate']
141
+ else
142
+ self.inflation_rate = 0.0
143
+ end
144
+
145
+ if attributes.has_key?(:'aggregation_account_ids')
146
+ if (value = attributes[:'aggregation_account_ids']).is_a?(Array)
147
+ self.aggregation_account_ids = value
148
+ end
149
+ end
150
+ end
151
+
152
+ # Show invalid properties with the reasons. Usually used together with valid?
153
+ # @return Array for valid properties with the reasons
154
+ def list_invalid_properties
155
+ invalid_properties = Array.new
156
+ if @purchase_horizon.nil?
157
+ invalid_properties.push('invalid value for "purchase_horizon", purchase_horizon cannot be nil.')
158
+ end
159
+
160
+ if @purchase_horizon < 0
161
+ invalid_properties.push('invalid value for "purchase_horizon", must be greater than or equal to 0.')
162
+ end
163
+
164
+ if !@investment_tax.nil? && @investment_tax > 1
165
+ invalid_properties.push('invalid value for "investment_tax", must be smaller than or equal to 1.')
166
+ end
167
+
168
+ if !@investment_tax.nil? && @investment_tax < 0
169
+ invalid_properties.push('invalid value for "investment_tax", must be greater than or equal to 0.')
170
+ end
171
+
172
+ if @portfolio_return.nil?
173
+ invalid_properties.push('invalid value for "portfolio_return", portfolio_return cannot be nil.')
174
+ end
175
+
176
+ if @portfolio_return < -1
177
+ invalid_properties.push('invalid value for "portfolio_return", must be greater than or equal to -1.')
178
+ end
179
+
180
+ if !@current_savings.nil? && @current_savings < 0
181
+ invalid_properties.push('invalid value for "current_savings", must be greater than or equal to 0.')
182
+ end
183
+
184
+ if @purchase_amount.nil?
185
+ invalid_properties.push('invalid value for "purchase_amount", purchase_amount cannot be nil.')
186
+ end
187
+
188
+ if @purchase_amount < 0
189
+ invalid_properties.push('invalid value for "purchase_amount", must be greater than or equal to 0.')
190
+ end
191
+
192
+ if !@inflation_rate.nil? && @inflation_rate < -1
193
+ invalid_properties.push('invalid value for "inflation_rate", must be greater than or equal to -1.')
194
+ end
195
+
196
+ invalid_properties
197
+ end
198
+
199
+ # Check to see if the all the properties in the model are valid
200
+ # @return true if the model is valid
201
+ def valid?
202
+ horizon_frequency_interval_validator = EnumAttributeValidator.new('String', ['year', 'quarter', 'month', 'week'])
203
+ return false unless horizon_frequency_interval_validator.valid?(@horizon_frequency_interval)
204
+ return false if @purchase_horizon.nil?
205
+ return false if @purchase_horizon < 0
206
+ return false if !@investment_tax.nil? && @investment_tax > 1
207
+ return false if !@investment_tax.nil? && @investment_tax < 0
208
+ return false if @portfolio_return.nil?
209
+ return false if @portfolio_return < -1
210
+ return false if !@current_savings.nil? && @current_savings < 0
211
+ return false if @purchase_amount.nil?
212
+ return false if @purchase_amount < 0
213
+ return false if !@inflation_rate.nil? && @inflation_rate < -1
214
+ true
215
+ end
216
+
217
+ # Custom attribute writer method checking allowed values (enum).
218
+ # @param [Object] horizon_frequency_interval Object to be assigned
219
+ def horizon_frequency_interval=(horizon_frequency_interval)
220
+ validator = EnumAttributeValidator.new('String', ['year', 'quarter', 'month', 'week'])
221
+ unless validator.valid?(horizon_frequency_interval)
222
+ fail ArgumentError, 'invalid value for "horizon_frequency_interval", must be one of #{validator.allowable_values}.'
223
+ end
224
+ @horizon_frequency_interval = horizon_frequency_interval
225
+ end
226
+
227
+ # Custom attribute writer method with validation
228
+ # @param [Object] purchase_horizon Value to be assigned
229
+ def purchase_horizon=(purchase_horizon)
230
+ if purchase_horizon.nil?
231
+ fail ArgumentError, 'purchase_horizon cannot be nil'
232
+ end
233
+
234
+ if purchase_horizon < 0
235
+ fail ArgumentError, 'invalid value for "purchase_horizon", must be greater than or equal to 0.'
236
+ end
237
+
238
+ @purchase_horizon = purchase_horizon
239
+ end
240
+
241
+ # Custom attribute writer method with validation
242
+ # @param [Object] investment_tax Value to be assigned
243
+ def investment_tax=(investment_tax)
244
+ if !investment_tax.nil? && investment_tax > 1
245
+ fail ArgumentError, 'invalid value for "investment_tax", must be smaller than or equal to 1.'
246
+ end
247
+
248
+ if !investment_tax.nil? && investment_tax < 0
249
+ fail ArgumentError, 'invalid value for "investment_tax", must be greater than or equal to 0.'
250
+ end
251
+
252
+ @investment_tax = investment_tax
253
+ end
254
+
255
+ # Custom attribute writer method with validation
256
+ # @param [Object] portfolio_return Value to be assigned
257
+ def portfolio_return=(portfolio_return)
258
+ if portfolio_return.nil?
259
+ fail ArgumentError, 'portfolio_return cannot be nil'
260
+ end
261
+
262
+ if portfolio_return < -1
263
+ fail ArgumentError, 'invalid value for "portfolio_return", must be greater than or equal to -1.'
264
+ end
265
+
266
+ @portfolio_return = portfolio_return
267
+ end
268
+
269
+ # Custom attribute writer method with validation
270
+ # @param [Object] current_savings Value to be assigned
271
+ def current_savings=(current_savings)
272
+ if !current_savings.nil? && current_savings < 0
273
+ fail ArgumentError, 'invalid value for "current_savings", must be greater than or equal to 0.'
274
+ end
275
+
276
+ @current_savings = current_savings
277
+ end
278
+
279
+ # Custom attribute writer method with validation
280
+ # @param [Object] purchase_amount Value to be assigned
281
+ def purchase_amount=(purchase_amount)
282
+ if purchase_amount.nil?
283
+ fail ArgumentError, 'purchase_amount cannot be nil'
284
+ end
285
+
286
+ if purchase_amount < 0
287
+ fail ArgumentError, 'invalid value for "purchase_amount", must be greater than or equal to 0.'
288
+ end
289
+
290
+ @purchase_amount = purchase_amount
291
+ end
292
+
293
+ # Custom attribute writer method with validation
294
+ # @param [Object] inflation_rate Value to be assigned
295
+ def inflation_rate=(inflation_rate)
296
+ if !inflation_rate.nil? && inflation_rate < -1
297
+ fail ArgumentError, 'invalid value for "inflation_rate", must be greater than or equal to -1.'
298
+ end
299
+
300
+ @inflation_rate = inflation_rate
301
+ end
302
+
303
+ # Checks equality by comparing each attribute.
304
+ # @param [Object] Object to be compared
305
+ def ==(o)
306
+ return true if self.equal?(o)
307
+ self.class == o.class &&
308
+ account_ids == o.account_ids &&
309
+ horizon_frequency_interval == o.horizon_frequency_interval &&
310
+ purchase_horizon == o.purchase_horizon &&
311
+ investment_tax == o.investment_tax &&
312
+ portfolio_return == o.portfolio_return &&
313
+ deposit_schedule == o.deposit_schedule &&
314
+ current_savings == o.current_savings &&
315
+ purchase_amount == o.purchase_amount &&
316
+ inflation_rate == o.inflation_rate &&
317
+ aggregation_account_ids == o.aggregation_account_ids
318
+ end
319
+
320
+ # @see the `==` method
321
+ # @param [Object] Object to be compared
322
+ def eql?(o)
323
+ self == o
324
+ end
325
+
326
+ # Calculates hash code according to all attributes.
327
+ # @return [Fixnum] Hash code
328
+ def hash
329
+ [account_ids, horizon_frequency_interval, purchase_horizon, investment_tax, portfolio_return, deposit_schedule, current_savings, purchase_amount, inflation_rate, aggregation_account_ids].hash
330
+ end
331
+
332
+ # Builds the object from hash
333
+ # @param [Hash] attributes Model attributes in the form of hash
334
+ # @return [Object] Returns the model itself
335
+ def build_from_hash(attributes)
336
+ return nil unless attributes.is_a?(Hash)
337
+ self.class.swagger_types.each_pair do |key, type|
338
+ if type =~ /\AArray<(.*)>/i
339
+ # check to ensure the input is an array given that the attribute
340
+ # is documented as an array but the input is not
341
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
342
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
343
+ end
344
+ elsif !attributes[self.class.attribute_map[key]].nil?
345
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
346
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
347
+ end
348
+
349
+ self
350
+ end
351
+ # Deserializes the data based on type
352
+ # @param string type Data type
353
+ # @param string value Value to be deserialized
354
+ # @return [Object] Deserialized data
355
+ def _deserialize(type, value)
356
+ case type.to_sym
357
+ when :DateTime
358
+ value
359
+ when :Date
360
+ value
361
+ when :String
362
+ value.to_s
363
+ when :Integer
364
+ value.to_i
365
+ when :Float
366
+ value.to_f
367
+ when :BOOLEAN
368
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
369
+ true
370
+ else
371
+ false
372
+ end
373
+ when :Object
374
+ # generic object (usually a Hash), return directly
375
+ value
376
+ when /\AArray<(?<inner_type>.+)>\z/
377
+ inner_type = Regexp.last_match[:inner_type]
378
+ value.map { |v| _deserialize(inner_type, v) }
379
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
380
+ k_type = Regexp.last_match[:k_type]
381
+ v_type = Regexp.last_match[:v_type]
382
+ {}.tap do |hash|
383
+ value.each do |k, v|
384
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
385
+ end
386
+ end
387
+ else # model
388
+ temp_model = ProtonApi.const_get(type).new
389
+ temp_model.build_from_hash(value)
390
+ end
391
+ end
392
+ # Returns the string representation of the object
393
+ # @return [String] String presentation of the object
394
+ def to_s
395
+ to_hash.to_s
396
+ end
397
+
398
+ # to_body is an alias to to_hash (backward compatibility)
399
+ # @return [Hash] Returns the object in the form of hash
400
+ def to_body
401
+ to_hash
402
+ end
403
+
404
+ # Returns the object in the form of hash
405
+ # @return [Hash] Returns the object in the form of hash
406
+ def to_hash
407
+ hash = {}
408
+ self.class.attribute_map.each_pair do |attr, param|
409
+ value = self.send(attr)
410
+ next if value.nil?
411
+ hash[param] = _to_hash(value)
412
+ end
413
+ hash
414
+ end
415
+ # Outputs non-array value in the form of hash
416
+ # For object, use to_hash. Otherwise, just return the value
417
+ # @param [Object] value Any valid value
418
+ # @return [Hash] Returns the value in the form of hash
419
+ def _to_hash(value)
420
+ if value.is_a?(Array)
421
+ value.compact.map { |v| _to_hash(v) }
422
+ elsif value.is_a?(Hash)
423
+ {}.tap do |hash|
424
+ value.each { |k, v| hash[k] = _to_hash(v) }
425
+ end
426
+ elsif value.respond_to? :to_hash
427
+ value.to_hash
428
+ else
429
+ value
430
+ end
431
+ end
432
+
433
+ end
434
+ end
@@ -0,0 +1,356 @@
1
+ =begin
2
+ #Hydrogen Proton API
3
+
4
+ #Financial engineering module of Hydrogen Atom
5
+
6
+ OpenAPI spec version: 1.9.1
7
+ Contact: info@hydrogenplatform.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.19
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module ProtonApi
16
+ class PurchaseCalculatorHorizonRequest
17
+ attr_accessor :account_ids
18
+
19
+ attr_accessor :investment_tax
20
+
21
+ attr_accessor :portfolio_return
22
+
23
+ attr_accessor :deposit_schedule
24
+
25
+ attr_accessor :current_savings
26
+
27
+ attr_accessor :purchase_amount
28
+
29
+ attr_accessor :inflation_rate
30
+
31
+ attr_accessor :aggregation_account_ids
32
+
33
+ # Attribute mapping from ruby-style variable name to JSON key.
34
+ def self.attribute_map
35
+ {
36
+ :'account_ids' => :'account_ids',
37
+ :'investment_tax' => :'investment_tax',
38
+ :'portfolio_return' => :'portfolio_return',
39
+ :'deposit_schedule' => :'deposit_schedule',
40
+ :'current_savings' => :'current_savings',
41
+ :'purchase_amount' => :'purchase_amount',
42
+ :'inflation_rate' => :'inflation_rate',
43
+ :'aggregation_account_ids' => :'aggregation_account_ids'
44
+ }
45
+ end
46
+
47
+ # Attribute type mapping.
48
+ def self.swagger_types
49
+ {
50
+ :'account_ids' => :'Array<String>',
51
+ :'investment_tax' => :'Float',
52
+ :'portfolio_return' => :'Float',
53
+ :'deposit_schedule' => :'CalculatorDepositSchedule1',
54
+ :'current_savings' => :'Float',
55
+ :'purchase_amount' => :'Float',
56
+ :'inflation_rate' => :'Float',
57
+ :'aggregation_account_ids' => :'Array<String>'
58
+ }
59
+ end
60
+
61
+ # Initializes the object
62
+ # @param [Hash] attributes Model attributes in the form of hash
63
+ def initialize(attributes = {})
64
+ return unless attributes.is_a?(Hash)
65
+
66
+ # convert string to symbol for hash key
67
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
68
+
69
+ if attributes.has_key?(:'account_ids')
70
+ if (value = attributes[:'account_ids']).is_a?(Array)
71
+ self.account_ids = value
72
+ end
73
+ end
74
+
75
+ if attributes.has_key?(:'investment_tax')
76
+ self.investment_tax = attributes[:'investment_tax']
77
+ else
78
+ self.investment_tax = 0.0
79
+ end
80
+
81
+ if attributes.has_key?(:'portfolio_return')
82
+ self.portfolio_return = attributes[:'portfolio_return']
83
+ end
84
+
85
+ if attributes.has_key?(:'deposit_schedule')
86
+ self.deposit_schedule = attributes[:'deposit_schedule']
87
+ end
88
+
89
+ if attributes.has_key?(:'current_savings')
90
+ self.current_savings = attributes[:'current_savings']
91
+ else
92
+ self.current_savings = 0.0
93
+ end
94
+
95
+ if attributes.has_key?(:'purchase_amount')
96
+ self.purchase_amount = attributes[:'purchase_amount']
97
+ end
98
+
99
+ if attributes.has_key?(:'inflation_rate')
100
+ self.inflation_rate = attributes[:'inflation_rate']
101
+ else
102
+ self.inflation_rate = 0.0
103
+ end
104
+
105
+ if attributes.has_key?(:'aggregation_account_ids')
106
+ if (value = attributes[:'aggregation_account_ids']).is_a?(Array)
107
+ self.aggregation_account_ids = value
108
+ end
109
+ end
110
+ end
111
+
112
+ # Show invalid properties with the reasons. Usually used together with valid?
113
+ # @return Array for valid properties with the reasons
114
+ def list_invalid_properties
115
+ invalid_properties = Array.new
116
+ if !@investment_tax.nil? && @investment_tax > 1
117
+ invalid_properties.push('invalid value for "investment_tax", must be smaller than or equal to 1.')
118
+ end
119
+
120
+ if !@investment_tax.nil? && @investment_tax < 0
121
+ invalid_properties.push('invalid value for "investment_tax", must be greater than or equal to 0.')
122
+ end
123
+
124
+ if @portfolio_return.nil?
125
+ invalid_properties.push('invalid value for "portfolio_return", portfolio_return cannot be nil.')
126
+ end
127
+
128
+ if @portfolio_return < -1
129
+ invalid_properties.push('invalid value for "portfolio_return", must be greater than or equal to -1.')
130
+ end
131
+
132
+ if !@current_savings.nil? && @current_savings < 0
133
+ invalid_properties.push('invalid value for "current_savings", must be greater than or equal to 0.')
134
+ end
135
+
136
+ if @purchase_amount.nil?
137
+ invalid_properties.push('invalid value for "purchase_amount", purchase_amount cannot be nil.')
138
+ end
139
+
140
+ if @purchase_amount < 0
141
+ invalid_properties.push('invalid value for "purchase_amount", must be greater than or equal to 0.')
142
+ end
143
+
144
+ if !@inflation_rate.nil? && @inflation_rate < -1
145
+ invalid_properties.push('invalid value for "inflation_rate", must be greater than or equal to -1.')
146
+ end
147
+
148
+ invalid_properties
149
+ end
150
+
151
+ # Check to see if the all the properties in the model are valid
152
+ # @return true if the model is valid
153
+ def valid?
154
+ return false if !@investment_tax.nil? && @investment_tax > 1
155
+ return false if !@investment_tax.nil? && @investment_tax < 0
156
+ return false if @portfolio_return.nil?
157
+ return false if @portfolio_return < -1
158
+ return false if !@current_savings.nil? && @current_savings < 0
159
+ return false if @purchase_amount.nil?
160
+ return false if @purchase_amount < 0
161
+ return false if !@inflation_rate.nil? && @inflation_rate < -1
162
+ true
163
+ end
164
+
165
+ # Custom attribute writer method with validation
166
+ # @param [Object] investment_tax Value to be assigned
167
+ def investment_tax=(investment_tax)
168
+ if !investment_tax.nil? && investment_tax > 1
169
+ fail ArgumentError, 'invalid value for "investment_tax", must be smaller than or equal to 1.'
170
+ end
171
+
172
+ if !investment_tax.nil? && investment_tax < 0
173
+ fail ArgumentError, 'invalid value for "investment_tax", must be greater than or equal to 0.'
174
+ end
175
+
176
+ @investment_tax = investment_tax
177
+ end
178
+
179
+ # Custom attribute writer method with validation
180
+ # @param [Object] portfolio_return Value to be assigned
181
+ def portfolio_return=(portfolio_return)
182
+ if portfolio_return.nil?
183
+ fail ArgumentError, 'portfolio_return cannot be nil'
184
+ end
185
+
186
+ if portfolio_return < -1
187
+ fail ArgumentError, 'invalid value for "portfolio_return", must be greater than or equal to -1.'
188
+ end
189
+
190
+ @portfolio_return = portfolio_return
191
+ end
192
+
193
+ # Custom attribute writer method with validation
194
+ # @param [Object] current_savings Value to be assigned
195
+ def current_savings=(current_savings)
196
+ if !current_savings.nil? && current_savings < 0
197
+ fail ArgumentError, 'invalid value for "current_savings", must be greater than or equal to 0.'
198
+ end
199
+
200
+ @current_savings = current_savings
201
+ end
202
+
203
+ # Custom attribute writer method with validation
204
+ # @param [Object] purchase_amount Value to be assigned
205
+ def purchase_amount=(purchase_amount)
206
+ if purchase_amount.nil?
207
+ fail ArgumentError, 'purchase_amount cannot be nil'
208
+ end
209
+
210
+ if purchase_amount < 0
211
+ fail ArgumentError, 'invalid value for "purchase_amount", must be greater than or equal to 0.'
212
+ end
213
+
214
+ @purchase_amount = purchase_amount
215
+ end
216
+
217
+ # Custom attribute writer method with validation
218
+ # @param [Object] inflation_rate Value to be assigned
219
+ def inflation_rate=(inflation_rate)
220
+ if !inflation_rate.nil? && inflation_rate < -1
221
+ fail ArgumentError, 'invalid value for "inflation_rate", must be greater than or equal to -1.'
222
+ end
223
+
224
+ @inflation_rate = inflation_rate
225
+ end
226
+
227
+ # Checks equality by comparing each attribute.
228
+ # @param [Object] Object to be compared
229
+ def ==(o)
230
+ return true if self.equal?(o)
231
+ self.class == o.class &&
232
+ account_ids == o.account_ids &&
233
+ investment_tax == o.investment_tax &&
234
+ portfolio_return == o.portfolio_return &&
235
+ deposit_schedule == o.deposit_schedule &&
236
+ current_savings == o.current_savings &&
237
+ purchase_amount == o.purchase_amount &&
238
+ inflation_rate == o.inflation_rate &&
239
+ aggregation_account_ids == o.aggregation_account_ids
240
+ end
241
+
242
+ # @see the `==` method
243
+ # @param [Object] Object to be compared
244
+ def eql?(o)
245
+ self == o
246
+ end
247
+
248
+ # Calculates hash code according to all attributes.
249
+ # @return [Fixnum] Hash code
250
+ def hash
251
+ [account_ids, investment_tax, portfolio_return, deposit_schedule, current_savings, purchase_amount, inflation_rate, aggregation_account_ids].hash
252
+ end
253
+
254
+ # Builds the object from hash
255
+ # @param [Hash] attributes Model attributes in the form of hash
256
+ # @return [Object] Returns the model itself
257
+ def build_from_hash(attributes)
258
+ return nil unless attributes.is_a?(Hash)
259
+ self.class.swagger_types.each_pair do |key, type|
260
+ if type =~ /\AArray<(.*)>/i
261
+ # check to ensure the input is an array given that the attribute
262
+ # is documented as an array but the input is not
263
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
264
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
265
+ end
266
+ elsif !attributes[self.class.attribute_map[key]].nil?
267
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
268
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
269
+ end
270
+
271
+ self
272
+ end
273
+ # Deserializes the data based on type
274
+ # @param string type Data type
275
+ # @param string value Value to be deserialized
276
+ # @return [Object] Deserialized data
277
+ def _deserialize(type, value)
278
+ case type.to_sym
279
+ when :DateTime
280
+ value
281
+ when :Date
282
+ value
283
+ when :String
284
+ value.to_s
285
+ when :Integer
286
+ value.to_i
287
+ when :Float
288
+ value.to_f
289
+ when :BOOLEAN
290
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
291
+ true
292
+ else
293
+ false
294
+ end
295
+ when :Object
296
+ # generic object (usually a Hash), return directly
297
+ value
298
+ when /\AArray<(?<inner_type>.+)>\z/
299
+ inner_type = Regexp.last_match[:inner_type]
300
+ value.map { |v| _deserialize(inner_type, v) }
301
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
302
+ k_type = Regexp.last_match[:k_type]
303
+ v_type = Regexp.last_match[:v_type]
304
+ {}.tap do |hash|
305
+ value.each do |k, v|
306
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
307
+ end
308
+ end
309
+ else # model
310
+ temp_model = ProtonApi.const_get(type).new
311
+ temp_model.build_from_hash(value)
312
+ end
313
+ end
314
+ # Returns the string representation of the object
315
+ # @return [String] String presentation of the object
316
+ def to_s
317
+ to_hash.to_s
318
+ end
319
+
320
+ # to_body is an alias to to_hash (backward compatibility)
321
+ # @return [Hash] Returns the object in the form of hash
322
+ def to_body
323
+ to_hash
324
+ end
325
+
326
+ # Returns the object in the form of hash
327
+ # @return [Hash] Returns the object in the form of hash
328
+ def to_hash
329
+ hash = {}
330
+ self.class.attribute_map.each_pair do |attr, param|
331
+ value = self.send(attr)
332
+ next if value.nil?
333
+ hash[param] = _to_hash(value)
334
+ end
335
+ hash
336
+ end
337
+ # Outputs non-array value in the form of hash
338
+ # For object, use to_hash. Otherwise, just return the value
339
+ # @param [Object] value Any valid value
340
+ # @return [Hash] Returns the value in the form of hash
341
+ def _to_hash(value)
342
+ if value.is_a?(Array)
343
+ value.compact.map { |v| _to_hash(v) }
344
+ elsif value.is_a?(Hash)
345
+ {}.tap do |hash|
346
+ value.each { |k, v| hash[k] = _to_hash(v) }
347
+ end
348
+ elsif value.respond_to? :to_hash
349
+ value.to_hash
350
+ else
351
+ value
352
+ end
353
+ end
354
+
355
+ end
356
+ end