Class: ProtonApi::SavingsCalculatorRequest

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SavingsCalculatorRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/proton_api/models/savings_calculator_request.rb', line 93

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?(:'inflation_rate')
    self.inflation_rate = attributes[:'inflation_rate']
  else
    self.inflation_rate = 0.0
  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?(:'horizon_frequency_interval')
    self.horizon_frequency_interval = attributes[:'horizon_frequency_interval']
  else
    self.horizon_frequency_interval = 'year'
  end

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

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

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

  if attributes.has_key?(:'create_log')
    self.create_log = attributes[:'create_log']
  else
    self.create_log = false
  end

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



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

def 
  @account_ids
end

#aggregation_account_ids ⇒ Object

Returns the value of attribute aggregation_account_ids.



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

def 
  
end

#create_log ⇒ Object

Returns the value of attribute create_log.



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

def create_log
  @create_log
end

#deposit_schedule ⇒ Object

Returns the value of attribute deposit_schedule.



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

def deposit_schedule
  @deposit_schedule
end

#horizon ⇒ Object

Returns the value of attribute horizon.



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

def horizon
  @horizon
end

#horizon_frequency_interval ⇒ Object

Returns the value of attribute horizon_frequency_interval.



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

def horizon_frequency_interval
  @horizon_frequency_interval
end

#inflation_rate ⇒ Object

Returns the value of attribute inflation_rate.



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

def inflation_rate
  @inflation_rate
end

#initial_balance ⇒ Object

Returns the value of attribute initial_balance.



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

def initial_balance
  @initial_balance
end

#return_schedule ⇒ Object

Returns the value of attribute return_schedule.



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

def return_schedule
  @return_schedule
end

#tax_rate ⇒ Object

Returns the value of attribute tax_rate.



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

def tax_rate
  @tax_rate
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/proton_api/models/savings_calculator_request.rb', line 60

def self.attribute_map
  {
    :'inflation_rate' => :'inflation_rate',
    :'account_ids' => :'account_ids',
    :'tax_rate' => :'tax_rate',
    :'horizon_frequency_interval' => :'horizon_frequency_interval',
    :'deposit_schedule' => :'deposit_schedule',
    :'horizon' => :'horizon',
    :'return_schedule' => :'return_schedule',
    :'create_log' => :'create_log',
    :'initial_balance' => :'initial_balance',
    :'aggregation_account_ids' => :'aggregation_account_ids'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/proton_api/models/savings_calculator_request.rb', line 76

def self.swagger_types
  {
    :'inflation_rate' => :'Float',
    :'account_ids' => :'Array<String>',
    :'tax_rate' => :'Float',
    :'horizon_frequency_interval' => :'String',
    :'deposit_schedule' => :'Array<SavingsDepositSchedule>',
    :'horizon' => :'Integer',
    :'return_schedule' => :'Array<Float>',
    :'create_log' => :'BOOLEAN',
    :'initial_balance' => :'Float',
    :'aggregation_account_ids' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/proton_api/models/savings_calculator_request.rb', line 266

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      inflation_rate == o.inflation_rate &&
       == o. &&
      tax_rate == o.tax_rate &&
      horizon_frequency_interval == o.horizon_frequency_interval &&
      deposit_schedule == o.deposit_schedule &&
      horizon == o.horizon &&
      return_schedule == o.return_schedule &&
      create_log == o.create_log &&
      initial_balance == o.initial_balance &&
       == o.
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/proton_api/models/savings_calculator_request.rb', line 316

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



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

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



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/proton_api/models/savings_calculator_request.rb', line 296

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


283
284
285
 
# File 'lib/proton_api/models/savings_calculator_request.rb', line 283

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



289
290
291
 
# File 'lib/proton_api/models/savings_calculator_request.rb', line 289

def hash
  [inflation_rate, , tax_rate, horizon_frequency_interval, deposit_schedule, horizon, return_schedule, create_log, initial_balance, ].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



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
 
# File 'lib/proton_api/models/savings_calculator_request.rb', line 158

def list_invalid_properties
  invalid_properties = Array.new
  if !@inflation_rate.nil? && @inflation_rate < -1
    invalid_properties.push('invalid value for "inflation_rate", must be greater than or equal to -1.')
  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 @horizon.nil?
    invalid_properties.push('invalid value for "horizon", horizon cannot be nil.')
  end

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

  if @return_schedule.nil?
    invalid_properties.push('invalid value for "return_schedule", return_schedule cannot be nil.')
  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

  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



361
362
363
 
# File 'lib/proton_api/models/savings_calculator_request.rb', line 361

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



367
368
369
370
371
372
373
374
375
 
# File 'lib/proton_api/models/savings_calculator_request.rb', line 367

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



355
356
357
 
# File 'lib/proton_api/models/savings_calculator_request.rb', line 355

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



193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/proton_api/models/savings_calculator_request.rb', line 193

def valid?
  return false if !@inflation_rate.nil? && @inflation_rate < -1
  return false if !@tax_rate.nil? && @tax_rate > 1
  return false if !@tax_rate.nil? && @tax_rate < 0
  horizon_frequency_interval_validator = EnumAttributeValidator.new('String', ['year', 'quarter', 'month', 'week', 'day'])
  return false unless horizon_frequency_interval_validator.valid?(@horizon_frequency_interval)
  return false if @horizon.nil?
  return false if @horizon < 0
  return false if @return_schedule.nil?
  return false if !@initial_balance.nil? && @initial_balance < 0
  true
end