Class: ProtonApi::AnnuityDepositSchedule

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AnnuityDepositSchedule

Initializes the object

Parameters:

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

    Model attributes in the form of hash



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/proton_api/models/annuity_deposit_schedule.rb', line 65

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

  if attributes.has_key?(:'deposit_frequency_interval')
    self.deposit_frequency_interval = attributes[:'deposit_frequency_interval']
  else
    self.deposit_frequency_interval = 'year'
  end

  if attributes.has_key?(:'adjust_deposit_for_inflation')
    self.adjust_deposit_for_inflation = attributes[:'adjust_deposit_for_inflation']
  else
    self.adjust_deposit_for_inflation = true
  end
end

Instance Attribute Details

#adjust_deposit_for_inflation ⇒ Object

Returns the value of attribute adjust_deposit_for_inflation.



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

def adjust_deposit_for_inflation
  @adjust_deposit_for_inflation
end

#deposit_amount ⇒ Object

Returns the value of attribute deposit_amount.



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

def deposit_amount
  @deposit_amount
end

#deposit_frequency_interval ⇒ Object

Returns the value of attribute deposit_frequency_interval.



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

def deposit_frequency_interval
  @deposit_frequency_interval
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
 
# File 'lib/proton_api/models/annuity_deposit_schedule.rb', line 46

def self.attribute_map
  {
    :'deposit_amount' => :'deposit_amount',
    :'deposit_frequency_interval' => :'deposit_frequency_interval',
    :'adjust_deposit_for_inflation' => :'adjust_deposit_for_inflation'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
 
# File 'lib/proton_api/models/annuity_deposit_schedule.rb', line 55

def self.swagger_types
  {
    :'deposit_amount' => :'Float',
    :'deposit_frequency_interval' => :'String',
    :'adjust_deposit_for_inflation' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



132
133
134
135
136
137
138
 
# File 'lib/proton_api/models/annuity_deposit_schedule.rb', line 132

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      deposit_amount == o.deposit_amount &&
      deposit_frequency_interval == o.deposit_frequency_interval &&
      adjust_deposit_for_inflation == o.adjust_deposit_for_inflation
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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

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



239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/proton_api/models/annuity_deposit_schedule.rb', line 239

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



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/proton_api/models/annuity_deposit_schedule.rb', line 155

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


142
143
144
 
# File 'lib/proton_api/models/annuity_deposit_schedule.rb', line 142

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



148
149
150
 
# File 'lib/proton_api/models/annuity_deposit_schedule.rb', line 148

def hash
  [deposit_amount, deposit_frequency_interval, adjust_deposit_for_inflation].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



92
93
94
95
96
97
98
99
 
# File 'lib/proton_api/models/annuity_deposit_schedule.rb', line 92

def list_invalid_properties
  invalid_properties = Array.new
  if !@deposit_amount.nil? && @deposit_amount < 0
    invalid_properties.push('invalid value for "deposit_amount", 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



220
221
222
 
# File 'lib/proton_api/models/annuity_deposit_schedule.rb', line 220

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



226
227
228
229
230
231
232
233
234
 
# File 'lib/proton_api/models/annuity_deposit_schedule.rb', line 226

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



214
215
216
 
# File 'lib/proton_api/models/annuity_deposit_schedule.rb', line 214

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



103
104
105
106
107
108
 
# File 'lib/proton_api/models/annuity_deposit_schedule.rb', line 103

def valid?
  return false if !@deposit_amount.nil? && @deposit_amount < 0
  deposit_frequency_interval_validator = EnumAttributeValidator.new('String', ['year', 'quarter', 'month', 'week', 'day'])
  return false unless deposit_frequency_interval_validator.valid?(@deposit_frequency_interval)
  true
end