Class: ProtonApi::RetirementCalculatorDepositAmountRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/proton_api/models/retirement_calculator_deposit_amount_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RetirementCalculatorDepositAmountRequest

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/proton_api/models/retirement_calculator_deposit_amount_request.rb', line 83

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'retirement_savings')
    self.retirement_savings = attributes[:'retirement_savings']
  else
    self.retirement_savings = 0.0
  end

  if attributes.has_key?(:'current_age')
    self.current_age = attributes[:'current_age']
  end

  if attributes.has_key?(:'account_ids')
    if (value = attributes[:'account_ids']).is_a?(Array)
      self. = value
    end
  end

  if attributes.has_key?(:'retirement_income')
    self.retirement_income = attributes[:'retirement_income']
  else
    self.retirement_income = 0.0
  end

  if attributes.has_key?(:'retirement_tax')
    self.retirement_tax = attributes[:'retirement_tax']
  else
    self.retirement_tax = 0.0
  end

  if attributes.has_key?(:'death_age')
    self.death_age = attributes[:'death_age']
  end

  if attributes.has_key?(:'retirement_age')
    self.retirement_age = attributes[:'retirement_age']
  else
    self.retirement_age = 65
  end

  if attributes.has_key?(:'percent_of_expenses_covered')
    self.percent_of_expenses_covered = attributes[:'percent_of_expenses_covered']
  else
    self.percent_of_expenses_covered = 1.0
  end

  if attributes.has_key?(:'portfolio_return')
    self.portfolio_return = attributes[:'portfolio_return']
  end

  if attributes.has_key?(:'retirement_expenses')
    self.retirement_expenses = attributes[:'retirement_expenses']
  end

  if attributes.has_key?(:'deposit_schedule')
    self.deposit_schedule = attributes[:'deposit_schedule']
  end

  if attributes.has_key?(:'inflation_rate')
    self.inflation_rate = attributes[:'inflation_rate']
  else
    self.inflation_rate = 0.0
  end

  if attributes.has_key?(:'aggregation_account_ids')
    if (value = attributes[:'aggregation_account_ids']).is_a?(Array)
      self. = value
    end
  end
end

Instance Attribute Details

#account_ids ⇒ Object

Returns the value of attribute account_ids.



21
22
23
 
# File 'lib/proton_api/models/retirement_calculator_deposit_amount_request.rb', line 21

def 
  @account_ids
end

#aggregation_account_ids ⇒ Object

Returns the value of attribute aggregation_account_ids.



41
42
43
 
# File 'lib/proton_api/models/retirement_calculator_deposit_amount_request.rb', line 41

def 
  @aggregation_account_ids
end

#current_age ⇒ Object

Returns the value of attribute current_age.



19
20
21
 
# File 'lib/proton_api/models/retirement_calculator_deposit_amount_request.rb', line 19

def current_age
  @current_age
end

#death_age ⇒ Object

Returns the value of attribute death_age.



27
28
29
 
# File 'lib/proton_api/models/retirement_calculator_deposit_amount_request.rb', line 27

def death_age
  @death_age
end

#deposit_schedule ⇒ Object

Returns the value of attribute deposit_schedule.



37
38
39
 
# File 'lib/proton_api/models/retirement_calculator_deposit_amount_request.rb', line 37

def deposit_schedule
  @deposit_schedule
end

#inflation_rate ⇒ Object

Returns the value of attribute inflation_rate.



39
40
41
 
# File 'lib/proton_api/models/retirement_calculator_deposit_amount_request.rb', line 39

def inflation_rate
  @inflation_rate
end

#percent_of_expenses_covered ⇒ Object

Returns the value of attribute percent_of_expenses_covered.



31
32
33
 
# File 'lib/proton_api/models/retirement_calculator_deposit_amount_request.rb', line 31

def percent_of_expenses_covered
  @percent_of_expenses_covered
end

#portfolio_return ⇒ Object

Returns the value of attribute portfolio_return.



33
34
35
 
# File 'lib/proton_api/models/retirement_calculator_deposit_amount_request.rb', line 33

