class ProtonApi::GoalWithdrawalConfig
Attributes
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/proton_api/models/goal_withdrawal_config.rb, line 54 def self.attribute_map { :'with_inflation' => :'with_inflation', :'with_frequency' => :'with_frequency', :'with_end_reference' => :'with_end_reference', :'with_start_reference' => :'with_start_reference', :'with_end_period' => :'with_end_period', :'with_amount' => :'with_amount', :'with_start_period' => :'with_start_period' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/proton_api/models/goal_withdrawal_config.rb, line 81 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?(:'with_inflation') self.with_inflation = attributes[:'with_inflation'] else self.with_inflation = 0.0 end if attributes.has_key?(:'with_frequency') self.with_frequency = attributes[:'with_frequency'] else self.with_frequency = 'year' end if attributes.has_key?(:'with_end_reference') self.with_end_reference = attributes[:'with_end_reference'] else self.with_end_reference = 'd_end' end if attributes.has_key?(:'with_start_reference') self.with_start_reference = attributes[:'with_start_reference'] else self.with_start_reference = 'a_end' end if attributes.has_key?(:'with_end_period') self.with_end_period = attributes[:'with_end_period'] else self.with_end_period = 0 end if attributes.has_key?(:'with_amount') self.with_amount = attributes[:'with_amount'] end if attributes.has_key?(:'with_start_period') self.with_start_period = attributes[:'with_start_period'] else self.with_start_period = 0 end end
Attribute type mapping.
# File lib/proton_api/models/goal_withdrawal_config.rb, line 67 def self.swagger_types { :'with_inflation' => :'Float', :'with_frequency' => :'String', :'with_end_reference' => :'String', :'with_start_reference' => :'String', :'with_end_period' => :'Integer', :'with_amount' => :'Float', :'with_start_period' => :'Integer' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/proton_api/models/goal_withdrawal_config.rb, line 209 def ==(o) return true if self.equal?(o) self.class == o.class && with_inflation == o.with_inflation && with_frequency == o.with_frequency && with_end_reference == o.with_end_reference && with_start_reference == o.with_start_reference && with_end_period == o.with_end_period && with_amount == o.with_amount && with_start_period == o.with_start_period 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/goal_withdrawal_config.rb, line 256 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/goal_withdrawal_config.rb, line 320 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/goal_withdrawal_config.rb, line 236 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/goal_withdrawal_config.rb, line 223 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/proton_api/models/goal_withdrawal_config.rb, line 229 def hash [with_inflation, with_frequency, with_end_reference, with_start_reference, with_end_period, with_amount, with_start_period].hash 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/goal_withdrawal_config.rb, line 130 def list_invalid_properties invalid_properties = Array.new if !@with_inflation.nil? && @with_inflation < -1 invalid_properties.push('invalid value for "with_inflation", must be greater than or equal to -1.') end if !@with_amount.nil? && @with_amount < 0 invalid_properties.push('invalid value for "with_amount", must be greater than or equal to 0.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/proton_api/models/goal_withdrawal_config.rb, line 307 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/goal_withdrawal_config.rb, line 295 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/goal_withdrawal_config.rb, line 145 def valid? return false if !@with_inflation.nil? && @with_inflation < -1 with_frequency_validator = EnumAttributeValidator.new('String', ['year', 'six_months', 'quarter', 'month', 'two_weeks', 'week', 'day']) return false unless with_frequency_validator.valid?(@with_frequency) with_end_reference_validator = EnumAttributeValidator.new('String', ['a_end', 'd_end']) return false unless with_end_reference_validator.valid?(@with_end_reference) with_start_reference_validator = EnumAttributeValidator.new('String', ['a_end', 'd_end']) return false unless with_start_reference_validator.valid?(@with_start_reference) return false if !@with_amount.nil? && @with_amount < 0 true end
Custom attribute writer method with validation @param [Object] with_amount
Value to be assigned
# File lib/proton_api/models/goal_withdrawal_config.rb, line 199 def with_amount=(with_amount) if !with_amount.nil? && with_amount < 0 fail ArgumentError, 'invalid value for "with_amount", must be greater than or equal to 0.' end @with_amount = with_amount end
Custom attribute writer method checking allowed values (enum). @param [Object] with_end_reference
Object to be assigned
# File lib/proton_api/models/goal_withdrawal_config.rb, line 179 def with_end_reference=(with_end_reference) validator = EnumAttributeValidator.new('String', ['a_end', 'd_end']) unless validator.valid?(with_end_reference) fail ArgumentError, 'invalid value for "with_end_reference", must be one of #{validator.allowable_values}.' end @with_end_reference = with_end_reference end
Custom attribute writer method checking allowed values (enum). @param [Object] with_frequency
Object to be assigned
# File lib/proton_api/models/goal_withdrawal_config.rb, line 169 def with_frequency=(with_frequency) validator = EnumAttributeValidator.new('String', ['year', 'six_months', 'quarter', 'month', 'two_weeks', 'week', 'day']) unless validator.valid?(with_frequency) fail ArgumentError, 'invalid value for "with_frequency", must be one of #{validator.allowable_values}.' end @with_frequency = with_frequency end
Custom attribute writer method with validation @param [Object] with_inflation
Value to be assigned
# File lib/proton_api/models/goal_withdrawal_config.rb, line 159 def with_inflation=(with_inflation) if !with_inflation.nil? && with_inflation < -1 fail ArgumentError, 'invalid value for "with_inflation", must be greater than or equal to -1.' end @with_inflation = with_inflation end
Custom attribute writer method checking allowed values (enum). @param [Object] with_start_reference
Object to be assigned
# File lib/proton_api/models/goal_withdrawal_config.rb, line 189 def with_start_reference=(with_start_reference) validator = EnumAttributeValidator.new('String', ['a_end', 'd_end']) unless validator.valid?(with_start_reference) fail ArgumentError, 'invalid value for "with_start_reference", must be one of #{validator.allowable_values}.' end @with_start_reference = with_start_reference end