Class: ProtonApi::EducationCalculatorAnnualCostRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EducationCalculatorAnnualCostRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



75
76
77
78
79
80
81
82
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
 
# File 'lib/proton_api/models/education_calculator_annual_cost_request.rb', line 75

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?(:'education_inflation_rate')
    self.education_inflation_rate = attributes[:'education_inflation_rate']
  else
    self.education_inflation_rate = 0.05
  end

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'percent_of_costs_covered')
    self.percent_of_costs_covered = attributes[:'percent_of_costs_covered']
  else
    self.percent_of_costs_covered = 1.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.



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

def 
  @account_ids
end

#accumulation_horizon ⇒ Object

Returns the value of attribute accumulation_horizon.



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

def accumulation_horizon
  @accumulation_horizon
end

#aggregation_account_ids ⇒ Object

Returns the value of attribute aggregation_account_ids.



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

def 
  @aggregation_account_ids
end

#decumulation_horizon ⇒ Object

Returns the value of attribute decumulation_horizon.



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

def decumulation_horizon
  @decumulation_horizon
end

#deposit_schedule ⇒ Object

Returns the value of attribute deposit_schedule.



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

def deposit_schedule
  @deposit_schedule
end

#education_inflation_rate ⇒ Object

Returns the value of attribute education_inflation_rate.



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

def education_inflation_rate
  @education_inflation_rate
end

#general_inflation_rate ⇒ Object

Returns the value of attribute general_inflation_rate.



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

def general_inflation_rate
  @general_inflation_rate
end

#initial_balance ⇒ Object

Returns the value of attribute initial_balance.



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

def initial_balance
  @initial_balance
end

#percent_of_costs_covered ⇒ Object

Returns the value of attribute percent_of_costs_covered.



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

def percent_of_costs_covered
  @percent_of_costs_covered
end

#portfolio_return ⇒ Object

Returns the value of attribute portfolio_return.



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

def portfolio_return
  @portfolio_return
end

#tax_rate ⇒ Object

Returns the value of attribute tax_rate.



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

def tax_rate
  @tax_rate
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/proton_api/models/education_calculator_annual_cost_request.rb', line 40

def self.attribute_map
  {
    :'education_inflation_rate' => :'education_inflation_rate',
    :'decumulation_horizon' => :'decumulation_horizon',
    :'accumulation_horizon' => :'accumulation_horizon',
    :'account_ids' => :'account_ids',
    :'tax_rate' => :'tax_rate',
    :'general_inflation_rate' => :'general_inflation_rate',
    :'portfolio_return' => :'portfolio_return',
    :'deposit_schedule' => :'deposit_schedule',
    :'initial_balance' => :'initial_balance',
    :'percent_of_costs_covered' => :'percent_of_costs_covered',
    :'aggregation_account_ids' => :'aggregation_account_ids'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/proton_api/models/education_calculator_annual_cost_request.rb', line 57

def self.swagger_types
  {
    :'education_inflation_rate' => :'Float',
    :'decumulation_horizon' => :'Integer',
    :'accumulation_horizon' => :'Integer',
    :'account_ids' => :'Array<String>',
    :'tax_rate' => :'Float',
    :'general_inflation_rate' => :'Float',
    :'portfolio_return' => :'Float',
    :'deposit_schedule' => :'CalculatorDepositSchedule1',
    :'initial_balance' => :'Float',
    :'percent_of_costs_covered' => :'Float',
    :'aggregation_account_ids' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/proton_api/models/education_calculator_annual_cost_request.rb', line 320

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      education_inflation_rate == o.education_inflation_rate &&
      decumulation_horizon == o.decumulation_horizon &&
      accumulation_horizon == o.accumulation_horizon &&
       == o. &&
      tax_rate == o.tax_rate &&
      general_inflation_rate == o.general_inflation_rate &&
      portfolio_return == o.portfolio_return &&
      deposit_schedule == o.deposit_schedule &&
      initial_balance == o.initial_balance &&
      percent_of_costs_covered == o.percent_of_costs_covered &&
       == o.
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/proton_api/models/education_calculator_annual_cost_request.rb', line 371

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



435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/proton_api/models/education_calculator_annual_cost_request.rb', line 435

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



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/proton_api/models/education_calculator_annual_cost_request.rb', line 351

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


338
339
340
 
# File 'lib/proton_api/models/education_calculator_annual_cost_request.rb', line 338

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



344
345
346
 
# File 'lib/proton_api/models/education_calculator_annual_cost_request.rb', line 344

def hash
  [education_inflation_rate, decumulation_horizon, accumulation_horizon, , tax_rate, general_inflation_rate, portfolio_return, deposit_schedule, initial_balance, percent_of_costs_covered, ].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



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
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
 
# File 'lib/proton_api/models/education_calculator_annual_cost_request.rb', line 142

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

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

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

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

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

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

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

  if !@general_inflation_rate.nil? && @general_inflation_rate < -1
    invalid_properties.push('invalid value for "general_inflation_rate", must be greater than or equal to -1.')
  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 !@initial_balance.nil? && @initial_balance < 0
    invalid_properties.push('invalid value for "initial_balance", must be greater than or equal to 0.')
  end

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

  if !@percent_of_costs_covered.nil? && @percent_of_costs_covered < 0
    invalid_properties.push('invalid value for "percent_of_costs_covered", must be greater than or equal to 0.')
  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



416
417
418
 
# File 'lib/proton_api/models/education_calculator_annual_cost_request.rb', line 416

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



422
423
424
425
426
427
428
429
430
 
# File 'lib/proton_api/models/education_calculator_annual_cost_request.rb', line 422

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



410
411
412
 
# File 'lib/proton_api/models/education_calculator_annual_cost_request.rb', line 410

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



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/proton_api/models/education_calculator_annual_cost_request.rb', line 201

def valid?
  return false if !@education_inflation_rate.nil? && @education_inflation_rate < -1
  return false if @decumulation_horizon.nil?
  return false if @decumulation_horizon < 0
  return false if @accumulation_horizon.nil?
  return false if @accumulation_horizon < 0
  return false if !@tax_rate.nil? && @tax_rate > 1
  return false if !@tax_rate.nil? && @tax_rate < 0
  return false if !@general_inflation_rate.nil? && @general_inflation_rate < -1
  return false if @portfolio_return.nil?
  return false if @portfolio_return < -1
  return false if !@initial_balance.nil? && @initial_balance < 0
  return false if !@percent_of_costs_covered.nil? && @percent_of_costs_covered > 1
  return false if !@percent_of_costs_covered.nil? && @percent_of_costs_covered < 0
  true
end