def portfolio_return
  @portfolio_return
end

#retirement_age ⇒ Object

Returns the value of attribute retirement_age.



29
30
31
 
# File 'lib/proton_api/models/retirement_calculator_deposit_amount_request.rb', line 29

def retirement_age
  @retirement_age
end

#retirement_expenses ⇒ Object

Returns the value of attribute retirement_expenses.



35
36
37
 
# File 'lib/proton_api/models/retirement_calculator_deposit_amount_request.rb', line 35

def retirement_expenses
  @retirement_expenses
end

#retirement_income ⇒ Object

Returns the value of attribute retirement_income.



23
24
25
 
# File 'lib/proton_api/models/retirement_calculator_deposit_amount_request.rb', line 23

def retirement_income
  @retirement_income
end

#retirement_savings ⇒ Object

Returns the value of attribute retirement_savings.



17
18
19
 
# File 'lib/proton_api/models/retirement_calculator_deposit_amount_request.rb', line 17

def retirement_savings
  @retirement_savings
end

#retirement_tax ⇒ Object

Returns the value of attribute retirement_tax.



25
26
27
 
# File 'lib/proton_api/models/retirement_calculator_deposit_amount_request.rb', line 25

def retirement_tax
  @retirement_tax
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/proton_api/models/retirement_calculator_deposit_amount_request.rb', line 44

