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,266 @@
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 IncomeConfig
17
+ attr_accessor :annual_net_take_home_pay
18
+
19
+ attr_accessor :income_benefit_duration
20
+
21
+ attr_accessor :percentage_of_income_covered
22
+
23
+ # Attribute mapping from ruby-style variable name to JSON key.
24
+ def self.attribute_map
25
+ {
26
+ :'annual_net_take_home_pay' => :'annual_net_take_home_pay',
27
+ :'income_benefit_duration' => :'income_benefit_duration',
28
+ :'percentage_of_income_covered' => :'percentage_of_income_covered'
29
+ }
30
+ end
31
+
32
+ # Attribute type mapping.
33
+ def self.swagger_types
34
+ {
35
+ :'annual_net_take_home_pay' => :'Float',
36
+ :'income_benefit_duration' => :'Integer',
37
+ :'percentage_of_income_covered' => :'Float'
38
+ }
39
+ end
40
+
41
+ # Initializes the object
42
+ # @param [Hash] attributes Model attributes in the form of hash
43
+ def initialize(attributes = {})
44
+ return unless attributes.is_a?(Hash)
45
+
46
+ # convert string to symbol for hash key
47
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
48
+
49
+ if attributes.has_key?(:'annual_net_take_home_pay')
50
+ self.annual_net_take_home_pay = attributes[:'annual_net_take_home_pay']
51
+ end
52
+
53
+ if attributes.has_key?(:'income_benefit_duration')
54
+ self.income_benefit_duration = attributes[:'income_benefit_duration']
55
+ else
56
+ self.income_benefit_duration = 10
57
+ end
58
+
59
+ if attributes.has_key?(:'percentage_of_income_covered')
60
+ self.percentage_of_income_covered = attributes[:'percentage_of_income_covered']
61
+ else
62
+ self.percentage_of_income_covered = 1.0
63
+ end
64
+ end
65
+
66
+ # Show invalid properties with the reasons. Usually used together with valid?
67
+ # @return Array for valid properties with the reasons
68
+ def list_invalid_properties
69
+ invalid_properties = Array.new
70
+ if @annual_net_take_home_pay.nil?
71
+ invalid_properties.push('invalid value for "annual_net_take_home_pay", annual_net_take_home_pay cannot be nil.')
72
+ end
73
+
74
+ if @annual_net_take_home_pay < 0
75
+ invalid_properties.push('invalid value for "annual_net_take_home_pay", must be greater than or equal to 0.')
76
+ end
77
+
78
+ if !@income_benefit_duration.nil? && @income_benefit_duration < 1
79
+ invalid_properties.push('invalid value for "income_benefit_duration", must be greater than or equal to 1.')
80
+ end
81
+
82
+ if !@percentage_of_income_covered.nil? && @percentage_of_income_covered > 1
83
+ invalid_properties.push('invalid value for "percentage_of_income_covered", must be smaller than or equal to 1.')
84
+ end
85
+
86
+ if !@percentage_of_income_covered.nil? && @percentage_of_income_covered < 0
87
+ invalid_properties.push('invalid value for "percentage_of_income_covered", must be greater than or equal to 0.')
88
+ end
89
+
90
+ invalid_properties
91
+ end
92
+
93
+ # Check to see if the all the properties in the model are valid
94
+ # @return true if the model is valid
95
+ def valid?
96
+ return false if @annual_net_take_home_pay.nil?
97
+ return false if @annual_net_take_home_pay < 0
98
+ return false if !@income_benefit_duration.nil? && @income_benefit_duration < 1
99
+ return false if !@percentage_of_income_covered.nil? && @percentage_of_income_covered > 1
100
+ return false if !@percentage_of_income_covered.nil? && @percentage_of_income_covered < 0
101
+ true
102
+ end
103
+
104
+ # Custom attribute writer method with validation
105
+ # @param [Object] annual_net_take_home_pay Value to be assigned
106
+ def annual_net_take_home_pay=(annual_net_take_home_pay)
107
+ if annual_net_take_home_pay.nil?
108
+ fail ArgumentError, 'annual_net_take_home_pay cannot be nil'
109
+ end
110
+
111
+ if annual_net_take_home_pay < 0
112
+ fail ArgumentError, 'invalid value for "annual_net_take_home_pay", must be greater than or equal to 0.'
113
+ end
114
+
115
+ @annual_net_take_home_pay = annual_net_take_home_pay
116
+ end
117
+
118
+ # Custom attribute writer method with validation
119
+ # @param [Object] income_benefit_duration Value to be assigned
120
+ def income_benefit_duration=(income_benefit_duration)
121
+ if !income_benefit_duration.nil? && income_benefit_duration < 1
122
+ fail ArgumentError, 'invalid value for "income_benefit_duration", must be greater than or equal to 1.'
123
+ end
124
+
125
+ @income_benefit_duration = income_benefit_duration
126
+ end
127
+
128
+ # Custom attribute writer method with validation
129
+ # @param [Object] percentage_of_income_covered Value to be assigned
130
+ def percentage_of_income_covered=(percentage_of_income_covered)
131
+ if !percentage_of_income_covered.nil? && percentage_of_income_covered > 1
132
+ fail ArgumentError, 'invalid value for "percentage_of_income_covered", must be smaller than or equal to 1.'
133
+ end
134
+
135
+ if !percentage_of_income_covered.nil? && percentage_of_income_covered < 0
136
+ fail ArgumentError, 'invalid value for "percentage_of_income_covered", must be greater than or equal to 0.'
137
+ end
138
+
139
+ @percentage_of_income_covered = percentage_of_income_covered
140
+ end
141
+
142
+ # Checks equality by comparing each attribute.
143
+ # @param [Object] Object to be compared
144
+ def ==(o)
145
+ return true if self.equal?(o)
146
+ self.class == o.class &&
147
+ annual_net_take_home_pay == o.annual_net_take_home_pay &&
148
+ income_benefit_duration == o.income_benefit_duration &&
149
+ percentage_of_income_covered == o.percentage_of_income_covered
150
+ end
151
+
152
+ # @see the `==` method
153
+ # @param [Object] Object to be compared
154
+ def eql?(o)
155
+ self == o
156
+ end
157
+
158
+ # Calculates hash code according to all attributes.
159
+ # @return [Fixnum] Hash code
160
+ def hash
161
+ [annual_net_take_home_pay, income_benefit_duration, percentage_of_income_covered].hash
162
+ end
163
+
164
+ # Builds the object from hash
165
+ # @param [Hash] attributes Model attributes in the form of hash
166
+ # @return [Object] Returns the model itself
167
+ def build_from_hash(attributes)
168
+ return nil unless attributes.is_a?(Hash)
169
+ self.class.swagger_types.each_pair do |key, type|
170
+ if type =~ /\AArray<(.*)>/i
171
+ # check to ensure the input is an array given that the attribute
172
+ # is documented as an array but the input is not
173
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
174
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
175
+ end
176
+ elsif !attributes[self.class.attribute_map[key]].nil?
177
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
178
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
179
+ end
180
+
181
+ self
182
+ end
183
+ # Deserializes the data based on type
184
+ # @param string type Data type
185
+ # @param string value Value to be deserialized
186
+ # @return [Object] Deserialized data
187
+ def _deserialize(type, value)
188
+ case type.to_sym
189
+ when :DateTime
190
+ value
191
+ when :Date
192
+ value
193
+ when :String
194
+ value.to_s
195
+ when :Integer
196
+ value.to_i
197
+ when :Float
198
+ value.to_f
199
+ when :BOOLEAN
200
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
201
+ true
202
+ else
203
+ false
204
+ end
205
+ when :Object
206
+ # generic object (usually a Hash), return directly
207
+ value
208
+ when /\AArray<(?<inner_type>.+)>\z/
209
+ inner_type = Regexp.last_match[:inner_type]
210
+ value.map { |v| _deserialize(inner_type, v) }
211
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
212
+ k_type = Regexp.last_match[:k_type]
213
+ v_type = Regexp.last_match[:v_type]
214
+ {}.tap do |hash|
215
+ value.each do |k, v|
216
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
217
+ end
218
+ end
219
+ else # model
220
+ temp_model = ProtonApi.const_get(type).new
221
+ temp_model.build_from_hash(value)
222
+ end
223
+ end
224
+ # Returns the string representation of the object
225
+ # @return [String] String presentation of the object
226
+ def to_s
227
+ to_hash.to_s
228
+ end
229
+
230
+ # to_body is an alias to to_hash (backward compatibility)
231
+ # @return [Hash] Returns the object in the form of hash
232
+ def to_body
233
+ to_hash
234
+ end
235
+
236
+ # Returns the object in the form of hash
237
+ # @return [Hash] Returns the object in the form of hash
238
+ def to_hash
239
+ hash = {}
240
+ self.class.attribute_map.each_pair do |attr, param|
241
+ value = self.send(attr)
242
+ next if value.nil?
243
+ hash[param] = _to_hash(value)
244
+ end
245
+ hash
246
+ end
247
+ # Outputs non-array value in the form of hash
248
+ # For object, use to_hash. Otherwise, just return the value
249
+ # @param [Object] value Any valid value
250
+ # @return [Hash] Returns the value in the form of hash
251
+ def _to_hash(value)
252
+ if value.is_a?(Array)
253
+ value.compact.map { |v| _to_hash(v) }
254
+ elsif value.is_a?(Hash)
255
+ {}.tap do |hash|
256
+ value.each { |k, v| hash[k] = _to_hash(v) }
257
+ end
258
+ elsif value.respond_to? :to_hash
259
+ value.to_hash
260
+ else
261
+ value
262
+ end
263
+ end
264
+
265
+ end
266
+ end
@@ -0,0 +1,515 @@
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 LifeInsuranceNeedsCalculatorRequest
17
+ attr_accessor :client_id
18
+
19
+ attr_accessor :beneficiary_bequest_config
20
+
21
+ attr_accessor :education_inflation_rate
22
+
23
+ attr_accessor :margin_of_error
24
+
25
+ attr_accessor :liquid_assets
26
+
27
+ attr_accessor :tax_rate
28
+
29
+ attr_accessor :other_debt
30
+
31
+ attr_accessor :end_of_life_expenses
32
+
33
+ attr_accessor :existing_life_insurance
34
+
35
+ attr_accessor :income_config
36
+
37
+ attr_accessor :mortgage_balance
38
+
39
+ attr_accessor :benefit_amount_rounding
40
+
41
+ attr_accessor :interest_rate
42
+
43
+ attr_accessor :children_education_config
44
+
45
+ attr_accessor :general_inflation_rate
46
+
47
+ # Attribute mapping from ruby-style variable name to JSON key.
48
+ def self.attribute_map
49
+ {
50
+ :'client_id' => :'client_id',
51
+ :'beneficiary_bequest_config' => :'beneficiary_bequest_config',
52
+ :'education_inflation_rate' => :'education_inflation_rate',
53
+ :'margin_of_error' => :'margin_of_error',
54
+ :'liquid_assets' => :'liquid_assets',
55
+ :'tax_rate' => :'tax_rate',
56
+ :'other_debt' => :'other_debt',
57
+ :'end_of_life_expenses' => :'end_of_life_expenses',
58
+ :'existing_life_insurance' => :'existing_life_insurance',
59
+ :'income_config' => :'income_config',
60
+ :'mortgage_balance' => :'mortgage_balance',
61
+ :'benefit_amount_rounding' => :'benefit_amount_rounding',
62
+ :'interest_rate' => :'interest_rate',
63
+ :'children_education_config' => :'children_education_config',
64
+ :'general_inflation_rate' => :'general_inflation_rate'
65
+ }
66
+ end
67
+
68
+ # Attribute type mapping.
69
+ def self.swagger_types
70
+ {
71
+ :'client_id' => :'String',
72
+ :'beneficiary_bequest_config' => :'Array<BeneficiaryBequestConfig>',
73
+ :'education_inflation_rate' => :'Float',
74
+ :'margin_of_error' => :'Float',
75
+ :'liquid_assets' => :'Float',
76
+ :'tax_rate' => :'Float',
77
+ :'other_debt' => :'Float',
78
+ :'end_of_life_expenses' => :'Float',
79
+ :'existing_life_insurance' => :'Float',
80
+ :'income_config' => :'Array<IncomeConfig>',
81
+ :'mortgage_balance' => :'Float',
82
+ :'benefit_amount_rounding' => :'Integer',
83
+ :'interest_rate' => :'Float',
84
+ :'children_education_config' => :'Array<ChildrenEducationConfig>',
85
+ :'general_inflation_rate' => :'Float'
86
+ }
87
+ end
88
+
89
+ # Initializes the object
90
+ # @param [Hash] attributes Model attributes in the form of hash
91
+ def initialize(attributes = {})
92
+ return unless attributes.is_a?(Hash)
93
+
94
+ # convert string to symbol for hash key
95
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
96
+
97
+ if attributes.has_key?(:'client_id')
98
+ self.client_id = attributes[:'client_id']
99
+ end
100
+
101
+ if attributes.has_key?(:'beneficiary_bequest_config')
102
+ if (value = attributes[:'beneficiary_bequest_config']).is_a?(Array)
103
+ self.beneficiary_bequest_config = value
104
+ end
105
+ end
106
+
107
+ if attributes.has_key?(:'education_inflation_rate')
108
+ self.education_inflation_rate = attributes[:'education_inflation_rate']
109
+ else
110
+ self.education_inflation_rate = 0.0
111
+ end
112
+
113
+ if attributes.has_key?(:'margin_of_error')
114
+ self.margin_of_error = attributes[:'margin_of_error']
115
+ else
116
+ self.margin_of_error = 0.0
117
+ end
118
+
119
+ if attributes.has_key?(:'liquid_assets')
120
+ self.liquid_assets = attributes[:'liquid_assets']
121
+ end
122
+
123
+ if attributes.has_key?(:'tax_rate')
124
+ self.tax_rate = attributes[:'tax_rate']
125
+ else
126
+ self.tax_rate = 0.0
127
+ end
128
+
129
+ if attributes.has_key?(:'other_debt')
130
+ self.other_debt = attributes[:'other_debt']
131
+ end
132
+
133
+ if attributes.has_key?(:'end_of_life_expenses')
134
+ self.end_of_life_expenses = attributes[:'end_of_life_expenses']
135
+ end
136
+
137
+ if attributes.has_key?(:'existing_life_insurance')
138
+ self.existing_life_insurance = attributes[:'existing_life_insurance']
139
+ end
140
+
141
+ if attributes.has_key?(:'income_config')
142
+ if (value = attributes[:'income_config']).is_a?(Array)
143
+ self.income_config = value
144
+ end
145
+ end
146
+
147
+ if attributes.has_key?(:'mortgage_balance')
148
+ self.mortgage_balance = attributes[:'mortgage_balance']
149
+ end
150
+
151
+ if attributes.has_key?(:'benefit_amount_rounding')
152
+ self.benefit_amount_rounding = attributes[:'benefit_amount_rounding']
153
+ else
154
+ self.benefit_amount_rounding = 0
155
+ end
156
+
157
+ if attributes.has_key?(:'interest_rate')
158
+ self.interest_rate = attributes[:'interest_rate']
159
+ end
160
+
161
+ if attributes.has_key?(:'children_education_config')
162
+ if (value = attributes[:'children_education_config']).is_a?(Array)
163
+ self.children_education_config = value
164
+ end
165
+ end
166
+
167
+ if attributes.has_key?(:'general_inflation_rate')
168
+ self.general_inflation_rate = attributes[:'general_inflation_rate']
169
+ else
170
+ self.general_inflation_rate = 0.0
171
+ end
172
+ end
173
+
174
+ # Show invalid properties with the reasons. Usually used together with valid?
175
+ # @return Array for valid properties with the reasons
176
+ def list_invalid_properties
177
+ invalid_properties = Array.new
178
+ if !@education_inflation_rate.nil? && @education_inflation_rate < -1
179
+ invalid_properties.push('invalid value for "education_inflation_rate", must be greater than or equal to -1.')
180
+ end
181
+
182
+ if !@margin_of_error.nil? && @margin_of_error < 0
183
+ invalid_properties.push('invalid value for "margin_of_error", must be greater than or equal to 0.')
184
+ end
185
+
186
+ if !@liquid_assets.nil? && @liquid_assets < 0
187
+ invalid_properties.push('invalid value for "liquid_assets", must be greater than or equal to 0.')
188
+ end
189
+
190
+ if !@tax_rate.nil? && @tax_rate > 1
191
+ invalid_properties.push('invalid value for "tax_rate", must be smaller than or equal to 1.')
192
+ end
193
+
194
+ if !@tax_rate.nil? && @tax_rate < 0
195
+ invalid_properties.push('invalid value for "tax_rate", must be greater than or equal to 0.')
196
+ end
197
+
198
+ if !@other_debt.nil? && @other_debt < 0
199
+ invalid_properties.push('invalid value for "other_debt", must be greater than or equal to 0.')
200
+ end
201
+
202
+ if !@end_of_life_expenses.nil? && @end_of_life_expenses < 0
203
+ invalid_properties.push('invalid value for "end_of_life_expenses", must be greater than or equal to 0.')
204
+ end
205
+
206
+ if !@existing_life_insurance.nil? && @existing_life_insurance < 0
207
+ invalid_properties.push('invalid value for "existing_life_insurance", must be greater than or equal to 0.')
208
+ end
209
+
210
+ if !@mortgage_balance.nil? && @mortgage_balance < 0
211
+ invalid_properties.push('invalid value for "mortgage_balance", must be greater than or equal to 0.')
212
+ end
213
+
214
+ if !@benefit_amount_rounding.nil? && @benefit_amount_rounding > 12
215
+ invalid_properties.push('invalid value for "benefit_amount_rounding", must be smaller than or equal to 12.')
216
+ end
217
+
218
+ if !@benefit_amount_rounding.nil? && @benefit_amount_rounding < 0
219
+ invalid_properties.push('invalid value for "benefit_amount_rounding", must be greater than or equal to 0.')
220
+ end
221
+
222
+ if @interest_rate.nil?
223
+ invalid_properties.push('invalid value for "interest_rate", interest_rate cannot be nil.')
224
+ end
225
+
226
+ if @interest_rate < -1
227
+ invalid_properties.push('invalid value for "interest_rate", must be greater than or equal to -1.')
228
+ end
229
+
230
+ if !@general_inflation_rate.nil? && @general_inflation_rate < -1
231
+ invalid_properties.push('invalid value for "general_inflation_rate", must be greater than or equal to -1.')
232
+ end
233
+
234
+ invalid_properties
235
+ end
236
+
237
+ # Check to see if the all the properties in the model are valid
238
+ # @return true if the model is valid
239
+ def valid?
240
+ return false if !@education_inflation_rate.nil? && @education_inflation_rate < -1
241
+ return false if !@margin_of_error.nil? && @margin_of_error < 0
242
+ return false if !@liquid_assets.nil? && @liquid_assets < 0
243
+ return false if !@tax_rate.nil? && @tax_rate > 1
244
+ return false if !@tax_rate.nil? && @tax_rate < 0
245
+ return false if !@other_debt.nil? && @other_debt < 0
246
+ return false if !@end_of_life_expenses.nil? && @end_of_life_expenses < 0
247
+ return false if !@existing_life_insurance.nil? && @existing_life_insurance < 0
248
+ return false if !@mortgage_balance.nil? && @mortgage_balance < 0
249
+ return false if !@benefit_amount_rounding.nil? && @benefit_amount_rounding > 12
250
+ return false if !@benefit_amount_rounding.nil? && @benefit_amount_rounding < 0
251
+ return false if @interest_rate.nil?
252
+ return false if @interest_rate < -1
253
+ return false if !@general_inflation_rate.nil? && @general_inflation_rate < -1
254
+ true
255
+ end
256
+
257
+ # Custom attribute writer method with validation
258
+ # @param [Object] education_inflation_rate Value to be assigned
259
+ def education_inflation_rate=(education_inflation_rate)
260
+ if !education_inflation_rate.nil? && education_inflation_rate < -1
261
+ fail ArgumentError, 'invalid value for "education_inflation_rate", must be greater than or equal to -1.'
262
+ end
263
+
264
+ @education_inflation_rate = education_inflation_rate
265
+ end
266
+
267
+ # Custom attribute writer method with validation
268
+ # @param [Object] margin_of_error Value to be assigned
269
+ def margin_of_error=(margin_of_error)
270
+ if !margin_of_error.nil? && margin_of_error < 0
271
+ fail ArgumentError, 'invalid value for "margin_of_error", must be greater than or equal to 0.'
272
+ end
273
+
274
+ @margin_of_error = margin_of_error
275
+ end
276
+
277
+ # Custom attribute writer method with validation
278
+ # @param [Object] liquid_assets Value to be assigned
279
+ def liquid_assets=(liquid_assets)
280
+ if !liquid_assets.nil? && liquid_assets < 0
281
+ fail ArgumentError, 'invalid value for "liquid_assets", must be greater than or equal to 0.'
282
+ end
283
+
284
+ @liquid_assets = liquid_assets
285
+ end
286
+
287
+ # Custom attribute writer method with validation
288
+ # @param [Object] tax_rate Value to be assigned
289
+ def tax_rate=(tax_rate)
290
+ if !tax_rate.nil? && tax_rate > 1
291
+ fail ArgumentError, 'invalid value for "tax_rate", must be smaller than or equal to 1.'
292
+ end
293
+
294
+ if !tax_rate.nil? && tax_rate < 0
295
+ fail ArgumentError, 'invalid value for "tax_rate", must be greater than or equal to 0.'
296
+ end
297
+
298
+ @tax_rate = tax_rate
299
+ end
300
+
301
+ # Custom attribute writer method with validation
302
+ # @param [Object] other_debt Value to be assigned
303
+ def other_debt=(other_debt)
304
+ if !other_debt.nil? && other_debt < 0
305
+ fail ArgumentError, 'invalid value for "other_debt", must be greater than or equal to 0.'
306
+ end
307
+
308
+ @other_debt = other_debt
309
+ end
310
+
311
+ # Custom attribute writer method with validation
312
+ # @param [Object] end_of_life_expenses Value to be assigned
313
+ def end_of_life_expenses=(end_of_life_expenses)
314
+ if !end_of_life_expenses.nil? && end_of_life_expenses < 0
315
+ fail ArgumentError, 'invalid value for "end_of_life_expenses", must be greater than or equal to 0.'
316
+ end
317
+
318
+ @end_of_life_expenses = end_of_life_expenses
319
+ end
320
+
321
+ # Custom attribute writer method with validation
322
+ # @param [Object] existing_life_insurance Value to be assigned
323
+ def existing_life_insurance=(existing_life_insurance)
324
+ if !existing_life_insurance.nil? && existing_life_insurance < 0
325
+ fail ArgumentError, 'invalid value for "existing_life_insurance", must be greater than or equal to 0.'
326
+ end
327
+
328
+ @existing_life_insurance = existing_life_insurance
329
+ end
330
+
331
+ # Custom attribute writer method with validation
332
+ # @param [Object] mortgage_balance Value to be assigned
333
+ def mortgage_balance=(mortgage_balance)
334
+ if !mortgage_balance.nil? && mortgage_balance < 0
335
+ fail ArgumentError, 'invalid value for "mortgage_balance", must be greater than or equal to 0.'
336
+ end
337
+
338
+ @mortgage_balance = mortgage_balance
339
+ end
340
+
341
+ # Custom attribute writer method with validation
342
+ # @param [Object] benefit_amount_rounding Value to be assigned
343
+ def benefit_amount_rounding=(benefit_amount_rounding)
344
+ if !benefit_amount_rounding.nil? && benefit_amount_rounding > 12
345
+ fail ArgumentError, 'invalid value for "benefit_amount_rounding", must be smaller than or equal to 12.'
346
+ end
347
+
348
+ if !benefit_amount_rounding.nil? && benefit_amount_rounding < 0
349
+ fail ArgumentError, 'invalid value for "benefit_amount_rounding", must be greater than or equal to 0.'
350
+ end
351
+
352
+ @benefit_amount_rounding = benefit_amount_rounding
353
+ end
354
+
355
+ # Custom attribute writer method with validation
356
+ # @param [Object] interest_rate Value to be assigned
357
+ def interest_rate=(interest_rate)
358
+ if interest_rate.nil?
359
+ fail ArgumentError, 'interest_rate cannot be nil'
360
+ end
361
+
362
+ if interest_rate < -1
363
+ fail ArgumentError, 'invalid value for "interest_rate", must be greater than or equal to -1.'
364
+ end
365
+
366
+ @interest_rate = interest_rate
367
+ end
368
+
369
+ # Custom attribute writer method with validation
370
+ # @param [Object] general_inflation_rate Value to be assigned
371
+ def general_inflation_rate=(general_inflation_rate)
372
+ if !general_inflation_rate.nil? && general_inflation_rate < -1
373
+ fail ArgumentError, 'invalid value for "general_inflation_rate", must be greater than or equal to -1.'
374
+ end
375
+
376
+ @general_inflation_rate = general_inflation_rate
377
+ end
378
+
379
+ # Checks equality by comparing each attribute.
380
+ # @param [Object] Object to be compared
381
+ def ==(o)
382
+ return true if self.equal?(o)
383
+ self.class == o.class &&
384
+ client_id == o.client_id &&
385
+ beneficiary_bequest_config == o.beneficiary_bequest_config &&
386
+ education_inflation_rate == o.education_inflation_rate &&
387
+ margin_of_error == o.margin_of_error &&
388
+ liquid_assets == o.liquid_assets &&
389
+ tax_rate == o.tax_rate &&
390
+ other_debt == o.other_debt &&
391
+ end_of_life_expenses == o.end_of_life_expenses &&
392
+ existing_life_insurance == o.existing_life_insurance &&
393
+ income_config == o.income_config &&
394
+ mortgage_balance == o.mortgage_balance &&
395
+ benefit_amount_rounding == o.benefit_amount_rounding &&
396
+ interest_rate == o.interest_rate &&
397
+ children_education_config == o.children_education_config &&
398
+ general_inflation_rate == o.general_inflation_rate
399
+ end
400
+
401
+ # @see the `==` method
402
+ # @param [Object] Object to be compared
403
+ def eql?(o)
404
+ self == o
405
+ end
406
+
407
+ # Calculates hash code according to all attributes.
408
+ # @return [Fixnum] Hash code
409
+ def hash
410
+ [client_id, beneficiary_bequest_config, education_inflation_rate, margin_of_error, liquid_assets, tax_rate, other_debt, end_of_life_expenses, existing_life_insurance, income_config, mortgage_balance, benefit_amount_rounding, interest_rate, children_education_config, general_inflation_rate].hash
411
+ end
412
+
413
+ # Builds the object from hash
414
+ # @param [Hash] attributes Model attributes in the form of hash
415
+ # @return [Object] Returns the model itself
416
+ def build_from_hash(attributes)
417
+ return nil unless attributes.is_a?(Hash)
418
+ self.class.swagger_types.each_pair do |key, type|
419
+ if type =~ /\AArray<(.*)>/i
420
+ # check to ensure the input is an array given that the attribute
421
+ # is documented as an array but the input is not
422
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
423
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
424
+ end
425
+ elsif !attributes[self.class.attribute_map[key]].nil?
426
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
427
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
428
+ end
429
+
430
+ self
431
+ end
432
+ # Deserializes the data based on type
433
+ # @param string type Data type
434
+ # @param string value Value to be deserialized
435
+ # @return [Object] Deserialized data
436
+ def _deserialize(type, value)
437
+ case type.to_sym
438
+ when :DateTime
439
+ value
440
+ when :Date
441
+ value
442
+ when :String
443
+ value.to_s
444
+ when :Integer
445
+ value.to_i
446
+ when :Float
447
+ value.to_f
448
+ when :BOOLEAN
449
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
450
+ true
451
+ else
452
+ false
453
+ end
454
+ when :Object
455
+ # generic object (usually a Hash), return directly
456
+ value
457
+ when /\AArray<(?<inner_type>.+)>\z/
458
+ inner_type = Regexp.last_match[:inner_type]
459
+ value.map { |v| _deserialize(inner_type, v) }
460
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
461
+ k_type = Regexp.last_match[:k_type]
462
+ v_type = Regexp.last_match[:v_type]
463
+ {}.tap do |hash|
464
+ value.each do |k, v|
465
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
466
+ end
467
+ end
468
+ else # model
469
+ temp_model = ProtonApi.const_get(type).new
470
+ temp_model.build_from_hash(value)
471
+ end
472
+ end
473
+ # Returns the string representation of the object
474
+ # @return [String] String presentation of the object
475
+ def to_s
476
+ to_hash.to_s
477
+ end
478
+
479
+ # to_body is an alias to to_hash (backward compatibility)
480
+ # @return [Hash] Returns the object in the form of hash
481
+ def to_body
482
+ to_hash
483
+ end
484
+
485
+ # Returns the object in the form of hash
486
+ # @return [Hash] Returns the object in the form of hash
487
+ def to_hash
488
+ hash = {}
489
+ self.class.attribute_map.each_pair do |attr, param|
490
+ value = self.send(attr)
491
+ next if value.nil?
492
+ hash[param] = _to_hash(value)
493
+ end
494
+ hash
495
+ end
496
+ # Outputs non-array value in the form of hash
497
+ # For object, use to_hash. Otherwise, just return the value
498
+ # @param [Object] value Any valid value
499
+ # @return [Hash] Returns the value in the form of hash
500
+ def _to_hash(value)
501
+ if value.is_a?(Array)
502
+ value.compact.map { |v| _to_hash(v) }
503
+ elsif value.is_a?(Hash)
504
+ {}.tap do |hash|
505
+ value.each { |k, v| hash[k] = _to_hash(v) }
506
+ end
507
+ elsif value.respond_to? :to_hash
508
+ value.to_hash
509
+ else
510
+ value
511
+ end
512
+ end
513
+
514
+ end
515
+ end