class ProtonApi::MortgageCalculatorPeriodicPaymentRequest

Attributes

down_payment[RW]
home_price[RW]
interest_rate[RW]
mortgage_term[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/mortgage_calculator_periodic_payment_request.rb, line 26
def self.attribute_map
  {
    :'down_payment' => :'down_payment',
    :'interest_rate' => :'interest_rate',
    :'home_price' => :'home_price',
    :'mortgage_term' => :'mortgage_term'
  }
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/mortgage_calculator_periodic_payment_request.rb, line 47
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?(:'down_payment')
    self.down_payment = attributes[:'down_payment']
  end

  if attributes.has_key?(:'interest_rate')
    self.interest_rate = attributes[:'interest_rate']
  else
    self.interest_rate = 0.04
  end

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

  if attributes.has_key?(:'mortgage_term')
    self.mortgage_term = attributes[:'mortgage_term']
  else
    self.mortgage_term = 360
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/proton_api/models/mortgage_calculator_periodic_payment_request.rb, line 36
def self.swagger_types
  {
    :'down_payment' => :'Float',
    :'interest_rate' => :'Float',
    :'home_price' => :'Float',
    :'mortgage_term' => :'Integer'
  }
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/mortgage_calculator_periodic_payment_request.rb, line 176
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      down_payment == o.down_payment &&
      interest_rate == o.interest_rate &&
      home_price == o.home_price &&
      mortgage_term == o.mortgage_term
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/mortgage_calculator_periodic_payment_request.rb, line 220
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/mortgage_calculator_periodic_payment_request.rb, line 284
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/mortgage_calculator_periodic_payment_request.rb, line 200
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
down_payment=(down_payment) click to toggle source

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

# File lib/proton_api/models/mortgage_calculator_periodic_payment_request.rb, line 124
def down_payment=(down_payment)
  if down_payment.nil?
    fail ArgumentError, 'down_payment cannot be nil'
  end

  if down_payment < 0
    fail ArgumentError, 'invalid value for "down_payment", must be greater than or equal to 0.'
  end

  @down_payment = down_payment
end
eql?(o) click to toggle source

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

# File lib/proton_api/models/mortgage_calculator_periodic_payment_request.rb, line 187
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/mortgage_calculator_periodic_payment_request.rb, line 193
def hash
  [down_payment, interest_rate, home_price, mortgage_term].hash
end
home_price=(home_price) click to toggle source

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

# File lib/proton_api/models/mortgage_calculator_periodic_payment_request.rb, line 148
def home_price=(home_price)
  if home_price.nil?
    fail ArgumentError, 'home_price cannot be nil'
  end

  if home_price < 0
    fail ArgumentError, 'invalid value for "home_price", must be greater than or equal to 0.'
  end

  @home_price = home_price
end
interest_rate=(interest_rate) click to toggle source

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

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

  @interest_rate = interest_rate
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/mortgage_calculator_periodic_payment_request.rb, line 76
def list_invalid_properties
  invalid_properties = Array.new
  if @down_payment.nil?
    invalid_properties.push('invalid value for "down_payment", down_payment cannot be nil.')
  end

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

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

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

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

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

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

  invalid_properties
end
mortgage_term=(mortgage_term) click to toggle source

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

# File lib/proton_api/models/mortgage_calculator_periodic_payment_request.rb, line 162
def mortgage_term=(mortgage_term)
  if !mortgage_term.nil? && mortgage_term > 600
    fail ArgumentError, 'invalid value for "mortgage_term", must be smaller than or equal to 600.'
  end

  if !mortgage_term.nil? && mortgage_term < 0
    fail ArgumentError, 'invalid value for "mortgage_term", must be greater than or equal to 0.'
  end

  @mortgage_term = mortgage_term
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/mortgage_calculator_periodic_payment_request.rb, line 265
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/mortgage_calculator_periodic_payment_request.rb, line 271
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/mortgage_calculator_periodic_payment_request.rb, line 259
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/mortgage_calculator_periodic_payment_request.rb, line 111
def valid?
  return false if @down_payment.nil?
  return false if @down_payment < 0
  return false if !@interest_rate.nil? && @interest_rate < 0
  return false if @home_price.nil?
  return false if @home_price < 0
  return false if !@mortgage_term.nil? && @mortgage_term > 600
  return false if !@mortgage_term.nil? && @mortgage_term < 0
  true
end