class ProtonApi::SavingsCalculatorRequest
Attributes
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# 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.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?(:'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.aggregation_account_ids = value end end end
Attribute type mapping.
# 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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# 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 && account_ids == o.account_ids && 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 && aggregation_account_ids == o.aggregation_account_ids end
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/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
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/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
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/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
@see the `==` method @param [Object] Object to be compared
# File lib/proton_api/models/savings_calculator_request.rb, line 283 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/proton_api/models/savings_calculator_request.rb, line 289 def hash [inflation_rate, account_ids, tax_rate, horizon_frequency_interval, deposit_schedule, horizon, return_schedule, create_log, initial_balance, aggregation_account_ids].hash end
Custom attribute writer method with validation @param [Object] horizon Value to be assigned
# File lib/proton_api/models/savings_calculator_request.rb, line 242 def horizon=(horizon) if horizon.nil? fail ArgumentError, 'horizon cannot be nil' end if horizon < 0 fail ArgumentError, 'invalid value for "horizon", must be greater than or equal to 0.' end @horizon = horizon end
Custom attribute writer method checking allowed values (enum). @param [Object] horizon_frequency_interval
Object to be assigned
# File lib/proton_api/models/savings_calculator_request.rb, line 232 def horizon_frequency_interval=(horizon_frequency_interval) validator = EnumAttributeValidator.new('String', ['year', 'quarter', 'month', 'week', 'day']) unless validator.valid?(horizon_frequency_interval) fail ArgumentError, 'invalid value for "horizon_frequency_interval", must be one of #{validator.allowable_values}.' end @horizon_frequency_interval = horizon_frequency_interval end
Custom attribute writer method with validation @param [Object] inflation_rate
Value to be assigned
# File lib/proton_api/models/savings_calculator_request.rb, line 208 def inflation_rate=(inflation_rate) 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
Custom attribute writer method with validation @param [Object] initial_balance
Value to be assigned
# File lib/proton_api/models/savings_calculator_request.rb, line 256 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
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# 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
Custom attribute writer method with validation @param [Object] tax_rate
Value to be assigned
# File lib/proton_api/models/savings_calculator_request.rb, line 218 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
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/proton_api/models/savings_calculator_request.rb, line 355 def to_s to_hash.to_s end
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/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