def self.attribute_map
  {
    :'retirement_savings' => :'retirement_savings',
    :'current_age' => :'current_age',
    :'account_ids' => :'account_ids',
    :'retirement_income' => :'retirement_income',
    :'retirement_tax' => :'retirement_tax',
    :'death_age' => :'death_age',
    :'retirement_age' => :'retirement_age',
    :'percent_of_expenses_covered' => :'percent_of_expenses_covered',
    :'portfolio_return' => :'portfolio_return',
    :'retirement_expenses' => :'retirement_expenses',
    :'deposit_schedule' => :'deposit_schedule',
    :'inflation_rate' => :'inflation_rate',
    :'aggregation_account_ids' => :'aggregation_account_ids'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/proton_api/models/retirement_calculator_deposit_amount_request.rb', line 63

def self.swagger_types
  {
    :'retirement_savings' => :'Float',
    :'current_age' => :'Integer',
    :'account_ids' => :'Array<String>',
    :'retirement_income' => :'Float',
    :'retirement_tax' => :'Float',
    :'death_age' => :'Integer',
    :'retirement_age' => :'Integer',
    :'percent_of_expenses_covered' => :'Float',
    :'portfolio_return' => :'Float',
    :'retirement_expenses' => :'Float',
    :'deposit_schedule' => :'CalculatorDepositSchedule',
    :'inflation_rate' => :'Float',
    :'aggregation_account_ids' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/proton_api/models/retirement_calculator_deposit_amount_request.rb', line 377

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      retirement_savings == o.retirement_savings &&
      current_age == o.current_age &&
       == o. &&
      retirement_income == o.retirement_income &&
      retirement_tax == o.retirement_tax &&
      death_age == o.death_age &&
      retirement_age == o.retirement_age &&
      percent_of_expenses_covered == o.percent_of_expenses_covered &&
      portfolio_return == o.portfolio_return &&
      retirement_expenses == o.retirement_expenses &&
      deposit_schedule == o.deposit_schedule &&
      inflation_rate == o.inflation_rate &&
       == o.
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/proton_api/models/retirement_calculator_deposit_amount_request.rb', line 430

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    value
  when :Date
    value
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = ProtonApi.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/proton_api/models/retirement_calculator_deposit_amount_request.rb', line 494

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/proton_api/models/retirement_calculator_deposit_amount_request.rb', line 410

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


397
398
399
 
# File 'lib/proton_api/models/retirement_calculator_deposit_amount_request.rb', line 397

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



403
404
405
 
# File 'lib/proton_api/models/retirement_calculator_deposit_amount_request.rb', line 403

def hash
  [retirement_savings, current_age, , retirement_income, retirement_tax, death_age, retirement_age, percent_of_expenses_covered, portfolio_return, retirement_expenses, deposit_schedule, inflation_rate, ].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/proton_api/models/retirement_calculator_deposit_amount_request.rb', line 160

def list_invalid_properties
  invalid_properties = Array.new
  if !@retirement_savings.nil? && @retirement_savings < 0
    invalid_properties.push('invalid value for "retirement_savings", must be greater than or equal to 0.')
  end

  if @current_age.nil?
    invalid_properties.push('invalid value for "current_age", current_age cannot be nil.')
  end

  if @current_age < 0
    invalid_properties.push('invalid value for "current_age", must be greater than or equal to 0.')
  end

  if !@retirement_income.nil? && @retirement_income < 0
    invalid_properties.push('invalid value for "retirement_income", must be greater than or equal to 0.')
  end

  if !@retirement_tax.nil? && @retirement_tax > 1
    invalid_properties.push('invalid value for "retirement_tax", must be smaller than or equal to 1.')
  end

  if !@retirement_tax.nil? && @retirement_tax < 0
    invalid_properties.push('invalid value for "retirement_tax", must be greater than or equal to 0.')
  end

  if @death_age.nil?
    invalid_properties.push('invalid value for "death_age", death_age cannot be nil.')
  end

  if @death_age < 0
    invalid_properties.push('invalid value for "death_age", must be greater than or equal to 0.')
  end

  if !@retirement_age.nil? && @retirement_age < 0
    invalid_properties.push('invalid value for "retirement_age", must be greater than or equal to 0.')
  end

  if !@percent_of_expenses_covered.nil? && @percent_of_expenses_covered > 1
    invalid_properties.push('invalid value for "percent_of_expenses_covered", must be smaller than or equal to 1.')
  end

  if !@percent_of_expenses_covered.nil? && @percent_of_expenses_covered < 0
    invalid_properties.push('invalid value for "percent_of_expenses_covered", must be greater than or equal to 0.')
  end

  if @portfolio_return.nil?
    invalid_properties.push('invalid value for "portfolio_return", portfolio_return cannot be nil.')
  end

  if @portfolio_return < -1
    invalid_properties.push('invalid value for "portfolio_return", must be greater than or equal to -1.')
  end

  if @retirement_expenses.nil?
    invalid_properties.push('invalid value for "retirement_expenses", retirement_expenses cannot be nil.')
  end

  if @retirement_expenses < 0
    invalid_properties.push('invalid value for "retirement_expenses", must be greater than or equal to 0.')
  end

  if !@inflation_rate.nil? && @inflation_rate < -1
    invalid_properties.push('invalid value for "inflation_rate", must be greater than or equal to -1.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



475
476
477
 
# File 'lib/proton_api/models/retirement_calculator_deposit_amount_request.rb', line 475

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



481
482
483
484
485
486
487
488
489
 
# File 'lib/proton_api/models/retirement_calculator_deposit_amount_request.rb', line 481

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns String presentation of the object.

Returns:

  • (String) —

    String presentation of the object



469
470
471
 
# File 'lib/proton_api/models/retirement_calculator_deposit_amount_request.rb', line 469

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/proton_api/models/retirement_calculator_deposit_amount_request.rb', line 231

def valid?
  return false if !@retirement_savings.nil? && @retirement_savings < 0
  return false if @current_age.nil?
  return false if @current_age < 0
  return false if !@retirement_income.nil? && @retirement_income < 0
  return false if !@retirement_tax.nil? && @retirement_tax > 1
  return false if !@retirement_tax.nil? && @retirement_tax < 0
  return false if @death_age.nil?
  return false if @death_age < 0
  return false if !@retirement_age.nil? && @retirement_age < 0
  return false if !@percent_of_expenses_covered.nil? && @percent_of_expenses_covered > 1
  return false if !@percent_of_expenses_covered.nil? && @percent_of_expenses_covered < 0
  return false if @portfolio_return.nil?
  return false if @portfolio_return < -1
  return false if @retirement_expenses.nil?
  return false if @retirement_expenses < 0
  return false if !@inflation_rate.nil? && @inflation_rate < -1
  true
end