class ProtonApi::AnnuityCalculatorDepositAmountRequest

Attributes

account_ids[RW]
accumulation_horizon[RW]
aggregation_account_ids[RW]
annuity_amount[RW]
annuity_frequency_interval[RW]
create_log[RW]
decumulation_horizon[RW]
deposit_schedule[RW]
inflation_rate[RW]
initial_balance[RW]
portfolio_return[RW]
tax_rate[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_calculator_deposit_amount_request.rb, line 64
def self.attribute_map
  {
    :'inflation_rate' => :'inflation_rate',
    :'decumulation_horizon' => :'decumulation_horizon',
    :'account_ids' => :'account_ids',
    :'tax_rate' => :'tax_rate',
    :'accumulation_horizon' => :'accumulation_horizon',
    :'annuity_amount' => :'annuity_amount',
    :'portfolio_return' => :'portfolio_return',
    :'deposit_schedule' => :'deposit_schedule',
    :'annuity_frequency_interval' => :'annuity_frequency_interval',
    :'initial_balance' => :'initial_balance',
    :'aggregation_account_ids' => :'aggregation_account_ids',
    :'create_log' => :'create_log'
  }
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_calculator_deposit_amount_request.rb, line 101
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?(:'decumulation_horizon')
    self.decumulation_horizon = attributes[:'decumulation_horizon']
  end

  if attributes.has_key?(:'account_ids')
    if (value = attributes[:'account_ids']).is_a?(Array)
      self.account_ids = 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?(:'accumulation_horizon')
    self.accumulation_horizon = attributes[:'accumulation_horizon']
  end

  if attributes.has_key?(:'annuity_amount')
    self.annuity_amount = attributes[:'annuity_amount']
  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?(:'annuity_frequency_interval')
    self.annuity_frequency_interval = attributes[:'annuity_frequency_interval']
  else
    self.annuity_frequency_interval = 'year'
  end

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

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

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

Attribute type mapping.

# File lib/proton_api/models/annuity_calculator_deposit_amount_request.rb, line 82
def self.swagger_types
  {
    :'inflation_rate' => :'Float',
    :'decumulation_horizon' => :'Integer',
    :'account_ids' => :'Array<String>',
    :'tax_rate' => :'Float',
    :'accumulation_horizon' => :'Integer',
    :'annuity_amount' => :'Float',
    :'portfolio_return' => :'Float',
    :'deposit_schedule' => :'AnnuityDepositSchedule',
    :'annuity_frequency_interval' => :'String',
    :'initial_balance' => :'Float',
    :'aggregation_account_ids' => :'Array<String>',
    :'create_log' => :'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_calculator_deposit_amount_request.rb, line 337
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      inflation_rate == o.inflation_rate &&
      decumulation_horizon == o.decumulation_horizon &&
      account_ids == o.account_ids &&
      tax_rate == o.tax_rate &&
      accumulation_horizon == o.accumulation_horizon &&
      annuity_amount == o.annuity_amount &&
      portfolio_return == o.portfolio_return &&
      deposit_schedule == o.deposit_schedule &&
      annuity_frequency_interval == o.annuity_frequency_interval &&
      initial_balance == o.initial_balance &&
      aggregation_account_ids == o.aggregation_account_ids &&
      create_log == o.create_log
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_calculator_deposit_amount_request.rb, line 389
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_calculator_deposit_amount_request.rb, line 453
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
accumulation_horizon=(accumulation_horizon) click to toggle source

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

# File lib/proton_api/models/annuity_calculator_deposit_amount_request.rb, line 289
def accumulation_horizon=(accumulation_horizon)
  if accumulation_horizon.nil?
    fail ArgumentError, 'accumulation_horizon cannot be nil'
  end

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

  @accumulation_horizon = accumulation_horizon
end
annuity_amount=(annuity_amount) click to toggle source

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

# File lib/proton_api/models/annuity_calculator_deposit_amount_request.rb, line 303
def annuity_amount=(annuity_amount)
  if annuity_amount.nil?
    fail ArgumentError, 'annuity_amount cannot be nil'
  end

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

  @annuity_amount = annuity_amount
end
annuity_frequency_interval=(annuity_frequency_interval) click to toggle source

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

# File lib/proton_api/models/annuity_calculator_deposit_amount_request.rb, line 317
def annuity_frequency_interval=(annuity_frequency_interval)
  validator = EnumAttributeValidator.new('String', ['year', 'quarter', 'month', 'week', 'day'])
  unless validator.valid?(annuity_frequency_interval)
    fail ArgumentError, 'invalid value for "annuity_frequency_interval", must be one of #{validator.allowable_values}.'
  end
  @annuity_frequency_interval = annuity_frequency_interval
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_calculator_deposit_amount_request.rb, line 369
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
decumulation_horizon=(decumulation_horizon) click to toggle source

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

# File lib/proton_api/models/annuity_calculator_deposit_amount_request.rb, line 261
def decumulation_horizon=(decumulation_horizon)
  if decumulation_horizon.nil?
    fail ArgumentError, 'decumulation_horizon cannot be nil'
  end

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

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

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

# File lib/proton_api/models/annuity_calculator_deposit_amount_request.rb, line 356
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_calculator_deposit_amount_request.rb, line 362
def hash
  [inflation_rate, decumulation_horizon, account_ids, tax_rate, accumulation_horizon, annuity_amount, portfolio_return, deposit_schedule, annuity_frequency_interval, initial_balance, aggregation_account_ids, create_log].hash
end
inflation_rate=(inflation_rate) click to toggle source

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

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

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

  @inflation_rate = inflation_rate
end
initial_balance=(initial_balance) click to toggle source

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

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

  @initial_balance = initial_balance
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_calculator_deposit_amount_request.rb, line 172
def list_invalid_properties
  invalid_properties = Array.new
  if !@inflation_rate.nil? && @inflation_rate > 20
    invalid_properties.push('invalid value for "inflation_rate", must be smaller than or equal to 20.')
  end

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

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

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

  if @portfolio_return.nil?
    invalid_properties.push('invalid value for "portfolio_return", portfolio_return 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
tax_rate=(tax_rate) click to toggle source

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

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

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

  @tax_rate = tax_rate
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_calculator_deposit_amount_request.rb, line 434
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_calculator_deposit_amount_request.rb, line 440
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_calculator_deposit_amount_request.rb, line 428
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_calculator_deposit_amount_request.rb, line 227
def valid?
  return false if !@inflation_rate.nil? && @inflation_rate > 20
  return false if !@inflation_rate.nil? && @inflation_rate < -1
  return false if @decumulation_horizon.nil?
  return false if @decumulation_horizon < 1
  return false if !@tax_rate.nil? && @tax_rate > 1
  return false if !@tax_rate.nil? && @tax_rate < 0
  return false if @accumulation_horizon.nil?
  return false if @accumulation_horizon < 0
  return false if @annuity_amount.nil?
  return false if @annuity_amount < 0
  return false if @portfolio_return.nil?
  annuity_frequency_interval_validator = EnumAttributeValidator.new('String', ['year', 'quarter', 'month', 'week', 'day'])
  return false unless annuity_frequency_interval_validator.valid?(@annuity_frequency_interval)
  return false if !@initial_balance.nil? && @initial_balance < 0
  true
end