class FireflyIIIClient::BudgetLimit
Attributes
End date of the budget limit.
The budget ID of the associated budget.
Use either currency_id
or currency_code. Defaults to the user's default currency.
Use either currency_id
or currency_code. Defaults to the user's default currency.
Start date of the budget limit.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/firefly_iii_client/models/budget_limit.rb, line 63 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/firefly_iii_client/models/budget_limit.rb, line 46 def self.attribute_map { :'created_at' => :'created_at', :'updated_at' => :'updated_at', :'currency_id' => :'currency_id', :'currency_code' => :'currency_code', :'currency_symbol' => :'currency_symbol', :'currency_decimal_places' => :'currency_decimal_places', :'budget_id' => :'budget_id', :'start' => :'start', :'_end' => :'end', :'amount' => :'amount', :'spent' => :'spent' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/firefly_iii_client/models/budget_limit.rb, line 218 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/firefly_iii_client/models/budget_limit.rb, line 92 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `FireflyIIIClient::BudgetLimit` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `FireflyIIIClient::BudgetLimit`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'created_at') self.created_at = attributes[:'created_at'] end if attributes.key?(:'updated_at') self.updated_at = attributes[:'updated_at'] end if attributes.key?(:'currency_id') self.currency_id = attributes[:'currency_id'] end if attributes.key?(:'currency_code') self.currency_code = attributes[:'currency_code'] end if attributes.key?(:'currency_symbol') self.currency_symbol = attributes[:'currency_symbol'] end if attributes.key?(:'currency_decimal_places') self.currency_decimal_places = attributes[:'currency_decimal_places'] end if attributes.key?(:'budget_id') self.budget_id = attributes[:'budget_id'] end if attributes.key?(:'start') self.start = attributes[:'start'] end if attributes.key?(:'_end') self._end = attributes[:'_end'] end if attributes.key?(:'amount') self.amount = attributes[:'amount'] end if attributes.key?(:'spent') if (value = attributes[:'spent']).is_a?(Array) self.spent = value end end end
List of attributes with nullable: true
# File lib/firefly_iii_client/models/budget_limit.rb, line 85 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/firefly_iii_client/models/budget_limit.rb, line 68 def self.openapi_types { :'created_at' => :'Time', :'updated_at' => :'Time', :'currency_id' => :'Integer', :'currency_code' => :'String', :'currency_symbol' => :'String', :'currency_decimal_places' => :'Integer', :'budget_id' => :'Integer', :'start' => :'Date', :'_end' => :'Date', :'amount' => :'Float', :'spent' => :'Array<BudgetSpent>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/firefly_iii_client/models/budget_limit.rb, line 187 def ==(o) return true if self.equal?(o) self.class == o.class && created_at == o.created_at && updated_at == o.updated_at && currency_id == o.currency_id && currency_code == o.currency_code && currency_symbol == o.currency_symbol && currency_decimal_places == o.currency_decimal_places && budget_id == o.budget_id && start == o.start && _end == o._end && amount == o.amount && spent == o.spent 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/firefly_iii_client/models/budget_limit.rb, line 248 def _deserialize(type, value) case type.to_sym when :Time Time.parse(value) when :Date Date.parse(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 # models (e.g. Pet) or oneOf klass = FireflyIIIClient.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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/firefly_iii_client/models/budget_limit.rb, line 319 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/firefly_iii_client/models/budget_limit.rb, line 225 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) self.send("#{key}=", nil) elsif 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 end self end
@see the `==` method @param [Object] Object to be compared
# File lib/firefly_iii_client/models/budget_limit.rb, line 205 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/firefly_iii_client/models/budget_limit.rb, line 211 def hash [created_at, updated_at, currency_id, currency_code, currency_symbol, currency_decimal_places, budget_id, start, _end, amount, spent].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/firefly_iii_client/models/budget_limit.rb, line 154 def list_invalid_properties invalid_properties = Array.new if @budget_id.nil? invalid_properties.push('invalid value for "budget_id", budget_id cannot be nil.') end if @start.nil? invalid_properties.push('invalid value for "start", start cannot be nil.') end if @_end.nil? invalid_properties.push('invalid value for "_end", _end cannot be nil.') end if @amount.nil? invalid_properties.push('invalid value for "amount", amount cannot be nil.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/firefly_iii_client/models/budget_limit.rb, line 301 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/firefly_iii_client/models/budget_limit.rb, line 289 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/firefly_iii_client/models/budget_limit.rb, line 177 def valid? return false if @budget_id.nil? return false if @start.nil? return false if @_end.nil? return false if @amount.nil? true end