class ProtonApi::AnnuityDepositSchedule

Attributes

adjust_deposit_for_inflation[RW]
deposit_amount[RW]
deposit_frequency_interval[RW]

Public Class Methods

attribute_map() click to toggle source

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

# 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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# 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
swagger_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# 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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# 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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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
deposit_amount=(deposit_amount) click to toggle source

Custom attribute writer method with validation @param [Object] deposit_amount Value to be assigned

# File lib/proton_api/models/annuity_deposit_schedule.rb, line 112
def deposit_amount=(deposit_amount)
  if !deposit_amount.nil? && deposit_amount < 0
    fail ArgumentError, 'invalid value for "deposit_amount", must be greater than or equal to 0.'
  end

  @deposit_amount = deposit_amount
end
deposit_frequency_interval=(deposit_frequency_interval) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] deposit_frequency_interval Object to be assigned

# File lib/proton_api/models/annuity_deposit_schedule.rb, line 122
def deposit_frequency_interval=(deposit_frequency_interval)
  validator = EnumAttributeValidator.new('String', ['year', 'quarter', 'month', 'week', 'day'])
  unless validator.valid?(deposit_frequency_interval)
    fail ArgumentError, 'invalid value for "deposit_frequency_interval", must be one of #{validator.allowable_values}.'
  end
  @deposit_frequency_interval = deposit_frequency_interval
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/proton_api/models/annuity_deposit_schedule.rb, line 142
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# 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() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# 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() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/proton_api/models/annuity_deposit_schedule.rb, line 220
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# 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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/proton_api/models/annuity_deposit_schedule.rb, line 214
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# 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